diff --git a/README.md b/README.md index a0b02b7..75e5db5 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.4.0 + 2.5.0 compile ``` @@ -72,7 +72,7 @@ Add this dependency to your project's build file: } dependencies { - implementation "com.dropbox.sign:dropbox-sign:2.4.0" + implementation "com.dropbox.sign:dropbox-sign:2.5.0" } ``` @@ -86,7 +86,7 @@ mvn clean package Then manually install the following JARs: -- `target/dropbox-sign-2.4.0.jar` +- `target/dropbox-sign-2.5.0.jar` - `target/lib/*.jar` ## Getting Started @@ -95,31 +95,41 @@ Please follow the [installation](#installation) instruction and execute the foll ```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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +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 AccountCreateExample +{ + 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 accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); @@ -154,7 +164,7 @@ Class | Method | HTTP request | Description *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 -*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +*FaxApi* | [**faxFiles**](docs/FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files *FaxApi* | [**faxGet**](docs/FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax *FaxApi* | [**faxList**](docs/FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes *FaxApi* | [**faxSend**](docs/FaxApi.md#faxSend) | **POST** /fax/send | Send Fax @@ -173,6 +183,10 @@ Class | Method | HTTP request | Description *SignatureRequestApi* | [**signatureRequestCancel**](docs/SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbedded**](docs/SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request *SignatureRequestApi* | [**signatureRequestCreateEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEdit**](docs/SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbedded**](docs/SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +*SignatureRequestApi* | [**signatureRequestEditEmbeddedWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +*SignatureRequestApi* | [**signatureRequestEditWithTemplate**](docs/SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template *SignatureRequestApi* | [**signatureRequestFiles**](docs/SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files *SignatureRequestApi* | [**signatureRequestFilesAsDataUri**](docs/SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri *SignatureRequestApi* | [**signatureRequestFilesAsFileUrl**](docs/SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -276,6 +290,10 @@ Class | Method | HTTP request | Description - [SignatureRequestBulkSendWithTemplateRequest](docs/SignatureRequestBulkSendWithTemplateRequest.md) - [SignatureRequestCreateEmbeddedRequest](docs/SignatureRequestCreateEmbeddedRequest.md) - [SignatureRequestCreateEmbeddedWithTemplateRequest](docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditEmbeddedRequest](docs/SignatureRequestEditEmbeddedRequest.md) + - [SignatureRequestEditEmbeddedWithTemplateRequest](docs/SignatureRequestEditEmbeddedWithTemplateRequest.md) + - [SignatureRequestEditRequest](docs/SignatureRequestEditRequest.md) + - [SignatureRequestEditWithTemplateRequest](docs/SignatureRequestEditWithTemplateRequest.md) - [SignatureRequestGetResponse](docs/SignatureRequestGetResponse.md) - [SignatureRequestListResponse](docs/SignatureRequestListResponse.md) - [SignatureRequestRemindRequest](docs/SignatureRequestRemindRequest.md) @@ -435,7 +453,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.4.0` + - Package version: `2.5.0` - Build package: `org.openapitools.codegen.languages.JavaClientCodegen` diff --git a/VERSION b/VERSION index 197c4d5..437459c 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -2.4.0 +2.5.0 diff --git a/bin/copy-constants.php b/bin/copy-constants.php new file mode 100755 index 0000000..70ec308 --- /dev/null +++ b/bin/copy-constants.php @@ -0,0 +1,64 @@ +#!/usr/bin/env php +run(); \ No newline at end of file diff --git a/build.gradle b/build.gradle index c6affe7..17e70b8 100644 --- a/build.gradle +++ b/build.gradle @@ -21,7 +21,7 @@ apply plugin: 'signing' group = 'com.dropbox.sign' archivesBaseName = 'dropbox-sign' -version = '2.4.0' +version = '2.5.0' sourceCompatibility = JavaVersion.VERSION_1_8 targetCompatibility = JavaVersion.VERSION_1_8 diff --git a/build.sbt b/build.sbt index 11b0b43..5504b48 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.4.0", + version := "2.5.0", scalaVersion := "2.11.4", scalacOptions ++= Seq("-feature"), Compile / javacOptions ++= Seq("-Xlint:deprecation"), diff --git a/docs/AccountApi.md b/docs/AccountApi.md index 494853d..e638f55 100644 --- a/docs/AccountApi.md +++ b/docs/AccountApi.md @@ -22,31 +22,41 @@ Creates a new Dropbox Sign Account that is associated with the specified `email_ ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); +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 AccountCreateExample +{ + 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 accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling AccountApi#accountCreate"); System.err.println("Status code: " + e.getCode()); @@ -97,30 +107,41 @@ Returns the properties and settings of your Account. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); +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 AccountGetExample +{ + 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"); + + try + { + var response = new AccountApi(config).accountGet( + null, // accountId + null // emailAddress + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling AccountApi#accountGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -170,33 +191,44 @@ Updates the properties and settings of your Account. Currently only allows for u ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); +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 AccountUpdateExample +{ + 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 accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling AccountApi#accountUpdate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -245,33 +277,43 @@ Verifies whether an Dropbox Sign Account exists for the given email address. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); +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 AccountVerifyExample +{ + 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 accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling AccountApi#accountVerify"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/ApiAppApi.md b/docs/ApiAppApi.md index 02630c9..c9e5fd6 100644 --- a/docs/ApiAppApi.md +++ b/docs/ApiAppApi.md @@ -23,50 +23,60 @@ Creates a new API App. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); +import java.util.Map; + +public class ApiAppCreateExample +{ + 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 oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -115,30 +125,38 @@ Deletes an API App. Can only be invoked for apps you own. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); +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 ApiAppDeleteExample +{ + 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"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -187,32 +205,40 @@ Returns an object with information about an API App. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); +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 ApiAppGetExample +{ + 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"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ApiAppApi#apiAppGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -261,33 +287,41 @@ Returns a list of API Apps that are accessible by you. If you are on a team with ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); +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 ApiAppListExample +{ + 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"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ApiAppApi#apiAppList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -337,52 +371,62 @@ Updates an existing API App. Can only be invoked for apps you own. Only the fiel ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); +import java.util.Map; + +public class ApiAppUpdateExample +{ + 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 oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/BulkSendJobApi.md b/docs/BulkSendJobApi.md index 5d7335a..a4b8a34 100644 --- a/docs/BulkSendJobApi.md +++ b/docs/BulkSendJobApi.md @@ -20,32 +20,42 @@ Returns the status of the BulkSendJob and its SignatureRequests specified by the ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); +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 BulkSendJobGetExample +{ + 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"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -96,33 +106,41 @@ Returns a list of BulkSendJob that you can access. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); +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 BulkSendJobListExample +{ + 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"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/EmbeddedApi.md b/docs/EmbeddedApi.md index 62955f9..416c319 100644 --- a/docs/EmbeddedApi.md +++ b/docs/EmbeddedApi.md @@ -20,38 +20,49 @@ Retrieves an embedded object containing a template url that can be opened in an ### 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; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); +import java.util.Map; + +public class EmbeddedEditUrlExample +{ + 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 mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -101,32 +112,40 @@ Retrieves an embedded object containing a signature url that can be opened in an ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); +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 EmbeddedSignUrlExample +{ + 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"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/FaxApi.md b/docs/FaxApi.md index a3d9bae..7ee47ff 100644 --- a/docs/FaxApi.md +++ b/docs/FaxApi.md @@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3* | Method | HTTP request | Description | |------------- | ------------- | -------------| [**faxDelete**](FaxApi.md#faxDelete) | **DELETE** /fax/{fax_id} | Delete Fax -[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | List Fax Files +[**faxFiles**](FaxApi.md#faxFiles) | **GET** /fax/files/{fax_id} | Download Fax Files [**faxGet**](FaxApi.md#faxGet) | **GET** /fax/{fax_id} | Get Fax [**faxList**](FaxApi.md#faxList) | **GET** /fax/list | Lists Faxes [**faxSend**](FaxApi.md#faxSend) | **POST** /fax/send | Send Fax @@ -18,29 +18,42 @@ All URIs are relative to *https://api.hellosign.com/v3* Delete Fax -Deletes the specified Fax from the system. +Deletes the specified Fax from the system ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - try { - faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); +import java.util.Map; + +public class FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -82,34 +95,45 @@ null (empty response body) > File faxFiles(faxId) -List Fax Files +Download Fax Files -Returns list of fax files +Downloads files associated with a Fax ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; +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 FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -153,31 +177,44 @@ public class Example { Get Fax -Returns information about fax +Returns information about a Fax ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); +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 FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling FaxApi#faxGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -221,32 +258,45 @@ public class Example { Lists Faxes -Returns properties of multiple faxes +Returns properties of multiple Faxes ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); +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 FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling FaxApi#faxList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -262,8 +312,8 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] + **page** | **Integer**| Which page number of the Fax List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] ### Return type @@ -291,41 +341,56 @@ public class Example { Send Fax -Action to prepare and send a fax +Creates and sends a new Fax with the submitted file(s) ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .testMode(true) - .recipient("16690000001") - .sender("16690000000") - .coverPageTo("Jill Fax") - .coverPageMessage("I'm sending you a fax!") - .coverPageFrom("Faxer Faxerson") - .title("This is what the fax is about!"); - - try { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); +import java.util.Map; + +public class FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/FaxLineAddUserRequest.md b/docs/FaxLineAddUserRequest.md index 1c9e997..4023bd0 100644 --- a/docs/FaxLineAddUserRequest.md +++ b/docs/FaxLineAddUserRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | | `accountId` | ```String``` | Account ID | | | `emailAddress` | ```String``` | Email address | | diff --git a/docs/FaxLineApi.md b/docs/FaxLineApi.md index 1997f1f..79ccf8b 100644 --- a/docs/FaxLineApi.md +++ b/docs/FaxLineApi.md @@ -25,29 +25,43 @@ Grants a user access to the specified Fax Line. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -91,30 +105,47 @@ public class Example { Get Available Fax Line Area Codes -Returns a response with the area codes available for a given state/provice and city. +Returns a list of available area codes for a given state/province and city ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); +import java.util.Map; + +public class FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -130,10 +161,10 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **country** | **String**| Filter area codes by country. | [enum: CA, US, UK] - **state** | **String**| Filter area codes by state. | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] - **province** | **String**| Filter area codes by province. | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] - **city** | **String**| Filter area codes by city. | [optional] + **country** | **String**| Filter area codes by country | [enum: CA, US, UK] + **state** | **String**| Filter area codes by state | [optional] [enum: AK, AL, AR, AZ, CA, CO, CT, DC, DE, FL, GA, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MI, MN, MO, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, RI, SC, SD, TN, TX, UT, VA, VT, WA, WI, WV, WY] + **province** | **String**| Filter area codes by province | [optional] [enum: AB, BC, MB, NB, NL, NT, NS, NU, ON, PE, QC, SK, YT] + **city** | **String**| Filter area codes by city | [optional] ### Return type @@ -161,34 +192,48 @@ public class Example { Purchase Fax Line -Purchases a new Fax Line. +Purchases a new Fax Line ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -237,27 +282,40 @@ Deletes the specified Fax Line from the subscription. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); +import java.util.Map; + +public class FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -306,25 +364,39 @@ Returns the properties and settings of a Fax Line. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); +import java.util.Map; + +public class FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -340,7 +412,7 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| - **number** | **String**| The Fax Line number. | + **number** | **String**| The Fax Line number | ### Return type @@ -373,25 +445,42 @@ Returns the properties and settings of multiple Fax Lines. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); +import java.util.Map; + +public class FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -408,9 +497,9 @@ public class Example { | Name | Type | Description | Notes | |------------- | ------------- | ------------- | -------------| **accountId** | **String**| Account ID | [optional] - **page** | **Integer**| Page | [optional] [default to 1] - **pageSize** | **Integer**| Page size | [optional] [default to 20] - **showTeamLines** | **Boolean**| Show team lines | [optional] + **page** | **Integer**| Which page number of the Fax Line List to return. Defaults to `1`. | [optional] [default to 1] + **pageSize** | **Integer**| Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional] [default to 20] + **showTeamLines** | **Boolean**| Include Fax Lines belonging to team members in the list | [optional] ### Return type @@ -438,34 +527,48 @@ public class Example { Remove Fax Line Access -Removes a user's access to the specified Fax Line. +Removes a user's access to the specified Fax Line ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); +import java.util.Map; + +public class FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/FaxLineCreateRequest.md b/docs/FaxLineCreateRequest.md index da9ba39..7fd1be6 100644 --- a/docs/FaxLineCreateRequest.md +++ b/docs/FaxLineCreateRequest.md @@ -8,10 +8,10 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `areaCode`*_required_ | ```Integer``` | Area code | | -| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | | -| `city` | ```String``` | City | | -| `accountId` | ```String``` | Account ID | | +| `areaCode`*_required_ | ```Integer``` | Area code of the new Fax Line | | +| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country of the area code | | +| `city` | ```String``` | City of the area code | | +| `accountId` | ```String``` | Account ID of the account that will be assigned this new Fax Line | | diff --git a/docs/FaxLineDeleteRequest.md b/docs/FaxLineDeleteRequest.md index de1748f..4b45b33 100644 --- a/docs/FaxLineDeleteRequest.md +++ b/docs/FaxLineDeleteRequest.md @@ -8,7 +8,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | +| `number`*_required_ | ```String``` | The Fax Line number | | diff --git a/docs/FaxLineRemoveUserRequest.md b/docs/FaxLineRemoveUserRequest.md index 51d81b8..8e55d57 100644 --- a/docs/FaxLineRemoveUserRequest.md +++ b/docs/FaxLineRemoveUserRequest.md @@ -8,9 +8,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `number`*_required_ | ```String``` | The Fax Line number. | | -| `accountId` | ```String``` | Account ID | | -| `emailAddress` | ```String``` | Email address | | +| `number`*_required_ | ```String``` | The Fax Line number | | +| `accountId` | ```String``` | Account ID of the user to remove access | | +| `emailAddress` | ```String``` | Email address of the user to remove access | | diff --git a/docs/FaxSendRequest.md b/docs/FaxSendRequest.md index 5b939a0..65b1057 100644 --- a/docs/FaxSendRequest.md +++ b/docs/FaxSendRequest.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| `recipient`*_required_ | ```String``` | Fax Send To Recipient | | +| `recipient`*_required_ | ```String``` | Recipient of the fax Can be a phone number in E.164 format or email address | | | `sender` | ```String``` | Fax Send From Sender (used only with fax number) | | -| `files` | ```List``` | Fax File to Send | | -| `fileUrls` | ```List``` | Fax File URL to Send | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Fax download the file(s) to fax

This endpoint requires either **files** or **file_urls[]**, but not both. | | | `testMode` | ```Boolean``` | API Test Mode Setting | | -| `coverPageTo` | ```String``` | Fax Cover Page for Recipient | | -| `coverPageFrom` | ```String``` | Fax Cover Page for Sender | | +| `coverPageTo` | ```String``` | Fax cover page recipient information | | +| `coverPageFrom` | ```String``` | Fax cover page sender information | | | `coverPageMessage` | ```String``` | Fax Cover Page Message | | | `title` | ```String``` | Fax Title | | diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md index a2eaa25..aab2b94 100644 --- a/docs/OAuthApi.md +++ b/docs/OAuthApi.md @@ -20,29 +20,45 @@ Once you have retrieved the code from the user callback, you will need to exchan ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); +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 OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -91,26 +107,42 @@ Access tokens are only valid for a given period of time (typically one hour) for ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); +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 OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/ReportApi.md b/docs/ReportApi.md index e0a4097..cadac49 100644 --- a/docs/ReportApi.md +++ b/docs/ReportApi.md @@ -21,40 +21,47 @@ When the report(s) have been generated, you will receive an email (one per reque ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); +import java.util.Map; + +public class ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling ReportApi#reportCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md index 60e0242..939b10e 100644 --- a/docs/SignatureRequestApi.md +++ b/docs/SignatureRequestApi.md @@ -9,6 +9,10 @@ All URIs are relative to *https://api.hellosign.com/v3* [**signatureRequestCancel**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request [**signatureRequestCreateEmbedded**](SignatureRequestApi.md#signatureRequestCreateEmbedded) | **POST** /signature_request/create_embedded | Create Embedded Signature Request [**signatureRequestCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestCreateEmbeddedWithTemplate) | **POST** /signature_request/create_embedded_with_template | Create Embedded Signature Request with Template +[**signatureRequestEdit**](SignatureRequestApi.md#signatureRequestEdit) | **PUT** /signature_request/edit/{signature_request_id} | Edit Signature Request +[**signatureRequestEditEmbedded**](SignatureRequestApi.md#signatureRequestEditEmbedded) | **PUT** /signature_request/edit_embedded/{signature_request_id} | Edit Embedded Signature Request +[**signatureRequestEditEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestEditEmbeddedWithTemplate) | **PUT** /signature_request/edit_embedded_with_template/{signature_request_id} | Edit Embedded Signature Request with Template +[**signatureRequestEditWithTemplate**](SignatureRequestApi.md#signatureRequestEditWithTemplate) | **PUT** /signature_request/edit_with_template/{signature_request_id} | Edit Signature Request With Template [**signatureRequestFiles**](SignatureRequestApi.md#signatureRequestFiles) | **GET** /signature_request/files/{signature_request_id} | Download Files [**signatureRequestFilesAsDataUri**](SignatureRequestApi.md#signatureRequestFilesAsDataUri) | **GET** /signature_request/files_as_data_uri/{signature_request_id} | Download Files as Data Uri [**signatureRequestFilesAsFileUrl**](SignatureRequestApi.md#signatureRequestFilesAsFileUrl) | **GET** /signature_request/files_as_file_url/{signature_request_id} | Download Files as File Url @@ -36,72 +40,107 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -152,72 +191,107 @@ Creates BulkSendJob which sends up to 250 SignatureRequests in bulk based off of ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestBulkSendWithTemplateExample +{ + 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 signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -274,30 +348,38 @@ To be eligible for cancelation, a signature request must have been sent successf ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +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; - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); +public class SignatureRequestCancelExample +{ + 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"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -346,61 +428,78 @@ Creates a new SignatureRequest with the submitted documents to be signed in an e ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); +public class SignatureRequestCreateEmbeddedExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -449,52 +548,67 @@ Creates a new SignatureRequest based on the given Template(s) to be signed in an ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class SignatureRequestCreateEmbeddedWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -532,6 +646,508 @@ public class Example { | **4XX** | failed_operation | - | +## signatureRequestEdit + +> SignatureRequestGetResponse signatureRequestEdit(signatureRequestId, signatureRequestEditRequest) + +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 + +```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 SignatureRequestEditExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + 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 | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditRequest** | [**SignatureRequestEditRequest**](SignatureRequestEditRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.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 | - | + + +## signatureRequestEditEmbedded + +> SignatureRequestGetResponse signatureRequestEditEmbedded(signatureRequestId, signatureRequestEditEmbeddedRequest) + +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 + +```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 SignatureRequestEditEmbeddedExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + 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 | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedRequest** | [**SignatureRequestEditEmbeddedRequest**](SignatureRequestEditEmbeddedRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.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 | - | + + +## signatureRequestEditEmbeddedWithTemplate + +> SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest) + +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 + +```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 SignatureRequestEditEmbeddedWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + 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 | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditEmbeddedWithTemplateRequest** | [**SignatureRequestEditEmbeddedWithTemplateRequest**](SignatureRequestEditEmbeddedWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.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 | - | + + +## signatureRequestEditWithTemplate + +> SignatureRequestGetResponse signatureRequestEditWithTemplate(signatureRequestId, signatureRequestEditWithTemplateRequest) + +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 + +```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 SignatureRequestEditWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + 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 | +|------------- | ------------- | ------------- | -------------| + **signatureRequestId** | **String**| The id of the SignatureRequest to edit. | + **signatureRequestEditWithTemplateRequest** | [**SignatureRequestEditWithTemplateRequest**](SignatureRequestEditWithTemplateRequest.md)| | + +### Return type + +[**SignatureRequestGetResponse**](SignatureRequestGetResponse.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 | - | + + ## signatureRequestFiles > File signatureRequestFiles(signatureRequestId, fileType) @@ -545,33 +1161,40 @@ If the files are currently being prepared, a status code of `409` will be return ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); +public class SignatureRequestFilesExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -623,32 +1246,40 @@ If the files are currently being prepared, a status code of `409` will be return ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +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; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsDataUriExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -699,32 +1330,41 @@ If the files are currently being prepared, a status code of `409` will be return ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +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; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestFilesAsFileUrlExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -774,32 +1414,40 @@ Returns the status of the SignatureRequest specified by the `signature_request_i ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +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; - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; +public class SignatureRequestGetExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -850,40 +1498,43 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query +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 SignatureRequestListExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query ); - System.out.println(result); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -935,32 +1586,40 @@ Releases a held SignatureRequest that was claimed and prepared from an [Unclaime ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); +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; - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +public class SignatureRequestReleaseHoldExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -1011,35 +1670,44 @@ Sends an email to the signer reminding them to sign the signature request. You c ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +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; - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); +public class SignatureRequestRemindExample +{ + 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 signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -1093,30 +1761,37 @@ Unlike /signature_request/cancel, this endpoint is synchronous and your access w ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +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; - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); +public class SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -1165,66 +1840,87 @@ Creates and sends a new SignatureRequest with the submitted documents. If `form_ ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); +public class SignatureRequestSendExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -1273,64 +1969,86 @@ Creates and sends a new SignatureRequest based off of the Template(s) specified ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); +public class SignatureRequestSendWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -1383,36 +2101,45 @@ Updating the email address of a signer will generate a new `signature_id` value. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; +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; - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); +public class SignatureRequestUpdateExample +{ + 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 signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/SignatureRequestEditEmbeddedRequest.md b/docs/SignatureRequestEditEmbeddedRequest.md new file mode 100644 index 0000000..dd8b060 --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedRequest.md @@ -0,0 +1,37 @@ + + +# SignatureRequestEditEmbeddedRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```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`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```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` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `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. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `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/SignatureRequestEditEmbeddedWithTemplateRequest.md b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md new file mode 100644 index 0000000..3cc3dee --- /dev/null +++ b/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md @@ -0,0 +1,28 @@ + + +# SignatureRequestEditEmbeddedWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this embedded signature request. Used for security purposes. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `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. | | +| `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. | | + + + diff --git a/docs/SignatureRequestEditRequest.md b/docs/SignatureRequestEditRequest.md new file mode 100644 index 0000000..7fa3aca --- /dev/null +++ b/docs/SignatureRequestEditRequest.md @@ -0,0 +1,38 @@ + + +# SignatureRequestEditRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `signers` | [```List```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `groupedSigners` | [```List```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.

This endpoint requires either **signers** or **grouped_signers**, but not both. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `allowReassign` | ```Boolean``` | Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.

**NOTE:** Only available for Premium plan and higher. | | +| `attachments` | [```List```](SubAttachment.md) | A list describing the attachments | | +| `ccEmailAddresses` | ```List``` | The email addresses that should be CCed. | | +| `clientId` | ```String``` | The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.

Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.

For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | | +| `fieldOptions` | [```SubFieldOptions```](SubFieldOptions.md) | | | +| `formFieldGroups` | [```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`. | | +| `formFieldRules` | [```List```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | | +| `formFieldsPerDocument` | [```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` | | +| `hideTextTags` | ```Boolean``` | Enables automatic Text Tag removal when set to true.

**NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `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. | | +| `useTextTags` | ```Boolean``` | Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. | | +| `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/SignatureRequestEditWithTemplateRequest.md b/docs/SignatureRequestEditWithTemplateRequest.md new file mode 100644 index 0000000..d079524 --- /dev/null +++ b/docs/SignatureRequestEditWithTemplateRequest.md @@ -0,0 +1,29 @@ + + +# SignatureRequestEditWithTemplateRequest + + + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. | | +| `signers`*_required_ | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. | | +| `allowDecline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | | +| `ccs` | [```List```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | | +| `clientId` | ```String``` | Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. | | +| `customFields` | [```List```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | | +| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `fileUrls` | ```List``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.

This endpoint requires either **files** or **file_urls[]**, but not both. | | +| `isEid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br>
**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | | +| `message` | ```String``` | The custom message in the email that will be sent to the signers. | | +| `metadata` | ```Map``` | Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request.

Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. | | +| `signingOptions` | [```SubSigningOptions```](SubSigningOptions.md) | | | +| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | | +| `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. | | + + + diff --git a/docs/SubFormFieldRuleAction.md b/docs/SubFormFieldRuleAction.md index 6a2d434..1692873 100644 --- a/docs/SubFormFieldRuleAction.md +++ b/docs/SubFormFieldRuleAction.md @@ -19,8 +19,8 @@ | Name | Value | ---- | ----- -| FIELD_VISIBILITY | "change-field-visibility" | -| GROUP_VISIBILITY | "change-group-visibility" | +| CHANGE_FIELD_VISIBILITY | "change-field-visibility" | +| CHANGE_GROUP_VISIBILITY | "change-group-visibility" | diff --git a/docs/TeamApi.md b/docs/TeamApi.md index b35b40e..abb3f1e 100644 --- a/docs/TeamApi.md +++ b/docs/TeamApi.md @@ -28,35 +28,44 @@ Invites a user (specified using the `email_address` parameter) to your Team. If ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); +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 TeamAddMemberExample +{ + 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 teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamAddMember"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -106,33 +115,43 @@ Creates a new Team and makes you a member. You must not currently belong to a Te ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); +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 TeamCreateExample +{ + 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 teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -181,28 +200,36 @@ Deletes your Team. Can only be invoked when you have a Team with only one member ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); +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 TeamDeleteExample +{ + 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"); + + try + { + new TeamApi(config).teamDelete(); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -248,30 +275,38 @@ Returns information about your Team as well as a list of its members. If you do ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); +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 TeamGetExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -317,28 +352,38 @@ Provides information about a team. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); +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 TeamInfoExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamInfo"); System.err.println("Status code: " + e.getCode()); @@ -389,32 +434,40 @@ Provides a list of team invites (and their roles). ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); +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 TeamInvitesExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamInvites( + null // emailAddress + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); + System.err.println("Exception when calling TeamApi#teamInvites"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -463,32 +516,40 @@ Provides a paginated list of members (and their roles) that belong to a given te ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); +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 TeamMembersExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamMembers"); System.err.println("Status code: " + e.getCode()); @@ -541,34 +602,44 @@ Removes the provided user Account from your Team. If the Account had an outstand ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); +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 TeamRemoveMemberExample +{ + 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 teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamRemoveMember"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -617,32 +688,40 @@ Provides a paginated list of sub teams that belong to a given team. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); +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 TeamSubTeamsExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); } catch (ApiException e) { System.err.println("Exception when calling TeamApi#teamSubTeams"); System.err.println("Status code: " + e.getCode()); @@ -695,33 +774,43 @@ Updates the name of your Team. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); +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 TeamUpdateExample +{ + 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 teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TeamApi#teamUpdate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/TemplateApi.md b/docs/TemplateApi.md index e6c7d17..dd47048 100644 --- a/docs/TemplateApi.md +++ b/docs/TemplateApi.md @@ -29,35 +29,44 @@ Gives the specified Account access to the specified Template. The specified Acco ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); +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 TemplateAddUserExample +{ + 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 templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateAddUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -107,64 +116,119 @@ Creates a template that can then be used. ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -213,64 +277,85 @@ The first step in an embedded template workflow. Creates a draft template that c ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); +import java.util.Map; + +public class TemplateCreateEmbeddedDraftExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -319,30 +404,38 @@ Completely deletes the template specified from the account. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); +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 TemplateDeleteExample +{ + 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"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateDelete"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -393,33 +486,40 @@ If the files are currently being prepared, a status code of `409` will be return ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); +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 TemplateFilesExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -471,32 +571,40 @@ If the files are currently being prepared, a status code of `409` will be return ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); +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 TemplateFilesAsDataUriExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -547,32 +655,41 @@ If the files are currently being prepared, a status code of `409` will be return ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); +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 TemplateFilesAsFileUrlExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -622,32 +739,40 @@ Returns the Template specified by the `template_id` parameter. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); +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 TemplateGetExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateGet"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -698,35 +823,43 @@ Take a look at our [search guide](/api/reference/search/) to learn more about qu ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); +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 TemplateListExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateList"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -778,35 +911,44 @@ Removes the specified Account's access to the specified Template. ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); +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 TemplateRemoveUserExample +{ + 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 templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -867,37 +1009,46 @@ If the page orientation or page count is different from the original template do ### 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; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); +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 TemplateUpdateFilesExample +{ + 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 templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/docs/UnclaimedDraftApi.md b/docs/UnclaimedDraftApi.md index 4d6d124..3f4dada 100644 --- a/docs/UnclaimedDraftApi.md +++ b/docs/UnclaimedDraftApi.md @@ -22,66 +22,57 @@ Creates a new Draft that can be claimed using the claim URL. The first authentic ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); +public class UnclaimedDraftCreateExample +{ + 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 signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -132,38 +123,48 @@ Creates a new Draft that can be claimed and used in an embedded iFrame. The firs ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedExample +{ + 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 unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -214,49 +215,67 @@ Creates a new Draft with a previously saved template(s) that can be claimed and ### 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 Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); +public class UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + 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 ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); @@ -307,36 +326,45 @@ Creates a new signature request from an embedded request that can be edited prio ### 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.*; -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; +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; - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); +public class UnclaimedDraftEditAndResendExample +{ + 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 unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); diff --git a/examples/AccountCreate.java b/examples/AccountCreate.java deleted file mode 100644 index 6063411..0000000 --- a/examples/AccountCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountCreateRequest() - .emailAddress("newuser@dropboxsign.com"); - - try { - AccountCreateResponse result = accountApi.accountCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/AccountCreateExample.java b/examples/AccountCreateExample.java new file mode 100644 index 0000000..2743ffa --- /dev/null +++ b/examples/AccountCreateExample.java @@ -0,0 +1,44 @@ +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 AccountCreateExample +{ + 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 accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + 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/examples/AccountCreateOauthExample.java b/examples/AccountCreateOauthExample.java new file mode 100644 index 0000000..e6ae95b --- /dev/null +++ b/examples/AccountCreateOauthExample.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 AccountCreateOauthExample +{ + 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 accountCreateRequest = new AccountCreateRequest(); + accountCreateRequest.emailAddress("newuser@dropboxsign.com"); + accountCreateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + accountCreateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + + try + { + var response = new AccountApi(config).accountCreate( + accountCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountCreate"); + 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/examples/AccountGet.java b/examples/AccountGet.java deleted file mode 100644 index e05f3ff..0000000 --- a/examples/AccountGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - try { - AccountGetResponse result = accountApi.accountGet(null, "jack@example.com"); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/AccountGetExample.java b/examples/AccountGetExample.java new file mode 100644 index 0000000..b1f712a --- /dev/null +++ b/examples/AccountGetExample.java @@ -0,0 +1,42 @@ +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 AccountGetExample +{ + 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"); + + try + { + var response = new AccountApi(config).accountGet( + null, // accountId + null // emailAddress + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountGet"); + 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/examples/AccountUpdate.java b/examples/AccountUpdate.java deleted file mode 100644 index 9b8d374..0000000 --- a/examples/AccountUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountUpdateRequest() - .callbackUrl("https://www.example.com/callback"); - - try { - AccountGetResponse result = accountApi.accountUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/AccountUpdateExample.java b/examples/AccountUpdateExample.java new file mode 100644 index 0000000..c1d2f1c --- /dev/null +++ b/examples/AccountUpdateExample.java @@ -0,0 +1,45 @@ +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 AccountUpdateExample +{ + 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 accountUpdateRequest = new AccountUpdateRequest(); + accountUpdateRequest.callbackUrl("https://www.example.com/callback"); + accountUpdateRequest.locale("en-US"); + + try + { + var response = new AccountApi(config).accountUpdate( + accountUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountUpdate"); + 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/examples/AccountVerify.java b/examples/AccountVerify.java deleted file mode 100644 index 36a9666..0000000 --- a/examples/AccountVerify.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var accountApi = new AccountApi(apiClient); - - var data = new AccountVerifyRequest() - .emailAddress("some_user@dropboxsign.com"); - - try { - AccountVerifyResponse result = accountApi.accountVerify(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/AccountVerifyExample.java b/examples/AccountVerifyExample.java new file mode 100644 index 0000000..5180f67 --- /dev/null +++ b/examples/AccountVerifyExample.java @@ -0,0 +1,44 @@ +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 AccountVerifyExample +{ + 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 accountVerifyRequest = new AccountVerifyRequest(); + accountVerifyRequest.emailAddress("some_user@dropboxsign.com"); + + try + { + var response = new AccountApi(config).accountVerify( + accountVerifyRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling AccountApi#accountVerify"); + 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/examples/ApiAppCreate.java b/examples/ApiAppCreate.java deleted file mode 100644 index 2d3c80f..0000000 --- a/examples/ApiAppCreate.java +++ /dev/null @@ -1,51 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of((SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppCreateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - try { - ApiAppGetResponse result = apiAppApi.apiAppCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ApiAppCreateExample.java b/examples/ApiAppCreateExample.java new file mode 100644 index 0000000..2d81a97 --- /dev/null +++ b/examples/ApiAppCreateExample.java @@ -0,0 +1,61 @@ +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 ApiAppCreateExample +{ + 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 oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppCreateRequest = new ApiAppCreateRequest(); + apiAppCreateRequest.name("My Production App"); + apiAppCreateRequest.domains(List.of ( + "example.com" + )); + apiAppCreateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppCreateRequest.oauth(oauth); + apiAppCreateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppCreate( + apiAppCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppCreate"); + 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/examples/ApiAppDelete.java b/examples/ApiAppDelete.java deleted file mode 100644 index fe44318..0000000 --- a/examples/ApiAppDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - apiAppApi.apiAppDelete(clientId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ApiAppDeleteExample.java b/examples/ApiAppDeleteExample.java new file mode 100644 index 0000000..aa23b5f --- /dev/null +++ b/examples/ApiAppDeleteExample.java @@ -0,0 +1,39 @@ +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 ApiAppDeleteExample +{ + 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"); + + try + { + new ApiAppApi(config).apiAppDelete( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppDelete"); + 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/examples/ApiAppGet.java b/examples/ApiAppGet.java deleted file mode 100644 index 5d3a4bb..0000000 --- a/examples/ApiAppGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppGet(clientId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ApiAppGetExample.java b/examples/ApiAppGetExample.java new file mode 100644 index 0000000..6ad075b --- /dev/null +++ b/examples/ApiAppGetExample.java @@ -0,0 +1,41 @@ +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 ApiAppGetExample +{ + 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"); + + try + { + var response = new ApiAppApi(config).apiAppGet( + "0dd3b823a682527788c4e40cb7b6f7e9" // clientId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppGet"); + 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/examples/ApiAppList.java b/examples/ApiAppList.java deleted file mode 100644 index e16df1a..0000000 --- a/examples/ApiAppList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - ApiAppListResponse result = apiAppApi.apiAppList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ApiAppListExample.java b/examples/ApiAppListExample.java new file mode 100644 index 0000000..0737568 --- /dev/null +++ b/examples/ApiAppListExample.java @@ -0,0 +1,42 @@ +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 ApiAppListExample +{ + 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"); + + try + { + var response = new ApiAppApi(config).apiAppList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppList"); + 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/examples/ApiAppUpdate.java b/examples/ApiAppUpdate.java deleted file mode 100644 index a656173..0000000 --- a/examples/ApiAppUpdate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var apiAppApi = new ApiAppApi(apiClient); - - var oauth = new SubOAuth() - .callbackUrl("https://example.com/oauth") - .scopes(List.of(SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, SubOAuth.ScopesEnum.REQUEST_SIGNATURE)); - - var whiteLabelingOptions = new SubWhiteLabelingOptions() - .primaryButtonColor("#00b3e6") - .primaryButtonTextColor("#ffffff"); - - var customLogoFile = new File("CustomLogoFile.png"); - - var data = new ApiAppUpdateRequest() - .name("My Production App") - .domains(List.of("example.com")) - .oauth(oauth) - .whiteLabelingOptions(whiteLabelingOptions) - .customLogoFile(customLogoFile); - - var clientId = "0dd3b823a682527788c4e40cb7b6f7e9"; - - try { - ApiAppGetResponse result = apiAppApi.apiAppUpdate(clientId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ApiAppUpdateExample.java b/examples/ApiAppUpdateExample.java new file mode 100644 index 0000000..ee6290b --- /dev/null +++ b/examples/ApiAppUpdateExample.java @@ -0,0 +1,63 @@ +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 ApiAppUpdateExample +{ + 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 oauth = new SubOAuth(); + oauth.callbackUrl("https://example.com/oauth"); + oauth.scopes(List.of ( + SubOAuth.ScopesEnum.BASIC_ACCOUNT_INFO, + SubOAuth.ScopesEnum.REQUEST_SIGNATURE + )); + + var whiteLabelingOptions = new SubWhiteLabelingOptions(); + whiteLabelingOptions.primaryButtonColor("#00b3e6"); + whiteLabelingOptions.primaryButtonTextColor("#ffffff"); + + var apiAppUpdateRequest = new ApiAppUpdateRequest(); + apiAppUpdateRequest.callbackUrl("https://example.com/dropboxsign"); + apiAppUpdateRequest.name("New Name"); + apiAppUpdateRequest.domains(List.of ( + "example.com" + )); + apiAppUpdateRequest.customLogoFile(new File("CustomLogoFile.png")); + apiAppUpdateRequest.oauth(oauth); + apiAppUpdateRequest.whiteLabelingOptions(whiteLabelingOptions); + + try + { + var response = new ApiAppApi(config).apiAppUpdate( + "0dd3b823a682527788c4e40cb7b6f7e9", // clientId + apiAppUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ApiAppApi#apiAppUpdate"); + 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/examples/BulkSendJobGet.java b/examples/BulkSendJobGet.java deleted file mode 100644 index d79a461..0000000 --- a/examples/BulkSendJobGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"; - - try { - BulkSendJobGetResponse result = bulkSendJobApi.bulkSendJobGet(bulkSendJobId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/BulkSendJobGetExample.java b/examples/BulkSendJobGetExample.java new file mode 100644 index 0000000..da4680b --- /dev/null +++ b/examples/BulkSendJobGetExample.java @@ -0,0 +1,43 @@ +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 BulkSendJobGetExample +{ + 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"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobGet( + "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174", // bulkSendJobId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobGet"); + 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/examples/BulkSendJobList.java b/examples/BulkSendJobList.java deleted file mode 100644 index 866f335..0000000 --- a/examples/BulkSendJobList.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var bulkSendJobApi = new BulkSendJobApi(apiClient); - - var page = 1; - var pageSize = 20; - - try { - BulkSendJobListResponse result = bulkSendJobApi.bulkSendJobList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/BulkSendJobListExample.java b/examples/BulkSendJobListExample.java new file mode 100644 index 0000000..9c9b835 --- /dev/null +++ b/examples/BulkSendJobListExample.java @@ -0,0 +1,42 @@ +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 BulkSendJobListExample +{ + 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"); + + try + { + var response = new BulkSendJobApi(config).bulkSendJobList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling BulkSendJobApi#bulkSendJobList"); + 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/examples/EmbeddedEditUrl.java b/examples/EmbeddedEditUrl.java deleted file mode 100644 index 65a52a9..0000000 --- a/examples/EmbeddedEditUrl.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Main { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var data = new EmbeddedEditUrlRequest() - .ccRoles(List.of("")) - .mergeFields(List.of()); - - var templateId = "5de8179668f2033afac48da1868d0093bf133266"; - - try { - EmbeddedEditUrlResponse result = embeddedApi.embeddedEditUrl(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/EmbeddedEditUrlExample.java b/examples/EmbeddedEditUrlExample.java new file mode 100644 index 0000000..a1097bd --- /dev/null +++ b/examples/EmbeddedEditUrlExample.java @@ -0,0 +1,50 @@ +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 EmbeddedEditUrlExample +{ + 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 mergeFields = new ArrayList(List.of ()); + + var embeddedEditUrlRequest = new EmbeddedEditUrlRequest(); + embeddedEditUrlRequest.ccRoles(List.of ( + "" + )); + embeddedEditUrlRequest.mergeFields(mergeFields); + + try + { + var response = new EmbeddedApi(config).embeddedEditUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + embeddedEditUrlRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedEditUrl"); + 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/examples/EmbeddedSignUrl.java b/examples/EmbeddedSignUrl.java deleted file mode 100644 index 2ab5869..0000000 --- a/examples/EmbeddedSignUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var embeddedApi = new EmbeddedApi(apiClient); - - var signatureId = "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b"; - - try { - EmbeddedSignUrlResponse result = embeddedApi.embeddedSignUrl(signatureId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/EmbeddedSignUrlExample.java b/examples/EmbeddedSignUrlExample.java new file mode 100644 index 0000000..45b7f50 --- /dev/null +++ b/examples/EmbeddedSignUrlExample.java @@ -0,0 +1,41 @@ +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 EmbeddedSignUrlExample +{ + 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"); + + try + { + var response = new EmbeddedApi(config).embeddedSignUrl( + "50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b" // signatureId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling EmbeddedApi#embeddedSignUrl"); + 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/examples/EventCallback.java b/examples/EventCallbackExample.java similarity index 97% rename from examples/EventCallback.java rename to examples/EventCallbackExample.java index d712408..37d2451 100644 --- a/examples/EventCallback.java +++ b/examples/EventCallbackExample.java @@ -4,7 +4,7 @@ import java.util.HashMap; -public class Example { +public class EventCallbackExample { public static void main(String[] args) throws Exception { // use your API key var apiKey = "324e3b0840f065eb51f3fd63231d0d33daa35d4ed10d27718839e81737065782"; diff --git a/examples/FaxDelete.java b/examples/FaxDelete.java deleted file mode 100644 index 794b74d..0000000 --- a/examples/FaxDelete.java +++ /dev/null @@ -1,25 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - try { - faxApi.faxDelete("fa5c8a0b0f492d768749333ad6fcc214c111e967"); - } catch (ApiException e) { - 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/examples/FaxDeleteExample.java b/examples/FaxDeleteExample.java new file mode 100644 index 0000000..f31f0ea --- /dev/null +++ b/examples/FaxDeleteExample.java @@ -0,0 +1,38 @@ +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 FaxDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + new FaxApi(config).faxDelete( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxDelete"); + 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/examples/FaxFiles.java b/examples/FaxFiles.java deleted file mode 100644 index bd6dcc5..0000000 --- a/examples/FaxFiles.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = faxApi.faxFiles(faxId); - result.renameTo(new File("file_response.pdf"));; - } catch (ApiException e) { - 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/examples/FaxFilesExample.java b/examples/FaxFilesExample.java new file mode 100644 index 0000000..a9e1f17 --- /dev/null +++ b/examples/FaxFilesExample.java @@ -0,0 +1,39 @@ +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 FaxFilesExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxFiles"); + 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/examples/FaxGet.java b/examples/FaxGet.java deleted file mode 100644 index a9cc433..0000000 --- a/examples/FaxGet.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FaxGetResponse result = faxApi.faxGet(faxId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/FaxGetExample.java b/examples/FaxGetExample.java new file mode 100644 index 0000000..1500980 --- /dev/null +++ b/examples/FaxGetExample.java @@ -0,0 +1,40 @@ +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 FaxGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // faxId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxGet"); + 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/examples/FaxLineAddUser.java b/examples/FaxLineAddUser.java deleted file mode 100644 index 34e455d..0000000 --- a/examples/FaxLineAddUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineAddUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineAddUser(data); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineAddUserExample.java b/examples/FaxLineAddUserExample.java new file mode 100644 index 0000000..d18bd73 --- /dev/null +++ b/examples/FaxLineAddUserExample.java @@ -0,0 +1,44 @@ +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 FaxLineAddUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineAddUserRequest = new FaxLineAddUserRequest(); + faxLineAddUserRequest.number("[FAX_NUMBER]"); + faxLineAddUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineAddUser( + faxLineAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAddUser"); + 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/examples/FaxLineAreaCodeGet.java b/examples/FaxLineAreaCodeGet.java deleted file mode 100644 index 1df071a..0000000 --- a/examples/FaxLineAreaCodeGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineAreaCodeGetResponse result = faxLineApi.faxLineAreaCodeGet("US", "CA"); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineAreaCodeGetExample.java b/examples/FaxLineAreaCodeGetExample.java new file mode 100644 index 0000000..57d64b4 --- /dev/null +++ b/examples/FaxLineAreaCodeGetExample.java @@ -0,0 +1,43 @@ +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 FaxLineAreaCodeGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineAreaCodeGet( + "US", // country + null, // state + null, // province + null // city + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineAreaCodeGet"); + 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/examples/FaxLineCreate.java b/examples/FaxLineCreate.java deleted file mode 100644 index fca1018..0000000 --- a/examples/FaxLineCreate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineCreateRequest() - .areaCode(209) - .country("US"); - - try { - FaxLineResponse result = faxLineApi.faxLineCreate(data); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineCreateExample.java b/examples/FaxLineCreateExample.java new file mode 100644 index 0000000..1c765fc --- /dev/null +++ b/examples/FaxLineCreateExample.java @@ -0,0 +1,44 @@ +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 FaxLineCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineCreateRequest = new FaxLineCreateRequest(); + faxLineCreateRequest.areaCode(209); + faxLineCreateRequest.country(FaxLineCreateRequest.CountryEnum.US); + + try + { + var response = new FaxLineApi(config).faxLineCreate( + faxLineCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineCreate"); + 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/examples/FaxLineDelete.java b/examples/FaxLineDelete.java deleted file mode 100644 index 6b989d2..0000000 --- a/examples/FaxLineDelete.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineDeleteRequest() - .number("[FAX_NUMBER]"); - - try { - faxLineApi.faxLineDelete(data); - } catch (ApiException e) { - 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/examples/FaxLineDeleteExample.java b/examples/FaxLineDeleteExample.java new file mode 100644 index 0000000..8516f8f --- /dev/null +++ b/examples/FaxLineDeleteExample.java @@ -0,0 +1,41 @@ +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 FaxLineDeleteExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineDeleteRequest = new FaxLineDeleteRequest(); + faxLineDeleteRequest.number("[FAX_NUMBER]"); + + try + { + new FaxLineApi(config).faxLineDelete( + faxLineDeleteRequest + ); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineDelete"); + 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/examples/FaxLineGet.java b/examples/FaxLineGet.java deleted file mode 100644 index 69281b3..0000000 --- a/examples/FaxLineGet.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineResponse result = faxLineApi.faxLineGet("[FAX_NUMBER]"); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineGetExample.java b/examples/FaxLineGetExample.java new file mode 100644 index 0000000..5784253 --- /dev/null +++ b/examples/FaxLineGetExample.java @@ -0,0 +1,40 @@ +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 FaxLineGetExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineGet( + "123-123-1234" // number + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineGet"); + 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/examples/FaxLineList.java b/examples/FaxLineList.java deleted file mode 100644 index df1d0bd..0000000 --- a/examples/FaxLineList.java +++ /dev/null @@ -1,26 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - try { - FaxLineListResponse result = faxLineApi.faxLineList(); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineListExample.java b/examples/FaxLineListExample.java new file mode 100644 index 0000000..0facd7c --- /dev/null +++ b/examples/FaxLineListExample.java @@ -0,0 +1,43 @@ +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 FaxLineListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxLineApi(config).faxLineList( + "ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97", // accountId + 1, // page + 20, // pageSize + null // showTeamLines + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineList"); + 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/examples/FaxLineRemoveUser.java b/examples/FaxLineRemoveUser.java deleted file mode 100644 index 7864b05..0000000 --- a/examples/FaxLineRemoveUser.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxLineApi = new FaxLineApi(apiClient); - - var data = new FaxLineRemoveUserRequest() - .number("[FAX_NUMBER]") - .emailAddress("member@dropboxsign.com"); - - try { - FaxLineResponse result = faxLineApi.faxLineRemoveUser(data); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxLineRemoveUserExample.java b/examples/FaxLineRemoveUserExample.java new file mode 100644 index 0000000..f815f36 --- /dev/null +++ b/examples/FaxLineRemoveUserExample.java @@ -0,0 +1,44 @@ +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 FaxLineRemoveUserExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxLineRemoveUserRequest = new FaxLineRemoveUserRequest(); + faxLineRemoveUserRequest.number("[FAX_NUMBER]"); + faxLineRemoveUserRequest.emailAddress("member@dropboxsign.com"); + + try + { + var response = new FaxLineApi(config).faxLineRemoveUser( + faxLineRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxLineApi#faxLineRemoveUser"); + 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/examples/FaxList.java b/examples/FaxList.java deleted file mode 100644 index 042bb71..0000000 --- a/examples/FaxList.java +++ /dev/null @@ -1,28 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - var page = 1; - var pageSize = 2; - - try { - FaxListResponse result = faxApi.faxList(page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/FaxListExample.java b/examples/FaxListExample.java new file mode 100644 index 0000000..c44f536 --- /dev/null +++ b/examples/FaxListExample.java @@ -0,0 +1,41 @@ +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 FaxListExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + var response = new FaxApi(config).faxList( + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxList"); + 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/examples/FaxSend.java b/examples/FaxSend.java deleted file mode 100644 index 4e764da..0000000 --- a/examples/FaxSend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - var faxApi = new FaxApi(apiClient); - - - var data = new FaxSendRequest() - .addFilesItem(new File("example_fax.pdf")) - .testMode(true) - .recipient("16690000001") - .sender("16690000000") - .coverPageTo("Jill Fax") - .coverPageMessage("I'm sending you a fax!") - .coverPageFrom("Faxer Faxerson") - .title("This is what the fax is about!"); - - try { - FaxCreateResponse result = faxApi.faxSend(data); - System.out.println(result); - } catch (ApiException e) { - 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/examples/FaxSendExample.java b/examples/FaxSendExample.java new file mode 100644 index 0000000..9648b87 --- /dev/null +++ b/examples/FaxSendExample.java @@ -0,0 +1,52 @@ +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 FaxSendExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var faxSendRequest = new FaxSendRequest(); + faxSendRequest.recipient("16690000001"); + faxSendRequest.sender("16690000000"); + faxSendRequest.testMode(true); + faxSendRequest.coverPageTo("Jill Fax"); + faxSendRequest.coverPageFrom("Faxer Faxerson"); + faxSendRequest.coverPageMessage("I'm sending you a fax!"); + faxSendRequest.title("This is what the fax is about!"); + faxSendRequest.files(List.of ( + new File("./example_fax.pdf") + )); + + try + { + var response = new FaxApi(config).faxSend( + faxSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling FaxApi#faxSend"); + 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/examples/OauthTokenGenerate.java b/examples/OauthTokenGenerate.java deleted file mode 100644 index b8a5ebf..0000000 --- a/examples/OauthTokenGenerate.java +++ /dev/null @@ -1,30 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenGenerateRequest() - .state("900e06e2") - .code("1b0d28d90c86c141") - .clientId("cc91c61d00f8bb2ece1428035716b") - .clientSecret("1d14434088507ffa390e6f5528465"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenGenerate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/OauthTokenGenerateExample.java b/examples/OauthTokenGenerateExample.java new file mode 100644 index 0000000..24bbb65 --- /dev/null +++ b/examples/OauthTokenGenerateExample.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 OauthTokenGenerateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenGenerateRequest = new OAuthTokenGenerateRequest(); + oAuthTokenGenerateRequest.clientId("cc91c61d00f8bb2ece1428035716b"); + oAuthTokenGenerateRequest.clientSecret("1d14434088507ffa390e6f5528465"); + oAuthTokenGenerateRequest.code("1b0d28d90c86c141"); + oAuthTokenGenerateRequest.state("900e06e2"); + oAuthTokenGenerateRequest.grantType("authorization_code"); + + try + { + var response = new OAuthApi(config).oauthTokenGenerate( + oAuthTokenGenerateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenGenerate"); + 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/examples/OauthTokenRefresh.java b/examples/OauthTokenRefresh.java deleted file mode 100644 index 8add0c1..0000000 --- a/examples/OauthTokenRefresh.java +++ /dev/null @@ -1,27 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient(); - - var oAuthApi = new OAuthApi(apiClient); - - var data = new OAuthTokenRefreshRequest() - .refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); - - try { - OAuthTokenResponse result = oAuthApi.oauthTokenRefresh(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/OauthTokenRefreshExample.java b/examples/OauthTokenRefreshExample.java new file mode 100644 index 0000000..f79562e --- /dev/null +++ b/examples/OauthTokenRefreshExample.java @@ -0,0 +1,43 @@ +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 OauthTokenRefreshExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + + var oAuthTokenRefreshRequest = new OAuthTokenRefreshRequest(); + oAuthTokenRefreshRequest.grantType("refresh_token"); + oAuthTokenRefreshRequest.refreshToken("hNTI2MTFmM2VmZDQxZTZjOWRmZmFjZmVmMGMyNGFjMzI2MGI5YzgzNmE3"); + + try + { + var response = new OAuthApi(config).oauthTokenRefresh( + oAuthTokenRefreshRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling OAuthApi#oauthTokenRefresh"); + 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/examples/ReportCreate.java b/examples/ReportCreate.java deleted file mode 100644 index 038f03b..0000000 --- a/examples/ReportCreate.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var reportApi = new ReportApi(apiClient); - - var data = new ReportCreateRequest() - .startDate("09/01/2020") - .endDate("09/01/2020") - .reportType(List.of( - ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, - ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS - )); - - try { - ReportCreateResponse result = reportApi.reportCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/ReportCreateExample.java b/examples/ReportCreateExample.java new file mode 100644 index 0000000..2f0013c --- /dev/null +++ b/examples/ReportCreateExample.java @@ -0,0 +1,48 @@ +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 ReportCreateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var reportCreateRequest = new ReportCreateRequest(); + reportCreateRequest.startDate("09/01/2020"); + reportCreateRequest.endDate("09/01/2020"); + reportCreateRequest.reportType(List.of ( + ReportCreateRequest.ReportTypeEnum.USER_ACTIVITY, + ReportCreateRequest.ReportTypeEnum.DOCUMENT_STATUS + )); + + try + { + var response = new ReportApi(config).reportCreate( + reportCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling ReportApi#reportCreate"); + 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/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java deleted file mode 100644 index babaca3..0000000 --- a/examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC().role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java new file mode 100644 index 0000000..a5bec1f --- /dev/null +++ b/examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,108 @@ +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 SignatureRequestBulkCreateEmbeddedWithTemplateExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + var signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkCreateEmbeddedWithTemplateRequest = new SignatureRequestBulkCreateEmbeddedWithTemplateRequest(); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.clientId("1a659d9ad95bccd307ecad78d72192f8"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.signerList(signerList); + signatureRequestBulkCreateEmbeddedWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkCreateEmbeddedWithTemplate( + signatureRequestBulkCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkCreateEmbeddedWithTemplate"); + 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/examples/SignatureRequestBulkSendWithTemplate.java b/examples/SignatureRequestBulkSendWithTemplate.java deleted file mode 100644 index 960d1cb..0000000 --- a/examples/SignatureRequestBulkSendWithTemplate.java +++ /dev/null @@ -1,73 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signerList1Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com") - .pin("d79a3td"); - - var signerList1CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("ABC Corp"); - - var signerList1 = new SubBulkSignerList() - .signers(List.of(signerList1Signer)) - .customFields(List.of(signerList1CustomFields)); - - var signerList2Signer = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("Mary") - .emailAddress("mary@example.com") - .pin("gd9as5b"); - - var signerList2CustomFields = new SubBulkSignerListCustomField() - .name("company") - .value("123 Corp"); - - var signerList2 = new SubBulkSignerList() - .signers(List.of(signerList2Signer)) - .customFields(List.of(signerList2CustomFields)); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new SignatureRequestBulkSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signerList(List.of(signerList1, signerList2)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - BulkSendJobSendResponse result = signatureRequestApi.signatureRequestBulkSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestBulkSendWithTemplateExample.java b/examples/SignatureRequestBulkSendWithTemplateExample.java new file mode 100644 index 0000000..b539626 --- /dev/null +++ b/examples/SignatureRequestBulkSendWithTemplateExample.java @@ -0,0 +1,108 @@ +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 SignatureRequestBulkSendWithTemplateExample +{ + 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 signerList2CustomFields1 = new SubBulkSignerListCustomField(); + signerList2CustomFields1.name("company"); + signerList2CustomFields1.value("123 LLC"); + + var signerList2CustomFields = new ArrayList(List.of ( + signerList2CustomFields1 + )); + + var signerList2Signers1 = new SubSignatureRequestTemplateSigner(); + signerList2Signers1.role("Client"); + signerList2Signers1.name("Mary"); + signerList2Signers1.emailAddress("mary@example.com"); + signerList2Signers1.pin("gd9as5b"); + + var signerList2Signers = new ArrayList(List.of ( + signerList2Signers1 + )); + + var signerList1CustomFields1 = new SubBulkSignerListCustomField(); + signerList1CustomFields1.name("company"); + signerList1CustomFields1.value("ABC Corp"); + + var signerList1CustomFields = new ArrayList(List.of ( + signerList1CustomFields1 + )); + + var signerList1Signers1 = new SubSignatureRequestTemplateSigner(); + signerList1Signers1.role("Client"); + signerList1Signers1.name("George"); + signerList1Signers1.emailAddress("george@example.com"); + signerList1Signers1.pin("d79a3td"); + + var signerList1Signers = new ArrayList(List.of ( + signerList1Signers1 + )); + + var signerList1 = new SubBulkSignerList(); + signerList1.customFields(signerList1CustomFields); + signerList1.signers(signerList1Signers); + + var signerList2 = new SubBulkSignerList(); + signerList2.customFields(signerList2CustomFields); + signerList2.signers(signerList2Signers); + + var signerList = new ArrayList(List.of ( + signerList1, + signerList2 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signatureRequestBulkSendWithTemplateRequest = new SignatureRequestBulkSendWithTemplateRequest(); + signatureRequestBulkSendWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestBulkSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestBulkSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestBulkSendWithTemplateRequest.testMode(true); + signatureRequestBulkSendWithTemplateRequest.signerList(signerList); + signatureRequestBulkSendWithTemplateRequest.ccs(ccs); + + try + { + var response = new SignatureRequestApi(config).signatureRequestBulkSendWithTemplate( + signatureRequestBulkSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestBulkSendWithTemplate"); + 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/examples/SignatureRequestCancel.java b/examples/SignatureRequestCancel.java deleted file mode 100644 index 20c1659..0000000 --- a/examples/SignatureRequestCancel.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestCancel(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestCancelExample.java b/examples/SignatureRequestCancelExample.java new file mode 100644 index 0000000..076a73d --- /dev/null +++ b/examples/SignatureRequestCancelExample.java @@ -0,0 +1,39 @@ +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 SignatureRequestCancelExample +{ + 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"); + + try + { + new SignatureRequestApi(config).signatureRequestCancel( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCancel"); + 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/examples/SignatureRequestCreateEmbedded.java b/examples/SignatureRequestCreateEmbedded.java deleted file mode 100644 index 3697f21..0000000 --- a/examples/SignatureRequestCreateEmbedded.java +++ /dev/null @@ -1,62 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestCreateEmbeddedExample.java b/examples/SignatureRequestCreateEmbeddedExample.java new file mode 100644 index 0000000..5193cee --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedExample.java @@ -0,0 +1,79 @@ +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 SignatureRequestCreateEmbeddedExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + 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/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java new file mode 100644 index 0000000..b069e20 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedGroupedSignersExample.java @@ -0,0 +1,105 @@ +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 SignatureRequestCreateEmbeddedGroupedSignersExample +{ + 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 groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestCreateEmbeddedRequest = new SignatureRequestCreateEmbeddedRequest(); + signatureRequestCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestCreateEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestCreateEmbeddedRequest.testMode(true); + signatureRequestCreateEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestCreateEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestCreateEmbeddedRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbedded( + signatureRequestCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbedded"); + 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/examples/SignatureRequestCreateEmbeddedWithTemplate.java b/examples/SignatureRequestCreateEmbeddedWithTemplate.java deleted file mode 100644 index 96d14e5..0000000 --- a/examples/SignatureRequestCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,53 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestCreateEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java new file mode 100644 index 0000000..309d422 --- /dev/null +++ b/examples/SignatureRequestCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +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 SignatureRequestCreateEmbeddedWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestCreateEmbeddedWithTemplateRequest = new SignatureRequestCreateEmbeddedWithTemplateRequest(); + signatureRequestCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestCreateEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestCreateEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestCreateEmbeddedWithTemplateRequest.testMode(true); + signatureRequestCreateEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestCreateEmbeddedWithTemplate( + signatureRequestCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestCreateEmbeddedWithTemplate"); + 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/examples/SignatureRequestEdit.java b/examples/SignatureRequestEdit.java deleted file mode 100644 index 163b663..0000000 --- a/examples/SignatureRequestEdit.java +++ /dev/null @@ -1,69 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEdit(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestEditEmbedded.java b/examples/SignatureRequestEditEmbedded.java deleted file mode 100644 index a9e0ddd..0000000 --- a/examples/SignatureRequestEditEmbedded.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbedded( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); - 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/examples/SignatureRequestEditEmbeddedExample.java b/examples/SignatureRequestEditEmbeddedExample.java new file mode 100644 index 0000000..c69cc85 --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedExample.java @@ -0,0 +1,80 @@ +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 SignatureRequestEditEmbeddedExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + 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/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java new file mode 100644 index 0000000..d526e3d --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedGroupedSignersExample.java @@ -0,0 +1,106 @@ +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 SignatureRequestEditEmbeddedGroupedSignersExample +{ + 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 groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditEmbeddedRequest = new SignatureRequestEditEmbeddedRequest(); + signatureRequestEditEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditEmbeddedRequest.subject("The NDA we talked about"); + signatureRequestEditEmbeddedRequest.testMode(true); + signatureRequestEditEmbeddedRequest.title("NDA with Acme Co."); + signatureRequestEditEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditEmbeddedRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditEmbeddedRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbedded( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbedded"); + 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/examples/SignatureRequestEditEmbeddedWithTemplate.java b/examples/SignatureRequestEditEmbeddedWithTemplate.java deleted file mode 100644 index c9b68d0..0000000 --- a/examples/SignatureRequestEditEmbeddedWithTemplate.java +++ /dev/null @@ -1,58 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .name("George"); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditEmbeddedWithTemplateRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .signingOptions(subSigningOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditEmbeddedWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling SignatureRequestApi#editEmbeddedWithTemplate"); - 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/examples/SignatureRequestEditEmbeddedWithTemplateExample.java b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java new file mode 100644 index 0000000..b0c034f --- /dev/null +++ b/examples/SignatureRequestEditEmbeddedWithTemplateExample.java @@ -0,0 +1,69 @@ +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 SignatureRequestEditEmbeddedWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var signatureRequestEditEmbeddedWithTemplateRequest = new SignatureRequestEditEmbeddedWithTemplateRequest(); + signatureRequestEditEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + signatureRequestEditEmbeddedWithTemplateRequest.templateIds(List.of ( + "c26b8a16784a872da37ea946b9ddec7c1e11dff6" + )); + signatureRequestEditEmbeddedWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditEmbeddedWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditEmbeddedWithTemplateRequest.testMode(true); + signatureRequestEditEmbeddedWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditEmbeddedWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditEmbeddedWithTemplate"); + 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/examples/SignatureRequestEditExample.java b/examples/SignatureRequestEditExample.java new file mode 100644 index 0000000..ee628de --- /dev/null +++ b/examples/SignatureRequestEditExample.java @@ -0,0 +1,89 @@ +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 SignatureRequestEditExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + 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/examples/SignatureRequestEditGroupedSignersExample.java b/examples/SignatureRequestEditGroupedSignersExample.java new file mode 100644 index 0000000..934764b --- /dev/null +++ b/examples/SignatureRequestEditGroupedSignersExample.java @@ -0,0 +1,115 @@ +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 SignatureRequestEditGroupedSignersExample +{ + 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 groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestEditRequest = new SignatureRequestEditRequest(); + signatureRequestEditRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestEditRequest.subject("The NDA we talked about"); + signatureRequestEditRequest.testMode(true); + signatureRequestEditRequest.title("NDA with Acme Co."); + signatureRequestEditRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestEditRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestEditRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestEditRequest.fieldOptions(fieldOptions); + signatureRequestEditRequest.signingOptions(signingOptions); + signatureRequestEditRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEdit( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEdit"); + 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/examples/SignatureRequestEditWithTemplate.java b/examples/SignatureRequestEditWithTemplate.java deleted file mode 100644 index da66772..0000000 --- a/examples/SignatureRequestEditWithTemplate.java +++ /dev/null @@ -1,70 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestEditWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestEditWithTemplate( - signatureRequestId, - data - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestEditWithTemplateExample.java b/examples/SignatureRequestEditWithTemplateExample.java new file mode 100644 index 0000000..d755e4e --- /dev/null +++ b/examples/SignatureRequestEditWithTemplateExample.java @@ -0,0 +1,88 @@ +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 SignatureRequestEditWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestEditWithTemplateRequest = new SignatureRequestEditWithTemplateRequest(); + signatureRequestEditWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestEditWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestEditWithTemplateRequest.subject("Purchase Order"); + signatureRequestEditWithTemplateRequest.testMode(true); + signatureRequestEditWithTemplateRequest.signingOptions(signingOptions); + signatureRequestEditWithTemplateRequest.signers(signers); + signatureRequestEditWithTemplateRequest.ccs(ccs); + signatureRequestEditWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestEditWithTemplate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestEditWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestEditWithTemplate"); + 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/examples/SignatureRequestFiles.java b/examples/SignatureRequestFiles.java deleted file mode 100644 index ca70f23..0000000 --- a/examples/SignatureRequestFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - File result = signatureRequestApi.signatureRequestFiles(signatureRequestId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestFilesAsDataUri.java b/examples/SignatureRequestFilesAsDataUri.java deleted file mode 100644 index b902223..0000000 --- a/examples/SignatureRequestFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponseDataUri result = signatureRequestApi.signatureRequestFilesAsDataUri(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestFilesAsDataUriExample.java b/examples/SignatureRequestFilesAsDataUriExample.java new file mode 100644 index 0000000..a7e5a36 --- /dev/null +++ b/examples/SignatureRequestFilesAsDataUriExample.java @@ -0,0 +1,41 @@ +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 SignatureRequestFilesAsDataUriExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsDataUri( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsDataUri"); + 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/examples/SignatureRequestFilesAsFileUrl.java b/examples/SignatureRequestFilesAsFileUrl.java deleted file mode 100644 index 7bf3b99..0000000 --- a/examples/SignatureRequestFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - FileResponse result = signatureRequestApi.signatureRequestFilesAsFileUrl(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestFilesAsFileUrlExample.java b/examples/SignatureRequestFilesAsFileUrlExample.java new file mode 100644 index 0000000..2a024ee --- /dev/null +++ b/examples/SignatureRequestFilesAsFileUrlExample.java @@ -0,0 +1,42 @@ +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 SignatureRequestFilesAsFileUrlExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFilesAsFileUrl( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFilesAsFileUrl"); + 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/examples/SignatureRequestFilesExample.java b/examples/SignatureRequestFilesExample.java new file mode 100644 index 0000000..53e8281 --- /dev/null +++ b/examples/SignatureRequestFilesExample.java @@ -0,0 +1,41 @@ +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 SignatureRequestFilesExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestFiles( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + "pdf" // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestFiles"); + 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/examples/SignatureRequestGet.java b/examples/SignatureRequestGet.java deleted file mode 100644 index 78e4af5..0000000 --- a/examples/SignatureRequestGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestGet(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestGetExample.java b/examples/SignatureRequestGetExample.java new file mode 100644 index 0000000..dc91272 --- /dev/null +++ b/examples/SignatureRequestGetExample.java @@ -0,0 +1,41 @@ +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 SignatureRequestGetExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestGet( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestGet"); + 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/examples/SignatureRequestList.java b/examples/SignatureRequestList.java deleted file mode 100644 index 1afcd8b..0000000 --- a/examples/SignatureRequestList.java +++ /dev/null @@ -1,41 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var accountId = "accountId"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - SignatureRequestListResponse result = signatureRequestApi.signatureRequestList( - accountId, - page, - pageSize, - query - ); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestListExample.java b/examples/SignatureRequestListExample.java new file mode 100644 index 0000000..72048a0 --- /dev/null +++ b/examples/SignatureRequestListExample.java @@ -0,0 +1,44 @@ +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 SignatureRequestListExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestList"); + 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/examples/SignatureRequestReleaseHold.java b/examples/SignatureRequestReleaseHold.java deleted file mode 100644 index c17085a..0000000 --- a/examples/SignatureRequestReleaseHold.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestReleaseHold(signatureRequestId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestReleaseHoldExample.java b/examples/SignatureRequestReleaseHoldExample.java new file mode 100644 index 0000000..a7fd42c --- /dev/null +++ b/examples/SignatureRequestReleaseHoldExample.java @@ -0,0 +1,41 @@ +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 SignatureRequestReleaseHoldExample +{ + 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"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestReleaseHold( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestReleaseHold"); + 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/examples/SignatureRequestRemind.java b/examples/SignatureRequestRemind.java deleted file mode 100644 index be5d42a..0000000 --- a/examples/SignatureRequestRemind.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestRemindRequest() - .emailAddress("john@example.com"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestRemind(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestRemindExample.java b/examples/SignatureRequestRemindExample.java new file mode 100644 index 0000000..ce292ba --- /dev/null +++ b/examples/SignatureRequestRemindExample.java @@ -0,0 +1,45 @@ +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 SignatureRequestRemindExample +{ + 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 signatureRequestRemindRequest = new SignatureRequestRemindRequest(); + signatureRequestRemindRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestRemind( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestRemindRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemind"); + 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/examples/SignatureRequestRemove.java b/examples/SignatureRequestRemove.java deleted file mode 100644 index 90ba45b..0000000 --- a/examples/SignatureRequestRemove.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - try { - signatureRequestApi.signatureRequestRemove(signatureRequestId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestRemoveExample.java b/examples/SignatureRequestRemoveExample.java new file mode 100644 index 0000000..e9b030a --- /dev/null +++ b/examples/SignatureRequestRemoveExample.java @@ -0,0 +1,38 @@ +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 SignatureRequestRemoveExample +{ + public static void main(String[] args) + { + var config = Configuration.getDefaultApiClient(); + ((HttpBasicAuth) config.getAuthentication("api_key")).setUsername("YOUR_API_KEY"); + + try + { + new SignatureRequestApi(config).signatureRequestRemove( + "fa5c8a0b0f492d768749333ad6fcc214c111e967" // signatureRequestId + ); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestRemove"); + 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/examples/SignatureRequestSend.java b/examples/SignatureRequestSend.java deleted file mode 100644 index 4382c85..0000000 --- a/examples/SignatureRequestSend.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubSignatureRequestSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(true) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new SignatureRequestSendRequest() - .title("NDA with Acme Co.") - .subject("The NDA we talked about") - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(signingOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSend(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestSendExample.java b/examples/SignatureRequestSendExample.java new file mode 100644 index 0000000..313b895 --- /dev/null +++ b/examples/SignatureRequestSendExample.java @@ -0,0 +1,88 @@ +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 SignatureRequestSendExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers2 = new SubSignatureRequestSigner(); + signers2.name("Jill"); + signers2.emailAddress("jill@example.com"); + signers2.order(1); + + var signers = new ArrayList(List.of ( + signers1, + signers2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.signers(signers); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + 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/examples/SignatureRequestSendGroupedSignersExample.java b/examples/SignatureRequestSendGroupedSignersExample.java new file mode 100644 index 0000000..ba07857 --- /dev/null +++ b/examples/SignatureRequestSendGroupedSignersExample.java @@ -0,0 +1,114 @@ +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 SignatureRequestSendGroupedSignersExample +{ + 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 groupedSigners2Signers1 = new SubSignatureRequestSigner(); + groupedSigners2Signers1.name("Bob"); + groupedSigners2Signers1.emailAddress("bob@example.com"); + + var groupedSigners2Signers2 = new SubSignatureRequestSigner(); + groupedSigners2Signers2.name("Charlie"); + groupedSigners2Signers2.emailAddress("charlie@example.com"); + + var groupedSigners2Signers = new ArrayList(List.of ( + groupedSigners2Signers1, + groupedSigners2Signers2 + )); + + var groupedSigners1Signers1 = new SubSignatureRequestSigner(); + groupedSigners1Signers1.name("Jack"); + groupedSigners1Signers1.emailAddress("jack@example.com"); + + var groupedSigners1Signers2 = new SubSignatureRequestSigner(); + groupedSigners1Signers2.name("Jill"); + groupedSigners1Signers2.emailAddress("jill@example.com"); + + var groupedSigners1Signers = new ArrayList(List.of ( + groupedSigners1Signers1, + groupedSigners1Signers2 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var groupedSigners1 = new SubSignatureRequestGroupedSigners(); + groupedSigners1.group("Group #1"); + groupedSigners1.order(0); + groupedSigners1.signers(groupedSigners1Signers); + + var groupedSigners2 = new SubSignatureRequestGroupedSigners(); + groupedSigners2.group("Group #2"); + groupedSigners2.order(1); + groupedSigners2.signers(groupedSigners2Signers); + + var groupedSigners = new ArrayList(List.of ( + groupedSigners1, + groupedSigners2 + )); + + var signatureRequestSendRequest = new SignatureRequestSendRequest(); + signatureRequestSendRequest.message("Please sign this NDA and then we can discuss more. Let me know if you\nhave any questions."); + signatureRequestSendRequest.subject("The NDA we talked about"); + signatureRequestSendRequest.testMode(true); + signatureRequestSendRequest.title("NDA with Acme Co."); + signatureRequestSendRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + signatureRequestSendRequest.ccEmailAddresses(List.of ( + "lawyer1@dropboxsign.com", + "lawyer2@dropboxsign.com" + )); + signatureRequestSendRequest.metadata(JSON.deserialize(""" + { + "custom_id": 1234, + "custom_text": "NDA #9" + } + """, Map.class)); + signatureRequestSendRequest.fieldOptions(fieldOptions); + signatureRequestSendRequest.signingOptions(signingOptions); + signatureRequestSendRequest.groupedSigners(groupedSigners); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSend( + signatureRequestSendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSend"); + 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/examples/SignatureRequestSendWithTemplate.java b/examples/SignatureRequestSendWithTemplate.java deleted file mode 100644 index 1907e4d..0000000 --- a/examples/SignatureRequestSendWithTemplate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signer1 = new SubSignatureRequestTemplateSigner() - .role("Client") - .emailAddress("george@example.com") - .name("George"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@emaple.com"); - - var customField1 = new SubCustomField() - .name("Cost") - .value("$20,000") - .editor("Client") - .required(true); - - var signingOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var data = new SignatureRequestSendWithTemplateRequest() - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .subject("Purchase Order") - .message("Glad we could come to an agreement.") - .signers(List.of(signer1)) - .ccs(List.of(cc1)) - .customFields(List.of(customField1)) - .signingOptions(signingOptions) - .testMode(true); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestSendWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestSendWithTemplateExample.java b/examples/SignatureRequestSendWithTemplateExample.java new file mode 100644 index 0000000..f44a67e --- /dev/null +++ b/examples/SignatureRequestSendWithTemplateExample.java @@ -0,0 +1,87 @@ +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 SignatureRequestSendWithTemplateExample +{ + 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 signingOptions = new SubSigningOptions(); + signingOptions.defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); + signingOptions.draw(true); + signingOptions.phone(false); + signingOptions.type(true); + signingOptions.upload(true); + + var signers1 = new SubSignatureRequestTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@example.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var customFields1 = new SubCustomField(); + customFields1.name("Cost"); + customFields1.editor("Client"); + customFields1.required(true); + customFields1.value("$20,000"); + + var customFields = new ArrayList(List.of ( + customFields1 + )); + + var signatureRequestSendWithTemplateRequest = new SignatureRequestSendWithTemplateRequest(); + signatureRequestSendWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + signatureRequestSendWithTemplateRequest.message("Glad we could come to an agreement."); + signatureRequestSendWithTemplateRequest.subject("Purchase Order"); + signatureRequestSendWithTemplateRequest.testMode(true); + signatureRequestSendWithTemplateRequest.signingOptions(signingOptions); + signatureRequestSendWithTemplateRequest.signers(signers); + signatureRequestSendWithTemplateRequest.ccs(ccs); + signatureRequestSendWithTemplateRequest.customFields(customFields); + + try + { + var response = new SignatureRequestApi(config).signatureRequestSendWithTemplate( + signatureRequestSendWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestSendWithTemplate"); + 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/examples/SignatureRequestUpdate.java b/examples/SignatureRequestUpdate.java deleted file mode 100644 index aca14a2..0000000 --- a/examples/SignatureRequestUpdate.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var signatureRequestApi = new SignatureRequestApi(apiClient); - - var signatureRequestId = "2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"; - - var data = new SignatureRequestUpdateRequest() - .emailAddress("john@example.com") - .signatureId("78caf2a1d01cd39cea2bc1cbb340dac3"); - - try { - SignatureRequestGetResponse result = signatureRequestApi.signatureRequestUpdate(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/SignatureRequestUpdateExample.java b/examples/SignatureRequestUpdateExample.java new file mode 100644 index 0000000..3500c76 --- /dev/null +++ b/examples/SignatureRequestUpdateExample.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 SignatureRequestUpdateExample +{ + 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 signatureRequestUpdateRequest = new SignatureRequestUpdateRequest(); + signatureRequestUpdateRequest.signatureId("2f9781e1a8e2045224d808c153c2e1d3df6f8f2f"); + signatureRequestUpdateRequest.emailAddress("john@example.com"); + + try + { + var response = new SignatureRequestApi(config).signatureRequestUpdate( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + signatureRequestUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling SignatureRequestApi#signatureRequestUpdate"); + 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/examples/TeamAddMember.java b/examples/TeamAddMember.java deleted file mode 100644 index 4548209..0000000 --- a/examples/TeamAddMember.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamAddMemberRequest() - .emailAddress("george@example.com"); - - String teamId = null; - - try { - TeamGetResponse result = teamApi.teamAddMember(data, teamId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamAddMemberAccountIdExample.java b/examples/TeamAddMemberAccountIdExample.java new file mode 100644 index 0000000..1aea584 --- /dev/null +++ b/examples/TeamAddMemberAccountIdExample.java @@ -0,0 +1,45 @@ +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 TeamAddMemberAccountIdExample +{ + 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 teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + 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/examples/TeamAddMemberExample.java b/examples/TeamAddMemberExample.java new file mode 100644 index 0000000..6e3af40 --- /dev/null +++ b/examples/TeamAddMemberExample.java @@ -0,0 +1,45 @@ +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 TeamAddMemberExample +{ + 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 teamAddMemberRequest = new TeamAddMemberRequest(); + teamAddMemberRequest.emailAddress("george@example.com"); + + try + { + var response = new TeamApi(config).teamAddMember( + teamAddMemberRequest, + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamAddMember"); + 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/examples/TeamCreate.java b/examples/TeamCreate.java deleted file mode 100644 index 0ecf2f5..0000000 --- a/examples/TeamCreate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamCreateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamCreateExample.java b/examples/TeamCreateExample.java new file mode 100644 index 0000000..ecfe232 --- /dev/null +++ b/examples/TeamCreateExample.java @@ -0,0 +1,44 @@ +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 TeamCreateExample +{ + 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 teamCreateRequest = new TeamCreateRequest(); + teamCreateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamCreate( + teamCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamCreate"); + 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/examples/TeamDelete.java b/examples/TeamDelete.java deleted file mode 100644 index 9f09ef6..0000000 --- a/examples/TeamDelete.java +++ /dev/null @@ -1,29 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - teamApi.teamDelete(); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamDeleteExample.java b/examples/TeamDeleteExample.java new file mode 100644 index 0000000..076a2e5 --- /dev/null +++ b/examples/TeamDeleteExample.java @@ -0,0 +1,37 @@ +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 TeamDeleteExample +{ + 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"); + + try + { + new TeamApi(config).teamDelete(); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamDelete"); + 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/examples/TeamGet.java b/examples/TeamGet.java deleted file mode 100644 index 035014b..0000000 --- a/examples/TeamGet.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetResponse result = teamApi.teamGet(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamGetExample.java b/examples/TeamGetExample.java new file mode 100644 index 0000000..8ab6d74 --- /dev/null +++ b/examples/TeamGetExample.java @@ -0,0 +1,39 @@ +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 TeamGetExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamGet(); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamGet"); + 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/examples/TeamInfo.java b/examples/TeamInfo.java deleted file mode 100644 index 94ace0c..0000000 --- a/examples/TeamInfo.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - try { - TeamGetInfoResponse result = teamApi.teamInfo(); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamInfo"); - 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/examples/TeamInfoExample.java b/examples/TeamInfoExample.java new file mode 100644 index 0000000..6f2c882 --- /dev/null +++ b/examples/TeamInfoExample.java @@ -0,0 +1,41 @@ +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 TeamInfoExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamInfo( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c" // teamId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInfo"); + 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/examples/TeamInvites.java b/examples/TeamInvites.java deleted file mode 100644 index 56b517b..0000000 --- a/examples/TeamInvites.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var emailAddress = "user@dropboxsign.com"; - - try { - TeamInvitesResponse result = teamApi.teamInvites(emailAddress); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - 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/examples/TeamInvitesExample.java b/examples/TeamInvitesExample.java new file mode 100644 index 0000000..f6d2b55 --- /dev/null +++ b/examples/TeamInvitesExample.java @@ -0,0 +1,41 @@ +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 TeamInvitesExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamInvites( + null // emailAddress + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamInvites"); + 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/examples/TeamMembers.java b/examples/TeamMembers.java deleted file mode 100644 index c357956..0000000 --- a/examples/TeamMembers.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamMembersResponse result = teamApi.teamMembers(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamMembers"); - 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/examples/TeamMembersExample.java b/examples/TeamMembersExample.java new file mode 100644 index 0000000..7499947 --- /dev/null +++ b/examples/TeamMembersExample.java @@ -0,0 +1,43 @@ +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 TeamMembersExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamMembers( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamMembers"); + 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/examples/TeamRemoveMember.java b/examples/TeamRemoveMember.java deleted file mode 100644 index 28514c7..0000000 --- a/examples/TeamRemoveMember.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamRemoveMemberRequest() - .emailAddress("teammate@dropboxsign.com") - .newOwnerEmailAddress("new_teammate@dropboxsign.com"); - - try { - TeamGetResponse result = teamApi.teamRemoveMember(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamRemoveMemberAccountIdExample.java b/examples/TeamRemoveMemberAccountIdExample.java new file mode 100644 index 0000000..d2d4ded --- /dev/null +++ b/examples/TeamRemoveMemberAccountIdExample.java @@ -0,0 +1,44 @@ +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 TeamRemoveMemberAccountIdExample +{ + 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 teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.accountId("f57db65d3f933b5316d398057a36176831451a35"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + 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/examples/TeamRemoveMemberExample.java b/examples/TeamRemoveMemberExample.java new file mode 100644 index 0000000..e68187a --- /dev/null +++ b/examples/TeamRemoveMemberExample.java @@ -0,0 +1,45 @@ +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 TeamRemoveMemberExample +{ + 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 teamRemoveMemberRequest = new TeamRemoveMemberRequest(); + teamRemoveMemberRequest.emailAddress("teammate@dropboxsign.com"); + teamRemoveMemberRequest.newOwnerEmailAddress("new_teammate@dropboxsign.com"); + + try + { + var response = new TeamApi(config).teamRemoveMember( + teamRemoveMemberRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamRemoveMember"); + 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/examples/TeamSubTeams.java b/examples/TeamSubTeams.java deleted file mode 100644 index f4a5b50..0000000 --- a/examples/TeamSubTeams.java +++ /dev/null @@ -1,35 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c"; - var page = 1; - var pageSize = 20; - - try { - TeamSubTeamsResponse result = teamApi.teamSubTeams(teamId, page, pageSize); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling TeamApi#teamSubTeams"); - 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/examples/TeamSubTeamsExample.java b/examples/TeamSubTeamsExample.java new file mode 100644 index 0000000..4ab0bc0 --- /dev/null +++ b/examples/TeamSubTeamsExample.java @@ -0,0 +1,43 @@ +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 TeamSubTeamsExample +{ + 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"); + + try + { + var response = new TeamApi(config).teamSubTeams( + "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c", // teamId + 1, // page + 20 // pageSize + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamSubTeams"); + 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/examples/TeamUpdate.java b/examples/TeamUpdate.java deleted file mode 100644 index eedcafc..0000000 --- a/examples/TeamUpdate.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var teamApi = new TeamApi(apiClient); - - var data = new TeamUpdateRequest() - .name("New Team Name"); - - try { - TeamGetResponse result = teamApi.teamUpdate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TeamUpdateExample.java b/examples/TeamUpdateExample.java new file mode 100644 index 0000000..e819032 --- /dev/null +++ b/examples/TeamUpdateExample.java @@ -0,0 +1,44 @@ +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 TeamUpdateExample +{ + 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 teamUpdateRequest = new TeamUpdateRequest(); + teamUpdateRequest.name("New Team Name"); + + try + { + var response = new TeamApi(config).teamUpdate( + teamUpdateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TeamApi#teamUpdate"); + 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/examples/TemplateAddUser.java b/examples/TemplateAddUser.java deleted file mode 100644 index 759990b..0000000 --- a/examples/TemplateAddUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateAddUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateAddUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateAddUserExample.java b/examples/TemplateAddUserExample.java new file mode 100644 index 0000000..3649e46 --- /dev/null +++ b/examples/TemplateAddUserExample.java @@ -0,0 +1,45 @@ +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 TemplateAddUserExample +{ + 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 templateAddUserRequest = new TemplateAddUserRequest(); + templateAddUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateAddUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateAddUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateAddUser"); + 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/examples/TemplateCreate.java b/examples/TemplateCreate.java deleted file mode 100644 index f2cd599..0000000 --- a/examples/TemplateCreate.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateResponse result = templateApi.templateCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateCreateEmbeddedDraft.java b/examples/TemplateCreateEmbeddedDraft.java deleted file mode 100644 index 7ae46b4..0000000 --- a/examples/TemplateCreateEmbeddedDraft.java +++ /dev/null @@ -1,65 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var role1 = new SubTemplateRole() - .name("Client") - .order(0); - - var role2 = new SubTemplateRole() - .name("Witness") - .order(1); - - var mergeField1 = new SubMergeField() - .name("Full Name") - .type(SubMergeField.TypeEnum.TEXT); - - var mergeField2 = new SubMergeField() - .name("Is Registered?") - .type(SubMergeField.TypeEnum.CHECKBOX); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DDMMYYYY); - - var data = new TemplateCreateEmbeddedDraftRequest() - .clientId("37dee8d8440c66d54cfa05d92c160882") - .addFilesItem(new File("example_signature_request.pdf")) - .title("Test Template") - .subject("Please sign this document") - .message("For your approval") - .signerRoles(List.of(role1, role2)) - .ccRoles(List.of("Manager")) - .mergeFields(List.of(mergeField1, mergeField2)) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - TemplateCreateEmbeddedDraftResponse result = templateApi.templateCreateEmbeddedDraft(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateCreateEmbeddedDraftExample.java b/examples/TemplateCreateEmbeddedDraftExample.java new file mode 100644 index 0000000..bf7c972 --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftExample.java @@ -0,0 +1,86 @@ +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 TemplateCreateEmbeddedDraftExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + 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/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java new file mode 100644 index 0000000..1a7ff9b --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldGroupsExample.java @@ -0,0 +1,132 @@ +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 TemplateCreateEmbeddedDraftFormFieldGroupsExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldGroups(formFieldGroups); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + 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/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java new file mode 100644 index 0000000..05ec5ab --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldRulesExample.java @@ -0,0 +1,148 @@ +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 TemplateCreateEmbeddedDraftFormFieldRulesExample +{ + 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 formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.CHANGE_FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldRules(formFieldRules); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + 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/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java new file mode 100644 index 0000000..8ac9bae --- /dev/null +++ b/examples/TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample.java @@ -0,0 +1,120 @@ +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 TemplateCreateEmbeddedDraftFormFieldsPerDocumentExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var templateCreateEmbeddedDraftRequest = new TemplateCreateEmbeddedDraftRequest(); + templateCreateEmbeddedDraftRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateEmbeddedDraftRequest.message("For your approval"); + templateCreateEmbeddedDraftRequest.subject("Please sign this document"); + templateCreateEmbeddedDraftRequest.testMode(true); + templateCreateEmbeddedDraftRequest.title("Test Template"); + templateCreateEmbeddedDraftRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateEmbeddedDraftRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateEmbeddedDraftRequest.fieldOptions(fieldOptions); + templateCreateEmbeddedDraftRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateEmbeddedDraftRequest.mergeFields(mergeFields); + templateCreateEmbeddedDraftRequest.signerRoles(signerRoles); + + try + { + var response = new TemplateApi(config).templateCreateEmbeddedDraft( + templateCreateEmbeddedDraftRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreateEmbeddedDraft"); + 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/examples/TemplateCreateExample.java b/examples/TemplateCreateExample.java new file mode 100644 index 0000000..ebf652f --- /dev/null +++ b/examples/TemplateCreateExample.java @@ -0,0 +1,120 @@ +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 TemplateCreateExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + 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/examples/TemplateCreateFormFieldGroupsExample.java b/examples/TemplateCreateFormFieldGroupsExample.java new file mode 100644 index 0000000..62f5094 --- /dev/null +++ b/examples/TemplateCreateFormFieldGroupsExample.java @@ -0,0 +1,132 @@ +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 TemplateCreateFormFieldGroupsExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldGroups(formFieldGroups); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + 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/examples/TemplateCreateFormFieldRulesExample.java b/examples/TemplateCreateFormFieldRulesExample.java new file mode 100644 index 0000000..7a97f0b --- /dev/null +++ b/examples/TemplateCreateFormFieldRulesExample.java @@ -0,0 +1,148 @@ +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 TemplateCreateFormFieldRulesExample +{ + 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 formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.CHANGE_FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.formFieldRules(formFieldRules); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + 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/examples/TemplateCreateFormFieldsPerDocumentExample.java b/examples/TemplateCreateFormFieldsPerDocumentExample.java new file mode 100644 index 0000000..9873668 --- /dev/null +++ b/examples/TemplateCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,120 @@ +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 TemplateCreateFormFieldsPerDocumentExample +{ + 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 fieldOptions = new SubFieldOptions(); + fieldOptions.dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); + + var signerRoles1 = new SubTemplateRole(); + signerRoles1.name("Client"); + signerRoles1.order(0); + + var signerRoles2 = new SubTemplateRole(); + signerRoles2.name("Witness"); + signerRoles2.order(1); + + var signerRoles = new ArrayList(List.of ( + signerRoles1, + signerRoles2 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var mergeFields1 = new SubMergeField(); + mergeFields1.name("Full Name"); + mergeFields1.type(SubMergeField.TypeEnum.TEXT); + + var mergeFields2 = new SubMergeField(); + mergeFields2.name("Is Registered?"); + mergeFields2.type(SubMergeField.TypeEnum.CHECKBOX); + + var mergeFields = new ArrayList(List.of ( + mergeFields1, + mergeFields2 + )); + + var templateCreateRequest = new TemplateCreateRequest(); + templateCreateRequest.clientId("37dee8d8440c66d54cfa05d92c160882"); + templateCreateRequest.message("For your approval"); + templateCreateRequest.subject("Please sign this document"); + templateCreateRequest.testMode(true); + templateCreateRequest.title("Test Template"); + templateCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + templateCreateRequest.ccRoles(List.of ( + "Manager" + )); + templateCreateRequest.fieldOptions(fieldOptions); + templateCreateRequest.signerRoles(signerRoles); + templateCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + templateCreateRequest.mergeFields(mergeFields); + + try + { + var response = new TemplateApi(config).templateCreate( + templateCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateCreate"); + 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/examples/TemplateDelete.java b/examples/TemplateDelete.java deleted file mode 100644 index 0714a45..0000000 --- a/examples/TemplateDelete.java +++ /dev/null @@ -1,31 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - templateApi.templateDelete(templateId); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateDeleteExample.java b/examples/TemplateDeleteExample.java new file mode 100644 index 0000000..6ca8746 --- /dev/null +++ b/examples/TemplateDeleteExample.java @@ -0,0 +1,39 @@ +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 TemplateDeleteExample +{ + 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"); + + try + { + new TemplateApi(config).templateDelete( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateDelete"); + 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/examples/TemplateFiles.java b/examples/TemplateFiles.java deleted file mode 100644 index 2c24e48..0000000 --- a/examples/TemplateFiles.java +++ /dev/null @@ -1,34 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - File result = templateApi.templateFiles(templateId, "pdf"); - result.renameTo(new File("file_response.pdf")); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateFilesAsDataUri.java b/examples/TemplateFilesAsDataUri.java deleted file mode 100644 index 868f280..0000000 --- a/examples/TemplateFilesAsDataUri.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponseDataUri result = templateApi.templateFilesAsDataUri(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateFilesAsDataUriExample.java b/examples/TemplateFilesAsDataUriExample.java new file mode 100644 index 0000000..02c9b69 --- /dev/null +++ b/examples/TemplateFilesAsDataUriExample.java @@ -0,0 +1,41 @@ +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 TemplateFilesAsDataUriExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFilesAsDataUri( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsDataUri"); + 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/examples/TemplateFilesAsFileUrl.java b/examples/TemplateFilesAsFileUrl.java deleted file mode 100644 index a3989a6..0000000 --- a/examples/TemplateFilesAsFileUrl.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - FileResponse result = templateApi.templateFilesAsFileUrl(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateFilesAsFileUrlExample.java b/examples/TemplateFilesAsFileUrlExample.java new file mode 100644 index 0000000..2b316f9 --- /dev/null +++ b/examples/TemplateFilesAsFileUrlExample.java @@ -0,0 +1,42 @@ +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 TemplateFilesAsFileUrlExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFilesAsFileUrl( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + 1 // forceDownload + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFilesAsFileUrl"); + 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/examples/TemplateFilesExample.java b/examples/TemplateFilesExample.java new file mode 100644 index 0000000..d003de8 --- /dev/null +++ b/examples/TemplateFilesExample.java @@ -0,0 +1,41 @@ +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 TemplateFilesExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + null // fileType + ); + response.renameTo(new File("./file_response")); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateFiles"); + 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/examples/TemplateGet.java b/examples/TemplateGet.java deleted file mode 100644 index 5c4721f..0000000 --- a/examples/TemplateGet.java +++ /dev/null @@ -1,33 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var templateId = "f57db65d3f933b5316d398057a36176831451a35"; - - try { - TemplateGetResponse result = templateApi.templateGet(templateId); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateGetExample.java b/examples/TemplateGetExample.java new file mode 100644 index 0000000..2aabdc6 --- /dev/null +++ b/examples/TemplateGetExample.java @@ -0,0 +1,41 @@ +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 TemplateGetExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateGet( + "f57db65d3f933b5316d398057a36176831451a35" // templateId + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateGet"); + 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/examples/TemplateList.java b/examples/TemplateList.java deleted file mode 100644 index 136dcf3..0000000 --- a/examples/TemplateList.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var accountId = "f57db65d3f933b5316d398057a36176831451a35"; - var page = 1; - var pageSize = 20; - String query = null; - - try { - TemplateListResponse result = templateApi.templateList(accountId, page, pageSize, query); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateListExample.java b/examples/TemplateListExample.java new file mode 100644 index 0000000..29e115b --- /dev/null +++ b/examples/TemplateListExample.java @@ -0,0 +1,44 @@ +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 TemplateListExample +{ + 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"); + + try + { + var response = new TemplateApi(config).templateList( + null, // accountId + 1, // page + 20, // pageSize + null // query + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateList"); + 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/examples/TemplateRemoveUser.java b/examples/TemplateRemoveUser.java deleted file mode 100644 index 9dd210c..0000000 --- a/examples/TemplateRemoveUser.java +++ /dev/null @@ -1,36 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateRemoveUserRequest() - .emailAddress("george@dropboxsign.com"); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateGetResponse result = templateApi.templateRemoveUser(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateRemoveUserExample.java b/examples/TemplateRemoveUserExample.java new file mode 100644 index 0000000..7d29ffa --- /dev/null +++ b/examples/TemplateRemoveUserExample.java @@ -0,0 +1,45 @@ +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 TemplateRemoveUserExample +{ + 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 templateRemoveUserRequest = new TemplateRemoveUserRequest(); + templateRemoveUserRequest.emailAddress("george@dropboxsign.com"); + + try + { + var response = new TemplateApi(config).templateRemoveUser( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateRemoveUserRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateRemoveUser"); + 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/examples/TemplateUpdateFiles.java b/examples/TemplateUpdateFiles.java deleted file mode 100644 index 873544c..0000000 --- a/examples/TemplateUpdateFiles.java +++ /dev/null @@ -1,38 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var templateApi = new TemplateApi(apiClient); - - var data = new TemplateUpdateFilesRequest() - .addFilesItem(new File("example_signature_request.pdf")); - - var templateId = "21f920ec2b7f4b6bb64d3ed79f26303843046536"; - - try { - TemplateUpdateFilesResponse result = templateApi.templateUpdateFiles(templateId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/TemplateUpdateFilesExample.java b/examples/TemplateUpdateFilesExample.java new file mode 100644 index 0000000..8f36d76 --- /dev/null +++ b/examples/TemplateUpdateFilesExample.java @@ -0,0 +1,47 @@ +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 TemplateUpdateFilesExample +{ + 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 templateUpdateFilesRequest = new TemplateUpdateFilesRequest(); + templateUpdateFilesRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new TemplateApi(config).templateUpdateFiles( + "f57db65d3f933b5316d398057a36176831451a35", // templateId + templateUpdateFilesRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling TemplateApi#templateUpdateFiles"); + 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/examples/UnclaimedDraftCreate.java b/examples/UnclaimedDraftCreate.java deleted file mode 100644 index 5ba8057..0000000 --- a/examples/UnclaimedDraftCreate.java +++ /dev/null @@ -1,67 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; -import java.util.List; -import java.util.Map; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer1 = new SubUnclaimedDraftSigner() - .emailAddress("jack@example.com") - .name("Jack") - .order(0); - - var signer2 = new SubUnclaimedDraftSigner() - .emailAddress("jill@example.com") - .name("Jill") - .order(1); - - var subSigningOptions = new SubSigningOptions() - .draw(true) - .type(true) - .upload(true) - .phone(false) - .defaultType(SubSigningOptions.DefaultTypeEnum.DRAW); - - var subFieldOptions = new SubFieldOptions() - .dateFormat(SubFieldOptions.DateFormatEnum.DD_MM_YYYY); - - var data = new UnclaimedDraftCreateRequest() - .subject("The NDA we talked about") - .type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE) - .message("Please sign this NDA and then we can discuss more. Let me know if you have any questions.") - .signers(List.of(signer1, signer2)) - .ccEmailAddresses(List.of("lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com")) - .addFilesItem(new File("example_signature_request.pdf")) - .metadata(Map.of("custom_id", 1234, "custom_text", "NDA #9")) - .signingOptions(subSigningOptions) - .fieldOptions(subFieldOptions) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/UnclaimedDraftCreateEmbedded.java b/examples/UnclaimedDraftCreateEmbedded.java deleted file mode 100644 index 56ad9a5..0000000 --- a/examples/UnclaimedDraftCreateEmbedded.java +++ /dev/null @@ -1,39 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.io.File; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftCreateEmbeddedRequest() - .clientId("ec64a202072370a737edf4a0eb7f4437") - .addFilesItem(new File("example_signature_request.pdf")) - .requesterEmailAddress("jack@dropboxsign.com") - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbedded(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/UnclaimedDraftCreateEmbeddedExample.java b/examples/UnclaimedDraftCreateEmbeddedExample.java new file mode 100644 index 0000000..e6bc38f --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedExample.java @@ -0,0 +1,49 @@ +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 UnclaimedDraftCreateEmbeddedExample +{ + 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 unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(true); + unclaimedDraftCreateEmbeddedRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + 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/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java new file mode 100644 index 0000000..b991838 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldGroupsExample.java @@ -0,0 +1,95 @@ +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 UnclaimedDraftCreateEmbeddedFormFieldGroupsExample +{ + 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 formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + 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/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java new file mode 100644 index 0000000..1564f78 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldRulesExample.java @@ -0,0 +1,111 @@ +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 UnclaimedDraftCreateEmbeddedFormFieldRulesExample +{ + 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 formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.CHANGE_FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + 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/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java new file mode 100644 index 0000000..2ec3a17 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample.java @@ -0,0 +1,83 @@ +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 UnclaimedDraftCreateEmbeddedFormFieldsPerDocumentExample +{ + 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 formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateEmbeddedRequest = new UnclaimedDraftCreateEmbeddedRequest(); + unclaimedDraftCreateEmbeddedRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedRequest.testMode(false); + unclaimedDraftCreateEmbeddedRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateEmbeddedRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbedded( + unclaimedDraftCreateEmbeddedRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbedded"); + 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/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java deleted file mode 100644 index 7a5983a..0000000 --- a/examples/UnclaimedDraftCreateEmbeddedWithTemplate.java +++ /dev/null @@ -1,50 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -import java.util.List; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var signer = new SubUnclaimedDraftTemplateSigner() - .role("Client") - .name("George") - .emailAddress("george@example.com"); - - var cc1 = new SubCC() - .role("Accounting") - .emailAddress("accouting@email.com"); - - var data = new UnclaimedDraftCreateEmbeddedWithTemplateRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .templateIds(List.of("c26b8a16784a872da37ea946b9ddec7c1e11dff6")) - .requesterEmailAddress("jack@dropboxsign.com") - .signers(List.of(signer)) - .ccs(List.of(cc1)) - .testMode(true); - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftCreateEmbeddedWithTemplate(data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java new file mode 100644 index 0000000..1b88887 --- /dev/null +++ b/examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java @@ -0,0 +1,68 @@ +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 UnclaimedDraftCreateEmbeddedWithTemplateExample +{ + 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 ccs1 = new SubCC(); + ccs1.role("Accounting"); + ccs1.emailAddress("accounting@dropboxsign.com"); + + var ccs = new ArrayList(List.of ( + ccs1 + )); + + var signers1 = new SubUnclaimedDraftTemplateSigner(); + signers1.role("Client"); + signers1.name("George"); + signers1.emailAddress("george@example.com"); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateEmbeddedWithTemplateRequest = new UnclaimedDraftCreateEmbeddedWithTemplateRequest(); + unclaimedDraftCreateEmbeddedWithTemplateRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.requesterEmailAddress("jack@dropboxsign.com"); + unclaimedDraftCreateEmbeddedWithTemplateRequest.templateIds(List.of ( + "61a832ff0d8423f91d503e76bfbcc750f7417c78" + )); + unclaimedDraftCreateEmbeddedWithTemplateRequest.testMode(false); + unclaimedDraftCreateEmbeddedWithTemplateRequest.ccs(ccs); + unclaimedDraftCreateEmbeddedWithTemplateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreateEmbeddedWithTemplate( + unclaimedDraftCreateEmbeddedWithTemplateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreateEmbeddedWithTemplate"); + 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/examples/UnclaimedDraftCreateExample.java b/examples/UnclaimedDraftCreateExample.java new file mode 100644 index 0000000..770bc05 --- /dev/null +++ b/examples/UnclaimedDraftCreateExample.java @@ -0,0 +1,58 @@ +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 UnclaimedDraftCreateExample +{ + 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 signers1 = new SubUnclaimedDraftSigner(); + signers1.name("Jack"); + signers1.emailAddress("jack@example.com"); + signers1.order(0); + + var signers = new ArrayList(List.of ( + signers1 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(true); + unclaimedDraftCreateRequest.files(List.of ( + new File("./example_signature_request.pdf") + )); + unclaimedDraftCreateRequest.signers(signers); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + 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/examples/UnclaimedDraftCreateFormFieldGroupsExample.java b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java new file mode 100644 index 0000000..1daa8d5 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldGroupsExample.java @@ -0,0 +1,94 @@ +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 UnclaimedDraftCreateFormFieldGroupsExample +{ + 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 formFieldGroups1 = new SubFormFieldGroup(); + formFieldGroups1.groupId("RadioItemGroup1"); + formFieldGroups1.groupLabel("Radio Item Group 1"); + formFieldGroups1.requirement("require_0-1"); + + var formFieldGroups = new ArrayList(List.of ( + formFieldGroups1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("radio"); + formFieldsPerDocument1.required(false); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(18); + formFieldsPerDocument1.height(18); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.group("RadioItemGroup1"); + formFieldsPerDocument1.isChecked(true); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentRadio(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("radio"); + formFieldsPerDocument2.required(false); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(18); + formFieldsPerDocument2.height(18); + formFieldsPerDocument2.x(112); + formFieldsPerDocument2.y(370); + formFieldsPerDocument2.group("RadioItemGroup1"); + formFieldsPerDocument2.isChecked(false); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldGroups(formFieldGroups); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + 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/examples/UnclaimedDraftCreateFormFieldRulesExample.java b/examples/UnclaimedDraftCreateFormFieldRulesExample.java new file mode 100644 index 0000000..dc123db --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldRulesExample.java @@ -0,0 +1,110 @@ +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 UnclaimedDraftCreateFormFieldRulesExample +{ + 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 formFieldRules1Triggers1 = new SubFormFieldRuleTrigger(); + formFieldRules1Triggers1.id("uniqueIdHere_1"); + formFieldRules1Triggers1.operator(SubFormFieldRuleTrigger.OperatorEnum.IS); + formFieldRules1Triggers1.value("foo"); + + var formFieldRules1Triggers = new ArrayList(List.of ( + formFieldRules1Triggers1 + )); + + var formFieldRules1Actions1 = new SubFormFieldRuleAction(); + formFieldRules1Actions1.hidden(true); + formFieldRules1Actions1.type(SubFormFieldRuleAction.TypeEnum.CHANGE_FIELD_VISIBILITY); + formFieldRules1Actions1.fieldId("uniqueIdHere_2"); + + var formFieldRules1Actions = new ArrayList(List.of ( + formFieldRules1Actions1 + )); + + var formFieldRules1 = new SubFormFieldRule(); + formFieldRules1.id("rule_1"); + formFieldRules1.triggerOperator("AND"); + formFieldRules1.triggers(formFieldRules1Triggers); + formFieldRules1.actions(formFieldRules1Actions); + + var formFieldRules = new ArrayList(List.of ( + formFieldRules1 + )); + + var formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("0"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldRules(formFieldRules); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + 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/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java new file mode 100644 index 0000000..5fb0e75 --- /dev/null +++ b/examples/UnclaimedDraftCreateFormFieldsPerDocumentExample.java @@ -0,0 +1,82 @@ +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 UnclaimedDraftCreateFormFieldsPerDocumentExample +{ + 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 formFieldsPerDocument1 = new SubFormFieldsPerDocumentText(); + formFieldsPerDocument1.documentIndex(0); + formFieldsPerDocument1.apiId("uniqueIdHere_1"); + formFieldsPerDocument1.type("text"); + formFieldsPerDocument1.required(true); + formFieldsPerDocument1.signer("1"); + formFieldsPerDocument1.width(100); + formFieldsPerDocument1.height(16); + formFieldsPerDocument1.x(112); + formFieldsPerDocument1.y(328); + formFieldsPerDocument1.name(""); + formFieldsPerDocument1.page(1); + formFieldsPerDocument1.placeholder(""); + formFieldsPerDocument1.validationType(SubFormFieldsPerDocumentText.ValidationTypeEnum.NUMBERS_ONLY); + + var formFieldsPerDocument2 = new SubFormFieldsPerDocumentSignature(); + formFieldsPerDocument2.documentIndex(0); + formFieldsPerDocument2.apiId("uniqueIdHere_2"); + formFieldsPerDocument2.type("signature"); + formFieldsPerDocument2.required(true); + formFieldsPerDocument2.signer("0"); + formFieldsPerDocument2.width(120); + formFieldsPerDocument2.height(30); + formFieldsPerDocument2.x(530); + formFieldsPerDocument2.y(415); + formFieldsPerDocument2.name(""); + formFieldsPerDocument2.page(1); + + var formFieldsPerDocument = new ArrayList(List.of ( + formFieldsPerDocument1, + formFieldsPerDocument2 + )); + + var unclaimedDraftCreateRequest = new UnclaimedDraftCreateRequest(); + unclaimedDraftCreateRequest.type(UnclaimedDraftCreateRequest.TypeEnum.REQUEST_SIGNATURE); + unclaimedDraftCreateRequest.testMode(false); + unclaimedDraftCreateRequest.fileUrls(List.of ( + "https://www.dropbox.com/s/ad9qnhbrjjn64tu/mutual-NDA-example.pdf?dl=1" + )); + unclaimedDraftCreateRequest.formFieldsPerDocument(formFieldsPerDocument); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftCreate( + unclaimedDraftCreateRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftCreate"); + 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/examples/UnclaimedDraftEditAndResend.java b/examples/UnclaimedDraftEditAndResend.java deleted file mode 100644 index bf33d8f..0000000 --- a/examples/UnclaimedDraftEditAndResend.java +++ /dev/null @@ -1,37 +0,0 @@ -import com.dropbox.sign.ApiException; -import com.dropbox.sign.Configuration; -import com.dropbox.sign.api.*; -import com.dropbox.sign.auth.*; -import com.dropbox.sign.model.*; - -public class Example { - public static void main(String[] args) { - var apiClient = Configuration.getDefaultApiClient() - .setApiKey("YOUR_API_KEY"); - - // or, configure Bearer (JWT) authorization: oauth2 - /* - var apiClient = Configuration.getDefaultApiClient() - .setBearerToken("YOUR_ACCESS_TOKEN"); - */ - - var unclaimedDraftApi = new UnclaimedDraftApi(apiClient); - - var data = new UnclaimedDraftEditAndResendRequest() - .clientId("1a659d9ad95bccd307ecad78d72192f8") - .testMode(true); - - var signatureRequestId = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"; - - try { - UnclaimedDraftCreateResponse result = unclaimedDraftApi.unclaimedDraftEditAndResend(signatureRequestId, data); - System.out.println(result); - } catch (ApiException e) { - System.err.println("Exception when calling AccountApi#accountCreate"); - 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/examples/UnclaimedDraftEditAndResendExample.java b/examples/UnclaimedDraftEditAndResendExample.java new file mode 100644 index 0000000..23ebe38 --- /dev/null +++ b/examples/UnclaimedDraftEditAndResendExample.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 UnclaimedDraftEditAndResendExample +{ + 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 unclaimedDraftEditAndResendRequest = new UnclaimedDraftEditAndResendRequest(); + unclaimedDraftEditAndResendRequest.clientId("b6b8e7deaf8f0b95c029dca049356d4a2cf9710a"); + unclaimedDraftEditAndResendRequest.testMode(false); + + try + { + var response = new UnclaimedDraftApi(config).unclaimedDraftEditAndResend( + "fa5c8a0b0f492d768749333ad6fcc214c111e967", // signatureRequestId + unclaimedDraftEditAndResendRequest + ); + + System.out.println(response); + } catch (ApiException e) { + System.err.println("Exception when calling UnclaimedDraftApi#unclaimedDraftEditAndResend"); + 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 8da7344..4078510 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.4.0 +VERSION_NAME=2.5.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 53f2ffb..7bb9ce6 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.4.0" + artifactVersion: "2.5.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 @@ -28,6 +28,10 @@ additionalProperties: licenseUrl: https://www.opensource.org/licenses/mit-license.php useCustomTemplateCode: true licenseCopyrightYear: 2024 + oseg.package: com.dropbox.sign_sandbox + oseg.printApiCallProperty: true + oseg.security.api_key.username: YOUR_API_KEY + oseg.security.oauth2.access_token: YOUR_ACCESS_TOKEN files: dropbox-EventCallbackHelper.mustache: templateType: SupportingFiles diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml index 608b57d..c832450 100644 --- a/openapi-sdk.yaml +++ b/openapi-sdk.yaml @@ -27,12 +27,12 @@ paths: schema: $ref: '#/components/schemas/AccountCreateRequest' examples: - default_example: - $ref: '#/components/examples/AccountCreateRequestDefaultExample' - oauth: - $ref: '#/components/examples/AccountCreateRequestOAuthExample' + example: + $ref: '#/components/examples/AccountCreateRequest' + oauth_example: + $ref: '#/components/examples/AccountCreateRequestOAuth' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -46,11 +46,11 @@ paths: schema: $ref: '#/components/schemas/AccountCreateResponse' examples: - default_example: - $ref: '#/components/examples/AccountCreateResponseExample' - oauth: - $ref: '#/components/examples/AccountCreateOAuthResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountCreateResponse' + oauth_example: + $ref: '#/components/examples/AccountCreateOAuthResponse' + '4XX': description: failed_operation content: application/json: @@ -58,15 +58,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -78,42 +78,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountCreate.php + $ref: examples/AccountCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountCreate.js + $ref: examples/AccountCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountCreate.ts + $ref: examples/AccountCreateExample.ts - lang: Java label: Java source: - $ref: examples/AccountCreate.java + $ref: examples/AccountCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountCreate.rb + $ref: examples/AccountCreateExample.rb - lang: Python label: Python source: - $ref: examples/AccountCreate.py + $ref: examples/AccountCreateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountCreate.sh + $ref: examples/AccountCreateExample.sh x-meta: seo: title: 'Create Account | API Documentation | Dropbox Sign for Developers' @@ -147,7 +142,7 @@ paths: schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -161,9 +156,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountGetResponse' + '4XX': description: failed_operation content: application/json: @@ -171,15 +166,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -192,42 +187,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountGet.php + $ref: examples/AccountGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountGet.js + $ref: examples/AccountGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountGet.ts + $ref: examples/AccountGetExample.ts - lang: Java label: Java source: - $ref: examples/AccountGet.java + $ref: examples/AccountGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountGet.rb + $ref: examples/AccountGetExample.rb - lang: Python label: Python source: - $ref: examples/AccountGet.py + $ref: examples/AccountGetExample.py - lang: cURL label: cURL source: - $ref: examples/AccountGet.sh + $ref: examples/AccountGetExample.sh x-meta: seo: title: 'Get Account | API Documentation | Dropbox Sign for Developers' @@ -245,10 +235,10 @@ paths: schema: $ref: '#/components/schemas/AccountUpdateRequest' examples: - default_example: - $ref: '#/components/examples/AccountUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/AccountUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -262,9 +252,9 @@ paths: schema: $ref: '#/components/schemas/AccountGetResponse' examples: - default_example: - $ref: '#/components/examples/AccountUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -272,17 +262,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -294,42 +284,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountUpdate.php + $ref: examples/AccountUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountUpdate.js + $ref: examples/AccountUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountUpdate.ts + $ref: examples/AccountUpdateExample.ts - lang: Java label: Java source: - $ref: examples/AccountUpdate.java + $ref: examples/AccountUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountUpdate.rb + $ref: examples/AccountUpdateExample.rb - lang: Python label: Python source: - $ref: examples/AccountUpdate.py + $ref: examples/AccountUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/AccountUpdate.sh + $ref: examples/AccountUpdateExample.sh x-meta: seo: title: 'Update Account | API Documentation | Dropbox Sign for Developers' @@ -348,10 +333,10 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyRequest' examples: - default_example: - $ref: '#/components/examples/AccountVerifyRequestDefaultExample' + example: + $ref: '#/components/examples/AccountVerifyRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -365,11 +350,11 @@ paths: schema: $ref: '#/components/schemas/AccountVerifyResponse' examples: - default_example: - $ref: '#/components/examples/AccountVerifyFoundResponseExample' - not_found: - $ref: '#/components/examples/AccountVerifyNotFoundResponseExample' - 4XX: + example: + $ref: '#/components/examples/AccountVerifyFoundResponse' + not_found_example: + $ref: '#/components/examples/AccountVerifyNotFoundResponse' + '4XX': description: failed_operation content: application/json: @@ -377,15 +362,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -397,42 +382,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/AccountVerify.php + $ref: examples/AccountVerifyExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/AccountVerify.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/AccountVerify.js + $ref: examples/AccountVerifyExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/AccountVerify.ts + $ref: examples/AccountVerifyExample.ts - lang: Java label: Java source: - $ref: examples/AccountVerify.java + $ref: examples/AccountVerifyExample.java - lang: Ruby label: Ruby source: - $ref: examples/AccountVerify.rb + $ref: examples/AccountVerifyExample.rb - lang: Python label: Python source: - $ref: examples/AccountVerify.py + $ref: examples/AccountVerifyExample.py - lang: cURL label: cURL source: - $ref: examples/AccountVerify.sh + $ref: examples/AccountVerifyExample.sh x-meta: seo: title: 'Verify Account | API Documentation | Dropbox Sign for Developers' @@ -451,13 +431,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppCreateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppCreateRequest' responses: - 201: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -471,9 +451,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -481,17 +461,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -503,42 +483,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppCreate.php + $ref: examples/ApiAppCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppCreate.js + $ref: examples/ApiAppCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppCreate.ts + $ref: examples/ApiAppCreateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppCreate.java + $ref: examples/ApiAppCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppCreate.rb + $ref: examples/ApiAppCreateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppCreate.py + $ref: examples/ApiAppCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppCreate.sh + $ref: examples/ApiAppCreateExample.sh x-meta: seo: title: 'Create API App | API Documentation | Dropbox Sign for Developers' @@ -560,7 +535,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -574,9 +549,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppGetResponse' + '4XX': description: failed_operation content: application/json: @@ -584,19 +559,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -608,42 +583,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppGet.php + $ref: examples/ApiAppGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppGet.js + $ref: examples/ApiAppGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppGet.ts + $ref: examples/ApiAppGetExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppGet.java + $ref: examples/ApiAppGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppGet.rb + $ref: examples/ApiAppGetExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppGet.py + $ref: examples/ApiAppGetExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppGet.sh + $ref: examples/ApiAppGetExample.sh x-meta: seo: title: 'Get API App | API Documentation | Dropbox Sign for Developers' @@ -670,13 +640,13 @@ paths: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/ApiAppUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/ApiAppUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -690,9 +660,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppGetResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -700,19 +670,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -724,42 +694,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppUpdate.php + $ref: examples/ApiAppUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppUpdate.js + $ref: examples/ApiAppUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppUpdate.ts + $ref: examples/ApiAppUpdateExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppUpdate.java + $ref: examples/ApiAppUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppUpdate.rb + $ref: examples/ApiAppUpdateExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppUpdate.py + $ref: examples/ApiAppUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppUpdate.sh + $ref: examples/ApiAppUpdateExample.sh x-meta: seo: title: 'Update API App | API Documentation | Dropbox Sign for Developers' @@ -780,7 +745,7 @@ paths: type: string example: 0dd3b823a682527788c4e40cb7b6f7e9 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -789,7 +754,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -797,17 +762,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -819,42 +784,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppDelete.php + $ref: examples/ApiAppDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppDelete.js + $ref: examples/ApiAppDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppDelete.ts + $ref: examples/ApiAppDeleteExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppDelete.java + $ref: examples/ApiAppDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppDelete.rb + $ref: examples/ApiAppDeleteExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppDelete.py + $ref: examples/ApiAppDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppDelete.sh + $ref: examples/ApiAppDeleteExample.sh x-meta: seo: title: 'Delete API App | API Documentation | Dropbox Sign for Developers' @@ -882,7 +842,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -896,9 +856,9 @@ paths: schema: $ref: '#/components/schemas/ApiAppListResponse' examples: - default_example: - $ref: '#/components/examples/ApiAppListResponseExample' - 4XX: + example: + $ref: '#/components/examples/ApiAppListResponse' + '4XX': description: failed_operation content: application/json: @@ -906,15 +866,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -926,42 +886,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ApiAppList.php + $ref: examples/ApiAppListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ApiAppList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ApiAppList.js + $ref: examples/ApiAppListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ApiAppList.ts + $ref: examples/ApiAppListExample.ts - lang: Java label: Java source: - $ref: examples/ApiAppList.java + $ref: examples/ApiAppListExample.java - lang: Ruby label: Ruby source: - $ref: examples/ApiAppList.rb + $ref: examples/ApiAppListExample.rb - lang: Python label: Python source: - $ref: examples/ApiAppList.py + $ref: examples/ApiAppListExample.py - lang: cURL label: cURL source: - $ref: examples/ApiAppList.sh + $ref: examples/ApiAppListExample.sh x-meta: seo: title: 'List API Apps | API Documentation | Dropbox Sign for Developers' @@ -997,7 +952,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1011,9 +966,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobGetResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1021,15 +976,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1042,42 +997,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobGet.php + $ref: examples/BulkSendJobGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobGet.js + $ref: examples/BulkSendJobGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobGet.ts + $ref: examples/BulkSendJobGetExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobGet.java + $ref: examples/BulkSendJobGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobGet.rb + $ref: examples/BulkSendJobGetExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobGet.py + $ref: examples/BulkSendJobGetExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobGet.sh + $ref: examples/BulkSendJobGetExample.sh x-meta: seo: title: 'Get Bulk Send Job | API Documentation | Dropbox Sign for Developers' @@ -1105,7 +1055,7 @@ paths: type: integer default: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1119,9 +1069,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobListResponse' examples: - default_example: - $ref: '#/components/examples/BulkSendJobListResponseExample' - 4XX: + example: + $ref: '#/components/examples/BulkSendJobListResponse' + '4XX': description: failed_operation content: application/json: @@ -1129,15 +1079,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1150,42 +1100,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/BulkSendJobList.php + $ref: examples/BulkSendJobListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/BulkSendJobList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/BulkSendJobList.js + $ref: examples/BulkSendJobListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/BulkSendJobList.ts + $ref: examples/BulkSendJobListExample.ts - lang: Java label: Java source: - $ref: examples/BulkSendJobList.java + $ref: examples/BulkSendJobListExample.java - lang: Ruby label: Ruby source: - $ref: examples/BulkSendJobList.rb + $ref: examples/BulkSendJobListExample.rb - lang: Python label: Python source: - $ref: examples/BulkSendJobList.py + $ref: examples/BulkSendJobListExample.py - lang: cURL label: cURL source: - $ref: examples/BulkSendJobList.sh + $ref: examples/BulkSendJobListExample.sh x-meta: seo: title: 'List Bulk Send Jobs | Documentation | Dropbox Sign for Developers' @@ -1213,10 +1158,10 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlRequest' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlRequestDefaultExample' + example: + $ref: '#/components/examples/EmbeddedEditUrlRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1230,9 +1175,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedEditUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedEditUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedEditUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1240,17 +1185,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1262,42 +1207,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedEditUrl.php + $ref: examples/EmbeddedEditUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedEditUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedEditUrl.js + $ref: examples/EmbeddedEditUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedEditUrl.ts + $ref: examples/EmbeddedEditUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedEditUrl.java + $ref: examples/EmbeddedEditUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedEditUrl.rb + $ref: examples/EmbeddedEditUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedEditUrl.py + $ref: examples/EmbeddedEditUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedEditUrl.sh + $ref: examples/EmbeddedEditUrlExample.sh x-meta: seo: title: 'Get Embedded Template URL | iFrame | Dropbox Sign for Developers' @@ -1319,7 +1259,7 @@ paths: type: string example: 50e3542f738adfa7ddd4cbd4c00d2a8ab6e4194b responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1333,9 +1273,9 @@ paths: schema: $ref: '#/components/schemas/EmbeddedSignUrlResponse' examples: - default_example: - $ref: '#/components/examples/EmbeddedSignUrlResponseExample' - 4XX: + example: + $ref: '#/components/examples/EmbeddedSignUrlResponse' + '4XX': description: failed_operation content: application/json: @@ -1343,21 +1283,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1369,42 +1309,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/EmbeddedSignUrl.php + $ref: examples/EmbeddedSignUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EmbeddedSignUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EmbeddedSignUrl.js + $ref: examples/EmbeddedSignUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EmbeddedSignUrl.ts + $ref: examples/EmbeddedSignUrlExample.ts - lang: Java label: Java source: - $ref: examples/EmbeddedSignUrl.java + $ref: examples/EmbeddedSignUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/EmbeddedSignUrl.rb + $ref: examples/EmbeddedSignUrlExample.rb - lang: Python label: Python source: - $ref: examples/EmbeddedSignUrl.py + $ref: examples/EmbeddedSignUrlExample.py - lang: cURL label: cURL source: - $ref: examples/EmbeddedSignUrl.sh + $ref: examples/EmbeddedSignUrlExample.sh x-meta: seo: title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers' @@ -1414,7 +1349,7 @@ paths: tags: - Fax summary: 'Get Fax' - description: 'Returns information about fax' + description: 'Returns information about a Fax' operationId: faxGet parameters: - @@ -1426,7 +1361,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1440,9 +1375,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1450,19 +1385,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1471,51 +1406,46 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxGet.php + $ref: examples/FaxGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxGet.js + $ref: examples/FaxGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxGet.ts + $ref: examples/FaxGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxGet.java + $ref: examples/FaxGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxGet.rb + $ref: examples/FaxGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxGet.py + $ref: examples/FaxGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxGet.sh + $ref: examples/FaxGetExample.sh x-meta: seo: title: 'Get Fax | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve properties of a fax, click here.' delete: tags: - Fax summary: 'Delete Fax' - description: 'Deletes the specified Fax from the system.' + description: 'Deletes the specified Fax from the system' operationId: faxDelete parameters: - @@ -1527,7 +1457,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 204: + '204': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1536,7 +1466,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1544,19 +1474,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1565,42 +1495,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxDelete.php + $ref: examples/FaxDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxDelete.js + $ref: examples/FaxDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxDelete.ts + $ref: examples/FaxDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxDelete.java + $ref: examples/FaxDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxDelete.rb + $ref: examples/FaxDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxDelete.py + $ref: examples/FaxDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxDelete.sh + $ref: examples/FaxDeleteExample.sh x-meta: seo: title: 'Delete Fax | API Documentation | Dropbox Fax for Developers' @@ -1609,8 +1534,8 @@ paths: get: tags: - Fax - summary: 'List Fax Files' - description: 'Returns list of fax files' + summary: 'Download Fax Files' + description: 'Downloads files associated with a Fax' operationId: faxFiles parameters: - @@ -1622,7 +1547,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1636,7 +1561,7 @@ paths: schema: type: string format: binary - 4XX: + '4XX': description: failed_operation content: application/json: @@ -1644,21 +1569,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1667,46 +1592,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxFiles.php + $ref: examples/FaxFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxFiles.js + $ref: examples/FaxFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxFiles.ts + $ref: examples/FaxFilesExample.ts - lang: Java label: Java source: - $ref: examples/FaxFiles.java + $ref: examples/FaxFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxFiles.rb + $ref: examples/FaxFilesExample.rb - lang: Python label: Python source: - $ref: examples/FaxFiles.py + $ref: examples/FaxFilesExample.py - lang: cURL label: cURL source: - $ref: examples/FaxFiles.sh + $ref: examples/FaxFilesExample.sh x-meta: seo: title: 'Fax Files | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list fax files, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list the files of a fax, click here.' /fax_line/add_user: put: tags: @@ -1721,10 +1641,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineAddUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineAddUserRequestExample' + example: + $ref: '#/components/examples/FaxLineAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1738,9 +1658,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -1748,17 +1668,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1767,42 +1687,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAddUser.php + $ref: examples/FaxLineAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAddUser.js + $ref: examples/FaxLineAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAddUser.ts + $ref: examples/FaxLineAddUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAddUser.java + $ref: examples/FaxLineAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAddUser.rb + $ref: examples/FaxLineAddUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAddUser.py + $ref: examples/FaxLineAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAddUser.sh + $ref: examples/FaxLineAddUserExample.sh x-meta: seo: title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers' @@ -1812,13 +1727,13 @@ paths: tags: - 'Fax Line' summary: 'Get Available Fax Line Area Codes' - description: 'Returns a response with the area codes available for a given state/provice and city.' + description: 'Returns a list of available area codes for a given state/province and city' operationId: faxLineAreaCodeGet parameters: - name: country in: query - description: 'Filter area codes by country.' + description: 'Filter area codes by country' required: true schema: type: string @@ -1826,10 +1741,11 @@ paths: - CA - US - UK + example: US - name: state in: query - description: 'Filter area codes by state.' + description: 'Filter area codes by state' schema: type: string enum: @@ -1887,7 +1803,7 @@ paths: - name: province in: query - description: 'Filter area codes by province.' + description: 'Filter area codes by province' schema: type: string enum: @@ -1907,11 +1823,11 @@ paths: - name: city in: query - description: 'Filter area codes by city.' + description: 'Filter area codes by city' schema: type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -1925,9 +1841,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineAreaCodeGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineAreaCodeGetResponse' + '4XX': description: failed_operation content: application/json: @@ -1935,15 +1851,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -1952,52 +1868,47 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineAreaCodeGet.php + $ref: examples/FaxLineAreaCodeGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineAreaCodeGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineAreaCodeGet.js + $ref: examples/FaxLineAreaCodeGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineAreaCodeGet.ts + $ref: examples/FaxLineAreaCodeGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineAreaCodeGet.java + $ref: examples/FaxLineAreaCodeGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineAreaCodeGet.rb + $ref: examples/FaxLineAreaCodeGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineAreaCodeGet.py + $ref: examples/FaxLineAreaCodeGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineAreaCodeGet.sh + $ref: examples/FaxLineAreaCodeGetExample.sh x-meta: seo: title: 'Fax Line Get Area Codes | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to purchase a new fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out what area codes are available, click here.' /fax_line/create: post: tags: - 'Fax Line' summary: 'Purchase Fax Line' - description: 'Purchases a new Fax Line.' + description: 'Purchases a new Fax Line' operationId: faxLineCreate requestBody: required: true @@ -2006,10 +1917,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineCreateRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineCreateRequestExample' + example: + $ref: '#/components/examples/FaxLineCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2023,9 +1934,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2033,17 +1944,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2052,42 +1963,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineCreate.php + $ref: examples/FaxLineCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineCreate.js + $ref: examples/FaxLineCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineCreate.ts + $ref: examples/FaxLineCreateExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineCreate.java + $ref: examples/FaxLineCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineCreate.rb + $ref: examples/FaxLineCreateExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineCreate.py + $ref: examples/FaxLineCreateExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineCreate.sh + $ref: examples/FaxLineCreateExample.sh x-meta: seo: title: 'Purchase Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2103,12 +2009,13 @@ paths: - name: number in: query - description: 'The Fax Line number.' + description: 'The Fax Line number' required: true schema: type: string + example: 123-123-1234 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2122,9 +2029,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2132,17 +2039,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2151,46 +2058,41 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineGet.php + $ref: examples/FaxLineGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineGet.js + $ref: examples/FaxLineGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineGet.ts + $ref: examples/FaxLineGetExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineGet.java + $ref: examples/FaxLineGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineGet.rb + $ref: examples/FaxLineGetExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineGet.py + $ref: examples/FaxLineGetExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineGet.sh + $ref: examples/FaxLineGetExample.sh x-meta: seo: title: 'Get Fax Line | API Documentation | Dropbox Fax for Developers' - description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve a fax line, click here.' + description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to retrieve the properties of a fax line, click here.' delete: tags: - 'Fax Line' @@ -2204,10 +2106,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineDeleteRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineDeleteRequestExample' + example: + $ref: '#/components/examples/FaxLineDeleteRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2218,7 +2120,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -2226,17 +2128,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2245,42 +2147,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineDelete.php + $ref: examples/FaxLineDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineDelete.js + $ref: examples/FaxLineDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineDelete.ts + $ref: examples/FaxLineDeleteExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineDelete.java + $ref: examples/FaxLineDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineDelete.rb + $ref: examples/FaxLineDeleteExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineDelete.py + $ref: examples/FaxLineDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineDelete.sh + $ref: examples/FaxLineDeleteExample.sh x-meta: seo: title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers' @@ -2299,31 +2196,31 @@ paths: description: 'Account ID' schema: type: string - example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 + example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 - name: page in: query - description: Page + description: 'Which page number of the Fax Line List to return. Defaults to `1`.' schema: type: integer default: 1 - example: 1 + example: 1 - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 - example: 20 + example: 20 - name: show_team_lines in: query - description: 'Show team lines' + description: 'Include Fax Lines belonging to team members in the list' schema: type: boolean responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2337,9 +2234,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineListResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineListResponse' + '4XX': description: failed_operation content: application/json: @@ -2347,15 +2244,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2364,42 +2261,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineList.php + $ref: examples/FaxLineListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineList.js + $ref: examples/FaxLineListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineList.ts + $ref: examples/FaxLineListExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineList.java + $ref: examples/FaxLineListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineList.rb + $ref: examples/FaxLineListExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineList.py + $ref: examples/FaxLineListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineList.sh + $ref: examples/FaxLineListExample.sh x-meta: seo: title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers' @@ -2409,7 +2301,7 @@ paths: tags: - 'Fax Line' summary: 'Remove Fax Line Access' - description: 'Removes a user''s access to the specified Fax Line.' + description: 'Removes a user''s access to the specified Fax Line' operationId: faxLineRemoveUser requestBody: required: true @@ -2418,10 +2310,10 @@ paths: schema: $ref: '#/components/schemas/FaxLineRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/FaxLineRemoveUserRequestExample' + example: + $ref: '#/components/examples/FaxLineRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2435,9 +2327,9 @@ paths: schema: $ref: '#/components/schemas/FaxLineResponse' examples: - default_example: - $ref: '#/components/examples/FaxLineResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxLineResponse' + '4XX': description: failed_operation content: application/json: @@ -2445,17 +2337,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2464,42 +2356,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxLineRemoveUser.php + $ref: examples/FaxLineRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxLineRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxLineRemoveUser.js + $ref: examples/FaxLineRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxLineRemoveUser.ts + $ref: examples/FaxLineRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/FaxLineRemoveUser.java + $ref: examples/FaxLineRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxLineRemoveUser.rb + $ref: examples/FaxLineRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/FaxLineRemoveUser.py + $ref: examples/FaxLineRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/FaxLineRemoveUser.sh + $ref: examples/FaxLineRemoveUserExample.sh x-meta: seo: title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers' @@ -2509,13 +2396,13 @@ paths: tags: - Fax summary: 'Lists Faxes' - description: 'Returns properties of multiple faxes' + description: 'Returns properties of multiple Faxes' operationId: faxList parameters: - name: page in: query - description: Page + description: 'Which page number of the Fax List to return. Defaults to `1`.' schema: type: integer default: 1 @@ -2524,7 +2411,7 @@ paths: - name: page_size in: query - description: 'Page size' + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' schema: type: integer default: 20 @@ -2532,7 +2419,7 @@ paths: minimum: 1 example: 20 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2546,9 +2433,9 @@ paths: schema: $ref: '#/components/schemas/FaxListResponse' examples: - default_example: - $ref: '#/components/examples/FaxListResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxListResponse' + '4XX': description: failed_operation content: application/json: @@ -2556,15 +2443,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2573,42 +2460,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxList.php + $ref: examples/FaxListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxList.js + $ref: examples/FaxListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxList.ts + $ref: examples/FaxListExample.ts - lang: Java label: Java source: - $ref: examples/FaxList.java + $ref: examples/FaxListExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxList.rb + $ref: examples/FaxListExample.rb - lang: Python label: Python source: - $ref: examples/FaxList.py + $ref: examples/FaxListExample.py - lang: cURL label: cURL source: - $ref: examples/FaxList.sh + $ref: examples/FaxListExample.sh x-meta: seo: title: 'List Faxes | API Documentation | Dropbox Fax for Developers' @@ -2618,7 +2500,7 @@ paths: tags: - Fax summary: 'Send Fax' - description: 'Action to prepare and send a fax' + description: 'Creates and sends a new Fax with the submitted file(s)' operationId: faxSend requestBody: required: true @@ -2627,13 +2509,13 @@ paths: schema: $ref: '#/components/schemas/FaxSendRequest' examples: - default_example: - $ref: '#/components/examples/FaxSendRequestExample' + example: + $ref: '#/components/examples/FaxSendRequest' multipart/form-data: schema: $ref: '#/components/schemas/FaxSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2647,9 +2529,9 @@ paths: schema: $ref: '#/components/schemas/FaxGetResponse' examples: - default_example: - $ref: '#/components/examples/FaxGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/FaxGetResponse' + '4XX': description: failed_operation content: application/json: @@ -2657,19 +2539,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2678,45 +2560,40 @@ paths: lang: PHP label: PHP source: - $ref: examples/FaxSend.php + $ref: examples/FaxSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/FaxSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/FaxSend.js + $ref: examples/FaxSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/FaxSend.ts + $ref: examples/FaxSendExample.ts - lang: Java label: Java source: - $ref: examples/FaxSend.java + $ref: examples/FaxSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/FaxSend.rb + $ref: examples/FaxSendExample.rb - lang: Python label: Python source: - $ref: examples/FaxSend.py + $ref: examples/FaxSendExample.py - lang: cURL label: cURL source: - $ref: examples/FaxSend.sh + $ref: examples/FaxSendExample.sh x-meta: seo: - title: 'Send Fax| API Documentation | Dropbox Fax for Developers' + title: 'Send Fax | API Documentation | Dropbox Fax for Developers' description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to send a fax, click here.' /oauth/token: post: @@ -2732,10 +2609,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenGenerateRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateRequestExample' + example: + $ref: '#/components/examples/OAuthTokenGenerateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2749,9 +2626,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenGenerateResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenGenerateResponse' + '4XX': description: failed_operation content: application/json: @@ -2759,15 +2636,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2777,42 +2654,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenGenerate.php + $ref: examples/OauthTokenGenerateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenGenerate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenGenerate.js + $ref: examples/OauthTokenGenerateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenGenerate.ts + $ref: examples/OauthTokenGenerateExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenGenerate.java + $ref: examples/OauthTokenGenerateExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenGenerate.rb + $ref: examples/OauthTokenGenerateExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenGenerate.py + $ref: examples/OauthTokenGenerateExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenGenerate.sh + $ref: examples/OauthTokenGenerateExample.sh x-meta: seo: title: 'Generate OAuth Token | Documentation | Dropbox Sign for Developers' @@ -2832,10 +2704,10 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenRefreshRequest' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshRequestExample' + example: + $ref: '#/components/examples/OAuthTokenRefreshRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2849,9 +2721,9 @@ paths: schema: $ref: '#/components/schemas/OAuthTokenResponse' examples: - default_example: - $ref: '#/components/examples/OAuthTokenRefreshResponseExample' - 4XX: + example: + $ref: '#/components/examples/OAuthTokenRefreshResponse' + '4XX': description: failed_operation content: application/json: @@ -2859,15 +2731,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: [] servers: - @@ -2877,42 +2749,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/OauthTokenRefresh.php + $ref: examples/OauthTokenRefreshExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/OauthTokenRefresh.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/OauthTokenRefresh.js + $ref: examples/OauthTokenRefreshExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/OauthTokenRefresh.ts + $ref: examples/OauthTokenRefreshExample.ts - lang: Java label: Java source: - $ref: examples/OauthTokenRefresh.java + $ref: examples/OauthTokenRefreshExample.java - lang: Ruby label: Ruby source: - $ref: examples/OauthTokenRefresh.rb + $ref: examples/OauthTokenRefreshExample.rb - lang: Python label: Python source: - $ref: examples/OauthTokenRefresh.py + $ref: examples/OauthTokenRefreshExample.py - lang: cURL label: cURL source: - $ref: examples/OauthTokenRefresh.sh + $ref: examples/OauthTokenRefreshExample.sh x-meta: seo: title: 'OAuth Token Refresh | Documentation | Dropbox Sign for Developers' @@ -2935,10 +2802,10 @@ paths: schema: $ref: '#/components/schemas/ReportCreateRequest' examples: - default_example: - $ref: '#/components/examples/ReportCreateRequestDefaultExample' + example: + $ref: '#/components/examples/ReportCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -2952,9 +2819,9 @@ paths: schema: $ref: '#/components/schemas/ReportCreateResponse' examples: - default_example: - $ref: '#/components/examples/ReportCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/ReportCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -2962,15 +2829,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -2979,42 +2846,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/ReportCreate.php + $ref: examples/ReportCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/ReportCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/ReportCreate.js + $ref: examples/ReportCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/ReportCreate.ts + $ref: examples/ReportCreateExample.ts - lang: Java label: Java source: - $ref: examples/ReportCreate.java + $ref: examples/ReportCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/ReportCreate.rb + $ref: examples/ReportCreateExample.rb - lang: Python label: Python source: - $ref: examples/ReportCreate.py + $ref: examples/ReportCreateExample.py - lang: cURL label: cURL source: - $ref: examples/ReportCreate.sh + $ref: examples/ReportCreateExample.sh x-meta: seo: title: 'Create Report | API Documentation | Dropbox Sign for Developers' @@ -3036,13 +2898,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3056,9 +2918,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3066,21 +2928,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3089,42 +2951,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestBulkCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Embedded Bulk Send with Template | Dropbox Sign for Developers' @@ -3146,13 +3003,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestBulkSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3166,9 +3023,9 @@ paths: schema: $ref: '#/components/schemas/BulkSendJobSendResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestBulkSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3176,17 +3033,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3199,42 +3056,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestBulkSendWithTemplate.php + $ref: examples/SignatureRequestBulkSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestBulkSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestBulkSendWithTemplate.js + $ref: examples/SignatureRequestBulkSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestBulkSendWithTemplate.ts + $ref: examples/SignatureRequestBulkSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestBulkSendWithTemplate.java + $ref: examples/SignatureRequestBulkSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestBulkSendWithTemplate.rb + $ref: examples/SignatureRequestBulkSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestBulkSendWithTemplate.py + $ref: examples/SignatureRequestBulkSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestBulkSendWithTemplate.sh + $ref: examples/SignatureRequestBulkSendWithTemplateExample.sh x-meta: seo: title: 'Bulk Send with Template | REST API | Dropbox Sign for Developers' @@ -3265,7 +3117,7 @@ paths: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3276,7 +3128,7 @@ paths: $ref: '#/components/headers/X-Ratelimit-Reset' content: application/json: {} - 4XX: + '4XX': description: failed_operation content: application/json: @@ -3284,21 +3136,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3311,42 +3163,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCancel.php + $ref: examples/SignatureRequestCancelExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCancel.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCancel.js + $ref: examples/SignatureRequestCancelExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCancel.ts + $ref: examples/SignatureRequestCancelExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCancel.java + $ref: examples/SignatureRequestCancelExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCancel.rb + $ref: examples/SignatureRequestCancelExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCancel.py + $ref: examples/SignatureRequestCancelExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCancel.sh + $ref: examples/SignatureRequestCancelExample.sh x-meta: seo: title: 'Cancel Incomplete Signature Request | Dropbox Sign for Developers' @@ -3365,15 +3212,15 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequest' grouped_signers_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSignersExample' + $ref: '#/components/examples/SignatureRequestCreateEmbeddedRequestGroupedSigners' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3387,9 +3234,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3397,19 +3244,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3421,42 +3268,37 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbedded.php + $ref: examples/SignatureRequestCreateEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbedded.js + $ref: examples/SignatureRequestCreateEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbedded.ts + $ref: examples/SignatureRequestCreateEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbedded.java + $ref: examples/SignatureRequestCreateEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbedded.rb + $ref: examples/SignatureRequestCreateEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbedded.py + $ref: examples/SignatureRequestCreateEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbedded.sh + $ref: examples/SignatureRequestCreateEmbeddedExample.sh x-meta: seo: title: 'Create Embedded Signature Request | Dropbox Sign for Developers' @@ -3475,13 +3317,13 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SignatureRequestCreateEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3495,9 +3337,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3505,19 +3347,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3529,77 +3371,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.php + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.js + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.ts + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.java + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.rb + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.py + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestCreateEmbeddedWithTemplate.sh + $ref: examples/SignatureRequestCreateEmbeddedWithTemplateExample.sh x-meta: seo: title: 'Signature Request with Template | Dropbox Sign for Developers' description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create a new SignatureRequest based on the given Template, click here.' - '/signature_request/files/{signature_request_id}': - get: + '/signature_request/edit/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files' + summary: 'Edit Signature Request' description: |- - Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFiles + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEdit parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - default: pdf - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3609,15 +3450,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -3625,23 +3464,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3654,67 +3491,76 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestFiles.php + $ref: examples/SignatureRequestEditExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFiles.js + $ref: examples/SignatureRequestEditExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFiles.ts + $ref: examples/SignatureRequestEditExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFiles.java + $ref: examples/SignatureRequestEditExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFiles.rb + $ref: examples/SignatureRequestEditExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFiles.py + $ref: examples/SignatureRequestEditExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFiles.sh + $ref: examples/SignatureRequestEditExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_data_uri/{signature_request_id}': - get: + title: 'Edit Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest with the submitted documents, click here.' + '/signature_request/edit_embedded/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as Data Uri' + summary: 'Edit Embedded Signature Request' description: |- - 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). + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsDataUri + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbedded parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3726,11 +3572,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedResponse' + '4XX': description: failed_operation content: application/json: @@ -3738,103 +3584,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsDataUri.php + $ref: examples/SignatureRequestEditEmbeddedExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsDataUri.js + $ref: examples/SignatureRequestEditEmbeddedExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsDataUri.ts + $ref: examples/SignatureRequestEditEmbeddedExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsDataUri.java + $ref: examples/SignatureRequestEditEmbeddedExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsDataUri.rb + $ref: examples/SignatureRequestEditEmbeddedExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsDataUri.py + $ref: examples/SignatureRequestEditEmbeddedExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsDataUri.sh + $ref: examples/SignatureRequestEditEmbeddedExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/files_as_file_url/{signature_request_id}': - get: + title: 'Edit Embedded Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to edit a SignatureRequest in an iFrame, click here.' + '/signature_request/edit_embedded_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Download Files as File Url' + summary: 'Edit Embedded Signature Request with Template' description: |- - 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). + 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. - If the files are currently being prepared, a status code of `409` will be returned instead. - operationId: signatureRequestFilesAsFileUrl + **NOTE:** Edit and resend *will* deduct your signature request quota. + operationId: signatureRequestEditEmbeddedWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - - name: force_download - in: query - description: '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.' - schema: - type: integer - default: 1 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditEmbeddedWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3846,11 +3689,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestCreateEmbeddedWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3858,93 +3701,100 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestFilesAsFileUrl.php + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestFilesAsFileUrl.js + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestFilesAsFileUrl.ts + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestFilesAsFileUrl.java + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestFilesAsFileUrl.rb + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestFilesAsFileUrl.py + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestFilesAsFileUrl.sh + $ref: examples/SignatureRequestEditEmbeddedWithTemplateExample.sh x-meta: seo: - title: 'Download Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' - '/signature_request/{signature_request_id}': - get: + title: 'Signature Request with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based on the given Template, click here.' + '/signature_request/edit_with_template/{signature_request_id}': + put: tags: - 'Signature Request' - summary: 'Get Signature Request' - description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' - operationId: signatureRequestGet + summary: 'Edit Signature Request With Template' + description: |- + 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. + operationId: signatureRequestEditWithTemplate parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to retrieve.' + description: 'The id of the SignatureRequest to edit.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestEditWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestEditWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -3958,9 +3808,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -3968,19 +3818,21 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -3993,86 +3845,72 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestGet.php + $ref: examples/SignatureRequestEditWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestGet.js + $ref: examples/SignatureRequestEditWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestGet.ts + $ref: examples/SignatureRequestEditWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestGet.java + $ref: examples/SignatureRequestEditWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestGet.rb + $ref: examples/SignatureRequestEditWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestGet.py + $ref: examples/SignatureRequestEditWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestGet.sh + $ref: examples/SignatureRequestEditWithTemplateExample.sh x-meta: seo: - title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' - /signature_request/list: + title: 'Edit Signature Request with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to edit a SignatureRequest based off of the Template, click here.' + '/signature_request/files/{signature_request_id}': get: tags: - 'Signature Request' - summary: 'List Signature Requests' + summary: 'Download Files' description: |- - 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. + Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying signature requests. - operationId: signatureRequestList + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFiles parameters: - - name: account_id - in: query - description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to retrieve.' + required: true schema: type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - - name: page + name: file_type in: query - description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - example: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - - - name: query - in: query - description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + default: pdf + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4082,13 +3920,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/SignatureRequestListResponse' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -4096,17 +3936,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4119,64 +3965,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestList.php + $ref: examples/SignatureRequestFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestList.js + $ref: examples/SignatureRequestFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestList.ts + $ref: examples/SignatureRequestFilesExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestList.java + $ref: examples/SignatureRequestFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestList.rb + $ref: examples/SignatureRequestFilesExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestList.py + $ref: examples/SignatureRequestFilesExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestList.sh + $ref: examples/SignatureRequestFilesExample.sh x-meta: seo: - title: 'List Signature Requests | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' - '/signature_request/release_hold/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_data_uri/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Release On-Hold Signature Request' - description: '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.' - operationId: signatureRequestReleaseHold + summary: 'Download Files as Data Uri' + description: |- + 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. + operationId: signatureRequestFilesAsDataUri parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to release.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4188,11 +4032,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/SignatureRequestReleaseHoldResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4200,98 +4044,98 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestReleaseHold.php + $ref: examples/SignatureRequestFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestReleaseHold.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestReleaseHold.js + $ref: examples/SignatureRequestFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestReleaseHold.ts + $ref: examples/SignatureRequestFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestReleaseHold.java + $ref: examples/SignatureRequestFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestReleaseHold.rb + $ref: examples/SignatureRequestFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestReleaseHold.py + $ref: examples/SignatureRequestFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestReleaseHold.sh + $ref: examples/SignatureRequestFilesAsDataUriExample.sh x-meta: seo: - title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' - '/signature_request/remind/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/files_as_file_url/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Send Request Reminder' + summary: 'Download Files as File Url' description: |- - 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. + 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). - **NOTE:** This action can **not** be used with embedded signature requests. - operationId: signatureRequestRemind + If the files are currently being prepared, a status code of `409` will be returned instead. + operationId: signatureRequestFilesAsFileUrl parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to send a reminder for.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestRemindRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindRequestDefaultExample' + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4303,11 +4147,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestRemindResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -4315,23 +4159,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4344,69 +4188,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemind.php + $ref: examples/SignatureRequestFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemind.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemind.js + $ref: examples/SignatureRequestFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemind.ts + $ref: examples/SignatureRequestFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemind.java + $ref: examples/SignatureRequestFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemind.rb + $ref: examples/SignatureRequestFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemind.py + $ref: examples/SignatureRequestFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemind.sh + $ref: examples/SignatureRequestFilesAsFileUrlExample.sh x-meta: seo: - title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' - '/signature_request/remove/{signature_request_id}': - post: + title: 'Download Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to get the current documents specified by the parameters, click here' + '/signature_request/{signature_request_id}': + get: tags: - 'Signature Request' - summary: 'Remove Signature Request Access' - description: |- - 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. - operationId: signatureRequestRemove + summary: 'Get Signature Request' + description: 'Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.' + operationId: signatureRequestGet parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to remove.' + description: 'The id of the SignatureRequest to retrieve.' required: true schema: type: string example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4416,8 +4250,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestGetResponse' + '4XX': description: failed_operation content: application/json: @@ -4425,92 +4264,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] + - + oauth2: + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestRemove.php + $ref: examples/SignatureRequestGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestRemove.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestRemove.js + $ref: examples/SignatureRequestGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestRemove.ts + $ref: examples/SignatureRequestGetExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestRemove.java + $ref: examples/SignatureRequestGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestRemove.rb + $ref: examples/SignatureRequestGetExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestRemove.py + $ref: examples/SignatureRequestGetExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestRemove.sh + $ref: examples/SignatureRequestGetExample.sh x-meta: seo: - title: 'Remove Signature Request Access | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' - /signature_request/send: - post: + title: 'Get Signature Request | Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return the status of SignatureRequest specified by the parameters, click here.' + /signature_request/list: + get: tags: - 'Signature Request' - summary: 'Send Signature Request' - description: '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.' - operationId: signatureRequestSend - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendRequestDefaultExample' - grouped_signers_example: - $ref: '#/components/examples/SignatureRequestSendRequestGroupedSignersExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendRequest' + summary: 'List Signature Requests' + description: |- + 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. + operationId: signatureRequestList + parameters: + - + name: account_id + in: query + description: 'Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the SignatureRequest List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + example: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the SignatureRequest objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4522,11 +4375,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestGetResponse' + $ref: '#/components/schemas/SignatureRequestListResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestListResponse' + '4XX': description: failed_operation content: application/json: @@ -4534,19 +4387,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -4559,67 +4410,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/SignatureRequestSend.php + $ref: examples/SignatureRequestListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSend.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSend.js + $ref: examples/SignatureRequestListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSend.ts + $ref: examples/SignatureRequestListExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSend.java + $ref: examples/SignatureRequestListExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSend.rb + $ref: examples/SignatureRequestListExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSend.py + $ref: examples/SignatureRequestListExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSend.sh + $ref: examples/SignatureRequestListExample.sh x-meta: seo: - title: 'Send Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' - /signature_request/send_with_template: + title: 'List Signature Requests | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to return a list of SignatureRequests that you can access, click here.' + '/signature_request/release_hold/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Send with Template' - description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' - operationId: signatureRequestSendWithTemplate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' - examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + summary: 'Release On-Hold Signature Request' + description: '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.' + operationId: signatureRequestReleaseHold + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to release.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4633,9 +4476,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestSendWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestReleaseHoldResponse' + '4XX': description: failed_operation content: application/json: @@ -4643,86 +4486,78 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestSendWithTemplate.php + $ref: examples/SignatureRequestReleaseHoldExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestSendWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestSendWithTemplate.js + $ref: examples/SignatureRequestReleaseHoldExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestSendWithTemplate.ts + $ref: examples/SignatureRequestReleaseHoldExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestSendWithTemplate.java + $ref: examples/SignatureRequestReleaseHoldExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestSendWithTemplate.rb + $ref: examples/SignatureRequestReleaseHoldExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestSendWithTemplate.py + $ref: examples/SignatureRequestReleaseHoldExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestSendWithTemplate.sh + $ref: examples/SignatureRequestReleaseHoldExample.sh x-meta: seo: - title: 'Send with Template | API Documentation | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' - '/signature_request/update/{signature_request_id}': + title: 'Release On-Hold Signature Request | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to release an on-hold SignatureRequest, click here.' + '/signature_request/remind/{signature_request_id}': post: tags: - 'Signature Request' - summary: 'Update Signature Request' + summary: 'Send Request Reminder' description: |- - 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. + 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 cannot be performed on a signature request with an appended signature page. - operationId: signatureRequestUpdate + **NOTE:** This action can **not** be used with embedded signature requests. + operationId: signatureRequestRemind parameters: - name: signature_request_id in: path - description: 'The id of the SignatureRequest to update.' + description: 'The id of the SignatureRequest to send a reminder for.' required: true schema: type: string @@ -4732,12 +4567,12 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SignatureRequestUpdateRequest' + $ref: '#/components/schemas/SignatureRequestRemindRequest' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestRemindRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4751,9 +4586,9 @@ paths: schema: $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/SignatureRequestUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestRemindResponse' + '4XX': description: failed_operation content: application/json: @@ -4761,97 +4596,93 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: + - request_signature - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/SignatureRequestUpdate.php + $ref: examples/SignatureRequestRemindExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/SignatureRequestUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/SignatureRequestUpdate.js + $ref: examples/SignatureRequestRemindExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/SignatureRequestUpdate.ts + $ref: examples/SignatureRequestRemindExample.ts - lang: Java label: Java source: - $ref: examples/SignatureRequestUpdate.java + $ref: examples/SignatureRequestRemindExample.java - lang: Ruby label: Ruby source: - $ref: examples/SignatureRequestUpdate.rb + $ref: examples/SignatureRequestRemindExample.rb - lang: Python label: Python source: - $ref: examples/SignatureRequestUpdate.py + $ref: examples/SignatureRequestRemindExample.py - lang: cURL label: cURL source: - $ref: examples/SignatureRequestUpdate.sh + $ref: examples/SignatureRequestRemindExample.sh x-meta: seo: - title: 'Update Signature Request | REST API | Dropbox Sign for Developers' - description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' - /team/add_member: - put: + title: 'Send Request Reminder | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to send an email reminder to the signer, click here.' + '/signature_request/remove/{signature_request_id}': + post: tags: - - Team - summary: 'Add User to Team' - description: '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.' - operationId: teamAddMember + - 'Signature Request' + summary: 'Remove Signature Request Access' + description: |- + 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. + operationId: signatureRequestRemove parameters: - - name: team_id - in: query - description: 'The id of the team.' - required: false + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to remove.' + required: true schema: type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TeamAddMemberRequest' - examples: - email_address: - $ref: '#/components/examples/TeamAddMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamAddMemberRequestAccountIdExample' + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4861,13 +4692,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TeamGetResponse' - examples: - default_example: - $ref: '#/components/examples/TeamAddMemberResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -4875,86 +4701,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - - - oauth2: - - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamAddMember.php + $ref: examples/SignatureRequestRemoveExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamAddMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamAddMember.js + $ref: examples/SignatureRequestRemoveExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamAddMember.ts + $ref: examples/SignatureRequestRemoveExample.ts - lang: Java label: Java source: - $ref: examples/TeamAddMember.java + $ref: examples/SignatureRequestRemoveExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamAddMember.rb + $ref: examples/SignatureRequestRemoveExample.rb - lang: Python label: Python source: - $ref: examples/TeamAddMember.py + $ref: examples/SignatureRequestRemoveExample.py - lang: cURL label: cURL source: - $ref: examples/TeamAddMember.sh + $ref: examples/SignatureRequestRemoveExample.sh x-meta: seo: - title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' - /team/create: + title: 'Remove Signature Request Access | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom integrations. To find out how to remove your access to a completed signature request, click here.' + /signature_request/send: post: tags: - - Team - summary: 'Create Team' - description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' - operationId: teamCreate + - 'Signature Request' + summary: 'Send Signature Request' + description: '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.' + operationId: signatureRequestSend requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamCreateRequest' + $ref: '#/components/schemas/SignatureRequestSendRequest' examples: - default_example: - $ref: '#/components/examples/TeamCreateRequestDefaultExample' + example: + $ref: '#/components/examples/SignatureRequestSendRequest' + grouped_signers_example: + $ref: '#/components/examples/SignatureRequestSendRequestGroupedSigners' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -4966,11 +4793,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestSendResponse' + '4XX': description: failed_operation content: application/json: @@ -4978,75 +4805,87 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamCreate.php + $ref: examples/SignatureRequestSendExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamCreate.js + $ref: examples/SignatureRequestSendExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamCreate.ts + $ref: examples/SignatureRequestSendExample.ts - lang: Java label: Java source: - $ref: examples/TeamCreate.java + $ref: examples/SignatureRequestSendExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamCreate.rb + $ref: examples/SignatureRequestSendExample.rb - lang: Python label: Python source: - $ref: examples/TeamCreate.py + $ref: examples/SignatureRequestSendExample.py - lang: cURL label: cURL source: - $ref: examples/TeamCreate.sh + $ref: examples/SignatureRequestSendExample.sh x-meta: seo: - title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' - /team/destroy: - delete: + title: 'Send Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send new SignatureRequest with the submitted documents, click here.' + /signature_request/send_with_template: + post: tags: - - Team - summary: 'Delete Team' - description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' - operationId: teamDelete + - 'Signature Request' + summary: 'Send with Template' + description: 'Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter.' + operationId: signatureRequestSendWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/SignatureRequestSendWithTemplateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5055,7 +4894,14 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - 4XX: + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestGetResponse' + examples: + example: + $ref: '#/components/examples/SignatureRequestSendWithTemplateResponse' + '4XX': description: failed_operation content: application/json: @@ -5063,75 +4909,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - request_signature + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamDelete.php + $ref: examples/SignatureRequestSendWithTemplateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamDelete.js + $ref: examples/SignatureRequestSendWithTemplateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamDelete.ts + $ref: examples/SignatureRequestSendWithTemplateExample.ts - lang: Java label: Java source: - $ref: examples/TeamDelete.java + $ref: examples/SignatureRequestSendWithTemplateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamDelete.rb + $ref: examples/SignatureRequestSendWithTemplateExample.rb - lang: Python label: Python source: - $ref: examples/TeamDelete.py + $ref: examples/SignatureRequestSendWithTemplateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamDelete.sh + $ref: examples/SignatureRequestSendWithTemplateExample.sh x-meta: seo: - title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' - /team: - get: + title: 'Send with Template | API Documentation | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to create and send a new SignatureRequest based off of the Template, click here.' + '/signature_request/update/{signature_request_id}': + post: tags: - - Team - summary: 'Get Team' - description: '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.' - operationId: teamGet + - 'Signature Request' + summary: 'Update Signature Request' + description: |- + 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. + operationId: signatureRequestUpdate + parameters: + - + name: signature_request_id + in: path + description: 'The id of the SignatureRequest to update.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SignatureRequestUpdateRequest' + examples: + example: + $ref: '#/components/examples/SignatureRequestUpdateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5143,11 +5010,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetResponse' + $ref: '#/components/schemas/SignatureRequestGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetResponseExample' - 4XX: + example: + $ref: '#/components/examples/SignatureRequestUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5155,85 +5022,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - team_access + - signature_request_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamGet.php + $ref: examples/SignatureRequestUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamGet.js + $ref: examples/SignatureRequestUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamGet.ts + $ref: examples/SignatureRequestUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamGet.java + $ref: examples/SignatureRequestUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamGet.rb + $ref: examples/SignatureRequestUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamGet.py + $ref: examples/SignatureRequestUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamGet.sh + $ref: examples/SignatureRequestUpdateExample.sh x-meta: seo: - title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + title: 'Update Signature Request | REST API | Dropbox Sign for Developers' + description: 'Dropbox Sign API allows you to build custom integrations. To find out how to update the email address/name for a signer on a signature request, click here.' + /team/add_member: put: tags: - Team - summary: 'Update Team' - description: 'Updates the name of your Team.' - operationId: teamUpdate + summary: 'Add User to Team' + description: '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.' + operationId: teamAddMember + parameters: + - + name: team_id + in: query + description: 'The id of the team.' + required: false + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamUpdateRequest' + $ref: '#/components/schemas/TeamAddMemberRequest' examples: - default_example: - $ref: '#/components/examples/TeamUpdateRequestDefaultExample' + example: + $ref: '#/components/examples/TeamAddMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamAddMemberRequestAccountId' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5247,9 +5121,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamUpdateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamAddMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -5257,15 +5131,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5277,64 +5153,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamUpdate.php + $ref: examples/TeamAddMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamUpdate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamUpdate.js + $ref: examples/TeamAddMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamUpdate.ts + $ref: examples/TeamAddMemberExample.ts - lang: Java label: Java source: - $ref: examples/TeamUpdate.java + $ref: examples/TeamAddMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamUpdate.rb + $ref: examples/TeamAddMemberExample.rb - lang: Python label: Python source: - $ref: examples/TeamUpdate.py + $ref: examples/TeamAddMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TeamUpdate.sh + $ref: examples/TeamAddMemberExample.sh x-meta: seo: - title: 'Update Team | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' - /team/info: - get: + title: 'Add User to Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to invite a specified user to your Team, click here.' + /team/create: + post: tags: - Team - summary: 'Get Team Info' - description: 'Provides information about a team.' - operationId: teamInfo - parameters: - - - name: team_id - in: query - description: 'The id of the team.' - required: false - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + summary: 'Create Team' + description: 'Creates a new Team and makes you a member. You must not currently belong to a Team to invoke.' + operationId: teamCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TeamCreateRequest' + examples: + example: + $ref: '#/components/examples/TeamCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5346,11 +5217,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamGetInfoResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamGetInfoResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -5358,19 +5229,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5382,63 +5249,50 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamInfo.php + $ref: examples/TeamCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInfo.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInfo.js + $ref: examples/TeamCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInfo.ts + $ref: examples/TeamCreateExample.ts - lang: Java label: Java source: - $ref: examples/TeamInfo.java + $ref: examples/TeamCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInfo.rb + $ref: examples/TeamCreateExample.rb - lang: Python label: Python source: - $ref: examples/TeamInfo.py + $ref: examples/TeamCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInfo.sh + $ref: examples/TeamCreateExample.sh x-meta: seo: - title: 'Get Team Info | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' - /team/invites: - get: + title: 'Create Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API allows you to build custom eSign integrations. To find out how to create a new team and make yourself a member, click here.' + /team/destroy: + delete: tags: - Team - summary: 'List Team Invites' - description: 'Provides a list of team invites (and their roles).' - operationId: teamInvites - parameters: - - - name: email_address - in: query - description: 'The email address for which to display the team invites.' - required: false - schema: - type: string + summary: 'Delete Team' + description: 'Deletes your Team. Can only be invoked when you have a Team with only one member (yourself).' + operationId: teamDelete responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5447,14 +5301,7 @@ paths: $ref: '#/components/headers/X-RateLimit-Remaining' X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' - content: - application/json: - schema: - $ref: '#/components/schemas/TeamInvitesResponse' - examples: - default_example: - $ref: '#/components/examples/TeamInvitesResponseExample' - 4XX: + '4XX': description: failed_operation content: application/json: @@ -5462,101 +5309,70 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - account_access - - basic_account_info + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TeamInvites.php + $ref: examples/TeamDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamInvites.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamInvites.js + $ref: examples/TeamDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamInvites.ts + $ref: examples/TeamDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TeamInvites.java + $ref: examples/TeamDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamInvites.rb + $ref: examples/TeamDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TeamInvites.py + $ref: examples/TeamDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TeamInvites.sh + $ref: examples/TeamDeleteExample.sh x-meta: seo: - title: 'List Team Invites | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' - '/team/members/{team_id}': + title: 'Delete Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to delete a team you are a member of, click here.' + /team: get: tags: - Team - summary: 'List Team Members' - description: 'Provides a paginated list of members (and their roles) that belong to a given team.' - operationId: teamMembers - parameters: - - - name: team_id - in: path - description: 'The id of the team that a member list is being requested from.' - required: true - schema: - type: string - example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the team member list to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 + summary: 'Get Team' + description: '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.' + operationId: teamGet responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5568,11 +5384,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamMembersResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamMembersResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetResponse' + '4XX': description: failed_operation content: application/json: @@ -5580,19 +5396,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5604,66 +5418,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamMembers.php + $ref: examples/TeamGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamMembers.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamMembers.js + $ref: examples/TeamGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamMembers.ts + $ref: examples/TeamGetExample.ts - lang: Java label: Java source: - $ref: examples/TeamMembers.java + $ref: examples/TeamGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamMembers.rb + $ref: examples/TeamGetExample.rb - lang: Python label: Python source: - $ref: examples/TeamMembers.py + $ref: examples/TeamGetExample.py - lang: cURL label: cURL source: - $ref: examples/TeamMembers.sh + $ref: examples/TeamGetExample.sh x-meta: seo: - title: 'List Team Members | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' - /team/remove_member: - post: + title: 'Get Team | REST API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to return information about your Team, click here.' + put: tags: - Team - summary: 'Remove User from Team' - description: '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.' - operationId: teamRemoveMember + summary: 'Update Team' + description: 'Updates the name of your Team.' + operationId: teamUpdate requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TeamRemoveMemberRequest' + $ref: '#/components/schemas/TeamUpdateRequest' examples: - email_address: - $ref: '#/components/examples/TeamRemoveMemberRequestEmailAddressExample' - account_id: - $ref: '#/components/examples/TeamRemoveMemberRequestAccountIdExample' + example: + $ref: '#/components/examples/TeamUpdateRequest' responses: - 201: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5677,9 +5483,9 @@ paths: schema: $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TeamRemoveMemberResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamUpdateResponse' + '4XX': description: failed_operation content: application/json: @@ -5687,17 +5493,15 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5709,80 +5513,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamRemoveMember.php + $ref: examples/TeamUpdateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamRemoveMember.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamRemoveMember.js + $ref: examples/TeamUpdateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamRemoveMember.ts + $ref: examples/TeamUpdateExample.ts - lang: Java label: Java source: - $ref: examples/TeamRemoveMember.java + $ref: examples/TeamUpdateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamRemoveMember.rb + $ref: examples/TeamUpdateExample.rb - lang: Python label: Python source: - $ref: examples/TeamRemoveMember.py + $ref: examples/TeamUpdateExample.py - lang: cURL label: cURL source: - $ref: examples/TeamRemoveMember.sh + $ref: examples/TeamUpdateExample.sh x-meta: seo: - title: 'Remove User from Team | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' - '/team/sub_teams/{team_id}': + title: 'Update Team | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to update the name of your team, click here.' + /team/info: get: tags: - Team - summary: 'List Sub Teams' - description: 'Provides a paginated list of sub teams that belong to a given team.' - operationId: teamSubTeams + summary: 'Get Team Info' + description: 'Provides information about a team.' + operationId: teamInfo parameters: - name: team_id - in: path - description: 'The id of the parent Team.' - required: true + in: query + description: 'The id of the team.' + required: false schema: type: string example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c - - - name: page - in: query - description: 'Which page number of the SubTeam List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5794,11 +5577,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TeamSubTeamsResponse' + $ref: '#/components/schemas/TeamGetInfoResponse' examples: - default_example: - $ref: '#/components/examples/TeamSubTeamsResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamGetInfoResponse' + '4XX': description: failed_operation content: application/json: @@ -5806,19 +5589,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -5830,73 +5613,58 @@ paths: lang: PHP label: PHP source: - $ref: examples/TeamSubTeams.php + $ref: examples/TeamInfoExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TeamSubTeams.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TeamSubTeams.js + $ref: examples/TeamInfoExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TeamSubTeams.ts + $ref: examples/TeamInfoExample.ts - lang: Java label: Java source: - $ref: examples/TeamSubTeams.java + $ref: examples/TeamInfoExample.java - lang: Ruby label: Ruby source: - $ref: examples/TeamSubTeams.rb + $ref: examples/TeamInfoExample.rb - lang: Python label: Python source: - $ref: examples/TeamSubTeams.py + $ref: examples/TeamInfoExample.py - lang: cURL label: cURL source: - $ref: examples/TeamSubTeams.sh + $ref: examples/TeamInfoExample.sh x-meta: seo: - title: 'List Sub Teams | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' - '/template/add_user/{template_id}': - post: + title: 'Get Team Info | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get information about a specific team, click here.' + /team/invites: + get: tags: - - Template - summary: 'Add User to Template' - description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' - operationId: templateAddUser + - Team + summary: 'List Team Invites' + description: 'Provides a list of team invites (and their roles).' + operationId: teamInvites parameters: - - name: template_id - in: path - description: 'The id of the Template to give the Account access to.' - required: true + name: email_address + in: query + description: 'The email address for which to display the team invites.' + required: false schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateAddUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateAddUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -5908,11 +5676,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/TeamInvitesResponse' examples: - default_example: - $ref: '#/components/examples/TemplateAddUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamInvitesResponse' + '4XX': description: failed_operation content: application/json: @@ -5920,95 +5688,96 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - account_access + - basic_account_info x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateAddUser.php + $ref: examples/TeamInvitesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateAddUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateAddUser.js + $ref: examples/TeamInvitesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateAddUser.ts + $ref: examples/TeamInvitesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateAddUser.java + $ref: examples/TeamInvitesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateAddUser.rb + $ref: examples/TeamInvitesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateAddUser.py + $ref: examples/TeamInvitesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateAddUser.sh + $ref: examples/TeamInvitesExample.sh x-meta: seo: - title: 'Add User to Template | REST API | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' - /template/create: - post: + title: 'List Team Invites | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team invites (and their roles), click here.' + '/team/members/{team_id}': + get: tags: - - Template - summary: 'Create Template' - description: 'Creates a template that can then be used.' - operationId: templateCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateRequest' + - Team + summary: 'List Team Members' + description: 'Provides a paginated list of members (and their roles) that belong to a given team.' + operationId: teamMembers + parameters: + - + name: team_id + in: path + description: 'The id of the team that a member list is being requested from.' + required: true + schema: + type: string + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the team member list to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6020,11 +5789,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateResponse' + $ref: '#/components/schemas/TeamMembersResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamMembersResponse' + '4XX': description: failed_operation content: application/json: @@ -6032,97 +5801,85 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreate.php + $ref: examples/TeamMembersExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreate.js + $ref: examples/TeamMembersExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreate.ts + $ref: examples/TeamMembersExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreate.java + $ref: examples/TeamMembersExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreate.rb + $ref: examples/TeamMembersExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreate.py + $ref: examples/TeamMembersExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreate.sh + $ref: examples/TeamMembersExample.sh x-meta: seo: - title: 'Create Template | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' - /template/create_embedded_draft: + title: 'List Team Members | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of team members and their roles for a specific team, click here.' + /team/remove_member: post: tags: - - Template - summary: 'Create Embedded Template Draft' - description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' - operationId: templateCreateEmbeddedDraft + - Team + summary: 'Remove User from Team' + description: '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.' + operationId: teamRemoveMember requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + $ref: '#/components/schemas/TeamRemoveMemberRequest' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + example: + $ref: '#/components/examples/TeamRemoveMemberRequest' + account_id_example: + $ref: '#/components/examples/TeamRemoveMemberRequestAccountId' responses: - 200: + '201': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6134,11 +5891,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' + $ref: '#/components/schemas/TeamGetResponse' examples: - default_example: - $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponseExample' - 4XX: + example: + $ref: '#/components/examples/TeamRemoveMemberResponse' + '4XX': description: failed_operation content: application/json: @@ -6146,88 +5903,97 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateCreateEmbeddedDraft.php + $ref: examples/TeamRemoveMemberExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateCreateEmbeddedDraft.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateCreateEmbeddedDraft.js + $ref: examples/TeamRemoveMemberExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateCreateEmbeddedDraft.ts + $ref: examples/TeamRemoveMemberExample.ts - lang: Java label: Java source: - $ref: examples/TemplateCreateEmbeddedDraft.java + $ref: examples/TeamRemoveMemberExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateCreateEmbeddedDraft.rb + $ref: examples/TeamRemoveMemberExample.rb - lang: Python label: Python source: - $ref: examples/TemplateCreateEmbeddedDraft.py + $ref: examples/TeamRemoveMemberExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateCreateEmbeddedDraft.sh + $ref: examples/TeamRemoveMemberExample.sh x-meta: seo: - title: 'Create Embedded Template Draft | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' - '/template/delete/{template_id}': - post: + title: 'Remove User from Team | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to remove a user Account from your Team, click here.' + '/team/sub_teams/{team_id}': + get: tags: - - Template - summary: 'Delete Template' - description: 'Completely deletes the template specified from the account.' - operationId: templateDelete + - Team + summary: 'List Sub Teams' + description: 'Provides a paginated list of sub teams that belong to a given team.' + operationId: teamSubTeams parameters: - - name: template_id + name: team_id in: path - description: 'The id of the Template to delete.' + description: 'The id of the parent Team.' required: true schema: type: string - example: f57db65d3f933b5316d398057a36176831451a35 - responses: - 200: + example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c + - + name: page + in: query + description: 'Which page number of the SubTeam List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + responses: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6237,8 +6003,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: {} - 4XX: + application/json: + schema: + $ref: '#/components/schemas/TeamSubTeamsResponse' + examples: + example: + $ref: '#/components/examples/TeamSubTeamsResponse' + '4XX': description: failed_operation content: application/json: @@ -6246,100 +6017,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - template_access + - team_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/TemplateDelete.php + $ref: examples/TeamSubTeamsExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateDelete.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateDelete.js + $ref: examples/TeamSubTeamsExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateDelete.ts + $ref: examples/TeamSubTeamsExample.ts - lang: Java label: Java source: - $ref: examples/TemplateDelete.java + $ref: examples/TeamSubTeamsExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateDelete.rb + $ref: examples/TeamSubTeamsExample.rb - lang: Python label: Python source: - $ref: examples/TemplateDelete.py + $ref: examples/TeamSubTeamsExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateDelete.sh + $ref: examples/TeamSubTeamsExample.sh x-meta: seo: - title: 'Delete Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' - '/template/files/{template_id}': - get: + title: 'List Sub Teams | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you automate your team management. To find out how to get a list of sub teams that exist for a given team, click here.' + '/template/add_user/{template_id}': + post: tags: - Template - summary: 'Get Template Files' - description: |- - 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. - operationId: templateFiles + summary: 'Add User to Template' + description: 'Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.' + operationId: templateAddUser parameters: - name: template_id in: path - description: 'The id of the template files to retrieve.' + description: 'The id of the Template to give the Account access to.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - - - name: file_type - in: query - description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' - schema: - type: string - enum: - - pdf - - zip + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateAddUserRequest' + examples: + example: + $ref: '#/components/examples/TemplateAddUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6349,15 +6112,13 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/pdf: - schema: - type: string - format: binary - application/zip: + application/json: schema: - type: string - format: binary - 4XX: + $ref: '#/components/schemas/TemplateGetResponse' + examples: + example: + $ref: '#/components/examples/TemplateAddUserResponse' + '4XX': description: failed_operation content: application/json: @@ -6365,23 +6126,17 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6393,67 +6148,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFiles.php + $ref: examples/TemplateAddUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFiles.js + $ref: examples/TemplateAddUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFiles.ts + $ref: examples/TemplateAddUserExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFiles.java + $ref: examples/TemplateAddUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFiles.rb + $ref: examples/TemplateAddUserExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFiles.py + $ref: examples/TemplateAddUserExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFiles.sh + $ref: examples/TemplateAddUserExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_data_uri/{template_id}': - get: + title: 'Add User to Template | REST API | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to give an Account access to a Template, click here.' + /template/create: + post: tags: - Template - summary: 'Get Template Files as Data Uri' - description: |- - 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. - operationId: templateFilesAsDataUri - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 + summary: 'Create Template' + description: 'Creates a template that can then be used.' + operationId: templateCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6465,11 +6221,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponseDataUri' + $ref: '#/components/schemas/TemplateCreateResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateResponse' + '4XX': description: failed_operation content: application/json: @@ -6477,23 +6233,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6505,74 +6257,68 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsDataUri.php + $ref: examples/TemplateCreateExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsDataUri.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsDataUri.js + $ref: examples/TemplateCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsDataUri.ts + $ref: examples/TemplateCreateExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsDataUri.java + $ref: examples/TemplateCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsDataUri.rb + $ref: examples/TemplateCreateExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsDataUri.py + $ref: examples/TemplateCreateExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsDataUri.sh + $ref: examples/TemplateCreateExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/files_as_file_url/{template_id}': - get: + title: 'Create Template | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an template, click here.' + /template/create_embedded_draft: + post: tags: - Template - summary: 'Get Template Files as File Url' - description: |- - 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. - operationId: templateFilesAsFileUrl - parameters: - - - name: template_id - in: path - description: 'The id of the template files to retrieve.' - required: true - schema: - type: string - example: f57db65d3f933b5316d398057a36176831451a35 - - - name: force_download - in: query - description: '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.' - schema: - type: integer - default: 1 + summary: 'Create Embedded Template Draft' + description: 'The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template ''edit'' stage.' + operationId: templateCreateEmbeddedDraft + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' + examples: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequest' + form_fields_per_document_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6584,11 +6330,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/FileResponse' + $ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponse' examples: - default_example: - $ref: '#/components/examples/TemplateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateCreateEmbeddedDraftResponse' + '4XX': description: failed_operation content: application/json: @@ -6596,23 +6342,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 422_example: - $ref: '#/components/examples/Error422ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6624,64 +6366,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateFilesAsFileUrl.php + $ref: examples/TemplateCreateEmbeddedDraftExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateFilesAsFileUrl.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateFilesAsFileUrl.js + $ref: examples/TemplateCreateEmbeddedDraftExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateFilesAsFileUrl.ts + $ref: examples/TemplateCreateEmbeddedDraftExample.ts - lang: Java label: Java source: - $ref: examples/TemplateFilesAsFileUrl.java + $ref: examples/TemplateCreateEmbeddedDraftExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateFilesAsFileUrl.rb + $ref: examples/TemplateCreateEmbeddedDraftExample.rb - lang: Python label: Python source: - $ref: examples/TemplateFilesAsFileUrl.py + $ref: examples/TemplateCreateEmbeddedDraftExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateFilesAsFileUrl.sh + $ref: examples/TemplateCreateEmbeddedDraftExample.sh x-meta: seo: - title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' - '/template/{template_id}': - get: + title: 'Create Embedded Template Draft | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom eSign integrations. To find out how to create an embedded draft template, click here.' + '/template/delete/{template_id}': + post: tags: - Template - summary: 'Get Template' - description: 'Returns the Template specified by the `template_id` parameter.' - operationId: templateGet + summary: 'Delete Template' + description: 'Completely deletes the template specified from the account.' + operationId: templateDelete parameters: - name: template_id in: path - description: 'The id of the Template to retrieve.' + description: 'The id of the Template to delete.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6691,13 +6428,8 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: - schema: - $ref: '#/components/schemas/TemplateGetResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateGetResponseExample' - 4XX: + application/json: {} + '4XX': description: failed_operation content: application/json: @@ -6705,19 +6437,19 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6729,87 +6461,71 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateGet.php + $ref: examples/TemplateDeleteExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateGet.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateGet.js + $ref: examples/TemplateDeleteExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateGet.ts + $ref: examples/TemplateDeleteExample.ts - lang: Java label: Java source: - $ref: examples/TemplateGet.java + $ref: examples/TemplateDeleteExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateGet.rb + $ref: examples/TemplateDeleteExample.rb - lang: Python label: Python source: - $ref: examples/TemplateGet.py + $ref: examples/TemplateDeleteExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateGet.sh + $ref: examples/TemplateDeleteExample.sh x-meta: seo: - title: 'Get Template | API Documentation | Dropbox Sign for Developers' - description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' - /template/list: + title: 'Delete Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to completely delete a template from the account, click here.' + '/template/files/{template_id}': get: tags: - Template - summary: 'List Templates' + summary: 'Get Template Files' description: |- - Returns a list of the Templates that are accessible by you. + Obtain a copy of the current documents specified by the `template_id` parameter. Returns a PDF or ZIP file. - Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. - operationId: templateList + 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. + operationId: templateFiles parameters: - - name: account_id - in: query - description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + name: template_id + in: path + description: 'The id of the template files to retrieve.' + required: true schema: type: string + example: f57db65d3f933b5316d398057a36176831451a35 - - name: page - in: query - description: 'Which page number of the Template List to return. Defaults to `1`.' - schema: - type: integer - default: 1 - - - name: page_size - in: query - description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' - schema: - type: integer - default: 20 - maximum: 100 - minimum: 1 - - - name: query + name: file_type in: query - description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + description: 'Set to `pdf` for a single merged document or `zip` for a collection of individual documents.' schema: type: string + enum: + - pdf + - zip responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6819,13 +6535,15 @@ paths: X-Ratelimit-Reset: $ref: '#/components/headers/X-Ratelimit-Reset' content: - application/json: + application/pdf: schema: - $ref: '#/components/schemas/TemplateListResponse' - examples: - default_example: - $ref: '#/components/examples/TemplateListResponseExample' - 4XX: + type: string + format: binary + application/zip: + schema: + type: string + format: binary + '4XX': description: failed_operation content: application/json: @@ -6833,19 +6551,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6857,73 +6579,62 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateList.php + $ref: examples/TemplateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateList.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateList.js + $ref: examples/TemplateFilesExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateList.ts + $ref: examples/TemplateFilesExample.ts - lang: Java label: Java source: - $ref: examples/TemplateList.java + $ref: examples/TemplateFilesExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateList.rb + $ref: examples/TemplateFilesExample.rb - lang: Python label: Python source: - $ref: examples/TemplateList.py + $ref: examples/TemplateFilesExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateList.sh + $ref: examples/TemplateFilesExample.sh x-meta: seo: - title: 'List Templates | API Documentation | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' - '/template/remove_user/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_data_uri/{template_id}': + get: tags: - Template - summary: 'Remove User from Template' - description: 'Removes the specified Account''s access to the specified Template.' - operationId: templateRemoveUser + summary: 'Get Template Files as Data Uri' + description: |- + 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. + operationId: templateFilesAsDataUri parameters: - name: template_id in: path - description: 'The id of the Template to remove the Account''s access to.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateRemoveUserRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserRequestDefaultExample' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -6935,11 +6646,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateGetResponse' + $ref: '#/components/schemas/FileResponseDataUri' examples: - default_example: - $ref: '#/components/examples/TemplateRemoveUserResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -6947,17 +6658,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -6969,88 +6686,69 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateRemoveUser.php + $ref: examples/TemplateFilesAsDataUriExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateRemoveUser.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateRemoveUser.js + $ref: examples/TemplateFilesAsDataUriExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateRemoveUser.ts + $ref: examples/TemplateFilesAsDataUriExample.ts - lang: Java label: Java source: - $ref: examples/TemplateRemoveUser.java + $ref: examples/TemplateFilesAsDataUriExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateRemoveUser.rb + $ref: examples/TemplateFilesAsDataUriExample.rb - lang: Python label: Python source: - $ref: examples/TemplateRemoveUser.py + $ref: examples/TemplateFilesAsDataUriExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateRemoveUser.sh + $ref: examples/TemplateFilesAsDataUriExample.sh x-meta: seo: - title: 'Remove User from Template | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' - '/template/update_files/{template_id}': - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/files_as_file_url/{template_id}': + get: tags: - Template - summary: 'Update Template Files' + summary: 'Get Template Files as File Url' description: |- - 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. + 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 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). - operationId: templateUpdateFiles + 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. + operationId: templateFilesAsFileUrl parameters: - name: template_id in: path - description: 'The ID of the template whose files to update.' + description: 'The id of the template files to retrieve.' required: true schema: type: string example: f57db65d3f933b5316d398057a36176831451a35 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' - examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/TemplateUpdateFilesRequest' + - + name: force_download + in: query + description: '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.' + schema: + type: integer + default: 1 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7062,11 +6760,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/TemplateUpdateFilesResponse' + $ref: '#/components/schemas/FileResponse' examples: - default_example: - $ref: '#/components/examples/TemplateUpdateFilesResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7074,21 +6772,23 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 422_example: + $ref: '#/components/examples/Error422Response' 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] @@ -7100,73 +6800,59 @@ paths: lang: PHP label: PHP source: - $ref: examples/TemplateUpdateFiles.php + $ref: examples/TemplateFilesAsFileUrlExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/TemplateUpdateFiles.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/TemplateUpdateFiles.js + $ref: examples/TemplateFilesAsFileUrlExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/TemplateUpdateFiles.ts + $ref: examples/TemplateFilesAsFileUrlExample.ts - lang: Java label: Java source: - $ref: examples/TemplateUpdateFiles.java + $ref: examples/TemplateFilesAsFileUrlExample.java - lang: Ruby label: Ruby source: - $ref: examples/TemplateUpdateFiles.rb + $ref: examples/TemplateFilesAsFileUrlExample.rb - lang: Python label: Python source: - $ref: examples/TemplateUpdateFiles.py + $ref: examples/TemplateFilesAsFileUrlExample.py - lang: cURL label: cURL source: - $ref: examples/TemplateUpdateFiles.sh + $ref: examples/TemplateFilesAsFileUrlExample.sh x-meta: seo: - title: 'Update Template Files | REST API | Dropbox Sign for Developers' - description: 'Overlays a new file with the overlay of an existing template' - /unclaimed_draft/create: - post: + title: 'Get Template Files | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to get a copy of the current specified documents, click here.' + '/template/{template_id}': + get: tags: - - 'Unclaimed Draft' - summary: 'Create Unclaimed Draft' - description: '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.' - operationId: unclaimedDraftCreate - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + - Template + summary: 'Get Template' + description: 'Returns the Template specified by the `template_id` parameter.' + operationId: templateGet + parameters: + - + name: template_id + in: path + description: 'The id of the Template to retrieve.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7178,11 +6864,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateGetResponse' + '4XX': description: failed_operation content: application/json: @@ -7190,96 +6876,106 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' + 404_example: + $ref: '#/components/examples/Error404Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreate.php + $ref: examples/TemplateGetExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreate.js + $ref: examples/TemplateGetExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreate.ts + $ref: examples/TemplateGetExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreate.java + $ref: examples/TemplateGetExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreate.rb + $ref: examples/TemplateGetExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreate.py + $ref: examples/TemplateGetExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreate.sh + $ref: examples/TemplateGetExample.sh x-meta: seo: - title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' - /unclaimed_draft/create_embedded: - post: + title: 'Get Template | API Documentation | Dropbox Sign for Developers' + description: 'The RESTful Dropbox Sign API easily allows you to build custom integrations. To find out how to return the Template specified by the `template_id` parameter, click here.' + /template/list: + get: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft' + - Template + summary: 'List Templates' description: |- - 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. + Returns a list of the Templates that are accessible by you. - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftCreateEmbedded - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' - examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestDefaultExample' - form_fields_per_document: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample' - form_field_groups: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample' - form_field_rules: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + Take a look at our [search guide](/api/reference/search/) to learn more about querying templates. + operationId: templateList + parameters: + - + name: account_id + in: query + description: 'Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account.' + schema: + type: string + - + name: page + in: query + description: 'Which page number of the Template List to return. Defaults to `1`.' + schema: + type: integer + default: 1 + - + name: page_size + in: query + description: 'Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`.' + schema: + type: integer + default: 20 + maximum: 100 + minimum: 1 + - + name: query + in: query + description: 'String that includes search terms and/or fields to be used to filter the Template objects.' + schema: + type: string responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7291,11 +6987,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateListResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateListResponse' + '4XX': description: failed_operation content: application/json: @@ -7303,95 +6999,92 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' - 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error403Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbedded.php + $ref: examples/TemplateListExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbedded.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbedded.js + $ref: examples/TemplateListExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbedded.ts + $ref: examples/TemplateListExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbedded.java + $ref: examples/TemplateListExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbedded.rb + $ref: examples/TemplateListExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbedded.py + $ref: examples/TemplateListExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbedded.sh + $ref: examples/TemplateListExample.sh x-meta: seo: - title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' - /unclaimed_draft/create_embedded_with_template: + title: 'List Templates | API Documentation | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to return a list of the Templates that can be accessed by you, click here.' + '/template/remove_user/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Create Embedded Unclaimed Draft with Template' - description: |- - 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. - operationId: unclaimedDraftCreateEmbeddedWithTemplate + - Template + summary: 'Remove User from Template' + description: 'Removes the specified Account''s access to the specified Template.' + operationId: templateRemoveUser + parameters: + - + name: template_id + in: path + description: 'The id of the Template to remove the Account''s access to.' + required: true + schema: + type: string + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + $ref: '#/components/schemas/TemplateRemoveUserRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample' - multipart/form-data: - schema: - $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + example: + $ref: '#/components/examples/TemplateRemoveUserRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7403,11 +7096,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateGetResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample' - 4XX: + example: + $ref: '#/components/examples/TemplateRemoveUserResponse' + '4XX': description: failed_operation content: application/json: @@ -7415,102 +7108,105 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' - 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 429_example: - $ref: '#/components/examples/Error429ResponseExample' + $ref: '#/components/examples/Error404Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.php + $ref: examples/TemplateRemoveUserExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.js + $ref: examples/TemplateRemoveUserExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.ts + $ref: examples/TemplateRemoveUserExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.java + $ref: examples/TemplateRemoveUserExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.rb + $ref: examples/TemplateRemoveUserExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.py + $ref: examples/TemplateRemoveUserExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplate.sh + $ref: examples/TemplateRemoveUserExample.sh x-meta: seo: - title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' - '/unclaimed_draft/edit_and_resend/{signature_request_id}': + title: 'Remove User from Template | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to remove a specified Account''s access to a Template, click here.' + '/template/update_files/{template_id}': post: tags: - - 'Unclaimed Draft' - summary: 'Edit and Resend Unclaimed Draft' + - Template + summary: 'Update Template Files' description: |- - 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. + Overlays a new file with the overlay of an existing template. The new file(s) must: - **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. - operationId: unclaimedDraftEditAndResend - parameters: - - - name: signature_request_id - in: path - description: 'The ID of the signature request to edit and resend.' + 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). + operationId: templateUpdateFiles + parameters: + - + name: template_id + in: path + description: 'The ID of the template whose files to update.' required: true schema: type: string - example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + example: f57db65d3f933b5316d398057a36176831451a35 requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + $ref: '#/components/schemas/TemplateUpdateFilesRequest' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendRequestDefaultExample' + example: + $ref: '#/components/examples/TemplateUpdateFilesRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/TemplateUpdateFilesRequest' responses: - 200: + '200': description: 'successful operation' headers: X-RateLimit-Limit: @@ -7522,11 +7218,11 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UnclaimedDraftCreateResponse' + $ref: '#/components/schemas/TemplateUpdateFilesResponse' examples: - default_example: - $ref: '#/components/examples/UnclaimedDraftEditAndResendExample' - 4XX: + example: + $ref: '#/components/examples/TemplateUpdateFilesResponse' + '4XX': description: failed_operation content: application/json: @@ -7534,123 +7230,558 @@ paths: $ref: '#/components/schemas/ErrorResponse' examples: 400_example: - $ref: '#/components/examples/Error400ResponseExample' + $ref: '#/components/examples/Error400Response' 401_example: - $ref: '#/components/examples/Error401ResponseExample' + $ref: '#/components/examples/Error401Response' 402_example: - $ref: '#/components/examples/Error402ResponseExample' + $ref: '#/components/examples/Error402Response' 403_example: - $ref: '#/components/examples/Error403ResponseExample' + $ref: '#/components/examples/Error403Response' 404_example: - $ref: '#/components/examples/Error404ResponseExample' + $ref: '#/components/examples/Error404Response' 409_example: - $ref: '#/components/examples/Error409ResponseExample' - 410_example: - $ref: '#/components/examples/Error410ResponseExample' + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' 4XX_example: - $ref: '#/components/examples/Error4XXResponseExample' + $ref: '#/components/examples/Error4XXResponse' security: - api_key: [] - oauth2: - - request_signature - - signature_request_access + - template_access x-codeSamples: - lang: PHP label: PHP source: - $ref: examples/UnclaimedDraftEditAndResend.php + $ref: examples/TemplateUpdateFilesExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.cs + $ref: examples/TemplateUpdateFilesExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/TemplateUpdateFilesExample.ts + - + lang: Java + label: Java + source: + $ref: examples/TemplateUpdateFilesExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/TemplateUpdateFilesExample.rb + - + lang: Python + label: Python + source: + $ref: examples/TemplateUpdateFilesExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/TemplateUpdateFilesExample.sh + x-meta: + seo: + title: 'Update Template Files | REST API | Dropbox Sign for Developers' + description: 'Overlays a new file with the overlay of an existing template' + /unclaimed_draft/create: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Unclaimed Draft' + description: '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.' + operationId: unclaimedDraftCreate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateRequest' + 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/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateResponse' + '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' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateExample.php - - lang: JavaScript - label: JavaScript + lang: 'C#' + label: 'C#' source: - $ref: examples/UnclaimedDraftEditAndResend.js + $ref: examples/UnclaimedDraftCreateExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/UnclaimedDraftEditAndResend.ts + $ref: examples/UnclaimedDraftCreateExample.ts - lang: Java label: Java source: - $ref: examples/UnclaimedDraftEditAndResend.java + $ref: examples/UnclaimedDraftCreateExample.java - lang: Ruby label: Ruby source: - $ref: examples/UnclaimedDraftEditAndResend.rb + $ref: examples/UnclaimedDraftCreateExample.rb - lang: Python label: Python source: - $ref: examples/UnclaimedDraftEditAndResend.py + $ref: examples/UnclaimedDraftCreateExample.py - lang: cURL label: cURL source: - $ref: examples/UnclaimedDraftEditAndResend.sh + $ref: examples/UnclaimedDraftCreateExample.sh x-meta: seo: - title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' - description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' -components: - schemas: - AccountCreateRequest: - required: - - email_address - properties: - client_id: - description: |- - Used when creating a new account with OAuth authorization. + title: 'Create Unclaimed Draft | REST API | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build eSign integrations. To find out how to create a new Signature Request Draft that can be claimed using the claim URL, click here.' + /unclaimed_draft/create_embedded: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft' + description: |- + 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. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - client_secret: - description: |- - Used when creating a new account with OAuth authorization. + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbedded + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequest' + form_fields_per_document_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument' + form_field_groups_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups' + form_field_rules_example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedRequestFormFieldRules' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedRequest' + 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/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedResponse' + '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' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedExample.sh + x-meta: + seo: + title: 'Create Embedded Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to create and embed a the creation of a Signature Request in an iFrame, click here.' + /unclaimed_draft/create_embedded_with_template: + post: + tags: + - 'Unclaimed Draft' + summary: 'Create Embedded Unclaimed Draft with Template' + description: |- + 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. - See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) - type: string - email_address: - description: 'The email address which will be associated with the new Account.' - type: string - format: email - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountUpdateRequest: - properties: - account_id: - description: 'The ID of the Account' - type: string - nullable: true - callback_url: - description: 'The URL that Dropbox Sign should POST events to.' - type: string - locale: - description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' - type: string - type: object - AccountVerifyRequest: - required: - - email_address - properties: - email_address: - description: 'Email address to run the verification for.' - type: string - format: email - type: object - ApiAppCreateRequest: - required: + **NOTE:** Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on Dropbox Sign. + operationId: unclaimedDraftCreateEmbeddedWithTemplate + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + multipart/form-data: + schema: + $ref: '#/components/schemas/UnclaimedDraftCreateEmbeddedWithTemplateRequest' + 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/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftCreateEmbeddedWithTemplateResponse' + '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' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 429_example: + $ref: '#/components/examples/Error429Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftCreateEmbeddedWithTemplateExample.sh + x-meta: + seo: + title: 'Embed Unclaimed Draft with Template | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new Draft with a previously saved template, click here.' + '/unclaimed_draft/edit_and_resend/{signature_request_id}': + post: + tags: + - 'Unclaimed Draft' + summary: 'Edit and Resend Unclaimed Draft' + description: |- + 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. + operationId: unclaimedDraftEditAndResend + parameters: + - + name: signature_request_id + in: path + description: 'The ID of the signature request to edit and resend.' + required: true + schema: + type: string + example: fa5c8a0b0f492d768749333ad6fcc214c111e967 + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UnclaimedDraftEditAndResendRequest' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResendRequest' + 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/UnclaimedDraftCreateResponse' + examples: + example: + $ref: '#/components/examples/UnclaimedDraftEditAndResend' + '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' + 404_example: + $ref: '#/components/examples/Error404Response' + 409_example: + $ref: '#/components/examples/Error409Response' + 410_example: + $ref: '#/components/examples/Error410Response' + 4XX_example: + $ref: '#/components/examples/Error4XXResponse' + security: + - + api_key: [] + - + oauth2: + - request_signature + - signature_request_access + x-codeSamples: + - + lang: PHP + label: PHP + source: + $ref: examples/UnclaimedDraftEditAndResendExample.php + - + lang: 'C#' + label: 'C#' + source: + $ref: examples/UnclaimedDraftEditAndResendExample.cs + - + lang: TypeScript + label: TypeScript + source: + $ref: examples/UnclaimedDraftEditAndResendExample.ts + - + lang: Java + label: Java + source: + $ref: examples/UnclaimedDraftEditAndResendExample.java + - + lang: Ruby + label: Ruby + source: + $ref: examples/UnclaimedDraftEditAndResendExample.rb + - + lang: Python + label: Python + source: + $ref: examples/UnclaimedDraftEditAndResendExample.py + - + lang: cURL + label: cURL + source: + $ref: examples/UnclaimedDraftEditAndResendExample.sh + x-meta: + seo: + title: 'Edit and Resend Unclaimed Draft | Dropbox Sign for Developers' + description: 'The Dropbox Sign API easily allows you to build custom integrations. To find out how to create a new signature request from an embedded request, click here.' +components: + schemas: + AccountCreateRequest: + required: + - email_address + properties: + client_id: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + client_secret: + description: |- + Used when creating a new account with OAuth authorization. + + See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) + type: string + email_address: + description: 'The email address which will be associated with the new Account.' + type: string + format: email + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountUpdateRequest: + properties: + account_id: + description: 'The ID of the Account' + type: string + nullable: true + callback_url: + description: 'The URL that Dropbox Sign should POST events to.' + type: string + locale: + description: 'The locale used in this Account. Check out the list of [supported locales](/api/reference/constants/#supported-locales) to learn more about the possible values.' + type: string + type: object + AccountVerifyRequest: + required: + - email_address + properties: + email_address: + description: 'Email address to run the verification for.' + type: string + format: email + type: object + ApiAppCreateRequest: + required: - name - domains properties: @@ -7757,7 +7888,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: description: 'Account ID' @@ -7850,20 +7981,20 @@ components: - country properties: area_code: - description: 'Area code' + description: 'Area code of the new Fax Line' type: integer country: - description: Country + description: 'Country of the area code' type: string enum: - CA - US - UK city: - description: City + description: 'City of the area code' type: string account_id: - description: 'Account ID' + description: 'Account ID of the account that will be assigned this new Fax Line' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 type: object @@ -7872,7 +8003,7 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string type: object FaxLineRemoveUserRequest: @@ -7880,14 +8011,14 @@ components: - number properties: number: - description: 'The Fax Line number.' + description: 'The Fax Line number' type: string account_id: - description: 'Account ID' + description: 'Account ID of the user to remove access' type: string example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97 email_address: - description: 'Email address' + description: 'Email address of the user to remove access' type: string format: email type: object @@ -7896,7 +8027,9 @@ components: - recipient properties: recipient: - description: 'Fax Send To Recipient' + description: |- + Recipient of the fax + Can be a phone number in E.164 format or email address type: string example: recipient@example.com sender: @@ -7904,13 +8037,19 @@ components: type: string example: sender@example.com files: - description: 'Fax File to Send' + description: |- + Use `files[]` to indicate the uploaded file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string format: binary file_urls: - description: 'Fax File URL to Send' + description: |- + Use `file_urls[]` to have Dropbox Fax download the file(s) to fax + + This endpoint requires either **files** or **file_urls[]**, but not both. type: array items: type: string @@ -7919,11 +8058,11 @@ components: type: boolean default: false cover_page_to: - description: 'Fax Cover Page for Recipient' + description: 'Fax cover page recipient information' type: string example: 'Recipient Name' cover_page_from: - description: 'Fax Cover Page for Sender' + description: 'Fax cover page sender information' type: string example: 'Sender Name' cover_page_message: @@ -8119,27 +8258,361 @@ components: Example CSV: - ``` - name, email_address, pin, company_field - George, george@example.com, d79a3td, ABC Corp - Mary, mary@example.com, gd9as5b, 123 LLC - ``` - type: string - format: binary - signer_list: - description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + ``` + name, email_address, pin, company_field + George, george@example.com, d79a3td, ABC Corp + Mary, mary@example.com, gd9as5b, 123 LLC + ``` + type: string + format: binary + signer_list: + description: '`signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.' + type: array + items: + $ref: '#/components/schemas/SubBulkSignerList' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object + SignatureRequestCreateEmbeddedRequest: + required: + - client_id + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' + type: array + items: + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: |- + When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. + + Pre-filled data can be used with "send-once" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. + + For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + type: array + items: + $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + 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' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + 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' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + type: boolean + default: false + populate_auto_fill_fields: + description: |- + 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. + 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 + SignatureRequestCreateEmbeddedWithTemplateRequest: + required: + - client_id + - template_ids + - signers + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app you''re using to create this embedded signature request. Used for security purposes.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + populate_auto_fill_fields: + description: |- + 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. + type: boolean + default: false + type: object + SignatureRequestEditRequest: + properties: + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + signers: + description: |- + Add Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestSigner' + grouped_signers: + description: |- + Add Grouped Signers to your Signature Request. + + This endpoint requires either **signers** or **grouped_signers**, but not both. type: array items: - $ref: '#/components/schemas/SubBulkSignerList' + $ref: '#/components/schemas/SubSignatureRequestGroupedSigners' allow_decline: description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' type: boolean default: false - ccs: - description: 'Add CC email recipients. Required when a CC role exists for the Template.' + allow_reassign: + description: |- + Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. + + **NOTE:** Only available for Premium plan and higher. + type: boolean + default: false + attachments: + description: 'A list describing the attachments' type: array items: - $ref: '#/components/schemas/SubCC' + $ref: '#/components/schemas/SubAttachment' + cc_email_addresses: + description: 'The email addresses that should be CCed.' + type: array + items: + type: string + format: email client_id: description: 'The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app.' type: string @@ -8153,6 +8626,52 @@ components: type: array items: $ref: '#/components/schemas/SubCustomField' + field_options: + $ref: '#/components/schemas/SubFieldOptions' + 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' + form_field_rules: + description: 'Conditional Logic rules for fields defined in `form_fields_per_document`.' + type: array + items: + $ref: '#/components/schemas/SubFormFieldRule' + 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' + hide_text_tags: + description: |- + Enables automatic Text Tag removal when set to true. + + **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + type: boolean + default: false + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false message: description: 'The custom message in the email that will be sent to the signers.' type: string @@ -8165,6 +8684,8 @@ components: type: object maxItems: 10 additionalProperties: {} + signing_options: + $ref: '#/components/schemas/SubSigningOptions' signing_redirect_url: description: 'The URL you want signers redirected to after they successfully sign.' type: string @@ -8180,8 +8701,16 @@ components: description: 'The title you want to assign to the SignatureRequest.' type: string maxLength: 255 + use_text_tags: + description: 'Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.' + 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 - SignatureRequestCreateEmbeddedRequest: + SignatureRequestEditEmbeddedRequest: required: - client_id properties: @@ -8333,7 +8862,7 @@ components: type: integer nullable: true type: object - SignatureRequestCreateEmbeddedWithTemplateRequest: + SignatureRequestEditEmbeddedWithTemplateRequest: required: - client_id - template_ids @@ -8417,6 +8946,94 @@ components: type: boolean default: false type: object + SignatureRequestEditWithTemplateRequest: + description: '' + required: + - signers + - template_ids + properties: + template_ids: + description: 'Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used.' + type: array + items: + type: string + allow_decline: + description: 'Allows signers to decline to sign a document if `true`. Defaults to `false`.' + type: boolean + default: false + ccs: + description: 'Add CC email recipients. Required when a CC role exists for the Template.' + type: array + items: + $ref: '#/components/schemas/SubCC' + client_id: + description: 'Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.' + type: string + custom_fields: + description: 'An array defining values and options for custom fields. Required when a custom field exists in the Template.' + type: array + items: + $ref: '#/components/schemas/SubCustomField' + files: + description: |- + Use `files[]` to indicate the uploaded file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + format: binary + file_urls: + description: |- + Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. + + This endpoint requires either **files** or **file_urls[]**, but not both. + type: array + items: + type: string + is_eid: + description: |- + Send with a value of `true` if you wish to enable + [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), + which requires the signer to verify their identity with an eID provider to sign a document.
+ **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + type: boolean + default: false + message: + description: 'The custom message in the email that will be sent to the signers.' + type: string + maxLength: 5000 + metadata: + description: |- + Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. + + Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + type: object + maxItems: 10 + additionalProperties: {} + signers: + description: 'Add Signers to your Templated-based Signature Request.' + type: array + items: + $ref: '#/components/schemas/SubSignatureRequestTemplateSigner' + signing_options: + $ref: '#/components/schemas/SubSigningOptions' + signing_redirect_url: + description: 'The URL you want signers redirected to after they successfully sign.' + type: string + subject: + description: 'The subject in the email that will be sent to the signers.' + type: string + maxLength: 255 + test_mode: + description: 'Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`.' + type: boolean + default: false + title: + description: 'The title you want to assign to the SignatureRequest.' + type: string + maxLength: 255 + type: object SignatureRequestRemindRequest: required: - email_address @@ -13085,498 +13702,522 @@ components: type: string default: 'Hello API Event Received' examples: - AccountCreateRequestDefaultExample: + AccountCreateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountCreateRequestDefaultExample.json - AccountCreateRequestOAuthExample: + $ref: examples/json/AccountCreateRequest.json + AccountCreateRequestOAuth: summary: 'OAuth Example' value: - $ref: examples/json/AccountCreateRequestOAuthExample.json - AccountUpdateRequestDefaultExample: + $ref: examples/json/AccountCreateRequestOAuth.json + AccountUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/AccountUpdateRequestDefaultExample.json - AccountVerifyRequestDefaultExample: + $ref: examples/json/AccountUpdateRequest.json + AccountVerifyRequest: summary: 'Default Example' value: - $ref: examples/json/AccountVerifyRequestDefaultExample.json - ApiAppCreateRequestDefaultExample: + $ref: examples/json/AccountVerifyRequest.json + ApiAppCreateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppCreateRequestDefaultExample.json - ApiAppUpdateRequestDefaultExample: + $ref: examples/json/ApiAppCreateRequest.json + ApiAppUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/ApiAppUpdateRequestDefaultExample.json - EmbeddedEditUrlRequestDefaultExample: + $ref: examples/json/ApiAppUpdateRequest.json + EmbeddedEditUrlRequest: summary: 'Default Example' value: - $ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json - FaxLineAddUserRequestExample: + $ref: examples/json/EmbeddedEditUrlRequest.json + FaxLineAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineAddUserRequestExample.json - FaxLineCreateRequestExample: + $ref: examples/json/FaxLineAddUserRequest.json + FaxLineCreateRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineCreateRequestExample.json - FaxLineDeleteRequestExample: + $ref: examples/json/FaxLineCreateRequest.json + FaxLineDeleteRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineDeleteRequestExample.json - FaxLineRemoveUserRequestExample: + $ref: examples/json/FaxLineDeleteRequest.json + FaxLineRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/FaxLineRemoveUserRequestExample.json - FaxSendRequestExample: + $ref: examples/json/FaxLineRemoveUserRequest.json + FaxSendRequest: summary: 'Default Example' value: - $ref: examples/json/FaxSendRequestExample.json - OAuthTokenGenerateRequestExample: + $ref: examples/json/FaxSendRequest.json + OAuthTokenGenerateRequest: summary: 'OAuth Token Generate Example' value: - $ref: examples/json/OAuthTokenGenerateRequestExample.json - OAuthTokenRefreshRequestExample: + $ref: examples/json/OAuthTokenGenerateRequest.json + OAuthTokenRefreshRequest: summary: 'OAuth Token Refresh Example' value: - $ref: examples/json/OAuthTokenRefreshRequestExample.json - ReportCreateRequestDefaultExample: + $ref: examples/json/OAuthTokenRefreshRequest.json + ReportCreateRequest: + summary: 'Default Example' + value: + $ref: examples/json/ReportCreateRequest.json + SignatureRequestBulkCreateEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.json + SignatureRequestBulkSendWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestBulkSendWithTemplateRequest.json + SignatureRequestCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/ReportCreateRequestDefaultExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedRequest.json + SignatureRequestCreateEmbeddedRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSigners.json + SignatureRequestCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestBulkSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequest.json + SignatureRequestEditRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestDefaultExample: + $ref: examples/json/SignatureRequestEditRequest.json + SignatureRequestEditRequestGroupedSigners: + summary: 'Grouped Signers Example' + value: + $ref: examples/json/SignatureRequestEditRequestGroupedSigners.json + SignatureRequestEditEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestDefaultExample.json - SignatureRequestCreateEmbeddedRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequest.json + SignatureRequestEditEmbeddedRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedRequestGroupedSignersExample.json - SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestEditEmbeddedRequestGroupedSigners.json + SignatureRequestEditEmbeddedWithTemplateRequest: + summary: 'Default Example' + value: + $ref: examples/json/SignatureRequestEditEmbeddedWithTemplateRequest.json + SignatureRequestEditWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateRequestDefaultExample.json - SignatureRequestRemindRequestDefaultExample: + $ref: examples/json/SignatureRequestEditWithTemplateRequest.json + SignatureRequestRemindRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestRemindRequestDefaultExample.json - SignatureRequestSendRequestDefaultExample: + $ref: examples/json/SignatureRequestRemindRequest.json + SignatureRequestSendRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendRequestDefaultExample.json - SignatureRequestSendRequestGroupedSignersExample: + $ref: examples/json/SignatureRequestSendRequest.json + SignatureRequestSendRequestGroupedSigners: summary: 'Grouped Signers Example' value: - $ref: examples/json/SignatureRequestSendRequestGroupedSignersExample.json - SignatureRequestSendWithTemplateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendRequestGroupedSigners.json + SignatureRequestSendWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestSendWithTemplateRequestDefaultExample.json - SignatureRequestUpdateRequestDefaultExample: + $ref: examples/json/SignatureRequestSendWithTemplateRequest.json + SignatureRequestUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/SignatureRequestUpdateRequestDefaultExample.json - TeamAddMemberRequestEmailAddressExample: + $ref: examples/json/SignatureRequestUpdateRequest.json + TeamAddMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamAddMemberRequestEmailAddressExample.json - TeamAddMemberRequestAccountIdExample: + $ref: examples/json/TeamAddMemberRequest.json + TeamAddMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamAddMemberRequestAccountIdExample.json - TeamCreateRequestDefaultExample: + $ref: examples/json/TeamAddMemberRequestAccountId.json + TeamCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamCreateRequestDefaultExample.json - TeamRemoveMemberRequestEmailAddressExample: + $ref: examples/json/TeamCreateRequest.json + TeamRemoveMemberRequest: summary: 'Email Address Example' value: - $ref: examples/json/TeamRemoveMemberRequestEmailAddressExample.json - TeamRemoveMemberRequestAccountIdExample: + $ref: examples/json/TeamRemoveMemberRequest.json + TeamRemoveMemberRequestAccountId: summary: 'Account ID Example' value: - $ref: examples/json/TeamRemoveMemberRequestAccountIdExample.json - TeamUpdateRequestDefaultExample: + $ref: examples/json/TeamRemoveMemberRequestAccountId.json + TeamUpdateRequest: summary: 'Default Example' value: - $ref: examples/json/TeamUpdateRequestDefaultExample.json - TemplateAddUserRequestDefaultExample: + $ref: examples/json/TeamUpdateRequest.json + TemplateAddUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateAddUserRequestDefaultExample.json - TemplateCreateRequestDefaultExample: + $ref: examples/json/TemplateAddUserRequest.json + TemplateCreateRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateRequestDefaultExample.json - TemplateCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateRequest.json + TemplateCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldsPerDocumentExample.json - TemplateCreateRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateRequestFormFieldsPerDocument.json + TemplateCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldGroupsExample.json - TemplateCreateRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateRequestFormFieldGroups.json + TemplateCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateRequestFormFieldRulesExample.json - TemplateCreateEmbeddedDraftRequestDefaultExample: + $ref: examples/json/TemplateCreateRequestFormFieldRules.json + TemplateCreateEmbeddedDraftRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestDefaultExample.json - TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequest.json + TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocumentExample.json - TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldsPerDocument.json + TemplateCreateEmbeddedDraftRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroupsExample.json - TemplateCreateEmbeddedDraftRequestFormFieldRulesExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldGroups.json + TemplateCreateEmbeddedDraftRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRulesExample.json - TemplateRemoveUserRequestDefaultExample: + $ref: examples/json/TemplateCreateEmbeddedDraftRequestFormFieldRules.json + TemplateRemoveUserRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateRemoveUserRequestDefaultExample.json - TemplateUpdateFilesRequestDefaultExample: + $ref: examples/json/TemplateRemoveUserRequest.json + TemplateUpdateFilesRequest: summary: 'Default Example' value: - $ref: examples/json/TemplateUpdateFilesRequestDefaultExample.json - UnclaimedDraftCreateRequestDefaultExample: + $ref: examples/json/TemplateUpdateFilesRequest.json + UnclaimedDraftCreateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestDefaultExample.json - UnclaimedDraftCreateRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateRequest.json + UnclaimedDraftCreateRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldsPerDocument.json + UnclaimedDraftCreateRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroupsExample.json - UnclaimedDraftCreateRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldGroups.json + UnclaimedDraftCreateRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestDefaultExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequest.json + UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument: summary: 'Form Fields Per Document Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocumentExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldsPerDocument.json + UnclaimedDraftCreateEmbeddedRequestFormFieldGroups: summary: 'Form Fields Per Document and Groups Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroupsExample.json - UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldGroups.json + UnclaimedDraftCreateEmbeddedRequestFormFieldRules: summary: 'Form Fields Per Document and Rules Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRulesExample.json - UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedRequestFormFieldRules.json + UnclaimedDraftCreateEmbeddedWithTemplateRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequestDefaultExample.json - UnclaimedDraftEditAndResendRequestDefaultExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateRequest.json + UnclaimedDraftEditAndResendRequest: summary: 'Default Example' value: - $ref: examples/json/UnclaimedDraftEditAndResendRequestDefaultExample.json - AccountCreateResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResendRequest.json + AccountCreateResponse: summary: 'Account Create' value: - $ref: examples/json/AccountCreateResponseExample.json - AccountCreateOAuthResponseExample: + $ref: examples/json/AccountCreateResponse.json + AccountCreateOAuthResponse: summary: 'Account Create with OAuth Authorization' value: - $ref: examples/json/AccountCreateOAuthResponseExample.json - AccountGetResponseExample: + $ref: examples/json/AccountCreateOAuthResponse.json + AccountGetResponse: summary: 'Account Get' value: - $ref: examples/json/AccountGetResponseExample.json - AccountVerifyFoundResponseExample: + $ref: examples/json/AccountGetResponse.json + AccountVerifyFoundResponse: summary: 'Account Found' value: - $ref: examples/json/AccountVerifyFoundResponseExample.json - AccountVerifyNotFoundResponseExample: + $ref: examples/json/AccountVerifyFoundResponse.json + AccountVerifyNotFoundResponse: summary: 'Account Not Found' value: - $ref: examples/json/AccountVerifyNotFoundResponseExample.json - ApiAppGetResponseExample: + $ref: examples/json/AccountVerifyNotFoundResponse.json + ApiAppGetResponse: summary: 'API App' value: - $ref: examples/json/ApiAppGetResponseExample.json - ApiAppListResponseExample: + $ref: examples/json/ApiAppGetResponse.json + ApiAppListResponse: summary: 'API App List' value: - $ref: examples/json/ApiAppListResponseExample.json - BulkSendJobGetResponseExample: + $ref: examples/json/ApiAppListResponse.json + BulkSendJobGetResponse: summary: 'Bulk Send Job' value: - $ref: examples/json/BulkSendJobGetResponseExample.json - BulkSendJobListResponseExample: + $ref: examples/json/BulkSendJobGetResponse.json + BulkSendJobListResponse: summary: 'Bulk Send Job List' value: - $ref: examples/json/BulkSendJobListResponseExample.json - EmbeddedEditUrlResponseExample: + $ref: examples/json/BulkSendJobListResponse.json + EmbeddedEditUrlResponse: summary: 'Embedded Edit URL' value: - $ref: examples/json/EmbeddedEditUrlResponseExample.json - EmbeddedSignUrlResponseExample: + $ref: examples/json/EmbeddedEditUrlResponse.json + EmbeddedSignUrlResponse: summary: 'Embedded Sign URL' value: - $ref: examples/json/EmbeddedSignUrlResponseExample.json - Error400ResponseExample: + $ref: examples/json/EmbeddedSignUrlResponse.json + Error400Response: summary: 'Error 400 bad_request' value: - $ref: examples/json/Error400ResponseExample.json - Error401ResponseExample: + $ref: examples/json/Error400Response.json + Error401Response: summary: 'Error 401 unauthorized' value: - $ref: examples/json/Error401ResponseExample.json - Error402ResponseExample: + $ref: examples/json/Error401Response.json + Error402Response: summary: 'Error 402 payment_required' value: - $ref: examples/json/Error402ResponseExample.json - Error403ResponseExample: + $ref: examples/json/Error402Response.json + Error403Response: summary: 'Error 403 forbidden' value: - $ref: examples/json/Error403ResponseExample.json - Error404ResponseExample: + $ref: examples/json/Error403Response.json + Error404Response: summary: 'Error 404 not_found' value: - $ref: examples/json/Error404ResponseExample.json - Error409ResponseExample: + $ref: examples/json/Error404Response.json + Error409Response: summary: 'Error 409 conflict' value: - $ref: examples/json/Error409ResponseExample.json - Error410ResponseExample: + $ref: examples/json/Error409Response.json + Error410Response: summary: 'Error 410 deleted' value: - $ref: examples/json/Error410ResponseExample.json - Error422ResponseExample: + $ref: examples/json/Error410Response.json + Error422Response: summary: 'Error 422 unprocessable_entity' value: - $ref: examples/json/Error422ResponseExample.json - Error429ResponseExample: + $ref: examples/json/Error422Response.json + Error429Response: summary: 'Error 429 exceeded_rate' value: - $ref: examples/json/Error429ResponseExample.json - Error4XXResponseExample: + $ref: examples/json/Error429Response.json + Error4XXResponse: summary: 'Error 4XX failed_operation' value: - $ref: examples/json/Error4XXResponseExample.json - FaxGetResponseExample: + $ref: examples/json/Error4XXResponse.json + FaxGetResponse: summary: 'Fax Response' value: - $ref: examples/json/FaxGetResponseExample.json - FaxLineResponseExample: + $ref: examples/json/FaxGetResponse.json + FaxLineResponse: summary: 'Sample Fax Line Response' value: - $ref: examples/json/FaxLineResponseExample.json - FaxLineAreaCodeGetResponseExample: + $ref: examples/json/FaxLineResponse.json + FaxLineAreaCodeGetResponse: summary: 'Sample Area Code Response' value: - $ref: examples/json/FaxLineAreaCodeGetResponseExample.json - FaxLineListResponseExample: + $ref: examples/json/FaxLineAreaCodeGetResponse.json + FaxLineListResponse: summary: 'Sample Fax Line List Response' value: - $ref: examples/json/FaxLineListResponseExample.json - FaxListResponseExample: - summary: 'Returns the properties and settings of multiple Faxes.' + $ref: examples/json/FaxLineListResponse.json + FaxListResponse: + summary: 'Returns the properties and settings of multiple Faxes' value: - $ref: examples/json/FaxListResponseExample.json - ReportCreateResponseExample: + $ref: examples/json/FaxListResponse.json + ReportCreateResponse: summary: Report value: - $ref: examples/json/ReportCreateResponseExample.json - SignatureRequestGetResponseExample: + $ref: examples/json/ReportCreateResponse.json + SignatureRequestGetResponse: summary: 'Get Signature Request' value: - $ref: examples/json/SignatureRequestGetResponseExample.json - SignatureRequestListResponseExample: + $ref: examples/json/SignatureRequestGetResponse.json + SignatureRequestListResponse: summary: 'List Signature Requests' value: - $ref: examples/json/SignatureRequestListResponseExample.json - AccountUpdateResponseExample: + $ref: examples/json/SignatureRequestListResponse.json + AccountUpdateResponse: summary: 'Account Update' value: - $ref: examples/json/AccountUpdateResponseExample.json - OAuthTokenGenerateResponseExample: + $ref: examples/json/AccountUpdateResponse.json + OAuthTokenGenerateResponse: summary: 'Retrieving the OAuth token' value: - $ref: examples/json/OAuthTokenGenerateResponseExample.json - OAuthTokenRefreshResponseExample: + $ref: examples/json/OAuthTokenGenerateResponse.json + OAuthTokenRefreshResponse: summary: 'Refresh an existing OAuth token' value: - $ref: examples/json/OAuthTokenRefreshResponseExample.json - ApiAppCreateResponseExample: + $ref: examples/json/OAuthTokenRefreshResponse.json + ApiAppCreateResponse: summary: 'API App' value: - $ref: examples/json/ApiAppCreateResponseExample.json - ApiAppUpdateResponseExample: + $ref: examples/json/ApiAppCreateResponse.json + ApiAppUpdateResponse: summary: 'API App Update' value: - $ref: examples/json/ApiAppUpdateResponseExample.json - SignatureRequestCreateEmbeddedResponseExample: + $ref: examples/json/ApiAppUpdateResponse.json + SignatureRequestCreateEmbeddedResponse: summary: 'Create Embedded Signature Request' value: - $ref: examples/json/SignatureRequestCreateEmbeddedResponseExample.json - SignatureRequestCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedResponse.json + SignatureRequestCreateEmbeddedWithTemplateResponse: summary: 'Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponseExample.json - SignatureRequestFilesResponseExample: + $ref: examples/json/SignatureRequestCreateEmbeddedWithTemplateResponse.json + SignatureRequestFilesResponse: summary: 'Signature Requests Files' value: - $ref: examples/json/SignatureRequestFilesResponseExample.json - SignatureRequestReleaseHoldResponseExample: + $ref: examples/json/SignatureRequestFilesResponse.json + SignatureRequestReleaseHoldResponse: summary: 'Send Signature Release Hold' value: - $ref: examples/json/SignatureRequestReleaseHoldResponseExample.json - SignatureRequestRemindResponseExample: + $ref: examples/json/SignatureRequestReleaseHoldResponse.json + SignatureRequestRemindResponse: summary: 'Send Signature Request Reminder' value: - $ref: examples/json/SignatureRequestRemindResponseExample.json - SignatureRequestSendResponseExample: + $ref: examples/json/SignatureRequestRemindResponse.json + SignatureRequestSendResponse: summary: 'Send Signature Request' value: - $ref: examples/json/SignatureRequestSendResponseExample.json - SignatureRequestSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestSendResponse.json + SignatureRequestSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestSendWithTemplateResponseExample.json - SignatureRequestUpdateResponseExample: + $ref: examples/json/SignatureRequestSendWithTemplateResponse.json + SignatureRequestUpdateResponse: summary: 'Signature Request Update' value: - $ref: examples/json/SignatureRequestUpdateResponseExample.json - SignatureRequestBulkSendWithTemplateResponseExample: + $ref: examples/json/SignatureRequestUpdateResponse.json + SignatureRequestBulkSendWithTemplateResponse: summary: 'Send Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkSendWithTemplateResponseExample.json - SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/SignatureRequestBulkSendWithTemplateResponse.json + SignatureRequestBulkCreateEmbeddedWithTemplateResponse: summary: 'Bulk Send Create Embedded Signature Request With Template' value: - $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponseExample.json - TeamCreateResponseExample: + $ref: examples/json/SignatureRequestBulkCreateEmbeddedWithTemplateResponse.json + TeamCreateResponse: summary: 'Team Create' value: - $ref: examples/json/TeamCreateResponseExample.json - TeamMembersResponseExample: + $ref: examples/json/TeamCreateResponse.json + TeamMembersResponse: summary: 'Team Members List' value: - $ref: examples/json/TeamMembersResponseExample.json - TeamRemoveMemberResponseExample: + $ref: examples/json/TeamMembersResponse.json + TeamRemoveMemberResponse: summary: 'Team Remove Member' value: - $ref: examples/json/TeamRemoveMemberResponseExample.json - TeamUpdateResponseExample: + $ref: examples/json/TeamRemoveMemberResponse.json + TeamUpdateResponse: summary: 'Team Update' value: - $ref: examples/json/TeamUpdateResponseExample.json - TeamDoesNotExistResponseExample: + $ref: examples/json/TeamUpdateResponse.json + TeamDoesNotExistResponse: summary: 'Team Does Not Exist' value: - $ref: examples/json/TeamDoesNotExistResponseExample.json - TemplateAddUserResponseExample: + $ref: examples/json/TeamDoesNotExistResponse.json + TemplateAddUserResponse: summary: 'Add User to Template' value: - $ref: examples/json/TemplateAddUserResponseExample.json - TemplateFilesResponseExample: + $ref: examples/json/TemplateAddUserResponse.json + TemplateFilesResponse: summary: 'Template Files' value: - $ref: examples/json/TemplateFilesResponseExample.json - TemplateRemoveUserResponseExample: + $ref: examples/json/TemplateFilesResponse.json + TemplateRemoveUserResponse: summary: 'Remove User from Template' value: - $ref: examples/json/TemplateRemoveUserResponseExample.json - UnclaimedDraftCreateEmbeddedResponseExample: + $ref: examples/json/TemplateRemoveUserResponse.json + UnclaimedDraftCreateEmbeddedResponse: summary: 'Unclaimed Draft Create Embedded' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedResponseExample.json - UnclaimedDraftCreateEmbeddedWithTemplateResponseExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedResponse.json + UnclaimedDraftCreateEmbeddedWithTemplateResponse: summary: 'Unclaimed Draft Create Embedded With Template' value: - $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponseExample.json - UnclaimedDraftEditAndResendExample: + $ref: examples/json/UnclaimedDraftCreateEmbeddedWithTemplateResponse.json + UnclaimedDraftEditAndResend: summary: 'Unclaimed Draft Edit and Resend' value: - $ref: examples/json/UnclaimedDraftEditAndResendExample.json - TeamGetResponseExample: + $ref: examples/json/UnclaimedDraftEditAndResend.json + TeamGetResponse: summary: 'Team Get' value: - $ref: examples/json/TeamGetResponseExample.json - TeamGetInfoResponseExample: + $ref: examples/json/TeamGetResponse.json + TeamGetInfoResponse: summary: 'Team Get Info' value: - $ref: examples/json/TeamGetInfoResponseExample.json - TeamInvitesResponseExample: + $ref: examples/json/TeamGetInfoResponse.json + TeamInvitesResponse: summary: 'Team Invites' value: - $ref: examples/json/TeamInvitesResponseExample.json - TeamAddMemberResponseExample: + $ref: examples/json/TeamInvitesResponse.json + TeamAddMemberResponse: summary: 'Team Add Member' value: - $ref: examples/json/TeamAddMemberResponseExample.json - TeamSubTeamsResponseExample: + $ref: examples/json/TeamAddMemberResponse.json + TeamSubTeamsResponse: summary: 'Team Sub Teams List' value: - $ref: examples/json/TeamSubTeamsResponseExample.json - TemplateCreateResponseExample: + $ref: examples/json/TeamSubTeamsResponse.json + TemplateCreateResponse: summary: 'Create Template' value: - $ref: examples/json/TemplateCreateResponseExample.json - TemplateCreateEmbeddedDraftResponseExample: + $ref: examples/json/TemplateCreateResponse.json + TemplateCreateEmbeddedDraftResponse: summary: 'Create Embedded Draft Template' value: - $ref: examples/json/TemplateCreateEmbeddedDraftResponseExample.json - TemplateGetResponseExample: + $ref: examples/json/TemplateCreateEmbeddedDraftResponse.json + TemplateGetResponse: summary: 'Get Template' value: - $ref: examples/json/TemplateGetResponseExample.json - TemplateListResponseExample: + $ref: examples/json/TemplateGetResponse.json + TemplateListResponse: summary: 'List Templates' value: - $ref: examples/json/TemplateListResponseExample.json - TemplateUpdateFilesResponseExample: + $ref: examples/json/TemplateListResponse.json + TemplateUpdateFilesResponse: summary: 'Update Template Files' value: - $ref: examples/json/TemplateUpdateFilesResponseExample.json - UnclaimedDraftCreateResponseExample: + $ref: examples/json/TemplateUpdateFilesResponse.json + UnclaimedDraftCreateResponse: summary: 'Unclaimed Draft Create' value: - $ref: examples/json/UnclaimedDraftCreateResponseExample.json - EventCallbackAccountSignatureRequestSentExample: + $ref: examples/json/UnclaimedDraftCreateResponse.json + EventCallbackAccountSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAccountSignatureRequestSentExample.json - EventCallbackAccountTemplateCreatedExample: + $ref: examples/json/EventCallbackAccountSignatureRequestSent.json + EventCallbackAccountTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAccountTemplateCreatedExample.json - EventCallbackAppAccountConfirmedExample: + $ref: examples/json/EventCallbackAccountTemplateCreated.json + EventCallbackAppAccountConfirmed: summary: 'Example: account_confirmed' value: - $ref: examples/json/EventCallbackAppAccountConfirmedExample.json - EventCallbackAppSignatureRequestSentExample: + $ref: examples/json/EventCallbackAppAccountConfirmed.json + EventCallbackAppSignatureRequestSent: summary: 'Example: signature_request_sent' value: - $ref: examples/json/EventCallbackAppSignatureRequestSentExample.json - EventCallbackAppTemplateCreatedExample: + $ref: examples/json/EventCallbackAppSignatureRequestSent.json + EventCallbackAppTemplateCreated: summary: 'Example: template_created' value: - $ref: examples/json/EventCallbackAppTemplateCreatedExample.json + $ref: examples/json/EventCallbackAppTemplateCreated.json requestBodies: EventCallbackAccountRequest: description: |- @@ -13588,9 +14229,9 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAccountSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAccountSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAccountTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAccountTemplateCreated' EventCallbackAppRequest: description: |- **API App Callback Payloads --** @@ -13601,11 +14242,11 @@ components: $ref: '#/components/schemas/EventCallbackRequest' examples: account_confirmed_example: - $ref: '#/components/examples/EventCallbackAppAccountConfirmedExample' + $ref: '#/components/examples/EventCallbackAppAccountConfirmed' signature_request_sent_example: - $ref: '#/components/examples/EventCallbackAppSignatureRequestSentExample' + $ref: '#/components/examples/EventCallbackAppSignatureRequestSent' template_created_example: - $ref: '#/components/examples/EventCallbackAppTemplateCreatedExample' + $ref: '#/components/examples/EventCallbackAppTemplateCreated' headers: X-RateLimit-Limit: description: 'The maximum number of requests per hour that you can make.' @@ -13642,6 +14283,7 @@ components: security: - api_key: [] + - oauth2: - account_access - signature_request_access @@ -13669,37 +14311,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: @@ -13722,37 +14359,32 @@ x-webhooks: lang: PHP label: PHP source: - $ref: examples/EventCallback.php + $ref: examples/EventCallbackExample.php - lang: 'C#' label: 'C#' source: - $ref: examples/EventCallback.cs - - - lang: JavaScript - label: JavaScript - source: - $ref: examples/EventCallback.js + $ref: examples/EventCallbackExample.cs - lang: TypeScript label: TypeScript source: - $ref: examples/EventCallback.ts + $ref: examples/EventCallbackExample.ts - lang: Java label: Java source: - $ref: examples/EventCallback.java + $ref: examples/EventCallbackExample.java - lang: Ruby label: Ruby source: - $ref: examples/EventCallback.rb + $ref: examples/EventCallbackExample.rb - lang: Python label: Python source: - $ref: examples/EventCallback.py + $ref: examples/EventCallbackExample.py tags: - 'Callbacks and Events' requestBody: diff --git a/pom.xml b/pom.xml index 49afbf5..ee9e7fb 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ dropbox-sign jar dropbox-sign - 2.4.0 + 2.5.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! @@ -334,6 +334,7 @@ jersey-apache-connector ${jersey-version} + org.junit.jupiter @@ -355,6 +356,7 @@ 2.17.1 0.2.6 2.1.1 + 3.0.2 5.10.0 2.21.0 3.12.4 diff --git a/run-build b/run-build index 778da00..2831739 100755 --- a/run-build +++ b/run-build @@ -18,7 +18,7 @@ rm -f "${DIR}/src/main/java/com/dropbox/sign/model/"*.java docker run --rm \ -v "${DIR}/:/local" \ - openapitools/openapi-generator-cli:v7.8.0 generate \ + openapitools/openapi-generator-cli:v7.12.0 generate \ -i "/local/openapi-sdk.yaml" \ -c "/local/openapi-config.yaml" \ -t "/local/templates" \ @@ -47,6 +47,9 @@ docker run --rm \ -w "${WORKING_DIR}" \ perl bash ./bin/scan_for +printf "Adding old-style constant names ...\n" +bash "${DIR}/bin/php" ./bin/copy-constants.php + # avoid docker messing with permissions if [[ -z "$GITHUB_ACTIONS" ]]; then chmod 644 "${DIR}/README.md" diff --git a/src/main/java/com/dropbox/sign/ApiClient.java b/src/main/java/com/dropbox/sign/ApiClient.java index 7572760..3ba325f 100644 --- a/src/main/java/com/dropbox/sign/ApiClient.java +++ b/src/main/java/com/dropbox/sign/ApiClient.java @@ -84,7 +84,7 @@ /** *

ApiClient class.

*/ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ApiClient extends JavaTimeFormatter { private static final Pattern JSON_MIME_PATTERN = Pattern.compile("(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$"); @@ -159,7 +159,7 @@ public ApiClient(Map authMap) { this.dateFormat = new RFC3339DateFormat(); // Set default User-Agent. - setUserAgent("OpenAPI-Generator/2.4.0/java"); + setUserAgent("OpenAPI-Generator/2.5.0/java"); // Setup authentications (key: authentication name, value: authentication). authentications = new HashMap<>(); @@ -807,24 +807,10 @@ public Entity serialize(Object obj, Map formParams, String co if (contentType.startsWith("multipart/form-data")) { MultiPart multiPart = new MultiPart(); for (Entry param: formParams.entrySet()) { - if (param.getValue() instanceof File) { - File file = (File) param.getValue(); - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()) - .fileName(file.getName()).size(file.length()).build(); - - // Attempt to probe the content type for the file so that the form part is more correctly - // and precisely identified, but fall back to application/octet-stream if that fails. - MediaType type; - try { - type = MediaType.valueOf(Files.probeContentType(file.toPath())); - } catch (IOException | IllegalArgumentException e) { - type = MediaType.APPLICATION_OCTET_STREAM_TYPE; - } - - multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + if (param.getValue() instanceof Iterable) { + ((Iterable)param.getValue()).forEach(v -> addParamToMultipart(v, param.getKey(), multiPart)); } else { - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()).build(); - multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(param.getValue()))); + addParamToMultipart(param.getValue(), param.getKey(), multiPart); } } entity = Entity.entity(multiPart, MediaType.MULTIPART_FORM_DATA_TYPE); @@ -853,6 +839,36 @@ public Entity serialize(Object obj, Map formParams, String co return entity; } + /** + * Adds the object with the provided key to the MultiPart. + * Based on the object type sets Content-Disposition and Content-Type. + * + * @param obj Object + * @param key Key of the object + * @param multiPart MultiPart to add the form param to + */ + private void addParamToMultipart(Object value, String key, MultiPart multiPart) { + if (value instanceof File) { + File file = (File) value; + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key) + .fileName(file.getName()).size(file.length()).build(); + + // Attempt to probe the content type for the file so that the form part is more correctly + // and precisely identified, but fall back to application/octet-stream if that fails. + MediaType type; + try { + type = MediaType.valueOf(Files.probeContentType(file.toPath())); + } catch (IOException | IllegalArgumentException e) { + type = MediaType.APPLICATION_OCTET_STREAM_TYPE; + } + + multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + } else { + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key).build(); + multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(value))); + } + } + /** * Serialize the given Java object into string according the given * Content-Type (only JSON, HTTP form is supported for now). @@ -1143,7 +1159,11 @@ private Response sendRequest(String method, Invocation.Builder invocationBuilder } else if ("PUT".equals(method)) { response = invocationBuilder.put(entity); } else if ("DELETE".equals(method)) { - response = invocationBuilder.method("DELETE", entity); + if ("".equals(entity.getEntity())) { + response = invocationBuilder.method("DELETE"); + } else { + response = invocationBuilder.method("DELETE", entity); + } } else if ("PATCH".equals(method)) { response = invocationBuilder.method("PATCH", entity); } else { diff --git a/src/main/java/com/dropbox/sign/ApiException.java b/src/main/java/com/dropbox/sign/ApiException.java index 2d61576..bb51040 100644 --- a/src/main/java/com/dropbox/sign/ApiException.java +++ b/src/main/java/com/dropbox/sign/ApiException.java @@ -20,7 +20,7 @@ /** * API Exception */ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ApiException extends Exception { private static final long serialVersionUID = 1L; diff --git a/src/main/java/com/dropbox/sign/Configuration.java b/src/main/java/com/dropbox/sign/Configuration.java index 1b636b9..39af453 100644 --- a/src/main/java/com/dropbox/sign/Configuration.java +++ b/src/main/java/com/dropbox/sign/Configuration.java @@ -13,11 +13,11 @@ package com.dropbox.sign; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class Configuration { - public static final String VERSION = "2.4.0"; + public static final String VERSION = "2.5.0"; - private static ApiClient defaultApiClient = new ApiClient(); + private static volatile ApiClient defaultApiClient = new ApiClient(); /** * Get the default API client, which would be used when creating API diff --git a/src/main/java/com/dropbox/sign/EventCallbackHelper.java b/src/main/java/com/dropbox/sign/EventCallbackHelper.java index 2470e2b..837f211 100644 --- a/src/main/java/com/dropbox/sign/EventCallbackHelper.java +++ b/src/main/java/com/dropbox/sign/EventCallbackHelper.java @@ -18,7 +18,7 @@ import org.apache.commons.codec.digest.HmacAlgorithms; import org.apache.commons.codec.digest.HmacUtils; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class EventCallbackHelper { public static final String EVENT_TYPE_ACCOUNT_CALLBACK = "account_callback"; diff --git a/src/main/java/com/dropbox/sign/JSON.java b/src/main/java/com/dropbox/sign/JSON.java index 68a3518..feb72da 100644 --- a/src/main/java/com/dropbox/sign/JSON.java +++ b/src/main/java/com/dropbox/sign/JSON.java @@ -17,7 +17,6 @@ import com.fasterxml.jackson.databind.*; import com.fasterxml.jackson.databind.json.JsonMapper; import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; -import com.dropbox.sign.model.*; import java.text.DateFormat; import java.util.HashMap; @@ -27,7 +26,7 @@ import jakarta.ws.rs.core.GenericType; import jakarta.ws.rs.ext.ContextResolver; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class JSON implements ContextResolver { private ObjectMapper mapper; diff --git a/src/main/java/com/dropbox/sign/JavaTimeFormatter.java b/src/main/java/com/dropbox/sign/JavaTimeFormatter.java index f91775b..b9cf82b 100644 --- a/src/main/java/com/dropbox/sign/JavaTimeFormatter.java +++ b/src/main/java/com/dropbox/sign/JavaTimeFormatter.java @@ -20,7 +20,7 @@ * Class that add parsing/formatting support for Java 8+ {@code OffsetDateTime} class. * It's generated for java clients when {@code AbstractJavaCodegen#dateLibrary} specified as {@code java8}. */ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class JavaTimeFormatter { private DateTimeFormatter offsetDateTimeFormatter = DateTimeFormatter.ISO_OFFSET_DATE_TIME; diff --git a/src/main/java/com/dropbox/sign/Pair.java b/src/main/java/com/dropbox/sign/Pair.java index 271555c..8172fd6 100644 --- a/src/main/java/com/dropbox/sign/Pair.java +++ b/src/main/java/com/dropbox/sign/Pair.java @@ -13,7 +13,7 @@ package com.dropbox.sign; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class Pair { private String name = ""; private String value = ""; diff --git a/src/main/java/com/dropbox/sign/RFC3339DateFormat.java b/src/main/java/com/dropbox/sign/RFC3339DateFormat.java index df30003..2f90336 100644 --- a/src/main/java/com/dropbox/sign/RFC3339DateFormat.java +++ b/src/main/java/com/dropbox/sign/RFC3339DateFormat.java @@ -22,7 +22,7 @@ import java.util.GregorianCalendar; import java.util.TimeZone; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class RFC3339DateFormat extends DateFormat { private static final long serialVersionUID = 1L; private static final TimeZone TIMEZONE_Z = TimeZone.getTimeZone("UTC"); diff --git a/src/main/java/com/dropbox/sign/ServerConfiguration.java b/src/main/java/com/dropbox/sign/ServerConfiguration.java index cb85f1c..e947932 100644 --- a/src/main/java/com/dropbox/sign/ServerConfiguration.java +++ b/src/main/java/com/dropbox/sign/ServerConfiguration.java @@ -18,7 +18,7 @@ /** * Representing a Server configuration. */ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ServerConfiguration { public String URL; public String description; diff --git a/src/main/java/com/dropbox/sign/ServerVariable.java b/src/main/java/com/dropbox/sign/ServerVariable.java index c40ffb4..f45333c 100644 --- a/src/main/java/com/dropbox/sign/ServerVariable.java +++ b/src/main/java/com/dropbox/sign/ServerVariable.java @@ -18,7 +18,7 @@ /** * Representing a Server Variable for server URL template substitution. */ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ServerVariable { public String description; public String defaultValue; diff --git a/src/main/java/com/dropbox/sign/StringUtil.java b/src/main/java/com/dropbox/sign/StringUtil.java index f3bd08f..246fae5 100644 --- a/src/main/java/com/dropbox/sign/StringUtil.java +++ b/src/main/java/com/dropbox/sign/StringUtil.java @@ -16,7 +16,7 @@ import java.util.Collection; import java.util.Iterator; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class StringUtil { /** * Check if the given array contains the given value (with case-insensitive comparison). diff --git a/src/main/java/com/dropbox/sign/api/AccountApi.java b/src/main/java/com/dropbox/sign/api/AccountApi.java index 95a5a8a..3981d8d 100644 --- a/src/main/java/com/dropbox/sign/api/AccountApi.java +++ b/src/main/java/com/dropbox/sign/api/AccountApi.java @@ -22,7 +22,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class AccountApi { private ApiClient apiClient; @@ -53,13 +53,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Create Account. + * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. * @param accountCreateRequest (required) * @return AccountCreateResponse * @throws ApiException if fails to make API call * @http.response.details - +
+ @@ -71,13 +72,14 @@ public AccountCreateResponse accountCreate(AccountCreateRequest accountCreateReq /** - * Create Account. + * Create Account * Creates a new Dropbox Sign Account that is associated with the specified `email_address`. * @param accountCreateRequest (required) * @return ApiResponse<AccountCreateResponse> * @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 -
+
+ @@ -114,14 +116,15 @@ public ApiResponse accountCreateWithHttpInfo(AccountCreat ); } /** - * Get Account. + * Get Account * Returns the properties and settings of your Account. * @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 * @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 -
+
+ @@ -172,14 +175,15 @@ public ApiResponse accountGetWithHttpInfo(String accountId) /** - * Get Account. + * Get Account * Returns the properties and settings of your Account. * @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> * @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 -
+
+ @@ -217,13 +221,14 @@ public ApiResponse accountGetWithHttpInfo(String accountId, ); } /** - * Update Account. + * 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. * @param accountUpdateRequest (required) * @return AccountGetResponse * @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 -
+
+ @@ -235,13 +240,14 @@ public AccountGetResponse accountUpdate(AccountUpdateRequest accountUpdateReques /** - * Update Account. + * 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. * @param accountUpdateRequest (required) * @return ApiResponse<AccountGetResponse> * @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 -
+
+ @@ -278,13 +284,14 @@ public ApiResponse accountUpdateWithHttpInfo(AccountUpdateRe ); } /** - * Verify Account. + * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. * @param accountVerifyRequest (required) * @return AccountVerifyResponse * @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 -
+
+ @@ -296,13 +303,14 @@ public AccountVerifyResponse accountVerify(AccountVerifyRequest accountVerifyReq /** - * Verify Account. + * Verify Account * Verifies whether an Dropbox Sign Account exists for the given email address. * @param accountVerifyRequest (required) * @return ApiResponse<AccountVerifyResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/ApiAppApi.java b/src/main/java/com/dropbox/sign/api/ApiAppApi.java index 37ec596..813cf39 100644 --- a/src/main/java/com/dropbox/sign/api/ApiAppApi.java +++ b/src/main/java/com/dropbox/sign/api/ApiAppApi.java @@ -20,7 +20,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ApiAppApi { private ApiClient apiClient; @@ -51,13 +51,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Create API App. + * Create API App * Creates a new API App. * @param apiAppCreateRequest (required) * @return ApiAppGetResponse * @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 -
+
+ @@ -69,13 +70,14 @@ public ApiAppGetResponse apiAppCreate(ApiAppCreateRequest apiAppCreateRequest) t /** - * Create API App. + * Create API App * Creates a new API App. * @param apiAppCreateRequest (required) * @return ApiResponse<ApiAppGetResponse> * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
201 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -112,12 +114,13 @@ public ApiResponse apiAppCreateWithHttpInfo(ApiAppCreateReque ); } /** - * Delete API App. + * Delete API App * Deletes an API App. Can only be invoked for apps you own. * @param clientId The client id of the API App to delete. (required) * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
201 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -129,13 +132,14 @@ public void apiAppDelete(String clientId) throws ApiException { /** - * Delete API App. + * Delete API App * Deletes an API App. Can only be invoked for apps you own. * @param clientId The client id of the API App to delete. (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -175,13 +179,14 @@ public ApiResponse apiAppDeleteWithHttpInfo(String clientId) throws ApiExc ); } /** - * Get API App. + * Get API App * Returns an object with information about an API App. * @param clientId The client id of the API App to retrieve. (required) * @return ApiAppGetResponse * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -193,13 +198,14 @@ public ApiAppGetResponse apiAppGet(String clientId) throws ApiException { /** - * Get API App. + * Get API App * Returns an object with information about an API App. * @param clientId The client id of the API App to retrieve. (required) * @return ApiResponse<ApiAppGetResponse> * @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 -
+
+ @@ -240,14 +246,15 @@ public ApiResponse apiAppGetWithHttpInfo(String clientId) thr ); } /** - * List API Apps. + * 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. * @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 * @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 -
+
+ @@ -298,14 +305,15 @@ public ApiResponse apiAppListWithHttpInfo(Integer page) thro /** - * List API Apps. + * 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. * @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> * @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 -
+
+ @@ -349,14 +357,15 @@ public ApiResponse apiAppListWithHttpInfo(Integer page, Inte ); } /** - * Update API App. + * 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. * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiAppGetResponse * @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 -
+
+ @@ -368,14 +377,15 @@ public ApiAppGetResponse apiAppUpdate(String clientId, ApiAppUpdateRequest apiAp /** - * Update API App. + * 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. * @param clientId The client id of the API App to update. (required) * @param apiAppUpdateRequest (required) * @return ApiResponse<ApiAppGetResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java b/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java index 405caf7..098c28c 100644 --- a/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java +++ b/src/main/java/com/dropbox/sign/api/BulkSendJobApi.java @@ -18,7 +18,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class BulkSendJobApi { private ApiClient apiClient; @@ -49,7 +49,7 @@ public void setApiClient(ApiClient apiClient) { } /** - * Get Bulk Send Job. + * Get Bulk Send Job * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. * @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) @@ -57,7 +57,8 @@ public void setApiClient(ApiClient apiClient) { * @return BulkSendJobGetResponse * @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 -
+
+ @@ -108,7 +109,7 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul /** - * Get Bulk Send Job. + * Get Bulk Send Job * Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter. * @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) @@ -116,7 +117,8 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul * @return ApiResponse<BulkSendJobGetResponse> * @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 -
+
+ @@ -169,14 +171,15 @@ public ApiResponse bulkSendJobGetWithHttpInfo(String bul ); } /** - * List Bulk Send Jobs. + * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. * @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 * @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 -
+
+ @@ -227,14 +230,15 @@ public ApiResponse bulkSendJobListWithHttpInfo(Integer /** - * List Bulk Send Jobs. + * List Bulk Send Jobs * Returns a list of BulkSendJob that you can access. * @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> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/EmbeddedApi.java b/src/main/java/com/dropbox/sign/api/EmbeddedApi.java index 38c828e..a847620 100644 --- a/src/main/java/com/dropbox/sign/api/EmbeddedApi.java +++ b/src/main/java/com/dropbox/sign/api/EmbeddedApi.java @@ -19,7 +19,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class EmbeddedApi { private ApiClient apiClient; @@ -50,14 +50,15 @@ public void setApiClient(ApiClient apiClient) { } /** - * Get Embedded Template Edit URL. + * 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. * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return EmbeddedEditUrlResponse * @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 -
+
+ @@ -69,14 +70,15 @@ public EmbeddedEditUrlResponse embeddedEditUrl(String templateId, EmbeddedEditUr /** - * Get Embedded Template Edit URL. + * 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. * @param templateId The id of the template to edit. (required) * @param embeddedEditUrlRequest (required) * @return ApiResponse<EmbeddedEditUrlResponse> * @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 -
+
+ @@ -120,13 +122,14 @@ public ApiResponse embeddedEditUrlWithHttpInfo(String t ); } /** - * Get Embedded Sign URL. + * 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. * @param signatureId The id of the signature to get a signature url for. (required) * @return EmbeddedSignUrlResponse * @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 -
+
+ @@ -138,13 +141,14 @@ public EmbeddedSignUrlResponse embeddedSignUrl(String signatureId) throws ApiExc /** - * Get Embedded Sign URL. + * 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. * @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 * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/FaxApi.java b/src/main/java/com/dropbox/sign/api/FaxApi.java index e010c83..e438d0d 100644 --- a/src/main/java/com/dropbox/sign/api/FaxApi.java +++ b/src/main/java/com/dropbox/sign/api/FaxApi.java @@ -20,7 +20,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class FaxApi { private ApiClient apiClient; @@ -51,12 +51,13 @@ public void setApiClient(ApiClient apiClient) { } /** - * Delete Fax. - * Deletes the specified Fax from the system. + * Delete Fax + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @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 -
+
+ @@ -68,13 +69,14 @@ public void faxDelete(String faxId) throws ApiException { /** - * Delete Fax. - * Deletes the specified Fax from the system. + * Delete Fax + * Deletes the specified Fax from the system * @param faxId Fax ID (required) * @return ApiResponse<Void> * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -114,13 +116,14 @@ public ApiResponse faxDeleteWithHttpInfo(String faxId) throws ApiException ); } /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return File * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
204 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -132,13 +135,14 @@ public File faxFiles(String faxId) throws ApiException { /** - * List Fax Files. - * Returns list of fax files + * Download Fax Files + * Downloads files associated with a Fax * @param faxId Fax ID (required) * @return ApiResponse<File> * @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 -
+
+ @@ -179,13 +183,14 @@ public ApiResponse faxFilesWithHttpInfo(String faxId) throws ApiException ); } /** - * Get Fax. - * Returns information about fax + * Get Fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return FaxGetResponse * @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 -
+
+ @@ -197,13 +202,14 @@ public FaxGetResponse faxGet(String faxId) throws ApiException { /** - * Get Fax. - * Returns information about fax + * Get Fax + * Returns information about a Fax * @param faxId Fax ID (required) * @return ApiResponse<FaxGetResponse> * @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 -
+
+ @@ -244,14 +250,15 @@ public ApiResponse faxGetWithHttpInfo(String faxId) throws ApiEx ); } /** - * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Lists Faxes + * Returns properties of multiple Faxes + * @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 * @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 -
+
+ @@ -302,14 +309,15 @@ public ApiResponse faxListWithHttpInfo(Integer page) throws Api /** - * Lists Faxes. - * Returns properties of multiple faxes - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) + * Lists Faxes + * Returns properties of multiple Faxes + * @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> * @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 -
+
+ @@ -353,13 +361,14 @@ public ApiResponse faxListWithHttpInfo(Integer page, Integer pa ); } /** - * Send Fax. - * Action to prepare and send a fax + * Send Fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return FaxGetResponse * @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 -
+
+ @@ -371,13 +380,14 @@ public FaxGetResponse faxSend(FaxSendRequest faxSendRequest) throws ApiException /** - * Send Fax. - * Action to prepare and send a fax + * Send Fax + * Creates and sends a new Fax with the submitted file(s) * @param faxSendRequest (required) * @return ApiResponse<FaxGetResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/FaxLineApi.java b/src/main/java/com/dropbox/sign/api/FaxLineApi.java index 3555e15..2d6eb5a 100644 --- a/src/main/java/com/dropbox/sign/api/FaxLineApi.java +++ b/src/main/java/com/dropbox/sign/api/FaxLineApi.java @@ -23,7 +23,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class FaxLineApi { private ApiClient apiClient; @@ -54,13 +54,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Add Fax Line User. + * Add Fax Line User * Grants a user access to the specified Fax Line. * @param faxLineAddUserRequest (required) * @return FaxLineResponse * @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 -
+
+ @@ -72,13 +73,14 @@ public FaxLineResponse faxLineAddUser(FaxLineAddUserRequest faxLineAddUserReques /** - * Add Fax Line User. + * Add Fax Line User * Grants a user access to the specified Fax Line. * @param faxLineAddUserRequest (required) * @return ApiResponse<FaxLineResponse> * @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 -
+
+ @@ -115,16 +117,17 @@ public ApiResponse faxLineAddUserWithHttpInfo(FaxLineAddUserReq ); } /** - * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Get Available Fax Line Area Codes + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return FaxLineAreaCodeGetResponse * @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 -
+
+ @@ -197,16 +200,17 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St /** - * Get Available Fax Line Area Codes. - * Returns a response with the area codes available for a given state/provice and city. - * @param country Filter area codes by country. (required) - * @param state Filter area codes by state. (optional) - * @param province Filter area codes by province. (optional) - * @param city Filter area codes by city. (optional) + * Get Available Fax Line Area Codes + * Returns a list of available area codes for a given state/province and city + * @param country Filter area codes by country (required) + * @param state Filter area codes by state (optional) + * @param province Filter area codes by province (optional) + * @param city Filter area codes by city (optional) * @return ApiResponse<FaxLineAreaCodeGetResponse> * @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 -
+
+ @@ -251,13 +255,14 @@ public ApiResponse faxLineAreaCodeGetWithHttpInfo(St ); } /** - * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchase Fax Line + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return FaxLineResponse * @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 -
+
+ @@ -269,13 +274,14 @@ public FaxLineResponse faxLineCreate(FaxLineCreateRequest faxLineCreateRequest) /** - * Purchase Fax Line. - * Purchases a new Fax Line. + * Purchase Fax Line + * Purchases a new Fax Line * @param faxLineCreateRequest (required) * @return ApiResponse<FaxLineResponse> * @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 -
+
+ @@ -312,12 +318,13 @@ public ApiResponse faxLineCreateWithHttpInfo(FaxLineCreateReque ); } /** - * Delete Fax Line. + * Delete Fax Line * Deletes the specified Fax Line from the subscription. * @param faxLineDeleteRequest (required) * @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 -
+
+ @@ -329,13 +336,14 @@ public void faxLineDelete(FaxLineDeleteRequest faxLineDeleteRequest) throws ApiE /** - * Delete Fax Line. + * Delete Fax Line * Deletes the specified Fax Line from the subscription. * @param faxLineDeleteRequest (required) * @return ApiResponse<Void> * @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 -
+
+ @@ -371,13 +379,14 @@ public ApiResponse faxLineDeleteWithHttpInfo(FaxLineDeleteRequest faxLineD ); } /** - * Get Fax Line. + * Get Fax Line * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return FaxLineResponse * @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 -
+
+ @@ -389,13 +398,14 @@ public FaxLineResponse faxLineGet(String number) throws ApiException { /** - * Get Fax Line. + * Get Fax Line * Returns the properties and settings of a Fax Line. - * @param number The Fax Line number. (required) + * @param number The Fax Line number (required) * @return ApiResponse<FaxLineResponse> * @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 -
+
+ @@ -437,16 +447,17 @@ public ApiResponse faxLineGetWithHttpInfo(String number) throws ); } /** - * List Fax Lines. + * List Fax Lines * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (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) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return FaxLineListResponse * @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 -
+
+ @@ -543,16 +554,17 @@ public ApiResponse faxLineListWithHttpInfo(String accountId /** - * List Fax Lines. + * List Fax Lines * Returns the properties and settings of multiple Fax Lines. * @param accountId Account ID (optional) - * @param page Page (optional, default to 1) - * @param pageSize Page size (optional, default to 20) - * @param showTeamLines Show team lines (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) + * @param showTeamLines Include Fax Lines belonging to team members in the list (optional) * @return ApiResponse<FaxLineListResponse> * @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 -
+
+ @@ -598,13 +610,14 @@ public ApiResponse faxLineListWithHttpInfo(String accountId ); } /** - * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Remove Fax Line Access + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return FaxLineResponse * @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 -
+
+ @@ -616,13 +629,14 @@ public FaxLineResponse faxLineRemoveUser(FaxLineRemoveUserRequest faxLineRemoveU /** - * Remove Fax Line Access. - * Removes a user's access to the specified Fax Line. + * Remove Fax Line Access + * Removes a user's access to the specified Fax Line * @param faxLineRemoveUserRequest (required) * @return ApiResponse<FaxLineResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/OAuthApi.java b/src/main/java/com/dropbox/sign/api/OAuthApi.java index 4d881a9..ddcaa24 100644 --- a/src/main/java/com/dropbox/sign/api/OAuthApi.java +++ b/src/main/java/com/dropbox/sign/api/OAuthApi.java @@ -19,7 +19,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class OAuthApi { private ApiClient apiClient; @@ -50,13 +50,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * OAuth Token Generate. + * 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. * @param oauthTokenGenerateRequest (required) * @return OAuthTokenResponse * @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 -
+
+ @@ -68,13 +69,14 @@ public OAuthTokenResponse oauthTokenGenerate(OAuthTokenGenerateRequest oauthToke /** - * OAuth Token Generate. + * 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. * @param oauthTokenGenerateRequest (required) * @return ApiResponse<OAuthTokenResponse> * @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 -
+
+ @@ -110,13 +112,14 @@ public ApiResponse oauthTokenGenerateWithHttpInfo(OAuthToken ); } /** - * OAuth Token Refresh. + * 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. * @param oauthTokenRefreshRequest (required) * @return OAuthTokenResponse * @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 -
+
+ @@ -128,13 +131,14 @@ public OAuthTokenResponse oauthTokenRefresh(OAuthTokenRefreshRequest oauthTokenR /** - * OAuth Token Refresh. + * 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. * @param oauthTokenRefreshRequest (required) * @return ApiResponse<OAuthTokenResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/ReportApi.java b/src/main/java/com/dropbox/sign/api/ReportApi.java index 4ed2aaf..a9a5905 100644 --- a/src/main/java/com/dropbox/sign/api/ReportApi.java +++ b/src/main/java/com/dropbox/sign/api/ReportApi.java @@ -18,7 +18,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ReportApi { private ApiClient apiClient; @@ -49,13 +49,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Create Report. + * 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. * @param reportCreateRequest (required) * @return ReportCreateResponse * @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 -
+
+ @@ -67,13 +68,14 @@ public ReportCreateResponse reportCreate(ReportCreateRequest reportCreateRequest /** - * Create Report. + * 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. * @param reportCreateRequest (required) * @return ApiResponse<ReportCreateResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java b/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java index 711191b..88f08b4 100644 --- a/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java +++ b/src/main/java/com/dropbox/sign/api/SignatureRequestApi.java @@ -17,6 +17,10 @@ import com.dropbox.sign.model.SignatureRequestBulkSendWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedRequest; import com.dropbox.sign.model.SignatureRequestCreateEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedRequest; +import com.dropbox.sign.model.SignatureRequestEditEmbeddedWithTemplateRequest; +import com.dropbox.sign.model.SignatureRequestEditRequest; +import com.dropbox.sign.model.SignatureRequestEditWithTemplateRequest; import com.dropbox.sign.model.SignatureRequestGetResponse; import com.dropbox.sign.model.SignatureRequestListResponse; import com.dropbox.sign.model.SignatureRequestRemindRequest; @@ -30,7 +34,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class SignatureRequestApi { private ApiClient apiClient; @@ -61,13 +65,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Embedded Bulk Send with Template. + * 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. * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return BulkSendJobSendResponse * @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 -
+
+ @@ -79,13 +84,14 @@ public BulkSendJobSendResponse signatureRequestBulkCreateEmbeddedWithTemplate(Si /** - * Embedded Bulk Send with Template. + * 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. * @param signatureRequestBulkCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @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 -
+
+ @@ -122,13 +128,14 @@ public ApiResponse signatureRequestBulkCreateEmbeddedWi ); } /** - * Bulk Send with Template. + * 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. * @param signatureRequestBulkSendWithTemplateRequest (required) * @return BulkSendJobSendResponse * @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 -
+
+ @@ -140,13 +147,14 @@ public BulkSendJobSendResponse signatureRequestBulkSendWithTemplate(SignatureReq /** - * Bulk Send with Template. + * 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. * @param signatureRequestBulkSendWithTemplateRequest (required) * @return ApiResponse<BulkSendJobSendResponse> * @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 -
+
+ @@ -183,12 +191,13 @@ public ApiResponse signatureRequestBulkSendWithTemplate ); } /** - * Cancel Incomplete Signature Request. + * 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]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @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 -
+
+ @@ -200,13 +209,14 @@ public void signatureRequestCancel(String signatureRequestId) throws ApiExceptio /** - * Cancel Incomplete Signature Request. + * 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]`. * @param signatureRequestId The id of the incomplete SignatureRequest to cancel. (required) * @return ApiResponse<Void> * @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 -
+
+ @@ -246,13 +256,14 @@ public ApiResponse signatureRequestCancelWithHttpInfo(String signatureRequ ); } /** - * Create Embedded Signature Request. + * 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. * @param signatureRequestCreateEmbeddedRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -264,13 +275,14 @@ public SignatureRequestGetResponse signatureRequestCreateEmbedded(SignatureReque /** - * Create Embedded Signature Request. + * 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. * @param signatureRequestCreateEmbeddedRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -307,13 +319,14 @@ public ApiResponse signatureRequestCreateEmbeddedWi ); } /** - * Create Embedded Signature Request with Template. + * 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. * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -325,13 +338,14 @@ public SignatureRequestGetResponse signatureRequestCreateEmbeddedWithTemplate(Si /** - * Create Embedded Signature Request with Template. + * 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. * @param signatureRequestCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -368,14 +382,303 @@ public ApiResponse signatureRequestCreateEmbeddedWi ); } /** - * Download Files. + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return SignatureRequestGetResponse + * @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 -
+ + + + +
Response Details
Status Code Description Response Headers
200 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+ */ + public SignatureRequestGetResponse signatureRequestEdit(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException { + return signatureRequestEditWithHttpInfo(signatureRequestId, signatureRequestEditRequest).getData(); + } + + + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @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 signatureRequestEditWithHttpInfo(String signatureRequestId, SignatureRequestEditRequest signatureRequestEditRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEdit"); + } + if (signatureRequestEditRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditRequest' when calling signatureRequestEdit"); + } + + // Path parameters + String localVarPath = "/signature_request/edit/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditRequest.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( + "SignatureRequestApi.signatureRequestEdit", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return SignatureRequestGetResponse + * @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 SignatureRequestGetResponse signatureRequestEditEmbedded(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException { + return signatureRequestEditEmbeddedWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedRequest).getData(); + } + + + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @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 signatureRequestEditEmbeddedWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbedded"); + } + if (signatureRequestEditEmbeddedRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedRequest' when calling signatureRequestEditEmbedded"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_embedded/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedRequest.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( + "SignatureRequestApi.signatureRequestEditEmbedded", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @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 SignatureRequestGetResponse signatureRequestEditEmbeddedWithTemplate(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException { + return signatureRequestEditEmbeddedWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditEmbeddedWithTemplateRequest).getData(); + } + + + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditEmbeddedWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @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 signatureRequestEditEmbeddedWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditEmbeddedWithTemplate"); + } + if (signatureRequestEditEmbeddedWithTemplateRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditEmbeddedWithTemplateRequest' when calling signatureRequestEditEmbeddedWithTemplate"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_embedded_with_template/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditEmbeddedWithTemplateRequest.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( + "SignatureRequestApi.signatureRequestEditEmbeddedWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditEmbeddedWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return SignatureRequestGetResponse + * @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 SignatureRequestGetResponse signatureRequestEditWithTemplate(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException { + return signatureRequestEditWithTemplateWithHttpInfo(signatureRequestId, signatureRequestEditWithTemplateRequest).getData(); + } + + + /** + * 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. + * @param signatureRequestId The id of the SignatureRequest to edit. (required) + * @param signatureRequestEditWithTemplateRequest (required) + * @return ApiResponse<SignatureRequestGetResponse> + * @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 signatureRequestEditWithTemplateWithHttpInfo(String signatureRequestId, SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest) throws ApiException { + + // Check required parameters + if (signatureRequestId == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestId' when calling signatureRequestEditWithTemplate"); + } + if (signatureRequestEditWithTemplateRequest == null) { + throw new ApiException(400, "Missing the required parameter 'signatureRequestEditWithTemplateRequest' when calling signatureRequestEditWithTemplate"); + } + + // Path parameters + String localVarPath = "/signature_request/edit_with_template/{signature_request_id}" + .replaceAll("\\{signature_request_id}", apiClient.escapeString(signatureRequestId.toString())); + + String localVarAccept = apiClient.selectHeaderAccept("application/json"); + Map localVarFormParams = new LinkedHashMap<>(); + localVarFormParams = signatureRequestEditWithTemplateRequest.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( + "SignatureRequestApi.signatureRequestEditWithTemplate", + localVarPath, + "PUT", + new ArrayList<>(), + isFileTypeFound ? null : signatureRequestEditWithTemplateRequest, + new LinkedHashMap<>(), + new LinkedHashMap<>(), + localVarFormParams, + localVarAccept, + localVarContentType, + localVarAuthNames, + localVarReturnType, + false + ); + } + /** + * 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. * @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 * @throws ApiException if fails to make API call * @http.response.details - +
+ @@ -406,14 +709,15 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque /** - * Download Files. + * 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. * @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> * @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 -
+
+ @@ -462,13 +766,14 @@ public ApiResponse signatureRequestFilesWithHttpInfo(String signatureReque ); } /** - * Download Files as Data Uri. + * 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. * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return FileResponseDataUri * @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 -
+
+ @@ -480,13 +785,14 @@ public FileResponseDataUri signatureRequestFilesAsDataUri(String signatureReques /** - * Download Files as Data Uri. + * 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. * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @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 -
+
+ @@ -527,14 +833,15 @@ public ApiResponse signatureRequestFilesAsDataUriWithHttpIn ); } /** - * Download Files as File Url. + * 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. * @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 * @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 -
+
+ @@ -565,14 +872,15 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri /** - * Download Files as File Url. + * 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. * @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> * @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 -
+
+ @@ -621,13 +929,14 @@ public ApiResponse signatureRequestFilesAsFileUrlWithHttpInfo(Stri ); } /** - * Get Signature Request. + * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -639,13 +948,14 @@ public SignatureRequestGetResponse signatureRequestGet(String signatureRequestId /** - * Get Signature Request. + * Get Signature Request * Returns the status of the SignatureRequest specified by the `signature_request_id` parameter. * @param signatureRequestId The id of the SignatureRequest to retrieve. (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -686,7 +996,7 @@ public ApiResponse signatureRequestGetWithHttpInfo( ); } /** - * List Signature Requests. + * 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. * @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) @@ -695,7 +1005,8 @@ public ApiResponse signatureRequestGetWithHttpInfo( * @return SignatureRequestListResponse * @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 -
+
+ @@ -792,7 +1103,7 @@ public ApiResponse signatureRequestListWithHttpInf /** - * List Signature Requests. + * 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. * @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) @@ -801,7 +1112,8 @@ public ApiResponse signatureRequestListWithHttpInf * @return ApiResponse<SignatureRequestListResponse> * @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 -
+
+ @@ -847,13 +1159,14 @@ public ApiResponse signatureRequestListWithHttpInf ); } /** - * Release On-Hold Signature Request. + * 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. * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -865,13 +1178,14 @@ public SignatureRequestGetResponse signatureRequestReleaseHold(String signatureR /** - * Release On-Hold Signature Request. + * 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. * @param signatureRequestId The id of the SignatureRequest to release. (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -912,14 +1226,15 @@ public ApiResponse signatureRequestReleaseHoldWithH ); } /** - * Send Request Reminder. + * 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. * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -931,14 +1246,15 @@ public SignatureRequestGetResponse signatureRequestRemind(String signatureReques /** - * Send Request Reminder. + * 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. * @param signatureRequestId The id of the SignatureRequest to send a reminder for. (required) * @param signatureRequestRemindRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -982,12 +1298,13 @@ public ApiResponse signatureRequestRemindWithHttpIn ); } /** - * Remove Signature Request Access. + * 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. * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @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 -
+
+ @@ -999,13 +1316,14 @@ public void signatureRequestRemove(String signatureRequestId) throws ApiExceptio /** - * Remove Signature Request Access. + * 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. * @param signatureRequestId The id of the SignatureRequest to remove. (required) * @return ApiResponse<Void> * @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 -
+
+ @@ -1045,13 +1363,14 @@ public ApiResponse signatureRequestRemoveWithHttpInfo(String signatureRequ ); } /** - * Send Signature Request. + * 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. * @param signatureRequestSendRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -1063,13 +1382,14 @@ public SignatureRequestGetResponse signatureRequestSend(SignatureRequestSendRequ /** - * Send Signature Request. + * 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. * @param signatureRequestSendRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -1106,13 +1426,14 @@ public ApiResponse signatureRequestSendWithHttpInfo ); } /** - * Send with Template. + * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. * @param signatureRequestSendWithTemplateRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -1124,13 +1445,14 @@ public SignatureRequestGetResponse signatureRequestSendWithTemplate(SignatureReq /** - * Send with Template. + * Send with Template * Creates and sends a new SignatureRequest based off of the Template(s) specified with the `template_ids` parameter. * @param signatureRequestSendWithTemplateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ @@ -1167,14 +1489,15 @@ public ApiResponse signatureRequestSendWithTemplate ); } /** - * Update Signature Request. + * 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. * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return SignatureRequestGetResponse * @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 -
+
+ @@ -1186,14 +1509,15 @@ public SignatureRequestGetResponse signatureRequestUpdate(String signatureReques /** - * Update Signature Request. + * 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. * @param signatureRequestId The id of the SignatureRequest to update. (required) * @param signatureRequestUpdateRequest (required) * @return ApiResponse<SignatureRequestGetResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/TeamApi.java b/src/main/java/com/dropbox/sign/api/TeamApi.java index 17ca21e..ac28133 100644 --- a/src/main/java/com/dropbox/sign/api/TeamApi.java +++ b/src/main/java/com/dropbox/sign/api/TeamApi.java @@ -25,7 +25,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class TeamApi { private ApiClient apiClient; @@ -56,14 +56,15 @@ public void setApiClient(ApiClient apiClient) { } /** - * Add User to Team. + * 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. * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return TeamGetResponse * @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 -
+
+ @@ -94,14 +95,15 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque /** - * Add User to Team. + * 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. * @param teamAddMemberRequest (required) * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetResponse> * @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 -
+
+ @@ -143,13 +145,14 @@ public ApiResponse teamAddMemberWithHttpInfo(TeamAddMemberReque ); } /** - * Create Team. + * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. * @param teamCreateRequest (required) * @return TeamGetResponse * @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 -
+
+ @@ -161,13 +164,14 @@ public TeamGetResponse teamCreate(TeamCreateRequest teamCreateRequest) throws Ap /** - * Create Team. + * Create Team * Creates a new Team and makes you a member. You must not currently belong to a Team to invoke. * @param teamCreateRequest (required) * @return ApiResponse<TeamGetResponse> * @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 -
+
+ @@ -204,11 +208,12 @@ public ApiResponse teamCreateWithHttpInfo(TeamCreateRequest tea ); } /** - * Delete Team. + * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). * @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 -
+
+ @@ -220,12 +225,13 @@ public void teamDelete() throws ApiException { /** - * Delete Team. + * Delete Team * Deletes your Team. Can only be invoked when you have a Team with only one member (yourself). * @return ApiResponse<Void> * @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 -
+
+ @@ -256,12 +262,13 @@ public ApiResponse teamDeleteWithHttpInfo() throws ApiException { ); } /** - * Get Team. + * 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. * @return TeamGetResponse * @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 -
+
+ @@ -273,12 +280,13 @@ public TeamGetResponse teamGet() throws ApiException { /** - * Get Team. + * 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. * @return ApiResponse<TeamGetResponse> * @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 -
+
+ @@ -310,13 +318,14 @@ public ApiResponse teamGetWithHttpInfo() throws ApiException { ); } /** - * Get Team Info. + * Get Team Info * Provides information about a team. * @param teamId The id of the team. (optional) * @return TeamGetInfoResponse * @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 -
+
+ @@ -347,13 +356,14 @@ public ApiResponse teamInfoWithHttpInfo() throws ApiExcepti /** - * Get Team Info. + * Get Team Info * Provides information about a team. * @param teamId The id of the team. (optional) * @return ApiResponse<TeamGetInfoResponse> * @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 -
+
+ @@ -390,13 +400,14 @@ public ApiResponse teamInfoWithHttpInfo(String teamId) thro ); } /** - * List Team Invites. + * List Team Invites * Provides a list of team invites (and their roles). * @param emailAddress The email address for which to display the team invites. (optional) * @return TeamInvitesResponse * @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 -
+
+ @@ -427,13 +438,14 @@ public ApiResponse teamInvitesWithHttpInfo() throws ApiExce /** - * List Team Invites. + * List Team Invites * Provides a list of team invites (and their roles). * @param emailAddress The email address for which to display the team invites. (optional) * @return ApiResponse<TeamInvitesResponse> * @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 -
+
+ @@ -470,7 +482,7 @@ public ApiResponse teamInvitesWithHttpInfo(String emailAddr ); } /** - * List Team Members. + * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. * @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) @@ -478,7 +490,8 @@ public ApiResponse teamInvitesWithHttpInfo(String emailAddr * @return TeamMembersResponse * @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 -
+
+ @@ -529,7 +542,7 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I /** - * List Team Members. + * List Team Members * Provides a paginated list of members (and their roles) that belong to a given team. * @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) @@ -537,7 +550,8 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I * @return ApiResponse<TeamMembersResponse> * @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 -
+
+ @@ -590,13 +604,14 @@ public ApiResponse teamMembersWithHttpInfo(String teamId, I ); } /** - * Remove User from Team. + * 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. * @param teamRemoveMemberRequest (required) * @return TeamGetResponse * @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 -
+
+ @@ -608,13 +623,14 @@ public TeamGetResponse teamRemoveMember(TeamRemoveMemberRequest teamRemoveMember /** - * Remove User from Team. + * 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. * @param teamRemoveMemberRequest (required) * @return ApiResponse<TeamGetResponse> * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
201 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -651,7 +667,7 @@ public ApiResponse teamRemoveMemberWithHttpInfo(TeamRemoveMembe ); } /** - * List Sub Teams. + * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. * @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) @@ -659,7 +675,8 @@ public ApiResponse teamRemoveMemberWithHttpInfo(TeamRemoveMembe * @return TeamSubTeamsResponse * @throws ApiException if fails to make API call * @http.response.details -
Response Details
Status Code Description Response Headers
201 successful operation * X-RateLimit-Limit -
* X-RateLimit-Remaining -
* X-Ratelimit-Reset -
4XX failed_operation -
+
+ @@ -710,7 +727,7 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, /** - * List Sub Teams. + * List Sub Teams * Provides a paginated list of sub teams that belong to a given team. * @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) @@ -718,7 +735,8 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, * @return ApiResponse<TeamSubTeamsResponse> * @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 -
+
+ @@ -771,13 +789,14 @@ public ApiResponse teamSubTeamsWithHttpInfo(String teamId, ); } /** - * Update Team. + * Update Team * Updates the name of your Team. * @param teamUpdateRequest (required) * @return TeamGetResponse * @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 -
+
+ @@ -789,13 +808,14 @@ public TeamGetResponse teamUpdate(TeamUpdateRequest teamUpdateRequest) throws Ap /** - * Update Team. + * Update Team * Updates the name of your Team. * @param teamUpdateRequest (required) * @return ApiResponse<TeamGetResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/TemplateApi.java b/src/main/java/com/dropbox/sign/api/TemplateApi.java index c64166a..974e61c 100644 --- a/src/main/java/com/dropbox/sign/api/TemplateApi.java +++ b/src/main/java/com/dropbox/sign/api/TemplateApi.java @@ -29,7 +29,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class TemplateApi { private ApiClient apiClient; @@ -60,14 +60,15 @@ public void setApiClient(ApiClient apiClient) { } /** - * Add User to Template. + * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return TemplateGetResponse * @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 -
+
+ @@ -79,14 +80,15 @@ public TemplateGetResponse templateAddUser(String templateId, TemplateAddUserReq /** - * Add User to Template. + * Add User to Template * Gives the specified Account access to the specified Template. The specified Account must be a part of your Team. * @param templateId The id of the Template to give the Account access to. (required) * @param templateAddUserRequest (required) * @return ApiResponse<TemplateGetResponse> * @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 -
+
+ @@ -130,13 +132,14 @@ public ApiResponse templateAddUserWithHttpInfo(String templ ); } /** - * Create Template. + * Create Template * Creates a template that can then be used. * @param templateCreateRequest (required) * @return TemplateCreateResponse * @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 -
+
+ @@ -148,13 +151,14 @@ public TemplateCreateResponse templateCreate(TemplateCreateRequest templateCreat /** - * Create Template. + * Create Template * Creates a template that can then be used. * @param templateCreateRequest (required) * @return ApiResponse<TemplateCreateResponse> * @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 -
+
+ @@ -191,13 +195,14 @@ public ApiResponse templateCreateWithHttpInfo(TemplateCr ); } /** - * Create Embedded Template Draft. + * 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. * @param templateCreateEmbeddedDraftRequest (required) * @return TemplateCreateEmbeddedDraftResponse * @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 -
+
+ @@ -209,13 +214,14 @@ public TemplateCreateEmbeddedDraftResponse templateCreateEmbeddedDraft(TemplateC /** - * Create Embedded Template Draft. + * 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. * @param templateCreateEmbeddedDraftRequest (required) * @return ApiResponse<TemplateCreateEmbeddedDraftResponse> * @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 -
+
+ @@ -252,12 +258,13 @@ public ApiResponse templateCreateEmbeddedDr ); } /** - * Delete Template. + * Delete Template * Completely deletes the template specified from the account. * @param templateId The id of the Template to delete. (required) * @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 -
+
+ @@ -269,13 +276,14 @@ public void templateDelete(String templateId) throws ApiException { /** - * Delete Template. + * Delete Template * Completely deletes the template specified from the account. * @param templateId The id of the Template to delete. (required) * @return ApiResponse<Void> * @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 -
+
+ @@ -315,14 +323,15 @@ public ApiResponse templateDeleteWithHttpInfo(String templateId) throws Ap ); } /** - * Get Template Files. + * 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. * @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 * @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 -
+
+ @@ -353,14 +362,15 @@ public ApiResponse templateFilesWithHttpInfo(String templateId) throws Api /** - * Get Template Files. + * 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. * @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> * @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 -
+
+ @@ -406,13 +416,14 @@ public ApiResponse templateFilesWithHttpInfo(String templateId, String fil ); } /** - * Get Template Files as Data Uri. + * 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. * @param templateId The id of the template files to retrieve. (required) * @return FileResponseDataUri * @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 -
+
+ @@ -424,13 +435,14 @@ public FileResponseDataUri templateFilesAsDataUri(String templateId) throws ApiE /** - * Get Template Files as Data Uri. + * 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. * @param templateId The id of the template files to retrieve. (required) * @return ApiResponse<FileResponseDataUri> * @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 -
+
+ @@ -471,14 +483,15 @@ public ApiResponse templateFilesAsDataUriWithHttpInfo(Strin ); } /** - * Get Template Files as File Url. + * 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. * @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 * @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 -
+
+ @@ -509,14 +522,15 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ /** - * Get Template Files as File Url. + * 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. * @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> * @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 -
+
+ @@ -565,13 +579,14 @@ public ApiResponse templateFilesAsFileUrlWithHttpInfo(String templ ); } /** - * Get Template. + * Get Template * Returns the Template specified by the `template_id` parameter. * @param templateId The id of the Template to retrieve. (required) * @return TemplateGetResponse * @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 -
+
+ @@ -583,13 +598,14 @@ public TemplateGetResponse templateGet(String templateId) throws ApiException { /** - * Get Template. + * Get Template * Returns the Template specified by the `template_id` parameter. * @param templateId The id of the Template to retrieve. (required) * @return ApiResponse<TemplateGetResponse> * @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 -
+
+ @@ -630,7 +646,7 @@ public ApiResponse templateGetWithHttpInfo(String templateI ); } /** - * List Templates. + * 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. * @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) @@ -639,7 +655,8 @@ public ApiResponse templateGetWithHttpInfo(String templateI * @return TemplateListResponse * @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 -
+
+ @@ -736,7 +753,7 @@ public ApiResponse templateListWithHttpInfo(String account /** - * List Templates. + * 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. * @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) @@ -745,7 +762,8 @@ public ApiResponse templateListWithHttpInfo(String account * @return ApiResponse<TemplateListResponse> * @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 -
+
+ @@ -791,14 +809,15 @@ public ApiResponse templateListWithHttpInfo(String account ); } /** - * Remove User from Template. + * Remove User from Template * Removes the specified Account's access to the specified Template. * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return TemplateGetResponse * @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 -
+
+ @@ -810,14 +829,15 @@ public TemplateGetResponse templateRemoveUser(String templateId, TemplateRemoveU /** - * Remove User from Template. + * Remove User from Template * Removes the specified Account's access to the specified Template. * @param templateId The id of the Template to remove the Account's access to. (required) * @param templateRemoveUserRequest (required) * @return ApiResponse<TemplateGetResponse> * @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 -
+
+ @@ -861,14 +881,15 @@ public ApiResponse templateRemoveUserWithHttpInfo(String te ); } /** - * Update Template Files. + * 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). * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return TemplateUpdateFilesResponse * @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 -
+
+ @@ -880,14 +901,15 @@ public TemplateUpdateFilesResponse templateUpdateFiles(String templateId, Templa /** - * Update Template Files. + * 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). * @param templateId The ID of the template whose files to update. (required) * @param templateUpdateFilesRequest (required) * @return ApiResponse<TemplateUpdateFilesResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java b/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java index fc3710e..8416bd8 100644 --- a/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java +++ b/src/main/java/com/dropbox/sign/api/UnclaimedDraftApi.java @@ -21,7 +21,7 @@ import java.util.List; import java.util.Map; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class UnclaimedDraftApi { private ApiClient apiClient; @@ -52,13 +52,14 @@ public void setApiClient(ApiClient apiClient) { } /** - * Create Unclaimed Draft. + * 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. * @param unclaimedDraftCreateRequest (required) * @return UnclaimedDraftCreateResponse * @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 -
+
+ @@ -70,13 +71,14 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreate(UnclaimedDraftCreateReq /** - * Create Unclaimed Draft. + * 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. * @param unclaimedDraftCreateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @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 -
+
+ @@ -113,13 +115,14 @@ public ApiResponse unclaimedDraftCreateWithHttpInf ); } /** - * Create Embedded Unclaimed Draft. + * 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. * @param unclaimedDraftCreateEmbeddedRequest (required) * @return UnclaimedDraftCreateResponse * @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 -
+
+ @@ -131,13 +134,14 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbedded(UnclaimedDraftC /** - * Create Embedded Unclaimed Draft. + * 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. * @param unclaimedDraftCreateEmbeddedRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @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 -
+
+ @@ -174,13 +178,14 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit ); } /** - * Create Embedded Unclaimed Draft with Template. + * 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. * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return UnclaimedDraftCreateResponse * @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 -
+
+ @@ -192,13 +197,14 @@ public UnclaimedDraftCreateResponse unclaimedDraftCreateEmbeddedWithTemplate(Unc /** - * Create Embedded Unclaimed Draft with Template. + * 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. * @param unclaimedDraftCreateEmbeddedWithTemplateRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @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 -
+
+ @@ -235,14 +241,15 @@ public ApiResponse unclaimedDraftCreateEmbeddedWit ); } /** - * Edit and Resend Unclaimed Draft. + * 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. * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return UnclaimedDraftCreateResponse * @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 -
+
+ @@ -254,14 +261,15 @@ public UnclaimedDraftCreateResponse unclaimedDraftEditAndResend(String signature /** - * Edit and Resend Unclaimed Draft. + * 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. * @param signatureRequestId The ID of the signature request to edit and resend. (required) * @param unclaimedDraftEditAndResendRequest (required) * @return ApiResponse<UnclaimedDraftCreateResponse> * @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 -
+
+ diff --git a/src/main/java/com/dropbox/sign/auth/ApiKeyAuth.java b/src/main/java/com/dropbox/sign/auth/ApiKeyAuth.java index e68272c..9b30729 100644 --- a/src/main/java/com/dropbox/sign/auth/ApiKeyAuth.java +++ b/src/main/java/com/dropbox/sign/auth/ApiKeyAuth.java @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class ApiKeyAuth implements Authentication { private final String location; private final String paramName; diff --git a/src/main/java/com/dropbox/sign/auth/HttpBasicAuth.java b/src/main/java/com/dropbox/sign/auth/HttpBasicAuth.java index 3afe97b..be2530e 100644 --- a/src/main/java/com/dropbox/sign/auth/HttpBasicAuth.java +++ b/src/main/java/com/dropbox/sign/auth/HttpBasicAuth.java @@ -23,7 +23,7 @@ import java.util.Map; import java.util.List; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class HttpBasicAuth implements Authentication { private String username; private String password; diff --git a/src/main/java/com/dropbox/sign/auth/HttpBearerAuth.java b/src/main/java/com/dropbox/sign/auth/HttpBearerAuth.java index 8f3273d..9dee1a6 100644 --- a/src/main/java/com/dropbox/sign/auth/HttpBearerAuth.java +++ b/src/main/java/com/dropbox/sign/auth/HttpBearerAuth.java @@ -20,7 +20,7 @@ import java.util.Map; import java.util.List; -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public class HttpBearerAuth implements Authentication { private final String scheme; private String bearerToken; diff --git a/src/main/java/com/dropbox/sign/model/AbstractOpenApiSchema.java b/src/main/java/com/dropbox/sign/model/AbstractOpenApiSchema.java index 759bf81..987a841 100644 --- a/src/main/java/com/dropbox/sign/model/AbstractOpenApiSchema.java +++ b/src/main/java/com/dropbox/sign/model/AbstractOpenApiSchema.java @@ -24,7 +24,7 @@ /** * Abstract class for oneOf,anyOf schemas defined in OpenAPI spec */ -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") public abstract class AbstractOpenApiSchema { // store the actual instance of the schema/object diff --git a/src/main/java/com/dropbox/sign/model/AccountCreateRequest.java b/src/main/java/com/dropbox/sign/model/AccountCreateRequest.java index 9f12a6e..cefd5b7 100644 --- a/src/main/java/com/dropbox/sign/model/AccountCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/AccountCreateRequest.java @@ -38,19 +38,23 @@ AccountCreateRequest.JSON_PROPERTY_CLIENT_SECRET, AccountCreateRequest.JSON_PROPERTY_LOCALE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountCreateRequest { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + @jakarta.annotation.Nullable private String clientSecret; public static final String JSON_PROPERTY_LOCALE = "locale"; + @jakarta.annotation.Nullable private String locale; public AccountCreateRequest() { @@ -71,7 +75,7 @@ static public AccountCreateRequest init(HashMap data) throws Exception { ); } - public AccountCreateRequest emailAddress(String emailAddress) { + public AccountCreateRequest emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -91,12 +95,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } - public AccountCreateRequest clientId(String clientId) { + public AccountCreateRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -116,12 +120,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public AccountCreateRequest clientSecret(String clientSecret) { + public AccountCreateRequest clientSecret(@jakarta.annotation.Nullable String clientSecret) { this.clientSecret = clientSecret; return this; } @@ -141,12 +145,12 @@ public String getClientSecret() { @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { + public void setClientSecret(@jakarta.annotation.Nullable String clientSecret) { this.clientSecret = clientSecret; } - public AccountCreateRequest locale(String locale) { + public AccountCreateRequest locale(@jakarta.annotation.Nullable String locale) { this.locale = locale; return this; } @@ -166,7 +170,7 @@ public String getLocale() { @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLocale(String locale) { + public void setLocale(@jakarta.annotation.Nullable String locale) { this.locale = locale; } diff --git a/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java b/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java index 08fd773..00240b9 100644 --- a/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java +++ b/src/main/java/com/dropbox/sign/model/AccountCreateResponse.java @@ -42,16 +42,19 @@ AccountCreateResponse.JSON_PROPERTY_OAUTH_DATA, AccountCreateResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountCreateResponse { public static final String JSON_PROPERTY_ACCOUNT = "account"; + @jakarta.annotation.Nonnull private AccountResponse account; public static final String JSON_PROPERTY_OAUTH_DATA = "oauth_data"; + @jakarta.annotation.Nullable private OAuthTokenResponse oauthData; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public AccountCreateResponse() { @@ -72,7 +75,7 @@ static public AccountCreateResponse init(HashMap data) throws Exception { ); } - public AccountCreateResponse account(AccountResponse account) { + public AccountCreateResponse account(@jakarta.annotation.Nonnull AccountResponse account) { this.account = account; return this; } @@ -92,12 +95,12 @@ public AccountResponse getAccount() { @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAccount(AccountResponse account) { + public void setAccount(@jakarta.annotation.Nonnull AccountResponse account) { this.account = account; } - public AccountCreateResponse oauthData(OAuthTokenResponse oauthData) { + public AccountCreateResponse oauthData(@jakarta.annotation.Nullable OAuthTokenResponse oauthData) { this.oauthData = oauthData; return this; } @@ -117,12 +120,12 @@ public OAuthTokenResponse getOauthData() { @JsonProperty(JSON_PROPERTY_OAUTH_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauthData(OAuthTokenResponse oauthData) { + public void setOauthData(@jakarta.annotation.Nullable OAuthTokenResponse oauthData) { this.oauthData = oauthData; } - public AccountCreateResponse warnings(List warnings) { + public AccountCreateResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -150,7 +153,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/AccountGetResponse.java b/src/main/java/com/dropbox/sign/model/AccountGetResponse.java index 2a2fabc..a37a29e 100644 --- a/src/main/java/com/dropbox/sign/model/AccountGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/AccountGetResponse.java @@ -40,13 +40,15 @@ AccountGetResponse.JSON_PROPERTY_ACCOUNT, AccountGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountGetResponse { public static final String JSON_PROPERTY_ACCOUNT = "account"; + @jakarta.annotation.Nonnull private AccountResponse account; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public AccountGetResponse() { @@ -67,7 +69,7 @@ static public AccountGetResponse init(HashMap data) throws Exception { ); } - public AccountGetResponse account(AccountResponse account) { + public AccountGetResponse account(@jakarta.annotation.Nonnull AccountResponse account) { this.account = account; return this; } @@ -87,12 +89,12 @@ public AccountResponse getAccount() { @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAccount(AccountResponse account) { + public void setAccount(@jakarta.annotation.Nonnull AccountResponse account) { this.account = account; } - public AccountGetResponse warnings(List warnings) { + public AccountGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/AccountResponse.java b/src/main/java/com/dropbox/sign/model/AccountResponse.java index 6f431ab..e714078 100644 --- a/src/main/java/com/dropbox/sign/model/AccountResponse.java +++ b/src/main/java/com/dropbox/sign/model/AccountResponse.java @@ -47,40 +47,51 @@ AccountResponse.JSON_PROPERTY_LOCALE, AccountResponse.JSON_PROPERTY_USAGE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; + @jakarta.annotation.Nullable private Boolean isLocked; public static final String JSON_PROPERTY_IS_PAID_HS = "is_paid_hs"; + @jakarta.annotation.Nullable private Boolean isPaidHs; public static final String JSON_PROPERTY_IS_PAID_HF = "is_paid_hf"; + @jakarta.annotation.Nullable private Boolean isPaidHf; public static final String JSON_PROPERTY_QUOTAS = "quotas"; + @jakarta.annotation.Nullable private AccountResponseQuotas quotas; public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_ROLE_CODE = "role_code"; + @jakarta.annotation.Nullable private String roleCode; public static final String JSON_PROPERTY_TEAM_ID = "team_id"; + @jakarta.annotation.Nullable private String teamId; public static final String JSON_PROPERTY_LOCALE = "locale"; + @jakarta.annotation.Nullable private String locale; public static final String JSON_PROPERTY_USAGE = "usage"; + @jakarta.annotation.Nullable private AccountResponseUsage usage; public AccountResponse() { @@ -101,7 +112,7 @@ static public AccountResponse init(HashMap data) throws Exception { ); } - public AccountResponse accountId(String accountId) { + public AccountResponse accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -121,12 +132,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public AccountResponse emailAddress(String emailAddress) { + public AccountResponse emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -146,12 +157,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public AccountResponse isLocked(Boolean isLocked) { + public AccountResponse isLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; return this; } @@ -171,12 +182,12 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsLocked(Boolean isLocked) { + public void setIsLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; } - public AccountResponse isPaidHs(Boolean isPaidHs) { + public AccountResponse isPaidHs(@jakarta.annotation.Nullable Boolean isPaidHs) { this.isPaidHs = isPaidHs; return this; } @@ -196,12 +207,12 @@ public Boolean getIsPaidHs() { @JsonProperty(JSON_PROPERTY_IS_PAID_HS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsPaidHs(Boolean isPaidHs) { + public void setIsPaidHs(@jakarta.annotation.Nullable Boolean isPaidHs) { this.isPaidHs = isPaidHs; } - public AccountResponse isPaidHf(Boolean isPaidHf) { + public AccountResponse isPaidHf(@jakarta.annotation.Nullable Boolean isPaidHf) { this.isPaidHf = isPaidHf; return this; } @@ -221,12 +232,12 @@ public Boolean getIsPaidHf() { @JsonProperty(JSON_PROPERTY_IS_PAID_HF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsPaidHf(Boolean isPaidHf) { + public void setIsPaidHf(@jakarta.annotation.Nullable Boolean isPaidHf) { this.isPaidHf = isPaidHf; } - public AccountResponse quotas(AccountResponseQuotas quotas) { + public AccountResponse quotas(@jakarta.annotation.Nullable AccountResponseQuotas quotas) { this.quotas = quotas; return this; } @@ -246,12 +257,12 @@ public AccountResponseQuotas getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQuotas(AccountResponseQuotas quotas) { + public void setQuotas(@jakarta.annotation.Nullable AccountResponseQuotas quotas) { this.quotas = quotas; } - public AccountResponse callbackUrl(String callbackUrl) { + public AccountResponse callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -271,12 +282,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public AccountResponse roleCode(String roleCode) { + public AccountResponse roleCode(@jakarta.annotation.Nullable String roleCode) { this.roleCode = roleCode; return this; } @@ -296,12 +307,12 @@ public String getRoleCode() { @JsonProperty(JSON_PROPERTY_ROLE_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRoleCode(String roleCode) { + public void setRoleCode(@jakarta.annotation.Nullable String roleCode) { this.roleCode = roleCode; } - public AccountResponse teamId(String teamId) { + public AccountResponse teamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; return this; } @@ -321,12 +332,12 @@ public String getTeamId() { @JsonProperty(JSON_PROPERTY_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamId(String teamId) { + public void setTeamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; } - public AccountResponse locale(String locale) { + public AccountResponse locale(@jakarta.annotation.Nullable String locale) { this.locale = locale; return this; } @@ -346,12 +357,12 @@ public String getLocale() { @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLocale(String locale) { + public void setLocale(@jakarta.annotation.Nullable String locale) { this.locale = locale; } - public AccountResponse usage(AccountResponseUsage usage) { + public AccountResponse usage(@jakarta.annotation.Nullable AccountResponseUsage usage) { this.usage = usage; return this; } @@ -371,7 +382,7 @@ public AccountResponseUsage getUsage() { @JsonProperty(JSON_PROPERTY_USAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsage(AccountResponseUsage usage) { + public void setUsage(@jakarta.annotation.Nullable AccountResponseUsage usage) { this.usage = usage; } diff --git a/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java b/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java index f8a7b6c..e1bf4a8 100644 --- a/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java +++ b/src/main/java/com/dropbox/sign/model/AccountResponseQuotas.java @@ -40,25 +40,31 @@ AccountResponseQuotas.JSON_PROPERTY_SMS_VERIFICATIONS_LEFT, AccountResponseQuotas.JSON_PROPERTY_NUM_FAX_PAGES_LEFT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseQuotas { public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; + @jakarta.annotation.Nullable private Integer apiSignatureRequestsLeft; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; + @jakarta.annotation.Nullable private Integer documentsLeft; public static final String JSON_PROPERTY_TEMPLATES_TOTAL = "templates_total"; + @jakarta.annotation.Nullable private Integer templatesTotal; public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; + @jakarta.annotation.Nullable private Integer templatesLeft; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; + @jakarta.annotation.Nullable private Integer smsVerificationsLeft; public static final String JSON_PROPERTY_NUM_FAX_PAGES_LEFT = "num_fax_pages_left"; + @jakarta.annotation.Nullable private Integer numFaxPagesLeft; public AccountResponseQuotas() { @@ -79,7 +85,7 @@ static public AccountResponseQuotas init(HashMap data) throws Exception { ); } - public AccountResponseQuotas apiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { + public AccountResponseQuotas apiSignatureRequestsLeft(@jakarta.annotation.Nullable Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; return this; } @@ -99,12 +105,12 @@ public Integer getApiSignatureRequestsLeft() { @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { + public void setApiSignatureRequestsLeft(@jakarta.annotation.Nullable Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } - public AccountResponseQuotas documentsLeft(Integer documentsLeft) { + public AccountResponseQuotas documentsLeft(@jakarta.annotation.Nullable Integer documentsLeft) { this.documentsLeft = documentsLeft; return this; } @@ -124,12 +130,12 @@ public Integer getDocumentsLeft() { @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDocumentsLeft(Integer documentsLeft) { + public void setDocumentsLeft(@jakarta.annotation.Nullable Integer documentsLeft) { this.documentsLeft = documentsLeft; } - public AccountResponseQuotas templatesTotal(Integer templatesTotal) { + public AccountResponseQuotas templatesTotal(@jakarta.annotation.Nullable Integer templatesTotal) { this.templatesTotal = templatesTotal; return this; } @@ -149,12 +155,12 @@ public Integer getTemplatesTotal() { @JsonProperty(JSON_PROPERTY_TEMPLATES_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplatesTotal(Integer templatesTotal) { + public void setTemplatesTotal(@jakarta.annotation.Nullable Integer templatesTotal) { this.templatesTotal = templatesTotal; } - public AccountResponseQuotas templatesLeft(Integer templatesLeft) { + public AccountResponseQuotas templatesLeft(@jakarta.annotation.Nullable Integer templatesLeft) { this.templatesLeft = templatesLeft; return this; } @@ -174,12 +180,12 @@ public Integer getTemplatesLeft() { @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplatesLeft(Integer templatesLeft) { + public void setTemplatesLeft(@jakarta.annotation.Nullable Integer templatesLeft) { this.templatesLeft = templatesLeft; } - public AccountResponseQuotas smsVerificationsLeft(Integer smsVerificationsLeft) { + public AccountResponseQuotas smsVerificationsLeft(@jakarta.annotation.Nullable Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; return this; } @@ -199,12 +205,12 @@ public Integer getSmsVerificationsLeft() { @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { + public void setSmsVerificationsLeft(@jakarta.annotation.Nullable Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } - public AccountResponseQuotas numFaxPagesLeft(Integer numFaxPagesLeft) { + public AccountResponseQuotas numFaxPagesLeft(@jakarta.annotation.Nullable Integer numFaxPagesLeft) { this.numFaxPagesLeft = numFaxPagesLeft; return this; } @@ -224,7 +230,7 @@ public Integer getNumFaxPagesLeft() { @JsonProperty(JSON_PROPERTY_NUM_FAX_PAGES_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumFaxPagesLeft(Integer numFaxPagesLeft) { + public void setNumFaxPagesLeft(@jakarta.annotation.Nullable Integer numFaxPagesLeft) { this.numFaxPagesLeft = numFaxPagesLeft; } diff --git a/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java b/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java index 741d5e5..32ba98c 100644 --- a/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java +++ b/src/main/java/com/dropbox/sign/model/AccountResponseUsage.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ AccountResponseUsage.JSON_PROPERTY_FAX_PAGES_SENT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountResponseUsage { public static final String JSON_PROPERTY_FAX_PAGES_SENT = "fax_pages_sent"; + @jakarta.annotation.Nullable private Integer faxPagesSent; public AccountResponseUsage() { @@ -59,7 +60,7 @@ static public AccountResponseUsage init(HashMap data) throws Exception { ); } - public AccountResponseUsage faxPagesSent(Integer faxPagesSent) { + public AccountResponseUsage faxPagesSent(@jakarta.annotation.Nullable Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; return this; } @@ -79,7 +80,7 @@ public Integer getFaxPagesSent() { @JsonProperty(JSON_PROPERTY_FAX_PAGES_SENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFaxPagesSent(Integer faxPagesSent) { + public void setFaxPagesSent(@jakarta.annotation.Nullable Integer faxPagesSent) { this.faxPagesSent = faxPagesSent; } diff --git a/src/main/java/com/dropbox/sign/model/AccountUpdateRequest.java b/src/main/java/com/dropbox/sign/model/AccountUpdateRequest.java index f1bede2..cb2d14d 100644 --- a/src/main/java/com/dropbox/sign/model/AccountUpdateRequest.java +++ b/src/main/java/com/dropbox/sign/model/AccountUpdateRequest.java @@ -37,16 +37,19 @@ AccountUpdateRequest.JSON_PROPERTY_CALLBACK_URL, AccountUpdateRequest.JSON_PROPERTY_LOCALE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountUpdateRequest { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_LOCALE = "locale"; + @jakarta.annotation.Nullable private String locale; public AccountUpdateRequest() { @@ -67,7 +70,7 @@ static public AccountUpdateRequest init(HashMap data) throws Exception { ); } - public AccountUpdateRequest accountId(String accountId) { + public AccountUpdateRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -87,12 +90,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public AccountUpdateRequest callbackUrl(String callbackUrl) { + public AccountUpdateRequest callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -112,12 +115,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public AccountUpdateRequest locale(String locale) { + public AccountUpdateRequest locale(@jakarta.annotation.Nullable String locale) { this.locale = locale; return this; } @@ -137,7 +140,7 @@ public String getLocale() { @JsonProperty(JSON_PROPERTY_LOCALE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLocale(String locale) { + public void setLocale(@jakarta.annotation.Nullable String locale) { this.locale = locale; } diff --git a/src/main/java/com/dropbox/sign/model/AccountVerifyRequest.java b/src/main/java/com/dropbox/sign/model/AccountVerifyRequest.java index ef7ce84..9b272bc 100644 --- a/src/main/java/com/dropbox/sign/model/AccountVerifyRequest.java +++ b/src/main/java/com/dropbox/sign/model/AccountVerifyRequest.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ AccountVerifyRequest.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountVerifyRequest { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public AccountVerifyRequest() { @@ -59,7 +60,7 @@ static public AccountVerifyRequest init(HashMap data) throws Exception { ); } - public AccountVerifyRequest emailAddress(String emailAddress) { + public AccountVerifyRequest emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -79,7 +80,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java b/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java index a703a42..971d4f6 100644 --- a/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java +++ b/src/main/java/com/dropbox/sign/model/AccountVerifyResponse.java @@ -40,13 +40,15 @@ AccountVerifyResponse.JSON_PROPERTY_ACCOUNT, AccountVerifyResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountVerifyResponse { public static final String JSON_PROPERTY_ACCOUNT = "account"; + @jakarta.annotation.Nullable private AccountVerifyResponseAccount account; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public AccountVerifyResponse() { @@ -67,7 +69,7 @@ static public AccountVerifyResponse init(HashMap data) throws Exception { ); } - public AccountVerifyResponse account(AccountVerifyResponseAccount account) { + public AccountVerifyResponse account(@jakarta.annotation.Nullable AccountVerifyResponseAccount account) { this.account = account; return this; } @@ -87,12 +89,12 @@ public AccountVerifyResponseAccount getAccount() { @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccount(AccountVerifyResponseAccount account) { + public void setAccount(@jakarta.annotation.Nullable AccountVerifyResponseAccount account) { this.account = account; } - public AccountVerifyResponse warnings(List warnings) { + public AccountVerifyResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java b/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java index 38b66db..932c5be 100644 --- a/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java +++ b/src/main/java/com/dropbox/sign/model/AccountVerifyResponseAccount.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ AccountVerifyResponseAccount.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class AccountVerifyResponseAccount { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public AccountVerifyResponseAccount() { @@ -59,7 +60,7 @@ static public AccountVerifyResponseAccount init(HashMap data) throws Exception { ); } - public AccountVerifyResponseAccount emailAddress(String emailAddress) { + public AccountVerifyResponseAccount emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -79,7 +80,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppCreateRequest.java b/src/main/java/com/dropbox/sign/model/ApiAppCreateRequest.java index 2b2cf1c..6edb049 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppCreateRequest.java @@ -47,28 +47,35 @@ ApiAppCreateRequest.JSON_PROPERTY_OPTIONS, ApiAppCreateRequest.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppCreateRequest { public static final String JSON_PROPERTY_DOMAINS = "domains"; + @jakarta.annotation.Nonnull private List domains = new ArrayList<>(); public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_CUSTOM_LOGO_FILE = "custom_logo_file"; + @jakarta.annotation.Nullable private File customLogoFile; public static final String JSON_PROPERTY_OAUTH = "oauth"; + @jakarta.annotation.Nullable private SubOAuth oauth; public static final String JSON_PROPERTY_OPTIONS = "options"; + @jakarta.annotation.Nullable private SubOptions options; public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; + @jakarta.annotation.Nullable private SubWhiteLabelingOptions whiteLabelingOptions; public ApiAppCreateRequest() { @@ -89,7 +96,7 @@ static public ApiAppCreateRequest init(HashMap data) throws Exception { ); } - public ApiAppCreateRequest domains(List domains) { + public ApiAppCreateRequest domains(@jakarta.annotation.Nonnull List domains) { this.domains = domains; return this; } @@ -117,12 +124,12 @@ public List getDomains() { @JsonProperty(JSON_PROPERTY_DOMAINS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDomains(List domains) { + public void setDomains(@jakarta.annotation.Nonnull List domains) { this.domains = domains; } - public ApiAppCreateRequest name(String name) { + public ApiAppCreateRequest name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -142,12 +149,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public ApiAppCreateRequest callbackUrl(String callbackUrl) { + public ApiAppCreateRequest callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -167,12 +174,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppCreateRequest customLogoFile(File customLogoFile) { + public ApiAppCreateRequest customLogoFile(@jakarta.annotation.Nullable File customLogoFile) { this.customLogoFile = customLogoFile; return this; } @@ -192,12 +199,12 @@ public File getCustomLogoFile() { @JsonProperty(JSON_PROPERTY_CUSTOM_LOGO_FILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomLogoFile(File customLogoFile) { + public void setCustomLogoFile(@jakarta.annotation.Nullable File customLogoFile) { this.customLogoFile = customLogoFile; } - public ApiAppCreateRequest oauth(SubOAuth oauth) { + public ApiAppCreateRequest oauth(@jakarta.annotation.Nullable SubOAuth oauth) { this.oauth = oauth; return this; } @@ -217,12 +224,12 @@ public SubOAuth getOauth() { @JsonProperty(JSON_PROPERTY_OAUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(SubOAuth oauth) { + public void setOauth(@jakarta.annotation.Nullable SubOAuth oauth) { this.oauth = oauth; } - public ApiAppCreateRequest options(SubOptions options) { + public ApiAppCreateRequest options(@jakarta.annotation.Nullable SubOptions options) { this.options = options; return this; } @@ -242,12 +249,12 @@ public SubOptions getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOptions(SubOptions options) { + public void setOptions(@jakarta.annotation.Nullable SubOptions options) { this.options = options; } - public ApiAppCreateRequest whiteLabelingOptions(SubWhiteLabelingOptions whiteLabelingOptions) { + public ApiAppCreateRequest whiteLabelingOptions(@jakarta.annotation.Nullable SubWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; return this; } @@ -267,7 +274,7 @@ public SubWhiteLabelingOptions getWhiteLabelingOptions() { @JsonProperty(JSON_PROPERTY_WHITE_LABELING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWhiteLabelingOptions(SubWhiteLabelingOptions whiteLabelingOptions) { + public void setWhiteLabelingOptions(@jakarta.annotation.Nullable SubWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java b/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java index a2d69e9..887067a 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppGetResponse.java @@ -40,13 +40,15 @@ ApiAppGetResponse.JSON_PROPERTY_API_APP, ApiAppGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppGetResponse { public static final String JSON_PROPERTY_API_APP = "api_app"; + @jakarta.annotation.Nonnull private ApiAppResponse apiApp; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public ApiAppGetResponse() { @@ -67,7 +69,7 @@ static public ApiAppGetResponse init(HashMap data) throws Exception { ); } - public ApiAppGetResponse apiApp(ApiAppResponse apiApp) { + public ApiAppGetResponse apiApp(@jakarta.annotation.Nonnull ApiAppResponse apiApp) { this.apiApp = apiApp; return this; } @@ -87,12 +89,12 @@ public ApiAppResponse getApiApp() { @JsonProperty(JSON_PROPERTY_API_APP) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setApiApp(ApiAppResponse apiApp) { + public void setApiApp(@jakarta.annotation.Nonnull ApiAppResponse apiApp) { this.apiApp = apiApp; } - public ApiAppGetResponse warnings(List warnings) { + public ApiAppGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java b/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java index 7abb536..eca7bbd 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppListResponse.java @@ -42,16 +42,19 @@ ApiAppListResponse.JSON_PROPERTY_LIST_INFO, ApiAppListResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppListResponse { public static final String JSON_PROPERTY_API_APPS = "api_apps"; + @jakarta.annotation.Nonnull private List apiApps = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public ApiAppListResponse() { @@ -72,7 +75,7 @@ static public ApiAppListResponse init(HashMap data) throws Exception { ); } - public ApiAppListResponse apiApps(List apiApps) { + public ApiAppListResponse apiApps(@jakarta.annotation.Nonnull List apiApps) { this.apiApps = apiApps; return this; } @@ -100,12 +103,12 @@ public List getApiApps() { @JsonProperty(JSON_PROPERTY_API_APPS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setApiApps(List apiApps) { + public void setApiApps(@jakarta.annotation.Nonnull List apiApps) { this.apiApps = apiApps; } - public ApiAppListResponse listInfo(ListInfoResponse listInfo) { + public ApiAppListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public ApiAppListResponse warnings(List warnings) { + public ApiAppListResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppResponse.java b/src/main/java/com/dropbox/sign/model/ApiAppResponse.java index ee5f12e..6bd39a5 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppResponse.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppResponse.java @@ -50,37 +50,47 @@ ApiAppResponse.JSON_PROPERTY_OWNER_ACCOUNT, ApiAppResponse.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponse { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nullable private Integer createdAt; public static final String JSON_PROPERTY_DOMAINS = "domains"; + @jakarta.annotation.Nullable private List domains = null; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_IS_APPROVED = "is_approved"; + @jakarta.annotation.Nullable private Boolean isApproved; public static final String JSON_PROPERTY_OAUTH = "oauth"; + @jakarta.annotation.Nullable private ApiAppResponseOAuth oauth; public static final String JSON_PROPERTY_OPTIONS = "options"; + @jakarta.annotation.Nullable private ApiAppResponseOptions options; public static final String JSON_PROPERTY_OWNER_ACCOUNT = "owner_account"; + @jakarta.annotation.Nullable private ApiAppResponseOwnerAccount ownerAccount; public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; + @jakarta.annotation.Nullable private ApiAppResponseWhiteLabelingOptions whiteLabelingOptions; public ApiAppResponse() { @@ -101,7 +111,7 @@ static public ApiAppResponse init(HashMap data) throws Exception { ); } - public ApiAppResponse callbackUrl(String callbackUrl) { + public ApiAppResponse callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -121,12 +131,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppResponse clientId(String clientId) { + public ApiAppResponse clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -146,12 +156,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public ApiAppResponse createdAt(Integer createdAt) { + public ApiAppResponse createdAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; return this; } @@ -171,12 +181,12 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; } - public ApiAppResponse domains(List domains) { + public ApiAppResponse domains(@jakarta.annotation.Nullable List domains) { this.domains = domains; return this; } @@ -204,12 +214,12 @@ public List getDomains() { @JsonProperty(JSON_PROPERTY_DOMAINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDomains(List domains) { + public void setDomains(@jakarta.annotation.Nullable List domains) { this.domains = domains; } - public ApiAppResponse name(String name) { + public ApiAppResponse name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -229,12 +239,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public ApiAppResponse isApproved(Boolean isApproved) { + public ApiAppResponse isApproved(@jakarta.annotation.Nullable Boolean isApproved) { this.isApproved = isApproved; return this; } @@ -254,12 +264,12 @@ public Boolean getIsApproved() { @JsonProperty(JSON_PROPERTY_IS_APPROVED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsApproved(Boolean isApproved) { + public void setIsApproved(@jakarta.annotation.Nullable Boolean isApproved) { this.isApproved = isApproved; } - public ApiAppResponse oauth(ApiAppResponseOAuth oauth) { + public ApiAppResponse oauth(@jakarta.annotation.Nullable ApiAppResponseOAuth oauth) { this.oauth = oauth; return this; } @@ -279,12 +289,12 @@ public ApiAppResponseOAuth getOauth() { @JsonProperty(JSON_PROPERTY_OAUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(ApiAppResponseOAuth oauth) { + public void setOauth(@jakarta.annotation.Nullable ApiAppResponseOAuth oauth) { this.oauth = oauth; } - public ApiAppResponse options(ApiAppResponseOptions options) { + public ApiAppResponse options(@jakarta.annotation.Nullable ApiAppResponseOptions options) { this.options = options; return this; } @@ -304,12 +314,12 @@ public ApiAppResponseOptions getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOptions(ApiAppResponseOptions options) { + public void setOptions(@jakarta.annotation.Nullable ApiAppResponseOptions options) { this.options = options; } - public ApiAppResponse ownerAccount(ApiAppResponseOwnerAccount ownerAccount) { + public ApiAppResponse ownerAccount(@jakarta.annotation.Nullable ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; return this; } @@ -329,12 +339,12 @@ public ApiAppResponseOwnerAccount getOwnerAccount() { @JsonProperty(JSON_PROPERTY_OWNER_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOwnerAccount(ApiAppResponseOwnerAccount ownerAccount) { + public void setOwnerAccount(@jakarta.annotation.Nullable ApiAppResponseOwnerAccount ownerAccount) { this.ownerAccount = ownerAccount; } - public ApiAppResponse whiteLabelingOptions(ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { + public ApiAppResponse whiteLabelingOptions(@jakarta.annotation.Nullable ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; return this; } @@ -354,7 +364,7 @@ public ApiAppResponseWhiteLabelingOptions getWhiteLabelingOptions() { @JsonProperty(JSON_PROPERTY_WHITE_LABELING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWhiteLabelingOptions(ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { + public void setWhiteLabelingOptions(@jakarta.annotation.Nullable ApiAppResponseWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java b/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java index b071e40..6ae38fc 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppResponseOAuth.java @@ -40,19 +40,23 @@ ApiAppResponseOAuth.JSON_PROPERTY_SCOPES, ApiAppResponseOAuth.JSON_PROPERTY_CHARGES_USERS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponseOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_SECRET = "secret"; + @jakarta.annotation.Nullable private String secret; public static final String JSON_PROPERTY_SCOPES = "scopes"; + @jakarta.annotation.Nullable private List scopes = null; public static final String JSON_PROPERTY_CHARGES_USERS = "charges_users"; + @jakarta.annotation.Nullable private Boolean chargesUsers; public ApiAppResponseOAuth() { @@ -73,7 +77,7 @@ static public ApiAppResponseOAuth init(HashMap data) throws Exception { ); } - public ApiAppResponseOAuth callbackUrl(String callbackUrl) { + public ApiAppResponseOAuth callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -93,12 +97,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppResponseOAuth secret(String secret) { + public ApiAppResponseOAuth secret(@jakarta.annotation.Nullable String secret) { this.secret = secret; return this; } @@ -118,12 +122,12 @@ public String getSecret() { @JsonProperty(JSON_PROPERTY_SECRET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecret(String secret) { + public void setSecret(@jakarta.annotation.Nullable String secret) { this.secret = secret; } - public ApiAppResponseOAuth scopes(List scopes) { + public ApiAppResponseOAuth scopes(@jakarta.annotation.Nullable List scopes) { this.scopes = scopes; return this; } @@ -151,12 +155,12 @@ public List getScopes() { @JsonProperty(JSON_PROPERTY_SCOPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setScopes(List scopes) { + public void setScopes(@jakarta.annotation.Nullable List scopes) { this.scopes = scopes; } - public ApiAppResponseOAuth chargesUsers(Boolean chargesUsers) { + public ApiAppResponseOAuth chargesUsers(@jakarta.annotation.Nullable Boolean chargesUsers) { this.chargesUsers = chargesUsers; return this; } @@ -176,7 +180,7 @@ public Boolean getChargesUsers() { @JsonProperty(JSON_PROPERTY_CHARGES_USERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setChargesUsers(Boolean chargesUsers) { + public void setChargesUsers(@jakarta.annotation.Nullable Boolean chargesUsers) { this.chargesUsers = chargesUsers; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java b/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java index 2cffd69..1a9c91d 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppResponseOptions.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ ApiAppResponseOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponseOptions { public static final String JSON_PROPERTY_CAN_INSERT_EVERYWHERE = "can_insert_everywhere"; + @jakarta.annotation.Nullable private Boolean canInsertEverywhere; public ApiAppResponseOptions() { @@ -59,7 +60,7 @@ static public ApiAppResponseOptions init(HashMap data) throws Exception { ); } - public ApiAppResponseOptions canInsertEverywhere(Boolean canInsertEverywhere) { + public ApiAppResponseOptions canInsertEverywhere(@jakarta.annotation.Nullable Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; return this; } @@ -79,7 +80,7 @@ public Boolean getCanInsertEverywhere() { @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCanInsertEverywhere(Boolean canInsertEverywhere) { + public void setCanInsertEverywhere(@jakarta.annotation.Nullable Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java b/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java index 80f95b5..7149d8e 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppResponseOwnerAccount.java @@ -36,13 +36,15 @@ ApiAppResponseOwnerAccount.JSON_PROPERTY_ACCOUNT_ID, ApiAppResponseOwnerAccount.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponseOwnerAccount { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public ApiAppResponseOwnerAccount() { @@ -63,7 +65,7 @@ static public ApiAppResponseOwnerAccount init(HashMap data) throws Exception { ); } - public ApiAppResponseOwnerAccount accountId(String accountId) { + public ApiAppResponseOwnerAccount accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -83,12 +85,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public ApiAppResponseOwnerAccount emailAddress(String emailAddress) { + public ApiAppResponseOwnerAccount emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -108,7 +110,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java b/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java index 44b6f6e..2dd9a00 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppResponseWhiteLabelingOptions.java @@ -48,49 +48,63 @@ ApiAppResponseWhiteLabelingOptions.JSON_PROPERTY_TEXT_COLOR1, ApiAppResponseWhiteLabelingOptions.JSON_PROPERTY_TEXT_COLOR2 }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppResponseWhiteLabelingOptions { public static final String JSON_PROPERTY_HEADER_BACKGROUND_COLOR = "header_background_color"; + @jakarta.annotation.Nullable private String headerBackgroundColor; public static final String JSON_PROPERTY_LEGAL_VERSION = "legal_version"; + @jakarta.annotation.Nullable private String legalVersion; public static final String JSON_PROPERTY_LINK_COLOR = "link_color"; + @jakarta.annotation.Nullable private String linkColor; public static final String JSON_PROPERTY_PAGE_BACKGROUND_COLOR = "page_background_color"; + @jakarta.annotation.Nullable private String pageBackgroundColor; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR = "primary_button_color"; + @jakarta.annotation.Nullable private String primaryButtonColor; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER = "primary_button_color_hover"; + @jakarta.annotation.Nullable private String primaryButtonColorHover; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR = "primary_button_text_color"; + @jakarta.annotation.Nullable private String primaryButtonTextColor; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER = "primary_button_text_color_hover"; + @jakarta.annotation.Nullable private String primaryButtonTextColorHover; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR = "secondary_button_color"; + @jakarta.annotation.Nullable private String secondaryButtonColor; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER = "secondary_button_color_hover"; + @jakarta.annotation.Nullable private String secondaryButtonColorHover; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR = "secondary_button_text_color"; + @jakarta.annotation.Nullable private String secondaryButtonTextColor; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER = "secondary_button_text_color_hover"; + @jakarta.annotation.Nullable private String secondaryButtonTextColorHover; public static final String JSON_PROPERTY_TEXT_COLOR1 = "text_color1"; + @jakarta.annotation.Nullable private String textColor1; public static final String JSON_PROPERTY_TEXT_COLOR2 = "text_color2"; + @jakarta.annotation.Nullable private String textColor2; public ApiAppResponseWhiteLabelingOptions() { @@ -111,7 +125,7 @@ static public ApiAppResponseWhiteLabelingOptions init(HashMap data) throws Excep ); } - public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(String headerBackgroundColor) { + public ApiAppResponseWhiteLabelingOptions headerBackgroundColor(@jakarta.annotation.Nullable String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; return this; } @@ -131,12 +145,12 @@ public String getHeaderBackgroundColor() { @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeaderBackgroundColor(String headerBackgroundColor) { + public void setHeaderBackgroundColor(@jakarta.annotation.Nullable String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } - public ApiAppResponseWhiteLabelingOptions legalVersion(String legalVersion) { + public ApiAppResponseWhiteLabelingOptions legalVersion(@jakarta.annotation.Nullable String legalVersion) { this.legalVersion = legalVersion; return this; } @@ -156,12 +170,12 @@ public String getLegalVersion() { @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLegalVersion(String legalVersion) { + public void setLegalVersion(@jakarta.annotation.Nullable String legalVersion) { this.legalVersion = legalVersion; } - public ApiAppResponseWhiteLabelingOptions linkColor(String linkColor) { + public ApiAppResponseWhiteLabelingOptions linkColor(@jakarta.annotation.Nullable String linkColor) { this.linkColor = linkColor; return this; } @@ -181,12 +195,12 @@ public String getLinkColor() { @JsonProperty(JSON_PROPERTY_LINK_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinkColor(String linkColor) { + public void setLinkColor(@jakarta.annotation.Nullable String linkColor) { this.linkColor = linkColor; } - public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(String pageBackgroundColor) { + public ApiAppResponseWhiteLabelingOptions pageBackgroundColor(@jakarta.annotation.Nullable String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; return this; } @@ -206,12 +220,12 @@ public String getPageBackgroundColor() { @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPageBackgroundColor(String pageBackgroundColor) { + public void setPageBackgroundColor(@jakarta.annotation.Nullable String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } - public ApiAppResponseWhiteLabelingOptions primaryButtonColor(String primaryButtonColor) { + public ApiAppResponseWhiteLabelingOptions primaryButtonColor(@jakarta.annotation.Nullable String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; return this; } @@ -231,12 +245,12 @@ public String getPrimaryButtonColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonColor(String primaryButtonColor) { + public void setPrimaryButtonColor(@jakarta.annotation.Nullable String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } - public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover(String primaryButtonColorHover) { + public ApiAppResponseWhiteLabelingOptions primaryButtonColorHover(@jakarta.annotation.Nullable String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; return this; } @@ -256,12 +270,12 @@ public String getPrimaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonColorHover(String primaryButtonColorHover) { + public void setPrimaryButtonColorHover(@jakarta.annotation.Nullable String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } - public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor(String primaryButtonTextColor) { + public ApiAppResponseWhiteLabelingOptions primaryButtonTextColor(@jakarta.annotation.Nullable String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; return this; } @@ -281,12 +295,12 @@ public String getPrimaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonTextColor(String primaryButtonTextColor) { + public void setPrimaryButtonTextColor(@jakarta.annotation.Nullable String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } - public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover(String primaryButtonTextColorHover) { + public ApiAppResponseWhiteLabelingOptions primaryButtonTextColorHover(@jakarta.annotation.Nullable String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; return this; } @@ -306,12 +320,12 @@ public String getPrimaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { + public void setPrimaryButtonTextColorHover(@jakarta.annotation.Nullable String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } - public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(String secondaryButtonColor) { + public ApiAppResponseWhiteLabelingOptions secondaryButtonColor(@jakarta.annotation.Nullable String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; return this; } @@ -331,12 +345,12 @@ public String getSecondaryButtonColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonColor(String secondaryButtonColor) { + public void setSecondaryButtonColor(@jakarta.annotation.Nullable String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } - public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover(String secondaryButtonColorHover) { + public ApiAppResponseWhiteLabelingOptions secondaryButtonColorHover(@jakarta.annotation.Nullable String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; return this; } @@ -356,12 +370,12 @@ public String getSecondaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { + public void setSecondaryButtonColorHover(@jakarta.annotation.Nullable String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } - public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor(String secondaryButtonTextColor) { + public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColor(@jakarta.annotation.Nullable String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; return this; } @@ -381,12 +395,12 @@ public String getSecondaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { + public void setSecondaryButtonTextColor(@jakarta.annotation.Nullable String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } - public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover(String secondaryButtonTextColorHover) { + public ApiAppResponseWhiteLabelingOptions secondaryButtonTextColorHover(@jakarta.annotation.Nullable String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; return this; } @@ -406,12 +420,12 @@ public String getSecondaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { + public void setSecondaryButtonTextColorHover(@jakarta.annotation.Nullable String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } - public ApiAppResponseWhiteLabelingOptions textColor1(String textColor1) { + public ApiAppResponseWhiteLabelingOptions textColor1(@jakarta.annotation.Nullable String textColor1) { this.textColor1 = textColor1; return this; } @@ -431,12 +445,12 @@ public String getTextColor1() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTextColor1(String textColor1) { + public void setTextColor1(@jakarta.annotation.Nullable String textColor1) { this.textColor1 = textColor1; } - public ApiAppResponseWhiteLabelingOptions textColor2(String textColor2) { + public ApiAppResponseWhiteLabelingOptions textColor2(@jakarta.annotation.Nullable String textColor2) { this.textColor2 = textColor2; return this; } @@ -456,7 +470,7 @@ public String getTextColor2() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTextColor2(String textColor2) { + public void setTextColor2(@jakarta.annotation.Nullable String textColor2) { this.textColor2 = textColor2; } diff --git a/src/main/java/com/dropbox/sign/model/ApiAppUpdateRequest.java b/src/main/java/com/dropbox/sign/model/ApiAppUpdateRequest.java index c4a4849..704ccc2 100644 --- a/src/main/java/com/dropbox/sign/model/ApiAppUpdateRequest.java +++ b/src/main/java/com/dropbox/sign/model/ApiAppUpdateRequest.java @@ -47,28 +47,35 @@ ApiAppUpdateRequest.JSON_PROPERTY_OPTIONS, ApiAppUpdateRequest.JSON_PROPERTY_WHITE_LABELING_OPTIONS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ApiAppUpdateRequest { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; public static final String JSON_PROPERTY_CUSTOM_LOGO_FILE = "custom_logo_file"; + @jakarta.annotation.Nullable private File customLogoFile; public static final String JSON_PROPERTY_DOMAINS = "domains"; + @jakarta.annotation.Nullable private List domains = null; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_OAUTH = "oauth"; + @jakarta.annotation.Nullable private SubOAuth oauth; public static final String JSON_PROPERTY_OPTIONS = "options"; + @jakarta.annotation.Nullable private SubOptions options; public static final String JSON_PROPERTY_WHITE_LABELING_OPTIONS = "white_labeling_options"; + @jakarta.annotation.Nullable private SubWhiteLabelingOptions whiteLabelingOptions; public ApiAppUpdateRequest() { @@ -89,7 +96,7 @@ static public ApiAppUpdateRequest init(HashMap data) throws Exception { ); } - public ApiAppUpdateRequest callbackUrl(String callbackUrl) { + public ApiAppUpdateRequest callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -109,12 +116,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public ApiAppUpdateRequest customLogoFile(File customLogoFile) { + public ApiAppUpdateRequest customLogoFile(@jakarta.annotation.Nullable File customLogoFile) { this.customLogoFile = customLogoFile; return this; } @@ -134,12 +141,12 @@ public File getCustomLogoFile() { @JsonProperty(JSON_PROPERTY_CUSTOM_LOGO_FILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomLogoFile(File customLogoFile) { + public void setCustomLogoFile(@jakarta.annotation.Nullable File customLogoFile) { this.customLogoFile = customLogoFile; } - public ApiAppUpdateRequest domains(List domains) { + public ApiAppUpdateRequest domains(@jakarta.annotation.Nullable List domains) { this.domains = domains; return this; } @@ -167,12 +174,12 @@ public List getDomains() { @JsonProperty(JSON_PROPERTY_DOMAINS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDomains(List domains) { + public void setDomains(@jakarta.annotation.Nullable List domains) { this.domains = domains; } - public ApiAppUpdateRequest name(String name) { + public ApiAppUpdateRequest name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -192,12 +199,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public ApiAppUpdateRequest oauth(SubOAuth oauth) { + public ApiAppUpdateRequest oauth(@jakarta.annotation.Nullable SubOAuth oauth) { this.oauth = oauth; return this; } @@ -217,12 +224,12 @@ public SubOAuth getOauth() { @JsonProperty(JSON_PROPERTY_OAUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOauth(SubOAuth oauth) { + public void setOauth(@jakarta.annotation.Nullable SubOAuth oauth) { this.oauth = oauth; } - public ApiAppUpdateRequest options(SubOptions options) { + public ApiAppUpdateRequest options(@jakarta.annotation.Nullable SubOptions options) { this.options = options; return this; } @@ -242,12 +249,12 @@ public SubOptions getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOptions(SubOptions options) { + public void setOptions(@jakarta.annotation.Nullable SubOptions options) { this.options = options; } - public ApiAppUpdateRequest whiteLabelingOptions(SubWhiteLabelingOptions whiteLabelingOptions) { + public ApiAppUpdateRequest whiteLabelingOptions(@jakarta.annotation.Nullable SubWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; return this; } @@ -267,7 +274,7 @@ public SubWhiteLabelingOptions getWhiteLabelingOptions() { @JsonProperty(JSON_PROPERTY_WHITE_LABELING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWhiteLabelingOptions(SubWhiteLabelingOptions whiteLabelingOptions) { + public void setWhiteLabelingOptions(@jakarta.annotation.Nullable SubWhiteLabelingOptions whiteLabelingOptions) { this.whiteLabelingOptions = whiteLabelingOptions; } diff --git a/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java b/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java index af9c337..944191a 100644 --- a/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponse.java @@ -44,19 +44,23 @@ BulkSendJobGetResponse.JSON_PROPERTY_SIGNATURE_REQUESTS, BulkSendJobGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class BulkSendJobGetResponse { public static final String JSON_PROPERTY_BULK_SEND_JOB = "bulk_send_job"; + @jakarta.annotation.Nonnull private BulkSendJobResponse bulkSendJob; public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_SIGNATURE_REQUESTS = "signature_requests"; + @jakarta.annotation.Nonnull private List signatureRequests = new ArrayList<>(); public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public BulkSendJobGetResponse() { @@ -77,7 +81,7 @@ static public BulkSendJobGetResponse init(HashMap data) throws Exception { ); } - public BulkSendJobGetResponse bulkSendJob(BulkSendJobResponse bulkSendJob) { + public BulkSendJobGetResponse bulkSendJob(@jakarta.annotation.Nonnull BulkSendJobResponse bulkSendJob) { this.bulkSendJob = bulkSendJob; return this; } @@ -97,12 +101,12 @@ public BulkSendJobResponse getBulkSendJob() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setBulkSendJob(BulkSendJobResponse bulkSendJob) { + public void setBulkSendJob(@jakarta.annotation.Nonnull BulkSendJobResponse bulkSendJob) { this.bulkSendJob = bulkSendJob; } - public BulkSendJobGetResponse listInfo(ListInfoResponse listInfo) { + public BulkSendJobGetResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -122,12 +126,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public BulkSendJobGetResponse signatureRequests(List signatureRequests) { + public BulkSendJobGetResponse signatureRequests(@jakarta.annotation.Nonnull List signatureRequests) { this.signatureRequests = signatureRequests; return this; } @@ -155,12 +159,12 @@ public List getSignatureRequests() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUESTS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignatureRequests(List signatureRequests) { + public void setSignatureRequests(@jakarta.annotation.Nonnull List signatureRequests) { this.signatureRequests = signatureRequests; } - public BulkSendJobGetResponse warnings(List warnings) { + public BulkSendJobGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -188,7 +192,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java b/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java index 3901db1..2e360bc 100644 --- a/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java +++ b/src/main/java/com/dropbox/sign/model/BulkSendJobGetResponseSignatureRequests.java @@ -67,82 +67,107 @@ BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_SIGNATURES, BulkSendJobGetResponseSignatureRequests.JSON_PROPERTY_BULK_SEND_JOB_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class BulkSendJobGetResponseSignatureRequests { public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_SIGNATURE_REQUEST_ID = "signature_request_id"; + @jakarta.annotation.Nullable private String signatureRequestId; public static final String JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS = "requester_email_address"; + @jakarta.annotation.Nullable private String requesterEmailAddress; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_ORIGINAL_TITLE = "original_title"; + @jakarta.annotation.Nullable private String originalTitle; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nullable private Integer createdAt; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public static final String JSON_PROPERTY_IS_COMPLETE = "is_complete"; + @jakarta.annotation.Nullable private Boolean isComplete; public static final String JSON_PROPERTY_IS_DECLINED = "is_declined"; + @jakarta.annotation.Nullable private Boolean isDeclined; public static final String JSON_PROPERTY_HAS_ERROR = "has_error"; + @jakarta.annotation.Nullable private Boolean hasError; public static final String JSON_PROPERTY_FILES_URL = "files_url"; + @jakarta.annotation.Nullable private String filesUrl; public static final String JSON_PROPERTY_SIGNING_URL = "signing_url"; + @jakarta.annotation.Nullable private String signingUrl; public static final String JSON_PROPERTY_DETAILS_URL = "details_url"; + @jakarta.annotation.Nullable private String detailsUrl; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_FINAL_COPY_URI = "final_copy_uri"; + @jakarta.annotation.Nullable private String finalCopyUri; public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nullable private List templateIds = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_RESPONSE_DATA = "response_data"; + @jakarta.annotation.Nullable private List responseData = null; public static final String JSON_PROPERTY_SIGNATURES = "signatures"; + @jakarta.annotation.Nullable private List signatures = null; public static final String JSON_PROPERTY_BULK_SEND_JOB_ID = "bulk_send_job_id"; + @jakarta.annotation.Nullable private String bulkSendJobId; public BulkSendJobGetResponseSignatureRequests() { @@ -163,7 +188,7 @@ static public BulkSendJobGetResponseSignatureRequests init(HashMap data) throws ); } - public BulkSendJobGetResponseSignatureRequests testMode(Boolean testMode) { + public BulkSendJobGetResponseSignatureRequests testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -183,12 +208,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public BulkSendJobGetResponseSignatureRequests signatureRequestId(String signatureRequestId) { + public BulkSendJobGetResponseSignatureRequests signatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; return this; } @@ -208,12 +233,12 @@ public String getSignatureRequestId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureRequestId(String signatureRequestId) { + public void setSignatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; } - public BulkSendJobGetResponseSignatureRequests requesterEmailAddress(String requesterEmailAddress) { + public BulkSendJobGetResponseSignatureRequests requesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; return this; } @@ -233,12 +258,12 @@ public String getRequesterEmailAddress() { @JsonProperty(JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequesterEmailAddress(String requesterEmailAddress) { + public void setRequesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; } - public BulkSendJobGetResponseSignatureRequests title(String title) { + public BulkSendJobGetResponseSignatureRequests title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -258,12 +283,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public BulkSendJobGetResponseSignatureRequests originalTitle(String originalTitle) { + public BulkSendJobGetResponseSignatureRequests originalTitle(@jakarta.annotation.Nullable String originalTitle) { this.originalTitle = originalTitle; return this; } @@ -283,12 +308,12 @@ public String getOriginalTitle() { @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOriginalTitle(String originalTitle) { + public void setOriginalTitle(@jakarta.annotation.Nullable String originalTitle) { this.originalTitle = originalTitle; } - public BulkSendJobGetResponseSignatureRequests subject(String subject) { + public BulkSendJobGetResponseSignatureRequests subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -308,12 +333,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public BulkSendJobGetResponseSignatureRequests message(String message) { + public BulkSendJobGetResponseSignatureRequests message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -333,12 +358,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public BulkSendJobGetResponseSignatureRequests metadata(Map metadata) { + public BulkSendJobGetResponseSignatureRequests metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -366,12 +391,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public BulkSendJobGetResponseSignatureRequests createdAt(Integer createdAt) { + public BulkSendJobGetResponseSignatureRequests createdAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; return this; } @@ -391,12 +416,12 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; } - public BulkSendJobGetResponseSignatureRequests expiresAt(Integer expiresAt) { + public BulkSendJobGetResponseSignatureRequests expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -416,12 +441,12 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } - public BulkSendJobGetResponseSignatureRequests isComplete(Boolean isComplete) { + public BulkSendJobGetResponseSignatureRequests isComplete(@jakarta.annotation.Nullable Boolean isComplete) { this.isComplete = isComplete; return this; } @@ -441,12 +466,12 @@ public Boolean getIsComplete() { @JsonProperty(JSON_PROPERTY_IS_COMPLETE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsComplete(Boolean isComplete) { + public void setIsComplete(@jakarta.annotation.Nullable Boolean isComplete) { this.isComplete = isComplete; } - public BulkSendJobGetResponseSignatureRequests isDeclined(Boolean isDeclined) { + public BulkSendJobGetResponseSignatureRequests isDeclined(@jakarta.annotation.Nullable Boolean isDeclined) { this.isDeclined = isDeclined; return this; } @@ -466,12 +491,12 @@ public Boolean getIsDeclined() { @JsonProperty(JSON_PROPERTY_IS_DECLINED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsDeclined(Boolean isDeclined) { + public void setIsDeclined(@jakarta.annotation.Nullable Boolean isDeclined) { this.isDeclined = isDeclined; } - public BulkSendJobGetResponseSignatureRequests hasError(Boolean hasError) { + public BulkSendJobGetResponseSignatureRequests hasError(@jakarta.annotation.Nullable Boolean hasError) { this.hasError = hasError; return this; } @@ -491,12 +516,12 @@ public Boolean getHasError() { @JsonProperty(JSON_PROPERTY_HAS_ERROR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHasError(Boolean hasError) { + public void setHasError(@jakarta.annotation.Nullable Boolean hasError) { this.hasError = hasError; } - public BulkSendJobGetResponseSignatureRequests filesUrl(String filesUrl) { + public BulkSendJobGetResponseSignatureRequests filesUrl(@jakarta.annotation.Nullable String filesUrl) { this.filesUrl = filesUrl; return this; } @@ -516,12 +541,12 @@ public String getFilesUrl() { @JsonProperty(JSON_PROPERTY_FILES_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFilesUrl(String filesUrl) { + public void setFilesUrl(@jakarta.annotation.Nullable String filesUrl) { this.filesUrl = filesUrl; } - public BulkSendJobGetResponseSignatureRequests signingUrl(String signingUrl) { + public BulkSendJobGetResponseSignatureRequests signingUrl(@jakarta.annotation.Nullable String signingUrl) { this.signingUrl = signingUrl; return this; } @@ -541,12 +566,12 @@ public String getSigningUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningUrl(String signingUrl) { + public void setSigningUrl(@jakarta.annotation.Nullable String signingUrl) { this.signingUrl = signingUrl; } - public BulkSendJobGetResponseSignatureRequests detailsUrl(String detailsUrl) { + public BulkSendJobGetResponseSignatureRequests detailsUrl(@jakarta.annotation.Nullable String detailsUrl) { this.detailsUrl = detailsUrl; return this; } @@ -566,12 +591,12 @@ public String getDetailsUrl() { @JsonProperty(JSON_PROPERTY_DETAILS_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDetailsUrl(String detailsUrl) { + public void setDetailsUrl(@jakarta.annotation.Nullable String detailsUrl) { this.detailsUrl = detailsUrl; } - public BulkSendJobGetResponseSignatureRequests ccEmailAddresses(List ccEmailAddresses) { + public BulkSendJobGetResponseSignatureRequests ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -599,12 +624,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public BulkSendJobGetResponseSignatureRequests signingRedirectUrl(String signingRedirectUrl) { + public BulkSendJobGetResponseSignatureRequests signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -624,12 +649,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public BulkSendJobGetResponseSignatureRequests finalCopyUri(String finalCopyUri) { + public BulkSendJobGetResponseSignatureRequests finalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; return this; } @@ -649,12 +674,12 @@ public String getFinalCopyUri() { @JsonProperty(JSON_PROPERTY_FINAL_COPY_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFinalCopyUri(String finalCopyUri) { + public void setFinalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; } - public BulkSendJobGetResponseSignatureRequests templateIds(List templateIds) { + public BulkSendJobGetResponseSignatureRequests templateIds(@jakarta.annotation.Nullable List templateIds) { this.templateIds = templateIds; return this; } @@ -682,12 +707,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nullable List templateIds) { this.templateIds = templateIds; } - public BulkSendJobGetResponseSignatureRequests customFields(List customFields) { + public BulkSendJobGetResponseSignatureRequests customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -715,12 +740,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public BulkSendJobGetResponseSignatureRequests attachments(List attachments) { + public BulkSendJobGetResponseSignatureRequests attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -748,12 +773,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public BulkSendJobGetResponseSignatureRequests responseData(List responseData) { + public BulkSendJobGetResponseSignatureRequests responseData(@jakarta.annotation.Nullable List responseData) { this.responseData = responseData; return this; } @@ -781,12 +806,12 @@ public List getResponseData() { @JsonProperty(JSON_PROPERTY_RESPONSE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResponseData(List responseData) { + public void setResponseData(@jakarta.annotation.Nullable List responseData) { this.responseData = responseData; } - public BulkSendJobGetResponseSignatureRequests signatures(List signatures) { + public BulkSendJobGetResponseSignatureRequests signatures(@jakarta.annotation.Nullable List signatures) { this.signatures = signatures; return this; } @@ -814,12 +839,12 @@ public List getSignatures() { @JsonProperty(JSON_PROPERTY_SIGNATURES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatures(List signatures) { + public void setSignatures(@jakarta.annotation.Nullable List signatures) { this.signatures = signatures; } - public BulkSendJobGetResponseSignatureRequests bulkSendJobId(String bulkSendJobId) { + public BulkSendJobGetResponseSignatureRequests bulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; return this; } @@ -839,7 +864,7 @@ public String getBulkSendJobId() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBulkSendJobId(String bulkSendJobId) { + public void setBulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } diff --git a/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java b/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java index c550b31..93fd456 100644 --- a/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java +++ b/src/main/java/com/dropbox/sign/model/BulkSendJobListResponse.java @@ -42,16 +42,19 @@ BulkSendJobListResponse.JSON_PROPERTY_LIST_INFO, BulkSendJobListResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class BulkSendJobListResponse { public static final String JSON_PROPERTY_BULK_SEND_JOBS = "bulk_send_jobs"; + @jakarta.annotation.Nonnull private List bulkSendJobs = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public BulkSendJobListResponse() { @@ -72,7 +75,7 @@ static public BulkSendJobListResponse init(HashMap data) throws Exception { ); } - public BulkSendJobListResponse bulkSendJobs(List bulkSendJobs) { + public BulkSendJobListResponse bulkSendJobs(@jakarta.annotation.Nonnull List bulkSendJobs) { this.bulkSendJobs = bulkSendJobs; return this; } @@ -100,12 +103,12 @@ public List getBulkSendJobs() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOBS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setBulkSendJobs(List bulkSendJobs) { + public void setBulkSendJobs(@jakarta.annotation.Nonnull List bulkSendJobs) { this.bulkSendJobs = bulkSendJobs; } - public BulkSendJobListResponse listInfo(ListInfoResponse listInfo) { + public BulkSendJobListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public BulkSendJobListResponse warnings(List warnings) { + public BulkSendJobListResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java b/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java index 88f0eec..f025c4f 100644 --- a/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java +++ b/src/main/java/com/dropbox/sign/model/BulkSendJobResponse.java @@ -38,19 +38,23 @@ BulkSendJobResponse.JSON_PROPERTY_IS_CREATOR, BulkSendJobResponse.JSON_PROPERTY_CREATED_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class BulkSendJobResponse { public static final String JSON_PROPERTY_BULK_SEND_JOB_ID = "bulk_send_job_id"; + @jakarta.annotation.Nullable private String bulkSendJobId; public static final String JSON_PROPERTY_TOTAL = "total"; + @jakarta.annotation.Nullable private Integer total; public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; + @jakarta.annotation.Nullable private Boolean isCreator; public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nullable private Integer createdAt; public BulkSendJobResponse() { @@ -71,7 +75,7 @@ static public BulkSendJobResponse init(HashMap data) throws Exception { ); } - public BulkSendJobResponse bulkSendJobId(String bulkSendJobId) { + public BulkSendJobResponse bulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; return this; } @@ -91,12 +95,12 @@ public String getBulkSendJobId() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBulkSendJobId(String bulkSendJobId) { + public void setBulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } - public BulkSendJobResponse total(Integer total) { + public BulkSendJobResponse total(@jakarta.annotation.Nullable Integer total) { this.total = total; return this; } @@ -116,12 +120,12 @@ public Integer getTotal() { @JsonProperty(JSON_PROPERTY_TOTAL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTotal(Integer total) { + public void setTotal(@jakarta.annotation.Nullable Integer total) { this.total = total; } - public BulkSendJobResponse isCreator(Boolean isCreator) { + public BulkSendJobResponse isCreator(@jakarta.annotation.Nullable Boolean isCreator) { this.isCreator = isCreator; return this; } @@ -141,12 +145,12 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsCreator(Boolean isCreator) { + public void setIsCreator(@jakarta.annotation.Nullable Boolean isCreator) { this.isCreator = isCreator; } - public BulkSendJobResponse createdAt(Integer createdAt) { + public BulkSendJobResponse createdAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; return this; } @@ -166,7 +170,7 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; } diff --git a/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java b/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java index b3be772..9f7095f 100644 --- a/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java +++ b/src/main/java/com/dropbox/sign/model/BulkSendJobSendResponse.java @@ -40,13 +40,15 @@ BulkSendJobSendResponse.JSON_PROPERTY_BULK_SEND_JOB, BulkSendJobSendResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class BulkSendJobSendResponse { public static final String JSON_PROPERTY_BULK_SEND_JOB = "bulk_send_job"; + @jakarta.annotation.Nonnull private BulkSendJobResponse bulkSendJob; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public BulkSendJobSendResponse() { @@ -67,7 +69,7 @@ static public BulkSendJobSendResponse init(HashMap data) throws Exception { ); } - public BulkSendJobSendResponse bulkSendJob(BulkSendJobResponse bulkSendJob) { + public BulkSendJobSendResponse bulkSendJob(@jakarta.annotation.Nonnull BulkSendJobResponse bulkSendJob) { this.bulkSendJob = bulkSendJob; return this; } @@ -87,12 +89,12 @@ public BulkSendJobResponse getBulkSendJob() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setBulkSendJob(BulkSendJobResponse bulkSendJob) { + public void setBulkSendJob(@jakarta.annotation.Nonnull BulkSendJobResponse bulkSendJob) { this.bulkSendJob = bulkSendJob; } - public BulkSendJobSendResponse warnings(List warnings) { + public BulkSendJobSendResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java index 103eb03..4ae9bf2 100644 --- a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java +++ b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlRequest.java @@ -48,37 +48,47 @@ EmbeddedEditUrlRequest.JSON_PROPERTY_SHOW_PROGRESS_STEPPER, EmbeddedEditUrlRequest.JSON_PROPERTY_TEST_MODE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EmbeddedEditUrlRequest { public static final String JSON_PROPERTY_ALLOW_EDIT_CCS = "allow_edit_ccs"; + @jakarta.annotation.Nullable private Boolean allowEditCcs = false; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + @jakarta.annotation.Nullable private List ccRoles = null; public static final String JSON_PROPERTY_EDITOR_OPTIONS = "editor_options"; + @jakarta.annotation.Nullable private SubEditorOptions editorOptions; public static final String JSON_PROPERTY_FORCE_SIGNER_ROLES = "force_signer_roles"; + @jakarta.annotation.Nullable private Boolean forceSignerRoles = false; public static final String JSON_PROPERTY_FORCE_SUBJECT_MESSAGE = "force_subject_message"; + @jakarta.annotation.Nullable private Boolean forceSubjectMessage = false; public static final String JSON_PROPERTY_MERGE_FIELDS = "merge_fields"; + @jakarta.annotation.Nullable private List mergeFields = null; public static final String JSON_PROPERTY_PREVIEW_ONLY = "preview_only"; + @jakarta.annotation.Nullable private Boolean previewOnly = false; public static final String JSON_PROPERTY_SHOW_PREVIEW = "show_preview"; + @jakarta.annotation.Nullable private Boolean showPreview = false; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public EmbeddedEditUrlRequest() { @@ -99,7 +109,7 @@ static public EmbeddedEditUrlRequest init(HashMap data) throws Exception { ); } - public EmbeddedEditUrlRequest allowEditCcs(Boolean allowEditCcs) { + public EmbeddedEditUrlRequest allowEditCcs(@jakarta.annotation.Nullable Boolean allowEditCcs) { this.allowEditCcs = allowEditCcs; return this; } @@ -119,12 +129,12 @@ public Boolean getAllowEditCcs() { @JsonProperty(JSON_PROPERTY_ALLOW_EDIT_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowEditCcs(Boolean allowEditCcs) { + public void setAllowEditCcs(@jakarta.annotation.Nullable Boolean allowEditCcs) { this.allowEditCcs = allowEditCcs; } - public EmbeddedEditUrlRequest ccRoles(List ccRoles) { + public EmbeddedEditUrlRequest ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; } @@ -152,12 +162,12 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { + public void setCcRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; } - public EmbeddedEditUrlRequest editorOptions(SubEditorOptions editorOptions) { + public EmbeddedEditUrlRequest editorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; return this; } @@ -177,12 +187,12 @@ public SubEditorOptions getEditorOptions() { @JsonProperty(JSON_PROPERTY_EDITOR_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditorOptions(SubEditorOptions editorOptions) { + public void setEditorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; } - public EmbeddedEditUrlRequest forceSignerRoles(Boolean forceSignerRoles) { + public EmbeddedEditUrlRequest forceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; return this; } @@ -202,12 +212,12 @@ public Boolean getForceSignerRoles() { @JsonProperty(JSON_PROPERTY_FORCE_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSignerRoles(Boolean forceSignerRoles) { + public void setForceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; } - public EmbeddedEditUrlRequest forceSubjectMessage(Boolean forceSubjectMessage) { + public EmbeddedEditUrlRequest forceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; return this; } @@ -227,12 +237,12 @@ public Boolean getForceSubjectMessage() { @JsonProperty(JSON_PROPERTY_FORCE_SUBJECT_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSubjectMessage(Boolean forceSubjectMessage) { + public void setForceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; } - public EmbeddedEditUrlRequest mergeFields(List mergeFields) { + public EmbeddedEditUrlRequest mergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; return this; } @@ -260,12 +270,12 @@ public List getMergeFields() { @JsonProperty(JSON_PROPERTY_MERGE_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMergeFields(List mergeFields) { + public void setMergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; } - public EmbeddedEditUrlRequest previewOnly(Boolean previewOnly) { + public EmbeddedEditUrlRequest previewOnly(@jakarta.annotation.Nullable Boolean previewOnly) { this.previewOnly = previewOnly; return this; } @@ -285,12 +295,12 @@ public Boolean getPreviewOnly() { @JsonProperty(JSON_PROPERTY_PREVIEW_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPreviewOnly(Boolean previewOnly) { + public void setPreviewOnly(@jakarta.annotation.Nullable Boolean previewOnly) { this.previewOnly = previewOnly; } - public EmbeddedEditUrlRequest showPreview(Boolean showPreview) { + public EmbeddedEditUrlRequest showPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; return this; } @@ -310,12 +320,12 @@ public Boolean getShowPreview() { @JsonProperty(JSON_PROPERTY_SHOW_PREVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowPreview(Boolean showPreview) { + public void setShowPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; } - public EmbeddedEditUrlRequest showProgressStepper(Boolean showProgressStepper) { + public EmbeddedEditUrlRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -335,12 +345,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public EmbeddedEditUrlRequest testMode(Boolean testMode) { + public EmbeddedEditUrlRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -360,7 +370,7 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } diff --git a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java index cf7faf9..11c566a 100644 --- a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java +++ b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponse.java @@ -40,13 +40,15 @@ EmbeddedEditUrlResponse.JSON_PROPERTY_EMBEDDED, EmbeddedEditUrlResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EmbeddedEditUrlResponse { public static final String JSON_PROPERTY_EMBEDDED = "embedded"; + @jakarta.annotation.Nonnull private EmbeddedEditUrlResponseEmbedded embedded; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public EmbeddedEditUrlResponse() { @@ -67,7 +69,7 @@ static public EmbeddedEditUrlResponse init(HashMap data) throws Exception { ); } - public EmbeddedEditUrlResponse embedded(EmbeddedEditUrlResponseEmbedded embedded) { + public EmbeddedEditUrlResponse embedded(@jakarta.annotation.Nonnull EmbeddedEditUrlResponseEmbedded embedded) { this.embedded = embedded; return this; } @@ -87,12 +89,12 @@ public EmbeddedEditUrlResponseEmbedded getEmbedded() { @JsonProperty(JSON_PROPERTY_EMBEDDED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmbedded(EmbeddedEditUrlResponseEmbedded embedded) { + public void setEmbedded(@jakarta.annotation.Nonnull EmbeddedEditUrlResponseEmbedded embedded) { this.embedded = embedded; } - public EmbeddedEditUrlResponse warnings(List warnings) { + public EmbeddedEditUrlResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java index c990405..0518d5e 100644 --- a/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java +++ b/src/main/java/com/dropbox/sign/model/EmbeddedEditUrlResponseEmbedded.java @@ -36,13 +36,15 @@ EmbeddedEditUrlResponseEmbedded.JSON_PROPERTY_EDIT_URL, EmbeddedEditUrlResponseEmbedded.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EmbeddedEditUrlResponseEmbedded { public static final String JSON_PROPERTY_EDIT_URL = "edit_url"; + @jakarta.annotation.Nullable private String editUrl; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public EmbeddedEditUrlResponseEmbedded() { @@ -63,7 +65,7 @@ static public EmbeddedEditUrlResponseEmbedded init(HashMap data) throws Exceptio ); } - public EmbeddedEditUrlResponseEmbedded editUrl(String editUrl) { + public EmbeddedEditUrlResponseEmbedded editUrl(@jakarta.annotation.Nullable String editUrl) { this.editUrl = editUrl; return this; } @@ -83,12 +85,12 @@ public String getEditUrl() { @JsonProperty(JSON_PROPERTY_EDIT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditUrl(String editUrl) { + public void setEditUrl(@jakarta.annotation.Nullable String editUrl) { this.editUrl = editUrl; } - public EmbeddedEditUrlResponseEmbedded expiresAt(Integer expiresAt) { + public EmbeddedEditUrlResponseEmbedded expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -108,7 +110,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java b/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java index 3455fe0..0ac9ccd 100644 --- a/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java +++ b/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponse.java @@ -40,13 +40,15 @@ EmbeddedSignUrlResponse.JSON_PROPERTY_EMBEDDED, EmbeddedSignUrlResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EmbeddedSignUrlResponse { public static final String JSON_PROPERTY_EMBEDDED = "embedded"; + @jakarta.annotation.Nonnull private EmbeddedSignUrlResponseEmbedded embedded; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public EmbeddedSignUrlResponse() { @@ -67,7 +69,7 @@ static public EmbeddedSignUrlResponse init(HashMap data) throws Exception { ); } - public EmbeddedSignUrlResponse embedded(EmbeddedSignUrlResponseEmbedded embedded) { + public EmbeddedSignUrlResponse embedded(@jakarta.annotation.Nonnull EmbeddedSignUrlResponseEmbedded embedded) { this.embedded = embedded; return this; } @@ -87,12 +89,12 @@ public EmbeddedSignUrlResponseEmbedded getEmbedded() { @JsonProperty(JSON_PROPERTY_EMBEDDED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmbedded(EmbeddedSignUrlResponseEmbedded embedded) { + public void setEmbedded(@jakarta.annotation.Nonnull EmbeddedSignUrlResponseEmbedded embedded) { this.embedded = embedded; } - public EmbeddedSignUrlResponse warnings(List warnings) { + public EmbeddedSignUrlResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java b/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java index f88dd63..c06bd38 100644 --- a/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java +++ b/src/main/java/com/dropbox/sign/model/EmbeddedSignUrlResponseEmbedded.java @@ -36,13 +36,15 @@ EmbeddedSignUrlResponseEmbedded.JSON_PROPERTY_SIGN_URL, EmbeddedSignUrlResponseEmbedded.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EmbeddedSignUrlResponseEmbedded { public static final String JSON_PROPERTY_SIGN_URL = "sign_url"; + @jakarta.annotation.Nullable private String signUrl; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public EmbeddedSignUrlResponseEmbedded() { @@ -63,7 +65,7 @@ static public EmbeddedSignUrlResponseEmbedded init(HashMap data) throws Exceptio ); } - public EmbeddedSignUrlResponseEmbedded signUrl(String signUrl) { + public EmbeddedSignUrlResponseEmbedded signUrl(@jakarta.annotation.Nullable String signUrl) { this.signUrl = signUrl; return this; } @@ -83,12 +85,12 @@ public String getSignUrl() { @JsonProperty(JSON_PROPERTY_SIGN_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignUrl(String signUrl) { + public void setSignUrl(@jakarta.annotation.Nullable String signUrl) { this.signUrl = signUrl; } - public EmbeddedSignUrlResponseEmbedded expiresAt(Integer expiresAt) { + public EmbeddedSignUrlResponseEmbedded expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -108,7 +110,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/ErrorResponse.java b/src/main/java/com/dropbox/sign/model/ErrorResponse.java index ea26e45..d905f67 100644 --- a/src/main/java/com/dropbox/sign/model/ErrorResponse.java +++ b/src/main/java/com/dropbox/sign/model/ErrorResponse.java @@ -36,10 +36,11 @@ @JsonPropertyOrder({ ErrorResponse.JSON_PROPERTY_ERROR }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ErrorResponse { public static final String JSON_PROPERTY_ERROR = "error"; + @jakarta.annotation.Nonnull private ErrorResponseError error; public ErrorResponse() { @@ -60,7 +61,7 @@ static public ErrorResponse init(HashMap data) throws Exception { ); } - public ErrorResponse error(ErrorResponseError error) { + public ErrorResponse error(@jakarta.annotation.Nonnull ErrorResponseError error) { this.error = error; return this; } @@ -80,7 +81,7 @@ public ErrorResponseError getError() { @JsonProperty(JSON_PROPERTY_ERROR) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setError(ErrorResponseError error) { + public void setError(@jakarta.annotation.Nonnull ErrorResponseError error) { this.error = error; } diff --git a/src/main/java/com/dropbox/sign/model/ErrorResponseError.java b/src/main/java/com/dropbox/sign/model/ErrorResponseError.java index 2c72770..af87ec4 100644 --- a/src/main/java/com/dropbox/sign/model/ErrorResponseError.java +++ b/src/main/java/com/dropbox/sign/model/ErrorResponseError.java @@ -37,16 +37,19 @@ ErrorResponseError.JSON_PROPERTY_ERROR_NAME, ErrorResponseError.JSON_PROPERTY_ERROR_PATH }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ErrorResponseError { public static final String JSON_PROPERTY_ERROR_MSG = "error_msg"; + @jakarta.annotation.Nonnull private String errorMsg; public static final String JSON_PROPERTY_ERROR_NAME = "error_name"; + @jakarta.annotation.Nonnull private String errorName; public static final String JSON_PROPERTY_ERROR_PATH = "error_path"; + @jakarta.annotation.Nullable private String errorPath; public ErrorResponseError() { @@ -67,7 +70,7 @@ static public ErrorResponseError init(HashMap data) throws Exception { ); } - public ErrorResponseError errorMsg(String errorMsg) { + public ErrorResponseError errorMsg(@jakarta.annotation.Nonnull String errorMsg) { this.errorMsg = errorMsg; return this; } @@ -87,12 +90,12 @@ public String getErrorMsg() { @JsonProperty(JSON_PROPERTY_ERROR_MSG) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setErrorMsg(String errorMsg) { + public void setErrorMsg(@jakarta.annotation.Nonnull String errorMsg) { this.errorMsg = errorMsg; } - public ErrorResponseError errorName(String errorName) { + public ErrorResponseError errorName(@jakarta.annotation.Nonnull String errorName) { this.errorName = errorName; return this; } @@ -112,12 +115,12 @@ public String getErrorName() { @JsonProperty(JSON_PROPERTY_ERROR_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setErrorName(String errorName) { + public void setErrorName(@jakarta.annotation.Nonnull String errorName) { this.errorName = errorName; } - public ErrorResponseError errorPath(String errorPath) { + public ErrorResponseError errorPath(@jakarta.annotation.Nullable String errorPath) { this.errorPath = errorPath; return this; } @@ -137,7 +140,7 @@ public String getErrorPath() { @JsonProperty(JSON_PROPERTY_ERROR_PATH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setErrorPath(String errorPath) { + public void setErrorPath(@jakarta.annotation.Nullable String errorPath) { this.errorPath = errorPath; } diff --git a/src/main/java/com/dropbox/sign/model/EventCallbackRequest.java b/src/main/java/com/dropbox/sign/model/EventCallbackRequest.java index 0307d55..81eb8d0 100644 --- a/src/main/java/com/dropbox/sign/model/EventCallbackRequest.java +++ b/src/main/java/com/dropbox/sign/model/EventCallbackRequest.java @@ -42,19 +42,23 @@ EventCallbackRequest.JSON_PROPERTY_SIGNATURE_REQUEST, EventCallbackRequest.JSON_PROPERTY_TEMPLATE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EventCallbackRequest { public static final String JSON_PROPERTY_EVENT = "event"; + @jakarta.annotation.Nonnull private EventCallbackRequestEvent event; public static final String JSON_PROPERTY_ACCOUNT = "account"; + @jakarta.annotation.Nullable private AccountResponse account; public static final String JSON_PROPERTY_SIGNATURE_REQUEST = "signature_request"; + @jakarta.annotation.Nullable private SignatureRequestResponse signatureRequest; public static final String JSON_PROPERTY_TEMPLATE = "template"; + @jakarta.annotation.Nullable private TemplateResponse template; public EventCallbackRequest() { @@ -75,7 +79,7 @@ static public EventCallbackRequest init(HashMap data) throws Exception { ); } - public EventCallbackRequest event(EventCallbackRequestEvent event) { + public EventCallbackRequest event(@jakarta.annotation.Nonnull EventCallbackRequestEvent event) { this.event = event; return this; } @@ -95,12 +99,12 @@ public EventCallbackRequestEvent getEvent() { @JsonProperty(JSON_PROPERTY_EVENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEvent(EventCallbackRequestEvent event) { + public void setEvent(@jakarta.annotation.Nonnull EventCallbackRequestEvent event) { this.event = event; } - public EventCallbackRequest account(AccountResponse account) { + public EventCallbackRequest account(@jakarta.annotation.Nullable AccountResponse account) { this.account = account; return this; } @@ -120,12 +124,12 @@ public AccountResponse getAccount() { @JsonProperty(JSON_PROPERTY_ACCOUNT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccount(AccountResponse account) { + public void setAccount(@jakarta.annotation.Nullable AccountResponse account) { this.account = account; } - public EventCallbackRequest signatureRequest(SignatureRequestResponse signatureRequest) { + public EventCallbackRequest signatureRequest(@jakarta.annotation.Nullable SignatureRequestResponse signatureRequest) { this.signatureRequest = signatureRequest; return this; } @@ -145,12 +149,12 @@ public SignatureRequestResponse getSignatureRequest() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUEST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureRequest(SignatureRequestResponse signatureRequest) { + public void setSignatureRequest(@jakarta.annotation.Nullable SignatureRequestResponse signatureRequest) { this.signatureRequest = signatureRequest; } - public EventCallbackRequest template(TemplateResponse template) { + public EventCallbackRequest template(@jakarta.annotation.Nullable TemplateResponse template) { this.template = template; return this; } @@ -170,7 +174,7 @@ public TemplateResponse getTemplate() { @JsonProperty(JSON_PROPERTY_TEMPLATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplate(TemplateResponse template) { + public void setTemplate(@jakarta.annotation.Nullable TemplateResponse template) { this.template = template; } diff --git a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java index 583482a..6004304 100644 --- a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java +++ b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEvent.java @@ -39,61 +39,62 @@ EventCallbackRequestEvent.JSON_PROPERTY_EVENT_HASH, EventCallbackRequestEvent.JSON_PROPERTY_EVENT_METADATA }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EventCallbackRequestEvent { public static final String JSON_PROPERTY_EVENT_TIME = "event_time"; + @jakarta.annotation.Nonnull private String eventTime; /** * Type of callback event that was triggered. */ public enum EventTypeEnum { - ACCOUNT_CONFIRMED("account_confirmed"), + ACCOUNT_CONFIRMED(String.valueOf("account_confirmed")), - UNKNOWN_ERROR("unknown_error"), + UNKNOWN_ERROR(String.valueOf("unknown_error")), - FILE_ERROR("file_error"), + FILE_ERROR(String.valueOf("file_error")), - SIGN_URL_INVALID("sign_url_invalid"), + SIGN_URL_INVALID(String.valueOf("sign_url_invalid")), - SIGNATURE_REQUEST_VIEWED("signature_request_viewed"), + SIGNATURE_REQUEST_VIEWED(String.valueOf("signature_request_viewed")), - SIGNATURE_REQUEST_SIGNED("signature_request_signed"), + SIGNATURE_REQUEST_SIGNED(String.valueOf("signature_request_signed")), - SIGNATURE_REQUEST_SENT("signature_request_sent"), + SIGNATURE_REQUEST_SENT(String.valueOf("signature_request_sent")), - SIGNATURE_REQUEST_ALL_SIGNED("signature_request_all_signed"), + SIGNATURE_REQUEST_ALL_SIGNED(String.valueOf("signature_request_all_signed")), - SIGNATURE_REQUEST_EMAIL_BOUNCE("signature_request_email_bounce"), + SIGNATURE_REQUEST_EMAIL_BOUNCE(String.valueOf("signature_request_email_bounce")), - SIGNATURE_REQUEST_REMIND("signature_request_remind"), + SIGNATURE_REQUEST_REMIND(String.valueOf("signature_request_remind")), - SIGNATURE_REQUEST_INCOMPLETE_QES("signature_request_incomplete_qes"), + SIGNATURE_REQUEST_INCOMPLETE_QES(String.valueOf("signature_request_incomplete_qes")), - SIGNATURE_REQUEST_DESTROYED("signature_request_destroyed"), + SIGNATURE_REQUEST_DESTROYED(String.valueOf("signature_request_destroyed")), - SIGNATURE_REQUEST_CANCELED("signature_request_canceled"), + SIGNATURE_REQUEST_CANCELED(String.valueOf("signature_request_canceled")), - SIGNATURE_REQUEST_DOWNLOADABLE("signature_request_downloadable"), + SIGNATURE_REQUEST_DOWNLOADABLE(String.valueOf("signature_request_downloadable")), - SIGNATURE_REQUEST_DECLINED("signature_request_declined"), + SIGNATURE_REQUEST_DECLINED(String.valueOf("signature_request_declined")), - SIGNATURE_REQUEST_REASSIGNED("signature_request_reassigned"), + SIGNATURE_REQUEST_REASSIGNED(String.valueOf("signature_request_reassigned")), - SIGNATURE_REQUEST_INVALID("signature_request_invalid"), + SIGNATURE_REQUEST_INVALID(String.valueOf("signature_request_invalid")), - SIGNATURE_REQUEST_PREPARED("signature_request_prepared"), + SIGNATURE_REQUEST_PREPARED(String.valueOf("signature_request_prepared")), - SIGNATURE_REQUEST_EXPIRED("signature_request_expired"), + SIGNATURE_REQUEST_EXPIRED(String.valueOf("signature_request_expired")), - TEMPLATE_CREATED("template_created"), + TEMPLATE_CREATED(String.valueOf("template_created")), - TEMPLATE_ERROR("template_error"), + TEMPLATE_ERROR(String.valueOf("template_error")), - CALLBACK_TEST("callback_test"), + CALLBACK_TEST(String.valueOf("callback_test")), - SIGNATURE_REQUEST_SIGNER_REMOVED("signature_request_signer_removed"); + SIGNATURE_REQUEST_SIGNER_REMOVED(String.valueOf("signature_request_signer_removed")); private String value; @@ -123,12 +124,15 @@ public static EventTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_EVENT_TYPE = "event_type"; + @jakarta.annotation.Nonnull private EventTypeEnum eventType; public static final String JSON_PROPERTY_EVENT_HASH = "event_hash"; + @jakarta.annotation.Nonnull private String eventHash; public static final String JSON_PROPERTY_EVENT_METADATA = "event_metadata"; + @jakarta.annotation.Nullable private EventCallbackRequestEventMetadata eventMetadata; public EventCallbackRequestEvent() { @@ -149,7 +153,7 @@ static public EventCallbackRequestEvent init(HashMap data) throws Exception { ); } - public EventCallbackRequestEvent eventTime(String eventTime) { + public EventCallbackRequestEvent eventTime(@jakarta.annotation.Nonnull String eventTime) { this.eventTime = eventTime; return this; } @@ -169,12 +173,12 @@ public String getEventTime() { @JsonProperty(JSON_PROPERTY_EVENT_TIME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEventTime(String eventTime) { + public void setEventTime(@jakarta.annotation.Nonnull String eventTime) { this.eventTime = eventTime; } - public EventCallbackRequestEvent eventType(EventTypeEnum eventType) { + public EventCallbackRequestEvent eventType(@jakarta.annotation.Nonnull EventTypeEnum eventType) { this.eventType = eventType; return this; } @@ -194,12 +198,12 @@ public EventTypeEnum getEventType() { @JsonProperty(JSON_PROPERTY_EVENT_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEventType(EventTypeEnum eventType) { + public void setEventType(@jakarta.annotation.Nonnull EventTypeEnum eventType) { this.eventType = eventType; } - public EventCallbackRequestEvent eventHash(String eventHash) { + public EventCallbackRequestEvent eventHash(@jakarta.annotation.Nonnull String eventHash) { this.eventHash = eventHash; return this; } @@ -219,12 +223,12 @@ public String getEventHash() { @JsonProperty(JSON_PROPERTY_EVENT_HASH) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEventHash(String eventHash) { + public void setEventHash(@jakarta.annotation.Nonnull String eventHash) { this.eventHash = eventHash; } - public EventCallbackRequestEvent eventMetadata(EventCallbackRequestEventMetadata eventMetadata) { + public EventCallbackRequestEvent eventMetadata(@jakarta.annotation.Nullable EventCallbackRequestEventMetadata eventMetadata) { this.eventMetadata = eventMetadata; return this; } @@ -244,7 +248,7 @@ public EventCallbackRequestEventMetadata getEventMetadata() { @JsonProperty(JSON_PROPERTY_EVENT_METADATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMetadata(EventCallbackRequestEventMetadata eventMetadata) { + public void setEventMetadata(@jakarta.annotation.Nullable EventCallbackRequestEventMetadata eventMetadata) { this.eventMetadata = eventMetadata; } diff --git a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java index b832ff1..70d002e 100644 --- a/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java +++ b/src/main/java/com/dropbox/sign/model/EventCallbackRequestEventMetadata.java @@ -38,19 +38,23 @@ EventCallbackRequestEventMetadata.JSON_PROPERTY_REPORTED_FOR_APP_ID, EventCallbackRequestEventMetadata.JSON_PROPERTY_EVENT_MESSAGE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class EventCallbackRequestEventMetadata { public static final String JSON_PROPERTY_RELATED_SIGNATURE_ID = "related_signature_id"; + @jakarta.annotation.Nullable private String relatedSignatureId; public static final String JSON_PROPERTY_REPORTED_FOR_ACCOUNT_ID = "reported_for_account_id"; + @jakarta.annotation.Nullable private String reportedForAccountId; public static final String JSON_PROPERTY_REPORTED_FOR_APP_ID = "reported_for_app_id"; + @jakarta.annotation.Nullable private String reportedForAppId; public static final String JSON_PROPERTY_EVENT_MESSAGE = "event_message"; + @jakarta.annotation.Nullable private String eventMessage; public EventCallbackRequestEventMetadata() { @@ -71,7 +75,7 @@ static public EventCallbackRequestEventMetadata init(HashMap data) throws Except ); } - public EventCallbackRequestEventMetadata relatedSignatureId(String relatedSignatureId) { + public EventCallbackRequestEventMetadata relatedSignatureId(@jakarta.annotation.Nullable String relatedSignatureId) { this.relatedSignatureId = relatedSignatureId; return this; } @@ -91,12 +95,12 @@ public String getRelatedSignatureId() { @JsonProperty(JSON_PROPERTY_RELATED_SIGNATURE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRelatedSignatureId(String relatedSignatureId) { + public void setRelatedSignatureId(@jakarta.annotation.Nullable String relatedSignatureId) { this.relatedSignatureId = relatedSignatureId; } - public EventCallbackRequestEventMetadata reportedForAccountId(String reportedForAccountId) { + public EventCallbackRequestEventMetadata reportedForAccountId(@jakarta.annotation.Nullable String reportedForAccountId) { this.reportedForAccountId = reportedForAccountId; return this; } @@ -116,12 +120,12 @@ public String getReportedForAccountId() { @JsonProperty(JSON_PROPERTY_REPORTED_FOR_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReportedForAccountId(String reportedForAccountId) { + public void setReportedForAccountId(@jakarta.annotation.Nullable String reportedForAccountId) { this.reportedForAccountId = reportedForAccountId; } - public EventCallbackRequestEventMetadata reportedForAppId(String reportedForAppId) { + public EventCallbackRequestEventMetadata reportedForAppId(@jakarta.annotation.Nullable String reportedForAppId) { this.reportedForAppId = reportedForAppId; return this; } @@ -141,12 +145,12 @@ public String getReportedForAppId() { @JsonProperty(JSON_PROPERTY_REPORTED_FOR_APP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReportedForAppId(String reportedForAppId) { + public void setReportedForAppId(@jakarta.annotation.Nullable String reportedForAppId) { this.reportedForAppId = reportedForAppId; } - public EventCallbackRequestEventMetadata eventMessage(String eventMessage) { + public EventCallbackRequestEventMetadata eventMessage(@jakarta.annotation.Nullable String eventMessage) { this.eventMessage = eventMessage; return this; } @@ -166,7 +170,7 @@ public String getEventMessage() { @JsonProperty(JSON_PROPERTY_EVENT_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEventMessage(String eventMessage) { + public void setEventMessage(@jakarta.annotation.Nullable String eventMessage) { this.eventMessage = eventMessage; } diff --git a/src/main/java/com/dropbox/sign/model/FaxGetResponse.java b/src/main/java/com/dropbox/sign/model/FaxGetResponse.java index 7b08c8e..958f088 100644 --- a/src/main/java/com/dropbox/sign/model/FaxGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxGetResponse.java @@ -40,13 +40,15 @@ FaxGetResponse.JSON_PROPERTY_FAX, FaxGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxGetResponse { public static final String JSON_PROPERTY_FAX = "fax"; + @jakarta.annotation.Nonnull private FaxResponse fax; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public FaxGetResponse() { @@ -67,7 +69,7 @@ static public FaxGetResponse init(HashMap data) throws Exception { ); } - public FaxGetResponse fax(FaxResponse fax) { + public FaxGetResponse fax(@jakarta.annotation.Nonnull FaxResponse fax) { this.fax = fax; return this; } @@ -87,12 +89,12 @@ public FaxResponse getFax() { @JsonProperty(JSON_PROPERTY_FAX) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFax(FaxResponse fax) { + public void setFax(@jakarta.annotation.Nonnull FaxResponse fax) { this.fax = fax; } - public FaxGetResponse warnings(List warnings) { + public FaxGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java b/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java index 99f972a..779e870 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineAddUserRequest.java @@ -37,16 +37,19 @@ FaxLineAddUserRequest.JSON_PROPERTY_ACCOUNT_ID, FaxLineAddUserRequest.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineAddUserRequest { public static final String JSON_PROPERTY_NUMBER = "number"; + @jakarta.annotation.Nonnull private String number; public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public FaxLineAddUserRequest() { @@ -67,13 +70,13 @@ static public FaxLineAddUserRequest init(HashMap data) throws Exception { ); } - public FaxLineAddUserRequest number(String number) { + public FaxLineAddUserRequest number(@jakarta.annotation.Nonnull String number) { this.number = number; return this; } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -87,12 +90,12 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setNumber(String number) { + public void setNumber(@jakarta.annotation.Nonnull String number) { this.number = number; } - public FaxLineAddUserRequest accountId(String accountId) { + public FaxLineAddUserRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -112,12 +115,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public FaxLineAddUserRequest emailAddress(String emailAddress) { + public FaxLineAddUserRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -137,7 +140,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineAreaCodeGetResponse.java b/src/main/java/com/dropbox/sign/model/FaxLineAreaCodeGetResponse.java index b4b2bbb..fec49f8 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineAreaCodeGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineAreaCodeGetResponse.java @@ -37,10 +37,11 @@ @JsonPropertyOrder({ FaxLineAreaCodeGetResponse.JSON_PROPERTY_AREA_CODES }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineAreaCodeGetResponse { public static final String JSON_PROPERTY_AREA_CODES = "area_codes"; + @jakarta.annotation.Nonnull private List areaCodes = new ArrayList<>(); public FaxLineAreaCodeGetResponse() { @@ -61,7 +62,7 @@ static public FaxLineAreaCodeGetResponse init(HashMap data) throws Exception { ); } - public FaxLineAreaCodeGetResponse areaCodes(List areaCodes) { + public FaxLineAreaCodeGetResponse areaCodes(@jakarta.annotation.Nonnull List areaCodes) { this.areaCodes = areaCodes; return this; } @@ -89,7 +90,7 @@ public List getAreaCodes() { @JsonProperty(JSON_PROPERTY_AREA_CODES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAreaCodes(List areaCodes) { + public void setAreaCodes(@jakarta.annotation.Nonnull List areaCodes) { this.areaCodes = areaCodes; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java b/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java index 7d23eac..cdf5270 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineCreateRequest.java @@ -38,21 +38,22 @@ FaxLineCreateRequest.JSON_PROPERTY_CITY, FaxLineCreateRequest.JSON_PROPERTY_ACCOUNT_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineCreateRequest { public static final String JSON_PROPERTY_AREA_CODE = "area_code"; + @jakarta.annotation.Nonnull private Integer areaCode; /** - * Country + * Country of the area code */ public enum CountryEnum { - CA("CA"), + CA(String.valueOf("CA")), - US("US"), + US(String.valueOf("US")), - UK("UK"); + UK(String.valueOf("UK")); private String value; @@ -82,12 +83,15 @@ public static CountryEnum fromValue(String value) { } public static final String JSON_PROPERTY_COUNTRY = "country"; + @jakarta.annotation.Nonnull private CountryEnum country; public static final String JSON_PROPERTY_CITY = "city"; + @jakarta.annotation.Nullable private String city; public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public FaxLineCreateRequest() { @@ -108,13 +112,13 @@ static public FaxLineCreateRequest init(HashMap data) throws Exception { ); } - public FaxLineCreateRequest areaCode(Integer areaCode) { + public FaxLineCreateRequest areaCode(@jakarta.annotation.Nonnull Integer areaCode) { this.areaCode = areaCode; return this; } /** - * Area code + * Area code of the new Fax Line * @return areaCode */ @jakarta.annotation.Nonnull @@ -128,18 +132,18 @@ public Integer getAreaCode() { @JsonProperty(JSON_PROPERTY_AREA_CODE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setAreaCode(Integer areaCode) { + public void setAreaCode(@jakarta.annotation.Nonnull Integer areaCode) { this.areaCode = areaCode; } - public FaxLineCreateRequest country(CountryEnum country) { + public FaxLineCreateRequest country(@jakarta.annotation.Nonnull CountryEnum country) { this.country = country; return this; } /** - * Country + * Country of the area code * @return country */ @jakarta.annotation.Nonnull @@ -153,18 +157,18 @@ public CountryEnum getCountry() { @JsonProperty(JSON_PROPERTY_COUNTRY) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCountry(CountryEnum country) { + public void setCountry(@jakarta.annotation.Nonnull CountryEnum country) { this.country = country; } - public FaxLineCreateRequest city(String city) { + public FaxLineCreateRequest city(@jakarta.annotation.Nullable String city) { this.city = city; return this; } /** - * City + * City of the area code * @return city */ @jakarta.annotation.Nullable @@ -178,18 +182,18 @@ public String getCity() { @JsonProperty(JSON_PROPERTY_CITY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCity(String city) { + public void setCity(@jakarta.annotation.Nullable String city) { this.city = city; } - public FaxLineCreateRequest accountId(String accountId) { + public FaxLineCreateRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } /** - * Account ID + * Account ID of the account that will be assigned this new Fax Line * @return accountId */ @jakarta.annotation.Nullable @@ -203,7 +207,7 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java b/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java index c7876dd..21c1c35 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineDeleteRequest.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ FaxLineDeleteRequest.JSON_PROPERTY_NUMBER }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineDeleteRequest { public static final String JSON_PROPERTY_NUMBER = "number"; + @jakarta.annotation.Nonnull private String number; public FaxLineDeleteRequest() { @@ -59,13 +60,13 @@ static public FaxLineDeleteRequest init(HashMap data) throws Exception { ); } - public FaxLineDeleteRequest number(String number) { + public FaxLineDeleteRequest number(@jakarta.annotation.Nonnull String number) { this.number = number; return this; } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -79,7 +80,7 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setNumber(String number) { + public void setNumber(@jakarta.annotation.Nonnull String number) { this.number = number; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineListResponse.java b/src/main/java/com/dropbox/sign/model/FaxLineListResponse.java index 33163a2..5454fa3 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineListResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineListResponse.java @@ -42,16 +42,19 @@ FaxLineListResponse.JSON_PROPERTY_FAX_LINES, FaxLineListResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineListResponse { public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_FAX_LINES = "fax_lines"; + @jakarta.annotation.Nonnull private List faxLines = new ArrayList<>(); public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private WarningResponse warnings; public FaxLineListResponse() { @@ -72,7 +75,7 @@ static public FaxLineListResponse init(HashMap data) throws Exception { ); } - public FaxLineListResponse listInfo(ListInfoResponse listInfo) { + public FaxLineListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -92,12 +95,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public FaxLineListResponse faxLines(List faxLines) { + public FaxLineListResponse faxLines(@jakarta.annotation.Nonnull List faxLines) { this.faxLines = faxLines; return this; } @@ -125,12 +128,12 @@ public List getFaxLines() { @JsonProperty(JSON_PROPERTY_FAX_LINES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFaxLines(List faxLines) { + public void setFaxLines(@jakarta.annotation.Nonnull List faxLines) { this.faxLines = faxLines; } - public FaxLineListResponse warnings(WarningResponse warnings) { + public FaxLineListResponse warnings(@jakarta.annotation.Nullable WarningResponse warnings) { this.warnings = warnings; return this; } @@ -150,7 +153,7 @@ public WarningResponse getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(WarningResponse warnings) { + public void setWarnings(@jakarta.annotation.Nullable WarningResponse warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java b/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java index 747853a..6ab55bb 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineRemoveUserRequest.java @@ -37,16 +37,19 @@ FaxLineRemoveUserRequest.JSON_PROPERTY_ACCOUNT_ID, FaxLineRemoveUserRequest.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineRemoveUserRequest { public static final String JSON_PROPERTY_NUMBER = "number"; + @jakarta.annotation.Nonnull private String number; public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public FaxLineRemoveUserRequest() { @@ -67,13 +70,13 @@ static public FaxLineRemoveUserRequest init(HashMap data) throws Exception { ); } - public FaxLineRemoveUserRequest number(String number) { + public FaxLineRemoveUserRequest number(@jakarta.annotation.Nonnull String number) { this.number = number; return this; } /** - * The Fax Line number. + * The Fax Line number * @return number */ @jakarta.annotation.Nonnull @@ -87,18 +90,18 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setNumber(String number) { + public void setNumber(@jakarta.annotation.Nonnull String number) { this.number = number; } - public FaxLineRemoveUserRequest accountId(String accountId) { + public FaxLineRemoveUserRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } /** - * Account ID + * Account ID of the user to remove access * @return accountId */ @jakarta.annotation.Nullable @@ -112,18 +115,18 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public FaxLineRemoveUserRequest emailAddress(String emailAddress) { + public FaxLineRemoveUserRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } /** - * Email address + * Email address of the user to remove access * @return emailAddress */ @jakarta.annotation.Nullable @@ -137,7 +140,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineResponse.java b/src/main/java/com/dropbox/sign/model/FaxLineResponse.java index 8fae8ca..5430836 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineResponse.java @@ -38,13 +38,15 @@ FaxLineResponse.JSON_PROPERTY_FAX_LINE, FaxLineResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineResponse { public static final String JSON_PROPERTY_FAX_LINE = "fax_line"; + @jakarta.annotation.Nonnull private FaxLineResponseFaxLine faxLine; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private WarningResponse warnings; public FaxLineResponse() { @@ -65,7 +67,7 @@ static public FaxLineResponse init(HashMap data) throws Exception { ); } - public FaxLineResponse faxLine(FaxLineResponseFaxLine faxLine) { + public FaxLineResponse faxLine(@jakarta.annotation.Nonnull FaxLineResponseFaxLine faxLine) { this.faxLine = faxLine; return this; } @@ -85,12 +87,12 @@ public FaxLineResponseFaxLine getFaxLine() { @JsonProperty(JSON_PROPERTY_FAX_LINE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFaxLine(FaxLineResponseFaxLine faxLine) { + public void setFaxLine(@jakarta.annotation.Nonnull FaxLineResponseFaxLine faxLine) { this.faxLine = faxLine; } - public FaxLineResponse warnings(WarningResponse warnings) { + public FaxLineResponse warnings(@jakarta.annotation.Nullable WarningResponse warnings) { this.warnings = warnings; return this; } @@ -110,7 +112,7 @@ public WarningResponse getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(WarningResponse warnings) { + public void setWarnings(@jakarta.annotation.Nullable WarningResponse warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java b/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java index 9b6b8c8..a5aa7c7 100644 --- a/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java +++ b/src/main/java/com/dropbox/sign/model/FaxLineResponseFaxLine.java @@ -41,19 +41,23 @@ FaxLineResponseFaxLine.JSON_PROPERTY_UPDATED_AT, FaxLineResponseFaxLine.JSON_PROPERTY_ACCOUNTS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxLineResponseFaxLine { public static final String JSON_PROPERTY_NUMBER = "number"; + @jakarta.annotation.Nullable private String number; public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nullable private Integer createdAt; public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + @jakarta.annotation.Nullable private Integer updatedAt; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + @jakarta.annotation.Nullable private List accounts = null; public FaxLineResponseFaxLine() { @@ -74,7 +78,7 @@ static public FaxLineResponseFaxLine init(HashMap data) throws Exception { ); } - public FaxLineResponseFaxLine number(String number) { + public FaxLineResponseFaxLine number(@jakarta.annotation.Nullable String number) { this.number = number; return this; } @@ -94,12 +98,12 @@ public String getNumber() { @JsonProperty(JSON_PROPERTY_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumber(String number) { + public void setNumber(@jakarta.annotation.Nullable String number) { this.number = number; } - public FaxLineResponseFaxLine createdAt(Integer createdAt) { + public FaxLineResponseFaxLine createdAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; return this; } @@ -119,12 +123,12 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; } - public FaxLineResponseFaxLine updatedAt(Integer updatedAt) { + public FaxLineResponseFaxLine updatedAt(@jakarta.annotation.Nullable Integer updatedAt) { this.updatedAt = updatedAt; return this; } @@ -144,12 +148,12 @@ public Integer getUpdatedAt() { @JsonProperty(JSON_PROPERTY_UPDATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { + public void setUpdatedAt(@jakarta.annotation.Nullable Integer updatedAt) { this.updatedAt = updatedAt; } - public FaxLineResponseFaxLine accounts(List accounts) { + public FaxLineResponseFaxLine accounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; return this; } @@ -177,7 +181,7 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { + public void setAccounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; } diff --git a/src/main/java/com/dropbox/sign/model/FaxListResponse.java b/src/main/java/com/dropbox/sign/model/FaxListResponse.java index 13c0d94..b545909 100644 --- a/src/main/java/com/dropbox/sign/model/FaxListResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxListResponse.java @@ -40,13 +40,15 @@ FaxListResponse.JSON_PROPERTY_FAXES, FaxListResponse.JSON_PROPERTY_LIST_INFO }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxListResponse { public static final String JSON_PROPERTY_FAXES = "faxes"; + @jakarta.annotation.Nonnull private List faxes = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public FaxListResponse() { @@ -67,7 +69,7 @@ static public FaxListResponse init(HashMap data) throws Exception { ); } - public FaxListResponse faxes(List faxes) { + public FaxListResponse faxes(@jakarta.annotation.Nonnull List faxes) { this.faxes = faxes; return this; } @@ -95,12 +97,12 @@ public List getFaxes() { @JsonProperty(JSON_PROPERTY_FAXES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFaxes(List faxes) { + public void setFaxes(@jakarta.annotation.Nonnull List faxes) { this.faxes = faxes; } - public FaxListResponse listInfo(ListInfoResponse listInfo) { + public FaxListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -120,7 +122,7 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } diff --git a/src/main/java/com/dropbox/sign/model/FaxResponse.java b/src/main/java/com/dropbox/sign/model/FaxResponse.java index 9d64e25..156435e 100644 --- a/src/main/java/com/dropbox/sign/model/FaxResponse.java +++ b/src/main/java/com/dropbox/sign/model/FaxResponse.java @@ -50,40 +50,51 @@ FaxResponse.JSON_PROPERTY_MESSAGE, FaxResponse.JSON_PROPERTY_FINAL_COPY_URI }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxResponse { public static final String JSON_PROPERTY_FAX_ID = "fax_id"; + @jakarta.annotation.Nonnull private String faxId; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nonnull private String title; public static final String JSON_PROPERTY_ORIGINAL_TITLE = "original_title"; + @jakarta.annotation.Nonnull private String originalTitle; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nonnull private Map metadata = new HashMap<>(); public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nonnull private Integer createdAt; public static final String JSON_PROPERTY_SENDER = "sender"; + @jakarta.annotation.Nonnull private String sender; public static final String JSON_PROPERTY_FILES_URL = "files_url"; + @jakarta.annotation.Nonnull private String filesUrl; public static final String JSON_PROPERTY_TRANSMISSIONS = "transmissions"; + @jakarta.annotation.Nonnull private List transmissions = new ArrayList<>(); public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_FINAL_COPY_URI = "final_copy_uri"; + @jakarta.annotation.Nullable private String finalCopyUri; public FaxResponse() { @@ -104,7 +115,7 @@ static public FaxResponse init(HashMap data) throws Exception { ); } - public FaxResponse faxId(String faxId) { + public FaxResponse faxId(@jakarta.annotation.Nonnull String faxId) { this.faxId = faxId; return this; } @@ -124,12 +135,12 @@ public String getFaxId() { @JsonProperty(JSON_PROPERTY_FAX_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFaxId(String faxId) { + public void setFaxId(@jakarta.annotation.Nonnull String faxId) { this.faxId = faxId; } - public FaxResponse title(String title) { + public FaxResponse title(@jakarta.annotation.Nonnull String title) { this.title = title; return this; } @@ -149,12 +160,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nonnull String title) { this.title = title; } - public FaxResponse originalTitle(String originalTitle) { + public FaxResponse originalTitle(@jakarta.annotation.Nonnull String originalTitle) { this.originalTitle = originalTitle; return this; } @@ -174,12 +185,12 @@ public String getOriginalTitle() { @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOriginalTitle(String originalTitle) { + public void setOriginalTitle(@jakarta.annotation.Nonnull String originalTitle) { this.originalTitle = originalTitle; } - public FaxResponse metadata(Map metadata) { + public FaxResponse metadata(@jakarta.annotation.Nonnull Map metadata) { this.metadata = metadata; return this; } @@ -207,12 +218,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.ALWAYS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nonnull Map metadata) { this.metadata = metadata; } - public FaxResponse createdAt(Integer createdAt) { + public FaxResponse createdAt(@jakarta.annotation.Nonnull Integer createdAt) { this.createdAt = createdAt; return this; } @@ -232,12 +243,12 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nonnull Integer createdAt) { this.createdAt = createdAt; } - public FaxResponse sender(String sender) { + public FaxResponse sender(@jakarta.annotation.Nonnull String sender) { this.sender = sender; return this; } @@ -257,12 +268,12 @@ public String getSender() { @JsonProperty(JSON_PROPERTY_SENDER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSender(String sender) { + public void setSender(@jakarta.annotation.Nonnull String sender) { this.sender = sender; } - public FaxResponse filesUrl(String filesUrl) { + public FaxResponse filesUrl(@jakarta.annotation.Nonnull String filesUrl) { this.filesUrl = filesUrl; return this; } @@ -282,12 +293,12 @@ public String getFilesUrl() { @JsonProperty(JSON_PROPERTY_FILES_URL) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFilesUrl(String filesUrl) { + public void setFilesUrl(@jakarta.annotation.Nonnull String filesUrl) { this.filesUrl = filesUrl; } - public FaxResponse transmissions(List transmissions) { + public FaxResponse transmissions(@jakarta.annotation.Nonnull List transmissions) { this.transmissions = transmissions; return this; } @@ -315,12 +326,12 @@ public List getTransmissions() { @JsonProperty(JSON_PROPERTY_TRANSMISSIONS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTransmissions(List transmissions) { + public void setTransmissions(@jakarta.annotation.Nonnull List transmissions) { this.transmissions = transmissions; } - public FaxResponse subject(String subject) { + public FaxResponse subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -340,12 +351,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public FaxResponse message(String message) { + public FaxResponse message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -365,12 +376,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public FaxResponse finalCopyUri(String finalCopyUri) { + public FaxResponse finalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; return this; } @@ -390,7 +401,7 @@ public String getFinalCopyUri() { @JsonProperty(JSON_PROPERTY_FINAL_COPY_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFinalCopyUri(String finalCopyUri) { + public void setFinalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; } diff --git a/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java b/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java index d53176b..2b350da 100644 --- a/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java +++ b/src/main/java/com/dropbox/sign/model/FaxResponseTransmission.java @@ -37,31 +37,32 @@ FaxResponseTransmission.JSON_PROPERTY_STATUS_CODE, FaxResponseTransmission.JSON_PROPERTY_SENT_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxResponseTransmission { public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + @jakarta.annotation.Nonnull private String recipient; /** * Fax Transmission Status Code */ public enum StatusCodeEnum { - SUCCESS("success"), + SUCCESS(String.valueOf("success")), - TRANSMITTING("transmitting"), + TRANSMITTING(String.valueOf("transmitting")), - ERROR_COULD_NOT_FAX("error_could_not_fax"), + ERROR_COULD_NOT_FAX(String.valueOf("error_could_not_fax")), - ERROR_UNKNOWN("error_unknown"), + ERROR_UNKNOWN(String.valueOf("error_unknown")), - ERROR_BUSY("error_busy"), + ERROR_BUSY(String.valueOf("error_busy")), - ERROR_NO_ANSWER("error_no_answer"), + ERROR_NO_ANSWER(String.valueOf("error_no_answer")), - ERROR_DISCONNECTED("error_disconnected"), + ERROR_DISCONNECTED(String.valueOf("error_disconnected")), - ERROR_BAD_DESTINATION("error_bad_destination"); + ERROR_BAD_DESTINATION(String.valueOf("error_bad_destination")); private String value; @@ -91,9 +92,11 @@ public static StatusCodeEnum fromValue(String value) { } public static final String JSON_PROPERTY_STATUS_CODE = "status_code"; + @jakarta.annotation.Nonnull private StatusCodeEnum statusCode; public static final String JSON_PROPERTY_SENT_AT = "sent_at"; + @jakarta.annotation.Nullable private Integer sentAt; public FaxResponseTransmission() { @@ -114,7 +117,7 @@ static public FaxResponseTransmission init(HashMap data) throws Exception { ); } - public FaxResponseTransmission recipient(String recipient) { + public FaxResponseTransmission recipient(@jakarta.annotation.Nonnull String recipient) { this.recipient = recipient; return this; } @@ -134,12 +137,12 @@ public String getRecipient() { @JsonProperty(JSON_PROPERTY_RECIPIENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRecipient(String recipient) { + public void setRecipient(@jakarta.annotation.Nonnull String recipient) { this.recipient = recipient; } - public FaxResponseTransmission statusCode(StatusCodeEnum statusCode) { + public FaxResponseTransmission statusCode(@jakarta.annotation.Nonnull StatusCodeEnum statusCode) { this.statusCode = statusCode; return this; } @@ -159,12 +162,12 @@ public StatusCodeEnum getStatusCode() { @JsonProperty(JSON_PROPERTY_STATUS_CODE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setStatusCode(StatusCodeEnum statusCode) { + public void setStatusCode(@jakarta.annotation.Nonnull StatusCodeEnum statusCode) { this.statusCode = statusCode; } - public FaxResponseTransmission sentAt(Integer sentAt) { + public FaxResponseTransmission sentAt(@jakarta.annotation.Nullable Integer sentAt) { this.sentAt = sentAt; return this; } @@ -184,7 +187,7 @@ public Integer getSentAt() { @JsonProperty(JSON_PROPERTY_SENT_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSentAt(Integer sentAt) { + public void setSentAt(@jakarta.annotation.Nullable Integer sentAt) { this.sentAt = sentAt; } diff --git a/src/main/java/com/dropbox/sign/model/FaxSendRequest.java b/src/main/java/com/dropbox/sign/model/FaxSendRequest.java index bb4a6e8..2978a4d 100644 --- a/src/main/java/com/dropbox/sign/model/FaxSendRequest.java +++ b/src/main/java/com/dropbox/sign/model/FaxSendRequest.java @@ -46,34 +46,43 @@ FaxSendRequest.JSON_PROPERTY_COVER_PAGE_MESSAGE, FaxSendRequest.JSON_PROPERTY_TITLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FaxSendRequest { public static final String JSON_PROPERTY_RECIPIENT = "recipient"; + @jakarta.annotation.Nonnull private String recipient; public static final String JSON_PROPERTY_SENDER = "sender"; + @jakarta.annotation.Nullable private String sender; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_COVER_PAGE_TO = "cover_page_to"; + @jakarta.annotation.Nullable private String coverPageTo; public static final String JSON_PROPERTY_COVER_PAGE_FROM = "cover_page_from"; + @jakarta.annotation.Nullable private String coverPageFrom; public static final String JSON_PROPERTY_COVER_PAGE_MESSAGE = "cover_page_message"; + @jakarta.annotation.Nullable private String coverPageMessage; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public FaxSendRequest() { @@ -94,13 +103,13 @@ static public FaxSendRequest init(HashMap data) throws Exception { ); } - public FaxSendRequest recipient(String recipient) { + public FaxSendRequest recipient(@jakarta.annotation.Nonnull String recipient) { this.recipient = recipient; return this; } /** - * Fax Send To Recipient + * Recipient of the fax Can be a phone number in E.164 format or email address * @return recipient */ @jakarta.annotation.Nonnull @@ -114,12 +123,12 @@ public String getRecipient() { @JsonProperty(JSON_PROPERTY_RECIPIENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRecipient(String recipient) { + public void setRecipient(@jakarta.annotation.Nonnull String recipient) { this.recipient = recipient; } - public FaxSendRequest sender(String sender) { + public FaxSendRequest sender(@jakarta.annotation.Nullable String sender) { this.sender = sender; return this; } @@ -139,12 +148,12 @@ public String getSender() { @JsonProperty(JSON_PROPERTY_SENDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSender(String sender) { + public void setSender(@jakarta.annotation.Nullable String sender) { this.sender = sender; } - public FaxSendRequest files(List files) { + public FaxSendRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -158,7 +167,7 @@ public FaxSendRequest addFilesItem(File filesItem) { } /** - * Fax File to Send + * Use `files[]` to indicate the uploaded file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return files */ @jakarta.annotation.Nullable @@ -172,12 +181,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public FaxSendRequest fileUrls(List fileUrls) { + public FaxSendRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -191,7 +200,7 @@ public FaxSendRequest addFileUrlsItem(String fileUrlsItem) { } /** - * Fax File URL to Send + * Use `file_urls[]` to have Dropbox Fax download the file(s) to fax This endpoint requires either **files** or **file_urls[]**, but not both. * @return fileUrls */ @jakarta.annotation.Nullable @@ -205,12 +214,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public FaxSendRequest testMode(Boolean testMode) { + public FaxSendRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -230,18 +239,18 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public FaxSendRequest coverPageTo(String coverPageTo) { + public FaxSendRequest coverPageTo(@jakarta.annotation.Nullable String coverPageTo) { this.coverPageTo = coverPageTo; return this; } /** - * Fax Cover Page for Recipient + * Fax cover page recipient information * @return coverPageTo */ @jakarta.annotation.Nullable @@ -255,18 +264,18 @@ public String getCoverPageTo() { @JsonProperty(JSON_PROPERTY_COVER_PAGE_TO) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCoverPageTo(String coverPageTo) { + public void setCoverPageTo(@jakarta.annotation.Nullable String coverPageTo) { this.coverPageTo = coverPageTo; } - public FaxSendRequest coverPageFrom(String coverPageFrom) { + public FaxSendRequest coverPageFrom(@jakarta.annotation.Nullable String coverPageFrom) { this.coverPageFrom = coverPageFrom; return this; } /** - * Fax Cover Page for Sender + * Fax cover page sender information * @return coverPageFrom */ @jakarta.annotation.Nullable @@ -280,12 +289,12 @@ public String getCoverPageFrom() { @JsonProperty(JSON_PROPERTY_COVER_PAGE_FROM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCoverPageFrom(String coverPageFrom) { + public void setCoverPageFrom(@jakarta.annotation.Nullable String coverPageFrom) { this.coverPageFrom = coverPageFrom; } - public FaxSendRequest coverPageMessage(String coverPageMessage) { + public FaxSendRequest coverPageMessage(@jakarta.annotation.Nullable String coverPageMessage) { this.coverPageMessage = coverPageMessage; return this; } @@ -305,12 +314,12 @@ public String getCoverPageMessage() { @JsonProperty(JSON_PROPERTY_COVER_PAGE_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCoverPageMessage(String coverPageMessage) { + public void setCoverPageMessage(@jakarta.annotation.Nullable String coverPageMessage) { this.coverPageMessage = coverPageMessage; } - public FaxSendRequest title(String title) { + public FaxSendRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -330,7 +339,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } diff --git a/src/main/java/com/dropbox/sign/model/FileResponse.java b/src/main/java/com/dropbox/sign/model/FileResponse.java index 01908c9..aa5f04e 100644 --- a/src/main/java/com/dropbox/sign/model/FileResponse.java +++ b/src/main/java/com/dropbox/sign/model/FileResponse.java @@ -36,13 +36,15 @@ FileResponse.JSON_PROPERTY_FILE_URL, FileResponse.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FileResponse { public static final String JSON_PROPERTY_FILE_URL = "file_url"; + @jakarta.annotation.Nonnull private String fileUrl; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nonnull private Integer expiresAt; public FileResponse() { @@ -63,7 +65,7 @@ static public FileResponse init(HashMap data) throws Exception { ); } - public FileResponse fileUrl(String fileUrl) { + public FileResponse fileUrl(@jakarta.annotation.Nonnull String fileUrl) { this.fileUrl = fileUrl; return this; } @@ -83,12 +85,12 @@ public String getFileUrl() { @JsonProperty(JSON_PROPERTY_FILE_URL) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFileUrl(String fileUrl) { + public void setFileUrl(@jakarta.annotation.Nonnull String fileUrl) { this.fileUrl = fileUrl; } - public FileResponse expiresAt(Integer expiresAt) { + public FileResponse expiresAt(@jakarta.annotation.Nonnull Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -108,7 +110,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nonnull Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java b/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java index 1ef6cdb..fcabc19 100644 --- a/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java +++ b/src/main/java/com/dropbox/sign/model/FileResponseDataUri.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ FileResponseDataUri.JSON_PROPERTY_DATA_URI }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class FileResponseDataUri { public static final String JSON_PROPERTY_DATA_URI = "data_uri"; + @jakarta.annotation.Nonnull private String dataUri; public FileResponseDataUri() { @@ -59,7 +60,7 @@ static public FileResponseDataUri init(HashMap data) throws Exception { ); } - public FileResponseDataUri dataUri(String dataUri) { + public FileResponseDataUri dataUri(@jakarta.annotation.Nonnull String dataUri) { this.dataUri = dataUri; return this; } @@ -79,7 +80,7 @@ public String getDataUri() { @JsonProperty(JSON_PROPERTY_DATA_URI) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDataUri(String dataUri) { + public void setDataUri(@jakarta.annotation.Nonnull String dataUri) { this.dataUri = dataUri; } diff --git a/src/main/java/com/dropbox/sign/model/ListInfoResponse.java b/src/main/java/com/dropbox/sign/model/ListInfoResponse.java index 5a8e00c..c070975 100644 --- a/src/main/java/com/dropbox/sign/model/ListInfoResponse.java +++ b/src/main/java/com/dropbox/sign/model/ListInfoResponse.java @@ -38,19 +38,23 @@ ListInfoResponse.JSON_PROPERTY_PAGE, ListInfoResponse.JSON_PROPERTY_PAGE_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ListInfoResponse { public static final String JSON_PROPERTY_NUM_PAGES = "num_pages"; + @jakarta.annotation.Nullable private Integer numPages; public static final String JSON_PROPERTY_NUM_RESULTS = "num_results"; + @jakarta.annotation.Nullable private Integer numResults; public static final String JSON_PROPERTY_PAGE = "page"; + @jakarta.annotation.Nullable private Integer page; public static final String JSON_PROPERTY_PAGE_SIZE = "page_size"; + @jakarta.annotation.Nullable private Integer pageSize; public ListInfoResponse() { @@ -71,7 +75,7 @@ static public ListInfoResponse init(HashMap data) throws Exception { ); } - public ListInfoResponse numPages(Integer numPages) { + public ListInfoResponse numPages(@jakarta.annotation.Nullable Integer numPages) { this.numPages = numPages; return this; } @@ -91,12 +95,12 @@ public Integer getNumPages() { @JsonProperty(JSON_PROPERTY_NUM_PAGES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumPages(Integer numPages) { + public void setNumPages(@jakarta.annotation.Nullable Integer numPages) { this.numPages = numPages; } - public ListInfoResponse numResults(Integer numResults) { + public ListInfoResponse numResults(@jakarta.annotation.Nullable Integer numResults) { this.numResults = numResults; return this; } @@ -116,12 +120,12 @@ public Integer getNumResults() { @JsonProperty(JSON_PROPERTY_NUM_RESULTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumResults(Integer numResults) { + public void setNumResults(@jakarta.annotation.Nullable Integer numResults) { this.numResults = numResults; } - public ListInfoResponse page(Integer page) { + public ListInfoResponse page(@jakarta.annotation.Nullable Integer page) { this.page = page; return this; } @@ -141,12 +145,12 @@ public Integer getPage() { @JsonProperty(JSON_PROPERTY_PAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPage(Integer page) { + public void setPage(@jakarta.annotation.Nullable Integer page) { this.page = page; } - public ListInfoResponse pageSize(Integer pageSize) { + public ListInfoResponse pageSize(@jakarta.annotation.Nullable Integer pageSize) { this.pageSize = pageSize; return this; } @@ -166,7 +170,7 @@ public Integer getPageSize() { @JsonProperty(JSON_PROPERTY_PAGE_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPageSize(Integer pageSize) { + public void setPageSize(@jakarta.annotation.Nullable Integer pageSize) { this.pageSize = pageSize; } diff --git a/src/main/java/com/dropbox/sign/model/OAuthTokenGenerateRequest.java b/src/main/java/com/dropbox/sign/model/OAuthTokenGenerateRequest.java index 176c0ee..bd6324a 100644 --- a/src/main/java/com/dropbox/sign/model/OAuthTokenGenerateRequest.java +++ b/src/main/java/com/dropbox/sign/model/OAuthTokenGenerateRequest.java @@ -39,22 +39,27 @@ OAuthTokenGenerateRequest.JSON_PROPERTY_GRANT_TYPE, OAuthTokenGenerateRequest.JSON_PROPERTY_STATE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class OAuthTokenGenerateRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + @jakarta.annotation.Nonnull private String clientSecret; public static final String JSON_PROPERTY_CODE = "code"; + @jakarta.annotation.Nonnull private String code; public static final String JSON_PROPERTY_GRANT_TYPE = "grant_type"; + @jakarta.annotation.Nonnull private String grantType = "authorization_code"; public static final String JSON_PROPERTY_STATE = "state"; + @jakarta.annotation.Nonnull private String state; public OAuthTokenGenerateRequest() { @@ -75,7 +80,7 @@ static public OAuthTokenGenerateRequest init(HashMap data) throws Exception { ); } - public OAuthTokenGenerateRequest clientId(String clientId) { + public OAuthTokenGenerateRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -95,12 +100,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public OAuthTokenGenerateRequest clientSecret(String clientSecret) { + public OAuthTokenGenerateRequest clientSecret(@jakarta.annotation.Nonnull String clientSecret) { this.clientSecret = clientSecret; return this; } @@ -120,12 +125,12 @@ public String getClientSecret() { @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientSecret(String clientSecret) { + public void setClientSecret(@jakarta.annotation.Nonnull String clientSecret) { this.clientSecret = clientSecret; } - public OAuthTokenGenerateRequest code(String code) { + public OAuthTokenGenerateRequest code(@jakarta.annotation.Nonnull String code) { this.code = code; return this; } @@ -145,12 +150,12 @@ public String getCode() { @JsonProperty(JSON_PROPERTY_CODE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCode(String code) { + public void setCode(@jakarta.annotation.Nonnull String code) { this.code = code; } - public OAuthTokenGenerateRequest grantType(String grantType) { + public OAuthTokenGenerateRequest grantType(@jakarta.annotation.Nonnull String grantType) { this.grantType = grantType; return this; } @@ -170,12 +175,12 @@ public String getGrantType() { @JsonProperty(JSON_PROPERTY_GRANT_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGrantType(String grantType) { + public void setGrantType(@jakarta.annotation.Nonnull String grantType) { this.grantType = grantType; } - public OAuthTokenGenerateRequest state(String state) { + public OAuthTokenGenerateRequest state(@jakarta.annotation.Nonnull String state) { this.state = state; return this; } @@ -195,7 +200,7 @@ public String getState() { @JsonProperty(JSON_PROPERTY_STATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setState(String state) { + public void setState(@jakarta.annotation.Nonnull String state) { this.state = state; } diff --git a/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java b/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java index fafe689..550d2ee 100644 --- a/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java +++ b/src/main/java/com/dropbox/sign/model/OAuthTokenRefreshRequest.java @@ -38,19 +38,23 @@ OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_ID, OAuthTokenRefreshRequest.JSON_PROPERTY_CLIENT_SECRET }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class OAuthTokenRefreshRequest { public static final String JSON_PROPERTY_GRANT_TYPE = "grant_type"; + @jakarta.annotation.Nonnull private String grantType = "refresh_token"; public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; + @jakarta.annotation.Nonnull private String refreshToken; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CLIENT_SECRET = "client_secret"; + @jakarta.annotation.Nullable private String clientSecret; public OAuthTokenRefreshRequest() { @@ -71,7 +75,7 @@ static public OAuthTokenRefreshRequest init(HashMap data) throws Exception { ); } - public OAuthTokenRefreshRequest grantType(String grantType) { + public OAuthTokenRefreshRequest grantType(@jakarta.annotation.Nonnull String grantType) { this.grantType = grantType; return this; } @@ -91,12 +95,12 @@ public String getGrantType() { @JsonProperty(JSON_PROPERTY_GRANT_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGrantType(String grantType) { + public void setGrantType(@jakarta.annotation.Nonnull String grantType) { this.grantType = grantType; } - public OAuthTokenRefreshRequest refreshToken(String refreshToken) { + public OAuthTokenRefreshRequest refreshToken(@jakarta.annotation.Nonnull String refreshToken) { this.refreshToken = refreshToken; return this; } @@ -116,12 +120,12 @@ public String getRefreshToken() { @JsonProperty(JSON_PROPERTY_REFRESH_TOKEN) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRefreshToken(String refreshToken) { + public void setRefreshToken(@jakarta.annotation.Nonnull String refreshToken) { this.refreshToken = refreshToken; } - public OAuthTokenRefreshRequest clientId(String clientId) { + public OAuthTokenRefreshRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -141,12 +145,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public OAuthTokenRefreshRequest clientSecret(String clientSecret) { + public OAuthTokenRefreshRequest clientSecret(@jakarta.annotation.Nullable String clientSecret) { this.clientSecret = clientSecret; return this; } @@ -166,7 +170,7 @@ public String getClientSecret() { @JsonProperty(JSON_PROPERTY_CLIENT_SECRET) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientSecret(String clientSecret) { + public void setClientSecret(@jakarta.annotation.Nullable String clientSecret) { this.clientSecret = clientSecret; } diff --git a/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java b/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java index 94e7073..8446939 100644 --- a/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java +++ b/src/main/java/com/dropbox/sign/model/OAuthTokenResponse.java @@ -39,22 +39,27 @@ OAuthTokenResponse.JSON_PROPERTY_EXPIRES_IN, OAuthTokenResponse.JSON_PROPERTY_STATE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class OAuthTokenResponse { public static final String JSON_PROPERTY_ACCESS_TOKEN = "access_token"; + @jakarta.annotation.Nullable private String accessToken; public static final String JSON_PROPERTY_TOKEN_TYPE = "token_type"; + @jakarta.annotation.Nullable private String tokenType; public static final String JSON_PROPERTY_REFRESH_TOKEN = "refresh_token"; + @jakarta.annotation.Nullable private String refreshToken; public static final String JSON_PROPERTY_EXPIRES_IN = "expires_in"; + @jakarta.annotation.Nullable private Integer expiresIn; public static final String JSON_PROPERTY_STATE = "state"; + @jakarta.annotation.Nullable private String state; public OAuthTokenResponse() { @@ -75,7 +80,7 @@ static public OAuthTokenResponse init(HashMap data) throws Exception { ); } - public OAuthTokenResponse accessToken(String accessToken) { + public OAuthTokenResponse accessToken(@jakarta.annotation.Nullable String accessToken) { this.accessToken = accessToken; return this; } @@ -95,12 +100,12 @@ public String getAccessToken() { @JsonProperty(JSON_PROPERTY_ACCESS_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccessToken(String accessToken) { + public void setAccessToken(@jakarta.annotation.Nullable String accessToken) { this.accessToken = accessToken; } - public OAuthTokenResponse tokenType(String tokenType) { + public OAuthTokenResponse tokenType(@jakarta.annotation.Nullable String tokenType) { this.tokenType = tokenType; return this; } @@ -120,12 +125,12 @@ public String getTokenType() { @JsonProperty(JSON_PROPERTY_TOKEN_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTokenType(String tokenType) { + public void setTokenType(@jakarta.annotation.Nullable String tokenType) { this.tokenType = tokenType; } - public OAuthTokenResponse refreshToken(String refreshToken) { + public OAuthTokenResponse refreshToken(@jakarta.annotation.Nullable String refreshToken) { this.refreshToken = refreshToken; return this; } @@ -145,12 +150,12 @@ public String getRefreshToken() { @JsonProperty(JSON_PROPERTY_REFRESH_TOKEN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRefreshToken(String refreshToken) { + public void setRefreshToken(@jakarta.annotation.Nullable String refreshToken) { this.refreshToken = refreshToken; } - public OAuthTokenResponse expiresIn(Integer expiresIn) { + public OAuthTokenResponse expiresIn(@jakarta.annotation.Nullable Integer expiresIn) { this.expiresIn = expiresIn; return this; } @@ -170,12 +175,12 @@ public Integer getExpiresIn() { @JsonProperty(JSON_PROPERTY_EXPIRES_IN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresIn(Integer expiresIn) { + public void setExpiresIn(@jakarta.annotation.Nullable Integer expiresIn) { this.expiresIn = expiresIn; } - public OAuthTokenResponse state(String state) { + public OAuthTokenResponse state(@jakarta.annotation.Nullable String state) { this.state = state; return this; } @@ -195,7 +200,7 @@ public String getState() { @JsonProperty(JSON_PROPERTY_STATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setState(String state) { + public void setState(@jakarta.annotation.Nullable String state) { this.state = state; } diff --git a/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java b/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java index bef5001..e88dbb0 100644 --- a/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/ReportCreateRequest.java @@ -39,19 +39,20 @@ ReportCreateRequest.JSON_PROPERTY_REPORT_TYPE, ReportCreateRequest.JSON_PROPERTY_START_DATE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ReportCreateRequest { public static final String JSON_PROPERTY_END_DATE = "end_date"; + @jakarta.annotation.Nonnull private String endDate; /** * Gets or Sets reportType */ public enum ReportTypeEnum { - USER_ACTIVITY("user_activity"), + USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS("document_status"); + DOCUMENT_STATUS(String.valueOf("document_status")); private String value; @@ -81,9 +82,11 @@ public static ReportTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_REPORT_TYPE = "report_type"; + @jakarta.annotation.Nonnull private List reportType = new ArrayList<>(); public static final String JSON_PROPERTY_START_DATE = "start_date"; + @jakarta.annotation.Nonnull private String startDate; public ReportCreateRequest() { @@ -104,7 +107,7 @@ static public ReportCreateRequest init(HashMap data) throws Exception { ); } - public ReportCreateRequest endDate(String endDate) { + public ReportCreateRequest endDate(@jakarta.annotation.Nonnull String endDate) { this.endDate = endDate; return this; } @@ -124,12 +127,12 @@ public String getEndDate() { @JsonProperty(JSON_PROPERTY_END_DATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEndDate(String endDate) { + public void setEndDate(@jakarta.annotation.Nonnull String endDate) { this.endDate = endDate; } - public ReportCreateRequest reportType(List reportType) { + public ReportCreateRequest reportType(@jakarta.annotation.Nonnull List reportType) { this.reportType = reportType; return this; } @@ -157,12 +160,12 @@ public List getReportType() { @JsonProperty(JSON_PROPERTY_REPORT_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setReportType(List reportType) { + public void setReportType(@jakarta.annotation.Nonnull List reportType) { this.reportType = reportType; } - public ReportCreateRequest startDate(String startDate) { + public ReportCreateRequest startDate(@jakarta.annotation.Nonnull String startDate) { this.startDate = startDate; return this; } @@ -182,7 +185,7 @@ public String getStartDate() { @JsonProperty(JSON_PROPERTY_START_DATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setStartDate(String startDate) { + public void setStartDate(@jakarta.annotation.Nonnull String startDate) { this.startDate = startDate; } diff --git a/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java b/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java index 3a042b4..0ca150b 100644 --- a/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java +++ b/src/main/java/com/dropbox/sign/model/ReportCreateResponse.java @@ -40,13 +40,15 @@ ReportCreateResponse.JSON_PROPERTY_REPORT, ReportCreateResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ReportCreateResponse { public static final String JSON_PROPERTY_REPORT = "report"; + @jakarta.annotation.Nonnull private ReportResponse report; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public ReportCreateResponse() { @@ -67,7 +69,7 @@ static public ReportCreateResponse init(HashMap data) throws Exception { ); } - public ReportCreateResponse report(ReportResponse report) { + public ReportCreateResponse report(@jakarta.annotation.Nonnull ReportResponse report) { this.report = report; return this; } @@ -87,12 +89,12 @@ public ReportResponse getReport() { @JsonProperty(JSON_PROPERTY_REPORT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setReport(ReportResponse report) { + public void setReport(@jakarta.annotation.Nonnull ReportResponse report) { this.report = report; } - public ReportCreateResponse warnings(List warnings) { + public ReportCreateResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/ReportResponse.java b/src/main/java/com/dropbox/sign/model/ReportResponse.java index 7491ccb..35770fa 100644 --- a/src/main/java/com/dropbox/sign/model/ReportResponse.java +++ b/src/main/java/com/dropbox/sign/model/ReportResponse.java @@ -40,25 +40,28 @@ ReportResponse.JSON_PROPERTY_END_DATE, ReportResponse.JSON_PROPERTY_REPORT_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class ReportResponse { public static final String JSON_PROPERTY_SUCCESS = "success"; + @jakarta.annotation.Nullable private String success; public static final String JSON_PROPERTY_START_DATE = "start_date"; + @jakarta.annotation.Nullable private String startDate; public static final String JSON_PROPERTY_END_DATE = "end_date"; + @jakarta.annotation.Nullable private String endDate; /** * Gets or Sets reportType */ public enum ReportTypeEnum { - USER_ACTIVITY("user_activity"), + USER_ACTIVITY(String.valueOf("user_activity")), - DOCUMENT_STATUS("document_status"); + DOCUMENT_STATUS(String.valueOf("document_status")); private String value; @@ -88,6 +91,7 @@ public static ReportTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_REPORT_TYPE = "report_type"; + @jakarta.annotation.Nullable private List reportType = null; public ReportResponse() { @@ -108,7 +112,7 @@ static public ReportResponse init(HashMap data) throws Exception { ); } - public ReportResponse success(String success) { + public ReportResponse success(@jakarta.annotation.Nullable String success) { this.success = success; return this; } @@ -128,12 +132,12 @@ public String getSuccess() { @JsonProperty(JSON_PROPERTY_SUCCESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSuccess(String success) { + public void setSuccess(@jakarta.annotation.Nullable String success) { this.success = success; } - public ReportResponse startDate(String startDate) { + public ReportResponse startDate(@jakarta.annotation.Nullable String startDate) { this.startDate = startDate; return this; } @@ -153,12 +157,12 @@ public String getStartDate() { @JsonProperty(JSON_PROPERTY_START_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setStartDate(String startDate) { + public void setStartDate(@jakarta.annotation.Nullable String startDate) { this.startDate = startDate; } - public ReportResponse endDate(String endDate) { + public ReportResponse endDate(@jakarta.annotation.Nullable String endDate) { this.endDate = endDate; return this; } @@ -178,12 +182,12 @@ public String getEndDate() { @JsonProperty(JSON_PROPERTY_END_DATE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndDate(String endDate) { + public void setEndDate(@jakarta.annotation.Nullable String endDate) { this.endDate = endDate; } - public ReportResponse reportType(List reportType) { + public ReportResponse reportType(@jakarta.annotation.Nullable List reportType) { this.reportType = reportType; return this; } @@ -211,7 +215,7 @@ public List getReportType() { @JsonProperty(JSON_PROPERTY_REPORT_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReportType(List reportType) { + public void setReportType(@jakarta.annotation.Nullable List reportType) { this.reportType = reportType; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java index 0e3b1ce..949ddb4 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.java @@ -55,46 +55,59 @@ SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestBulkCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestBulkCreateEmbeddedWithTemplateRequest { public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull private List templateIds = new ArrayList<>(); public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_SIGNER_FILE = "signer_file"; + @jakarta.annotation.Nullable private File signerFile; public static final String JSON_PROPERTY_SIGNER_LIST = "signer_list"; + @jakarta.annotation.Nullable private List signerList = null; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable private List ccs = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public SignatureRequestBulkCreateEmbeddedWithTemplateRequest() { @@ -115,7 +128,7 @@ static public SignatureRequestBulkCreateEmbeddedWithTemplateRequest init(HashMap ); } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest templateIds(List templateIds) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; return this; } @@ -143,12 +156,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest clientId(String clientId) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -168,12 +181,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signerFile(File signerFile) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signerFile(@jakarta.annotation.Nullable File signerFile) { this.signerFile = signerFile; return this; } @@ -193,12 +206,12 @@ public File getSignerFile() { @JsonProperty(JSON_PROPERTY_SIGNER_FILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerFile(File signerFile) { + public void setSignerFile(@jakarta.annotation.Nullable File signerFile) { this.signerFile = signerFile; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signerList(List signerList) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signerList(@jakarta.annotation.Nullable List signerList) { this.signerList = signerList; return this; } @@ -226,12 +239,12 @@ public List getSignerList() { @JsonProperty(JSON_PROPERTY_SIGNER_LIST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerList(List signerList) { + public void setSignerList(@jakarta.annotation.Nullable List signerList) { this.signerList = signerList; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest allowDecline(Boolean allowDecline) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -251,12 +264,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest ccs(List ccs) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; return this; } @@ -284,12 +297,12 @@ public List getCcs() { @JsonProperty(JSON_PROPERTY_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcs(List ccs) { + public void setCcs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest customFields(List customFields) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -317,12 +330,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest message(String message) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -342,12 +355,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest metadata(Map metadata) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -375,12 +388,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -400,12 +413,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest subject(String subject) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -425,12 +438,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest testMode(Boolean testMode) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -450,12 +463,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestBulkCreateEmbeddedWithTemplateRequest title(String title) { + public SignatureRequestBulkCreateEmbeddedWithTemplateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -475,7 +488,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java index f25da05..1efde34 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestBulkSendWithTemplateRequest.java @@ -55,46 +55,59 @@ SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestBulkSendWithTemplateRequest.JSON_PROPERTY_TITLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestBulkSendWithTemplateRequest { public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull private List templateIds = new ArrayList<>(); public static final String JSON_PROPERTY_SIGNER_FILE = "signer_file"; + @jakarta.annotation.Nullable private File signerFile; public static final String JSON_PROPERTY_SIGNER_LIST = "signer_list"; + @jakarta.annotation.Nullable private List signerList = null; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable private List ccs = null; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public SignatureRequestBulkSendWithTemplateRequest() { @@ -115,7 +128,7 @@ static public SignatureRequestBulkSendWithTemplateRequest init(HashMap data) thr ); } - public SignatureRequestBulkSendWithTemplateRequest templateIds(List templateIds) { + public SignatureRequestBulkSendWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; return this; } @@ -143,12 +156,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; } - public SignatureRequestBulkSendWithTemplateRequest signerFile(File signerFile) { + public SignatureRequestBulkSendWithTemplateRequest signerFile(@jakarta.annotation.Nullable File signerFile) { this.signerFile = signerFile; return this; } @@ -168,12 +181,12 @@ public File getSignerFile() { @JsonProperty(JSON_PROPERTY_SIGNER_FILE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerFile(File signerFile) { + public void setSignerFile(@jakarta.annotation.Nullable File signerFile) { this.signerFile = signerFile; } - public SignatureRequestBulkSendWithTemplateRequest signerList(List signerList) { + public SignatureRequestBulkSendWithTemplateRequest signerList(@jakarta.annotation.Nullable List signerList) { this.signerList = signerList; return this; } @@ -201,12 +214,12 @@ public List getSignerList() { @JsonProperty(JSON_PROPERTY_SIGNER_LIST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerList(List signerList) { + public void setSignerList(@jakarta.annotation.Nullable List signerList) { this.signerList = signerList; } - public SignatureRequestBulkSendWithTemplateRequest allowDecline(Boolean allowDecline) { + public SignatureRequestBulkSendWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -226,12 +239,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestBulkSendWithTemplateRequest ccs(List ccs) { + public SignatureRequestBulkSendWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; return this; } @@ -259,12 +272,12 @@ public List getCcs() { @JsonProperty(JSON_PROPERTY_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcs(List ccs) { + public void setCcs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; } - public SignatureRequestBulkSendWithTemplateRequest clientId(String clientId) { + public SignatureRequestBulkSendWithTemplateRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -284,12 +297,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public SignatureRequestBulkSendWithTemplateRequest customFields(List customFields) { + public SignatureRequestBulkSendWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -317,12 +330,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestBulkSendWithTemplateRequest message(String message) { + public SignatureRequestBulkSendWithTemplateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -342,12 +355,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestBulkSendWithTemplateRequest metadata(Map metadata) { + public SignatureRequestBulkSendWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -375,12 +388,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestBulkSendWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + public SignatureRequestBulkSendWithTemplateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -400,12 +413,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public SignatureRequestBulkSendWithTemplateRequest subject(String subject) { + public SignatureRequestBulkSendWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -425,12 +438,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestBulkSendWithTemplateRequest testMode(Boolean testMode) { + public SignatureRequestBulkSendWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -450,12 +463,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestBulkSendWithTemplateRequest title(String title) { + public SignatureRequestBulkSendWithTemplateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -475,7 +488,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java index 14fdbca..3002dec 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedRequest.java @@ -72,79 +72,103 @@ SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, SignatureRequestCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestCreateEmbeddedRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + @jakarta.annotation.Nullable private List groupedSigners = null; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable private List formFieldsPerDocument = null; public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable private Boolean hideTextTags = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable private Boolean useTextTags = false; public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public SignatureRequestCreateEmbeddedRequest() { @@ -165,7 +189,7 @@ static public SignatureRequestCreateEmbeddedRequest init(HashMap data) throws Ex ); } - public SignatureRequestCreateEmbeddedRequest clientId(String clientId) { + public SignatureRequestCreateEmbeddedRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -185,12 +209,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public SignatureRequestCreateEmbeddedRequest files(List files) { + public SignatureRequestCreateEmbeddedRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -218,12 +242,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public SignatureRequestCreateEmbeddedRequest fileUrls(List fileUrls) { + public SignatureRequestCreateEmbeddedRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -251,12 +275,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public SignatureRequestCreateEmbeddedRequest signers(List signers) { + public SignatureRequestCreateEmbeddedRequest signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -284,12 +308,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } - public SignatureRequestCreateEmbeddedRequest groupedSigners(List groupedSigners) { + public SignatureRequestCreateEmbeddedRequest groupedSigners(@jakarta.annotation.Nullable List groupedSigners) { this.groupedSigners = groupedSigners; return this; } @@ -317,12 +341,12 @@ public List getGroupedSigners() { @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupedSigners(List groupedSigners) { + public void setGroupedSigners(@jakarta.annotation.Nullable List groupedSigners) { this.groupedSigners = groupedSigners; } - public SignatureRequestCreateEmbeddedRequest allowDecline(Boolean allowDecline) { + public SignatureRequestCreateEmbeddedRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -342,12 +366,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestCreateEmbeddedRequest allowReassign(Boolean allowReassign) { + public SignatureRequestCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -367,12 +391,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public SignatureRequestCreateEmbeddedRequest attachments(List attachments) { + public SignatureRequestCreateEmbeddedRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -400,12 +424,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public SignatureRequestCreateEmbeddedRequest ccEmailAddresses(List ccEmailAddresses) { + public SignatureRequestCreateEmbeddedRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -433,12 +457,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public SignatureRequestCreateEmbeddedRequest customFields(List customFields) { + public SignatureRequestCreateEmbeddedRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -466,12 +490,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestCreateEmbeddedRequest fieldOptions(SubFieldOptions fieldOptions) { + public SignatureRequestCreateEmbeddedRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -491,12 +515,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public SignatureRequestCreateEmbeddedRequest formFieldGroups(List formFieldGroups) { + public SignatureRequestCreateEmbeddedRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -524,12 +548,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public SignatureRequestCreateEmbeddedRequest formFieldRules(List formFieldRules) { + public SignatureRequestCreateEmbeddedRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -557,12 +581,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public SignatureRequestCreateEmbeddedRequest formFieldsPerDocument(List formFieldsPerDocument) { + public SignatureRequestCreateEmbeddedRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -590,12 +614,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public SignatureRequestCreateEmbeddedRequest hideTextTags(Boolean hideTextTags) { + public SignatureRequestCreateEmbeddedRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; return this; } @@ -615,12 +639,12 @@ public Boolean getHideTextTags() { @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHideTextTags(Boolean hideTextTags) { + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; } - public SignatureRequestCreateEmbeddedRequest message(String message) { + public SignatureRequestCreateEmbeddedRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -640,12 +664,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestCreateEmbeddedRequest metadata(Map metadata) { + public SignatureRequestCreateEmbeddedRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -673,12 +697,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestCreateEmbeddedRequest signingOptions(SubSigningOptions signingOptions) { + public SignatureRequestCreateEmbeddedRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -698,12 +722,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public SignatureRequestCreateEmbeddedRequest subject(String subject) { + public SignatureRequestCreateEmbeddedRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -723,12 +747,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestCreateEmbeddedRequest testMode(Boolean testMode) { + public SignatureRequestCreateEmbeddedRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -748,12 +772,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestCreateEmbeddedRequest title(String title) { + public SignatureRequestCreateEmbeddedRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -773,12 +797,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public SignatureRequestCreateEmbeddedRequest useTextTags(Boolean useTextTags) { + public SignatureRequestCreateEmbeddedRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; return this; } @@ -798,12 +822,12 @@ public Boolean getUseTextTags() { @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUseTextTags(Boolean useTextTags) { + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } - public SignatureRequestCreateEmbeddedRequest populateAutoFillFields(Boolean populateAutoFillFields) { + public SignatureRequestCreateEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; } @@ -823,12 +847,12 @@ public Boolean getPopulateAutoFillFields() { @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; } - public SignatureRequestCreateEmbeddedRequest expiresAt(Integer expiresAt) { + public SignatureRequestCreateEmbeddedRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -848,7 +872,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java index 82e075a..6dc29fb 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestCreateEmbeddedWithTemplateRequest.java @@ -58,52 +58,67 @@ SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, SignatureRequestCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestCreateEmbeddedWithTemplateRequest { public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull private List templateIds = new ArrayList<>(); public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nonnull private List signers = new ArrayList<>(); public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable private List ccs = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; public SignatureRequestCreateEmbeddedWithTemplateRequest() { @@ -124,7 +139,7 @@ static public SignatureRequestCreateEmbeddedWithTemplateRequest init(HashMap dat ); } - public SignatureRequestCreateEmbeddedWithTemplateRequest templateIds(List templateIds) { + public SignatureRequestCreateEmbeddedWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; return this; } @@ -152,12 +167,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; } - public SignatureRequestCreateEmbeddedWithTemplateRequest clientId(String clientId) { + public SignatureRequestCreateEmbeddedWithTemplateRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -177,12 +192,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public SignatureRequestCreateEmbeddedWithTemplateRequest signers(List signers) { + public SignatureRequestCreateEmbeddedWithTemplateRequest signers(@jakarta.annotation.Nonnull List signers) { this.signers = signers; return this; } @@ -210,12 +225,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nonnull List signers) { this.signers = signers; } - public SignatureRequestCreateEmbeddedWithTemplateRequest allowDecline(Boolean allowDecline) { + public SignatureRequestCreateEmbeddedWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -235,12 +250,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestCreateEmbeddedWithTemplateRequest ccs(List ccs) { + public SignatureRequestCreateEmbeddedWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; return this; } @@ -268,12 +283,12 @@ public List getCcs() { @JsonProperty(JSON_PROPERTY_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcs(List ccs) { + public void setCcs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; } - public SignatureRequestCreateEmbeddedWithTemplateRequest customFields(List customFields) { + public SignatureRequestCreateEmbeddedWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -301,12 +316,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestCreateEmbeddedWithTemplateRequest files(List files) { + public SignatureRequestCreateEmbeddedWithTemplateRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -334,12 +349,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public SignatureRequestCreateEmbeddedWithTemplateRequest fileUrls(List fileUrls) { + public SignatureRequestCreateEmbeddedWithTemplateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -367,12 +382,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public SignatureRequestCreateEmbeddedWithTemplateRequest message(String message) { + public SignatureRequestCreateEmbeddedWithTemplateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -392,12 +407,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestCreateEmbeddedWithTemplateRequest metadata(Map metadata) { + public SignatureRequestCreateEmbeddedWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -425,12 +440,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestCreateEmbeddedWithTemplateRequest signingOptions(SubSigningOptions signingOptions) { + public SignatureRequestCreateEmbeddedWithTemplateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -450,12 +465,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public SignatureRequestCreateEmbeddedWithTemplateRequest subject(String subject) { + public SignatureRequestCreateEmbeddedWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -475,12 +490,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestCreateEmbeddedWithTemplateRequest testMode(Boolean testMode) { + public SignatureRequestCreateEmbeddedWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -500,12 +515,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestCreateEmbeddedWithTemplateRequest title(String title) { + public SignatureRequestCreateEmbeddedWithTemplateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -525,12 +540,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public SignatureRequestCreateEmbeddedWithTemplateRequest populateAutoFillFields(Boolean populateAutoFillFields) { + public SignatureRequestCreateEmbeddedWithTemplateRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; } @@ -550,7 +565,7 @@ public Boolean getPopulateAutoFillFields() { @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java new file mode 100644 index 0000000..9a40b64 --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedRequest.java @@ -0,0 +1,1454 @@ +/* + * 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.SubAttachment; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubFieldOptions; +import com.dropbox.sign.model.SubFormFieldGroup; +import com.dropbox.sign.model.SubFormFieldRule; +import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; +import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSigningOptions; +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.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +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; +/** + * SignatureRequestEditEmbeddedRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, + SignatureRequestEditEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditEmbeddedRequest { + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull + private String clientId; + + public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + @jakarta.annotation.Nullable + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable + private Boolean populateAutoFillFields = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + + public SignatureRequestEditEmbeddedRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditEmbeddedRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditEmbeddedRequest.class); + } + + static public SignatureRequestEditEmbeddedRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedRequest.class + ); + } + + public SignatureRequestEditEmbeddedRequest clientId(@jakarta.annotation.Nonnull String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for security purposes. + * @return clientId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(@jakarta.annotation.Nonnull String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditEmbeddedRequest files(@jakarta.annotation.Nullable List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(@jakarta.annotation.Nullable List files) { + this.files = files; + } + + + public SignatureRequestEditEmbeddedRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditEmbeddedRequest signers(@jakarta.annotation.Nullable List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedRequest addSignersItem(SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return signers + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(@jakarta.annotation.Nullable List signers) { + this.signers = signers; + } + + + public SignatureRequestEditEmbeddedRequest groupedSigners(@jakarta.annotation.Nullable List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditEmbeddedRequest addGroupedSignersItem(SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return groupedSigners + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getGroupedSigners() { + return groupedSigners; + } + + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(@jakarta.annotation.Nullable List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + + public SignatureRequestEditEmbeddedRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan. + * @return allowReassign + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowReassign() { + return allowReassign; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + + public SignatureRequestEditEmbeddedRequest attachments(@jakarta.annotation.Nullable List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditEmbeddedRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * @return attachments + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(@jakarta.annotation.Nullable List attachments) { + this.attachments = attachments; + } + + + public SignatureRequestEditEmbeddedRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCcEmailAddressesItem(String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * @return ccEmailAddresses + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + + public SignatureRequestEditEmbeddedRequest customFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditEmbeddedRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * @return fieldOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + + public SignatureRequestEditEmbeddedRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditEmbeddedRequest 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.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldGroups() { + return formFieldGroups; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + + public SignatureRequestEditEmbeddedRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditEmbeddedRequest addFormFieldRulesItem(SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * @return formFieldRules + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldRules() { + return formFieldRules; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + + public SignatureRequestEditEmbeddedRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditEmbeddedRequest 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.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + + public SignatureRequestEditEmbeddedRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * @return hideTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getHideTextTags() { + return hideTextTags; + } + + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + + public SignatureRequestEditEmbeddedRequest message(@jakarta.annotation.Nullable String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(@jakarta.annotation.Nullable String message) { + this.message = message; + } + + + public SignatureRequestEditEmbeddedRequest metadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditEmbeddedRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditEmbeddedRequest subject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + } + + + public SignatureRequestEditEmbeddedRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditEmbeddedRequest title(@jakarta.annotation.Nullable String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(@jakarta.annotation.Nullable String title) { + this.title = title; + } + + + public SignatureRequestEditEmbeddedRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * @return useTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseTextTags() { + return useTextTags; + } + + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + + public SignatureRequestEditEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * 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. + * @return populateAutoFillFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + + public SignatureRequestEditEmbeddedRequest 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 SignatureRequestEditEmbeddedRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedRequest signatureRequestEditEmbeddedRequest = (SignatureRequestEditEmbeddedRequest) o; + return Objects.equals(this.clientId, signatureRequestEditEmbeddedRequest.clientId) && + Objects.equals(this.files, signatureRequestEditEmbeddedRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditEmbeddedRequest.fileUrls) && + Objects.equals(this.signers, signatureRequestEditEmbeddedRequest.signers) && + Objects.equals(this.groupedSigners, signatureRequestEditEmbeddedRequest.groupedSigners) && + Objects.equals(this.allowDecline, signatureRequestEditEmbeddedRequest.allowDecline) && + Objects.equals(this.allowReassign, signatureRequestEditEmbeddedRequest.allowReassign) && + Objects.equals(this.attachments, signatureRequestEditEmbeddedRequest.attachments) && + Objects.equals(this.ccEmailAddresses, signatureRequestEditEmbeddedRequest.ccEmailAddresses) && + Objects.equals(this.customFields, signatureRequestEditEmbeddedRequest.customFields) && + Objects.equals(this.fieldOptions, signatureRequestEditEmbeddedRequest.fieldOptions) && + Objects.equals(this.formFieldGroups, signatureRequestEditEmbeddedRequest.formFieldGroups) && + Objects.equals(this.formFieldRules, signatureRequestEditEmbeddedRequest.formFieldRules) && + Objects.equals(this.formFieldsPerDocument, signatureRequestEditEmbeddedRequest.formFieldsPerDocument) && + Objects.equals(this.hideTextTags, signatureRequestEditEmbeddedRequest.hideTextTags) && + Objects.equals(this.message, signatureRequestEditEmbeddedRequest.message) && + Objects.equals(this.metadata, signatureRequestEditEmbeddedRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditEmbeddedRequest.signingOptions) && + Objects.equals(this.subject, signatureRequestEditEmbeddedRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditEmbeddedRequest.testMode) && + Objects.equals(this.title, signatureRequestEditEmbeddedRequest.title) && + Objects.equals(this.useTextTags, signatureRequestEditEmbeddedRequest.useTextTags) && + Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedRequest.populateAutoFillFields) && + Objects.equals(this.expiresAt, signatureRequestEditEmbeddedRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash(clientId, files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, message, metadata, signingOptions, subject, testMode, title, useTextTags, populateAutoFillFields, expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedRequest {\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ").append(toIndentedString(formFieldsPerDocument)).append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + 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(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) || + groupedSigners.getClass().equals(Integer.class) || + groupedSigners.getClass().equals(String.class) || + groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for(int i = 0; i< getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } + else { + map.put("grouped_signers", JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) || + allowReassign.getClass().equals(Integer.class) || + allowReassign.getClass().equals(String.class) || + allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for(int i = 0; i< getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } + else { + map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) || + ccEmailAddresses.getClass().equals(Integer.class) || + ccEmailAddresses.getClass().equals(String.class) || + ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for(int i = 0; i< getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } + else { + map.put("cc_email_addresses", JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) || + fieldOptions.getClass().equals(Integer.class) || + fieldOptions.getClass().equals(String.class) || + fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for(int i = 0; i< getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } + else { + map.put("field_options", JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + 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 (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) || + formFieldRules.getClass().equals(Integer.class) || + formFieldRules.getClass().equals(String.class) || + formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for(int i = 0; i< getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } + else { + map.put("form_field_rules", JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + 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 (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) || + hideTextTags.getClass().equals(Integer.class) || + hideTextTags.getClass().equals(String.class) || + hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for(int i = 0; i< getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } + else { + map.put("hide_text_tags", JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + 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 (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) || + useTextTags.getClass().equals(Integer.class) || + useTextTags.getClass().equals(String.class) || + useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for(int i = 0; i< getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } + else { + map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) || + populateAutoFillFields.getClass().equals(Integer.class) || + populateAutoFillFields.getClass().equals(String.class) || + populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for(int i = 0; i< getListSize(populateAutoFillFields); i++) { + map.put("populate_auto_fill_fields[" + i + "]", getFromList(populateAutoFillFields, i)); + } + } + else { + 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); + } + + 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/SignatureRequestEditEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java new file mode 100644 index 0000000..af70292 --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestEditEmbeddedWithTemplateRequest.java @@ -0,0 +1,958 @@ +/* + * 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.SubCC; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSigningOptions; +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.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +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; +/** + * SignatureRequestEditEmbeddedWithTemplateRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditEmbeddedWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull + private String clientId; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nonnull + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable + private List ccs = null; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable + private List fileUrls = null; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable + private String title; + + public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable + private Boolean populateAutoFillFields = false; + + public SignatureRequestEditEmbeddedWithTemplateRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditEmbeddedWithTemplateRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditEmbeddedWithTemplateRequest.class); + } + + static public SignatureRequestEditEmbeddedWithTemplateRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditEmbeddedWithTemplateRequest.class + ); + } + + public SignatureRequestEditEmbeddedWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addTemplateIdsItem(String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @return templateIds + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getTemplateIds() { + return templateIds; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { + this.templateIds = templateIds; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest clientId(@jakarta.annotation.Nonnull String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app you're using to create this embedded signature request. Used for security purposes. + * @return clientId + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setClientId(@jakarta.annotation.Nonnull String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest signers(@jakarta.annotation.Nonnull List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addSignersItem(SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * @return signers + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(@jakarta.annotation.Nonnull List signers) { + this.signers = signers; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * @return ccs + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcs() { + return ccs; + } + + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(@jakarta.annotation.Nullable List ccs) { + this.ccs = ccs; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest files(@jakarta.annotation.Nullable List files) { + this.files = files; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(@jakarta.annotation.Nullable List files) { + this.files = files; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest message(@jakarta.annotation.Nullable String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(@jakarta.annotation.Nullable String message) { + this.message = message; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditEmbeddedWithTemplateRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest title(@jakarta.annotation.Nullable String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(@jakarta.annotation.Nullable String title) { + this.title = title; + } + + + public SignatureRequestEditEmbeddedWithTemplateRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + return this; + } + + /** + * 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. + * @return populateAutoFillFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getPopulateAutoFillFields() { + return populateAutoFillFields; + } + + + @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { + this.populateAutoFillFields = populateAutoFillFields; + } + + + /** + * Return true if this SignatureRequestEditEmbeddedWithTemplateRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditEmbeddedWithTemplateRequest signatureRequestEditEmbeddedWithTemplateRequest = (SignatureRequestEditEmbeddedWithTemplateRequest) o; + return Objects.equals(this.templateIds, signatureRequestEditEmbeddedWithTemplateRequest.templateIds) && + Objects.equals(this.clientId, signatureRequestEditEmbeddedWithTemplateRequest.clientId) && + Objects.equals(this.signers, signatureRequestEditEmbeddedWithTemplateRequest.signers) && + Objects.equals(this.allowDecline, signatureRequestEditEmbeddedWithTemplateRequest.allowDecline) && + Objects.equals(this.ccs, signatureRequestEditEmbeddedWithTemplateRequest.ccs) && + Objects.equals(this.customFields, signatureRequestEditEmbeddedWithTemplateRequest.customFields) && + Objects.equals(this.files, signatureRequestEditEmbeddedWithTemplateRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditEmbeddedWithTemplateRequest.fileUrls) && + Objects.equals(this.message, signatureRequestEditEmbeddedWithTemplateRequest.message) && + Objects.equals(this.metadata, signatureRequestEditEmbeddedWithTemplateRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditEmbeddedWithTemplateRequest.signingOptions) && + Objects.equals(this.subject, signatureRequestEditEmbeddedWithTemplateRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditEmbeddedWithTemplateRequest.testMode) && + Objects.equals(this.title, signatureRequestEditEmbeddedWithTemplateRequest.title) && + Objects.equals(this.populateAutoFillFields, signatureRequestEditEmbeddedWithTemplateRequest.populateAutoFillFields); + } + + @Override + public int hashCode() { + return Objects.hash(templateIds, clientId, signers, allowDecline, ccs, customFields, files, fileUrls, message, metadata, signingOptions, subject, testMode, title, populateAutoFillFields); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditEmbeddedWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + 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(" populateAutoFillFields: ").append(toIndentedString(populateAutoFillFields)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) || + templateIds.getClass().equals(Integer.class) || + templateIds.getClass().equals(String.class) || + templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for(int i = 0; i< getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } + else { + map.put("template_ids", JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) || + ccs.getClass().equals(Integer.class) || + ccs.getClass().equals(String.class) || + ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for(int i = 0; i< getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } + else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + 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 (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (populateAutoFillFields != null) { + if (isFileTypeOrListOfFiles(populateAutoFillFields)) { + fileTypeFound = true; + } + + if (populateAutoFillFields.getClass().equals(java.io.File.class) || + populateAutoFillFields.getClass().equals(Integer.class) || + populateAutoFillFields.getClass().equals(String.class) || + populateAutoFillFields.getClass().isEnum()) { + map.put("populate_auto_fill_fields", populateAutoFillFields); + } else if (isListOfFile(populateAutoFillFields)) { + for(int i = 0; i< getListSize(populateAutoFillFields); i++) { + map.put("populate_auto_fill_fields[" + i + "]", getFromList(populateAutoFillFields, i)); + } + } + else { + map.put("populate_auto_fill_fields", JSON.getDefault().getMapper().writeValueAsString(populateAutoFillFields)); + } + } + } 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/SignatureRequestEditRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java new file mode 100644 index 0000000..719a6b4 --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestEditRequest.java @@ -0,0 +1,1505 @@ +/* + * 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.SubAttachment; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubFieldOptions; +import com.dropbox.sign.model.SubFormFieldGroup; +import com.dropbox.sign.model.SubFormFieldRule; +import com.dropbox.sign.model.SubFormFieldsPerDocumentBase; +import com.dropbox.sign.model.SubSignatureRequestGroupedSigners; +import com.dropbox.sign.model.SubSignatureRequestSigner; +import com.dropbox.sign.model.SubSigningOptions; +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.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +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; +/** + * SignatureRequestEditRequest + */ +@JsonPropertyOrder({ + SignatureRequestEditRequest.JSON_PROPERTY_FILES, + SignatureRequestEditRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_GROUPED_SIGNERS, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditRequest.JSON_PROPERTY_ALLOW_REASSIGN, + SignatureRequestEditRequest.JSON_PROPERTY_ATTACHMENTS, + SignatureRequestEditRequest.JSON_PROPERTY_CC_EMAIL_ADDRESSES, + SignatureRequestEditRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditRequest.JSON_PROPERTY_FIELD_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_GROUPS, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELD_RULES, + SignatureRequestEditRequest.JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT, + SignatureRequestEditRequest.JSON_PROPERTY_HIDE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditRequest.JSON_PROPERTY_TITLE, + SignatureRequestEditRequest.JSON_PROPERTY_USE_TEXT_TAGS, + SignatureRequestEditRequest.JSON_PROPERTY_EXPIRES_AT +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditRequest { + public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable + private List fileUrls = null; + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable + private List signers = null; + + public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + @jakarta.annotation.Nullable + private List groupedSigners = null; + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable + private Boolean allowReassign = false; + + public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable + private List attachments = null; + + public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable + private List ccEmailAddresses = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable + private List customFields = null; + + public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable + private SubFieldOptions fieldOptions; + + public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable + private List formFieldGroups = null; + + public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable + private List formFieldRules = null; + + public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable + private List formFieldsPerDocument = null; + + public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable + private Boolean hideTextTags = false; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + @jakarta.annotation.Nullable + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable + private String title; + + public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable + private Boolean useTextTags = false; + + public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable + private Integer expiresAt; + + public SignatureRequestEditRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditRequest.class); + } + + static public SignatureRequestEditRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditRequest.class + ); + } + + public SignatureRequestEditRequest files(@jakarta.annotation.Nullable List files) { + this.files = files; + return this; + } + + public SignatureRequestEditRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(@jakarta.annotation.Nullable List files) { + this.files = files; + } + + + public SignatureRequestEditRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditRequest signers(@jakarta.annotation.Nullable List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditRequest addSignersItem(SubSignatureRequestSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return signers + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigners(@jakarta.annotation.Nullable List signers) { + this.signers = signers; + } + + + public SignatureRequestEditRequest groupedSigners(@jakarta.annotation.Nullable List groupedSigners) { + this.groupedSigners = groupedSigners; + return this; + } + + public SignatureRequestEditRequest addGroupedSignersItem(SubSignatureRequestGroupedSigners groupedSignersItem) { + if (this.groupedSigners == null) { + this.groupedSigners = new ArrayList<>(); + } + this.groupedSigners.add(groupedSignersItem); + return this; + } + + /** + * Add Grouped Signers to your Signature Request. This endpoint requires either **signers** or **grouped_signers**, but not both. + * @return groupedSigners + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getGroupedSigners() { + return groupedSigners; + } + + + @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setGroupedSigners(@jakarta.annotation.Nullable List groupedSigners) { + this.groupedSigners = groupedSigners; + } + + + public SignatureRequestEditRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { + this.allowReassign = allowReassign; + return this; + } + + /** + * Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher. + * @return allowReassign + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowReassign() { + return allowReassign; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { + this.allowReassign = allowReassign; + } + + + public SignatureRequestEditRequest attachments(@jakarta.annotation.Nullable List attachments) { + this.attachments = attachments; + return this; + } + + public SignatureRequestEditRequest addAttachmentsItem(SubAttachment attachmentsItem) { + if (this.attachments == null) { + this.attachments = new ArrayList<>(); + } + this.attachments.add(attachmentsItem); + return this; + } + + /** + * A list describing the attachments + * @return attachments + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getAttachments() { + return attachments; + } + + + @JsonProperty(JSON_PROPERTY_ATTACHMENTS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAttachments(@jakarta.annotation.Nullable List attachments) { + this.attachments = attachments; + } + + + public SignatureRequestEditRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + return this; + } + + public SignatureRequestEditRequest addCcEmailAddressesItem(String ccEmailAddressesItem) { + if (this.ccEmailAddresses == null) { + this.ccEmailAddresses = new ArrayList<>(); + } + this.ccEmailAddresses.add(ccEmailAddressesItem); + return this; + } + + /** + * The email addresses that should be CCed. + * @return ccEmailAddresses + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcEmailAddresses() { + return ccEmailAddresses; + } + + + @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { + this.ccEmailAddresses = ccEmailAddresses; + } + + + public SignatureRequestEditRequest clientId(@jakarta.annotation.Nullable String clientId) { + this.clientId = clientId; + return this; + } + + /** + * The client id of the API App you want to associate with this request. Used to apply the branding and callback url defined for the app. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(@jakarta.annotation.Nullable String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditRequest customFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + return this; + } + + /** + * Get fieldOptions + * @return fieldOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubFieldOptions getFieldOptions() { + return fieldOptions; + } + + + @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { + this.fieldOptions = fieldOptions; + } + + + public SignatureRequestEditRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + return this; + } + + public SignatureRequestEditRequest 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.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldGroups() { + return formFieldGroups; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { + this.formFieldGroups = formFieldGroups; + } + + + public SignatureRequestEditRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { + this.formFieldRules = formFieldRules; + return this; + } + + public SignatureRequestEditRequest addFormFieldRulesItem(SubFormFieldRule formFieldRulesItem) { + if (this.formFieldRules == null) { + this.formFieldRules = new ArrayList<>(); + } + this.formFieldRules.add(formFieldRulesItem); + return this; + } + + /** + * Conditional Logic rules for fields defined in `form_fields_per_document`. + * @return formFieldRules + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldRules() { + return formFieldRules; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { + this.formFieldRules = formFieldRules; + } + + + public SignatureRequestEditRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + return this; + } + + public SignatureRequestEditRequest 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.Nullable + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFormFieldsPerDocument() { + return formFieldsPerDocument; + } + + + @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { + this.formFieldsPerDocument = formFieldsPerDocument; + } + + + public SignatureRequestEditRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + return this; + } + + /** + * Enables automatic Text Tag removal when set to true. **NOTE:** Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information. + * @return hideTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getHideTextTags() { + return hideTextTags; + } + + + @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { + this.hideTextTags = hideTextTags; + } + + + public SignatureRequestEditRequest isEid(@jakarta.annotation.Nullable Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * @return isEid + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEid() { + return isEid; + } + + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(@jakarta.annotation.Nullable Boolean isEid) { + this.isEid = isEid; + } + + + public SignatureRequestEditRequest message(@jakarta.annotation.Nullable String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(@jakarta.annotation.Nullable String message) { + this.message = message; + } + + + public SignatureRequestEditRequest metadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * @return signingRedirectUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + + public SignatureRequestEditRequest subject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + } + + + public SignatureRequestEditRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditRequest title(@jakarta.annotation.Nullable String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(@jakarta.annotation.Nullable String title) { + this.title = title; + } + + + public SignatureRequestEditRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { + this.useTextTags = useTextTags; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`. + * @return useTextTags + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getUseTextTags() { + return useTextTags; + } + + + @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { + this.useTextTags = useTextTags; + } + + + public SignatureRequestEditRequest 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 SignatureRequestEditRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditRequest signatureRequestEditRequest = (SignatureRequestEditRequest) o; + return Objects.equals(this.files, signatureRequestEditRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditRequest.fileUrls) && + Objects.equals(this.signers, signatureRequestEditRequest.signers) && + Objects.equals(this.groupedSigners, signatureRequestEditRequest.groupedSigners) && + Objects.equals(this.allowDecline, signatureRequestEditRequest.allowDecline) && + Objects.equals(this.allowReassign, signatureRequestEditRequest.allowReassign) && + Objects.equals(this.attachments, signatureRequestEditRequest.attachments) && + Objects.equals(this.ccEmailAddresses, signatureRequestEditRequest.ccEmailAddresses) && + Objects.equals(this.clientId, signatureRequestEditRequest.clientId) && + Objects.equals(this.customFields, signatureRequestEditRequest.customFields) && + Objects.equals(this.fieldOptions, signatureRequestEditRequest.fieldOptions) && + Objects.equals(this.formFieldGroups, signatureRequestEditRequest.formFieldGroups) && + Objects.equals(this.formFieldRules, signatureRequestEditRequest.formFieldRules) && + Objects.equals(this.formFieldsPerDocument, signatureRequestEditRequest.formFieldsPerDocument) && + Objects.equals(this.hideTextTags, signatureRequestEditRequest.hideTextTags) && + Objects.equals(this.isEid, signatureRequestEditRequest.isEid) && + Objects.equals(this.message, signatureRequestEditRequest.message) && + Objects.equals(this.metadata, signatureRequestEditRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditRequest.signingOptions) && + Objects.equals(this.signingRedirectUrl, signatureRequestEditRequest.signingRedirectUrl) && + Objects.equals(this.subject, signatureRequestEditRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditRequest.testMode) && + Objects.equals(this.title, signatureRequestEditRequest.title) && + Objects.equals(this.useTextTags, signatureRequestEditRequest.useTextTags) && + Objects.equals(this.expiresAt, signatureRequestEditRequest.expiresAt); + } + + @Override + public int hashCode() { + return Objects.hash(files, fileUrls, signers, groupedSigners, allowDecline, allowReassign, attachments, ccEmailAddresses, clientId, customFields, fieldOptions, formFieldGroups, formFieldRules, formFieldsPerDocument, hideTextTags, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title, useTextTags, expiresAt); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditRequest {\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" groupedSigners: ").append(toIndentedString(groupedSigners)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" allowReassign: ").append(toIndentedString(allowReassign)).append("\n"); + sb.append(" attachments: ").append(toIndentedString(attachments)).append("\n"); + sb.append(" ccEmailAddresses: ").append(toIndentedString(ccEmailAddresses)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" fieldOptions: ").append(toIndentedString(fieldOptions)).append("\n"); + sb.append(" formFieldGroups: ").append(toIndentedString(formFieldGroups)).append("\n"); + sb.append(" formFieldRules: ").append(toIndentedString(formFieldRules)).append("\n"); + sb.append(" formFieldsPerDocument: ").append(toIndentedString(formFieldsPerDocument)).append("\n"); + sb.append(" hideTextTags: ").append(toIndentedString(hideTextTags)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ").append(toIndentedString(signingRedirectUrl)).append("\n"); + 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(" useTextTags: ").append(toIndentedString(useTextTags)).append("\n"); + sb.append(" expiresAt: ").append(toIndentedString(expiresAt)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (groupedSigners != null) { + if (isFileTypeOrListOfFiles(groupedSigners)) { + fileTypeFound = true; + } + + if (groupedSigners.getClass().equals(java.io.File.class) || + groupedSigners.getClass().equals(Integer.class) || + groupedSigners.getClass().equals(String.class) || + groupedSigners.getClass().isEnum()) { + map.put("grouped_signers", groupedSigners); + } else if (isListOfFile(groupedSigners)) { + for(int i = 0; i< getListSize(groupedSigners); i++) { + map.put("grouped_signers[" + i + "]", getFromList(groupedSigners, i)); + } + } + else { + map.put("grouped_signers", JSON.getDefault().getMapper().writeValueAsString(groupedSigners)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (allowReassign != null) { + if (isFileTypeOrListOfFiles(allowReassign)) { + fileTypeFound = true; + } + + if (allowReassign.getClass().equals(java.io.File.class) || + allowReassign.getClass().equals(Integer.class) || + allowReassign.getClass().equals(String.class) || + allowReassign.getClass().isEnum()) { + map.put("allow_reassign", allowReassign); + } else if (isListOfFile(allowReassign)) { + for(int i = 0; i< getListSize(allowReassign); i++) { + map.put("allow_reassign[" + i + "]", getFromList(allowReassign, i)); + } + } + else { + map.put("allow_reassign", JSON.getDefault().getMapper().writeValueAsString(allowReassign)); + } + } + if (attachments != null) { + if (isFileTypeOrListOfFiles(attachments)) { + fileTypeFound = true; + } + + if (attachments.getClass().equals(java.io.File.class) || + attachments.getClass().equals(Integer.class) || + attachments.getClass().equals(String.class) || + attachments.getClass().isEnum()) { + map.put("attachments", attachments); + } else if (isListOfFile(attachments)) { + for(int i = 0; i< getListSize(attachments); i++) { + map.put("attachments[" + i + "]", getFromList(attachments, i)); + } + } + else { + map.put("attachments", JSON.getDefault().getMapper().writeValueAsString(attachments)); + } + } + if (ccEmailAddresses != null) { + if (isFileTypeOrListOfFiles(ccEmailAddresses)) { + fileTypeFound = true; + } + + if (ccEmailAddresses.getClass().equals(java.io.File.class) || + ccEmailAddresses.getClass().equals(Integer.class) || + ccEmailAddresses.getClass().equals(String.class) || + ccEmailAddresses.getClass().isEnum()) { + map.put("cc_email_addresses", ccEmailAddresses); + } else if (isListOfFile(ccEmailAddresses)) { + for(int i = 0; i< getListSize(ccEmailAddresses); i++) { + map.put("cc_email_addresses[" + i + "]", getFromList(ccEmailAddresses, i)); + } + } + else { + map.put("cc_email_addresses", JSON.getDefault().getMapper().writeValueAsString(ccEmailAddresses)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (fieldOptions != null) { + if (isFileTypeOrListOfFiles(fieldOptions)) { + fileTypeFound = true; + } + + if (fieldOptions.getClass().equals(java.io.File.class) || + fieldOptions.getClass().equals(Integer.class) || + fieldOptions.getClass().equals(String.class) || + fieldOptions.getClass().isEnum()) { + map.put("field_options", fieldOptions); + } else if (isListOfFile(fieldOptions)) { + for(int i = 0; i< getListSize(fieldOptions); i++) { + map.put("field_options[" + i + "]", getFromList(fieldOptions, i)); + } + } + else { + map.put("field_options", JSON.getDefault().getMapper().writeValueAsString(fieldOptions)); + } + } + 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 (formFieldRules != null) { + if (isFileTypeOrListOfFiles(formFieldRules)) { + fileTypeFound = true; + } + + if (formFieldRules.getClass().equals(java.io.File.class) || + formFieldRules.getClass().equals(Integer.class) || + formFieldRules.getClass().equals(String.class) || + formFieldRules.getClass().isEnum()) { + map.put("form_field_rules", formFieldRules); + } else if (isListOfFile(formFieldRules)) { + for(int i = 0; i< getListSize(formFieldRules); i++) { + map.put("form_field_rules[" + i + "]", getFromList(formFieldRules, i)); + } + } + else { + map.put("form_field_rules", JSON.getDefault().getMapper().writeValueAsString(formFieldRules)); + } + } + 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 (hideTextTags != null) { + if (isFileTypeOrListOfFiles(hideTextTags)) { + fileTypeFound = true; + } + + if (hideTextTags.getClass().equals(java.io.File.class) || + hideTextTags.getClass().equals(Integer.class) || + hideTextTags.getClass().equals(String.class) || + hideTextTags.getClass().isEnum()) { + map.put("hide_text_tags", hideTextTags); + } else if (isListOfFile(hideTextTags)) { + for(int i = 0; i< getListSize(hideTextTags); i++) { + map.put("hide_text_tags[" + i + "]", getFromList(hideTextTags, i)); + } + } + else { + map.put("hide_text_tags", JSON.getDefault().getMapper().writeValueAsString(hideTextTags)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) || + isEid.getClass().equals(Integer.class) || + isEid.getClass().equals(String.class) || + isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for(int i = 0; i< getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } + else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) || + signingRedirectUrl.getClass().equals(Integer.class) || + signingRedirectUrl.getClass().equals(String.class) || + signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for(int i = 0; i< getListSize(signingRedirectUrl); i++) { + map.put("signing_redirect_url[" + i + "]", getFromList(signingRedirectUrl, i)); + } + } + else { + map.put("signing_redirect_url", JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + 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 (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + if (useTextTags != null) { + if (isFileTypeOrListOfFiles(useTextTags)) { + fileTypeFound = true; + } + + if (useTextTags.getClass().equals(java.io.File.class) || + useTextTags.getClass().equals(Integer.class) || + useTextTags.getClass().equals(String.class) || + useTextTags.getClass().isEnum()) { + map.put("use_text_tags", useTextTags); + } else if (isListOfFile(useTextTags)) { + for(int i = 0; i< getListSize(useTextTags); i++) { + map.put("use_text_tags[" + i + "]", getFromList(useTextTags, i)); + } + } + else { + map.put("use_text_tags", JSON.getDefault().getMapper().writeValueAsString(useTextTags)); + } + } + 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); + } + + 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/SignatureRequestEditWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java new file mode 100644 index 0000000..02f2a4d --- /dev/null +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestEditWithTemplateRequest.java @@ -0,0 +1,1009 @@ +/* + * 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.SubCC; +import com.dropbox.sign.model.SubCustomField; +import com.dropbox.sign.model.SubSignatureRequestTemplateSigner; +import com.dropbox.sign.model.SubSigningOptions; +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.util.ArrayList; +import java.util.Arrays; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +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; +/** + * + */ +@JsonPropertyOrder({ + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEMPLATE_IDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNERS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_ALLOW_DECLINE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CCS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CLIENT_ID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_CUSTOM_FIELDS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILES, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_FILE_URLS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_IS_EID, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_MESSAGE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_METADATA, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_OPTIONS, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_SUBJECT, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TEST_MODE, + SignatureRequestEditWithTemplateRequest.JSON_PROPERTY_TITLE +}) +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") +@JsonIgnoreProperties(ignoreUnknown=true) +public class SignatureRequestEditWithTemplateRequest { + public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull + private List templateIds = new ArrayList<>(); + + public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nonnull + private List signers = new ArrayList<>(); + + public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable + private Boolean allowDecline = false; + + public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable + private List ccs = null; + + public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable + private String clientId; + + public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable + private List customFields = null; + + public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable + private List files = null; + + public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable + private List fileUrls = null; + + public static final String JSON_PROPERTY_IS_EID = "is_eid"; + @jakarta.annotation.Nullable + private Boolean isEid = false; + + public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable + private String message; + + public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable + private Map metadata = null; + + public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable + private SubSigningOptions signingOptions; + + public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable + private String signingRedirectUrl; + + public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable + private String subject; + + public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable + private Boolean testMode = false; + + public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable + private String title; + + public SignatureRequestEditWithTemplateRequest() { + } + + /** + * Attempt to instantiate and hydrate a new instance of this class + * @param jsonData String of JSON data representing target object + */ + static public SignatureRequestEditWithTemplateRequest init(String jsonData) throws Exception { + return new ObjectMapper().readValue(jsonData, SignatureRequestEditWithTemplateRequest.class); + } + + static public SignatureRequestEditWithTemplateRequest init(HashMap data) throws Exception { + return new ObjectMapper().readValue( + new ObjectMapper().writeValueAsString(data), + SignatureRequestEditWithTemplateRequest.class + ); + } + + public SignatureRequestEditWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { + this.templateIds = templateIds; + return this; + } + + public SignatureRequestEditWithTemplateRequest addTemplateIdsItem(String templateIdsItem) { + if (this.templateIds == null) { + this.templateIds = new ArrayList<>(); + } + this.templateIds.add(templateIdsItem); + return this; + } + + /** + * Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the template will be used. + * @return templateIds + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getTemplateIds() { + return templateIds; + } + + + @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { + this.templateIds = templateIds; + } + + + public SignatureRequestEditWithTemplateRequest signers(@jakarta.annotation.Nonnull List signers) { + this.signers = signers; + return this; + } + + public SignatureRequestEditWithTemplateRequest addSignersItem(SubSignatureRequestTemplateSigner signersItem) { + if (this.signers == null) { + this.signers = new ArrayList<>(); + } + this.signers.add(signersItem); + return this; + } + + /** + * Add Signers to your Templated-based Signature Request. + * @return signers + */ + @jakarta.annotation.Nonnull + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + + public List getSigners() { + return signers; + } + + + @JsonProperty(JSON_PROPERTY_SIGNERS) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setSigners(@jakarta.annotation.Nonnull List signers) { + this.signers = signers; + } + + + public SignatureRequestEditWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + return this; + } + + /** + * Allows signers to decline to sign a document if `true`. Defaults to `false`. + * @return allowDecline + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getAllowDecline() { + return allowDecline; + } + + + @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { + this.allowDecline = allowDecline; + } + + + public SignatureRequestEditWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { + this.ccs = ccs; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCcsItem(SubCC ccsItem) { + if (this.ccs == null) { + this.ccs = new ArrayList<>(); + } + this.ccs.add(ccsItem); + return this; + } + + /** + * Add CC email recipients. Required when a CC role exists for the Template. + * @return ccs + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCcs() { + return ccs; + } + + + @JsonProperty(JSON_PROPERTY_CCS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCcs(@jakarta.annotation.Nullable List ccs) { + this.ccs = ccs; + } + + + public SignatureRequestEditWithTemplateRequest clientId(@jakarta.annotation.Nullable String clientId) { + this.clientId = clientId; + return this; + } + + /** + * Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app. + * @return clientId + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getClientId() { + return clientId; + } + + + @JsonProperty(JSON_PROPERTY_CLIENT_ID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setClientId(@jakarta.annotation.Nullable String clientId) { + this.clientId = clientId; + } + + + public SignatureRequestEditWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + return this; + } + + public SignatureRequestEditWithTemplateRequest addCustomFieldsItem(SubCustomField customFieldsItem) { + if (this.customFields == null) { + this.customFields = new ArrayList<>(); + } + this.customFields.add(customFieldsItem); + return this; + } + + /** + * An array defining values and options for custom fields. Required when a custom field exists in the Template. + * @return customFields + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getCustomFields() { + return customFields; + } + + + @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { + this.customFields = customFields; + } + + + public SignatureRequestEditWithTemplateRequest files(@jakarta.annotation.Nullable List files) { + this.files = files; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFilesItem(File filesItem) { + if (this.files == null) { + this.files = new ArrayList<>(); + } + this.files.add(filesItem); + return this; + } + + /** + * Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return files + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFiles() { + return files; + } + + + @JsonProperty(JSON_PROPERTY_FILES) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFiles(@jakarta.annotation.Nullable List files) { + this.files = files; + } + + + public SignatureRequestEditWithTemplateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + return this; + } + + public SignatureRequestEditWithTemplateRequest addFileUrlsItem(String fileUrlsItem) { + if (this.fileUrls == null) { + this.fileUrls = new ArrayList<>(); + } + this.fileUrls.add(fileUrlsItem); + return this; + } + + /** + * Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both. + * @return fileUrls + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public List getFileUrls() { + return fileUrls; + } + + + @JsonProperty(JSON_PROPERTY_FILE_URLS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { + this.fileUrls = fileUrls; + } + + + public SignatureRequestEditWithTemplateRequest isEid(@jakarta.annotation.Nullable Boolean isEid) { + this.isEid = isEid; + return this; + } + + /** + * Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. + * @return isEid + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getIsEid() { + return isEid; + } + + + @JsonProperty(JSON_PROPERTY_IS_EID) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIsEid(@jakarta.annotation.Nullable Boolean isEid) { + this.isEid = isEid; + } + + + public SignatureRequestEditWithTemplateRequest message(@jakarta.annotation.Nullable String message) { + this.message = message; + return this; + } + + /** + * The custom message in the email that will be sent to the signers. + * @return message + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getMessage() { + return message; + } + + + @JsonProperty(JSON_PROPERTY_MESSAGE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setMessage(@jakarta.annotation.Nullable String message) { + this.message = message; + } + + + public SignatureRequestEditWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + return this; + } + + public SignatureRequestEditWithTemplateRequest putMetadataItem(String key, Object metadataItem) { + if (this.metadata == null) { + this.metadata = new HashMap<>(); + } + this.metadata.put(key, metadataItem); + return this; + } + + /** + * Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long. + * @return metadata + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + + public Map getMetadata() { + return metadata; + } + + + @JsonProperty(JSON_PROPERTY_METADATA) + @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { + this.metadata = metadata; + } + + + public SignatureRequestEditWithTemplateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + return this; + } + + /** + * Get signingOptions + * @return signingOptions + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public SubSigningOptions getSigningOptions() { + return signingOptions; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { + this.signingOptions = signingOptions; + } + + + public SignatureRequestEditWithTemplateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + return this; + } + + /** + * The URL you want signers redirected to after they successfully sign. + * @return signingRedirectUrl + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSigningRedirectUrl() { + return signingRedirectUrl; + } + + + @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { + this.signingRedirectUrl = signingRedirectUrl; + } + + + public SignatureRequestEditWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + return this; + } + + /** + * The subject in the email that will be sent to the signers. + * @return subject + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getSubject() { + return subject; + } + + + @JsonProperty(JSON_PROPERTY_SUBJECT) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setSubject(@jakarta.annotation.Nullable String subject) { + this.subject = subject; + } + + + public SignatureRequestEditWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + return this; + } + + /** + * Whether this is a test, the signature request will not be legally binding if set to `true`. Defaults to `false`. + * @return testMode + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public Boolean getTestMode() { + return testMode; + } + + + @JsonProperty(JSON_PROPERTY_TEST_MODE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { + this.testMode = testMode; + } + + + public SignatureRequestEditWithTemplateRequest title(@jakarta.annotation.Nullable String title) { + this.title = title; + return this; + } + + /** + * The title you want to assign to the SignatureRequest. + * @return title + */ + @jakarta.annotation.Nullable + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + + public String getTitle() { + return title; + } + + + @JsonProperty(JSON_PROPERTY_TITLE) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTitle(@jakarta.annotation.Nullable String title) { + this.title = title; + } + + + /** + * Return true if this SignatureRequestEditWithTemplateRequest object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + SignatureRequestEditWithTemplateRequest signatureRequestEditWithTemplateRequest = (SignatureRequestEditWithTemplateRequest) o; + return Objects.equals(this.templateIds, signatureRequestEditWithTemplateRequest.templateIds) && + Objects.equals(this.signers, signatureRequestEditWithTemplateRequest.signers) && + Objects.equals(this.allowDecline, signatureRequestEditWithTemplateRequest.allowDecline) && + Objects.equals(this.ccs, signatureRequestEditWithTemplateRequest.ccs) && + Objects.equals(this.clientId, signatureRequestEditWithTemplateRequest.clientId) && + Objects.equals(this.customFields, signatureRequestEditWithTemplateRequest.customFields) && + Objects.equals(this.files, signatureRequestEditWithTemplateRequest.files) && + Objects.equals(this.fileUrls, signatureRequestEditWithTemplateRequest.fileUrls) && + Objects.equals(this.isEid, signatureRequestEditWithTemplateRequest.isEid) && + Objects.equals(this.message, signatureRequestEditWithTemplateRequest.message) && + Objects.equals(this.metadata, signatureRequestEditWithTemplateRequest.metadata) && + Objects.equals(this.signingOptions, signatureRequestEditWithTemplateRequest.signingOptions) && + Objects.equals(this.signingRedirectUrl, signatureRequestEditWithTemplateRequest.signingRedirectUrl) && + Objects.equals(this.subject, signatureRequestEditWithTemplateRequest.subject) && + Objects.equals(this.testMode, signatureRequestEditWithTemplateRequest.testMode) && + Objects.equals(this.title, signatureRequestEditWithTemplateRequest.title); + } + + @Override + public int hashCode() { + return Objects.hash(templateIds, signers, allowDecline, ccs, clientId, customFields, files, fileUrls, isEid, message, metadata, signingOptions, signingRedirectUrl, subject, testMode, title); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class SignatureRequestEditWithTemplateRequest {\n"); + sb.append(" templateIds: ").append(toIndentedString(templateIds)).append("\n"); + sb.append(" signers: ").append(toIndentedString(signers)).append("\n"); + sb.append(" allowDecline: ").append(toIndentedString(allowDecline)).append("\n"); + sb.append(" ccs: ").append(toIndentedString(ccs)).append("\n"); + sb.append(" clientId: ").append(toIndentedString(clientId)).append("\n"); + sb.append(" customFields: ").append(toIndentedString(customFields)).append("\n"); + sb.append(" files: ").append(toIndentedString(files)).append("\n"); + sb.append(" fileUrls: ").append(toIndentedString(fileUrls)).append("\n"); + sb.append(" isEid: ").append(toIndentedString(isEid)).append("\n"); + sb.append(" message: ").append(toIndentedString(message)).append("\n"); + sb.append(" metadata: ").append(toIndentedString(metadata)).append("\n"); + sb.append(" signingOptions: ").append(toIndentedString(signingOptions)).append("\n"); + sb.append(" signingRedirectUrl: ").append(toIndentedString(signingRedirectUrl)).append("\n"); + 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("}"); + return sb.toString(); + } + + public Map createFormData() throws ApiException { + Map map = new HashMap<>(); + boolean fileTypeFound = false; + try { + if (templateIds != null) { + if (isFileTypeOrListOfFiles(templateIds)) { + fileTypeFound = true; + } + + if (templateIds.getClass().equals(java.io.File.class) || + templateIds.getClass().equals(Integer.class) || + templateIds.getClass().equals(String.class) || + templateIds.getClass().isEnum()) { + map.put("template_ids", templateIds); + } else if (isListOfFile(templateIds)) { + for(int i = 0; i< getListSize(templateIds); i++) { + map.put("template_ids[" + i + "]", getFromList(templateIds, i)); + } + } + else { + map.put("template_ids", JSON.getDefault().getMapper().writeValueAsString(templateIds)); + } + } + if (signers != null) { + if (isFileTypeOrListOfFiles(signers)) { + fileTypeFound = true; + } + + if (signers.getClass().equals(java.io.File.class) || + signers.getClass().equals(Integer.class) || + signers.getClass().equals(String.class) || + signers.getClass().isEnum()) { + map.put("signers", signers); + } else if (isListOfFile(signers)) { + for(int i = 0; i< getListSize(signers); i++) { + map.put("signers[" + i + "]", getFromList(signers, i)); + } + } + else { + map.put("signers", JSON.getDefault().getMapper().writeValueAsString(signers)); + } + } + if (allowDecline != null) { + if (isFileTypeOrListOfFiles(allowDecline)) { + fileTypeFound = true; + } + + if (allowDecline.getClass().equals(java.io.File.class) || + allowDecline.getClass().equals(Integer.class) || + allowDecline.getClass().equals(String.class) || + allowDecline.getClass().isEnum()) { + map.put("allow_decline", allowDecline); + } else if (isListOfFile(allowDecline)) { + for(int i = 0; i< getListSize(allowDecline); i++) { + map.put("allow_decline[" + i + "]", getFromList(allowDecline, i)); + } + } + else { + map.put("allow_decline", JSON.getDefault().getMapper().writeValueAsString(allowDecline)); + } + } + if (ccs != null) { + if (isFileTypeOrListOfFiles(ccs)) { + fileTypeFound = true; + } + + if (ccs.getClass().equals(java.io.File.class) || + ccs.getClass().equals(Integer.class) || + ccs.getClass().equals(String.class) || + ccs.getClass().isEnum()) { + map.put("ccs", ccs); + } else if (isListOfFile(ccs)) { + for(int i = 0; i< getListSize(ccs); i++) { + map.put("ccs[" + i + "]", getFromList(ccs, i)); + } + } + else { + map.put("ccs", JSON.getDefault().getMapper().writeValueAsString(ccs)); + } + } + if (clientId != null) { + if (isFileTypeOrListOfFiles(clientId)) { + fileTypeFound = true; + } + + if (clientId.getClass().equals(java.io.File.class) || + clientId.getClass().equals(Integer.class) || + clientId.getClass().equals(String.class) || + clientId.getClass().isEnum()) { + map.put("client_id", clientId); + } else if (isListOfFile(clientId)) { + for(int i = 0; i< getListSize(clientId); i++) { + map.put("client_id[" + i + "]", getFromList(clientId, i)); + } + } + else { + map.put("client_id", JSON.getDefault().getMapper().writeValueAsString(clientId)); + } + } + if (customFields != null) { + if (isFileTypeOrListOfFiles(customFields)) { + fileTypeFound = true; + } + + if (customFields.getClass().equals(java.io.File.class) || + customFields.getClass().equals(Integer.class) || + customFields.getClass().equals(String.class) || + customFields.getClass().isEnum()) { + map.put("custom_fields", customFields); + } else if (isListOfFile(customFields)) { + for(int i = 0; i< getListSize(customFields); i++) { + map.put("custom_fields[" + i + "]", getFromList(customFields, i)); + } + } + else { + map.put("custom_fields", JSON.getDefault().getMapper().writeValueAsString(customFields)); + } + } + if (files != null) { + if (isFileTypeOrListOfFiles(files)) { + fileTypeFound = true; + } + + if (files.getClass().equals(java.io.File.class) || + files.getClass().equals(Integer.class) || + files.getClass().equals(String.class) || + files.getClass().isEnum()) { + map.put("files", files); + } else if (isListOfFile(files)) { + for(int i = 0; i< getListSize(files); i++) { + map.put("files[" + i + "]", getFromList(files, i)); + } + } + else { + map.put("files", JSON.getDefault().getMapper().writeValueAsString(files)); + } + } + if (fileUrls != null) { + if (isFileTypeOrListOfFiles(fileUrls)) { + fileTypeFound = true; + } + + if (fileUrls.getClass().equals(java.io.File.class) || + fileUrls.getClass().equals(Integer.class) || + fileUrls.getClass().equals(String.class) || + fileUrls.getClass().isEnum()) { + map.put("file_urls", fileUrls); + } else if (isListOfFile(fileUrls)) { + for(int i = 0; i< getListSize(fileUrls); i++) { + map.put("file_urls[" + i + "]", getFromList(fileUrls, i)); + } + } + else { + map.put("file_urls", JSON.getDefault().getMapper().writeValueAsString(fileUrls)); + } + } + if (isEid != null) { + if (isFileTypeOrListOfFiles(isEid)) { + fileTypeFound = true; + } + + if (isEid.getClass().equals(java.io.File.class) || + isEid.getClass().equals(Integer.class) || + isEid.getClass().equals(String.class) || + isEid.getClass().isEnum()) { + map.put("is_eid", isEid); + } else if (isListOfFile(isEid)) { + for(int i = 0; i< getListSize(isEid); i++) { + map.put("is_eid[" + i + "]", getFromList(isEid, i)); + } + } + else { + map.put("is_eid", JSON.getDefault().getMapper().writeValueAsString(isEid)); + } + } + if (message != null) { + if (isFileTypeOrListOfFiles(message)) { + fileTypeFound = true; + } + + if (message.getClass().equals(java.io.File.class) || + message.getClass().equals(Integer.class) || + message.getClass().equals(String.class) || + message.getClass().isEnum()) { + map.put("message", message); + } else if (isListOfFile(message)) { + for(int i = 0; i< getListSize(message); i++) { + map.put("message[" + i + "]", getFromList(message, i)); + } + } + else { + map.put("message", JSON.getDefault().getMapper().writeValueAsString(message)); + } + } + if (metadata != null) { + if (isFileTypeOrListOfFiles(metadata)) { + fileTypeFound = true; + } + + if (metadata.getClass().equals(java.io.File.class) || + metadata.getClass().equals(Integer.class) || + metadata.getClass().equals(String.class) || + metadata.getClass().isEnum()) { + map.put("metadata", metadata); + } else if (isListOfFile(metadata)) { + for(int i = 0; i< getListSize(metadata); i++) { + map.put("metadata[" + i + "]", getFromList(metadata, i)); + } + } + else { + map.put("metadata", JSON.getDefault().getMapper().writeValueAsString(metadata)); + } + } + if (signingOptions != null) { + if (isFileTypeOrListOfFiles(signingOptions)) { + fileTypeFound = true; + } + + if (signingOptions.getClass().equals(java.io.File.class) || + signingOptions.getClass().equals(Integer.class) || + signingOptions.getClass().equals(String.class) || + signingOptions.getClass().isEnum()) { + map.put("signing_options", signingOptions); + } else if (isListOfFile(signingOptions)) { + for(int i = 0; i< getListSize(signingOptions); i++) { + map.put("signing_options[" + i + "]", getFromList(signingOptions, i)); + } + } + else { + map.put("signing_options", JSON.getDefault().getMapper().writeValueAsString(signingOptions)); + } + } + if (signingRedirectUrl != null) { + if (isFileTypeOrListOfFiles(signingRedirectUrl)) { + fileTypeFound = true; + } + + if (signingRedirectUrl.getClass().equals(java.io.File.class) || + signingRedirectUrl.getClass().equals(Integer.class) || + signingRedirectUrl.getClass().equals(String.class) || + signingRedirectUrl.getClass().isEnum()) { + map.put("signing_redirect_url", signingRedirectUrl); + } else if (isListOfFile(signingRedirectUrl)) { + for(int i = 0; i< getListSize(signingRedirectUrl); i++) { + map.put("signing_redirect_url[" + i + "]", getFromList(signingRedirectUrl, i)); + } + } + else { + map.put("signing_redirect_url", JSON.getDefault().getMapper().writeValueAsString(signingRedirectUrl)); + } + } + if (subject != null) { + if (isFileTypeOrListOfFiles(subject)) { + fileTypeFound = true; + } + + if (subject.getClass().equals(java.io.File.class) || + subject.getClass().equals(Integer.class) || + subject.getClass().equals(String.class) || + subject.getClass().isEnum()) { + map.put("subject", subject); + } else if (isListOfFile(subject)) { + for(int i = 0; i< getListSize(subject); i++) { + map.put("subject[" + i + "]", getFromList(subject, i)); + } + } + else { + map.put("subject", JSON.getDefault().getMapper().writeValueAsString(subject)); + } + } + 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 (title != null) { + if (isFileTypeOrListOfFiles(title)) { + fileTypeFound = true; + } + + if (title.getClass().equals(java.io.File.class) || + title.getClass().equals(Integer.class) || + title.getClass().equals(String.class) || + title.getClass().isEnum()) { + map.put("title", title); + } else if (isListOfFile(title)) { + for(int i = 0; i< getListSize(title); i++) { + map.put("title[" + i + "]", getFromList(title, i)); + } + } + else { + map.put("title", JSON.getDefault().getMapper().writeValueAsString(title)); + } + } + } 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/SignatureRequestGetResponse.java b/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java index 6f1fe1d..489a922 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestGetResponse.java @@ -40,13 +40,15 @@ SignatureRequestGetResponse.JSON_PROPERTY_SIGNATURE_REQUEST, SignatureRequestGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestGetResponse { public static final String JSON_PROPERTY_SIGNATURE_REQUEST = "signature_request"; + @jakarta.annotation.Nonnull private SignatureRequestResponse signatureRequest; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public SignatureRequestGetResponse() { @@ -67,7 +69,7 @@ static public SignatureRequestGetResponse init(HashMap data) throws Exception { ); } - public SignatureRequestGetResponse signatureRequest(SignatureRequestResponse signatureRequest) { + public SignatureRequestGetResponse signatureRequest(@jakarta.annotation.Nonnull SignatureRequestResponse signatureRequest) { this.signatureRequest = signatureRequest; return this; } @@ -87,12 +89,12 @@ public SignatureRequestResponse getSignatureRequest() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUEST) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignatureRequest(SignatureRequestResponse signatureRequest) { + public void setSignatureRequest(@jakarta.annotation.Nonnull SignatureRequestResponse signatureRequest) { this.signatureRequest = signatureRequest; } - public SignatureRequestGetResponse warnings(List warnings) { + public SignatureRequestGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java b/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java index cbb3d1f..5c81692 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestListResponse.java @@ -42,16 +42,19 @@ SignatureRequestListResponse.JSON_PROPERTY_LIST_INFO, SignatureRequestListResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestListResponse { public static final String JSON_PROPERTY_SIGNATURE_REQUESTS = "signature_requests"; + @jakarta.annotation.Nonnull private List signatureRequests = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public SignatureRequestListResponse() { @@ -72,7 +75,7 @@ static public SignatureRequestListResponse init(HashMap data) throws Exception { ); } - public SignatureRequestListResponse signatureRequests(List signatureRequests) { + public SignatureRequestListResponse signatureRequests(@jakarta.annotation.Nonnull List signatureRequests) { this.signatureRequests = signatureRequests; return this; } @@ -100,12 +103,12 @@ public List getSignatureRequests() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUESTS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignatureRequests(List signatureRequests) { + public void setSignatureRequests(@jakarta.annotation.Nonnull List signatureRequests) { this.signatureRequests = signatureRequests; } - public SignatureRequestListResponse listInfo(ListInfoResponse listInfo) { + public SignatureRequestListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public SignatureRequestListResponse warnings(List warnings) { + public SignatureRequestListResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestRemindRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestRemindRequest.java index b736aa7..dc2b5f5 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestRemindRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestRemindRequest.java @@ -36,13 +36,15 @@ SignatureRequestRemindRequest.JSON_PROPERTY_EMAIL_ADDRESS, SignatureRequestRemindRequest.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestRemindRequest { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public SignatureRequestRemindRequest() { @@ -63,7 +65,7 @@ static public SignatureRequestRemindRequest init(HashMap data) throws Exception ); } - public SignatureRequestRemindRequest emailAddress(String emailAddress) { + public SignatureRequestRemindRequest emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -83,12 +85,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } - public SignatureRequestRemindRequest name(String name) { + public SignatureRequestRemindRequest name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -108,7 +110,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java index 44fdde9..481b8bd 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponse.java @@ -67,82 +67,107 @@ SignatureRequestResponse.JSON_PROPERTY_SIGNATURES, SignatureRequestResponse.JSON_PROPERTY_BULK_SEND_JOB_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestResponse { public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_SIGNATURE_REQUEST_ID = "signature_request_id"; + @jakarta.annotation.Nullable private String signatureRequestId; public static final String JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS = "requester_email_address"; + @jakarta.annotation.Nullable private String requesterEmailAddress; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_ORIGINAL_TITLE = "original_title"; + @jakarta.annotation.Nullable private String originalTitle; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_CREATED_AT = "created_at"; + @jakarta.annotation.Nullable private Integer createdAt; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public static final String JSON_PROPERTY_IS_COMPLETE = "is_complete"; + @jakarta.annotation.Nullable private Boolean isComplete; public static final String JSON_PROPERTY_IS_DECLINED = "is_declined"; + @jakarta.annotation.Nullable private Boolean isDeclined; public static final String JSON_PROPERTY_HAS_ERROR = "has_error"; + @jakarta.annotation.Nullable private Boolean hasError; public static final String JSON_PROPERTY_FILES_URL = "files_url"; + @jakarta.annotation.Nullable private String filesUrl; public static final String JSON_PROPERTY_SIGNING_URL = "signing_url"; + @jakarta.annotation.Nullable private String signingUrl; public static final String JSON_PROPERTY_DETAILS_URL = "details_url"; + @jakarta.annotation.Nullable private String detailsUrl; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_FINAL_COPY_URI = "final_copy_uri"; + @jakarta.annotation.Nullable private String finalCopyUri; public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nullable private List templateIds = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_RESPONSE_DATA = "response_data"; + @jakarta.annotation.Nullable private List responseData = null; public static final String JSON_PROPERTY_SIGNATURES = "signatures"; + @jakarta.annotation.Nullable private List signatures = null; public static final String JSON_PROPERTY_BULK_SEND_JOB_ID = "bulk_send_job_id"; + @jakarta.annotation.Nullable private String bulkSendJobId; public SignatureRequestResponse() { @@ -163,7 +188,7 @@ static public SignatureRequestResponse init(HashMap data) throws Exception { ); } - public SignatureRequestResponse testMode(Boolean testMode) { + public SignatureRequestResponse testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -183,12 +208,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestResponse signatureRequestId(String signatureRequestId) { + public SignatureRequestResponse signatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; return this; } @@ -208,12 +233,12 @@ public String getSignatureRequestId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureRequestId(String signatureRequestId) { + public void setSignatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; } - public SignatureRequestResponse requesterEmailAddress(String requesterEmailAddress) { + public SignatureRequestResponse requesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; return this; } @@ -233,12 +258,12 @@ public String getRequesterEmailAddress() { @JsonProperty(JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequesterEmailAddress(String requesterEmailAddress) { + public void setRequesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; } - public SignatureRequestResponse title(String title) { + public SignatureRequestResponse title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -258,12 +283,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public SignatureRequestResponse originalTitle(String originalTitle) { + public SignatureRequestResponse originalTitle(@jakarta.annotation.Nullable String originalTitle) { this.originalTitle = originalTitle; return this; } @@ -283,12 +308,12 @@ public String getOriginalTitle() { @JsonProperty(JSON_PROPERTY_ORIGINAL_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOriginalTitle(String originalTitle) { + public void setOriginalTitle(@jakarta.annotation.Nullable String originalTitle) { this.originalTitle = originalTitle; } - public SignatureRequestResponse subject(String subject) { + public SignatureRequestResponse subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -308,12 +333,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestResponse message(String message) { + public SignatureRequestResponse message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -333,12 +358,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestResponse metadata(Map metadata) { + public SignatureRequestResponse metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -366,12 +391,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestResponse createdAt(Integer createdAt) { + public SignatureRequestResponse createdAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; return this; } @@ -391,12 +416,12 @@ public Integer getCreatedAt() { @JsonProperty(JSON_PROPERTY_CREATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCreatedAt(Integer createdAt) { + public void setCreatedAt(@jakarta.annotation.Nullable Integer createdAt) { this.createdAt = createdAt; } - public SignatureRequestResponse expiresAt(Integer expiresAt) { + public SignatureRequestResponse expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -416,12 +441,12 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } - public SignatureRequestResponse isComplete(Boolean isComplete) { + public SignatureRequestResponse isComplete(@jakarta.annotation.Nullable Boolean isComplete) { this.isComplete = isComplete; return this; } @@ -441,12 +466,12 @@ public Boolean getIsComplete() { @JsonProperty(JSON_PROPERTY_IS_COMPLETE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsComplete(Boolean isComplete) { + public void setIsComplete(@jakarta.annotation.Nullable Boolean isComplete) { this.isComplete = isComplete; } - public SignatureRequestResponse isDeclined(Boolean isDeclined) { + public SignatureRequestResponse isDeclined(@jakarta.annotation.Nullable Boolean isDeclined) { this.isDeclined = isDeclined; return this; } @@ -466,12 +491,12 @@ public Boolean getIsDeclined() { @JsonProperty(JSON_PROPERTY_IS_DECLINED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsDeclined(Boolean isDeclined) { + public void setIsDeclined(@jakarta.annotation.Nullable Boolean isDeclined) { this.isDeclined = isDeclined; } - public SignatureRequestResponse hasError(Boolean hasError) { + public SignatureRequestResponse hasError(@jakarta.annotation.Nullable Boolean hasError) { this.hasError = hasError; return this; } @@ -491,12 +516,12 @@ public Boolean getHasError() { @JsonProperty(JSON_PROPERTY_HAS_ERROR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHasError(Boolean hasError) { + public void setHasError(@jakarta.annotation.Nullable Boolean hasError) { this.hasError = hasError; } - public SignatureRequestResponse filesUrl(String filesUrl) { + public SignatureRequestResponse filesUrl(@jakarta.annotation.Nullable String filesUrl) { this.filesUrl = filesUrl; return this; } @@ -516,12 +541,12 @@ public String getFilesUrl() { @JsonProperty(JSON_PROPERTY_FILES_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFilesUrl(String filesUrl) { + public void setFilesUrl(@jakarta.annotation.Nullable String filesUrl) { this.filesUrl = filesUrl; } - public SignatureRequestResponse signingUrl(String signingUrl) { + public SignatureRequestResponse signingUrl(@jakarta.annotation.Nullable String signingUrl) { this.signingUrl = signingUrl; return this; } @@ -541,12 +566,12 @@ public String getSigningUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningUrl(String signingUrl) { + public void setSigningUrl(@jakarta.annotation.Nullable String signingUrl) { this.signingUrl = signingUrl; } - public SignatureRequestResponse detailsUrl(String detailsUrl) { + public SignatureRequestResponse detailsUrl(@jakarta.annotation.Nullable String detailsUrl) { this.detailsUrl = detailsUrl; return this; } @@ -566,12 +591,12 @@ public String getDetailsUrl() { @JsonProperty(JSON_PROPERTY_DETAILS_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDetailsUrl(String detailsUrl) { + public void setDetailsUrl(@jakarta.annotation.Nullable String detailsUrl) { this.detailsUrl = detailsUrl; } - public SignatureRequestResponse ccEmailAddresses(List ccEmailAddresses) { + public SignatureRequestResponse ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -599,12 +624,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public SignatureRequestResponse signingRedirectUrl(String signingRedirectUrl) { + public SignatureRequestResponse signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -624,12 +649,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public SignatureRequestResponse finalCopyUri(String finalCopyUri) { + public SignatureRequestResponse finalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; return this; } @@ -649,12 +674,12 @@ public String getFinalCopyUri() { @JsonProperty(JSON_PROPERTY_FINAL_COPY_URI) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFinalCopyUri(String finalCopyUri) { + public void setFinalCopyUri(@jakarta.annotation.Nullable String finalCopyUri) { this.finalCopyUri = finalCopyUri; } - public SignatureRequestResponse templateIds(List templateIds) { + public SignatureRequestResponse templateIds(@jakarta.annotation.Nullable List templateIds) { this.templateIds = templateIds; return this; } @@ -682,12 +707,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nullable List templateIds) { this.templateIds = templateIds; } - public SignatureRequestResponse customFields(List customFields) { + public SignatureRequestResponse customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -715,12 +740,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestResponse attachments(List attachments) { + public SignatureRequestResponse attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -748,12 +773,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public SignatureRequestResponse responseData(List responseData) { + public SignatureRequestResponse responseData(@jakarta.annotation.Nullable List responseData) { this.responseData = responseData; return this; } @@ -781,12 +806,12 @@ public List getResponseData() { @JsonProperty(JSON_PROPERTY_RESPONSE_DATA) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResponseData(List responseData) { + public void setResponseData(@jakarta.annotation.Nullable List responseData) { this.responseData = responseData; } - public SignatureRequestResponse signatures(List signatures) { + public SignatureRequestResponse signatures(@jakarta.annotation.Nullable List signatures) { this.signatures = signatures; return this; } @@ -814,12 +839,12 @@ public List getSignatures() { @JsonProperty(JSON_PROPERTY_SIGNATURES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatures(List signatures) { + public void setSignatures(@jakarta.annotation.Nullable List signatures) { this.signatures = signatures; } - public SignatureRequestResponse bulkSendJobId(String bulkSendJobId) { + public SignatureRequestResponse bulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; return this; } @@ -839,7 +864,7 @@ public String getBulkSendJobId() { @JsonProperty(JSON_PROPERTY_BULK_SEND_JOB_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setBulkSendJobId(String bulkSendJobId) { + public void setBulkSendJobId(@jakarta.annotation.Nullable String bulkSendJobId) { this.bulkSendJobId = bulkSendJobId; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java index 125fc66..388774f 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseAttachment.java @@ -40,25 +40,31 @@ SignatureRequestResponseAttachment.JSON_PROPERTY_INSTRUCTIONS, SignatureRequestResponseAttachment.JSON_PROPERTY_UPLOADED_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestResponseAttachment { public static final String JSON_PROPERTY_ID = "id"; + @jakarta.annotation.Nonnull private String id; public static final String JSON_PROPERTY_SIGNER = "signer"; + @jakarta.annotation.Nonnull private String signer; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nonnull private Boolean required; public static final String JSON_PROPERTY_INSTRUCTIONS = "instructions"; + @jakarta.annotation.Nullable private String instructions; public static final String JSON_PROPERTY_UPLOADED_AT = "uploaded_at"; + @jakarta.annotation.Nullable private Integer uploadedAt; public SignatureRequestResponseAttachment() { @@ -79,7 +85,7 @@ static public SignatureRequestResponseAttachment init(HashMap data) throws Excep ); } - public SignatureRequestResponseAttachment id(String id) { + public SignatureRequestResponseAttachment id(@jakarta.annotation.Nonnull String id) { this.id = id; return this; } @@ -99,12 +105,12 @@ public String getId() { @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setId(String id) { + public void setId(@jakarta.annotation.Nonnull String id) { this.id = id; } - public SignatureRequestResponseAttachment signer(String signer) { + public SignatureRequestResponseAttachment signer(@jakarta.annotation.Nonnull String signer) { this.signer = signer; return this; } @@ -128,7 +134,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSigner(String signer) { + public void setSigner(@jakarta.annotation.Nonnull String signer) { this.signer = signer; } @@ -137,7 +143,7 @@ public void setSigner(Integer signer) { } - public SignatureRequestResponseAttachment name(String name) { + public SignatureRequestResponseAttachment name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -157,12 +163,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SignatureRequestResponseAttachment required(Boolean required) { + public SignatureRequestResponseAttachment required(@jakarta.annotation.Nonnull Boolean required) { this.required = required; return this; } @@ -182,12 +188,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nonnull Boolean required) { this.required = required; } - public SignatureRequestResponseAttachment instructions(String instructions) { + public SignatureRequestResponseAttachment instructions(@jakarta.annotation.Nullable String instructions) { this.instructions = instructions; return this; } @@ -207,12 +213,12 @@ public String getInstructions() { @JsonProperty(JSON_PROPERTY_INSTRUCTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInstructions(String instructions) { + public void setInstructions(@jakarta.annotation.Nullable String instructions) { this.instructions = instructions; } - public SignatureRequestResponseAttachment uploadedAt(Integer uploadedAt) { + public SignatureRequestResponseAttachment uploadedAt(@jakarta.annotation.Nullable Integer uploadedAt) { this.uploadedAt = uploadedAt; return this; } @@ -232,7 +238,7 @@ public Integer getUploadedAt() { @JsonProperty(JSON_PROPERTY_UPLOADED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUploadedAt(Integer uploadedAt) { + public void setUploadedAt(@jakarta.annotation.Nullable Integer uploadedAt) { this.uploadedAt = uploadedAt; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java index fca2222..0901f46 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldBase.java @@ -42,7 +42,7 @@ SignatureRequestResponseCustomFieldBase.JSON_PROPERTY_API_ID, SignatureRequestResponseCustomFieldBase.JSON_PROPERTY_EDITOR }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -55,18 +55,23 @@ public class SignatureRequestResponseCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required; public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nullable private String apiId; public static final String JSON_PROPERTY_EDITOR = "editor"; + @jakarta.annotation.Nullable private String editor; public SignatureRequestResponseCustomFieldBase() { @@ -87,7 +92,7 @@ static public SignatureRequestResponseCustomFieldBase init(HashMap data) throws ); } - public SignatureRequestResponseCustomFieldBase type(String type) { + public SignatureRequestResponseCustomFieldBase type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -107,12 +112,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SignatureRequestResponseCustomFieldBase name(String name) { + public SignatureRequestResponseCustomFieldBase name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -132,12 +137,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SignatureRequestResponseCustomFieldBase required(Boolean required) { + public SignatureRequestResponseCustomFieldBase required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -157,12 +162,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } - public SignatureRequestResponseCustomFieldBase apiId(String apiId) { + public SignatureRequestResponseCustomFieldBase apiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; return this; } @@ -182,12 +187,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; } - public SignatureRequestResponseCustomFieldBase editor(String editor) { + public SignatureRequestResponseCustomFieldBase editor(@jakarta.annotation.Nullable String editor) { this.editor = editor; return this; } @@ -207,7 +212,7 @@ public String getEditor() { @JsonProperty(JSON_PROPERTY_EDITOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditor(String editor) { + public void setEditor(@jakarta.annotation.Nullable String editor) { this.editor = editor; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java index 9943467..7ab1636 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldCheckbox.java @@ -40,7 +40,7 @@ SignatureRequestResponseCustomFieldCheckbox.JSON_PROPERTY_TYPE, SignatureRequestResponseCustomFieldCheckbox.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseCustomFieldCheckbox extends SignatureRequestResponseCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private Boolean value; public SignatureRequestResponseCustomFieldCheckbox() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseCustomFieldCheckbox init(HashMap data) thr ); } - public SignatureRequestResponseCustomFieldCheckbox type(String type) { + public SignatureRequestResponseCustomFieldCheckbox type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SignatureRequestResponseCustomFieldCheckbox value(Boolean value) { + public SignatureRequestResponseCustomFieldCheckbox value(@jakarta.annotation.Nullable Boolean value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public Boolean getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(Boolean value) { + public void setValue(@jakarta.annotation.Nullable Boolean value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java index 9c7e628..7157610 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseCustomFieldText.java @@ -40,7 +40,7 @@ SignatureRequestResponseCustomFieldText.JSON_PROPERTY_TYPE, SignatureRequestResponseCustomFieldText.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseCustomFieldText extends SignatureRequestResponseCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseCustomFieldText() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseCustomFieldText init(HashMap data) throws ); } - public SignatureRequestResponseCustomFieldText type(String type) { + public SignatureRequestResponseCustomFieldText type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SignatureRequestResponseCustomFieldText value(String value) { + public SignatureRequestResponseCustomFieldText value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java index 5478862..d572079 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataBase.java @@ -42,7 +42,7 @@ SignatureRequestResponseDataBase.JSON_PROPERTY_REQUIRED, SignatureRequestResponseDataBase.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -62,18 +62,23 @@ public class SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nullable private String apiId; public static final String JSON_PROPERTY_SIGNATURE_ID = "signature_id"; + @jakarta.annotation.Nullable private String signatureId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required; public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type; public SignatureRequestResponseDataBase() { @@ -94,7 +99,7 @@ static public SignatureRequestResponseDataBase init(HashMap data) throws Excepti ); } - public SignatureRequestResponseDataBase apiId(String apiId) { + public SignatureRequestResponseDataBase apiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; return this; } @@ -114,12 +119,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; } - public SignatureRequestResponseDataBase signatureId(String signatureId) { + public SignatureRequestResponseDataBase signatureId(@jakarta.annotation.Nullable String signatureId) { this.signatureId = signatureId; return this; } @@ -139,12 +144,12 @@ public String getSignatureId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureId(String signatureId) { + public void setSignatureId(@jakarta.annotation.Nullable String signatureId) { this.signatureId = signatureId; } - public SignatureRequestResponseDataBase name(String name) { + public SignatureRequestResponseDataBase name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -164,12 +169,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public SignatureRequestResponseDataBase required(Boolean required) { + public SignatureRequestResponseDataBase required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -189,12 +194,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } - public SignatureRequestResponseDataBase type(String type) { + public SignatureRequestResponseDataBase type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -214,7 +219,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java index ed72505..ea881f7 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckbox.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueCheckbox.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueCheckbox.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueCheckbox extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "checkbox"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private Boolean value; public SignatureRequestResponseDataValueCheckbox() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueCheckbox init(HashMap data) throw ); } - public SignatureRequestResponseDataValueCheckbox type(String type) { + public SignatureRequestResponseDataValueCheckbox type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueCheckbox value(Boolean value) { + public SignatureRequestResponseDataValueCheckbox value(@jakarta.annotation.Nullable Boolean value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public Boolean getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(Boolean value) { + public void setValue(@jakarta.annotation.Nullable Boolean value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java index 386212b..b365554 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueCheckboxMerge.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueCheckboxMerge.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueCheckboxMerge.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueCheckboxMerge extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "checkbox-merge"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseDataValueCheckboxMerge() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueCheckboxMerge init(HashMap data) ); } - public SignatureRequestResponseDataValueCheckboxMerge type(String type) { + public SignatureRequestResponseDataValueCheckboxMerge type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueCheckboxMerge value(String value) { + public SignatureRequestResponseDataValueCheckboxMerge value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java index c793034..6c8c351 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDateSigned.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueDateSigned.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueDateSigned.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueDateSigned extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "date_signed"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseDataValueDateSigned() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueDateSigned init(HashMap data) thr ); } - public SignatureRequestResponseDataValueDateSigned type(String type) { + public SignatureRequestResponseDataValueDateSigned type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueDateSigned value(String value) { + public SignatureRequestResponseDataValueDateSigned value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java index 9f72ae3..8d7a842 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueDropdown.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueDropdown.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueDropdown.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueDropdown extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "dropdown"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseDataValueDropdown() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueDropdown init(HashMap data) throw ); } - public SignatureRequestResponseDataValueDropdown type(String type) { + public SignatureRequestResponseDataValueDropdown type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueDropdown value(String value) { + public SignatureRequestResponseDataValueDropdown value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java index 3724d3e..1a68d9a 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueInitials.java @@ -41,7 +41,7 @@ SignatureRequestResponseDataValueInitials.JSON_PROPERTY_VALUE, SignatureRequestResponseDataValueInitials.JSON_PROPERTY_IS_SIGNED }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,12 +50,15 @@ public class SignatureRequestResponseDataValueInitials extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "initials"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public static final String JSON_PROPERTY_IS_SIGNED = "is_signed"; + @jakarta.annotation.Nullable private Boolean isSigned; public SignatureRequestResponseDataValueInitials() { @@ -76,7 +79,7 @@ static public SignatureRequestResponseDataValueInitials init(HashMap data) throw ); } - public SignatureRequestResponseDataValueInitials type(String type) { + public SignatureRequestResponseDataValueInitials type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -96,12 +99,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueInitials value(String value) { + public SignatureRequestResponseDataValueInitials value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -121,12 +124,12 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } - public SignatureRequestResponseDataValueInitials isSigned(Boolean isSigned) { + public SignatureRequestResponseDataValueInitials isSigned(@jakarta.annotation.Nullable Boolean isSigned) { this.isSigned = isSigned; return this; } @@ -146,7 +149,7 @@ public Boolean getIsSigned() { @JsonProperty(JSON_PROPERTY_IS_SIGNED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsSigned(Boolean isSigned) { + public void setIsSigned(@jakarta.annotation.Nullable Boolean isSigned) { this.isSigned = isSigned; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java index a317694..027c4d9 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueRadio.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueRadio.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueRadio.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueRadio extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "radio"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private Boolean value; public SignatureRequestResponseDataValueRadio() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueRadio init(HashMap data) throws E ); } - public SignatureRequestResponseDataValueRadio type(String type) { + public SignatureRequestResponseDataValueRadio type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueRadio value(Boolean value) { + public SignatureRequestResponseDataValueRadio value(@jakarta.annotation.Nullable Boolean value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public Boolean getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(Boolean value) { + public void setValue(@jakarta.annotation.Nullable Boolean value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java index 1a789fb..95953be 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueSignature.java @@ -41,7 +41,7 @@ SignatureRequestResponseDataValueSignature.JSON_PROPERTY_VALUE, SignatureRequestResponseDataValueSignature.JSON_PROPERTY_IS_SIGNED }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,12 +50,15 @@ public class SignatureRequestResponseDataValueSignature extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "signature"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public static final String JSON_PROPERTY_IS_SIGNED = "is_signed"; + @jakarta.annotation.Nullable private Boolean isSigned; public SignatureRequestResponseDataValueSignature() { @@ -76,7 +79,7 @@ static public SignatureRequestResponseDataValueSignature init(HashMap data) thro ); } - public SignatureRequestResponseDataValueSignature type(String type) { + public SignatureRequestResponseDataValueSignature type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -96,12 +99,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueSignature value(String value) { + public SignatureRequestResponseDataValueSignature value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -121,12 +124,12 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } - public SignatureRequestResponseDataValueSignature isSigned(Boolean isSigned) { + public SignatureRequestResponseDataValueSignature isSigned(@jakarta.annotation.Nullable Boolean isSigned) { this.isSigned = isSigned; return this; } @@ -146,7 +149,7 @@ public Boolean getIsSigned() { @JsonProperty(JSON_PROPERTY_IS_SIGNED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsSigned(Boolean isSigned) { + public void setIsSigned(@jakarta.annotation.Nullable Boolean isSigned) { this.isSigned = isSigned; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java index 47f82d4..6322548 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueText.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueText.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueText.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueText extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "text"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseDataValueText() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueText init(HashMap data) throws Ex ); } - public SignatureRequestResponseDataValueText type(String type) { + public SignatureRequestResponseDataValueText type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueText value(String value) { + public SignatureRequestResponseDataValueText value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java index c25f4b1..b420f75 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseDataValueTextMerge.java @@ -40,7 +40,7 @@ SignatureRequestResponseDataValueTextMerge.JSON_PROPERTY_TYPE, SignatureRequestResponseDataValueTextMerge.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class SignatureRequestResponseDataValueTextMerge extends SignatureRequestResponseDataBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private String type = "text-merge"; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SignatureRequestResponseDataValueTextMerge() { @@ -72,7 +74,7 @@ static public SignatureRequestResponseDataValueTextMerge init(HashMap data) thro ); } - public SignatureRequestResponseDataValueTextMerge type(String type) { + public SignatureRequestResponseDataValueTextMerge type(@jakarta.annotation.Nullable String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nullable String type) { this.type = type; } - public SignatureRequestResponseDataValueTextMerge value(String value) { + public SignatureRequestResponseDataValueTextMerge value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -117,7 +119,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java index 16e2020..59472ad 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestResponseSignatures.java @@ -53,64 +53,83 @@ SignatureRequestResponseSignatures.JSON_PROPERTY_REASSIGNED_FROM, SignatureRequestResponseSignatures.JSON_PROPERTY_ERROR }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestResponseSignatures { public static final String JSON_PROPERTY_SIGNATURE_ID = "signature_id"; + @jakarta.annotation.Nullable private String signatureId; public static final String JSON_PROPERTY_SIGNER_GROUP_GUID = "signer_group_guid"; + @jakarta.annotation.Nullable private String signerGroupGuid; public static final String JSON_PROPERTY_SIGNER_EMAIL_ADDRESS = "signer_email_address"; + @jakarta.annotation.Nullable private String signerEmailAddress; public static final String JSON_PROPERTY_SIGNER_NAME = "signer_name"; + @jakarta.annotation.Nullable private String signerName; public static final String JSON_PROPERTY_SIGNER_ROLE = "signer_role"; + @jakarta.annotation.Nullable private String signerRole; public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public static final String JSON_PROPERTY_STATUS_CODE = "status_code"; + @jakarta.annotation.Nullable private String statusCode; public static final String JSON_PROPERTY_DECLINE_REASON = "decline_reason"; + @jakarta.annotation.Nullable private String declineReason; public static final String JSON_PROPERTY_SIGNED_AT = "signed_at"; + @jakarta.annotation.Nullable private Integer signedAt; public static final String JSON_PROPERTY_LAST_VIEWED_AT = "last_viewed_at"; + @jakarta.annotation.Nullable private Integer lastViewedAt; public static final String JSON_PROPERTY_LAST_REMINDED_AT = "last_reminded_at"; + @jakarta.annotation.Nullable private Integer lastRemindedAt; public static final String JSON_PROPERTY_HAS_PIN = "has_pin"; + @jakarta.annotation.Nullable private Boolean hasPin; public static final String JSON_PROPERTY_HAS_SMS_AUTH = "has_sms_auth"; + @jakarta.annotation.Nullable private Boolean hasSmsAuth; public static final String JSON_PROPERTY_HAS_SMS_DELIVERY = "has_sms_delivery"; + @jakarta.annotation.Nullable private Boolean hasSmsDelivery; public static final String JSON_PROPERTY_SMS_PHONE_NUMBER = "sms_phone_number"; + @jakarta.annotation.Nullable private String smsPhoneNumber; public static final String JSON_PROPERTY_REASSIGNED_BY = "reassigned_by"; + @jakarta.annotation.Nullable private String reassignedBy; public static final String JSON_PROPERTY_REASSIGNMENT_REASON = "reassignment_reason"; + @jakarta.annotation.Nullable private String reassignmentReason; public static final String JSON_PROPERTY_REASSIGNED_FROM = "reassigned_from"; + @jakarta.annotation.Nullable private String reassignedFrom; public static final String JSON_PROPERTY_ERROR = "error"; + @jakarta.annotation.Nullable private String error; public SignatureRequestResponseSignatures() { @@ -131,7 +150,7 @@ static public SignatureRequestResponseSignatures init(HashMap data) throws Excep ); } - public SignatureRequestResponseSignatures signatureId(String signatureId) { + public SignatureRequestResponseSignatures signatureId(@jakarta.annotation.Nullable String signatureId) { this.signatureId = signatureId; return this; } @@ -151,12 +170,12 @@ public String getSignatureId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureId(String signatureId) { + public void setSignatureId(@jakarta.annotation.Nullable String signatureId) { this.signatureId = signatureId; } - public SignatureRequestResponseSignatures signerGroupGuid(String signerGroupGuid) { + public SignatureRequestResponseSignatures signerGroupGuid(@jakarta.annotation.Nullable String signerGroupGuid) { this.signerGroupGuid = signerGroupGuid; return this; } @@ -176,12 +195,12 @@ public String getSignerGroupGuid() { @JsonProperty(JSON_PROPERTY_SIGNER_GROUP_GUID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerGroupGuid(String signerGroupGuid) { + public void setSignerGroupGuid(@jakarta.annotation.Nullable String signerGroupGuid) { this.signerGroupGuid = signerGroupGuid; } - public SignatureRequestResponseSignatures signerEmailAddress(String signerEmailAddress) { + public SignatureRequestResponseSignatures signerEmailAddress(@jakarta.annotation.Nullable String signerEmailAddress) { this.signerEmailAddress = signerEmailAddress; return this; } @@ -201,12 +220,12 @@ public String getSignerEmailAddress() { @JsonProperty(JSON_PROPERTY_SIGNER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerEmailAddress(String signerEmailAddress) { + public void setSignerEmailAddress(@jakarta.annotation.Nullable String signerEmailAddress) { this.signerEmailAddress = signerEmailAddress; } - public SignatureRequestResponseSignatures signerName(String signerName) { + public SignatureRequestResponseSignatures signerName(@jakarta.annotation.Nullable String signerName) { this.signerName = signerName; return this; } @@ -226,12 +245,12 @@ public String getSignerName() { @JsonProperty(JSON_PROPERTY_SIGNER_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerName(String signerName) { + public void setSignerName(@jakarta.annotation.Nullable String signerName) { this.signerName = signerName; } - public SignatureRequestResponseSignatures signerRole(String signerRole) { + public SignatureRequestResponseSignatures signerRole(@jakarta.annotation.Nullable String signerRole) { this.signerRole = signerRole; return this; } @@ -251,12 +270,12 @@ public String getSignerRole() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerRole(String signerRole) { + public void setSignerRole(@jakarta.annotation.Nullable String signerRole) { this.signerRole = signerRole; } - public SignatureRequestResponseSignatures order(Integer order) { + public SignatureRequestResponseSignatures order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -276,12 +295,12 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } - public SignatureRequestResponseSignatures statusCode(String statusCode) { + public SignatureRequestResponseSignatures statusCode(@jakarta.annotation.Nullable String statusCode) { this.statusCode = statusCode; return this; } @@ -301,12 +320,12 @@ public String getStatusCode() { @JsonProperty(JSON_PROPERTY_STATUS_CODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setStatusCode(String statusCode) { + public void setStatusCode(@jakarta.annotation.Nullable String statusCode) { this.statusCode = statusCode; } - public SignatureRequestResponseSignatures declineReason(String declineReason) { + public SignatureRequestResponseSignatures declineReason(@jakarta.annotation.Nullable String declineReason) { this.declineReason = declineReason; return this; } @@ -326,12 +345,12 @@ public String getDeclineReason() { @JsonProperty(JSON_PROPERTY_DECLINE_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDeclineReason(String declineReason) { + public void setDeclineReason(@jakarta.annotation.Nullable String declineReason) { this.declineReason = declineReason; } - public SignatureRequestResponseSignatures signedAt(Integer signedAt) { + public SignatureRequestResponseSignatures signedAt(@jakarta.annotation.Nullable Integer signedAt) { this.signedAt = signedAt; return this; } @@ -351,12 +370,12 @@ public Integer getSignedAt() { @JsonProperty(JSON_PROPERTY_SIGNED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignedAt(Integer signedAt) { + public void setSignedAt(@jakarta.annotation.Nullable Integer signedAt) { this.signedAt = signedAt; } - public SignatureRequestResponseSignatures lastViewedAt(Integer lastViewedAt) { + public SignatureRequestResponseSignatures lastViewedAt(@jakarta.annotation.Nullable Integer lastViewedAt) { this.lastViewedAt = lastViewedAt; return this; } @@ -376,12 +395,12 @@ public Integer getLastViewedAt() { @JsonProperty(JSON_PROPERTY_LAST_VIEWED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLastViewedAt(Integer lastViewedAt) { + public void setLastViewedAt(@jakarta.annotation.Nullable Integer lastViewedAt) { this.lastViewedAt = lastViewedAt; } - public SignatureRequestResponseSignatures lastRemindedAt(Integer lastRemindedAt) { + public SignatureRequestResponseSignatures lastRemindedAt(@jakarta.annotation.Nullable Integer lastRemindedAt) { this.lastRemindedAt = lastRemindedAt; return this; } @@ -401,12 +420,12 @@ public Integer getLastRemindedAt() { @JsonProperty(JSON_PROPERTY_LAST_REMINDED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLastRemindedAt(Integer lastRemindedAt) { + public void setLastRemindedAt(@jakarta.annotation.Nullable Integer lastRemindedAt) { this.lastRemindedAt = lastRemindedAt; } - public SignatureRequestResponseSignatures hasPin(Boolean hasPin) { + public SignatureRequestResponseSignatures hasPin(@jakarta.annotation.Nullable Boolean hasPin) { this.hasPin = hasPin; return this; } @@ -426,12 +445,12 @@ public Boolean getHasPin() { @JsonProperty(JSON_PROPERTY_HAS_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHasPin(Boolean hasPin) { + public void setHasPin(@jakarta.annotation.Nullable Boolean hasPin) { this.hasPin = hasPin; } - public SignatureRequestResponseSignatures hasSmsAuth(Boolean hasSmsAuth) { + public SignatureRequestResponseSignatures hasSmsAuth(@jakarta.annotation.Nullable Boolean hasSmsAuth) { this.hasSmsAuth = hasSmsAuth; return this; } @@ -451,12 +470,12 @@ public Boolean getHasSmsAuth() { @JsonProperty(JSON_PROPERTY_HAS_SMS_AUTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHasSmsAuth(Boolean hasSmsAuth) { + public void setHasSmsAuth(@jakarta.annotation.Nullable Boolean hasSmsAuth) { this.hasSmsAuth = hasSmsAuth; } - public SignatureRequestResponseSignatures hasSmsDelivery(Boolean hasSmsDelivery) { + public SignatureRequestResponseSignatures hasSmsDelivery(@jakarta.annotation.Nullable Boolean hasSmsDelivery) { this.hasSmsDelivery = hasSmsDelivery; return this; } @@ -476,12 +495,12 @@ public Boolean getHasSmsDelivery() { @JsonProperty(JSON_PROPERTY_HAS_SMS_DELIVERY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHasSmsDelivery(Boolean hasSmsDelivery) { + public void setHasSmsDelivery(@jakarta.annotation.Nullable Boolean hasSmsDelivery) { this.hasSmsDelivery = hasSmsDelivery; } - public SignatureRequestResponseSignatures smsPhoneNumber(String smsPhoneNumber) { + public SignatureRequestResponseSignatures smsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; return this; } @@ -501,12 +520,12 @@ public String getSmsPhoneNumber() { @JsonProperty(JSON_PROPERTY_SMS_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsPhoneNumber(String smsPhoneNumber) { + public void setSmsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; } - public SignatureRequestResponseSignatures reassignedBy(String reassignedBy) { + public SignatureRequestResponseSignatures reassignedBy(@jakarta.annotation.Nullable String reassignedBy) { this.reassignedBy = reassignedBy; return this; } @@ -526,12 +545,12 @@ public String getReassignedBy() { @JsonProperty(JSON_PROPERTY_REASSIGNED_BY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReassignedBy(String reassignedBy) { + public void setReassignedBy(@jakarta.annotation.Nullable String reassignedBy) { this.reassignedBy = reassignedBy; } - public SignatureRequestResponseSignatures reassignmentReason(String reassignmentReason) { + public SignatureRequestResponseSignatures reassignmentReason(@jakarta.annotation.Nullable String reassignmentReason) { this.reassignmentReason = reassignmentReason; return this; } @@ -551,12 +570,12 @@ public String getReassignmentReason() { @JsonProperty(JSON_PROPERTY_REASSIGNMENT_REASON) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReassignmentReason(String reassignmentReason) { + public void setReassignmentReason(@jakarta.annotation.Nullable String reassignmentReason) { this.reassignmentReason = reassignmentReason; } - public SignatureRequestResponseSignatures reassignedFrom(String reassignedFrom) { + public SignatureRequestResponseSignatures reassignedFrom(@jakarta.annotation.Nullable String reassignedFrom) { this.reassignedFrom = reassignedFrom; return this; } @@ -576,12 +595,12 @@ public String getReassignedFrom() { @JsonProperty(JSON_PROPERTY_REASSIGNED_FROM) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setReassignedFrom(String reassignedFrom) { + public void setReassignedFrom(@jakarta.annotation.Nullable String reassignedFrom) { this.reassignedFrom = reassignedFrom; } - public SignatureRequestResponseSignatures error(String error) { + public SignatureRequestResponseSignatures error(@jakarta.annotation.Nullable String error) { this.error = error; return this; } @@ -601,7 +620,7 @@ public String getError() { @JsonProperty(JSON_PROPERTY_ERROR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setError(String error) { + public void setError(@jakarta.annotation.Nullable String error) { this.error = error; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java index 160f345..a76ab91 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestSendRequest.java @@ -74,86 +74,112 @@ SignatureRequestSendRequest.JSON_PROPERTY_USE_TEXT_TAGS, SignatureRequestSendRequest.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestSendRequest { public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public static final String JSON_PROPERTY_GROUPED_SIGNERS = "grouped_signers"; + @jakarta.annotation.Nullable private List groupedSigners = null; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable private List formFieldsPerDocument = null; public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable private Boolean hideTextTags = false; public static final String JSON_PROPERTY_IS_QUALIFIED_SIGNATURE = "is_qualified_signature"; @Deprecated + @jakarta.annotation.Nullable private Boolean isQualifiedSignature = false; public static final String JSON_PROPERTY_IS_EID = "is_eid"; + @jakarta.annotation.Nullable private Boolean isEid = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable private Boolean useTextTags = false; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public SignatureRequestSendRequest() { @@ -174,7 +200,7 @@ static public SignatureRequestSendRequest init(HashMap data) throws Exception { ); } - public SignatureRequestSendRequest files(List files) { + public SignatureRequestSendRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -202,12 +228,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public SignatureRequestSendRequest fileUrls(List fileUrls) { + public SignatureRequestSendRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -235,12 +261,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public SignatureRequestSendRequest signers(List signers) { + public SignatureRequestSendRequest signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -268,12 +294,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } - public SignatureRequestSendRequest groupedSigners(List groupedSigners) { + public SignatureRequestSendRequest groupedSigners(@jakarta.annotation.Nullable List groupedSigners) { this.groupedSigners = groupedSigners; return this; } @@ -301,12 +327,12 @@ public List getGroupedSigners() { @JsonProperty(JSON_PROPERTY_GROUPED_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupedSigners(List groupedSigners) { + public void setGroupedSigners(@jakarta.annotation.Nullable List groupedSigners) { this.groupedSigners = groupedSigners; } - public SignatureRequestSendRequest allowDecline(Boolean allowDecline) { + public SignatureRequestSendRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -326,12 +352,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestSendRequest allowReassign(Boolean allowReassign) { + public SignatureRequestSendRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -351,12 +377,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public SignatureRequestSendRequest attachments(List attachments) { + public SignatureRequestSendRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -384,12 +410,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public SignatureRequestSendRequest ccEmailAddresses(List ccEmailAddresses) { + public SignatureRequestSendRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -417,12 +443,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public SignatureRequestSendRequest clientId(String clientId) { + public SignatureRequestSendRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -442,12 +468,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public SignatureRequestSendRequest customFields(List customFields) { + public SignatureRequestSendRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -475,12 +501,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestSendRequest fieldOptions(SubFieldOptions fieldOptions) { + public SignatureRequestSendRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -500,12 +526,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public SignatureRequestSendRequest formFieldGroups(List formFieldGroups) { + public SignatureRequestSendRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -533,12 +559,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public SignatureRequestSendRequest formFieldRules(List formFieldRules) { + public SignatureRequestSendRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -566,12 +592,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public SignatureRequestSendRequest formFieldsPerDocument(List formFieldsPerDocument) { + public SignatureRequestSendRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -599,12 +625,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public SignatureRequestSendRequest hideTextTags(Boolean hideTextTags) { + public SignatureRequestSendRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; return this; } @@ -624,13 +650,13 @@ public Boolean getHideTextTags() { @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHideTextTags(Boolean hideTextTags) { + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; } @Deprecated - public SignatureRequestSendRequest isQualifiedSignature(Boolean isQualifiedSignature) { + public SignatureRequestSendRequest isQualifiedSignature(@jakarta.annotation.Nullable Boolean isQualifiedSignature) { this.isQualifiedSignature = isQualifiedSignature; return this; } @@ -653,12 +679,12 @@ public Boolean getIsQualifiedSignature() { @Deprecated @JsonProperty(JSON_PROPERTY_IS_QUALIFIED_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsQualifiedSignature(Boolean isQualifiedSignature) { + public void setIsQualifiedSignature(@jakarta.annotation.Nullable Boolean isQualifiedSignature) { this.isQualifiedSignature = isQualifiedSignature; } - public SignatureRequestSendRequest isEid(Boolean isEid) { + public SignatureRequestSendRequest isEid(@jakarta.annotation.Nullable Boolean isEid) { this.isEid = isEid; return this; } @@ -678,12 +704,12 @@ public Boolean getIsEid() { @JsonProperty(JSON_PROPERTY_IS_EID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEid(Boolean isEid) { + public void setIsEid(@jakarta.annotation.Nullable Boolean isEid) { this.isEid = isEid; } - public SignatureRequestSendRequest message(String message) { + public SignatureRequestSendRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -703,12 +729,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestSendRequest metadata(Map metadata) { + public SignatureRequestSendRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -736,12 +762,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestSendRequest signingOptions(SubSigningOptions signingOptions) { + public SignatureRequestSendRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -761,12 +787,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public SignatureRequestSendRequest signingRedirectUrl(String signingRedirectUrl) { + public SignatureRequestSendRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -786,12 +812,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public SignatureRequestSendRequest subject(String subject) { + public SignatureRequestSendRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -811,12 +837,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestSendRequest testMode(Boolean testMode) { + public SignatureRequestSendRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -836,12 +862,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestSendRequest title(String title) { + public SignatureRequestSendRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -861,12 +887,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public SignatureRequestSendRequest useTextTags(Boolean useTextTags) { + public SignatureRequestSendRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; return this; } @@ -886,12 +912,12 @@ public Boolean getUseTextTags() { @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUseTextTags(Boolean useTextTags) { + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } - public SignatureRequestSendRequest expiresAt(Integer expiresAt) { + public SignatureRequestSendRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -911,7 +937,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java index c498d87..861f52e 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestSendWithTemplateRequest.java @@ -60,59 +60,76 @@ SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TEST_MODE, SignatureRequestSendWithTemplateRequest.JSON_PROPERTY_TITLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestSendWithTemplateRequest { public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull private List templateIds = new ArrayList<>(); public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nonnull private List signers = new ArrayList<>(); public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable private List ccs = null; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_IS_QUALIFIED_SIGNATURE = "is_qualified_signature"; @Deprecated + @jakarta.annotation.Nullable private Boolean isQualifiedSignature = false; public static final String JSON_PROPERTY_IS_EID = "is_eid"; + @jakarta.annotation.Nullable private Boolean isEid = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public SignatureRequestSendWithTemplateRequest() { @@ -133,7 +150,7 @@ static public SignatureRequestSendWithTemplateRequest init(HashMap data) throws ); } - public SignatureRequestSendWithTemplateRequest templateIds(List templateIds) { + public SignatureRequestSendWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; return this; } @@ -161,12 +178,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; } - public SignatureRequestSendWithTemplateRequest signers(List signers) { + public SignatureRequestSendWithTemplateRequest signers(@jakarta.annotation.Nonnull List signers) { this.signers = signers; return this; } @@ -194,12 +211,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nonnull List signers) { this.signers = signers; } - public SignatureRequestSendWithTemplateRequest allowDecline(Boolean allowDecline) { + public SignatureRequestSendWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -219,12 +236,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public SignatureRequestSendWithTemplateRequest ccs(List ccs) { + public SignatureRequestSendWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; return this; } @@ -252,12 +269,12 @@ public List getCcs() { @JsonProperty(JSON_PROPERTY_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcs(List ccs) { + public void setCcs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; } - public SignatureRequestSendWithTemplateRequest clientId(String clientId) { + public SignatureRequestSendWithTemplateRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -277,12 +294,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public SignatureRequestSendWithTemplateRequest customFields(List customFields) { + public SignatureRequestSendWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -310,12 +327,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SignatureRequestSendWithTemplateRequest files(List files) { + public SignatureRequestSendWithTemplateRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -343,12 +360,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public SignatureRequestSendWithTemplateRequest fileUrls(List fileUrls) { + public SignatureRequestSendWithTemplateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -376,13 +393,13 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } @Deprecated - public SignatureRequestSendWithTemplateRequest isQualifiedSignature(Boolean isQualifiedSignature) { + public SignatureRequestSendWithTemplateRequest isQualifiedSignature(@jakarta.annotation.Nullable Boolean isQualifiedSignature) { this.isQualifiedSignature = isQualifiedSignature; return this; } @@ -405,12 +422,12 @@ public Boolean getIsQualifiedSignature() { @Deprecated @JsonProperty(JSON_PROPERTY_IS_QUALIFIED_SIGNATURE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsQualifiedSignature(Boolean isQualifiedSignature) { + public void setIsQualifiedSignature(@jakarta.annotation.Nullable Boolean isQualifiedSignature) { this.isQualifiedSignature = isQualifiedSignature; } - public SignatureRequestSendWithTemplateRequest isEid(Boolean isEid) { + public SignatureRequestSendWithTemplateRequest isEid(@jakarta.annotation.Nullable Boolean isEid) { this.isEid = isEid; return this; } @@ -430,12 +447,12 @@ public Boolean getIsEid() { @JsonProperty(JSON_PROPERTY_IS_EID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEid(Boolean isEid) { + public void setIsEid(@jakarta.annotation.Nullable Boolean isEid) { this.isEid = isEid; } - public SignatureRequestSendWithTemplateRequest message(String message) { + public SignatureRequestSendWithTemplateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -455,12 +472,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public SignatureRequestSendWithTemplateRequest metadata(Map metadata) { + public SignatureRequestSendWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -488,12 +505,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public SignatureRequestSendWithTemplateRequest signingOptions(SubSigningOptions signingOptions) { + public SignatureRequestSendWithTemplateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -513,12 +530,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public SignatureRequestSendWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + public SignatureRequestSendWithTemplateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -538,12 +555,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public SignatureRequestSendWithTemplateRequest subject(String subject) { + public SignatureRequestSendWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -563,12 +580,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public SignatureRequestSendWithTemplateRequest testMode(Boolean testMode) { + public SignatureRequestSendWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -588,12 +605,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public SignatureRequestSendWithTemplateRequest title(String title) { + public SignatureRequestSendWithTemplateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -613,7 +630,7 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } diff --git a/src/main/java/com/dropbox/sign/model/SignatureRequestUpdateRequest.java b/src/main/java/com/dropbox/sign/model/SignatureRequestUpdateRequest.java index e5b31ad..599e2b0 100644 --- a/src/main/java/com/dropbox/sign/model/SignatureRequestUpdateRequest.java +++ b/src/main/java/com/dropbox/sign/model/SignatureRequestUpdateRequest.java @@ -38,19 +38,23 @@ SignatureRequestUpdateRequest.JSON_PROPERTY_NAME, SignatureRequestUpdateRequest.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SignatureRequestUpdateRequest { public static final String JSON_PROPERTY_SIGNATURE_ID = "signature_id"; + @jakarta.annotation.Nonnull private String signatureId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public SignatureRequestUpdateRequest() { @@ -71,7 +75,7 @@ static public SignatureRequestUpdateRequest init(HashMap data) throws Exception ); } - public SignatureRequestUpdateRequest signatureId(String signatureId) { + public SignatureRequestUpdateRequest signatureId(@jakarta.annotation.Nonnull String signatureId) { this.signatureId = signatureId; return this; } @@ -91,12 +95,12 @@ public String getSignatureId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignatureId(String signatureId) { + public void setSignatureId(@jakarta.annotation.Nonnull String signatureId) { this.signatureId = signatureId; } - public SignatureRequestUpdateRequest emailAddress(String emailAddress) { + public SignatureRequestUpdateRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -116,12 +120,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public SignatureRequestUpdateRequest name(String name) { + public SignatureRequestUpdateRequest name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -141,12 +145,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public SignatureRequestUpdateRequest expiresAt(Integer expiresAt) { + public SignatureRequestUpdateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -166,7 +170,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/SubAttachment.java b/src/main/java/com/dropbox/sign/model/SubAttachment.java index 47c26c1..2194103 100644 --- a/src/main/java/com/dropbox/sign/model/SubAttachment.java +++ b/src/main/java/com/dropbox/sign/model/SubAttachment.java @@ -38,19 +38,23 @@ SubAttachment.JSON_PROPERTY_INSTRUCTIONS, SubAttachment.JSON_PROPERTY_REQUIRED }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubAttachment { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_SIGNER_INDEX = "signer_index"; + @jakarta.annotation.Nonnull private Integer signerIndex; public static final String JSON_PROPERTY_INSTRUCTIONS = "instructions"; + @jakarta.annotation.Nullable private String instructions; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required = false; public SubAttachment() { @@ -71,7 +75,7 @@ static public SubAttachment init(HashMap data) throws Exception { ); } - public SubAttachment name(String name) { + public SubAttachment name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -91,12 +95,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubAttachment signerIndex(Integer signerIndex) { + public SubAttachment signerIndex(@jakarta.annotation.Nonnull Integer signerIndex) { this.signerIndex = signerIndex; return this; } @@ -116,12 +120,12 @@ public Integer getSignerIndex() { @JsonProperty(JSON_PROPERTY_SIGNER_INDEX) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignerIndex(Integer signerIndex) { + public void setSignerIndex(@jakarta.annotation.Nonnull Integer signerIndex) { this.signerIndex = signerIndex; } - public SubAttachment instructions(String instructions) { + public SubAttachment instructions(@jakarta.annotation.Nullable String instructions) { this.instructions = instructions; return this; } @@ -141,12 +145,12 @@ public String getInstructions() { @JsonProperty(JSON_PROPERTY_INSTRUCTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInstructions(String instructions) { + public void setInstructions(@jakarta.annotation.Nullable String instructions) { this.instructions = instructions; } - public SubAttachment required(Boolean required) { + public SubAttachment required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -166,7 +170,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } diff --git a/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java b/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java index 670dd4b..beb21db 100644 --- a/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java +++ b/src/main/java/com/dropbox/sign/model/SubBulkSignerList.java @@ -40,13 +40,15 @@ SubBulkSignerList.JSON_PROPERTY_CUSTOM_FIELDS, SubBulkSignerList.JSON_PROPERTY_SIGNERS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubBulkSignerList { public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public SubBulkSignerList() { @@ -67,7 +69,7 @@ static public SubBulkSignerList init(HashMap data) throws Exception { ); } - public SubBulkSignerList customFields(List customFields) { + public SubBulkSignerList customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -95,12 +97,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public SubBulkSignerList signers(List signers) { + public SubBulkSignerList signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -128,7 +130,7 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } diff --git a/src/main/java/com/dropbox/sign/model/SubBulkSignerListCustomField.java b/src/main/java/com/dropbox/sign/model/SubBulkSignerListCustomField.java index f2b250c..a71f2a6 100644 --- a/src/main/java/com/dropbox/sign/model/SubBulkSignerListCustomField.java +++ b/src/main/java/com/dropbox/sign/model/SubBulkSignerListCustomField.java @@ -36,13 +36,15 @@ SubBulkSignerListCustomField.JSON_PROPERTY_NAME, SubBulkSignerListCustomField.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubBulkSignerListCustomField { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nonnull private String value; public SubBulkSignerListCustomField() { @@ -63,7 +65,7 @@ static public SubBulkSignerListCustomField init(HashMap data) throws Exception { ); } - public SubBulkSignerListCustomField name(String name) { + public SubBulkSignerListCustomField name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -83,12 +85,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubBulkSignerListCustomField value(String value) { + public SubBulkSignerListCustomField value(@jakarta.annotation.Nonnull String value) { this.value = value; return this; } @@ -108,7 +110,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nonnull String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SubCC.java b/src/main/java/com/dropbox/sign/model/SubCC.java index 1edd1df..282cbf9 100644 --- a/src/main/java/com/dropbox/sign/model/SubCC.java +++ b/src/main/java/com/dropbox/sign/model/SubCC.java @@ -36,13 +36,15 @@ SubCC.JSON_PROPERTY_ROLE, SubCC.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubCC { public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nonnull private String role; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public SubCC() { @@ -63,7 +65,7 @@ static public SubCC init(HashMap data) throws Exception { ); } - public SubCC role(String role) { + public SubCC role(@jakarta.annotation.Nonnull String role) { this.role = role; return this; } @@ -83,12 +85,12 @@ public String getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRole(String role) { + public void setRole(@jakarta.annotation.Nonnull String role) { this.role = role; } - public SubCC emailAddress(String emailAddress) { + public SubCC emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -108,7 +110,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/SubCustomField.java b/src/main/java/com/dropbox/sign/model/SubCustomField.java index 027d857..425a895 100644 --- a/src/main/java/com/dropbox/sign/model/SubCustomField.java +++ b/src/main/java/com/dropbox/sign/model/SubCustomField.java @@ -38,19 +38,23 @@ SubCustomField.JSON_PROPERTY_REQUIRED, SubCustomField.JSON_PROPERTY_VALUE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubCustomField { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_EDITOR = "editor"; + @jakarta.annotation.Nullable private String editor; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required = false; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public SubCustomField() { @@ -71,7 +75,7 @@ static public SubCustomField init(HashMap data) throws Exception { ); } - public SubCustomField name(String name) { + public SubCustomField name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -91,12 +95,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubCustomField editor(String editor) { + public SubCustomField editor(@jakarta.annotation.Nullable String editor) { this.editor = editor; return this; } @@ -116,12 +120,12 @@ public String getEditor() { @JsonProperty(JSON_PROPERTY_EDITOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditor(String editor) { + public void setEditor(@jakarta.annotation.Nullable String editor) { this.editor = editor; } - public SubCustomField required(Boolean required) { + public SubCustomField required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -141,12 +145,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } - public SubCustomField value(String value) { + public SubCustomField value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -166,7 +170,7 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } diff --git a/src/main/java/com/dropbox/sign/model/SubEditorOptions.java b/src/main/java/com/dropbox/sign/model/SubEditorOptions.java index 0d2542d..5612b51 100644 --- a/src/main/java/com/dropbox/sign/model/SubEditorOptions.java +++ b/src/main/java/com/dropbox/sign/model/SubEditorOptions.java @@ -36,13 +36,15 @@ SubEditorOptions.JSON_PROPERTY_ALLOW_EDIT_SIGNERS, SubEditorOptions.JSON_PROPERTY_ALLOW_EDIT_DOCUMENTS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubEditorOptions { public static final String JSON_PROPERTY_ALLOW_EDIT_SIGNERS = "allow_edit_signers"; + @jakarta.annotation.Nullable private Boolean allowEditSigners = false; public static final String JSON_PROPERTY_ALLOW_EDIT_DOCUMENTS = "allow_edit_documents"; + @jakarta.annotation.Nullable private Boolean allowEditDocuments = false; public SubEditorOptions() { @@ -63,7 +65,7 @@ static public SubEditorOptions init(HashMap data) throws Exception { ); } - public SubEditorOptions allowEditSigners(Boolean allowEditSigners) { + public SubEditorOptions allowEditSigners(@jakarta.annotation.Nullable Boolean allowEditSigners) { this.allowEditSigners = allowEditSigners; return this; } @@ -83,12 +85,12 @@ public Boolean getAllowEditSigners() { @JsonProperty(JSON_PROPERTY_ALLOW_EDIT_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowEditSigners(Boolean allowEditSigners) { + public void setAllowEditSigners(@jakarta.annotation.Nullable Boolean allowEditSigners) { this.allowEditSigners = allowEditSigners; } - public SubEditorOptions allowEditDocuments(Boolean allowEditDocuments) { + public SubEditorOptions allowEditDocuments(@jakarta.annotation.Nullable Boolean allowEditDocuments) { this.allowEditDocuments = allowEditDocuments; return this; } @@ -108,7 +110,7 @@ public Boolean getAllowEditDocuments() { @JsonProperty(JSON_PROPERTY_ALLOW_EDIT_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowEditDocuments(Boolean allowEditDocuments) { + public void setAllowEditDocuments(@jakarta.annotation.Nullable Boolean allowEditDocuments) { this.allowEditDocuments = allowEditDocuments; } diff --git a/src/main/java/com/dropbox/sign/model/SubFieldOptions.java b/src/main/java/com/dropbox/sign/model/SubFieldOptions.java index 186faba..9d39fc4 100644 --- a/src/main/java/com/dropbox/sign/model/SubFieldOptions.java +++ b/src/main/java/com/dropbox/sign/model/SubFieldOptions.java @@ -35,24 +35,24 @@ @JsonPropertyOrder({ SubFieldOptions.JSON_PROPERTY_DATE_FORMAT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubFieldOptions { /** * Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher. */ public enum DateFormatEnum { - MMDDYYYY("MM / DD / YYYY"), + MMDDYYYY(String.valueOf("MM / DD / YYYY")), - MM_DD_YYYY("MM - DD - YYYY"), + MM_DD_YYYY(String.valueOf("MM - DD - YYYY")), - DDMMYYYY("DD / MM / YYYY"), + DDMMYYYY(String.valueOf("DD / MM / YYYY")), - DD_MM_YYYY("DD - MM - YYYY"), + DD_MM_YYYY(String.valueOf("DD - MM - YYYY")), - YYYYMMDD("YYYY / MM / DD"), + YYYYMMDD(String.valueOf("YYYY / MM / DD")), - YYYY_MM_DD("YYYY - MM - DD"); + YYYY_MM_DD(String.valueOf("YYYY - MM - DD")); private String value; @@ -82,6 +82,7 @@ public static DateFormatEnum fromValue(String value) { } public static final String JSON_PROPERTY_DATE_FORMAT = "date_format"; + @jakarta.annotation.Nonnull private DateFormatEnum dateFormat; public SubFieldOptions() { @@ -102,7 +103,7 @@ static public SubFieldOptions init(HashMap data) throws Exception { ); } - public SubFieldOptions dateFormat(DateFormatEnum dateFormat) { + public SubFieldOptions dateFormat(@jakarta.annotation.Nonnull DateFormatEnum dateFormat) { this.dateFormat = dateFormat; return this; } @@ -122,7 +123,7 @@ public DateFormatEnum getDateFormat() { @JsonProperty(JSON_PROPERTY_DATE_FORMAT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDateFormat(DateFormatEnum dateFormat) { + public void setDateFormat(@jakarta.annotation.Nonnull DateFormatEnum dateFormat) { this.dateFormat = dateFormat; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldGroup.java b/src/main/java/com/dropbox/sign/model/SubFormFieldGroup.java index 80dd46e..9993e17 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldGroup.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldGroup.java @@ -37,16 +37,19 @@ SubFormFieldGroup.JSON_PROPERTY_GROUP_LABEL, SubFormFieldGroup.JSON_PROPERTY_REQUIREMENT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubFormFieldGroup { public static final String JSON_PROPERTY_GROUP_ID = "group_id"; + @jakarta.annotation.Nonnull private String groupId; public static final String JSON_PROPERTY_GROUP_LABEL = "group_label"; + @jakarta.annotation.Nonnull private String groupLabel; public static final String JSON_PROPERTY_REQUIREMENT = "requirement"; + @jakarta.annotation.Nonnull private String requirement; public SubFormFieldGroup() { @@ -67,7 +70,7 @@ static public SubFormFieldGroup init(HashMap data) throws Exception { ); } - public SubFormFieldGroup groupId(String groupId) { + public SubFormFieldGroup groupId(@jakarta.annotation.Nonnull String groupId) { this.groupId = groupId; return this; } @@ -87,12 +90,12 @@ public String getGroupId() { @JsonProperty(JSON_PROPERTY_GROUP_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGroupId(String groupId) { + public void setGroupId(@jakarta.annotation.Nonnull String groupId) { this.groupId = groupId; } - public SubFormFieldGroup groupLabel(String groupLabel) { + public SubFormFieldGroup groupLabel(@jakarta.annotation.Nonnull String groupLabel) { this.groupLabel = groupLabel; return this; } @@ -112,12 +115,12 @@ public String getGroupLabel() { @JsonProperty(JSON_PROPERTY_GROUP_LABEL) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGroupLabel(String groupLabel) { + public void setGroupLabel(@jakarta.annotation.Nonnull String groupLabel) { this.groupLabel = groupLabel; } - public SubFormFieldGroup requirement(String requirement) { + public SubFormFieldGroup requirement(@jakarta.annotation.Nonnull String requirement) { this.requirement = requirement; return this; } @@ -137,7 +140,7 @@ public String getRequirement() { @JsonProperty(JSON_PROPERTY_REQUIREMENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequirement(String requirement) { + public void setRequirement(@jakarta.annotation.Nonnull String requirement) { this.requirement = requirement; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldRule.java b/src/main/java/com/dropbox/sign/model/SubFormFieldRule.java index 629d8f4..7c6eda1 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldRule.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldRule.java @@ -42,19 +42,23 @@ SubFormFieldRule.JSON_PROPERTY_TRIGGERS, SubFormFieldRule.JSON_PROPERTY_ACTIONS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubFormFieldRule { public static final String JSON_PROPERTY_ID = "id"; + @jakarta.annotation.Nonnull private String id; public static final String JSON_PROPERTY_TRIGGER_OPERATOR = "trigger_operator"; + @jakarta.annotation.Nonnull private String triggerOperator = "AND"; public static final String JSON_PROPERTY_TRIGGERS = "triggers"; + @jakarta.annotation.Nonnull private List triggers = new ArrayList<>(); public static final String JSON_PROPERTY_ACTIONS = "actions"; + @jakarta.annotation.Nonnull private List actions = new ArrayList<>(); public SubFormFieldRule() { @@ -75,7 +79,7 @@ static public SubFormFieldRule init(HashMap data) throws Exception { ); } - public SubFormFieldRule id(String id) { + public SubFormFieldRule id(@jakarta.annotation.Nonnull String id) { this.id = id; return this; } @@ -95,12 +99,12 @@ public String getId() { @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setId(String id) { + public void setId(@jakarta.annotation.Nonnull String id) { this.id = id; } - public SubFormFieldRule triggerOperator(String triggerOperator) { + public SubFormFieldRule triggerOperator(@jakarta.annotation.Nonnull String triggerOperator) { this.triggerOperator = triggerOperator; return this; } @@ -120,12 +124,12 @@ public String getTriggerOperator() { @JsonProperty(JSON_PROPERTY_TRIGGER_OPERATOR) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTriggerOperator(String triggerOperator) { + public void setTriggerOperator(@jakarta.annotation.Nonnull String triggerOperator) { this.triggerOperator = triggerOperator; } - public SubFormFieldRule triggers(List triggers) { + public SubFormFieldRule triggers(@jakarta.annotation.Nonnull List triggers) { this.triggers = triggers; return this; } @@ -153,12 +157,12 @@ public List getTriggers() { @JsonProperty(JSON_PROPERTY_TRIGGERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTriggers(List triggers) { + public void setTriggers(@jakarta.annotation.Nonnull List triggers) { this.triggers = triggers; } - public SubFormFieldRule actions(List actions) { + public SubFormFieldRule actions(@jakarta.annotation.Nonnull List actions) { this.actions = actions; return this; } @@ -186,7 +190,7 @@ public List getActions() { @JsonProperty(JSON_PROPERTY_ACTIONS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setActions(List actions) { + public void setActions(@jakarta.annotation.Nonnull List actions) { this.actions = actions; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldRuleAction.java b/src/main/java/com/dropbox/sign/model/SubFormFieldRuleAction.java index 7aebfc1..096164a 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldRuleAction.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldRuleAction.java @@ -38,19 +38,22 @@ SubFormFieldRuleAction.JSON_PROPERTY_FIELD_ID, SubFormFieldRuleAction.JSON_PROPERTY_GROUP_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubFormFieldRuleAction { public static final String JSON_PROPERTY_HIDDEN = "hidden"; + @jakarta.annotation.Nonnull private Boolean hidden; /** * Gets or Sets type */ public enum TypeEnum { - FIELD_VISIBILITY("change-field-visibility"), + CHANGE_FIELD_VISIBILITY(String.valueOf("change-field-visibility")), + FIELD_VISIBILITY(String.valueOf("change-field-visibility")), - GROUP_VISIBILITY("change-group-visibility"); + CHANGE_GROUP_VISIBILITY(String.valueOf("change-group-visibility")), + GROUP_VISIBILITY(String.valueOf("change-group-visibility")); private String value; @@ -80,12 +83,15 @@ public static TypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private TypeEnum type; public static final String JSON_PROPERTY_FIELD_ID = "field_id"; + @jakarta.annotation.Nullable private String fieldId; public static final String JSON_PROPERTY_GROUP_ID = "group_id"; + @jakarta.annotation.Nullable private String groupId; public SubFormFieldRuleAction() { @@ -106,7 +112,7 @@ static public SubFormFieldRuleAction init(HashMap data) throws Exception { ); } - public SubFormFieldRuleAction hidden(Boolean hidden) { + public SubFormFieldRuleAction hidden(@jakarta.annotation.Nonnull Boolean hidden) { this.hidden = hidden; return this; } @@ -126,12 +132,12 @@ public Boolean getHidden() { @JsonProperty(JSON_PROPERTY_HIDDEN) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setHidden(Boolean hidden) { + public void setHidden(@jakarta.annotation.Nonnull Boolean hidden) { this.hidden = hidden; } - public SubFormFieldRuleAction type(TypeEnum type) { + public SubFormFieldRuleAction type(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; return this; } @@ -151,12 +157,12 @@ public TypeEnum getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(TypeEnum type) { + public void setType(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; } - public SubFormFieldRuleAction fieldId(String fieldId) { + public SubFormFieldRuleAction fieldId(@jakarta.annotation.Nullable String fieldId) { this.fieldId = fieldId; return this; } @@ -176,12 +182,12 @@ public String getFieldId() { @JsonProperty(JSON_PROPERTY_FIELD_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldId(String fieldId) { + public void setFieldId(@jakarta.annotation.Nullable String fieldId) { this.fieldId = fieldId; } - public SubFormFieldRuleAction groupId(String groupId) { + public SubFormFieldRuleAction groupId(@jakarta.annotation.Nullable String groupId) { this.groupId = groupId; return this; } @@ -201,7 +207,7 @@ public String getGroupId() { @JsonProperty(JSON_PROPERTY_GROUP_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupId(String groupId) { + public void setGroupId(@jakarta.annotation.Nullable String groupId) { this.groupId = groupId; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldRuleTrigger.java b/src/main/java/com/dropbox/sign/model/SubFormFieldRuleTrigger.java index 466d619..d29de9d 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldRuleTrigger.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldRuleTrigger.java @@ -40,25 +40,26 @@ SubFormFieldRuleTrigger.JSON_PROPERTY_VALUE, SubFormFieldRuleTrigger.JSON_PROPERTY_VALUES }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubFormFieldRuleTrigger { public static final String JSON_PROPERTY_ID = "id"; + @jakarta.annotation.Nonnull private String id; /** * Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value */ public enum OperatorEnum { - ANY("any"), + ANY(String.valueOf("any")), - IS("is"), + IS(String.valueOf("is")), - MATCH("match"), + MATCH(String.valueOf("match")), - NONE("none"), + NONE(String.valueOf("none")), - NOT("not"); + NOT(String.valueOf("not")); private String value; @@ -88,12 +89,15 @@ public static OperatorEnum fromValue(String value) { } public static final String JSON_PROPERTY_OPERATOR = "operator"; + @jakarta.annotation.Nonnull private OperatorEnum operator; public static final String JSON_PROPERTY_VALUE = "value"; + @jakarta.annotation.Nullable private String value; public static final String JSON_PROPERTY_VALUES = "values"; + @jakarta.annotation.Nullable private List values = null; public SubFormFieldRuleTrigger() { @@ -114,7 +118,7 @@ static public SubFormFieldRuleTrigger init(HashMap data) throws Exception { ); } - public SubFormFieldRuleTrigger id(String id) { + public SubFormFieldRuleTrigger id(@jakarta.annotation.Nonnull String id) { this.id = id; return this; } @@ -134,12 +138,12 @@ public String getId() { @JsonProperty(JSON_PROPERTY_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setId(String id) { + public void setId(@jakarta.annotation.Nonnull String id) { this.id = id; } - public SubFormFieldRuleTrigger operator(OperatorEnum operator) { + public SubFormFieldRuleTrigger operator(@jakarta.annotation.Nonnull OperatorEnum operator) { this.operator = operator; return this; } @@ -159,12 +163,12 @@ public OperatorEnum getOperator() { @JsonProperty(JSON_PROPERTY_OPERATOR) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOperator(OperatorEnum operator) { + public void setOperator(@jakarta.annotation.Nonnull OperatorEnum operator) { this.operator = operator; } - public SubFormFieldRuleTrigger value(String value) { + public SubFormFieldRuleTrigger value(@jakarta.annotation.Nullable String value) { this.value = value; return this; } @@ -184,12 +188,12 @@ public String getValue() { @JsonProperty(JSON_PROPERTY_VALUE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValue(String value) { + public void setValue(@jakarta.annotation.Nullable String value) { this.value = value; } - public SubFormFieldRuleTrigger values(List values) { + public SubFormFieldRuleTrigger values(@jakarta.annotation.Nullable List values) { this.values = values; return this; } @@ -217,7 +221,7 @@ public List getValues() { @JsonProperty(JSON_PROPERTY_VALUES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValues(List values) { + public void setValues(@jakarta.annotation.Nullable List values) { this.values = values; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java index a0a5217..2a37ad1 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentBase.java @@ -48,7 +48,7 @@ SubFormFieldsPerDocumentBase.JSON_PROPERTY_NAME, SubFormFieldsPerDocumentBase.JSON_PROPERTY_PAGE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -69,36 +69,47 @@ public class SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_DOCUMENT_INDEX = "document_index"; + @jakarta.annotation.Nonnull private Integer documentIndex; public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nonnull private String apiId; public static final String JSON_PROPERTY_HEIGHT = "height"; + @jakarta.annotation.Nonnull private Integer height; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nonnull private Boolean required; public static final String JSON_PROPERTY_SIGNER = "signer"; + @jakarta.annotation.Nonnull private String signer; public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; public static final String JSON_PROPERTY_WIDTH = "width"; + @jakarta.annotation.Nonnull private Integer width; public static final String JSON_PROPERTY_X = "x"; + @jakarta.annotation.Nonnull private Integer x; public static final String JSON_PROPERTY_Y = "y"; + @jakarta.annotation.Nonnull private Integer y; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_PAGE = "page"; + @jakarta.annotation.Nullable private Integer page; public SubFormFieldsPerDocumentBase() { @@ -119,7 +130,7 @@ static public SubFormFieldsPerDocumentBase init(HashMap data) throws Exception { ); } - public SubFormFieldsPerDocumentBase documentIndex(Integer documentIndex) { + public SubFormFieldsPerDocumentBase documentIndex(@jakarta.annotation.Nonnull Integer documentIndex) { this.documentIndex = documentIndex; return this; } @@ -139,12 +150,12 @@ public Integer getDocumentIndex() { @JsonProperty(JSON_PROPERTY_DOCUMENT_INDEX) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDocumentIndex(Integer documentIndex) { + public void setDocumentIndex(@jakarta.annotation.Nonnull Integer documentIndex) { this.documentIndex = documentIndex; } - public SubFormFieldsPerDocumentBase apiId(String apiId) { + public SubFormFieldsPerDocumentBase apiId(@jakarta.annotation.Nonnull String apiId) { this.apiId = apiId; return this; } @@ -164,12 +175,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nonnull String apiId) { this.apiId = apiId; } - public SubFormFieldsPerDocumentBase height(Integer height) { + public SubFormFieldsPerDocumentBase height(@jakarta.annotation.Nonnull Integer height) { this.height = height; return this; } @@ -189,12 +200,12 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setHeight(Integer height) { + public void setHeight(@jakarta.annotation.Nonnull Integer height) { this.height = height; } - public SubFormFieldsPerDocumentBase required(Boolean required) { + public SubFormFieldsPerDocumentBase required(@jakarta.annotation.Nonnull Boolean required) { this.required = required; return this; } @@ -214,12 +225,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nonnull Boolean required) { this.required = required; } - public SubFormFieldsPerDocumentBase signer(String signer) { + public SubFormFieldsPerDocumentBase signer(@jakarta.annotation.Nonnull String signer) { this.signer = signer; return this; } @@ -243,7 +254,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSigner(String signer) { + public void setSigner(@jakarta.annotation.Nonnull String signer) { this.signer = signer; } @@ -252,7 +263,7 @@ public void setSigner(Integer signer) { } - public SubFormFieldsPerDocumentBase type(String type) { + public SubFormFieldsPerDocumentBase type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -272,12 +283,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentBase width(Integer width) { + public SubFormFieldsPerDocumentBase width(@jakarta.annotation.Nonnull Integer width) { this.width = width; return this; } @@ -297,12 +308,12 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setWidth(Integer width) { + public void setWidth(@jakarta.annotation.Nonnull Integer width) { this.width = width; } - public SubFormFieldsPerDocumentBase x(Integer x) { + public SubFormFieldsPerDocumentBase x(@jakarta.annotation.Nonnull Integer x) { this.x = x; return this; } @@ -322,12 +333,12 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setX(Integer x) { + public void setX(@jakarta.annotation.Nonnull Integer x) { this.x = x; } - public SubFormFieldsPerDocumentBase y(Integer y) { + public SubFormFieldsPerDocumentBase y(@jakarta.annotation.Nonnull Integer y) { this.y = y; return this; } @@ -347,12 +358,12 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setY(Integer y) { + public void setY(@jakarta.annotation.Nonnull Integer y) { this.y = y; } - public SubFormFieldsPerDocumentBase name(String name) { + public SubFormFieldsPerDocumentBase name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -372,12 +383,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public SubFormFieldsPerDocumentBase page(Integer page) { + public SubFormFieldsPerDocumentBase page(@jakarta.annotation.Nullable Integer page) { this.page = page; return this; } @@ -397,7 +408,7 @@ public Integer getPage() { @JsonProperty(JSON_PROPERTY_PAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPage(Integer page) { + public void setPage(@jakarta.annotation.Nullable Integer page) { this.page = page; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckbox.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckbox.java index 25cc889..660550c 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckbox.java @@ -41,7 +41,7 @@ SubFormFieldsPerDocumentCheckbox.JSON_PROPERTY_IS_CHECKED, SubFormFieldsPerDocumentCheckbox.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,12 +50,15 @@ public class SubFormFieldsPerDocumentCheckbox extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox"; public static final String JSON_PROPERTY_IS_CHECKED = "is_checked"; + @jakarta.annotation.Nonnull private Boolean isChecked; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public SubFormFieldsPerDocumentCheckbox() { @@ -76,7 +79,7 @@ static public SubFormFieldsPerDocumentCheckbox init(HashMap data) throws Excepti ); } - public SubFormFieldsPerDocumentCheckbox type(String type) { + public SubFormFieldsPerDocumentCheckbox type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -96,12 +99,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentCheckbox isChecked(Boolean isChecked) { + public SubFormFieldsPerDocumentCheckbox isChecked(@jakarta.annotation.Nonnull Boolean isChecked) { this.isChecked = isChecked; return this; } @@ -121,12 +124,12 @@ public Boolean getIsChecked() { @JsonProperty(JSON_PROPERTY_IS_CHECKED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setIsChecked(Boolean isChecked) { + public void setIsChecked(@jakarta.annotation.Nonnull Boolean isChecked) { this.isChecked = isChecked; } - public SubFormFieldsPerDocumentCheckbox group(String group) { + public SubFormFieldsPerDocumentCheckbox group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -146,7 +149,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckboxMerge.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckboxMerge.java index ea0b0df..6275827 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckboxMerge.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentCheckboxMerge.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ SubFormFieldsPerDocumentCheckboxMerge.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class SubFormFieldsPerDocumentCheckboxMerge extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox-merge"; public SubFormFieldsPerDocumentCheckboxMerge() { @@ -68,7 +69,7 @@ static public SubFormFieldsPerDocumentCheckboxMerge init(HashMap data) throws Ex ); } - public SubFormFieldsPerDocumentCheckboxMerge type(String type) { + public SubFormFieldsPerDocumentCheckboxMerge type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDateSigned.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDateSigned.java index ff67323..314aef5 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDateSigned.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDateSigned.java @@ -41,7 +41,7 @@ SubFormFieldsPerDocumentDateSigned.JSON_PROPERTY_FONT_FAMILY, SubFormFieldsPerDocumentDateSigned.JSON_PROPERTY_FONT_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,43 +50,44 @@ public class SubFormFieldsPerDocumentDateSigned extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "date_signed"; /** * Font family for the field. */ public enum FontFamilyEnum { - HELVETICA("helvetica"), + HELVETICA(String.valueOf("helvetica")), - ARIAL("arial"), + ARIAL(String.valueOf("arial")), - COURIER("courier"), + COURIER(String.valueOf("courier")), - CALIBRI("calibri"), + CALIBRI(String.valueOf("calibri")), - CAMBRIA("cambria"), + CAMBRIA(String.valueOf("cambria")), - GEORGIA("georgia"), + GEORGIA(String.valueOf("georgia")), - TIMES("times"), + TIMES(String.valueOf("times")), - TREBUCHET("trebuchet"), + TREBUCHET(String.valueOf("trebuchet")), - VERDANA("verdana"), + VERDANA(String.valueOf("verdana")), - ROBOTO("roboto"), + ROBOTO(String.valueOf("roboto")), - ROBOTO_MONO("robotoMono"), + ROBOTO_MONO(String.valueOf("robotoMono")), - NOTO_SANS("notoSans"), + NOTO_SANS(String.valueOf("notoSans")), - NOTO_SERIF("notoSerif"), + NOTO_SERIF(String.valueOf("notoSerif")), - NOTO_CJK_JP_REGULAR("notoCJK-JP-Regular"), + NOTO_CJK_JP_REGULAR(String.valueOf("notoCJK-JP-Regular")), - NOTO_HEBREW_REGULAR("notoHebrew-Regular"), + NOTO_HEBREW_REGULAR(String.valueOf("notoHebrew-Regular")), - NOTO_SAN_THAI_MERGED("notoSanThaiMerged"); + NOTO_SAN_THAI_MERGED(String.valueOf("notoSanThaiMerged")); private String value; @@ -116,9 +117,11 @@ public static FontFamilyEnum fromValue(String value) { } public static final String JSON_PROPERTY_FONT_FAMILY = "font_family"; + @jakarta.annotation.Nullable private FontFamilyEnum fontFamily; public static final String JSON_PROPERTY_FONT_SIZE = "font_size"; + @jakarta.annotation.Nullable private Integer fontSize = 12; public SubFormFieldsPerDocumentDateSigned() { @@ -139,7 +142,7 @@ static public SubFormFieldsPerDocumentDateSigned init(HashMap data) throws Excep ); } - public SubFormFieldsPerDocumentDateSigned type(String type) { + public SubFormFieldsPerDocumentDateSigned type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -159,12 +162,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentDateSigned fontFamily(FontFamilyEnum fontFamily) { + public SubFormFieldsPerDocumentDateSigned fontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; return this; } @@ -184,12 +187,12 @@ public FontFamilyEnum getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(FontFamilyEnum fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; } - public SubFormFieldsPerDocumentDateSigned fontSize(Integer fontSize) { + public SubFormFieldsPerDocumentDateSigned fontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; return this; } @@ -209,7 +212,7 @@ public Integer getFontSize() { @JsonProperty(JSON_PROPERTY_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontSize(Integer fontSize) { + public void setFontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDropdown.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDropdown.java index ce35e13..154fec9 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDropdown.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentDropdown.java @@ -45,7 +45,7 @@ SubFormFieldsPerDocumentDropdown.JSON_PROPERTY_FONT_FAMILY, SubFormFieldsPerDocumentDropdown.JSON_PROPERTY_FONT_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -54,49 +54,52 @@ public class SubFormFieldsPerDocumentDropdown extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "dropdown"; public static final String JSON_PROPERTY_OPTIONS = "options"; + @jakarta.annotation.Nonnull private List options = new ArrayList<>(); public static final String JSON_PROPERTY_CONTENT = "content"; + @jakarta.annotation.Nullable private String content; /** * Font family for the field. */ public enum FontFamilyEnum { - HELVETICA("helvetica"), + HELVETICA(String.valueOf("helvetica")), - ARIAL("arial"), + ARIAL(String.valueOf("arial")), - COURIER("courier"), + COURIER(String.valueOf("courier")), - CALIBRI("calibri"), + CALIBRI(String.valueOf("calibri")), - CAMBRIA("cambria"), + CAMBRIA(String.valueOf("cambria")), - GEORGIA("georgia"), + GEORGIA(String.valueOf("georgia")), - TIMES("times"), + TIMES(String.valueOf("times")), - TREBUCHET("trebuchet"), + TREBUCHET(String.valueOf("trebuchet")), - VERDANA("verdana"), + VERDANA(String.valueOf("verdana")), - ROBOTO("roboto"), + ROBOTO(String.valueOf("roboto")), - ROBOTO_MONO("robotoMono"), + ROBOTO_MONO(String.valueOf("robotoMono")), - NOTO_SANS("notoSans"), + NOTO_SANS(String.valueOf("notoSans")), - NOTO_SERIF("notoSerif"), + NOTO_SERIF(String.valueOf("notoSerif")), - NOTO_CJK_JP_REGULAR("notoCJK-JP-Regular"), + NOTO_CJK_JP_REGULAR(String.valueOf("notoCJK-JP-Regular")), - NOTO_HEBREW_REGULAR("notoHebrew-Regular"), + NOTO_HEBREW_REGULAR(String.valueOf("notoHebrew-Regular")), - NOTO_SAN_THAI_MERGED("notoSanThaiMerged"); + NOTO_SAN_THAI_MERGED(String.valueOf("notoSanThaiMerged")); private String value; @@ -126,9 +129,11 @@ public static FontFamilyEnum fromValue(String value) { } public static final String JSON_PROPERTY_FONT_FAMILY = "font_family"; + @jakarta.annotation.Nullable private FontFamilyEnum fontFamily; public static final String JSON_PROPERTY_FONT_SIZE = "font_size"; + @jakarta.annotation.Nullable private Integer fontSize = 12; public SubFormFieldsPerDocumentDropdown() { @@ -149,7 +154,7 @@ static public SubFormFieldsPerDocumentDropdown init(HashMap data) throws Excepti ); } - public SubFormFieldsPerDocumentDropdown type(String type) { + public SubFormFieldsPerDocumentDropdown type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -169,12 +174,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentDropdown options(List options) { + public SubFormFieldsPerDocumentDropdown options(@jakarta.annotation.Nonnull List options) { this.options = options; return this; } @@ -202,12 +207,12 @@ public List getOptions() { @JsonProperty(JSON_PROPERTY_OPTIONS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOptions(List options) { + public void setOptions(@jakarta.annotation.Nonnull List options) { this.options = options; } - public SubFormFieldsPerDocumentDropdown content(String content) { + public SubFormFieldsPerDocumentDropdown content(@jakarta.annotation.Nullable String content) { this.content = content; return this; } @@ -227,12 +232,12 @@ public String getContent() { @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setContent(String content) { + public void setContent(@jakarta.annotation.Nullable String content) { this.content = content; } - public SubFormFieldsPerDocumentDropdown fontFamily(FontFamilyEnum fontFamily) { + public SubFormFieldsPerDocumentDropdown fontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; return this; } @@ -252,12 +257,12 @@ public FontFamilyEnum getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(FontFamilyEnum fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; } - public SubFormFieldsPerDocumentDropdown fontSize(Integer fontSize) { + public SubFormFieldsPerDocumentDropdown fontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; return this; } @@ -277,7 +282,7 @@ public Integer getFontSize() { @JsonProperty(JSON_PROPERTY_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontSize(Integer fontSize) { + public void setFontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentHyperlink.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentHyperlink.java index 44cb483..491da06 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentHyperlink.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentHyperlink.java @@ -43,7 +43,7 @@ SubFormFieldsPerDocumentHyperlink.JSON_PROPERTY_FONT_FAMILY, SubFormFieldsPerDocumentHyperlink.JSON_PROPERTY_FONT_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -52,49 +52,52 @@ public class SubFormFieldsPerDocumentHyperlink extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "hyperlink"; public static final String JSON_PROPERTY_CONTENT = "content"; + @jakarta.annotation.Nonnull private String content; public static final String JSON_PROPERTY_CONTENT_URL = "content_url"; + @jakarta.annotation.Nonnull private String contentUrl; /** * Font family for the field. */ public enum FontFamilyEnum { - HELVETICA("helvetica"), + HELVETICA(String.valueOf("helvetica")), - ARIAL("arial"), + ARIAL(String.valueOf("arial")), - COURIER("courier"), + COURIER(String.valueOf("courier")), - CALIBRI("calibri"), + CALIBRI(String.valueOf("calibri")), - CAMBRIA("cambria"), + CAMBRIA(String.valueOf("cambria")), - GEORGIA("georgia"), + GEORGIA(String.valueOf("georgia")), - TIMES("times"), + TIMES(String.valueOf("times")), - TREBUCHET("trebuchet"), + TREBUCHET(String.valueOf("trebuchet")), - VERDANA("verdana"), + VERDANA(String.valueOf("verdana")), - ROBOTO("roboto"), + ROBOTO(String.valueOf("roboto")), - ROBOTO_MONO("robotoMono"), + ROBOTO_MONO(String.valueOf("robotoMono")), - NOTO_SANS("notoSans"), + NOTO_SANS(String.valueOf("notoSans")), - NOTO_SERIF("notoSerif"), + NOTO_SERIF(String.valueOf("notoSerif")), - NOTO_CJK_JP_REGULAR("notoCJK-JP-Regular"), + NOTO_CJK_JP_REGULAR(String.valueOf("notoCJK-JP-Regular")), - NOTO_HEBREW_REGULAR("notoHebrew-Regular"), + NOTO_HEBREW_REGULAR(String.valueOf("notoHebrew-Regular")), - NOTO_SAN_THAI_MERGED("notoSanThaiMerged"); + NOTO_SAN_THAI_MERGED(String.valueOf("notoSanThaiMerged")); private String value; @@ -124,9 +127,11 @@ public static FontFamilyEnum fromValue(String value) { } public static final String JSON_PROPERTY_FONT_FAMILY = "font_family"; + @jakarta.annotation.Nullable private FontFamilyEnum fontFamily; public static final String JSON_PROPERTY_FONT_SIZE = "font_size"; + @jakarta.annotation.Nullable private Integer fontSize = 12; public SubFormFieldsPerDocumentHyperlink() { @@ -147,7 +152,7 @@ static public SubFormFieldsPerDocumentHyperlink init(HashMap data) throws Except ); } - public SubFormFieldsPerDocumentHyperlink type(String type) { + public SubFormFieldsPerDocumentHyperlink type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -167,12 +172,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentHyperlink content(String content) { + public SubFormFieldsPerDocumentHyperlink content(@jakarta.annotation.Nonnull String content) { this.content = content; return this; } @@ -192,12 +197,12 @@ public String getContent() { @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setContent(String content) { + public void setContent(@jakarta.annotation.Nonnull String content) { this.content = content; } - public SubFormFieldsPerDocumentHyperlink contentUrl(String contentUrl) { + public SubFormFieldsPerDocumentHyperlink contentUrl(@jakarta.annotation.Nonnull String contentUrl) { this.contentUrl = contentUrl; return this; } @@ -217,12 +222,12 @@ public String getContentUrl() { @JsonProperty(JSON_PROPERTY_CONTENT_URL) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setContentUrl(String contentUrl) { + public void setContentUrl(@jakarta.annotation.Nonnull String contentUrl) { this.contentUrl = contentUrl; } - public SubFormFieldsPerDocumentHyperlink fontFamily(FontFamilyEnum fontFamily) { + public SubFormFieldsPerDocumentHyperlink fontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; return this; } @@ -242,12 +247,12 @@ public FontFamilyEnum getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(FontFamilyEnum fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; } - public SubFormFieldsPerDocumentHyperlink fontSize(Integer fontSize) { + public SubFormFieldsPerDocumentHyperlink fontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; return this; } @@ -267,7 +272,7 @@ public Integer getFontSize() { @JsonProperty(JSON_PROPERTY_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontSize(Integer fontSize) { + public void setFontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentInitials.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentInitials.java index 886c59f..9c522f0 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentInitials.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentInitials.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ SubFormFieldsPerDocumentInitials.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class SubFormFieldsPerDocumentInitials extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "initials"; public SubFormFieldsPerDocumentInitials() { @@ -68,7 +69,7 @@ static public SubFormFieldsPerDocumentInitials init(HashMap data) throws Excepti ); } - public SubFormFieldsPerDocumentInitials type(String type) { + public SubFormFieldsPerDocumentInitials type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentRadio.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentRadio.java index b21b9da..e2db055 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentRadio.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentRadio.java @@ -41,7 +41,7 @@ SubFormFieldsPerDocumentRadio.JSON_PROPERTY_GROUP, SubFormFieldsPerDocumentRadio.JSON_PROPERTY_IS_CHECKED }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,12 +50,15 @@ public class SubFormFieldsPerDocumentRadio extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "radio"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nonnull private String group; public static final String JSON_PROPERTY_IS_CHECKED = "is_checked"; + @jakarta.annotation.Nonnull private Boolean isChecked; public SubFormFieldsPerDocumentRadio() { @@ -76,7 +79,7 @@ static public SubFormFieldsPerDocumentRadio init(HashMap data) throws Exception ); } - public SubFormFieldsPerDocumentRadio type(String type) { + public SubFormFieldsPerDocumentRadio type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -96,12 +99,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentRadio group(String group) { + public SubFormFieldsPerDocumentRadio group(@jakarta.annotation.Nonnull String group) { this.group = group; return this; } @@ -121,12 +124,12 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nonnull String group) { this.group = group; } - public SubFormFieldsPerDocumentRadio isChecked(Boolean isChecked) { + public SubFormFieldsPerDocumentRadio isChecked(@jakarta.annotation.Nonnull Boolean isChecked) { this.isChecked = isChecked; return this; } @@ -146,7 +149,7 @@ public Boolean getIsChecked() { @JsonProperty(JSON_PROPERTY_IS_CHECKED) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setIsChecked(Boolean isChecked) { + public void setIsChecked(@jakarta.annotation.Nonnull Boolean isChecked) { this.isChecked = isChecked; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentSignature.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentSignature.java index fb56d68..fd72a6b 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentSignature.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentSignature.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ SubFormFieldsPerDocumentSignature.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class SubFormFieldsPerDocumentSignature extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "signature"; public SubFormFieldsPerDocumentSignature() { @@ -68,7 +69,7 @@ static public SubFormFieldsPerDocumentSignature init(HashMap data) throws Except ); } - public SubFormFieldsPerDocumentSignature type(String type) { + public SubFormFieldsPerDocumentSignature type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java index 385ec28..396c85d 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentText.java @@ -49,7 +49,7 @@ SubFormFieldsPerDocumentText.JSON_PROPERTY_FONT_FAMILY, SubFormFieldsPerDocumentText.JSON_PROPERTY_FONT_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -58,43 +58,48 @@ public class SubFormFieldsPerDocumentText extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text"; public static final String JSON_PROPERTY_PLACEHOLDER = "placeholder"; + @jakarta.annotation.Nullable private String placeholder; public static final String JSON_PROPERTY_AUTO_FILL_TYPE = "auto_fill_type"; + @jakarta.annotation.Nullable private String autoFillType; public static final String JSON_PROPERTY_LINK_ID = "link_id"; + @jakarta.annotation.Nullable private String linkId; public static final String JSON_PROPERTY_MASKED = "masked"; + @jakarta.annotation.Nullable private Boolean masked; /** * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. **NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. */ public enum ValidationTypeEnum { - NUMBERS_ONLY("numbers_only"), + NUMBERS_ONLY(String.valueOf("numbers_only")), - LETTERS_ONLY("letters_only"), + LETTERS_ONLY(String.valueOf("letters_only")), - PHONE_NUMBER("phone_number"), + PHONE_NUMBER(String.valueOf("phone_number")), - BANK_ROUTING_NUMBER("bank_routing_number"), + BANK_ROUTING_NUMBER(String.valueOf("bank_routing_number")), - BANK_ACCOUNT_NUMBER("bank_account_number"), + BANK_ACCOUNT_NUMBER(String.valueOf("bank_account_number")), - EMAIL_ADDRESS("email_address"), + EMAIL_ADDRESS(String.valueOf("email_address")), - ZIP_CODE("zip_code"), + ZIP_CODE(String.valueOf("zip_code")), - SOCIAL_SECURITY_NUMBER("social_security_number"), + SOCIAL_SECURITY_NUMBER(String.valueOf("social_security_number")), - EMPLOYER_IDENTIFICATION_NUMBER("employer_identification_number"), + EMPLOYER_IDENTIFICATION_NUMBER(String.valueOf("employer_identification_number")), - CUSTOM_REGEX("custom_regex"); + CUSTOM_REGEX(String.valueOf("custom_regex")); private String value; @@ -124,52 +129,56 @@ public static ValidationTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; + @jakarta.annotation.Nullable private ValidationTypeEnum validationType; public static final String JSON_PROPERTY_VALIDATION_CUSTOM_REGEX = "validation_custom_regex"; + @jakarta.annotation.Nullable private String validationCustomRegex; public static final String JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL = "validation_custom_regex_format_label"; + @jakarta.annotation.Nullable private String validationCustomRegexFormatLabel; public static final String JSON_PROPERTY_CONTENT = "content"; + @jakarta.annotation.Nullable private String content; /** * Font family for the field. */ public enum FontFamilyEnum { - HELVETICA("helvetica"), + HELVETICA(String.valueOf("helvetica")), - ARIAL("arial"), + ARIAL(String.valueOf("arial")), - COURIER("courier"), + COURIER(String.valueOf("courier")), - CALIBRI("calibri"), + CALIBRI(String.valueOf("calibri")), - CAMBRIA("cambria"), + CAMBRIA(String.valueOf("cambria")), - GEORGIA("georgia"), + GEORGIA(String.valueOf("georgia")), - TIMES("times"), + TIMES(String.valueOf("times")), - TREBUCHET("trebuchet"), + TREBUCHET(String.valueOf("trebuchet")), - VERDANA("verdana"), + VERDANA(String.valueOf("verdana")), - ROBOTO("roboto"), + ROBOTO(String.valueOf("roboto")), - ROBOTO_MONO("robotoMono"), + ROBOTO_MONO(String.valueOf("robotoMono")), - NOTO_SANS("notoSans"), + NOTO_SANS(String.valueOf("notoSans")), - NOTO_SERIF("notoSerif"), + NOTO_SERIF(String.valueOf("notoSerif")), - NOTO_CJK_JP_REGULAR("notoCJK-JP-Regular"), + NOTO_CJK_JP_REGULAR(String.valueOf("notoCJK-JP-Regular")), - NOTO_HEBREW_REGULAR("notoHebrew-Regular"), + NOTO_HEBREW_REGULAR(String.valueOf("notoHebrew-Regular")), - NOTO_SAN_THAI_MERGED("notoSanThaiMerged"); + NOTO_SAN_THAI_MERGED(String.valueOf("notoSanThaiMerged")); private String value; @@ -199,9 +208,11 @@ public static FontFamilyEnum fromValue(String value) { } public static final String JSON_PROPERTY_FONT_FAMILY = "font_family"; + @jakarta.annotation.Nullable private FontFamilyEnum fontFamily; public static final String JSON_PROPERTY_FONT_SIZE = "font_size"; + @jakarta.annotation.Nullable private Integer fontSize = 12; public SubFormFieldsPerDocumentText() { @@ -222,7 +233,7 @@ static public SubFormFieldsPerDocumentText init(HashMap data) throws Exception { ); } - public SubFormFieldsPerDocumentText type(String type) { + public SubFormFieldsPerDocumentText type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -242,12 +253,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentText placeholder(String placeholder) { + public SubFormFieldsPerDocumentText placeholder(@jakarta.annotation.Nullable String placeholder) { this.placeholder = placeholder; return this; } @@ -267,12 +278,12 @@ public String getPlaceholder() { @JsonProperty(JSON_PROPERTY_PLACEHOLDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPlaceholder(String placeholder) { + public void setPlaceholder(@jakarta.annotation.Nullable String placeholder) { this.placeholder = placeholder; } - public SubFormFieldsPerDocumentText autoFillType(String autoFillType) { + public SubFormFieldsPerDocumentText autoFillType(@jakarta.annotation.Nullable String autoFillType) { this.autoFillType = autoFillType; return this; } @@ -292,12 +303,12 @@ public String getAutoFillType() { @JsonProperty(JSON_PROPERTY_AUTO_FILL_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAutoFillType(String autoFillType) { + public void setAutoFillType(@jakarta.annotation.Nullable String autoFillType) { this.autoFillType = autoFillType; } - public SubFormFieldsPerDocumentText linkId(String linkId) { + public SubFormFieldsPerDocumentText linkId(@jakarta.annotation.Nullable String linkId) { this.linkId = linkId; return this; } @@ -317,12 +328,12 @@ public String getLinkId() { @JsonProperty(JSON_PROPERTY_LINK_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinkId(String linkId) { + public void setLinkId(@jakarta.annotation.Nullable String linkId) { this.linkId = linkId; } - public SubFormFieldsPerDocumentText masked(Boolean masked) { + public SubFormFieldsPerDocumentText masked(@jakarta.annotation.Nullable Boolean masked) { this.masked = masked; return this; } @@ -342,12 +353,12 @@ public Boolean getMasked() { @JsonProperty(JSON_PROPERTY_MASKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMasked(Boolean masked) { + public void setMasked(@jakarta.annotation.Nullable Boolean masked) { this.masked = masked; } - public SubFormFieldsPerDocumentText validationType(ValidationTypeEnum validationType) { + public SubFormFieldsPerDocumentText validationType(@jakarta.annotation.Nullable ValidationTypeEnum validationType) { this.validationType = validationType; return this; } @@ -367,12 +378,12 @@ public ValidationTypeEnum getValidationType() { @JsonProperty(JSON_PROPERTY_VALIDATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValidationType(ValidationTypeEnum validationType) { + public void setValidationType(@jakarta.annotation.Nullable ValidationTypeEnum validationType) { this.validationType = validationType; } - public SubFormFieldsPerDocumentText validationCustomRegex(String validationCustomRegex) { + public SubFormFieldsPerDocumentText validationCustomRegex(@jakarta.annotation.Nullable String validationCustomRegex) { this.validationCustomRegex = validationCustomRegex; return this; } @@ -392,12 +403,12 @@ public String getValidationCustomRegex() { @JsonProperty(JSON_PROPERTY_VALIDATION_CUSTOM_REGEX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValidationCustomRegex(String validationCustomRegex) { + public void setValidationCustomRegex(@jakarta.annotation.Nullable String validationCustomRegex) { this.validationCustomRegex = validationCustomRegex; } - public SubFormFieldsPerDocumentText validationCustomRegexFormatLabel(String validationCustomRegexFormatLabel) { + public SubFormFieldsPerDocumentText validationCustomRegexFormatLabel(@jakarta.annotation.Nullable String validationCustomRegexFormatLabel) { this.validationCustomRegexFormatLabel = validationCustomRegexFormatLabel; return this; } @@ -417,12 +428,12 @@ public String getValidationCustomRegexFormatLabel() { @JsonProperty(JSON_PROPERTY_VALIDATION_CUSTOM_REGEX_FORMAT_LABEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValidationCustomRegexFormatLabel(String validationCustomRegexFormatLabel) { + public void setValidationCustomRegexFormatLabel(@jakarta.annotation.Nullable String validationCustomRegexFormatLabel) { this.validationCustomRegexFormatLabel = validationCustomRegexFormatLabel; } - public SubFormFieldsPerDocumentText content(String content) { + public SubFormFieldsPerDocumentText content(@jakarta.annotation.Nullable String content) { this.content = content; return this; } @@ -442,12 +453,12 @@ public String getContent() { @JsonProperty(JSON_PROPERTY_CONTENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setContent(String content) { + public void setContent(@jakarta.annotation.Nullable String content) { this.content = content; } - public SubFormFieldsPerDocumentText fontFamily(FontFamilyEnum fontFamily) { + public SubFormFieldsPerDocumentText fontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; return this; } @@ -467,12 +478,12 @@ public FontFamilyEnum getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(FontFamilyEnum fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; } - public SubFormFieldsPerDocumentText fontSize(Integer fontSize) { + public SubFormFieldsPerDocumentText fontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; return this; } @@ -492,7 +503,7 @@ public Integer getFontSize() { @JsonProperty(JSON_PROPERTY_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontSize(Integer fontSize) { + public void setFontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; } diff --git a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java index 799a0ef..1024f05 100644 --- a/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java +++ b/src/main/java/com/dropbox/sign/model/SubFormFieldsPerDocumentTextMerge.java @@ -41,7 +41,7 @@ SubFormFieldsPerDocumentTextMerge.JSON_PROPERTY_FONT_FAMILY, SubFormFieldsPerDocumentTextMerge.JSON_PROPERTY_FONT_SIZE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -50,43 +50,44 @@ public class SubFormFieldsPerDocumentTextMerge extends SubFormFieldsPerDocumentBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text-merge"; /** * Font family for the field. */ public enum FontFamilyEnum { - HELVETICA("helvetica"), + HELVETICA(String.valueOf("helvetica")), - ARIAL("arial"), + ARIAL(String.valueOf("arial")), - COURIER("courier"), + COURIER(String.valueOf("courier")), - CALIBRI("calibri"), + CALIBRI(String.valueOf("calibri")), - CAMBRIA("cambria"), + CAMBRIA(String.valueOf("cambria")), - GEORGIA("georgia"), + GEORGIA(String.valueOf("georgia")), - TIMES("times"), + TIMES(String.valueOf("times")), - TREBUCHET("trebuchet"), + TREBUCHET(String.valueOf("trebuchet")), - VERDANA("verdana"), + VERDANA(String.valueOf("verdana")), - ROBOTO("roboto"), + ROBOTO(String.valueOf("roboto")), - ROBOTO_MONO("robotoMono"), + ROBOTO_MONO(String.valueOf("robotoMono")), - NOTO_SANS("notoSans"), + NOTO_SANS(String.valueOf("notoSans")), - NOTO_SERIF("notoSerif"), + NOTO_SERIF(String.valueOf("notoSerif")), - NOTO_CJK_JP_REGULAR("notoCJK-JP-Regular"), + NOTO_CJK_JP_REGULAR(String.valueOf("notoCJK-JP-Regular")), - NOTO_HEBREW_REGULAR("notoHebrew-Regular"), + NOTO_HEBREW_REGULAR(String.valueOf("notoHebrew-Regular")), - NOTO_SAN_THAI_MERGED("notoSanThaiMerged"); + NOTO_SAN_THAI_MERGED(String.valueOf("notoSanThaiMerged")); private String value; @@ -116,9 +117,11 @@ public static FontFamilyEnum fromValue(String value) { } public static final String JSON_PROPERTY_FONT_FAMILY = "font_family"; + @jakarta.annotation.Nullable private FontFamilyEnum fontFamily; public static final String JSON_PROPERTY_FONT_SIZE = "font_size"; + @jakarta.annotation.Nullable private Integer fontSize = 12; public SubFormFieldsPerDocumentTextMerge() { @@ -139,7 +142,7 @@ static public SubFormFieldsPerDocumentTextMerge init(HashMap data) throws Except ); } - public SubFormFieldsPerDocumentTextMerge type(String type) { + public SubFormFieldsPerDocumentTextMerge type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -159,12 +162,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public SubFormFieldsPerDocumentTextMerge fontFamily(FontFamilyEnum fontFamily) { + public SubFormFieldsPerDocumentTextMerge fontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; return this; } @@ -184,12 +187,12 @@ public FontFamilyEnum getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(FontFamilyEnum fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable FontFamilyEnum fontFamily) { this.fontFamily = fontFamily; } - public SubFormFieldsPerDocumentTextMerge fontSize(Integer fontSize) { + public SubFormFieldsPerDocumentTextMerge fontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; return this; } @@ -209,7 +212,7 @@ public Integer getFontSize() { @JsonProperty(JSON_PROPERTY_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontSize(Integer fontSize) { + public void setFontSize(@jakarta.annotation.Nullable Integer fontSize) { this.fontSize = fontSize; } diff --git a/src/main/java/com/dropbox/sign/model/SubMergeField.java b/src/main/java/com/dropbox/sign/model/SubMergeField.java index cc61287..9b039b4 100644 --- a/src/main/java/com/dropbox/sign/model/SubMergeField.java +++ b/src/main/java/com/dropbox/sign/model/SubMergeField.java @@ -36,19 +36,20 @@ SubMergeField.JSON_PROPERTY_NAME, SubMergeField.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubMergeField { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; /** * The type of merge field. */ public enum TypeEnum { - TEXT("text"), + TEXT(String.valueOf("text")), - CHECKBOX("checkbox"); + CHECKBOX(String.valueOf("checkbox")); private String value; @@ -78,6 +79,7 @@ public static TypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private TypeEnum type; public SubMergeField() { @@ -98,7 +100,7 @@ static public SubMergeField init(HashMap data) throws Exception { ); } - public SubMergeField name(String name) { + public SubMergeField name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -118,12 +120,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubMergeField type(TypeEnum type) { + public SubMergeField type(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; return this; } @@ -143,7 +145,7 @@ public TypeEnum getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(TypeEnum type) { + public void setType(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/SubOAuth.java b/src/main/java/com/dropbox/sign/model/SubOAuth.java index c997626..c5a7795 100644 --- a/src/main/java/com/dropbox/sign/model/SubOAuth.java +++ b/src/main/java/com/dropbox/sign/model/SubOAuth.java @@ -38,31 +38,32 @@ SubOAuth.JSON_PROPERTY_CALLBACK_URL, SubOAuth.JSON_PROPERTY_SCOPES }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubOAuth { public static final String JSON_PROPERTY_CALLBACK_URL = "callback_url"; + @jakarta.annotation.Nullable private String callbackUrl; /** * Gets or Sets scopes */ public enum ScopesEnum { - REQUEST_SIGNATURE("request_signature"), + REQUEST_SIGNATURE(String.valueOf("request_signature")), - BASIC_ACCOUNT_INFO("basic_account_info"), + BASIC_ACCOUNT_INFO(String.valueOf("basic_account_info")), - ACCOUNT_ACCESS("account_access"), + ACCOUNT_ACCESS(String.valueOf("account_access")), - SIGNATURE_REQUEST_ACCESS("signature_request_access"), + SIGNATURE_REQUEST_ACCESS(String.valueOf("signature_request_access")), - TEMPLATE_ACCESS("template_access"), + TEMPLATE_ACCESS(String.valueOf("template_access")), - TEAM_ACCESS("team_access"), + TEAM_ACCESS(String.valueOf("team_access")), - API_APP_ACCESS("api_app_access"), + API_APP_ACCESS(String.valueOf("api_app_access")), - EMPTY(""); + EMPTY(String.valueOf("")); private String value; @@ -92,6 +93,7 @@ public static ScopesEnum fromValue(String value) { } public static final String JSON_PROPERTY_SCOPES = "scopes"; + @jakarta.annotation.Nullable private List scopes = null; public SubOAuth() { @@ -112,7 +114,7 @@ static public SubOAuth init(HashMap data) throws Exception { ); } - public SubOAuth callbackUrl(String callbackUrl) { + public SubOAuth callbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; return this; } @@ -132,12 +134,12 @@ public String getCallbackUrl() { @JsonProperty(JSON_PROPERTY_CALLBACK_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCallbackUrl(String callbackUrl) { + public void setCallbackUrl(@jakarta.annotation.Nullable String callbackUrl) { this.callbackUrl = callbackUrl; } - public SubOAuth scopes(List scopes) { + public SubOAuth scopes(@jakarta.annotation.Nullable List scopes) { this.scopes = scopes; return this; } @@ -165,7 +167,7 @@ public List getScopes() { @JsonProperty(JSON_PROPERTY_SCOPES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setScopes(List scopes) { + public void setScopes(@jakarta.annotation.Nullable List scopes) { this.scopes = scopes; } diff --git a/src/main/java/com/dropbox/sign/model/SubOptions.java b/src/main/java/com/dropbox/sign/model/SubOptions.java index 73d5df6..2ff1672 100644 --- a/src/main/java/com/dropbox/sign/model/SubOptions.java +++ b/src/main/java/com/dropbox/sign/model/SubOptions.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ SubOptions.JSON_PROPERTY_CAN_INSERT_EVERYWHERE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubOptions { public static final String JSON_PROPERTY_CAN_INSERT_EVERYWHERE = "can_insert_everywhere"; + @jakarta.annotation.Nullable private Boolean canInsertEverywhere = false; public SubOptions() { @@ -59,7 +60,7 @@ static public SubOptions init(HashMap data) throws Exception { ); } - public SubOptions canInsertEverywhere(Boolean canInsertEverywhere) { + public SubOptions canInsertEverywhere(@jakarta.annotation.Nullable Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; return this; } @@ -79,7 +80,7 @@ public Boolean getCanInsertEverywhere() { @JsonProperty(JSON_PROPERTY_CAN_INSERT_EVERYWHERE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCanInsertEverywhere(Boolean canInsertEverywhere) { + public void setCanInsertEverywhere(@jakarta.annotation.Nullable Boolean canInsertEverywhere) { this.canInsertEverywhere = canInsertEverywhere; } diff --git a/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java b/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java index 2120ea6..e3906ba 100644 --- a/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java +++ b/src/main/java/com/dropbox/sign/model/SubSignatureRequestGroupedSigners.java @@ -40,16 +40,19 @@ SubSignatureRequestGroupedSigners.JSON_PROPERTY_SIGNERS, SubSignatureRequestGroupedSigners.JSON_PROPERTY_ORDER }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubSignatureRequestGroupedSigners { public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nonnull private String group; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nonnull private List signers = new ArrayList<>(); public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public SubSignatureRequestGroupedSigners() { @@ -70,7 +73,7 @@ static public SubSignatureRequestGroupedSigners init(HashMap data) throws Except ); } - public SubSignatureRequestGroupedSigners group(String group) { + public SubSignatureRequestGroupedSigners group(@jakarta.annotation.Nonnull String group) { this.group = group; return this; } @@ -90,12 +93,12 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nonnull String group) { this.group = group; } - public SubSignatureRequestGroupedSigners signers(List signers) { + public SubSignatureRequestGroupedSigners signers(@jakarta.annotation.Nonnull List signers) { this.signers = signers; return this; } @@ -123,12 +126,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nonnull List signers) { this.signers = signers; } - public SubSignatureRequestGroupedSigners order(Integer order) { + public SubSignatureRequestGroupedSigners order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -148,7 +151,7 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } diff --git a/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java b/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java index d1900a1..c0d16fe 100644 --- a/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java +++ b/src/main/java/com/dropbox/sign/model/SubSignatureRequestSigner.java @@ -40,31 +40,36 @@ SubSignatureRequestSigner.JSON_PROPERTY_SMS_PHONE_NUMBER, SubSignatureRequestSigner.JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubSignatureRequestSigner { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public static final String JSON_PROPERTY_PIN = "pin"; + @jakarta.annotation.Nullable private String pin; public static final String JSON_PROPERTY_SMS_PHONE_NUMBER = "sms_phone_number"; + @jakarta.annotation.Nullable private String smsPhoneNumber; /** * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). */ public enum SmsPhoneNumberTypeEnum { - AUTHENTICATION("authentication"), + AUTHENTICATION(String.valueOf("authentication")), - DELIVERY("delivery"); + DELIVERY(String.valueOf("delivery")); private String value; @@ -94,6 +99,7 @@ public static SmsPhoneNumberTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE = "sms_phone_number_type"; + @jakarta.annotation.Nullable private SmsPhoneNumberTypeEnum smsPhoneNumberType; public SubSignatureRequestSigner() { @@ -114,7 +120,7 @@ static public SubSignatureRequestSigner init(HashMap data) throws Exception { ); } - public SubSignatureRequestSigner name(String name) { + public SubSignatureRequestSigner name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -134,12 +140,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubSignatureRequestSigner emailAddress(String emailAddress) { + public SubSignatureRequestSigner emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -159,12 +165,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } - public SubSignatureRequestSigner order(Integer order) { + public SubSignatureRequestSigner order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -184,12 +190,12 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } - public SubSignatureRequestSigner pin(String pin) { + public SubSignatureRequestSigner pin(@jakarta.annotation.Nullable String pin) { this.pin = pin; return this; } @@ -209,12 +215,12 @@ public String getPin() { @JsonProperty(JSON_PROPERTY_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPin(String pin) { + public void setPin(@jakarta.annotation.Nullable String pin) { this.pin = pin; } - public SubSignatureRequestSigner smsPhoneNumber(String smsPhoneNumber) { + public SubSignatureRequestSigner smsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; return this; } @@ -234,12 +240,12 @@ public String getSmsPhoneNumber() { @JsonProperty(JSON_PROPERTY_SMS_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsPhoneNumber(String smsPhoneNumber) { + public void setSmsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; } - public SubSignatureRequestSigner smsPhoneNumberType(SmsPhoneNumberTypeEnum smsPhoneNumberType) { + public SubSignatureRequestSigner smsPhoneNumberType(@jakarta.annotation.Nullable SmsPhoneNumberTypeEnum smsPhoneNumberType) { this.smsPhoneNumberType = smsPhoneNumberType; return this; } @@ -259,7 +265,7 @@ public SmsPhoneNumberTypeEnum getSmsPhoneNumberType() { @JsonProperty(JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsPhoneNumberType(SmsPhoneNumberTypeEnum smsPhoneNumberType) { + public void setSmsPhoneNumberType(@jakarta.annotation.Nullable SmsPhoneNumberTypeEnum smsPhoneNumberType) { this.smsPhoneNumberType = smsPhoneNumberType; } diff --git a/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java b/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java index 53222fa..c5c3478 100644 --- a/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java +++ b/src/main/java/com/dropbox/sign/model/SubSignatureRequestTemplateSigner.java @@ -40,31 +40,36 @@ SubSignatureRequestTemplateSigner.JSON_PROPERTY_SMS_PHONE_NUMBER, SubSignatureRequestTemplateSigner.JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubSignatureRequestTemplateSigner { public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nonnull private String role; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public static final String JSON_PROPERTY_PIN = "pin"; + @jakarta.annotation.Nullable private String pin; public static final String JSON_PROPERTY_SMS_PHONE_NUMBER = "sms_phone_number"; + @jakarta.annotation.Nullable private String smsPhoneNumber; /** * Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). */ public enum SmsPhoneNumberTypeEnum { - AUTHENTICATION("authentication"), + AUTHENTICATION(String.valueOf("authentication")), - DELIVERY("delivery"); + DELIVERY(String.valueOf("delivery")); private String value; @@ -94,6 +99,7 @@ public static SmsPhoneNumberTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE = "sms_phone_number_type"; + @jakarta.annotation.Nullable private SmsPhoneNumberTypeEnum smsPhoneNumberType; public SubSignatureRequestTemplateSigner() { @@ -114,7 +120,7 @@ static public SubSignatureRequestTemplateSigner init(HashMap data) throws Except ); } - public SubSignatureRequestTemplateSigner role(String role) { + public SubSignatureRequestTemplateSigner role(@jakarta.annotation.Nonnull String role) { this.role = role; return this; } @@ -134,12 +140,12 @@ public String getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRole(String role) { + public void setRole(@jakarta.annotation.Nonnull String role) { this.role = role; } - public SubSignatureRequestTemplateSigner name(String name) { + public SubSignatureRequestTemplateSigner name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -159,12 +165,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubSignatureRequestTemplateSigner emailAddress(String emailAddress) { + public SubSignatureRequestTemplateSigner emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -184,12 +190,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } - public SubSignatureRequestTemplateSigner pin(String pin) { + public SubSignatureRequestTemplateSigner pin(@jakarta.annotation.Nullable String pin) { this.pin = pin; return this; } @@ -209,12 +215,12 @@ public String getPin() { @JsonProperty(JSON_PROPERTY_PIN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPin(String pin) { + public void setPin(@jakarta.annotation.Nullable String pin) { this.pin = pin; } - public SubSignatureRequestTemplateSigner smsPhoneNumber(String smsPhoneNumber) { + public SubSignatureRequestTemplateSigner smsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; return this; } @@ -234,12 +240,12 @@ public String getSmsPhoneNumber() { @JsonProperty(JSON_PROPERTY_SMS_PHONE_NUMBER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsPhoneNumber(String smsPhoneNumber) { + public void setSmsPhoneNumber(@jakarta.annotation.Nullable String smsPhoneNumber) { this.smsPhoneNumber = smsPhoneNumber; } - public SubSignatureRequestTemplateSigner smsPhoneNumberType(SmsPhoneNumberTypeEnum smsPhoneNumberType) { + public SubSignatureRequestTemplateSigner smsPhoneNumberType(@jakarta.annotation.Nullable SmsPhoneNumberTypeEnum smsPhoneNumberType) { this.smsPhoneNumberType = smsPhoneNumberType; return this; } @@ -259,7 +265,7 @@ public SmsPhoneNumberTypeEnum getSmsPhoneNumberType() { @JsonProperty(JSON_PROPERTY_SMS_PHONE_NUMBER_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsPhoneNumberType(SmsPhoneNumberTypeEnum smsPhoneNumberType) { + public void setSmsPhoneNumberType(@jakarta.annotation.Nullable SmsPhoneNumberTypeEnum smsPhoneNumberType) { this.smsPhoneNumberType = smsPhoneNumberType; } diff --git a/src/main/java/com/dropbox/sign/model/SubSigningOptions.java b/src/main/java/com/dropbox/sign/model/SubSigningOptions.java index 4e2c33c..8a194e4 100644 --- a/src/main/java/com/dropbox/sign/model/SubSigningOptions.java +++ b/src/main/java/com/dropbox/sign/model/SubSigningOptions.java @@ -39,20 +39,20 @@ SubSigningOptions.JSON_PROPERTY_TYPE, SubSigningOptions.JSON_PROPERTY_UPLOAD }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubSigningOptions { /** * The default type shown (limited to the listed types) */ public enum DefaultTypeEnum { - DRAW("draw"), + DRAW(String.valueOf("draw")), - PHONE("phone"), + PHONE(String.valueOf("phone")), - TYPE("type"), + TYPE(String.valueOf("type")), - UPLOAD("upload"); + UPLOAD(String.valueOf("upload")); private String value; @@ -82,18 +82,23 @@ public static DefaultTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_DEFAULT_TYPE = "default_type"; + @jakarta.annotation.Nonnull private DefaultTypeEnum defaultType; public static final String JSON_PROPERTY_DRAW = "draw"; + @jakarta.annotation.Nullable private Boolean draw = false; public static final String JSON_PROPERTY_PHONE = "phone"; + @jakarta.annotation.Nullable private Boolean phone = false; public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private Boolean type = false; public static final String JSON_PROPERTY_UPLOAD = "upload"; + @jakarta.annotation.Nullable private Boolean upload = false; public SubSigningOptions() { @@ -114,7 +119,7 @@ static public SubSigningOptions init(HashMap data) throws Exception { ); } - public SubSigningOptions defaultType(DefaultTypeEnum defaultType) { + public SubSigningOptions defaultType(@jakarta.annotation.Nonnull DefaultTypeEnum defaultType) { this.defaultType = defaultType; return this; } @@ -134,12 +139,12 @@ public DefaultTypeEnum getDefaultType() { @JsonProperty(JSON_PROPERTY_DEFAULT_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDefaultType(DefaultTypeEnum defaultType) { + public void setDefaultType(@jakarta.annotation.Nonnull DefaultTypeEnum defaultType) { this.defaultType = defaultType; } - public SubSigningOptions draw(Boolean draw) { + public SubSigningOptions draw(@jakarta.annotation.Nullable Boolean draw) { this.draw = draw; return this; } @@ -159,12 +164,12 @@ public Boolean getDraw() { @JsonProperty(JSON_PROPERTY_DRAW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDraw(Boolean draw) { + public void setDraw(@jakarta.annotation.Nullable Boolean draw) { this.draw = draw; } - public SubSigningOptions phone(Boolean phone) { + public SubSigningOptions phone(@jakarta.annotation.Nullable Boolean phone) { this.phone = phone; return this; } @@ -184,12 +189,12 @@ public Boolean getPhone() { @JsonProperty(JSON_PROPERTY_PHONE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPhone(Boolean phone) { + public void setPhone(@jakarta.annotation.Nullable Boolean phone) { this.phone = phone; } - public SubSigningOptions type(Boolean type) { + public SubSigningOptions type(@jakarta.annotation.Nullable Boolean type) { this.type = type; return this; } @@ -209,12 +214,12 @@ public Boolean getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(Boolean type) { + public void setType(@jakarta.annotation.Nullable Boolean type) { this.type = type; } - public SubSigningOptions upload(Boolean upload) { + public SubSigningOptions upload(@jakarta.annotation.Nullable Boolean upload) { this.upload = upload; return this; } @@ -234,7 +239,7 @@ public Boolean getUpload() { @JsonProperty(JSON_PROPERTY_UPLOAD) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpload(Boolean upload) { + public void setUpload(@jakarta.annotation.Nullable Boolean upload) { this.upload = upload; } diff --git a/src/main/java/com/dropbox/sign/model/SubTeamResponse.java b/src/main/java/com/dropbox/sign/model/SubTeamResponse.java index e653cbb..5ff941e 100644 --- a/src/main/java/com/dropbox/sign/model/SubTeamResponse.java +++ b/src/main/java/com/dropbox/sign/model/SubTeamResponse.java @@ -36,13 +36,15 @@ SubTeamResponse.JSON_PROPERTY_TEAM_ID, SubTeamResponse.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubTeamResponse { public static final String JSON_PROPERTY_TEAM_ID = "team_id"; + @jakarta.annotation.Nullable private String teamId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public SubTeamResponse() { @@ -63,7 +65,7 @@ static public SubTeamResponse init(HashMap data) throws Exception { ); } - public SubTeamResponse teamId(String teamId) { + public SubTeamResponse teamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; return this; } @@ -83,12 +85,12 @@ public String getTeamId() { @JsonProperty(JSON_PROPERTY_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamId(String teamId) { + public void setTeamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; } - public SubTeamResponse name(String name) { + public SubTeamResponse name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -108,7 +110,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/SubTemplateRole.java b/src/main/java/com/dropbox/sign/model/SubTemplateRole.java index 081d88d..36ebe7a 100644 --- a/src/main/java/com/dropbox/sign/model/SubTemplateRole.java +++ b/src/main/java/com/dropbox/sign/model/SubTemplateRole.java @@ -36,13 +36,15 @@ SubTemplateRole.JSON_PROPERTY_NAME, SubTemplateRole.JSON_PROPERTY_ORDER }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubTemplateRole { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public SubTemplateRole() { @@ -63,7 +65,7 @@ static public SubTemplateRole init(HashMap data) throws Exception { ); } - public SubTemplateRole name(String name) { + public SubTemplateRole name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -83,12 +85,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public SubTemplateRole order(Integer order) { + public SubTemplateRole order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -108,7 +110,7 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } diff --git a/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java b/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java index bc3ea96..0e08dbd 100644 --- a/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java +++ b/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftSigner.java @@ -37,16 +37,19 @@ SubUnclaimedDraftSigner.JSON_PROPERTY_NAME, SubUnclaimedDraftSigner.JSON_PROPERTY_ORDER }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubUnclaimedDraftSigner { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public SubUnclaimedDraftSigner() { @@ -67,7 +70,7 @@ static public SubUnclaimedDraftSigner init(HashMap data) throws Exception { ); } - public SubUnclaimedDraftSigner emailAddress(String emailAddress) { + public SubUnclaimedDraftSigner emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -87,12 +90,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } - public SubUnclaimedDraftSigner name(String name) { + public SubUnclaimedDraftSigner name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -112,12 +115,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubUnclaimedDraftSigner order(Integer order) { + public SubUnclaimedDraftSigner order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -137,7 +140,7 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } diff --git a/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java b/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java index 2b7d02c..7cb7161 100644 --- a/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java +++ b/src/main/java/com/dropbox/sign/model/SubUnclaimedDraftTemplateSigner.java @@ -37,16 +37,19 @@ SubUnclaimedDraftTemplateSigner.JSON_PROPERTY_NAME, SubUnclaimedDraftTemplateSigner.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubUnclaimedDraftTemplateSigner { public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nonnull private String role; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nonnull private String name; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nonnull private String emailAddress; public SubUnclaimedDraftTemplateSigner() { @@ -67,7 +70,7 @@ static public SubUnclaimedDraftTemplateSigner init(HashMap data) throws Exceptio ); } - public SubUnclaimedDraftTemplateSigner role(String role) { + public SubUnclaimedDraftTemplateSigner role(@jakarta.annotation.Nonnull String role) { this.role = role; return this; } @@ -87,12 +90,12 @@ public String getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRole(String role) { + public void setRole(@jakarta.annotation.Nonnull String role) { this.role = role; } - public SubUnclaimedDraftTemplateSigner name(String name) { + public SubUnclaimedDraftTemplateSigner name(@jakarta.annotation.Nonnull String name) { this.name = name; return this; } @@ -112,12 +115,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nonnull String name) { this.name = name; } - public SubUnclaimedDraftTemplateSigner emailAddress(String emailAddress) { + public SubUnclaimedDraftTemplateSigner emailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -137,7 +140,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nonnull String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java b/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java index a14d8cc..0b98b9d 100644 --- a/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java +++ b/src/main/java/com/dropbox/sign/model/SubWhiteLabelingOptions.java @@ -49,19 +49,20 @@ SubWhiteLabelingOptions.JSON_PROPERTY_TEXT_COLOR2, SubWhiteLabelingOptions.JSON_PROPERTY_RESET_TO_DEFAULT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class SubWhiteLabelingOptions { public static final String JSON_PROPERTY_HEADER_BACKGROUND_COLOR = "header_background_color"; + @jakarta.annotation.Nullable private String headerBackgroundColor = "#1a1a1a"; /** * Gets or Sets legalVersion */ public enum LegalVersionEnum { - TERMS1("terms1"), + TERMS1(String.valueOf("terms1")), - TERMS2("terms2"); + TERMS2(String.valueOf("terms2")); private String value; @@ -91,45 +92,59 @@ public static LegalVersionEnum fromValue(String value) { } public static final String JSON_PROPERTY_LEGAL_VERSION = "legal_version"; + @jakarta.annotation.Nullable private LegalVersionEnum legalVersion = LegalVersionEnum.TERMS1; public static final String JSON_PROPERTY_LINK_COLOR = "link_color"; + @jakarta.annotation.Nullable private String linkColor = "#0061FE"; public static final String JSON_PROPERTY_PAGE_BACKGROUND_COLOR = "page_background_color"; + @jakarta.annotation.Nullable private String pageBackgroundColor = "#f7f8f9"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR = "primary_button_color"; + @jakarta.annotation.Nullable private String primaryButtonColor = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER = "primary_button_color_hover"; + @jakarta.annotation.Nullable private String primaryButtonColorHover = "#0061FE"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR = "primary_button_text_color"; + @jakarta.annotation.Nullable private String primaryButtonTextColor = "#ffffff"; public static final String JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER = "primary_button_text_color_hover"; + @jakarta.annotation.Nullable private String primaryButtonTextColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR = "secondary_button_color"; + @jakarta.annotation.Nullable private String secondaryButtonColor = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER = "secondary_button_color_hover"; + @jakarta.annotation.Nullable private String secondaryButtonColorHover = "#ffffff"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR = "secondary_button_text_color"; + @jakarta.annotation.Nullable private String secondaryButtonTextColor = "#0061FE"; public static final String JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER = "secondary_button_text_color_hover"; + @jakarta.annotation.Nullable private String secondaryButtonTextColorHover = "#0061FE"; public static final String JSON_PROPERTY_TEXT_COLOR1 = "text_color1"; + @jakarta.annotation.Nullable private String textColor1 = "#808080"; public static final String JSON_PROPERTY_TEXT_COLOR2 = "text_color2"; + @jakarta.annotation.Nullable private String textColor2 = "#ffffff"; public static final String JSON_PROPERTY_RESET_TO_DEFAULT = "reset_to_default"; + @jakarta.annotation.Nullable private Boolean resetToDefault; public SubWhiteLabelingOptions() { @@ -150,7 +165,7 @@ static public SubWhiteLabelingOptions init(HashMap data) throws Exception { ); } - public SubWhiteLabelingOptions headerBackgroundColor(String headerBackgroundColor) { + public SubWhiteLabelingOptions headerBackgroundColor(@jakarta.annotation.Nullable String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; return this; } @@ -170,12 +185,12 @@ public String getHeaderBackgroundColor() { @JsonProperty(JSON_PROPERTY_HEADER_BACKGROUND_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeaderBackgroundColor(String headerBackgroundColor) { + public void setHeaderBackgroundColor(@jakarta.annotation.Nullable String headerBackgroundColor) { this.headerBackgroundColor = headerBackgroundColor; } - public SubWhiteLabelingOptions legalVersion(LegalVersionEnum legalVersion) { + public SubWhiteLabelingOptions legalVersion(@jakarta.annotation.Nullable LegalVersionEnum legalVersion) { this.legalVersion = legalVersion; return this; } @@ -195,12 +210,12 @@ public LegalVersionEnum getLegalVersion() { @JsonProperty(JSON_PROPERTY_LEGAL_VERSION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLegalVersion(LegalVersionEnum legalVersion) { + public void setLegalVersion(@jakarta.annotation.Nullable LegalVersionEnum legalVersion) { this.legalVersion = legalVersion; } - public SubWhiteLabelingOptions linkColor(String linkColor) { + public SubWhiteLabelingOptions linkColor(@jakarta.annotation.Nullable String linkColor) { this.linkColor = linkColor; return this; } @@ -220,12 +235,12 @@ public String getLinkColor() { @JsonProperty(JSON_PROPERTY_LINK_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setLinkColor(String linkColor) { + public void setLinkColor(@jakarta.annotation.Nullable String linkColor) { this.linkColor = linkColor; } - public SubWhiteLabelingOptions pageBackgroundColor(String pageBackgroundColor) { + public SubWhiteLabelingOptions pageBackgroundColor(@jakarta.annotation.Nullable String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; return this; } @@ -245,12 +260,12 @@ public String getPageBackgroundColor() { @JsonProperty(JSON_PROPERTY_PAGE_BACKGROUND_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPageBackgroundColor(String pageBackgroundColor) { + public void setPageBackgroundColor(@jakarta.annotation.Nullable String pageBackgroundColor) { this.pageBackgroundColor = pageBackgroundColor; } - public SubWhiteLabelingOptions primaryButtonColor(String primaryButtonColor) { + public SubWhiteLabelingOptions primaryButtonColor(@jakarta.annotation.Nullable String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; return this; } @@ -270,12 +285,12 @@ public String getPrimaryButtonColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonColor(String primaryButtonColor) { + public void setPrimaryButtonColor(@jakarta.annotation.Nullable String primaryButtonColor) { this.primaryButtonColor = primaryButtonColor; } - public SubWhiteLabelingOptions primaryButtonColorHover(String primaryButtonColorHover) { + public SubWhiteLabelingOptions primaryButtonColorHover(@jakarta.annotation.Nullable String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; return this; } @@ -295,12 +310,12 @@ public String getPrimaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonColorHover(String primaryButtonColorHover) { + public void setPrimaryButtonColorHover(@jakarta.annotation.Nullable String primaryButtonColorHover) { this.primaryButtonColorHover = primaryButtonColorHover; } - public SubWhiteLabelingOptions primaryButtonTextColor(String primaryButtonTextColor) { + public SubWhiteLabelingOptions primaryButtonTextColor(@jakarta.annotation.Nullable String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; return this; } @@ -320,12 +335,12 @@ public String getPrimaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonTextColor(String primaryButtonTextColor) { + public void setPrimaryButtonTextColor(@jakarta.annotation.Nullable String primaryButtonTextColor) { this.primaryButtonTextColor = primaryButtonTextColor; } - public SubWhiteLabelingOptions primaryButtonTextColorHover(String primaryButtonTextColorHover) { + public SubWhiteLabelingOptions primaryButtonTextColorHover(@jakarta.annotation.Nullable String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; return this; } @@ -345,12 +360,12 @@ public String getPrimaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_PRIMARY_BUTTON_TEXT_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPrimaryButtonTextColorHover(String primaryButtonTextColorHover) { + public void setPrimaryButtonTextColorHover(@jakarta.annotation.Nullable String primaryButtonTextColorHover) { this.primaryButtonTextColorHover = primaryButtonTextColorHover; } - public SubWhiteLabelingOptions secondaryButtonColor(String secondaryButtonColor) { + public SubWhiteLabelingOptions secondaryButtonColor(@jakarta.annotation.Nullable String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; return this; } @@ -370,12 +385,12 @@ public String getSecondaryButtonColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonColor(String secondaryButtonColor) { + public void setSecondaryButtonColor(@jakarta.annotation.Nullable String secondaryButtonColor) { this.secondaryButtonColor = secondaryButtonColor; } - public SubWhiteLabelingOptions secondaryButtonColorHover(String secondaryButtonColorHover) { + public SubWhiteLabelingOptions secondaryButtonColorHover(@jakarta.annotation.Nullable String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; return this; } @@ -395,12 +410,12 @@ public String getSecondaryButtonColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonColorHover(String secondaryButtonColorHover) { + public void setSecondaryButtonColorHover(@jakarta.annotation.Nullable String secondaryButtonColorHover) { this.secondaryButtonColorHover = secondaryButtonColorHover; } - public SubWhiteLabelingOptions secondaryButtonTextColor(String secondaryButtonTextColor) { + public SubWhiteLabelingOptions secondaryButtonTextColor(@jakarta.annotation.Nullable String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; return this; } @@ -420,12 +435,12 @@ public String getSecondaryButtonTextColor() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonTextColor(String secondaryButtonTextColor) { + public void setSecondaryButtonTextColor(@jakarta.annotation.Nullable String secondaryButtonTextColor) { this.secondaryButtonTextColor = secondaryButtonTextColor; } - public SubWhiteLabelingOptions secondaryButtonTextColorHover(String secondaryButtonTextColorHover) { + public SubWhiteLabelingOptions secondaryButtonTextColorHover(@jakarta.annotation.Nullable String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; return this; } @@ -445,12 +460,12 @@ public String getSecondaryButtonTextColorHover() { @JsonProperty(JSON_PROPERTY_SECONDARY_BUTTON_TEXT_COLOR_HOVER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSecondaryButtonTextColorHover(String secondaryButtonTextColorHover) { + public void setSecondaryButtonTextColorHover(@jakarta.annotation.Nullable String secondaryButtonTextColorHover) { this.secondaryButtonTextColorHover = secondaryButtonTextColorHover; } - public SubWhiteLabelingOptions textColor1(String textColor1) { + public SubWhiteLabelingOptions textColor1(@jakarta.annotation.Nullable String textColor1) { this.textColor1 = textColor1; return this; } @@ -470,12 +485,12 @@ public String getTextColor1() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR1) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTextColor1(String textColor1) { + public void setTextColor1(@jakarta.annotation.Nullable String textColor1) { this.textColor1 = textColor1; } - public SubWhiteLabelingOptions textColor2(String textColor2) { + public SubWhiteLabelingOptions textColor2(@jakarta.annotation.Nullable String textColor2) { this.textColor2 = textColor2; return this; } @@ -495,12 +510,12 @@ public String getTextColor2() { @JsonProperty(JSON_PROPERTY_TEXT_COLOR2) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTextColor2(String textColor2) { + public void setTextColor2(@jakarta.annotation.Nullable String textColor2) { this.textColor2 = textColor2; } - public SubWhiteLabelingOptions resetToDefault(Boolean resetToDefault) { + public SubWhiteLabelingOptions resetToDefault(@jakarta.annotation.Nullable Boolean resetToDefault) { this.resetToDefault = resetToDefault; return this; } @@ -520,7 +535,7 @@ public Boolean getResetToDefault() { @JsonProperty(JSON_PROPERTY_RESET_TO_DEFAULT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setResetToDefault(Boolean resetToDefault) { + public void setResetToDefault(@jakarta.annotation.Nullable Boolean resetToDefault) { this.resetToDefault = resetToDefault; } diff --git a/src/main/java/com/dropbox/sign/model/TeamAddMemberRequest.java b/src/main/java/com/dropbox/sign/model/TeamAddMemberRequest.java index d79399a..26ce749 100644 --- a/src/main/java/com/dropbox/sign/model/TeamAddMemberRequest.java +++ b/src/main/java/com/dropbox/sign/model/TeamAddMemberRequest.java @@ -37,26 +37,28 @@ TeamAddMemberRequest.JSON_PROPERTY_EMAIL_ADDRESS, TeamAddMemberRequest.JSON_PROPERTY_ROLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamAddMemberRequest { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; /** * A role member will take in a new Team. **NOTE:** This parameter is used only if `team_id` is provided. */ public enum RoleEnum { - MEMBER("Member"), + MEMBER(String.valueOf("Member")), - DEVELOPER("Developer"), + DEVELOPER(String.valueOf("Developer")), - TEAM_MANAGER("Team Manager"), + TEAM_MANAGER(String.valueOf("Team Manager")), - ADMIN("Admin"); + ADMIN(String.valueOf("Admin")); private String value; @@ -86,6 +88,7 @@ public static RoleEnum fromValue(String value) { } public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nullable private RoleEnum role; public TeamAddMemberRequest() { @@ -106,7 +109,7 @@ static public TeamAddMemberRequest init(HashMap data) throws Exception { ); } - public TeamAddMemberRequest accountId(String accountId) { + public TeamAddMemberRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -126,12 +129,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TeamAddMemberRequest emailAddress(String emailAddress) { + public TeamAddMemberRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -151,12 +154,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TeamAddMemberRequest role(RoleEnum role) { + public TeamAddMemberRequest role(@jakarta.annotation.Nullable RoleEnum role) { this.role = role; return this; } @@ -176,7 +179,7 @@ public RoleEnum getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRole(RoleEnum role) { + public void setRole(@jakarta.annotation.Nullable RoleEnum role) { this.role = role; } diff --git a/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java b/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java index cb5c87e..f5b0e92 100644 --- a/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/TeamCreateRequest.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ TeamCreateRequest.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamCreateRequest { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name = "Untitled Team"; public TeamCreateRequest() { @@ -59,7 +60,7 @@ static public TeamCreateRequest init(HashMap data) throws Exception { ); } - public TeamCreateRequest name(String name) { + public TeamCreateRequest name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -79,7 +80,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java b/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java index f6a7870..8d2bf78 100644 --- a/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamGetInfoResponse.java @@ -40,13 +40,15 @@ TeamGetInfoResponse.JSON_PROPERTY_TEAM, TeamGetInfoResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamGetInfoResponse { public static final String JSON_PROPERTY_TEAM = "team"; + @jakarta.annotation.Nonnull private TeamInfoResponse team; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TeamGetInfoResponse() { @@ -67,7 +69,7 @@ static public TeamGetInfoResponse init(HashMap data) throws Exception { ); } - public TeamGetInfoResponse team(TeamInfoResponse team) { + public TeamGetInfoResponse team(@jakarta.annotation.Nonnull TeamInfoResponse team) { this.team = team; return this; } @@ -87,12 +89,12 @@ public TeamInfoResponse getTeam() { @JsonProperty(JSON_PROPERTY_TEAM) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTeam(TeamInfoResponse team) { + public void setTeam(@jakarta.annotation.Nonnull TeamInfoResponse team) { this.team = team; } - public TeamGetInfoResponse warnings(List warnings) { + public TeamGetInfoResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TeamGetResponse.java b/src/main/java/com/dropbox/sign/model/TeamGetResponse.java index f1670c1..957c890 100644 --- a/src/main/java/com/dropbox/sign/model/TeamGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamGetResponse.java @@ -40,13 +40,15 @@ TeamGetResponse.JSON_PROPERTY_TEAM, TeamGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamGetResponse { public static final String JSON_PROPERTY_TEAM = "team"; + @jakarta.annotation.Nonnull private TeamResponse team; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TeamGetResponse() { @@ -67,7 +69,7 @@ static public TeamGetResponse init(HashMap data) throws Exception { ); } - public TeamGetResponse team(TeamResponse team) { + public TeamGetResponse team(@jakarta.annotation.Nonnull TeamResponse team) { this.team = team; return this; } @@ -87,12 +89,12 @@ public TeamResponse getTeam() { @JsonProperty(JSON_PROPERTY_TEAM) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTeam(TeamResponse team) { + public void setTeam(@jakarta.annotation.Nonnull TeamResponse team) { this.team = team; } - public TeamGetResponse warnings(List warnings) { + public TeamGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java b/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java index 4a1e91a..39282f5 100644 --- a/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamInfoResponse.java @@ -40,22 +40,27 @@ TeamInfoResponse.JSON_PROPERTY_NUM_MEMBERS, TeamInfoResponse.JSON_PROPERTY_NUM_SUB_TEAMS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamInfoResponse { public static final String JSON_PROPERTY_TEAM_ID = "team_id"; + @jakarta.annotation.Nullable private String teamId; public static final String JSON_PROPERTY_TEAM_PARENT = "team_parent"; + @jakarta.annotation.Nullable private TeamParentResponse teamParent; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_NUM_MEMBERS = "num_members"; + @jakarta.annotation.Nullable private Integer numMembers; public static final String JSON_PROPERTY_NUM_SUB_TEAMS = "num_sub_teams"; + @jakarta.annotation.Nullable private Integer numSubTeams; public TeamInfoResponse() { @@ -76,7 +81,7 @@ static public TeamInfoResponse init(HashMap data) throws Exception { ); } - public TeamInfoResponse teamId(String teamId) { + public TeamInfoResponse teamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; return this; } @@ -96,12 +101,12 @@ public String getTeamId() { @JsonProperty(JSON_PROPERTY_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamId(String teamId) { + public void setTeamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; } - public TeamInfoResponse teamParent(TeamParentResponse teamParent) { + public TeamInfoResponse teamParent(@jakarta.annotation.Nullable TeamParentResponse teamParent) { this.teamParent = teamParent; return this; } @@ -121,12 +126,12 @@ public TeamParentResponse getTeamParent() { @JsonProperty(JSON_PROPERTY_TEAM_PARENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamParent(TeamParentResponse teamParent) { + public void setTeamParent(@jakarta.annotation.Nullable TeamParentResponse teamParent) { this.teamParent = teamParent; } - public TeamInfoResponse name(String name) { + public TeamInfoResponse name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -146,12 +151,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TeamInfoResponse numMembers(Integer numMembers) { + public TeamInfoResponse numMembers(@jakarta.annotation.Nullable Integer numMembers) { this.numMembers = numMembers; return this; } @@ -171,12 +176,12 @@ public Integer getNumMembers() { @JsonProperty(JSON_PROPERTY_NUM_MEMBERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumMembers(Integer numMembers) { + public void setNumMembers(@jakarta.annotation.Nullable Integer numMembers) { this.numMembers = numMembers; } - public TeamInfoResponse numSubTeams(Integer numSubTeams) { + public TeamInfoResponse numSubTeams(@jakarta.annotation.Nullable Integer numSubTeams) { this.numSubTeams = numSubTeams; return this; } @@ -196,7 +201,7 @@ public Integer getNumSubTeams() { @JsonProperty(JSON_PROPERTY_NUM_SUB_TEAMS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumSubTeams(Integer numSubTeams) { + public void setNumSubTeams(@jakarta.annotation.Nullable Integer numSubTeams) { this.numSubTeams = numSubTeams; } diff --git a/src/main/java/com/dropbox/sign/model/TeamInviteResponse.java b/src/main/java/com/dropbox/sign/model/TeamInviteResponse.java index fb8aef5..1e1b4f1 100644 --- a/src/main/java/com/dropbox/sign/model/TeamInviteResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamInviteResponse.java @@ -40,25 +40,31 @@ TeamInviteResponse.JSON_PROPERTY_REDEEMED_AT, TeamInviteResponse.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamInviteResponse { public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_TEAM_ID = "team_id"; + @jakarta.annotation.Nullable private String teamId; public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nullable private String role; public static final String JSON_PROPERTY_SENT_AT = "sent_at"; + @jakarta.annotation.Nullable private Integer sentAt; public static final String JSON_PROPERTY_REDEEMED_AT = "redeemed_at"; + @jakarta.annotation.Nullable private Integer redeemedAt; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public TeamInviteResponse() { @@ -79,7 +85,7 @@ static public TeamInviteResponse init(HashMap data) throws Exception { ); } - public TeamInviteResponse emailAddress(String emailAddress) { + public TeamInviteResponse emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -99,12 +105,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TeamInviteResponse teamId(String teamId) { + public TeamInviteResponse teamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; return this; } @@ -124,12 +130,12 @@ public String getTeamId() { @JsonProperty(JSON_PROPERTY_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamId(String teamId) { + public void setTeamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; } - public TeamInviteResponse role(String role) { + public TeamInviteResponse role(@jakarta.annotation.Nullable String role) { this.role = role; return this; } @@ -149,12 +155,12 @@ public String getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRole(String role) { + public void setRole(@jakarta.annotation.Nullable String role) { this.role = role; } - public TeamInviteResponse sentAt(Integer sentAt) { + public TeamInviteResponse sentAt(@jakarta.annotation.Nullable Integer sentAt) { this.sentAt = sentAt; return this; } @@ -174,12 +180,12 @@ public Integer getSentAt() { @JsonProperty(JSON_PROPERTY_SENT_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSentAt(Integer sentAt) { + public void setSentAt(@jakarta.annotation.Nullable Integer sentAt) { this.sentAt = sentAt; } - public TeamInviteResponse redeemedAt(Integer redeemedAt) { + public TeamInviteResponse redeemedAt(@jakarta.annotation.Nullable Integer redeemedAt) { this.redeemedAt = redeemedAt; return this; } @@ -199,12 +205,12 @@ public Integer getRedeemedAt() { @JsonProperty(JSON_PROPERTY_REDEEMED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRedeemedAt(Integer redeemedAt) { + public void setRedeemedAt(@jakarta.annotation.Nullable Integer redeemedAt) { this.redeemedAt = redeemedAt; } - public TeamInviteResponse expiresAt(Integer expiresAt) { + public TeamInviteResponse expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -224,7 +230,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/TeamInvitesResponse.java b/src/main/java/com/dropbox/sign/model/TeamInvitesResponse.java index b509eb0..4e1eb25 100644 --- a/src/main/java/com/dropbox/sign/model/TeamInvitesResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamInvitesResponse.java @@ -40,13 +40,15 @@ TeamInvitesResponse.JSON_PROPERTY_TEAM_INVITES, TeamInvitesResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamInvitesResponse { public static final String JSON_PROPERTY_TEAM_INVITES = "team_invites"; + @jakarta.annotation.Nonnull private List teamInvites = new ArrayList<>(); public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TeamInvitesResponse() { @@ -67,7 +69,7 @@ static public TeamInvitesResponse init(HashMap data) throws Exception { ); } - public TeamInvitesResponse teamInvites(List teamInvites) { + public TeamInvitesResponse teamInvites(@jakarta.annotation.Nonnull List teamInvites) { this.teamInvites = teamInvites; return this; } @@ -95,12 +97,12 @@ public List getTeamInvites() { @JsonProperty(JSON_PROPERTY_TEAM_INVITES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTeamInvites(List teamInvites) { + public void setTeamInvites(@jakarta.annotation.Nonnull List teamInvites) { this.teamInvites = teamInvites; } - public TeamInvitesResponse warnings(List warnings) { + public TeamInvitesResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -128,7 +130,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TeamMemberResponse.java b/src/main/java/com/dropbox/sign/model/TeamMemberResponse.java index 888e9a8..b454ffb 100644 --- a/src/main/java/com/dropbox/sign/model/TeamMemberResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamMemberResponse.java @@ -37,16 +37,19 @@ TeamMemberResponse.JSON_PROPERTY_EMAIL_ADDRESS, TeamMemberResponse.JSON_PROPERTY_ROLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamMemberResponse { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_ROLE = "role"; + @jakarta.annotation.Nullable private String role; public TeamMemberResponse() { @@ -67,7 +70,7 @@ static public TeamMemberResponse init(HashMap data) throws Exception { ); } - public TeamMemberResponse accountId(String accountId) { + public TeamMemberResponse accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -87,12 +90,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TeamMemberResponse emailAddress(String emailAddress) { + public TeamMemberResponse emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -112,12 +115,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TeamMemberResponse role(String role) { + public TeamMemberResponse role(@jakarta.annotation.Nullable String role) { this.role = role; return this; } @@ -137,7 +140,7 @@ public String getRole() { @JsonProperty(JSON_PROPERTY_ROLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRole(String role) { + public void setRole(@jakarta.annotation.Nullable String role) { this.role = role; } diff --git a/src/main/java/com/dropbox/sign/model/TeamMembersResponse.java b/src/main/java/com/dropbox/sign/model/TeamMembersResponse.java index 05fb9e4..181e65e 100644 --- a/src/main/java/com/dropbox/sign/model/TeamMembersResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamMembersResponse.java @@ -42,16 +42,19 @@ TeamMembersResponse.JSON_PROPERTY_LIST_INFO, TeamMembersResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamMembersResponse { public static final String JSON_PROPERTY_TEAM_MEMBERS = "team_members"; + @jakarta.annotation.Nonnull private List teamMembers = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TeamMembersResponse() { @@ -72,7 +75,7 @@ static public TeamMembersResponse init(HashMap data) throws Exception { ); } - public TeamMembersResponse teamMembers(List teamMembers) { + public TeamMembersResponse teamMembers(@jakarta.annotation.Nonnull List teamMembers) { this.teamMembers = teamMembers; return this; } @@ -100,12 +103,12 @@ public List getTeamMembers() { @JsonProperty(JSON_PROPERTY_TEAM_MEMBERS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTeamMembers(List teamMembers) { + public void setTeamMembers(@jakarta.annotation.Nonnull List teamMembers) { this.teamMembers = teamMembers; } - public TeamMembersResponse listInfo(ListInfoResponse listInfo) { + public TeamMembersResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public TeamMembersResponse warnings(List warnings) { + public TeamMembersResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TeamParentResponse.java b/src/main/java/com/dropbox/sign/model/TeamParentResponse.java index 482b585..5928538 100644 --- a/src/main/java/com/dropbox/sign/model/TeamParentResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamParentResponse.java @@ -36,13 +36,15 @@ TeamParentResponse.JSON_PROPERTY_TEAM_ID, TeamParentResponse.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamParentResponse { public static final String JSON_PROPERTY_TEAM_ID = "team_id"; + @jakarta.annotation.Nullable private String teamId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public TeamParentResponse() { @@ -63,7 +65,7 @@ static public TeamParentResponse init(HashMap data) throws Exception { ); } - public TeamParentResponse teamId(String teamId) { + public TeamParentResponse teamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; return this; } @@ -83,12 +85,12 @@ public String getTeamId() { @JsonProperty(JSON_PROPERTY_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTeamId(String teamId) { + public void setTeamId(@jakarta.annotation.Nullable String teamId) { this.teamId = teamId; } - public TeamParentResponse name(String name) { + public TeamParentResponse name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -108,7 +110,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/TeamRemoveMemberRequest.java b/src/main/java/com/dropbox/sign/model/TeamRemoveMemberRequest.java index 9303f68..f48daa1 100644 --- a/src/main/java/com/dropbox/sign/model/TeamRemoveMemberRequest.java +++ b/src/main/java/com/dropbox/sign/model/TeamRemoveMemberRequest.java @@ -39,32 +39,36 @@ TeamRemoveMemberRequest.JSON_PROPERTY_NEW_TEAM_ID, TeamRemoveMemberRequest.JSON_PROPERTY_NEW_ROLE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamRemoveMemberRequest { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_NEW_OWNER_EMAIL_ADDRESS = "new_owner_email_address"; + @jakarta.annotation.Nullable private String newOwnerEmailAddress; public static final String JSON_PROPERTY_NEW_TEAM_ID = "new_team_id"; + @jakarta.annotation.Nullable private String newTeamId; /** * A new role member will take in a new Team. **NOTE:** This parameter is used only if `new_team_id` is provided. */ public enum NewRoleEnum { - MEMBER("Member"), + MEMBER(String.valueOf("Member")), - DEVELOPER("Developer"), + DEVELOPER(String.valueOf("Developer")), - TEAM_MANAGER("Team Manager"), + TEAM_MANAGER(String.valueOf("Team Manager")), - ADMIN("Admin"); + ADMIN(String.valueOf("Admin")); private String value; @@ -94,6 +98,7 @@ public static NewRoleEnum fromValue(String value) { } public static final String JSON_PROPERTY_NEW_ROLE = "new_role"; + @jakarta.annotation.Nullable private NewRoleEnum newRole; public TeamRemoveMemberRequest() { @@ -114,7 +119,7 @@ static public TeamRemoveMemberRequest init(HashMap data) throws Exception { ); } - public TeamRemoveMemberRequest accountId(String accountId) { + public TeamRemoveMemberRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -134,12 +139,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TeamRemoveMemberRequest emailAddress(String emailAddress) { + public TeamRemoveMemberRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -159,12 +164,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TeamRemoveMemberRequest newOwnerEmailAddress(String newOwnerEmailAddress) { + public TeamRemoveMemberRequest newOwnerEmailAddress(@jakarta.annotation.Nullable String newOwnerEmailAddress) { this.newOwnerEmailAddress = newOwnerEmailAddress; return this; } @@ -184,12 +189,12 @@ public String getNewOwnerEmailAddress() { @JsonProperty(JSON_PROPERTY_NEW_OWNER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNewOwnerEmailAddress(String newOwnerEmailAddress) { + public void setNewOwnerEmailAddress(@jakarta.annotation.Nullable String newOwnerEmailAddress) { this.newOwnerEmailAddress = newOwnerEmailAddress; } - public TeamRemoveMemberRequest newTeamId(String newTeamId) { + public TeamRemoveMemberRequest newTeamId(@jakarta.annotation.Nullable String newTeamId) { this.newTeamId = newTeamId; return this; } @@ -209,12 +214,12 @@ public String getNewTeamId() { @JsonProperty(JSON_PROPERTY_NEW_TEAM_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNewTeamId(String newTeamId) { + public void setNewTeamId(@jakarta.annotation.Nullable String newTeamId) { this.newTeamId = newTeamId; } - public TeamRemoveMemberRequest newRole(NewRoleEnum newRole) { + public TeamRemoveMemberRequest newRole(@jakarta.annotation.Nullable NewRoleEnum newRole) { this.newRole = newRole; return this; } @@ -234,7 +239,7 @@ public NewRoleEnum getNewRole() { @JsonProperty(JSON_PROPERTY_NEW_ROLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNewRole(NewRoleEnum newRole) { + public void setNewRole(@jakarta.annotation.Nullable NewRoleEnum newRole) { this.newRole = newRole; } diff --git a/src/main/java/com/dropbox/sign/model/TeamResponse.java b/src/main/java/com/dropbox/sign/model/TeamResponse.java index 39a93c4..37128c9 100644 --- a/src/main/java/com/dropbox/sign/model/TeamResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamResponse.java @@ -41,19 +41,23 @@ TeamResponse.JSON_PROPERTY_INVITED_ACCOUNTS, TeamResponse.JSON_PROPERTY_INVITED_EMAILS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamResponse { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + @jakarta.annotation.Nullable private List accounts = null; public static final String JSON_PROPERTY_INVITED_ACCOUNTS = "invited_accounts"; + @jakarta.annotation.Nullable private List invitedAccounts = null; public static final String JSON_PROPERTY_INVITED_EMAILS = "invited_emails"; + @jakarta.annotation.Nullable private List invitedEmails = null; public TeamResponse() { @@ -74,7 +78,7 @@ static public TeamResponse init(HashMap data) throws Exception { ); } - public TeamResponse name(String name) { + public TeamResponse name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -94,12 +98,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TeamResponse accounts(List accounts) { + public TeamResponse accounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; return this; } @@ -127,12 +131,12 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { + public void setAccounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; } - public TeamResponse invitedAccounts(List invitedAccounts) { + public TeamResponse invitedAccounts(@jakarta.annotation.Nullable List invitedAccounts) { this.invitedAccounts = invitedAccounts; return this; } @@ -160,12 +164,12 @@ public List getInvitedAccounts() { @JsonProperty(JSON_PROPERTY_INVITED_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInvitedAccounts(List invitedAccounts) { + public void setInvitedAccounts(@jakarta.annotation.Nullable List invitedAccounts) { this.invitedAccounts = invitedAccounts; } - public TeamResponse invitedEmails(List invitedEmails) { + public TeamResponse invitedEmails(@jakarta.annotation.Nullable List invitedEmails) { this.invitedEmails = invitedEmails; return this; } @@ -193,7 +197,7 @@ public List getInvitedEmails() { @JsonProperty(JSON_PROPERTY_INVITED_EMAILS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setInvitedEmails(List invitedEmails) { + public void setInvitedEmails(@jakarta.annotation.Nullable List invitedEmails) { this.invitedEmails = invitedEmails; } diff --git a/src/main/java/com/dropbox/sign/model/TeamSubTeamsResponse.java b/src/main/java/com/dropbox/sign/model/TeamSubTeamsResponse.java index b8c7190..1330e7c 100644 --- a/src/main/java/com/dropbox/sign/model/TeamSubTeamsResponse.java +++ b/src/main/java/com/dropbox/sign/model/TeamSubTeamsResponse.java @@ -42,16 +42,19 @@ TeamSubTeamsResponse.JSON_PROPERTY_LIST_INFO, TeamSubTeamsResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamSubTeamsResponse { public static final String JSON_PROPERTY_SUB_TEAMS = "sub_teams"; + @jakarta.annotation.Nonnull private List subTeams = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TeamSubTeamsResponse() { @@ -72,7 +75,7 @@ static public TeamSubTeamsResponse init(HashMap data) throws Exception { ); } - public TeamSubTeamsResponse subTeams(List subTeams) { + public TeamSubTeamsResponse subTeams(@jakarta.annotation.Nonnull List subTeams) { this.subTeams = subTeams; return this; } @@ -100,12 +103,12 @@ public List getSubTeams() { @JsonProperty(JSON_PROPERTY_SUB_TEAMS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSubTeams(List subTeams) { + public void setSubTeams(@jakarta.annotation.Nonnull List subTeams) { this.subTeams = subTeams; } - public TeamSubTeamsResponse listInfo(ListInfoResponse listInfo) { + public TeamSubTeamsResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public TeamSubTeamsResponse warnings(List warnings) { + public TeamSubTeamsResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TeamUpdateRequest.java b/src/main/java/com/dropbox/sign/model/TeamUpdateRequest.java index aa668a2..100923c 100644 --- a/src/main/java/com/dropbox/sign/model/TeamUpdateRequest.java +++ b/src/main/java/com/dropbox/sign/model/TeamUpdateRequest.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ TeamUpdateRequest.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TeamUpdateRequest { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public TeamUpdateRequest() { @@ -59,7 +60,7 @@ static public TeamUpdateRequest init(HashMap data) throws Exception { ); } - public TeamUpdateRequest name(String name) { + public TeamUpdateRequest name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -79,7 +80,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateAddUserRequest.java b/src/main/java/com/dropbox/sign/model/TemplateAddUserRequest.java index dc2bf3a..71356ac 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateAddUserRequest.java +++ b/src/main/java/com/dropbox/sign/model/TemplateAddUserRequest.java @@ -37,16 +37,19 @@ TemplateAddUserRequest.JSON_PROPERTY_EMAIL_ADDRESS, TemplateAddUserRequest.JSON_PROPERTY_SKIP_NOTIFICATION }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateAddUserRequest { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_SKIP_NOTIFICATION = "skip_notification"; + @jakarta.annotation.Nullable private Boolean skipNotification = false; public TemplateAddUserRequest() { @@ -67,7 +70,7 @@ static public TemplateAddUserRequest init(HashMap data) throws Exception { ); } - public TemplateAddUserRequest accountId(String accountId) { + public TemplateAddUserRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -87,12 +90,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TemplateAddUserRequest emailAddress(String emailAddress) { + public TemplateAddUserRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -112,12 +115,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TemplateAddUserRequest skipNotification(Boolean skipNotification) { + public TemplateAddUserRequest skipNotification(@jakarta.annotation.Nullable Boolean skipNotification) { this.skipNotification = skipNotification; return this; } @@ -137,7 +140,7 @@ public Boolean getSkipNotification() { @JsonProperty(JSON_PROPERTY_SKIP_NOTIFICATION) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSkipNotification(Boolean skipNotification) { + public void setSkipNotification(@jakarta.annotation.Nullable Boolean skipNotification) { this.skipNotification = skipNotification; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java index 8c6b2ba..d7786da 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftRequest.java @@ -72,82 +72,107 @@ TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_TITLE, TemplateCreateEmbeddedDraftRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateEmbeddedDraftRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_ALLOW_CCS = "allow_ccs"; + @jakarta.annotation.Nullable private Boolean allowCcs = true; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + @jakarta.annotation.Nullable private List ccRoles = null; public static final String JSON_PROPERTY_EDITOR_OPTIONS = "editor_options"; + @jakarta.annotation.Nullable private SubEditorOptions editorOptions; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORCE_SIGNER_ROLES = "force_signer_roles"; + @jakarta.annotation.Nullable private Boolean forceSignerRoles = false; public static final String JSON_PROPERTY_FORCE_SUBJECT_MESSAGE = "force_subject_message"; + @jakarta.annotation.Nullable private Boolean forceSubjectMessage = false; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable private List formFieldsPerDocument = null; public static final String JSON_PROPERTY_MERGE_FIELDS = "merge_fields"; + @jakarta.annotation.Nullable private List mergeFields = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SHOW_PREVIEW = "show_preview"; + @jakarta.annotation.Nullable private Boolean showPreview = false; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; + @jakarta.annotation.Nullable private List signerRoles = null; public static final String JSON_PROPERTY_SKIP_ME_NOW = "skip_me_now"; + @jakarta.annotation.Nullable private Boolean skipMeNow = false; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; + @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; public TemplateCreateEmbeddedDraftRequest() { @@ -168,7 +193,7 @@ static public TemplateCreateEmbeddedDraftRequest init(HashMap data) throws Excep ); } - public TemplateCreateEmbeddedDraftRequest clientId(String clientId) { + public TemplateCreateEmbeddedDraftRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -188,12 +213,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public TemplateCreateEmbeddedDraftRequest files(List files) { + public TemplateCreateEmbeddedDraftRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -221,12 +246,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public TemplateCreateEmbeddedDraftRequest fileUrls(List fileUrls) { + public TemplateCreateEmbeddedDraftRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -254,12 +279,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public TemplateCreateEmbeddedDraftRequest allowCcs(Boolean allowCcs) { + public TemplateCreateEmbeddedDraftRequest allowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; return this; } @@ -279,12 +304,12 @@ public Boolean getAllowCcs() { @JsonProperty(JSON_PROPERTY_ALLOW_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowCcs(Boolean allowCcs) { + public void setAllowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; } - public TemplateCreateEmbeddedDraftRequest allowReassign(Boolean allowReassign) { + public TemplateCreateEmbeddedDraftRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -304,12 +329,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public TemplateCreateEmbeddedDraftRequest attachments(List attachments) { + public TemplateCreateEmbeddedDraftRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -337,12 +362,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public TemplateCreateEmbeddedDraftRequest ccRoles(List ccRoles) { + public TemplateCreateEmbeddedDraftRequest ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; } @@ -370,12 +395,12 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { + public void setCcRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; } - public TemplateCreateEmbeddedDraftRequest editorOptions(SubEditorOptions editorOptions) { + public TemplateCreateEmbeddedDraftRequest editorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; return this; } @@ -395,12 +420,12 @@ public SubEditorOptions getEditorOptions() { @JsonProperty(JSON_PROPERTY_EDITOR_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditorOptions(SubEditorOptions editorOptions) { + public void setEditorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; } - public TemplateCreateEmbeddedDraftRequest fieldOptions(SubFieldOptions fieldOptions) { + public TemplateCreateEmbeddedDraftRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -420,12 +445,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public TemplateCreateEmbeddedDraftRequest forceSignerRoles(Boolean forceSignerRoles) { + public TemplateCreateEmbeddedDraftRequest forceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; return this; } @@ -445,12 +470,12 @@ public Boolean getForceSignerRoles() { @JsonProperty(JSON_PROPERTY_FORCE_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSignerRoles(Boolean forceSignerRoles) { + public void setForceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; } - public TemplateCreateEmbeddedDraftRequest forceSubjectMessage(Boolean forceSubjectMessage) { + public TemplateCreateEmbeddedDraftRequest forceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; return this; } @@ -470,12 +495,12 @@ public Boolean getForceSubjectMessage() { @JsonProperty(JSON_PROPERTY_FORCE_SUBJECT_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSubjectMessage(Boolean forceSubjectMessage) { + public void setForceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; } - public TemplateCreateEmbeddedDraftRequest formFieldGroups(List formFieldGroups) { + public TemplateCreateEmbeddedDraftRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -503,12 +528,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public TemplateCreateEmbeddedDraftRequest formFieldRules(List formFieldRules) { + public TemplateCreateEmbeddedDraftRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -536,12 +561,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public TemplateCreateEmbeddedDraftRequest formFieldsPerDocument(List formFieldsPerDocument) { + public TemplateCreateEmbeddedDraftRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -569,12 +594,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public TemplateCreateEmbeddedDraftRequest mergeFields(List mergeFields) { + public TemplateCreateEmbeddedDraftRequest mergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; return this; } @@ -602,12 +627,12 @@ public List getMergeFields() { @JsonProperty(JSON_PROPERTY_MERGE_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMergeFields(List mergeFields) { + public void setMergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; } - public TemplateCreateEmbeddedDraftRequest message(String message) { + public TemplateCreateEmbeddedDraftRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -627,12 +652,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public TemplateCreateEmbeddedDraftRequest metadata(Map metadata) { + public TemplateCreateEmbeddedDraftRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -660,12 +685,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public TemplateCreateEmbeddedDraftRequest showPreview(Boolean showPreview) { + public TemplateCreateEmbeddedDraftRequest showPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; return this; } @@ -685,12 +710,12 @@ public Boolean getShowPreview() { @JsonProperty(JSON_PROPERTY_SHOW_PREVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowPreview(Boolean showPreview) { + public void setShowPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; } - public TemplateCreateEmbeddedDraftRequest showProgressStepper(Boolean showProgressStepper) { + public TemplateCreateEmbeddedDraftRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -710,12 +735,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public TemplateCreateEmbeddedDraftRequest signerRoles(List signerRoles) { + public TemplateCreateEmbeddedDraftRequest signerRoles(@jakarta.annotation.Nullable List signerRoles) { this.signerRoles = signerRoles; return this; } @@ -743,12 +768,12 @@ public List getSignerRoles() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerRoles(List signerRoles) { + public void setSignerRoles(@jakarta.annotation.Nullable List signerRoles) { this.signerRoles = signerRoles; } - public TemplateCreateEmbeddedDraftRequest skipMeNow(Boolean skipMeNow) { + public TemplateCreateEmbeddedDraftRequest skipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; return this; } @@ -768,12 +793,12 @@ public Boolean getSkipMeNow() { @JsonProperty(JSON_PROPERTY_SKIP_ME_NOW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSkipMeNow(Boolean skipMeNow) { + public void setSkipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; } - public TemplateCreateEmbeddedDraftRequest subject(String subject) { + public TemplateCreateEmbeddedDraftRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -793,12 +818,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public TemplateCreateEmbeddedDraftRequest testMode(Boolean testMode) { + public TemplateCreateEmbeddedDraftRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -818,12 +843,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public TemplateCreateEmbeddedDraftRequest title(String title) { + public TemplateCreateEmbeddedDraftRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -843,12 +868,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public TemplateCreateEmbeddedDraftRequest usePreexistingFields(Boolean usePreexistingFields) { + public TemplateCreateEmbeddedDraftRequest usePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; return this; } @@ -868,7 +893,7 @@ public Boolean getUsePreexistingFields() { @JsonProperty(JSON_PROPERTY_USE_PREEXISTING_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsePreexistingFields(Boolean usePreexistingFields) { + public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java index e3e7300..3a1c18a 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponse.java @@ -40,13 +40,15 @@ TemplateCreateEmbeddedDraftResponse.JSON_PROPERTY_TEMPLATE, TemplateCreateEmbeddedDraftResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateEmbeddedDraftResponse { public static final String JSON_PROPERTY_TEMPLATE = "template"; + @jakarta.annotation.Nonnull private TemplateCreateEmbeddedDraftResponseTemplate template; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TemplateCreateEmbeddedDraftResponse() { @@ -67,7 +69,7 @@ static public TemplateCreateEmbeddedDraftResponse init(HashMap data) throws Exce ); } - public TemplateCreateEmbeddedDraftResponse template(TemplateCreateEmbeddedDraftResponseTemplate template) { + public TemplateCreateEmbeddedDraftResponse template(@jakarta.annotation.Nonnull TemplateCreateEmbeddedDraftResponseTemplate template) { this.template = template; return this; } @@ -87,12 +89,12 @@ public TemplateCreateEmbeddedDraftResponseTemplate getTemplate() { @JsonProperty(JSON_PROPERTY_TEMPLATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplate(TemplateCreateEmbeddedDraftResponseTemplate template) { + public void setTemplate(@jakarta.annotation.Nonnull TemplateCreateEmbeddedDraftResponseTemplate template) { this.template = template; } - public TemplateCreateEmbeddedDraftResponse warnings(List warnings) { + public TemplateCreateEmbeddedDraftResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java index f9c0286..d40592d 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateEmbeddedDraftResponseTemplate.java @@ -41,20 +41,24 @@ TemplateCreateEmbeddedDraftResponseTemplate.JSON_PROPERTY_EXPIRES_AT, TemplateCreateEmbeddedDraftResponseTemplate.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateEmbeddedDraftResponseTemplate { public static final String JSON_PROPERTY_TEMPLATE_ID = "template_id"; + @jakarta.annotation.Nullable private String templateId; public static final String JSON_PROPERTY_EDIT_URL = "edit_url"; + @jakarta.annotation.Nullable private String editUrl; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public static final String JSON_PROPERTY_WARNINGS = "warnings"; @Deprecated + @jakarta.annotation.Nullable private List warnings = null; public TemplateCreateEmbeddedDraftResponseTemplate() { @@ -75,7 +79,7 @@ static public TemplateCreateEmbeddedDraftResponseTemplate init(HashMap data) thr ); } - public TemplateCreateEmbeddedDraftResponseTemplate templateId(String templateId) { + public TemplateCreateEmbeddedDraftResponseTemplate templateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; return this; } @@ -95,12 +99,12 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateId(String templateId) { + public void setTemplateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; } - public TemplateCreateEmbeddedDraftResponseTemplate editUrl(String editUrl) { + public TemplateCreateEmbeddedDraftResponseTemplate editUrl(@jakarta.annotation.Nullable String editUrl) { this.editUrl = editUrl; return this; } @@ -120,12 +124,12 @@ public String getEditUrl() { @JsonProperty(JSON_PROPERTY_EDIT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditUrl(String editUrl) { + public void setEditUrl(@jakarta.annotation.Nullable String editUrl) { this.editUrl = editUrl; } - public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(Integer expiresAt) { + public TemplateCreateEmbeddedDraftResponseTemplate expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -145,13 +149,13 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } @Deprecated - public TemplateCreateEmbeddedDraftResponseTemplate warnings(List warnings) { + public TemplateCreateEmbeddedDraftResponseTemplate warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -182,7 +186,7 @@ public List getWarnings() { @Deprecated @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java b/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java index b1ff55f..2a353e0 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateRequest.java @@ -64,61 +64,79 @@ TemplateCreateRequest.JSON_PROPERTY_TITLE, TemplateCreateRequest.JSON_PROPERTY_USE_PREEXISTING_FIELDS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateRequest { 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_SIGNER_ROLES = "signer_roles"; + @jakarta.annotation.Nonnull private List signerRoles = new ArrayList<>(); public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + @jakarta.annotation.Nullable private List ccRoles = null; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_MERGE_FIELDS = "merge_fields"; + @jakarta.annotation.Nullable private List mergeFields = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; + @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; public TemplateCreateRequest() { @@ -139,7 +157,7 @@ static public TemplateCreateRequest init(HashMap data) throws Exception { ); } - public TemplateCreateRequest formFieldsPerDocument(List formFieldsPerDocument) { + public TemplateCreateRequest formFieldsPerDocument(@jakarta.annotation.Nonnull List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -167,12 +185,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nonnull List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public TemplateCreateRequest signerRoles(List signerRoles) { + public TemplateCreateRequest signerRoles(@jakarta.annotation.Nonnull List signerRoles) { this.signerRoles = signerRoles; return this; } @@ -200,12 +218,12 @@ public List getSignerRoles() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setSignerRoles(List signerRoles) { + public void setSignerRoles(@jakarta.annotation.Nonnull List signerRoles) { this.signerRoles = signerRoles; } - public TemplateCreateRequest files(List files) { + public TemplateCreateRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -233,12 +251,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public TemplateCreateRequest fileUrls(List fileUrls) { + public TemplateCreateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -266,12 +284,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public TemplateCreateRequest allowReassign(Boolean allowReassign) { + public TemplateCreateRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -291,12 +309,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public TemplateCreateRequest attachments(List attachments) { + public TemplateCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -324,12 +342,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public TemplateCreateRequest ccRoles(List ccRoles) { + public TemplateCreateRequest ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; } @@ -357,12 +375,12 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { + public void setCcRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; } - public TemplateCreateRequest clientId(String clientId) { + public TemplateCreateRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -382,12 +400,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public TemplateCreateRequest fieldOptions(SubFieldOptions fieldOptions) { + public TemplateCreateRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -407,12 +425,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public TemplateCreateRequest formFieldGroups(List formFieldGroups) { + public TemplateCreateRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -440,12 +458,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public TemplateCreateRequest formFieldRules(List formFieldRules) { + public TemplateCreateRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -473,12 +491,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public TemplateCreateRequest mergeFields(List mergeFields) { + public TemplateCreateRequest mergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; return this; } @@ -506,12 +524,12 @@ public List getMergeFields() { @JsonProperty(JSON_PROPERTY_MERGE_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMergeFields(List mergeFields) { + public void setMergeFields(@jakarta.annotation.Nullable List mergeFields) { this.mergeFields = mergeFields; } - public TemplateCreateRequest message(String message) { + public TemplateCreateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -531,12 +549,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public TemplateCreateRequest metadata(Map metadata) { + public TemplateCreateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -564,12 +582,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public TemplateCreateRequest subject(String subject) { + public TemplateCreateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -589,12 +607,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public TemplateCreateRequest testMode(Boolean testMode) { + public TemplateCreateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -614,12 +632,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public TemplateCreateRequest title(String title) { + public TemplateCreateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -639,12 +657,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public TemplateCreateRequest usePreexistingFields(Boolean usePreexistingFields) { + public TemplateCreateRequest usePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; return this; } @@ -664,7 +682,7 @@ public Boolean getUsePreexistingFields() { @JsonProperty(JSON_PROPERTY_USE_PREEXISTING_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsePreexistingFields(Boolean usePreexistingFields) { + public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java b/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java index 5d7d2c2..0391002 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateResponse.java @@ -40,13 +40,15 @@ TemplateCreateResponse.JSON_PROPERTY_TEMPLATE, TemplateCreateResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateResponse { public static final String JSON_PROPERTY_TEMPLATE = "template"; + @jakarta.annotation.Nonnull private TemplateCreateResponseTemplate template; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TemplateCreateResponse() { @@ -67,7 +69,7 @@ static public TemplateCreateResponse init(HashMap data) throws Exception { ); } - public TemplateCreateResponse template(TemplateCreateResponseTemplate template) { + public TemplateCreateResponse template(@jakarta.annotation.Nonnull TemplateCreateResponseTemplate template) { this.template = template; return this; } @@ -87,12 +89,12 @@ public TemplateCreateResponseTemplate getTemplate() { @JsonProperty(JSON_PROPERTY_TEMPLATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplate(TemplateCreateResponseTemplate template) { + public void setTemplate(@jakarta.annotation.Nonnull TemplateCreateResponseTemplate template) { this.template = template; } - public TemplateCreateResponse warnings(List warnings) { + public TemplateCreateResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java b/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java index 6d668fd..2222fc7 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java +++ b/src/main/java/com/dropbox/sign/model/TemplateCreateResponseTemplate.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ TemplateCreateResponseTemplate.JSON_PROPERTY_TEMPLATE_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateCreateResponseTemplate { public static final String JSON_PROPERTY_TEMPLATE_ID = "template_id"; + @jakarta.annotation.Nullable private String templateId; public TemplateCreateResponseTemplate() { @@ -59,7 +60,7 @@ static public TemplateCreateResponseTemplate init(HashMap data) throws Exception ); } - public TemplateCreateResponseTemplate templateId(String templateId) { + public TemplateCreateResponseTemplate templateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; return this; } @@ -79,7 +80,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateId(String templateId) { + public void setTemplateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java b/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java index f660ab2..866a87f 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateEditResponse.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ TemplateEditResponse.JSON_PROPERTY_TEMPLATE_ID }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateEditResponse { public static final String JSON_PROPERTY_TEMPLATE_ID = "template_id"; + @jakarta.annotation.Nonnull private String templateId; public TemplateEditResponse() { @@ -59,7 +60,7 @@ static public TemplateEditResponse init(HashMap data) throws Exception { ); } - public TemplateEditResponse templateId(String templateId) { + public TemplateEditResponse templateId(@jakarta.annotation.Nonnull String templateId) { this.templateId = templateId; return this; } @@ -79,7 +80,7 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateId(String templateId) { + public void setTemplateId(@jakarta.annotation.Nonnull String templateId) { this.templateId = templateId; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java b/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java index 30a55e8..248ae9f 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateGetResponse.java @@ -40,13 +40,15 @@ TemplateGetResponse.JSON_PROPERTY_TEMPLATE, TemplateGetResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateGetResponse { public static final String JSON_PROPERTY_TEMPLATE = "template"; + @jakarta.annotation.Nonnull private TemplateResponse template; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TemplateGetResponse() { @@ -67,7 +69,7 @@ static public TemplateGetResponse init(HashMap data) throws Exception { ); } - public TemplateGetResponse template(TemplateResponse template) { + public TemplateGetResponse template(@jakarta.annotation.Nonnull TemplateResponse template) { this.template = template; return this; } @@ -87,12 +89,12 @@ public TemplateResponse getTemplate() { @JsonProperty(JSON_PROPERTY_TEMPLATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplate(TemplateResponse template) { + public void setTemplate(@jakarta.annotation.Nonnull TemplateResponse template) { this.template = template; } - public TemplateGetResponse warnings(List warnings) { + public TemplateGetResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateListResponse.java b/src/main/java/com/dropbox/sign/model/TemplateListResponse.java index d3949c6..4569dba 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateListResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateListResponse.java @@ -42,16 +42,19 @@ TemplateListResponse.JSON_PROPERTY_LIST_INFO, TemplateListResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateListResponse { public static final String JSON_PROPERTY_TEMPLATES = "templates"; + @jakarta.annotation.Nonnull private List templates = new ArrayList<>(); public static final String JSON_PROPERTY_LIST_INFO = "list_info"; + @jakarta.annotation.Nonnull private ListInfoResponse listInfo; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public TemplateListResponse() { @@ -72,7 +75,7 @@ static public TemplateListResponse init(HashMap data) throws Exception { ); } - public TemplateListResponse templates(List templates) { + public TemplateListResponse templates(@jakarta.annotation.Nonnull List templates) { this.templates = templates; return this; } @@ -100,12 +103,12 @@ public List getTemplates() { @JsonProperty(JSON_PROPERTY_TEMPLATES) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplates(List templates) { + public void setTemplates(@jakarta.annotation.Nonnull List templates) { this.templates = templates; } - public TemplateListResponse listInfo(ListInfoResponse listInfo) { + public TemplateListResponse listInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; return this; } @@ -125,12 +128,12 @@ public ListInfoResponse getListInfo() { @JsonProperty(JSON_PROPERTY_LIST_INFO) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setListInfo(ListInfoResponse listInfo) { + public void setListInfo(@jakarta.annotation.Nonnull ListInfoResponse listInfo) { this.listInfo = listInfo; } - public TemplateListResponse warnings(List warnings) { + public TemplateListResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -158,7 +161,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateRemoveUserRequest.java b/src/main/java/com/dropbox/sign/model/TemplateRemoveUserRequest.java index 0d9c88e..bce53ad 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateRemoveUserRequest.java +++ b/src/main/java/com/dropbox/sign/model/TemplateRemoveUserRequest.java @@ -36,13 +36,15 @@ TemplateRemoveUserRequest.JSON_PROPERTY_ACCOUNT_ID, TemplateRemoveUserRequest.JSON_PROPERTY_EMAIL_ADDRESS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateRemoveUserRequest { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public TemplateRemoveUserRequest() { @@ -63,7 +65,7 @@ static public TemplateRemoveUserRequest init(HashMap data) throws Exception { ); } - public TemplateRemoveUserRequest accountId(String accountId) { + public TemplateRemoveUserRequest accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -83,12 +85,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TemplateRemoveUserRequest emailAddress(String emailAddress) { + public TemplateRemoveUserRequest emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -108,7 +110,7 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponse.java b/src/main/java/com/dropbox/sign/model/TemplateResponse.java index f031a03..1796c99 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponse.java @@ -61,57 +61,73 @@ TemplateResponse.JSON_PROPERTY_ACCOUNTS, TemplateResponse.JSON_PROPERTY_ATTACHMENTS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponse { public static final String JSON_PROPERTY_TEMPLATE_ID = "template_id"; + @jakarta.annotation.Nullable private String templateId; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_UPDATED_AT = "updated_at"; + @jakarta.annotation.Nullable private Integer updatedAt; public static final String JSON_PROPERTY_IS_EMBEDDED = "is_embedded"; + @jakarta.annotation.Nullable private Boolean isEmbedded; public static final String JSON_PROPERTY_IS_CREATOR = "is_creator"; + @jakarta.annotation.Nullable private Boolean isCreator; public static final String JSON_PROPERTY_CAN_EDIT = "can_edit"; + @jakarta.annotation.Nullable private Boolean canEdit; public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; + @jakarta.annotation.Nullable private Boolean isLocked; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SIGNER_ROLES = "signer_roles"; + @jakarta.annotation.Nullable private List signerRoles = null; public static final String JSON_PROPERTY_CC_ROLES = "cc_roles"; + @jakarta.annotation.Nullable private List ccRoles = null; public static final String JSON_PROPERTY_DOCUMENTS = "documents"; + @jakarta.annotation.Nullable private List documents = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; @Deprecated + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_NAMED_FORM_FIELDS = "named_form_fields"; @Deprecated + @jakarta.annotation.Nullable private List namedFormFields = null; public static final String JSON_PROPERTY_ACCOUNTS = "accounts"; + @jakarta.annotation.Nullable private List accounts = null; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public TemplateResponse() { @@ -132,7 +148,7 @@ static public TemplateResponse init(HashMap data) throws Exception { ); } - public TemplateResponse templateId(String templateId) { + public TemplateResponse templateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; return this; } @@ -152,12 +168,12 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateId(String templateId) { + public void setTemplateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; } - public TemplateResponse title(String title) { + public TemplateResponse title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -177,12 +193,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public TemplateResponse message(String message) { + public TemplateResponse message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -202,12 +218,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public TemplateResponse updatedAt(Integer updatedAt) { + public TemplateResponse updatedAt(@jakarta.annotation.Nullable Integer updatedAt) { this.updatedAt = updatedAt; return this; } @@ -227,12 +243,12 @@ public Integer getUpdatedAt() { @JsonProperty(JSON_PROPERTY_UPDATED_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUpdatedAt(Integer updatedAt) { + public void setUpdatedAt(@jakarta.annotation.Nullable Integer updatedAt) { this.updatedAt = updatedAt; } - public TemplateResponse isEmbedded(Boolean isEmbedded) { + public TemplateResponse isEmbedded(@jakarta.annotation.Nullable Boolean isEmbedded) { this.isEmbedded = isEmbedded; return this; } @@ -252,12 +268,12 @@ public Boolean getIsEmbedded() { @JsonProperty(JSON_PROPERTY_IS_EMBEDDED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsEmbedded(Boolean isEmbedded) { + public void setIsEmbedded(@jakarta.annotation.Nullable Boolean isEmbedded) { this.isEmbedded = isEmbedded; } - public TemplateResponse isCreator(Boolean isCreator) { + public TemplateResponse isCreator(@jakarta.annotation.Nullable Boolean isCreator) { this.isCreator = isCreator; return this; } @@ -277,12 +293,12 @@ public Boolean getIsCreator() { @JsonProperty(JSON_PROPERTY_IS_CREATOR) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsCreator(Boolean isCreator) { + public void setIsCreator(@jakarta.annotation.Nullable Boolean isCreator) { this.isCreator = isCreator; } - public TemplateResponse canEdit(Boolean canEdit) { + public TemplateResponse canEdit(@jakarta.annotation.Nullable Boolean canEdit) { this.canEdit = canEdit; return this; } @@ -302,12 +318,12 @@ public Boolean getCanEdit() { @JsonProperty(JSON_PROPERTY_CAN_EDIT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCanEdit(Boolean canEdit) { + public void setCanEdit(@jakarta.annotation.Nullable Boolean canEdit) { this.canEdit = canEdit; } - public TemplateResponse isLocked(Boolean isLocked) { + public TemplateResponse isLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; return this; } @@ -327,12 +343,12 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsLocked(Boolean isLocked) { + public void setIsLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; } - public TemplateResponse metadata(Map metadata) { + public TemplateResponse metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -360,12 +376,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public TemplateResponse signerRoles(List signerRoles) { + public TemplateResponse signerRoles(@jakarta.annotation.Nullable List signerRoles) { this.signerRoles = signerRoles; return this; } @@ -393,12 +409,12 @@ public List getSignerRoles() { @JsonProperty(JSON_PROPERTY_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignerRoles(List signerRoles) { + public void setSignerRoles(@jakarta.annotation.Nullable List signerRoles) { this.signerRoles = signerRoles; } - public TemplateResponse ccRoles(List ccRoles) { + public TemplateResponse ccRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; return this; } @@ -426,12 +442,12 @@ public List getCcRoles() { @JsonProperty(JSON_PROPERTY_CC_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcRoles(List ccRoles) { + public void setCcRoles(@jakarta.annotation.Nullable List ccRoles) { this.ccRoles = ccRoles; } - public TemplateResponse documents(List documents) { + public TemplateResponse documents(@jakarta.annotation.Nullable List documents) { this.documents = documents; return this; } @@ -459,13 +475,13 @@ public List getDocuments() { @JsonProperty(JSON_PROPERTY_DOCUMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDocuments(List documents) { + public void setDocuments(@jakarta.annotation.Nullable List documents) { this.documents = documents; } @Deprecated - public TemplateResponse customFields(List customFields) { + public TemplateResponse customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -496,13 +512,13 @@ public List getCustomFields() { @Deprecated @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } @Deprecated - public TemplateResponse namedFormFields(List namedFormFields) { + public TemplateResponse namedFormFields(@jakarta.annotation.Nullable List namedFormFields) { this.namedFormFields = namedFormFields; return this; } @@ -533,12 +549,12 @@ public List getNamedFormFields() { @Deprecated @JsonProperty(JSON_PROPERTY_NAMED_FORM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNamedFormFields(List namedFormFields) { + public void setNamedFormFields(@jakarta.annotation.Nullable List namedFormFields) { this.namedFormFields = namedFormFields; } - public TemplateResponse accounts(List accounts) { + public TemplateResponse accounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; return this; } @@ -566,12 +582,12 @@ public List getAccounts() { @JsonProperty(JSON_PROPERTY_ACCOUNTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccounts(List accounts) { + public void setAccounts(@jakarta.annotation.Nullable List accounts) { this.accounts = accounts; } - public TemplateResponse attachments(List attachments) { + public TemplateResponse attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -599,7 +615,7 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java b/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java index 53f50dd..0e9d517 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseAccount.java @@ -41,25 +41,31 @@ TemplateResponseAccount.JSON_PROPERTY_IS_PAID_HF, TemplateResponseAccount.JSON_PROPERTY_QUOTAS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseAccount { public static final String JSON_PROPERTY_ACCOUNT_ID = "account_id"; + @jakarta.annotation.Nullable private String accountId; public static final String JSON_PROPERTY_EMAIL_ADDRESS = "email_address"; + @jakarta.annotation.Nullable private String emailAddress; public static final String JSON_PROPERTY_IS_LOCKED = "is_locked"; + @jakarta.annotation.Nullable private Boolean isLocked; public static final String JSON_PROPERTY_IS_PAID_HS = "is_paid_hs"; + @jakarta.annotation.Nullable private Boolean isPaidHs; public static final String JSON_PROPERTY_IS_PAID_HF = "is_paid_hf"; + @jakarta.annotation.Nullable private Boolean isPaidHf; public static final String JSON_PROPERTY_QUOTAS = "quotas"; + @jakarta.annotation.Nullable private TemplateResponseAccountQuota quotas; public TemplateResponseAccount() { @@ -80,7 +86,7 @@ static public TemplateResponseAccount init(HashMap data) throws Exception { ); } - public TemplateResponseAccount accountId(String accountId) { + public TemplateResponseAccount accountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; return this; } @@ -100,12 +106,12 @@ public String getAccountId() { @JsonProperty(JSON_PROPERTY_ACCOUNT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAccountId(String accountId) { + public void setAccountId(@jakarta.annotation.Nullable String accountId) { this.accountId = accountId; } - public TemplateResponseAccount emailAddress(String emailAddress) { + public TemplateResponseAccount emailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; return this; } @@ -125,12 +131,12 @@ public String getEmailAddress() { @JsonProperty(JSON_PROPERTY_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEmailAddress(String emailAddress) { + public void setEmailAddress(@jakarta.annotation.Nullable String emailAddress) { this.emailAddress = emailAddress; } - public TemplateResponseAccount isLocked(Boolean isLocked) { + public TemplateResponseAccount isLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; return this; } @@ -150,12 +156,12 @@ public Boolean getIsLocked() { @JsonProperty(JSON_PROPERTY_IS_LOCKED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsLocked(Boolean isLocked) { + public void setIsLocked(@jakarta.annotation.Nullable Boolean isLocked) { this.isLocked = isLocked; } - public TemplateResponseAccount isPaidHs(Boolean isPaidHs) { + public TemplateResponseAccount isPaidHs(@jakarta.annotation.Nullable Boolean isPaidHs) { this.isPaidHs = isPaidHs; return this; } @@ -175,12 +181,12 @@ public Boolean getIsPaidHs() { @JsonProperty(JSON_PROPERTY_IS_PAID_HS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsPaidHs(Boolean isPaidHs) { + public void setIsPaidHs(@jakarta.annotation.Nullable Boolean isPaidHs) { this.isPaidHs = isPaidHs; } - public TemplateResponseAccount isPaidHf(Boolean isPaidHf) { + public TemplateResponseAccount isPaidHf(@jakarta.annotation.Nullable Boolean isPaidHf) { this.isPaidHf = isPaidHf; return this; } @@ -200,12 +206,12 @@ public Boolean getIsPaidHf() { @JsonProperty(JSON_PROPERTY_IS_PAID_HF) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsPaidHf(Boolean isPaidHf) { + public void setIsPaidHf(@jakarta.annotation.Nullable Boolean isPaidHf) { this.isPaidHf = isPaidHf; } - public TemplateResponseAccount quotas(TemplateResponseAccountQuota quotas) { + public TemplateResponseAccount quotas(@jakarta.annotation.Nullable TemplateResponseAccountQuota quotas) { this.quotas = quotas; return this; } @@ -225,7 +231,7 @@ public TemplateResponseAccountQuota getQuotas() { @JsonProperty(JSON_PROPERTY_QUOTAS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setQuotas(TemplateResponseAccountQuota quotas) { + public void setQuotas(@jakarta.annotation.Nullable TemplateResponseAccountQuota quotas) { this.quotas = quotas; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java b/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java index 78b1f58..8c0615b 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseAccountQuota.java @@ -38,19 +38,23 @@ TemplateResponseAccountQuota.JSON_PROPERTY_DOCUMENTS_LEFT, TemplateResponseAccountQuota.JSON_PROPERTY_SMS_VERIFICATIONS_LEFT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseAccountQuota { public static final String JSON_PROPERTY_TEMPLATES_LEFT = "templates_left"; + @jakarta.annotation.Nullable private Integer templatesLeft; public static final String JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT = "api_signature_requests_left"; + @jakarta.annotation.Nullable private Integer apiSignatureRequestsLeft; public static final String JSON_PROPERTY_DOCUMENTS_LEFT = "documents_left"; + @jakarta.annotation.Nullable private Integer documentsLeft; public static final String JSON_PROPERTY_SMS_VERIFICATIONS_LEFT = "sms_verifications_left"; + @jakarta.annotation.Nullable private Integer smsVerificationsLeft; public TemplateResponseAccountQuota() { @@ -71,7 +75,7 @@ static public TemplateResponseAccountQuota init(HashMap data) throws Exception { ); } - public TemplateResponseAccountQuota templatesLeft(Integer templatesLeft) { + public TemplateResponseAccountQuota templatesLeft(@jakarta.annotation.Nullable Integer templatesLeft) { this.templatesLeft = templatesLeft; return this; } @@ -91,12 +95,12 @@ public Integer getTemplatesLeft() { @JsonProperty(JSON_PROPERTY_TEMPLATES_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplatesLeft(Integer templatesLeft) { + public void setTemplatesLeft(@jakarta.annotation.Nullable Integer templatesLeft) { this.templatesLeft = templatesLeft; } - public TemplateResponseAccountQuota apiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { + public TemplateResponseAccountQuota apiSignatureRequestsLeft(@jakarta.annotation.Nullable Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; return this; } @@ -116,12 +120,12 @@ public Integer getApiSignatureRequestsLeft() { @JsonProperty(JSON_PROPERTY_API_SIGNATURE_REQUESTS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiSignatureRequestsLeft(Integer apiSignatureRequestsLeft) { + public void setApiSignatureRequestsLeft(@jakarta.annotation.Nullable Integer apiSignatureRequestsLeft) { this.apiSignatureRequestsLeft = apiSignatureRequestsLeft; } - public TemplateResponseAccountQuota documentsLeft(Integer documentsLeft) { + public TemplateResponseAccountQuota documentsLeft(@jakarta.annotation.Nullable Integer documentsLeft) { this.documentsLeft = documentsLeft; return this; } @@ -141,12 +145,12 @@ public Integer getDocumentsLeft() { @JsonProperty(JSON_PROPERTY_DOCUMENTS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDocumentsLeft(Integer documentsLeft) { + public void setDocumentsLeft(@jakarta.annotation.Nullable Integer documentsLeft) { this.documentsLeft = documentsLeft; } - public TemplateResponseAccountQuota smsVerificationsLeft(Integer smsVerificationsLeft) { + public TemplateResponseAccountQuota smsVerificationsLeft(@jakarta.annotation.Nullable Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; return this; } @@ -166,7 +170,7 @@ public Integer getSmsVerificationsLeft() { @JsonProperty(JSON_PROPERTY_SMS_VERIFICATIONS_LEFT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSmsVerificationsLeft(Integer smsVerificationsLeft) { + public void setSmsVerificationsLeft(@jakarta.annotation.Nullable Integer smsVerificationsLeft) { this.smsVerificationsLeft = smsVerificationsLeft; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java b/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java index 4ed3eb9..9c25e52 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseCCRole.java @@ -35,10 +35,11 @@ @JsonPropertyOrder({ TemplateResponseCCRole.JSON_PROPERTY_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseCCRole { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public TemplateResponseCCRole() { @@ -59,7 +60,7 @@ static public TemplateResponseCCRole init(HashMap data) throws Exception { ); } - public TemplateResponseCCRole name(String name) { + public TemplateResponseCCRole name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -79,7 +80,7 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java index 040c68c..2ea3ac1 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocument.java @@ -46,25 +46,31 @@ TemplateResponseDocument.JSON_PROPERTY_CUSTOM_FIELDS, TemplateResponseDocument.JSON_PROPERTY_STATIC_FIELDS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseDocument { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_INDEX = "index"; + @jakarta.annotation.Nullable private Integer index; public static final String JSON_PROPERTY_FIELD_GROUPS = "field_groups"; + @jakarta.annotation.Nullable private List fieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELDS = "form_fields"; + @jakarta.annotation.Nullable private List formFields = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_STATIC_FIELDS = "static_fields"; + @jakarta.annotation.Nullable private List staticFields = null; public TemplateResponseDocument() { @@ -85,7 +91,7 @@ static public TemplateResponseDocument init(HashMap data) throws Exception { ); } - public TemplateResponseDocument name(String name) { + public TemplateResponseDocument name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -105,12 +111,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseDocument index(Integer index) { + public TemplateResponseDocument index(@jakarta.annotation.Nullable Integer index) { this.index = index; return this; } @@ -130,12 +136,12 @@ public Integer getIndex() { @JsonProperty(JSON_PROPERTY_INDEX) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIndex(Integer index) { + public void setIndex(@jakarta.annotation.Nullable Integer index) { this.index = index; } - public TemplateResponseDocument fieldGroups(List fieldGroups) { + public TemplateResponseDocument fieldGroups(@jakarta.annotation.Nullable List fieldGroups) { this.fieldGroups = fieldGroups; return this; } @@ -163,12 +169,12 @@ public List getFieldGroups() { @JsonProperty(JSON_PROPERTY_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldGroups(List fieldGroups) { + public void setFieldGroups(@jakarta.annotation.Nullable List fieldGroups) { this.fieldGroups = fieldGroups; } - public TemplateResponseDocument formFields(List formFields) { + public TemplateResponseDocument formFields(@jakarta.annotation.Nullable List formFields) { this.formFields = formFields; return this; } @@ -196,12 +202,12 @@ public List getFormFields() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFields(List formFields) { + public void setFormFields(@jakarta.annotation.Nullable List formFields) { this.formFields = formFields; } - public TemplateResponseDocument customFields(List customFields) { + public TemplateResponseDocument customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -229,12 +235,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public TemplateResponseDocument staticFields(List staticFields) { + public TemplateResponseDocument staticFields(@jakarta.annotation.Nullable List staticFields) { this.staticFields = staticFields; return this; } @@ -262,7 +268,7 @@ public List getStaticFields() { @JsonProperty(JSON_PROPERTY_STATIC_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setStaticFields(List staticFields) { + public void setStaticFields(@jakarta.annotation.Nullable List staticFields) { this.staticFields = staticFields; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java index 4797afd..80e1e9c 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldBase.java @@ -47,7 +47,7 @@ TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_REQUIRED, TemplateResponseDocumentCustomFieldBase.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -60,33 +60,43 @@ public class TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nullable private String apiId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_SIGNER = "signer"; + @jakarta.annotation.Nullable private String signer; public static final String JSON_PROPERTY_X = "x"; + @jakarta.annotation.Nullable private Integer x; public static final String JSON_PROPERTY_Y = "y"; + @jakarta.annotation.Nullable private Integer y; public static final String JSON_PROPERTY_WIDTH = "width"; + @jakarta.annotation.Nullable private Integer width; public static final String JSON_PROPERTY_HEIGHT = "height"; + @jakarta.annotation.Nullable private Integer height; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentCustomFieldBase() { @@ -107,7 +117,7 @@ static public TemplateResponseDocumentCustomFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentCustomFieldBase type(String type) { + public TemplateResponseDocumentCustomFieldBase type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -127,12 +137,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentCustomFieldBase apiId(String apiId) { + public TemplateResponseDocumentCustomFieldBase apiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; return this; } @@ -152,12 +162,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; } - public TemplateResponseDocumentCustomFieldBase name(String name) { + public TemplateResponseDocumentCustomFieldBase name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -177,12 +187,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseDocumentCustomFieldBase signer(String signer) { + public TemplateResponseDocumentCustomFieldBase signer(@jakarta.annotation.Nullable String signer) { this.signer = signer; return this; } @@ -206,7 +216,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { + public void setSigner(@jakarta.annotation.Nullable String signer) { this.signer = signer; } @@ -215,7 +225,7 @@ public void setSigner(Integer signer) { } - public TemplateResponseDocumentCustomFieldBase x(Integer x) { + public TemplateResponseDocumentCustomFieldBase x(@jakarta.annotation.Nullable Integer x) { this.x = x; return this; } @@ -235,12 +245,12 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setX(Integer x) { + public void setX(@jakarta.annotation.Nullable Integer x) { this.x = x; } - public TemplateResponseDocumentCustomFieldBase y(Integer y) { + public TemplateResponseDocumentCustomFieldBase y(@jakarta.annotation.Nullable Integer y) { this.y = y; return this; } @@ -260,12 +270,12 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setY(Integer y) { + public void setY(@jakarta.annotation.Nullable Integer y) { this.y = y; } - public TemplateResponseDocumentCustomFieldBase width(Integer width) { + public TemplateResponseDocumentCustomFieldBase width(@jakarta.annotation.Nullable Integer width) { this.width = width; return this; } @@ -285,12 +295,12 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWidth(Integer width) { + public void setWidth(@jakarta.annotation.Nullable Integer width) { this.width = width; } - public TemplateResponseDocumentCustomFieldBase height(Integer height) { + public TemplateResponseDocumentCustomFieldBase height(@jakarta.annotation.Nullable Integer height) { this.height = height; return this; } @@ -310,12 +320,12 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeight(Integer height) { + public void setHeight(@jakarta.annotation.Nullable Integer height) { this.height = height; } - public TemplateResponseDocumentCustomFieldBase required(Boolean required) { + public TemplateResponseDocumentCustomFieldBase required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -335,12 +345,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } - public TemplateResponseDocumentCustomFieldBase group(String group) { + public TemplateResponseDocumentCustomFieldBase group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -360,7 +370,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java index 353dd6a..40a4564 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldCheckbox.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentCustomFieldCheckbox.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentCustomFieldCheckbox extends TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox"; public TemplateResponseDocumentCustomFieldCheckbox() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentCustomFieldCheckbox init(HashMap data) thr ); } - public TemplateResponseDocumentCustomFieldCheckbox type(String type) { + public TemplateResponseDocumentCustomFieldCheckbox type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java index e9c2932..e566693 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentCustomFieldText.java @@ -44,7 +44,7 @@ TemplateResponseDocumentCustomFieldText.JSON_PROPERTY_ORIGINAL_FONT_SIZE, TemplateResponseDocumentCustomFieldText.JSON_PROPERTY_FONT_FAMILY }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -53,18 +53,23 @@ public class TemplateResponseDocumentCustomFieldText extends TemplateResponseDocumentCustomFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text"; public static final String JSON_PROPERTY_AVG_TEXT_LENGTH = "avg_text_length"; + @jakarta.annotation.Nullable private TemplateResponseFieldAvgTextLength avgTextLength; public static final String JSON_PROPERTY_IS_MULTILINE = "isMultiline"; + @jakarta.annotation.Nullable private Boolean isMultiline; public static final String JSON_PROPERTY_ORIGINAL_FONT_SIZE = "originalFontSize"; + @jakarta.annotation.Nullable private Integer originalFontSize; public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; + @jakarta.annotation.Nullable private String fontFamily; public TemplateResponseDocumentCustomFieldText() { @@ -85,7 +90,7 @@ static public TemplateResponseDocumentCustomFieldText init(HashMap data) throws ); } - public TemplateResponseDocumentCustomFieldText type(String type) { + public TemplateResponseDocumentCustomFieldText type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -105,12 +110,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentCustomFieldText avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public TemplateResponseDocumentCustomFieldText avgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; return this; } @@ -130,12 +135,12 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public void setAvgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } - public TemplateResponseDocumentCustomFieldText isMultiline(Boolean isMultiline) { + public TemplateResponseDocumentCustomFieldText isMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; return this; } @@ -155,12 +160,12 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsMultiline(Boolean isMultiline) { + public void setIsMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; } - public TemplateResponseDocumentCustomFieldText originalFontSize(Integer originalFontSize) { + public TemplateResponseDocumentCustomFieldText originalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; return this; } @@ -180,12 +185,12 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOriginalFontSize(Integer originalFontSize) { + public void setOriginalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; } - public TemplateResponseDocumentCustomFieldText fontFamily(String fontFamily) { + public TemplateResponseDocumentCustomFieldText fontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; return this; } @@ -205,7 +210,7 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(String fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java index 3e724af..bffee5b 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroup.java @@ -37,13 +37,15 @@ TemplateResponseDocumentFieldGroup.JSON_PROPERTY_NAME, TemplateResponseDocumentFieldGroup.JSON_PROPERTY_RULE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseDocumentFieldGroup { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_RULE = "rule"; + @jakarta.annotation.Nullable private TemplateResponseDocumentFieldGroupRule rule; public TemplateResponseDocumentFieldGroup() { @@ -64,7 +66,7 @@ static public TemplateResponseDocumentFieldGroup init(HashMap data) throws Excep ); } - public TemplateResponseDocumentFieldGroup name(String name) { + public TemplateResponseDocumentFieldGroup name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -84,12 +86,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseDocumentFieldGroup rule(TemplateResponseDocumentFieldGroupRule rule) { + public TemplateResponseDocumentFieldGroup rule(@jakarta.annotation.Nullable TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; return this; } @@ -109,7 +111,7 @@ public TemplateResponseDocumentFieldGroupRule getRule() { @JsonProperty(JSON_PROPERTY_RULE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRule(TemplateResponseDocumentFieldGroupRule rule) { + public void setRule(@jakarta.annotation.Nullable TemplateResponseDocumentFieldGroupRule rule) { this.rule = rule; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java index 65aa63b..8842e29 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFieldGroupRule.java @@ -36,13 +36,15 @@ TemplateResponseDocumentFieldGroupRule.JSON_PROPERTY_REQUIREMENT, TemplateResponseDocumentFieldGroupRule.JSON_PROPERTY_GROUP_LABEL }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseDocumentFieldGroupRule { public static final String JSON_PROPERTY_REQUIREMENT = "requirement"; + @jakarta.annotation.Nullable private String requirement; public static final String JSON_PROPERTY_GROUP_LABEL = "groupLabel"; + @jakarta.annotation.Nullable private String groupLabel; public TemplateResponseDocumentFieldGroupRule() { @@ -63,7 +65,7 @@ static public TemplateResponseDocumentFieldGroupRule init(HashMap data) throws E ); } - public TemplateResponseDocumentFieldGroupRule requirement(String requirement) { + public TemplateResponseDocumentFieldGroupRule requirement(@jakarta.annotation.Nullable String requirement) { this.requirement = requirement; return this; } @@ -83,12 +85,12 @@ public String getRequirement() { @JsonProperty(JSON_PROPERTY_REQUIREMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequirement(String requirement) { + public void setRequirement(@jakarta.annotation.Nullable String requirement) { this.requirement = requirement; } - public TemplateResponseDocumentFieldGroupRule groupLabel(String groupLabel) { + public TemplateResponseDocumentFieldGroupRule groupLabel(@jakarta.annotation.Nullable String groupLabel) { this.groupLabel = groupLabel; return this; } @@ -108,7 +110,7 @@ public String getGroupLabel() { @JsonProperty(JSON_PROPERTY_GROUP_LABEL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroupLabel(String groupLabel) { + public void setGroupLabel(@jakarta.annotation.Nullable String groupLabel) { this.groupLabel = groupLabel; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java index 25ee2dc..6256087 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldBase.java @@ -46,7 +46,7 @@ TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_HEIGHT, TemplateResponseDocumentFormFieldBase.JSON_PROPERTY_REQUIRED }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -65,30 +65,39 @@ public class TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nullable private String apiId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_SIGNER = "signer"; + @jakarta.annotation.Nullable private String signer; public static final String JSON_PROPERTY_X = "x"; + @jakarta.annotation.Nullable private Integer x; public static final String JSON_PROPERTY_Y = "y"; + @jakarta.annotation.Nullable private Integer y; public static final String JSON_PROPERTY_WIDTH = "width"; + @jakarta.annotation.Nullable private Integer width; public static final String JSON_PROPERTY_HEIGHT = "height"; + @jakarta.annotation.Nullable private Integer height; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required; public TemplateResponseDocumentFormFieldBase() { @@ -109,7 +118,7 @@ static public TemplateResponseDocumentFormFieldBase init(HashMap data) throws Ex ); } - public TemplateResponseDocumentFormFieldBase type(String type) { + public TemplateResponseDocumentFormFieldBase type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -129,12 +138,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldBase apiId(String apiId) { + public TemplateResponseDocumentFormFieldBase apiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; return this; } @@ -154,12 +163,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; } - public TemplateResponseDocumentFormFieldBase name(String name) { + public TemplateResponseDocumentFormFieldBase name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -179,12 +188,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseDocumentFormFieldBase signer(String signer) { + public TemplateResponseDocumentFormFieldBase signer(@jakarta.annotation.Nullable String signer) { this.signer = signer; return this; } @@ -208,7 +217,7 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { + public void setSigner(@jakarta.annotation.Nullable String signer) { this.signer = signer; } @@ -217,7 +226,7 @@ public void setSigner(Integer signer) { } - public TemplateResponseDocumentFormFieldBase x(Integer x) { + public TemplateResponseDocumentFormFieldBase x(@jakarta.annotation.Nullable Integer x) { this.x = x; return this; } @@ -237,12 +246,12 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setX(Integer x) { + public void setX(@jakarta.annotation.Nullable Integer x) { this.x = x; } - public TemplateResponseDocumentFormFieldBase y(Integer y) { + public TemplateResponseDocumentFormFieldBase y(@jakarta.annotation.Nullable Integer y) { this.y = y; return this; } @@ -262,12 +271,12 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setY(Integer y) { + public void setY(@jakarta.annotation.Nullable Integer y) { this.y = y; } - public TemplateResponseDocumentFormFieldBase width(Integer width) { + public TemplateResponseDocumentFormFieldBase width(@jakarta.annotation.Nullable Integer width) { this.width = width; return this; } @@ -287,12 +296,12 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWidth(Integer width) { + public void setWidth(@jakarta.annotation.Nullable Integer width) { this.width = width; } - public TemplateResponseDocumentFormFieldBase height(Integer height) { + public TemplateResponseDocumentFormFieldBase height(@jakarta.annotation.Nullable Integer height) { this.height = height; return this; } @@ -312,12 +321,12 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeight(Integer height) { + public void setHeight(@jakarta.annotation.Nullable Integer height) { this.height = height; } - public TemplateResponseDocumentFormFieldBase required(Boolean required) { + public TemplateResponseDocumentFormFieldBase required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -337,7 +346,7 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java index 110468a..81b0ce1 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldCheckbox.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldCheckbox.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldCheckbox extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldCheckbox() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldCheckbox init(HashMap data) throw ); } - public TemplateResponseDocumentFormFieldCheckbox type(String type) { + public TemplateResponseDocumentFormFieldCheckbox type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldCheckbox group(String group) { + public TemplateResponseDocumentFormFieldCheckbox group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java index 67ec89a..b59e545 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDateSigned.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldDateSigned.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldDateSigned extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "date_signed"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldDateSigned() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldDateSigned init(HashMap data) thr ); } - public TemplateResponseDocumentFormFieldDateSigned type(String type) { + public TemplateResponseDocumentFormFieldDateSigned type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldDateSigned group(String group) { + public TemplateResponseDocumentFormFieldDateSigned group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java index 8003f4c..951081d 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldDropdown.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldDropdown.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldDropdown extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "dropdown"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldDropdown() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldDropdown init(HashMap data) throw ); } - public TemplateResponseDocumentFormFieldDropdown type(String type) { + public TemplateResponseDocumentFormFieldDropdown type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldDropdown group(String group) { + public TemplateResponseDocumentFormFieldDropdown group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java index 6ce907e..5a917fa 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldHyperlink.java @@ -45,7 +45,7 @@ TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_FONT_FAMILY, TemplateResponseDocumentFormFieldHyperlink.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -54,21 +54,27 @@ public class TemplateResponseDocumentFormFieldHyperlink extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "hyperlink"; public static final String JSON_PROPERTY_AVG_TEXT_LENGTH = "avg_text_length"; + @jakarta.annotation.Nullable private TemplateResponseFieldAvgTextLength avgTextLength; public static final String JSON_PROPERTY_IS_MULTILINE = "isMultiline"; + @jakarta.annotation.Nullable private Boolean isMultiline; public static final String JSON_PROPERTY_ORIGINAL_FONT_SIZE = "originalFontSize"; + @jakarta.annotation.Nullable private Integer originalFontSize; public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; + @jakarta.annotation.Nullable private String fontFamily; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldHyperlink() { @@ -89,7 +95,7 @@ static public TemplateResponseDocumentFormFieldHyperlink init(HashMap data) thro ); } - public TemplateResponseDocumentFormFieldHyperlink type(String type) { + public TemplateResponseDocumentFormFieldHyperlink type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -109,12 +115,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldHyperlink avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public TemplateResponseDocumentFormFieldHyperlink avgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; return this; } @@ -134,12 +140,12 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public void setAvgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } - public TemplateResponseDocumentFormFieldHyperlink isMultiline(Boolean isMultiline) { + public TemplateResponseDocumentFormFieldHyperlink isMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; return this; } @@ -159,12 +165,12 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsMultiline(Boolean isMultiline) { + public void setIsMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; } - public TemplateResponseDocumentFormFieldHyperlink originalFontSize(Integer originalFontSize) { + public TemplateResponseDocumentFormFieldHyperlink originalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; return this; } @@ -184,12 +190,12 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOriginalFontSize(Integer originalFontSize) { + public void setOriginalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; } - public TemplateResponseDocumentFormFieldHyperlink fontFamily(String fontFamily) { + public TemplateResponseDocumentFormFieldHyperlink fontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; return this; } @@ -209,12 +215,12 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(String fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; } - public TemplateResponseDocumentFormFieldHyperlink group(String group) { + public TemplateResponseDocumentFormFieldHyperlink group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -234,7 +240,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java index 7aa96f5..336e016 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldInitials.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldInitials.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldInitials extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "initials"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldInitials() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldInitials init(HashMap data) throw ); } - public TemplateResponseDocumentFormFieldInitials type(String type) { + public TemplateResponseDocumentFormFieldInitials type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldInitials group(String group) { + public TemplateResponseDocumentFormFieldInitials group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java index 5e93657..7a41f8e 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldRadio.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldRadio.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldRadio extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "radio"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nonnull private String group; public TemplateResponseDocumentFormFieldRadio() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldRadio init(HashMap data) throws E ); } - public TemplateResponseDocumentFormFieldRadio type(String type) { + public TemplateResponseDocumentFormFieldRadio type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldRadio group(String group) { + public TemplateResponseDocumentFormFieldRadio group(@jakarta.annotation.Nonnull String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nonnull String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java index ac0a0c3..17b167c 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldSignature.java @@ -40,7 +40,7 @@ TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_TYPE, TemplateResponseDocumentFormFieldSignature.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -49,9 +49,11 @@ public class TemplateResponseDocumentFormFieldSignature extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "signature"; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldSignature() { @@ -72,7 +74,7 @@ static public TemplateResponseDocumentFormFieldSignature init(HashMap data) thro ); } - public TemplateResponseDocumentFormFieldSignature type(String type) { + public TemplateResponseDocumentFormFieldSignature type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -92,12 +94,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldSignature group(String group) { + public TemplateResponseDocumentFormFieldSignature group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -117,7 +119,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java index db5fce4..7bbb7ca 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentFormFieldText.java @@ -46,7 +46,7 @@ TemplateResponseDocumentFormFieldText.JSON_PROPERTY_VALIDATION_TYPE, TemplateResponseDocumentFormFieldText.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -55,43 +55,48 @@ public class TemplateResponseDocumentFormFieldText extends TemplateResponseDocumentFormFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text"; public static final String JSON_PROPERTY_AVG_TEXT_LENGTH = "avg_text_length"; + @jakarta.annotation.Nullable private TemplateResponseFieldAvgTextLength avgTextLength; public static final String JSON_PROPERTY_IS_MULTILINE = "isMultiline"; + @jakarta.annotation.Nullable private Boolean isMultiline; public static final String JSON_PROPERTY_ORIGINAL_FONT_SIZE = "originalFontSize"; + @jakarta.annotation.Nullable private Integer originalFontSize; public static final String JSON_PROPERTY_FONT_FAMILY = "fontFamily"; + @jakarta.annotation.Nullable private String fontFamily; /** * Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values. */ public enum ValidationTypeEnum { - NUMBERS_ONLY("numbers_only"), + NUMBERS_ONLY(String.valueOf("numbers_only")), - LETTERS_ONLY("letters_only"), + LETTERS_ONLY(String.valueOf("letters_only")), - PHONE_NUMBER("phone_number"), + PHONE_NUMBER(String.valueOf("phone_number")), - BANK_ROUTING_NUMBER("bank_routing_number"), + BANK_ROUTING_NUMBER(String.valueOf("bank_routing_number")), - BANK_ACCOUNT_NUMBER("bank_account_number"), + BANK_ACCOUNT_NUMBER(String.valueOf("bank_account_number")), - EMAIL_ADDRESS("email_address"), + EMAIL_ADDRESS(String.valueOf("email_address")), - ZIP_CODE("zip_code"), + ZIP_CODE(String.valueOf("zip_code")), - SOCIAL_SECURITY_NUMBER("social_security_number"), + SOCIAL_SECURITY_NUMBER(String.valueOf("social_security_number")), - EMPLOYER_IDENTIFICATION_NUMBER("employer_identification_number"), + EMPLOYER_IDENTIFICATION_NUMBER(String.valueOf("employer_identification_number")), - CUSTOM_REGEX("custom_regex"); + CUSTOM_REGEX(String.valueOf("custom_regex")); private String value; @@ -121,9 +126,11 @@ public static ValidationTypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_VALIDATION_TYPE = "validation_type"; + @jakarta.annotation.Nullable private ValidationTypeEnum validationType; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentFormFieldText() { @@ -144,7 +151,7 @@ static public TemplateResponseDocumentFormFieldText init(HashMap data) throws Ex ); } - public TemplateResponseDocumentFormFieldText type(String type) { + public TemplateResponseDocumentFormFieldText type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -164,12 +171,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentFormFieldText avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public TemplateResponseDocumentFormFieldText avgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; return this; } @@ -189,12 +196,12 @@ public TemplateResponseFieldAvgTextLength getAvgTextLength() { @JsonProperty(JSON_PROPERTY_AVG_TEXT_LENGTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength) { + public void setAvgTextLength(@jakarta.annotation.Nullable TemplateResponseFieldAvgTextLength avgTextLength) { this.avgTextLength = avgTextLength; } - public TemplateResponseDocumentFormFieldText isMultiline(Boolean isMultiline) { + public TemplateResponseDocumentFormFieldText isMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; return this; } @@ -214,12 +221,12 @@ public Boolean getIsMultiline() { @JsonProperty(JSON_PROPERTY_IS_MULTILINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsMultiline(Boolean isMultiline) { + public void setIsMultiline(@jakarta.annotation.Nullable Boolean isMultiline) { this.isMultiline = isMultiline; } - public TemplateResponseDocumentFormFieldText originalFontSize(Integer originalFontSize) { + public TemplateResponseDocumentFormFieldText originalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; return this; } @@ -239,12 +246,12 @@ public Integer getOriginalFontSize() { @JsonProperty(JSON_PROPERTY_ORIGINAL_FONT_SIZE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOriginalFontSize(Integer originalFontSize) { + public void setOriginalFontSize(@jakarta.annotation.Nullable Integer originalFontSize) { this.originalFontSize = originalFontSize; } - public TemplateResponseDocumentFormFieldText fontFamily(String fontFamily) { + public TemplateResponseDocumentFormFieldText fontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; return this; } @@ -264,12 +271,12 @@ public String getFontFamily() { @JsonProperty(JSON_PROPERTY_FONT_FAMILY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFontFamily(String fontFamily) { + public void setFontFamily(@jakarta.annotation.Nullable String fontFamily) { this.fontFamily = fontFamily; } - public TemplateResponseDocumentFormFieldText validationType(ValidationTypeEnum validationType) { + public TemplateResponseDocumentFormFieldText validationType(@jakarta.annotation.Nullable ValidationTypeEnum validationType) { this.validationType = validationType; return this; } @@ -289,12 +296,12 @@ public ValidationTypeEnum getValidationType() { @JsonProperty(JSON_PROPERTY_VALIDATION_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setValidationType(ValidationTypeEnum validationType) { + public void setValidationType(@jakarta.annotation.Nullable ValidationTypeEnum validationType) { this.validationType = validationType; } - public TemplateResponseDocumentFormFieldText group(String group) { + public TemplateResponseDocumentFormFieldText group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -314,7 +321,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java index 4e1e982..06bb977 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldBase.java @@ -47,7 +47,7 @@ TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_REQUIRED, TemplateResponseDocumentStaticFieldBase.JSON_PROPERTY_GROUP }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -66,33 +66,43 @@ public class TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type; public static final String JSON_PROPERTY_API_ID = "api_id"; + @jakarta.annotation.Nullable private String apiId; public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_SIGNER = "signer"; + @jakarta.annotation.Nullable private String signer = "me_now"; public static final String JSON_PROPERTY_X = "x"; + @jakarta.annotation.Nullable private Integer x; public static final String JSON_PROPERTY_Y = "y"; + @jakarta.annotation.Nullable private Integer y; public static final String JSON_PROPERTY_WIDTH = "width"; + @jakarta.annotation.Nullable private Integer width; public static final String JSON_PROPERTY_HEIGHT = "height"; + @jakarta.annotation.Nullable private Integer height; public static final String JSON_PROPERTY_REQUIRED = "required"; + @jakarta.annotation.Nullable private Boolean required; public static final String JSON_PROPERTY_GROUP = "group"; + @jakarta.annotation.Nullable private String group; public TemplateResponseDocumentStaticFieldBase() { @@ -113,7 +123,7 @@ static public TemplateResponseDocumentStaticFieldBase init(HashMap data) throws ); } - public TemplateResponseDocumentStaticFieldBase type(String type) { + public TemplateResponseDocumentStaticFieldBase type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -133,12 +143,12 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } - public TemplateResponseDocumentStaticFieldBase apiId(String apiId) { + public TemplateResponseDocumentStaticFieldBase apiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; return this; } @@ -158,12 +168,12 @@ public String getApiId() { @JsonProperty(JSON_PROPERTY_API_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setApiId(String apiId) { + public void setApiId(@jakarta.annotation.Nullable String apiId) { this.apiId = apiId; } - public TemplateResponseDocumentStaticFieldBase name(String name) { + public TemplateResponseDocumentStaticFieldBase name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -183,12 +193,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseDocumentStaticFieldBase signer(String signer) { + public TemplateResponseDocumentStaticFieldBase signer(@jakarta.annotation.Nullable String signer) { this.signer = signer; return this; } @@ -208,12 +218,12 @@ public String getSigner() { @JsonProperty(JSON_PROPERTY_SIGNER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigner(String signer) { + public void setSigner(@jakarta.annotation.Nullable String signer) { this.signer = signer; } - public TemplateResponseDocumentStaticFieldBase x(Integer x) { + public TemplateResponseDocumentStaticFieldBase x(@jakarta.annotation.Nullable Integer x) { this.x = x; return this; } @@ -233,12 +243,12 @@ public Integer getX() { @JsonProperty(JSON_PROPERTY_X) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setX(Integer x) { + public void setX(@jakarta.annotation.Nullable Integer x) { this.x = x; } - public TemplateResponseDocumentStaticFieldBase y(Integer y) { + public TemplateResponseDocumentStaticFieldBase y(@jakarta.annotation.Nullable Integer y) { this.y = y; return this; } @@ -258,12 +268,12 @@ public Integer getY() { @JsonProperty(JSON_PROPERTY_Y) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setY(Integer y) { + public void setY(@jakarta.annotation.Nullable Integer y) { this.y = y; } - public TemplateResponseDocumentStaticFieldBase width(Integer width) { + public TemplateResponseDocumentStaticFieldBase width(@jakarta.annotation.Nullable Integer width) { this.width = width; return this; } @@ -283,12 +293,12 @@ public Integer getWidth() { @JsonProperty(JSON_PROPERTY_WIDTH) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWidth(Integer width) { + public void setWidth(@jakarta.annotation.Nullable Integer width) { this.width = width; } - public TemplateResponseDocumentStaticFieldBase height(Integer height) { + public TemplateResponseDocumentStaticFieldBase height(@jakarta.annotation.Nullable Integer height) { this.height = height; return this; } @@ -308,12 +318,12 @@ public Integer getHeight() { @JsonProperty(JSON_PROPERTY_HEIGHT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHeight(Integer height) { + public void setHeight(@jakarta.annotation.Nullable Integer height) { this.height = height; } - public TemplateResponseDocumentStaticFieldBase required(Boolean required) { + public TemplateResponseDocumentStaticFieldBase required(@jakarta.annotation.Nullable Boolean required) { this.required = required; return this; } @@ -333,12 +343,12 @@ public Boolean getRequired() { @JsonProperty(JSON_PROPERTY_REQUIRED) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequired(Boolean required) { + public void setRequired(@jakarta.annotation.Nullable Boolean required) { this.required = required; } - public TemplateResponseDocumentStaticFieldBase group(String group) { + public TemplateResponseDocumentStaticFieldBase group(@jakarta.annotation.Nullable String group) { this.group = group; return this; } @@ -358,7 +368,7 @@ public String getGroup() { @JsonProperty(JSON_PROPERTY_GROUP) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setGroup(String group) { + public void setGroup(@jakarta.annotation.Nullable String group) { this.group = group; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java index d23f853..81c46c3 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldCheckbox.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldCheckbox.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldCheckbox extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "checkbox"; public TemplateResponseDocumentStaticFieldCheckbox() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldCheckbox init(HashMap data) thr ); } - public TemplateResponseDocumentStaticFieldCheckbox type(String type) { + public TemplateResponseDocumentStaticFieldCheckbox type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java index 8a19f3c..7afedcd 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDateSigned.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldDateSigned.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldDateSigned extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "date_signed"; public TemplateResponseDocumentStaticFieldDateSigned() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldDateSigned init(HashMap data) t ); } - public TemplateResponseDocumentStaticFieldDateSigned type(String type) { + public TemplateResponseDocumentStaticFieldDateSigned type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java index 171417e..41e4246 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldDropdown.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldDropdown.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldDropdown extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "dropdown"; public TemplateResponseDocumentStaticFieldDropdown() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldDropdown init(HashMap data) thr ); } - public TemplateResponseDocumentStaticFieldDropdown type(String type) { + public TemplateResponseDocumentStaticFieldDropdown type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java index 925996d..bea9d84 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldHyperlink.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldHyperlink.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldHyperlink extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "hyperlink"; public TemplateResponseDocumentStaticFieldHyperlink() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldHyperlink init(HashMap data) th ); } - public TemplateResponseDocumentStaticFieldHyperlink type(String type) { + public TemplateResponseDocumentStaticFieldHyperlink type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java index 15e4b07..1ec5db4 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldInitials.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldInitials.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldInitials extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "initials"; public TemplateResponseDocumentStaticFieldInitials() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldInitials init(HashMap data) thr ); } - public TemplateResponseDocumentStaticFieldInitials type(String type) { + public TemplateResponseDocumentStaticFieldInitials type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java index 73f1fd8..b1401f4 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldRadio.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldRadio.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldRadio extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "radio"; public TemplateResponseDocumentStaticFieldRadio() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldRadio init(HashMap data) throws ); } - public TemplateResponseDocumentStaticFieldRadio type(String type) { + public TemplateResponseDocumentStaticFieldRadio type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java index 6e472ec..f72de56 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldSignature.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldSignature.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldSignature extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "signature"; public TemplateResponseDocumentStaticFieldSignature() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldSignature init(HashMap data) th ); } - public TemplateResponseDocumentStaticFieldSignature type(String type) { + public TemplateResponseDocumentStaticFieldSignature type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java index 8778199..4d313af 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseDocumentStaticFieldText.java @@ -39,7 +39,7 @@ @JsonPropertyOrder({ TemplateResponseDocumentStaticFieldText.JSON_PROPERTY_TYPE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties( allowSetters = true, // allows the type to be set during deserialization ignoreUnknown = true @@ -48,6 +48,7 @@ public class TemplateResponseDocumentStaticFieldText extends TemplateResponseDocumentStaticFieldBase { public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private String type = "text"; public TemplateResponseDocumentStaticFieldText() { @@ -68,7 +69,7 @@ static public TemplateResponseDocumentStaticFieldText init(HashMap data) throws ); } - public TemplateResponseDocumentStaticFieldText type(String type) { + public TemplateResponseDocumentStaticFieldText type(@jakarta.annotation.Nonnull String type) { this.type = type; return this; } @@ -88,7 +89,7 @@ public String getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(String type) { + public void setType(@jakarta.annotation.Nonnull String type) { this.type = type; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java b/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java index 38f5acd..e87ce40 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseFieldAvgTextLength.java @@ -36,13 +36,15 @@ TemplateResponseFieldAvgTextLength.JSON_PROPERTY_NUM_LINES, TemplateResponseFieldAvgTextLength.JSON_PROPERTY_NUM_CHARS_PER_LINE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseFieldAvgTextLength { public static final String JSON_PROPERTY_NUM_LINES = "num_lines"; + @jakarta.annotation.Nullable private Integer numLines; public static final String JSON_PROPERTY_NUM_CHARS_PER_LINE = "num_chars_per_line"; + @jakarta.annotation.Nullable private Integer numCharsPerLine; public TemplateResponseFieldAvgTextLength() { @@ -63,7 +65,7 @@ static public TemplateResponseFieldAvgTextLength init(HashMap data) throws Excep ); } - public TemplateResponseFieldAvgTextLength numLines(Integer numLines) { + public TemplateResponseFieldAvgTextLength numLines(@jakarta.annotation.Nullable Integer numLines) { this.numLines = numLines; return this; } @@ -83,12 +85,12 @@ public Integer getNumLines() { @JsonProperty(JSON_PROPERTY_NUM_LINES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumLines(Integer numLines) { + public void setNumLines(@jakarta.annotation.Nullable Integer numLines) { this.numLines = numLines; } - public TemplateResponseFieldAvgTextLength numCharsPerLine(Integer numCharsPerLine) { + public TemplateResponseFieldAvgTextLength numCharsPerLine(@jakarta.annotation.Nullable Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; return this; } @@ -108,7 +110,7 @@ public Integer getNumCharsPerLine() { @JsonProperty(JSON_PROPERTY_NUM_CHARS_PER_LINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setNumCharsPerLine(Integer numCharsPerLine) { + public void setNumCharsPerLine(@jakarta.annotation.Nullable Integer numCharsPerLine) { this.numCharsPerLine = numCharsPerLine; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java b/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java index 45d786a..6e5e212 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java +++ b/src/main/java/com/dropbox/sign/model/TemplateResponseSignerRole.java @@ -36,13 +36,15 @@ TemplateResponseSignerRole.JSON_PROPERTY_NAME, TemplateResponseSignerRole.JSON_PROPERTY_ORDER }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateResponseSignerRole { public static final String JSON_PROPERTY_NAME = "name"; + @jakarta.annotation.Nullable private String name; public static final String JSON_PROPERTY_ORDER = "order"; + @jakarta.annotation.Nullable private Integer order; public TemplateResponseSignerRole() { @@ -63,7 +65,7 @@ static public TemplateResponseSignerRole init(HashMap data) throws Exception { ); } - public TemplateResponseSignerRole name(String name) { + public TemplateResponseSignerRole name(@jakarta.annotation.Nullable String name) { this.name = name; return this; } @@ -83,12 +85,12 @@ public String getName() { @JsonProperty(JSON_PROPERTY_NAME) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setName(String name) { + public void setName(@jakarta.annotation.Nullable String name) { this.name = name; } - public TemplateResponseSignerRole order(Integer order) { + public TemplateResponseSignerRole order(@jakarta.annotation.Nullable Integer order) { this.order = order; return this; } @@ -108,7 +110,7 @@ public Integer getOrder() { @JsonProperty(JSON_PROPERTY_ORDER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOrder(Integer order) { + public void setOrder(@jakarta.annotation.Nullable Integer order) { this.order = order; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesRequest.java b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesRequest.java index 432b368..8e7f33f 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesRequest.java +++ b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesRequest.java @@ -43,25 +43,31 @@ TemplateUpdateFilesRequest.JSON_PROPERTY_SUBJECT, TemplateUpdateFilesRequest.JSON_PROPERTY_TEST_MODE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateUpdateFilesRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public TemplateUpdateFilesRequest() { @@ -82,7 +88,7 @@ static public TemplateUpdateFilesRequest init(HashMap data) throws Exception { ); } - public TemplateUpdateFilesRequest clientId(String clientId) { + public TemplateUpdateFilesRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -102,12 +108,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public TemplateUpdateFilesRequest files(List files) { + public TemplateUpdateFilesRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -135,12 +141,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public TemplateUpdateFilesRequest fileUrls(List fileUrls) { + public TemplateUpdateFilesRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -168,12 +174,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public TemplateUpdateFilesRequest message(String message) { + public TemplateUpdateFilesRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -193,12 +199,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public TemplateUpdateFilesRequest subject(String subject) { + public TemplateUpdateFilesRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -218,12 +224,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public TemplateUpdateFilesRequest testMode(Boolean testMode) { + public TemplateUpdateFilesRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -243,7 +249,7 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponse.java b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponse.java index 862c431..2cddd3e 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponse.java +++ b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponse.java @@ -36,10 +36,11 @@ @JsonPropertyOrder({ TemplateUpdateFilesResponse.JSON_PROPERTY_TEMPLATE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateUpdateFilesResponse { public static final String JSON_PROPERTY_TEMPLATE = "template"; + @jakarta.annotation.Nonnull private TemplateUpdateFilesResponseTemplate template; public TemplateUpdateFilesResponse() { @@ -60,7 +61,7 @@ static public TemplateUpdateFilesResponse init(HashMap data) throws Exception { ); } - public TemplateUpdateFilesResponse template(TemplateUpdateFilesResponseTemplate template) { + public TemplateUpdateFilesResponse template(@jakarta.annotation.Nonnull TemplateUpdateFilesResponseTemplate template) { this.template = template; return this; } @@ -80,7 +81,7 @@ public TemplateUpdateFilesResponseTemplate getTemplate() { @JsonProperty(JSON_PROPERTY_TEMPLATE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplate(TemplateUpdateFilesResponseTemplate template) { + public void setTemplate(@jakarta.annotation.Nonnull TemplateUpdateFilesResponseTemplate template) { this.template = template; } diff --git a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java index 19dea91..3dc17d8 100644 --- a/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java +++ b/src/main/java/com/dropbox/sign/model/TemplateUpdateFilesResponseTemplate.java @@ -39,14 +39,16 @@ TemplateUpdateFilesResponseTemplate.JSON_PROPERTY_TEMPLATE_ID, TemplateUpdateFilesResponseTemplate.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class TemplateUpdateFilesResponseTemplate { public static final String JSON_PROPERTY_TEMPLATE_ID = "template_id"; + @jakarta.annotation.Nullable private String templateId; public static final String JSON_PROPERTY_WARNINGS = "warnings"; @Deprecated + @jakarta.annotation.Nullable private List warnings = null; public TemplateUpdateFilesResponseTemplate() { @@ -67,7 +69,7 @@ static public TemplateUpdateFilesResponseTemplate init(HashMap data) throws Exce ); } - public TemplateUpdateFilesResponseTemplate templateId(String templateId) { + public TemplateUpdateFilesResponseTemplate templateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; return this; } @@ -87,13 +89,13 @@ public String getTemplateId() { @JsonProperty(JSON_PROPERTY_TEMPLATE_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTemplateId(String templateId) { + public void setTemplateId(@jakarta.annotation.Nullable String templateId) { this.templateId = templateId; } @Deprecated - public TemplateUpdateFilesResponseTemplate warnings(List warnings) { + public TemplateUpdateFilesResponseTemplate warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -124,7 +126,7 @@ public List getWarnings() { @Deprecated @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java index 5dd37a3..0c762b6 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedRequest.java @@ -84,109 +84,140 @@ UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, UnclaimedDraftCreateEmbeddedRequest.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftCreateEmbeddedRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS = "requester_email_address"; + @jakarta.annotation.Nonnull private String requesterEmailAddress; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_ALLOW_CCS = "allow_ccs"; + @jakarta.annotation.Nullable private Boolean allowCcs = true; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_EDITOR_OPTIONS = "editor_options"; + @jakarta.annotation.Nullable private SubEditorOptions editorOptions; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORCE_SIGNER_PAGE = "force_signer_page"; + @jakarta.annotation.Nullable private Boolean forceSignerPage = false; public static final String JSON_PROPERTY_FORCE_SUBJECT_MESSAGE = "force_subject_message"; + @jakarta.annotation.Nullable private Boolean forceSubjectMessage = false; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable private List formFieldsPerDocument = null; public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable private Boolean hideTextTags = false; public static final String JSON_PROPERTY_HOLD_REQUEST = "hold_request"; + @jakarta.annotation.Nullable private Boolean holdRequest = false; public static final String JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING = "is_for_embedded_signing"; + @jakarta.annotation.Nullable private Boolean isForEmbeddedSigning = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_REQUESTING_REDIRECT_URL = "requesting_redirect_url"; + @jakarta.annotation.Nullable private String requestingRedirectUrl; public static final String JSON_PROPERTY_SHOW_PREVIEW = "show_preview"; + @jakarta.annotation.Nullable private Boolean showPreview; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SKIP_ME_NOW = "skip_me_now"; + @jakarta.annotation.Nullable private Boolean skipMeNow = false; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; /** * The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it. */ public enum TypeEnum { - SEND_DOCUMENT("send_document"), + SEND_DOCUMENT(String.valueOf("send_document")), - REQUEST_SIGNATURE("request_signature"); + REQUEST_SIGNATURE(String.valueOf("request_signature")); private String value; @@ -216,18 +247,23 @@ public static TypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nullable private TypeEnum type = TypeEnum.REQUEST_SIGNATURE; public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; + @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable private Boolean useTextTags = false; public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public UnclaimedDraftCreateEmbeddedRequest() { @@ -248,7 +284,7 @@ static public UnclaimedDraftCreateEmbeddedRequest init(HashMap data) throws Exce ); } - public UnclaimedDraftCreateEmbeddedRequest clientId(String clientId) { + public UnclaimedDraftCreateEmbeddedRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -268,12 +304,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public UnclaimedDraftCreateEmbeddedRequest requesterEmailAddress(String requesterEmailAddress) { + public UnclaimedDraftCreateEmbeddedRequest requesterEmailAddress(@jakarta.annotation.Nonnull String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; return this; } @@ -293,12 +329,12 @@ public String getRequesterEmailAddress() { @JsonProperty(JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequesterEmailAddress(String requesterEmailAddress) { + public void setRequesterEmailAddress(@jakarta.annotation.Nonnull String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; } - public UnclaimedDraftCreateEmbeddedRequest files(List files) { + public UnclaimedDraftCreateEmbeddedRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -326,12 +362,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public UnclaimedDraftCreateEmbeddedRequest fileUrls(List fileUrls) { + public UnclaimedDraftCreateEmbeddedRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -359,12 +395,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public UnclaimedDraftCreateEmbeddedRequest allowCcs(Boolean allowCcs) { + public UnclaimedDraftCreateEmbeddedRequest allowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; return this; } @@ -384,12 +420,12 @@ public Boolean getAllowCcs() { @JsonProperty(JSON_PROPERTY_ALLOW_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowCcs(Boolean allowCcs) { + public void setAllowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; } - public UnclaimedDraftCreateEmbeddedRequest allowDecline(Boolean allowDecline) { + public UnclaimedDraftCreateEmbeddedRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -409,12 +445,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public UnclaimedDraftCreateEmbeddedRequest allowReassign(Boolean allowReassign) { + public UnclaimedDraftCreateEmbeddedRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -434,12 +470,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public UnclaimedDraftCreateEmbeddedRequest attachments(List attachments) { + public UnclaimedDraftCreateEmbeddedRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -467,12 +503,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public UnclaimedDraftCreateEmbeddedRequest ccEmailAddresses(List ccEmailAddresses) { + public UnclaimedDraftCreateEmbeddedRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -500,12 +536,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public UnclaimedDraftCreateEmbeddedRequest customFields(List customFields) { + public UnclaimedDraftCreateEmbeddedRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -533,12 +569,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public UnclaimedDraftCreateEmbeddedRequest editorOptions(SubEditorOptions editorOptions) { + public UnclaimedDraftCreateEmbeddedRequest editorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; return this; } @@ -558,12 +594,12 @@ public SubEditorOptions getEditorOptions() { @JsonProperty(JSON_PROPERTY_EDITOR_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditorOptions(SubEditorOptions editorOptions) { + public void setEditorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; } - public UnclaimedDraftCreateEmbeddedRequest fieldOptions(SubFieldOptions fieldOptions) { + public UnclaimedDraftCreateEmbeddedRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -583,12 +619,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public UnclaimedDraftCreateEmbeddedRequest forceSignerPage(Boolean forceSignerPage) { + public UnclaimedDraftCreateEmbeddedRequest forceSignerPage(@jakarta.annotation.Nullable Boolean forceSignerPage) { this.forceSignerPage = forceSignerPage; return this; } @@ -608,12 +644,12 @@ public Boolean getForceSignerPage() { @JsonProperty(JSON_PROPERTY_FORCE_SIGNER_PAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSignerPage(Boolean forceSignerPage) { + public void setForceSignerPage(@jakarta.annotation.Nullable Boolean forceSignerPage) { this.forceSignerPage = forceSignerPage; } - public UnclaimedDraftCreateEmbeddedRequest forceSubjectMessage(Boolean forceSubjectMessage) { + public UnclaimedDraftCreateEmbeddedRequest forceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; return this; } @@ -633,12 +669,12 @@ public Boolean getForceSubjectMessage() { @JsonProperty(JSON_PROPERTY_FORCE_SUBJECT_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSubjectMessage(Boolean forceSubjectMessage) { + public void setForceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; } - public UnclaimedDraftCreateEmbeddedRequest formFieldGroups(List formFieldGroups) { + public UnclaimedDraftCreateEmbeddedRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -666,12 +702,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public UnclaimedDraftCreateEmbeddedRequest formFieldRules(List formFieldRules) { + public UnclaimedDraftCreateEmbeddedRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -699,12 +735,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public UnclaimedDraftCreateEmbeddedRequest formFieldsPerDocument(List formFieldsPerDocument) { + public UnclaimedDraftCreateEmbeddedRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -732,12 +768,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public UnclaimedDraftCreateEmbeddedRequest hideTextTags(Boolean hideTextTags) { + public UnclaimedDraftCreateEmbeddedRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; return this; } @@ -757,12 +793,12 @@ public Boolean getHideTextTags() { @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHideTextTags(Boolean hideTextTags) { + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; } - public UnclaimedDraftCreateEmbeddedRequest holdRequest(Boolean holdRequest) { + public UnclaimedDraftCreateEmbeddedRequest holdRequest(@jakarta.annotation.Nullable Boolean holdRequest) { this.holdRequest = holdRequest; return this; } @@ -782,12 +818,12 @@ public Boolean getHoldRequest() { @JsonProperty(JSON_PROPERTY_HOLD_REQUEST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHoldRequest(Boolean holdRequest) { + public void setHoldRequest(@jakarta.annotation.Nullable Boolean holdRequest) { this.holdRequest = holdRequest; } - public UnclaimedDraftCreateEmbeddedRequest isForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public UnclaimedDraftCreateEmbeddedRequest isForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; return this; } @@ -807,12 +843,12 @@ public Boolean getIsForEmbeddedSigning() { @JsonProperty(JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public void setIsForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; } - public UnclaimedDraftCreateEmbeddedRequest message(String message) { + public UnclaimedDraftCreateEmbeddedRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -832,12 +868,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public UnclaimedDraftCreateEmbeddedRequest metadata(Map metadata) { + public UnclaimedDraftCreateEmbeddedRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -865,12 +901,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public UnclaimedDraftCreateEmbeddedRequest requestingRedirectUrl(String requestingRedirectUrl) { + public UnclaimedDraftCreateEmbeddedRequest requestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; return this; } @@ -890,12 +926,12 @@ public String getRequestingRedirectUrl() { @JsonProperty(JSON_PROPERTY_REQUESTING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestingRedirectUrl(String requestingRedirectUrl) { + public void setRequestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; } - public UnclaimedDraftCreateEmbeddedRequest showPreview(Boolean showPreview) { + public UnclaimedDraftCreateEmbeddedRequest showPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; return this; } @@ -915,12 +951,12 @@ public Boolean getShowPreview() { @JsonProperty(JSON_PROPERTY_SHOW_PREVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowPreview(Boolean showPreview) { + public void setShowPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; } - public UnclaimedDraftCreateEmbeddedRequest showProgressStepper(Boolean showProgressStepper) { + public UnclaimedDraftCreateEmbeddedRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -940,12 +976,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public UnclaimedDraftCreateEmbeddedRequest signers(List signers) { + public UnclaimedDraftCreateEmbeddedRequest signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -973,12 +1009,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } - public UnclaimedDraftCreateEmbeddedRequest signingOptions(SubSigningOptions signingOptions) { + public UnclaimedDraftCreateEmbeddedRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -998,12 +1034,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public UnclaimedDraftCreateEmbeddedRequest signingRedirectUrl(String signingRedirectUrl) { + public UnclaimedDraftCreateEmbeddedRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -1023,12 +1059,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public UnclaimedDraftCreateEmbeddedRequest skipMeNow(Boolean skipMeNow) { + public UnclaimedDraftCreateEmbeddedRequest skipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; return this; } @@ -1048,12 +1084,12 @@ public Boolean getSkipMeNow() { @JsonProperty(JSON_PROPERTY_SKIP_ME_NOW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSkipMeNow(Boolean skipMeNow) { + public void setSkipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; } - public UnclaimedDraftCreateEmbeddedRequest subject(String subject) { + public UnclaimedDraftCreateEmbeddedRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -1073,12 +1109,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public UnclaimedDraftCreateEmbeddedRequest testMode(Boolean testMode) { + public UnclaimedDraftCreateEmbeddedRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -1098,12 +1134,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public UnclaimedDraftCreateEmbeddedRequest type(TypeEnum type) { + public UnclaimedDraftCreateEmbeddedRequest type(@jakarta.annotation.Nullable TypeEnum type) { this.type = type; return this; } @@ -1123,12 +1159,12 @@ public TypeEnum getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setType(TypeEnum type) { + public void setType(@jakarta.annotation.Nullable TypeEnum type) { this.type = type; } - public UnclaimedDraftCreateEmbeddedRequest usePreexistingFields(Boolean usePreexistingFields) { + public UnclaimedDraftCreateEmbeddedRequest usePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; return this; } @@ -1148,12 +1184,12 @@ public Boolean getUsePreexistingFields() { @JsonProperty(JSON_PROPERTY_USE_PREEXISTING_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsePreexistingFields(Boolean usePreexistingFields) { + public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; } - public UnclaimedDraftCreateEmbeddedRequest useTextTags(Boolean useTextTags) { + public UnclaimedDraftCreateEmbeddedRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; return this; } @@ -1173,12 +1209,12 @@ public Boolean getUseTextTags() { @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUseTextTags(Boolean useTextTags) { + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } - public UnclaimedDraftCreateEmbeddedRequest populateAutoFillFields(Boolean populateAutoFillFields) { + public UnclaimedDraftCreateEmbeddedRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; } @@ -1198,12 +1234,12 @@ public Boolean getPopulateAutoFillFields() { @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; } - public UnclaimedDraftCreateEmbeddedRequest expiresAt(Integer expiresAt) { + public UnclaimedDraftCreateEmbeddedRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -1223,7 +1259,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java index 7af776e..3e598be 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateEmbeddedWithTemplateRequest.java @@ -75,97 +75,127 @@ UnclaimedDraftCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS, UnclaimedDraftCreateEmbeddedWithTemplateRequest.JSON_PROPERTY_ALLOW_CCS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftCreateEmbeddedWithTemplateRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS = "requester_email_address"; + @jakarta.annotation.Nonnull private String requesterEmailAddress; public static final String JSON_PROPERTY_TEMPLATE_IDS = "template_ids"; + @jakarta.annotation.Nonnull private List templateIds = new ArrayList<>(); public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_ALLOW_REASSIGN = "allow_reassign"; + @jakarta.annotation.Nullable private Boolean allowReassign = false; public static final String JSON_PROPERTY_CCS = "ccs"; + @jakarta.annotation.Nullable private List ccs = null; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_EDITOR_OPTIONS = "editor_options"; + @jakarta.annotation.Nullable private SubEditorOptions editorOptions; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_FORCE_SIGNER_ROLES = "force_signer_roles"; + @jakarta.annotation.Nullable private Boolean forceSignerRoles = false; public static final String JSON_PROPERTY_FORCE_SUBJECT_MESSAGE = "force_subject_message"; + @jakarta.annotation.Nullable private Boolean forceSubjectMessage = false; public static final String JSON_PROPERTY_HOLD_REQUEST = "hold_request"; + @jakarta.annotation.Nullable private Boolean holdRequest = false; public static final String JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING = "is_for_embedded_signing"; + @jakarta.annotation.Nullable private Boolean isForEmbeddedSigning = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_PREVIEW_ONLY = "preview_only"; + @jakarta.annotation.Nullable private Boolean previewOnly = false; public static final String JSON_PROPERTY_REQUESTING_REDIRECT_URL = "requesting_redirect_url"; + @jakarta.annotation.Nullable private String requestingRedirectUrl; public static final String JSON_PROPERTY_SHOW_PREVIEW = "show_preview"; + @jakarta.annotation.Nullable private Boolean showPreview = false; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SKIP_ME_NOW = "skip_me_now"; + @jakarta.annotation.Nullable private Boolean skipMeNow = false; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_TITLE = "title"; + @jakarta.annotation.Nullable private String title; public static final String JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS = "populate_auto_fill_fields"; + @jakarta.annotation.Nullable private Boolean populateAutoFillFields = false; public static final String JSON_PROPERTY_ALLOW_CCS = "allow_ccs"; + @jakarta.annotation.Nullable private Boolean allowCcs = false; public UnclaimedDraftCreateEmbeddedWithTemplateRequest() { @@ -186,7 +216,7 @@ static public UnclaimedDraftCreateEmbeddedWithTemplateRequest init(HashMap data) ); } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest clientId(String clientId) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -206,12 +236,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest requesterEmailAddress(String requesterEmailAddress) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest requesterEmailAddress(@jakarta.annotation.Nonnull String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; return this; } @@ -231,12 +261,12 @@ public String getRequesterEmailAddress() { @JsonProperty(JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setRequesterEmailAddress(String requesterEmailAddress) { + public void setRequesterEmailAddress(@jakarta.annotation.Nonnull String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest templateIds(List templateIds) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest templateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; return this; } @@ -264,12 +294,12 @@ public List getTemplateIds() { @JsonProperty(JSON_PROPERTY_TEMPLATE_IDS) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setTemplateIds(List templateIds) { + public void setTemplateIds(@jakarta.annotation.Nonnull List templateIds) { this.templateIds = templateIds; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowDecline(Boolean allowDecline) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -289,12 +319,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowReassign(Boolean allowReassign) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; return this; } @@ -314,12 +344,12 @@ public Boolean getAllowReassign() { @JsonProperty(JSON_PROPERTY_ALLOW_REASSIGN) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowReassign(Boolean allowReassign) { + public void setAllowReassign(@jakarta.annotation.Nullable Boolean allowReassign) { this.allowReassign = allowReassign; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest ccs(List ccs) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest ccs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; return this; } @@ -347,12 +377,12 @@ public List getCcs() { @JsonProperty(JSON_PROPERTY_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcs(List ccs) { + public void setCcs(@jakarta.annotation.Nullable List ccs) { this.ccs = ccs; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest customFields(List customFields) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -380,12 +410,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest editorOptions(SubEditorOptions editorOptions) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest editorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; return this; } @@ -405,12 +435,12 @@ public SubEditorOptions getEditorOptions() { @JsonProperty(JSON_PROPERTY_EDITOR_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditorOptions(SubEditorOptions editorOptions) { + public void setEditorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest fieldOptions(SubFieldOptions fieldOptions) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -430,12 +460,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest files(List files) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -463,12 +493,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest fileUrls(List fileUrls) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -496,12 +526,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest forceSignerRoles(Boolean forceSignerRoles) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest forceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; return this; } @@ -521,12 +551,12 @@ public Boolean getForceSignerRoles() { @JsonProperty(JSON_PROPERTY_FORCE_SIGNER_ROLES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSignerRoles(Boolean forceSignerRoles) { + public void setForceSignerRoles(@jakarta.annotation.Nullable Boolean forceSignerRoles) { this.forceSignerRoles = forceSignerRoles; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest forceSubjectMessage(Boolean forceSubjectMessage) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest forceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; return this; } @@ -546,12 +576,12 @@ public Boolean getForceSubjectMessage() { @JsonProperty(JSON_PROPERTY_FORCE_SUBJECT_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setForceSubjectMessage(Boolean forceSubjectMessage) { + public void setForceSubjectMessage(@jakarta.annotation.Nullable Boolean forceSubjectMessage) { this.forceSubjectMessage = forceSubjectMessage; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest holdRequest(Boolean holdRequest) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest holdRequest(@jakarta.annotation.Nullable Boolean holdRequest) { this.holdRequest = holdRequest; return this; } @@ -571,12 +601,12 @@ public Boolean getHoldRequest() { @JsonProperty(JSON_PROPERTY_HOLD_REQUEST) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHoldRequest(Boolean holdRequest) { + public void setHoldRequest(@jakarta.annotation.Nullable Boolean holdRequest) { this.holdRequest = holdRequest; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest isForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest isForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; return this; } @@ -596,12 +626,12 @@ public Boolean getIsForEmbeddedSigning() { @JsonProperty(JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public void setIsForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest message(String message) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -621,12 +651,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest metadata(Map metadata) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -654,12 +684,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest previewOnly(Boolean previewOnly) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest previewOnly(@jakarta.annotation.Nullable Boolean previewOnly) { this.previewOnly = previewOnly; return this; } @@ -679,12 +709,12 @@ public Boolean getPreviewOnly() { @JsonProperty(JSON_PROPERTY_PREVIEW_ONLY) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPreviewOnly(Boolean previewOnly) { + public void setPreviewOnly(@jakarta.annotation.Nullable Boolean previewOnly) { this.previewOnly = previewOnly; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest requestingRedirectUrl(String requestingRedirectUrl) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest requestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; return this; } @@ -704,12 +734,12 @@ public String getRequestingRedirectUrl() { @JsonProperty(JSON_PROPERTY_REQUESTING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestingRedirectUrl(String requestingRedirectUrl) { + public void setRequestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest showPreview(Boolean showPreview) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest showPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; return this; } @@ -729,12 +759,12 @@ public Boolean getShowPreview() { @JsonProperty(JSON_PROPERTY_SHOW_PREVIEW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowPreview(Boolean showPreview) { + public void setShowPreview(@jakarta.annotation.Nullable Boolean showPreview) { this.showPreview = showPreview; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest showProgressStepper(Boolean showProgressStepper) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -754,12 +784,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest signers(List signers) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -787,12 +817,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest signingOptions(SubSigningOptions signingOptions) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -812,12 +842,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest signingRedirectUrl(String signingRedirectUrl) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -837,12 +867,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest skipMeNow(Boolean skipMeNow) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest skipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; return this; } @@ -862,12 +892,12 @@ public Boolean getSkipMeNow() { @JsonProperty(JSON_PROPERTY_SKIP_ME_NOW) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSkipMeNow(Boolean skipMeNow) { + public void setSkipMeNow(@jakarta.annotation.Nullable Boolean skipMeNow) { this.skipMeNow = skipMeNow; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest subject(String subject) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -887,12 +917,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest testMode(Boolean testMode) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -912,12 +942,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest title(String title) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest title(@jakarta.annotation.Nullable String title) { this.title = title; return this; } @@ -937,12 +967,12 @@ public String getTitle() { @JsonProperty(JSON_PROPERTY_TITLE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTitle(String title) { + public void setTitle(@jakarta.annotation.Nullable String title) { this.title = title; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest populateAutoFillFields(Boolean populateAutoFillFields) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest populateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; return this; } @@ -962,12 +992,12 @@ public Boolean getPopulateAutoFillFields() { @JsonProperty(JSON_PROPERTY_POPULATE_AUTO_FILL_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setPopulateAutoFillFields(Boolean populateAutoFillFields) { + public void setPopulateAutoFillFields(@jakarta.annotation.Nullable Boolean populateAutoFillFields) { this.populateAutoFillFields = populateAutoFillFields; } - public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowCcs(Boolean allowCcs) { + public UnclaimedDraftCreateEmbeddedWithTemplateRequest allowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; return this; } @@ -987,7 +1017,7 @@ public Boolean getAllowCcs() { @JsonProperty(JSON_PROPERTY_ALLOW_CCS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowCcs(Boolean allowCcs) { + public void setAllowCcs(@jakarta.annotation.Nullable Boolean allowCcs) { this.allowCcs = allowCcs; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java index 9df838f..58a7375 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateRequest.java @@ -71,16 +71,16 @@ UnclaimedDraftCreateRequest.JSON_PROPERTY_USE_TEXT_TAGS, UnclaimedDraftCreateRequest.JSON_PROPERTY_EXPIRES_AT }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftCreateRequest { /** * The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional. */ public enum TypeEnum { - SEND_DOCUMENT("send_document"), + SEND_DOCUMENT(String.valueOf("send_document")), - REQUEST_SIGNATURE("request_signature"); + REQUEST_SIGNATURE(String.valueOf("request_signature")); private String value; @@ -110,75 +110,99 @@ public static TypeEnum fromValue(String value) { } public static final String JSON_PROPERTY_TYPE = "type"; + @jakarta.annotation.Nonnull private TypeEnum type; public static final String JSON_PROPERTY_FILES = "files"; + @jakarta.annotation.Nullable private List files = null; public static final String JSON_PROPERTY_FILE_URLS = "file_urls"; + @jakarta.annotation.Nullable private List fileUrls = null; public static final String JSON_PROPERTY_ALLOW_DECLINE = "allow_decline"; + @jakarta.annotation.Nullable private Boolean allowDecline = false; public static final String JSON_PROPERTY_ATTACHMENTS = "attachments"; + @jakarta.annotation.Nullable private List attachments = null; public static final String JSON_PROPERTY_CC_EMAIL_ADDRESSES = "cc_email_addresses"; + @jakarta.annotation.Nullable private List ccEmailAddresses = null; public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nullable private String clientId; public static final String JSON_PROPERTY_CUSTOM_FIELDS = "custom_fields"; + @jakarta.annotation.Nullable private List customFields = null; public static final String JSON_PROPERTY_FIELD_OPTIONS = "field_options"; + @jakarta.annotation.Nullable private SubFieldOptions fieldOptions; public static final String JSON_PROPERTY_FORM_FIELD_GROUPS = "form_field_groups"; + @jakarta.annotation.Nullable private List formFieldGroups = null; public static final String JSON_PROPERTY_FORM_FIELD_RULES = "form_field_rules"; + @jakarta.annotation.Nullable private List formFieldRules = null; public static final String JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT = "form_fields_per_document"; + @jakarta.annotation.Nullable private List formFieldsPerDocument = null; public static final String JSON_PROPERTY_HIDE_TEXT_TAGS = "hide_text_tags"; + @jakarta.annotation.Nullable private Boolean hideTextTags = false; public static final String JSON_PROPERTY_MESSAGE = "message"; + @jakarta.annotation.Nullable private String message; public static final String JSON_PROPERTY_METADATA = "metadata"; + @jakarta.annotation.Nullable private Map metadata = null; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_SIGNERS = "signers"; + @jakarta.annotation.Nullable private List signers = null; public static final String JSON_PROPERTY_SIGNING_OPTIONS = "signing_options"; + @jakarta.annotation.Nullable private SubSigningOptions signingOptions; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_SUBJECT = "subject"; + @jakarta.annotation.Nullable private String subject; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public static final String JSON_PROPERTY_USE_PREEXISTING_FIELDS = "use_preexisting_fields"; + @jakarta.annotation.Nullable private Boolean usePreexistingFields = false; public static final String JSON_PROPERTY_USE_TEXT_TAGS = "use_text_tags"; + @jakarta.annotation.Nullable private Boolean useTextTags = false; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public UnclaimedDraftCreateRequest() { @@ -199,7 +223,7 @@ static public UnclaimedDraftCreateRequest init(HashMap data) throws Exception { ); } - public UnclaimedDraftCreateRequest type(TypeEnum type) { + public UnclaimedDraftCreateRequest type(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; return this; } @@ -219,12 +243,12 @@ public TypeEnum getType() { @JsonProperty(JSON_PROPERTY_TYPE) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setType(TypeEnum type) { + public void setType(@jakarta.annotation.Nonnull TypeEnum type) { this.type = type; } - public UnclaimedDraftCreateRequest files(List files) { + public UnclaimedDraftCreateRequest files(@jakarta.annotation.Nullable List files) { this.files = files; return this; } @@ -252,12 +276,12 @@ public List getFiles() { @JsonProperty(JSON_PROPERTY_FILES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFiles(List files) { + public void setFiles(@jakarta.annotation.Nullable List files) { this.files = files; } - public UnclaimedDraftCreateRequest fileUrls(List fileUrls) { + public UnclaimedDraftCreateRequest fileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; return this; } @@ -285,12 +309,12 @@ public List getFileUrls() { @JsonProperty(JSON_PROPERTY_FILE_URLS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFileUrls(List fileUrls) { + public void setFileUrls(@jakarta.annotation.Nullable List fileUrls) { this.fileUrls = fileUrls; } - public UnclaimedDraftCreateRequest allowDecline(Boolean allowDecline) { + public UnclaimedDraftCreateRequest allowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; return this; } @@ -310,12 +334,12 @@ public Boolean getAllowDecline() { @JsonProperty(JSON_PROPERTY_ALLOW_DECLINE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAllowDecline(Boolean allowDecline) { + public void setAllowDecline(@jakarta.annotation.Nullable Boolean allowDecline) { this.allowDecline = allowDecline; } - public UnclaimedDraftCreateRequest attachments(List attachments) { + public UnclaimedDraftCreateRequest attachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; return this; } @@ -343,12 +367,12 @@ public List getAttachments() { @JsonProperty(JSON_PROPERTY_ATTACHMENTS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAttachments(List attachments) { + public void setAttachments(@jakarta.annotation.Nullable List attachments) { this.attachments = attachments; } - public UnclaimedDraftCreateRequest ccEmailAddresses(List ccEmailAddresses) { + public UnclaimedDraftCreateRequest ccEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; return this; } @@ -376,12 +400,12 @@ public List getCcEmailAddresses() { @JsonProperty(JSON_PROPERTY_CC_EMAIL_ADDRESSES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCcEmailAddresses(List ccEmailAddresses) { + public void setCcEmailAddresses(@jakarta.annotation.Nullable List ccEmailAddresses) { this.ccEmailAddresses = ccEmailAddresses; } - public UnclaimedDraftCreateRequest clientId(String clientId) { + public UnclaimedDraftCreateRequest clientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; return this; } @@ -401,12 +425,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nullable String clientId) { this.clientId = clientId; } - public UnclaimedDraftCreateRequest customFields(List customFields) { + public UnclaimedDraftCreateRequest customFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; return this; } @@ -434,12 +458,12 @@ public List getCustomFields() { @JsonProperty(JSON_PROPERTY_CUSTOM_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setCustomFields(List customFields) { + public void setCustomFields(@jakarta.annotation.Nullable List customFields) { this.customFields = customFields; } - public UnclaimedDraftCreateRequest fieldOptions(SubFieldOptions fieldOptions) { + public UnclaimedDraftCreateRequest fieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; return this; } @@ -459,12 +483,12 @@ public SubFieldOptions getFieldOptions() { @JsonProperty(JSON_PROPERTY_FIELD_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFieldOptions(SubFieldOptions fieldOptions) { + public void setFieldOptions(@jakarta.annotation.Nullable SubFieldOptions fieldOptions) { this.fieldOptions = fieldOptions; } - public UnclaimedDraftCreateRequest formFieldGroups(List formFieldGroups) { + public UnclaimedDraftCreateRequest formFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; return this; } @@ -492,12 +516,12 @@ public List getFormFieldGroups() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_GROUPS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldGroups(List formFieldGroups) { + public void setFormFieldGroups(@jakarta.annotation.Nullable List formFieldGroups) { this.formFieldGroups = formFieldGroups; } - public UnclaimedDraftCreateRequest formFieldRules(List formFieldRules) { + public UnclaimedDraftCreateRequest formFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; return this; } @@ -525,12 +549,12 @@ public List getFormFieldRules() { @JsonProperty(JSON_PROPERTY_FORM_FIELD_RULES) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldRules(List formFieldRules) { + public void setFormFieldRules(@jakarta.annotation.Nullable List formFieldRules) { this.formFieldRules = formFieldRules; } - public UnclaimedDraftCreateRequest formFieldsPerDocument(List formFieldsPerDocument) { + public UnclaimedDraftCreateRequest formFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; return this; } @@ -558,12 +582,12 @@ public List getFormFieldsPerDocument() { @JsonProperty(JSON_PROPERTY_FORM_FIELDS_PER_DOCUMENT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setFormFieldsPerDocument(List formFieldsPerDocument) { + public void setFormFieldsPerDocument(@jakarta.annotation.Nullable List formFieldsPerDocument) { this.formFieldsPerDocument = formFieldsPerDocument; } - public UnclaimedDraftCreateRequest hideTextTags(Boolean hideTextTags) { + public UnclaimedDraftCreateRequest hideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; return this; } @@ -583,12 +607,12 @@ public Boolean getHideTextTags() { @JsonProperty(JSON_PROPERTY_HIDE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setHideTextTags(Boolean hideTextTags) { + public void setHideTextTags(@jakarta.annotation.Nullable Boolean hideTextTags) { this.hideTextTags = hideTextTags; } - public UnclaimedDraftCreateRequest message(String message) { + public UnclaimedDraftCreateRequest message(@jakarta.annotation.Nullable String message) { this.message = message; return this; } @@ -608,12 +632,12 @@ public String getMessage() { @JsonProperty(JSON_PROPERTY_MESSAGE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setMessage(String message) { + public void setMessage(@jakarta.annotation.Nullable String message) { this.message = message; } - public UnclaimedDraftCreateRequest metadata(Map metadata) { + public UnclaimedDraftCreateRequest metadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; return this; } @@ -641,12 +665,12 @@ public Map getMetadata() { @JsonProperty(JSON_PROPERTY_METADATA) @JsonInclude(content = JsonInclude.Include.ALWAYS, value = JsonInclude.Include.USE_DEFAULTS) - public void setMetadata(Map metadata) { + public void setMetadata(@jakarta.annotation.Nullable Map metadata) { this.metadata = metadata; } - public UnclaimedDraftCreateRequest showProgressStepper(Boolean showProgressStepper) { + public UnclaimedDraftCreateRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -666,12 +690,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public UnclaimedDraftCreateRequest signers(List signers) { + public UnclaimedDraftCreateRequest signers(@jakarta.annotation.Nullable List signers) { this.signers = signers; return this; } @@ -699,12 +723,12 @@ public List getSigners() { @JsonProperty(JSON_PROPERTY_SIGNERS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigners(List signers) { + public void setSigners(@jakarta.annotation.Nullable List signers) { this.signers = signers; } - public UnclaimedDraftCreateRequest signingOptions(SubSigningOptions signingOptions) { + public UnclaimedDraftCreateRequest signingOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; return this; } @@ -724,12 +748,12 @@ public SubSigningOptions getSigningOptions() { @JsonProperty(JSON_PROPERTY_SIGNING_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningOptions(SubSigningOptions signingOptions) { + public void setSigningOptions(@jakarta.annotation.Nullable SubSigningOptions signingOptions) { this.signingOptions = signingOptions; } - public UnclaimedDraftCreateRequest signingRedirectUrl(String signingRedirectUrl) { + public UnclaimedDraftCreateRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -749,12 +773,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public UnclaimedDraftCreateRequest subject(String subject) { + public UnclaimedDraftCreateRequest subject(@jakarta.annotation.Nullable String subject) { this.subject = subject; return this; } @@ -774,12 +798,12 @@ public String getSubject() { @JsonProperty(JSON_PROPERTY_SUBJECT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSubject(String subject) { + public void setSubject(@jakarta.annotation.Nullable String subject) { this.subject = subject; } - public UnclaimedDraftCreateRequest testMode(Boolean testMode) { + public UnclaimedDraftCreateRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -799,12 +823,12 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } - public UnclaimedDraftCreateRequest usePreexistingFields(Boolean usePreexistingFields) { + public UnclaimedDraftCreateRequest usePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; return this; } @@ -824,12 +848,12 @@ public Boolean getUsePreexistingFields() { @JsonProperty(JSON_PROPERTY_USE_PREEXISTING_FIELDS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUsePreexistingFields(Boolean usePreexistingFields) { + public void setUsePreexistingFields(@jakarta.annotation.Nullable Boolean usePreexistingFields) { this.usePreexistingFields = usePreexistingFields; } - public UnclaimedDraftCreateRequest useTextTags(Boolean useTextTags) { + public UnclaimedDraftCreateRequest useTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; return this; } @@ -849,12 +873,12 @@ public Boolean getUseTextTags() { @JsonProperty(JSON_PROPERTY_USE_TEXT_TAGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setUseTextTags(Boolean useTextTags) { + public void setUseTextTags(@jakarta.annotation.Nullable Boolean useTextTags) { this.useTextTags = useTextTags; } - public UnclaimedDraftCreateRequest expiresAt(Integer expiresAt) { + public UnclaimedDraftCreateRequest expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -874,7 +898,7 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java index b0477d0..48eabe4 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftCreateResponse.java @@ -40,13 +40,15 @@ UnclaimedDraftCreateResponse.JSON_PROPERTY_UNCLAIMED_DRAFT, UnclaimedDraftCreateResponse.JSON_PROPERTY_WARNINGS }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftCreateResponse { public static final String JSON_PROPERTY_UNCLAIMED_DRAFT = "unclaimed_draft"; + @jakarta.annotation.Nonnull private UnclaimedDraftResponse unclaimedDraft; public static final String JSON_PROPERTY_WARNINGS = "warnings"; + @jakarta.annotation.Nullable private List warnings = null; public UnclaimedDraftCreateResponse() { @@ -67,7 +69,7 @@ static public UnclaimedDraftCreateResponse init(HashMap data) throws Exception { ); } - public UnclaimedDraftCreateResponse unclaimedDraft(UnclaimedDraftResponse unclaimedDraft) { + public UnclaimedDraftCreateResponse unclaimedDraft(@jakarta.annotation.Nonnull UnclaimedDraftResponse unclaimedDraft) { this.unclaimedDraft = unclaimedDraft; return this; } @@ -87,12 +89,12 @@ public UnclaimedDraftResponse getUnclaimedDraft() { @JsonProperty(JSON_PROPERTY_UNCLAIMED_DRAFT) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setUnclaimedDraft(UnclaimedDraftResponse unclaimedDraft) { + public void setUnclaimedDraft(@jakarta.annotation.Nonnull UnclaimedDraftResponse unclaimedDraft) { this.unclaimedDraft = unclaimedDraft; } - public UnclaimedDraftCreateResponse warnings(List warnings) { + public UnclaimedDraftCreateResponse warnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; return this; } @@ -120,7 +122,7 @@ public List getWarnings() { @JsonProperty(JSON_PROPERTY_WARNINGS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setWarnings(List warnings) { + public void setWarnings(@jakarta.annotation.Nullable List warnings) { this.warnings = warnings; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftEditAndResendRequest.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftEditAndResendRequest.java index 5e4c639..62459fd 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftEditAndResendRequest.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftEditAndResendRequest.java @@ -43,31 +43,39 @@ UnclaimedDraftEditAndResendRequest.JSON_PROPERTY_SIGNING_REDIRECT_URL, UnclaimedDraftEditAndResendRequest.JSON_PROPERTY_TEST_MODE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftEditAndResendRequest { public static final String JSON_PROPERTY_CLIENT_ID = "client_id"; + @jakarta.annotation.Nonnull private String clientId; public static final String JSON_PROPERTY_EDITOR_OPTIONS = "editor_options"; + @jakarta.annotation.Nullable private SubEditorOptions editorOptions; public static final String JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING = "is_for_embedded_signing"; + @jakarta.annotation.Nullable private Boolean isForEmbeddedSigning; public static final String JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS = "requester_email_address"; + @jakarta.annotation.Nullable private String requesterEmailAddress; public static final String JSON_PROPERTY_REQUESTING_REDIRECT_URL = "requesting_redirect_url"; + @jakarta.annotation.Nullable private String requestingRedirectUrl; public static final String JSON_PROPERTY_SHOW_PROGRESS_STEPPER = "show_progress_stepper"; + @jakarta.annotation.Nullable private Boolean showProgressStepper = true; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode = false; public UnclaimedDraftEditAndResendRequest() { @@ -88,7 +96,7 @@ static public UnclaimedDraftEditAndResendRequest init(HashMap data) throws Excep ); } - public UnclaimedDraftEditAndResendRequest clientId(String clientId) { + public UnclaimedDraftEditAndResendRequest clientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; return this; } @@ -108,12 +116,12 @@ public String getClientId() { @JsonProperty(JSON_PROPERTY_CLIENT_ID) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setClientId(String clientId) { + public void setClientId(@jakarta.annotation.Nonnull String clientId) { this.clientId = clientId; } - public UnclaimedDraftEditAndResendRequest editorOptions(SubEditorOptions editorOptions) { + public UnclaimedDraftEditAndResendRequest editorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; return this; } @@ -133,12 +141,12 @@ public SubEditorOptions getEditorOptions() { @JsonProperty(JSON_PROPERTY_EDITOR_OPTIONS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEditorOptions(SubEditorOptions editorOptions) { + public void setEditorOptions(@jakarta.annotation.Nullable SubEditorOptions editorOptions) { this.editorOptions = editorOptions; } - public UnclaimedDraftEditAndResendRequest isForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public UnclaimedDraftEditAndResendRequest isForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; return this; } @@ -158,12 +166,12 @@ public Boolean getIsForEmbeddedSigning() { @JsonProperty(JSON_PROPERTY_IS_FOR_EMBEDDED_SIGNING) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIsForEmbeddedSigning(Boolean isForEmbeddedSigning) { + public void setIsForEmbeddedSigning(@jakarta.annotation.Nullable Boolean isForEmbeddedSigning) { this.isForEmbeddedSigning = isForEmbeddedSigning; } - public UnclaimedDraftEditAndResendRequest requesterEmailAddress(String requesterEmailAddress) { + public UnclaimedDraftEditAndResendRequest requesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; return this; } @@ -183,12 +191,12 @@ public String getRequesterEmailAddress() { @JsonProperty(JSON_PROPERTY_REQUESTER_EMAIL_ADDRESS) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequesterEmailAddress(String requesterEmailAddress) { + public void setRequesterEmailAddress(@jakarta.annotation.Nullable String requesterEmailAddress) { this.requesterEmailAddress = requesterEmailAddress; } - public UnclaimedDraftEditAndResendRequest requestingRedirectUrl(String requestingRedirectUrl) { + public UnclaimedDraftEditAndResendRequest requestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; return this; } @@ -208,12 +216,12 @@ public String getRequestingRedirectUrl() { @JsonProperty(JSON_PROPERTY_REQUESTING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestingRedirectUrl(String requestingRedirectUrl) { + public void setRequestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; } - public UnclaimedDraftEditAndResendRequest showProgressStepper(Boolean showProgressStepper) { + public UnclaimedDraftEditAndResendRequest showProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; return this; } @@ -233,12 +241,12 @@ public Boolean getShowProgressStepper() { @JsonProperty(JSON_PROPERTY_SHOW_PROGRESS_STEPPER) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setShowProgressStepper(Boolean showProgressStepper) { + public void setShowProgressStepper(@jakarta.annotation.Nullable Boolean showProgressStepper) { this.showProgressStepper = showProgressStepper; } - public UnclaimedDraftEditAndResendRequest signingRedirectUrl(String signingRedirectUrl) { + public UnclaimedDraftEditAndResendRequest signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -258,12 +266,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public UnclaimedDraftEditAndResendRequest testMode(Boolean testMode) { + public UnclaimedDraftEditAndResendRequest testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -283,7 +291,7 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } diff --git a/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java b/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java index a7212a2..b515280 100644 --- a/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java +++ b/src/main/java/com/dropbox/sign/model/UnclaimedDraftResponse.java @@ -40,25 +40,31 @@ UnclaimedDraftResponse.JSON_PROPERTY_EXPIRES_AT, UnclaimedDraftResponse.JSON_PROPERTY_TEST_MODE }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class UnclaimedDraftResponse { public static final String JSON_PROPERTY_SIGNATURE_REQUEST_ID = "signature_request_id"; + @jakarta.annotation.Nullable private String signatureRequestId; public static final String JSON_PROPERTY_CLAIM_URL = "claim_url"; + @jakarta.annotation.Nullable private String claimUrl; public static final String JSON_PROPERTY_SIGNING_REDIRECT_URL = "signing_redirect_url"; + @jakarta.annotation.Nullable private String signingRedirectUrl; public static final String JSON_PROPERTY_REQUESTING_REDIRECT_URL = "requesting_redirect_url"; + @jakarta.annotation.Nullable private String requestingRedirectUrl; public static final String JSON_PROPERTY_EXPIRES_AT = "expires_at"; + @jakarta.annotation.Nullable private Integer expiresAt; public static final String JSON_PROPERTY_TEST_MODE = "test_mode"; + @jakarta.annotation.Nullable private Boolean testMode; public UnclaimedDraftResponse() { @@ -79,7 +85,7 @@ static public UnclaimedDraftResponse init(HashMap data) throws Exception { ); } - public UnclaimedDraftResponse signatureRequestId(String signatureRequestId) { + public UnclaimedDraftResponse signatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; return this; } @@ -99,12 +105,12 @@ public String getSignatureRequestId() { @JsonProperty(JSON_PROPERTY_SIGNATURE_REQUEST_ID) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSignatureRequestId(String signatureRequestId) { + public void setSignatureRequestId(@jakarta.annotation.Nullable String signatureRequestId) { this.signatureRequestId = signatureRequestId; } - public UnclaimedDraftResponse claimUrl(String claimUrl) { + public UnclaimedDraftResponse claimUrl(@jakarta.annotation.Nullable String claimUrl) { this.claimUrl = claimUrl; return this; } @@ -124,12 +130,12 @@ public String getClaimUrl() { @JsonProperty(JSON_PROPERTY_CLAIM_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClaimUrl(String claimUrl) { + public void setClaimUrl(@jakarta.annotation.Nullable String claimUrl) { this.claimUrl = claimUrl; } - public UnclaimedDraftResponse signingRedirectUrl(String signingRedirectUrl) { + public UnclaimedDraftResponse signingRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; return this; } @@ -149,12 +155,12 @@ public String getSigningRedirectUrl() { @JsonProperty(JSON_PROPERTY_SIGNING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSigningRedirectUrl(String signingRedirectUrl) { + public void setSigningRedirectUrl(@jakarta.annotation.Nullable String signingRedirectUrl) { this.signingRedirectUrl = signingRedirectUrl; } - public UnclaimedDraftResponse requestingRedirectUrl(String requestingRedirectUrl) { + public UnclaimedDraftResponse requestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; return this; } @@ -174,12 +180,12 @@ public String getRequestingRedirectUrl() { @JsonProperty(JSON_PROPERTY_REQUESTING_REDIRECT_URL) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setRequestingRedirectUrl(String requestingRedirectUrl) { + public void setRequestingRedirectUrl(@jakarta.annotation.Nullable String requestingRedirectUrl) { this.requestingRedirectUrl = requestingRedirectUrl; } - public UnclaimedDraftResponse expiresAt(Integer expiresAt) { + public UnclaimedDraftResponse expiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; return this; } @@ -199,12 +205,12 @@ public Integer getExpiresAt() { @JsonProperty(JSON_PROPERTY_EXPIRES_AT) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setExpiresAt(Integer expiresAt) { + public void setExpiresAt(@jakarta.annotation.Nullable Integer expiresAt) { this.expiresAt = expiresAt; } - public UnclaimedDraftResponse testMode(Boolean testMode) { + public UnclaimedDraftResponse testMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; return this; } @@ -224,7 +230,7 @@ public Boolean getTestMode() { @JsonProperty(JSON_PROPERTY_TEST_MODE) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTestMode(Boolean testMode) { + public void setTestMode(@jakarta.annotation.Nullable Boolean testMode) { this.testMode = testMode; } diff --git a/src/main/java/com/dropbox/sign/model/WarningResponse.java b/src/main/java/com/dropbox/sign/model/WarningResponse.java index 8be1d98..d8e314c 100644 --- a/src/main/java/com/dropbox/sign/model/WarningResponse.java +++ b/src/main/java/com/dropbox/sign/model/WarningResponse.java @@ -36,13 +36,15 @@ WarningResponse.JSON_PROPERTY_WARNING_MSG, WarningResponse.JSON_PROPERTY_WARNING_NAME }) -@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0") +@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.12.0") @JsonIgnoreProperties(ignoreUnknown=true) public class WarningResponse { public static final String JSON_PROPERTY_WARNING_MSG = "warning_msg"; + @jakarta.annotation.Nonnull private String warningMsg; public static final String JSON_PROPERTY_WARNING_NAME = "warning_name"; + @jakarta.annotation.Nonnull private String warningName; public WarningResponse() { @@ -63,7 +65,7 @@ static public WarningResponse init(HashMap data) throws Exception { ); } - public WarningResponse warningMsg(String warningMsg) { + public WarningResponse warningMsg(@jakarta.annotation.Nonnull String warningMsg) { this.warningMsg = warningMsg; return this; } @@ -83,12 +85,12 @@ public String getWarningMsg() { @JsonProperty(JSON_PROPERTY_WARNING_MSG) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setWarningMsg(String warningMsg) { + public void setWarningMsg(@jakarta.annotation.Nonnull String warningMsg) { this.warningMsg = warningMsg; } - public WarningResponse warningName(String warningName) { + public WarningResponse warningName(@jakarta.annotation.Nonnull String warningName) { this.warningName = warningName; return this; } @@ -108,7 +110,7 @@ public String getWarningName() { @JsonProperty(JSON_PROPERTY_WARNING_NAME) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setWarningName(String warningName) { + public void setWarningName(@jakarta.annotation.Nonnull String warningName) { this.warningName = warningName; } diff --git a/templates/BeanValidationException.mustache b/templates/BeanValidationException.mustache index d8b0fa6..d551902 100644 --- a/templates/BeanValidationException.mustache +++ b/templates/BeanValidationException.mustache @@ -4,8 +4,8 @@ package {{invokerPackage}}; import java.util.Set; -import jakarta.validation.ConstraintViolation; -import jakarta.validation.ValidationException; +import {{javaxPackage}}.validation.ConstraintViolation; +import {{javaxPackage}}.validation.ValidationException; public class BeanValidationException extends ValidationException { /** diff --git a/templates/Configuration.mustache b/templates/Configuration.mustache index 8e9720e..61b08ab 100644 --- a/templates/Configuration.mustache +++ b/templates/Configuration.mustache @@ -6,7 +6,7 @@ package {{invokerPackage}}; public class Configuration { public static final String VERSION = "{{{artifactVersion}}}"; - private static ApiClient defaultApiClient = new ApiClient(); + private static volatile ApiClient defaultApiClient = new ApiClient(); /** * Get the default API client, which would be used when creating API diff --git a/templates/JSON.mustache b/templates/JSON.mustache index 1d0a813..5ef0266 100644 --- a/templates/JSON.mustache +++ b/templates/JSON.mustache @@ -31,9 +31,11 @@ import java.lang.reflect.Type; import java.text.DateFormat; import java.text.ParseException; import java.text.ParsePosition; +{{#jsr310}} import java.time.LocalDate; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; +{{/jsr310}} import java.util.Date; import java.util.Locale; import java.util.Map; diff --git a/templates/build.gradle.mustache b/templates/build.gradle.mustache index 06f9bd5..6557a7c 100644 --- a/templates/build.gradle.mustache +++ b/templates/build.gradle.mustache @@ -66,7 +66,7 @@ if(hasProperty('target') && target == 'android') { task sourcesJar(type: Jar) { from android.sourceSets.main.java.srcDirs - classifier = 'sources' + archiveClassifier = 'sources' } artifacts { @@ -97,12 +97,12 @@ if(hasProperty('target') && target == 'android') { } task sourcesJar(type: Jar, dependsOn: classes) { - classifier = 'sources' + archiveClassifier = 'sources' from sourceSets.main.allSource } task javadocJar(type: Jar, dependsOn: javadoc) { - classifier = 'javadoc' + archiveClassifier = 'javadoc' from javadoc.destinationDir } @@ -126,6 +126,9 @@ ext { jersey_version = "1.19.4" jodatime_version = "2.9.9" junit_version = "5.10.2" + {{#useReflectionEqualsHashCode}} + commons_lang3_version = "3.17.0" + {{/useReflectionEqualsHashCode}} } dependencies { @@ -148,6 +151,9 @@ dependencies { {{#useBeanValidation}} implementation "jakarta.validation:jakarta.validation-api:$bean_validation_version" {{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + implementation "org.apache.commons:commons-lang3:$commons_lang3_version" + {{/useReflectionEqualsHashCode}} testImplementation "junit:junit:$junit_version" testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_version" testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version" diff --git a/templates/javaBuilder.mustache b/templates/javaBuilder.mustache index c027300..4a0e102 100644 --- a/templates/javaBuilder.mustache +++ b/templates/javaBuilder.mustache @@ -14,9 +14,9 @@ public static class Builder {{#parentModel}}extends {{classname}}.Builder {{/par } {{#vars}} - public {{classname}}.Builder {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}}.Builder {{name}}({{#removeAnnotations}}{{{datatypeWithEnum}}}{{/removeAnnotations}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}} - this.instance.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}}); + this.instance.{{name}} = JsonNullable.<{{#removeAnnotations}}{{{datatypeWithEnum}}}{{/removeAnnotations}}>of({{name}}); {{/vendorExtensions.x-is-jackson-optional-nullable}} {{^vendorExtensions.x-is-jackson-optional-nullable}} this.instance.{{name}} = {{name}}; @@ -24,7 +24,7 @@ public static class Builder {{#parentModel}}extends {{classname}}.Builder {{/par return this; } {{#vendorExtensions.x-is-jackson-optional-nullable}} - public {{classname}}.Builder {{name}}(JsonNullable<{{{datatypeWithEnum}}}> {{name}}) { + public {{classname}}.Builder {{name}}(JsonNullable<{{#removeAnnotations}}{{{datatypeWithEnum}}}{{/removeAnnotations}}> {{name}}) { this.instance.{{name}} = {{name}}; return this; } @@ -32,12 +32,12 @@ public static class Builder {{#parentModel}}extends {{classname}}.Builder {{/par {{/vars}} {{#parentVars}} - public {{classname}}.Builder {{name}}({{{datatypeWithEnum}}} {{name}}) { // inherited: {{isInherited}} + public {{classname}}.Builder {{name}}({{#removeAnnotations}}{{{datatypeWithEnum}}}{{/removeAnnotations}} {{name}}) { // inherited: {{isInherited}} super.{{name}}({{name}}); return this; } {{#vendorExtensions.x-is-jackson-optional-nullable}} - public {{classname}}.Builder {{name}}(JsonNullable<{{{datatypeWithEnum}}}> {{name}}) { + public {{classname}}.Builder {{name}}(JsonNullable<{{#removeAnnotations}}{{{datatypeWithEnum}}}{{/removeAnnotations}}> {{name}}) { this.instance.{{name}} = {{name}}; return this; } diff --git a/templates/libraries/apache-httpclient/ApiClient.mustache b/templates/libraries/apache-httpclient/ApiClient.mustache index a00c6dc..854d8a6 100644 --- a/templates/libraries/apache-httpclient/ApiClient.mustache +++ b/templates/libraries/apache-httpclient/ApiClient.mustache @@ -137,7 +137,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { public ApiClient(CloseableHttpClient httpClient) { objectMapper = new ObjectMapper(); objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); - objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); objectMapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false); objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); objectMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING); @@ -444,7 +444,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { * @param userAgent User agent * @return API client */ - public ApiClient setUserAgent(String userAgent) { + public final ApiClient setUserAgent(String userAgent) { addDefaultHeader("User-Agent", userAgent); return this; } @@ -622,7 +622,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { * @param value The value of the parameter. * @return A list of {@code Pair} objects. */ - public List parameterToPairs(String collectionFormat, String name, Collection value) { + public List parameterToPairs(String collectionFormat, String name, Collection value) { List params = new ArrayList(); // preconditions diff --git a/templates/libraries/apache-httpclient/api.mustache b/templates/libraries/apache-httpclient/api.mustache index 27b4564..cfcd9f0 100644 --- a/templates/libraries/apache-httpclient/api.mustache +++ b/templates/libraries/apache-httpclient/api.mustache @@ -24,8 +24,8 @@ import java.util.Map; import java.util.StringJoiner; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{>generatedAnnotation}} @@ -99,7 +99,7 @@ public class {{classname}} extends BaseApi { {{/required}}{{/allParams}} // create path and map variables String localVarPath = "{{{path}}}"{{#pathParams}} - .replaceAll("\\{" + "{{baseName}}" + "\\}", apiClient.escapeString({{{paramName}}}.toString())){{/pathParams}}; + .replaceAll("\\{" + "{{baseName}}" + "\\}", apiClient.escapeString(apiClient.parameterToString({{{paramName}}}))){{/pathParams}}; StringJoiner localVarQueryStringJoiner = new StringJoiner("&"); String localVarQueryParameterBaseName; diff --git a/templates/libraries/apache-httpclient/api_test.mustache b/templates/libraries/apache-httpclient/api_test.mustache index b4393ea..05b2bf9 100644 --- a/templates/libraries/apache-httpclient/api_test.mustache +++ b/templates/libraries/apache-httpclient/api_test.mustache @@ -17,8 +17,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/apache-httpclient/pom.mustache b/templates/libraries/apache-httpclient/pom.mustache index 74a70a3..3a506ca 100644 --- a/templates/libraries/apache-httpclient/pom.mustache +++ b/templates/libraries/apache-httpclient/pom.mustache @@ -358,13 +358,12 @@ {{/openApiNullable}} {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} 5.10.2 diff --git a/templates/libraries/feign/ApiClient.mustache b/templates/libraries/feign/ApiClient.mustache index 9a5b9bc..f744eec 100644 --- a/templates/libraries/feign/ApiClient.mustache +++ b/templates/libraries/feign/ApiClient.mustache @@ -173,7 +173,12 @@ public class ApiClient { ObjectMapper objectMapper = new ObjectMapper(); objectMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING); objectMapper.enable(DeserializationFeature.READ_ENUMS_USING_TO_STRING); + {{#failOnUnknownProperties}} + objectMapper.enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); + {{/failOnUnknownProperties}} + {{^failOnUnknownProperties}} objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES); + {{/failOnUnknownProperties}} objectMapper.disable(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE); objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); objectMapper.setDateFormat(new RFC3339DateFormat()); diff --git a/templates/libraries/feign/README.mustache b/templates/libraries/feign/README.mustache index fed3cbe..c3d9487 100644 --- a/templates/libraries/feign/README.mustache +++ b/templates/libraries/feign/README.mustache @@ -32,7 +32,7 @@ After the client library is installed/deployed, you can use it in your Maven pro ``` -And to use the api you can follow the examples bellow: +And to use the api you can follow the examples below: ```java diff --git a/templates/libraries/feign/api.mustache b/templates/libraries/feign/api.mustache index af05d65..d67de9a 100644 --- a/templates/libraries/feign/api.mustache +++ b/templates/libraries/feign/api.mustache @@ -15,8 +15,8 @@ import java.util.HashMap; import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import feign.*; @@ -47,8 +47,8 @@ public interface {{classname}} extends ApiClient.Api { {{/isDeprecated}} @RequestLine("{{httpMethod}} {{{path}}}{{#hasQueryParams}}?{{/hasQueryParams}}{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{^-last}}&{{/-last}}{{/queryParams}}") @Headers({ -{{#vendorExtensions.x-content-type}} "Content-Type: {{vendorExtensions.x-content-type}}", -{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{.}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} +{{#vendorExtensions.x-content-type}} "Content-Type: {{{vendorExtensions.x-content-type}}}", +{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{{.}}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} "{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{^-last}}, {{/-last}}{{/headerParams}} }) @@ -77,8 +77,8 @@ public interface {{classname}} extends ApiClient.Api { {{/isDeprecated}} @RequestLine("{{httpMethod}} {{{path}}}{{#hasQueryParams}}?{{/hasQueryParams}}{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{^-last}}&{{/-last}}{{/queryParams}}") @Headers({ -{{#vendorExtensions.x-content-type}} "Content-Type: {{vendorExtensions.x-content-type}}", -{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{.}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} +{{#vendorExtensions.x-content-type}} "Content-Type: {{{vendorExtensions.x-content-type}}}", +{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{{.}}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} "{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{^-last}}, {{/-last}}{{/headerParams}} }) @@ -122,8 +122,8 @@ public interface {{classname}} extends ApiClient.Api { {{/isDeprecated}} @RequestLine("{{httpMethod}} {{{path}}}?{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{^-last}}&{{/-last}}{{/queryParams}}") @Headers({ -{{#vendorExtensions.x-content-type}} "Content-Type: {{vendorExtensions.x-content-type}}", -{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{.}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} +{{#vendorExtensions.x-content-type}} "Content-Type: {{{vendorExtensions.x-content-type}}}", +{{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{{.}}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} "{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{^-last}}, {{/-last}}{{/headerParams}} }) @@ -162,8 +162,8 @@ public interface {{classname}} extends ApiClient.Api { {{/isDeprecated}} @RequestLine("{{httpMethod}} {{{path}}}?{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{^-last}}&{{/-last}}{{/queryParams}}") @Headers({ - {{#vendorExtensions.x-content-type}} "Content-Type: {{vendorExtensions.x-content-type}}", - {{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{.}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} + {{#vendorExtensions.x-content-type}} "Content-Type: {{{vendorExtensions.x-content-type}}}", + {{/vendorExtensions.x-content-type}} "Accept: {{#vendorExtensions.x-accepts}}{{{.}}}{{^-last}},{{/-last}}{{/vendorExtensions.x-accepts}}",{{#headerParams}} "{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{^-last}}, {{/-last}}{{/headerParams}} }) diff --git a/templates/libraries/feign/api_test.mustache b/templates/libraries/feign/api_test.mustache index 1db8411..6252112 100644 --- a/templates/libraries/feign/api_test.mustache +++ b/templates/libraries/feign/api_test.mustache @@ -14,8 +14,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/feign/build.gradle.mustache b/templates/libraries/feign/build.gradle.mustache index 8af1cb1..2b4e034 100644 --- a/templates/libraries/feign/build.gradle.mustache +++ b/templates/libraries/feign/build.gradle.mustache @@ -114,6 +114,9 @@ ext { feign_form_version = "3.8.0" junit_version = "5.7.0" scribejava_version = "8.0.0" + {{#useReflectionEqualsHashCode}} + commons_lang3_version = "3.17.0" + {{/useReflectionEqualsHashCode}} } dependencies { @@ -127,9 +130,9 @@ dependencies { implementation "io.github.openfeign:feign-okhttp:$feign_version" implementation "io.github.openfeign.form:feign-form:$feign_form_version" {{#jackson}} - {{#joda}} + {{#joda}} implementation "com.fasterxml.jackson.datatype:jackson-datatype-joda:$jackson_version" - {{/joda}} + {{/joda}} implementation "com.fasterxml.jackson.core:jackson-core:$jackson_version" implementation "com.fasterxml.jackson.core:jackson-annotations:$jackson_version" implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_databind_version" @@ -142,11 +145,14 @@ dependencies { implementation "com.github.scribejava:scribejava-core:$scribejava_version" implementation "com.brsanthu:migbase64:2.2" implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" + {{#useReflectionEqualsHashCode}} + implementation "org.apache.commons:commons-lang3:$commons_lang3_version" + {{/useReflectionEqualsHashCode}} testImplementation "org.junit.jupiter:junit-jupiter:$junit_version" testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version" testImplementation "org.junit.jupiter:junit-jupiter-params:$junit_version" testImplementation "com.github.tomakehurst:wiremock-jre8:2.35.1" testImplementation "org.hamcrest:hamcrest:2.2" - testImplementation "commons-io:commons-io:2.8.0" + testImplementation "commons-io:commons-io:2.16.1" testImplementation "ch.qos.logback:logback-classic:1.2.3" } diff --git a/templates/libraries/feign/build.sbt.mustache b/templates/libraries/feign/build.sbt.mustache index 9af32c2..1a24b99 100644 --- a/templates/libraries/feign/build.sbt.mustache +++ b/templates/libraries/feign/build.sbt.mustache @@ -28,11 +28,14 @@ lazy val root = (project in file(".")). "com.github.scribejava" % "scribejava-core" % "8.0.0" % "compile", "com.brsanthu" % "migbase64" % "2.2" % "compile", "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile", +{{#useReflectionEqualsHashCode}} + "org.apache.commons" % "commons-lang3" % "3.17.0" % "compile", +{{/useReflectionEqualsHashCode}} "org.junit.jupiter" % "junit-jupiter" % "5.7.0" % "test", "org.junit.jupiter" % "junit-jupiter-params" % "5.7.0" % "test", "com.github.tomakehurst" % "wiremock-jre8" % "2.35.1" % "test", "org.hamcrest" % "hamcrest" % "2.2" % "test", - "commons-io" % "commons-io" % "2.8.0" % "test", + "commons-io" % "commons-io" % "2.16.1" % "test", "com.novocode" % "junit-interface" % "0.10" % "test" ) ) diff --git a/templates/libraries/feign/model.mustache b/templates/libraries/feign/model.mustache index 5fa9bca..108748f 100644 --- a/templates/libraries/feign/model.mustache +++ b/templates/libraries/feign/model.mustache @@ -59,8 +59,8 @@ import android.os.Parcelable; import android.os.Parcel; {{/parcelableModel}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} import org.hibernate.validator.constraints.*; diff --git a/templates/libraries/feign/pojo.mustache b/templates/libraries/feign/pojo.mustache index fe97e3b..76f119e 100644 --- a/templates/libraries/feign/pojo.mustache +++ b/templates/libraries/feign/pojo.mustache @@ -72,6 +72,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{/isContainer}} {{/vendorExtensions.x-is-jackson-optional-nullable}} {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{>nullable_var_annotations}} {{#isContainer}} private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; {{/isContainer}} @@ -113,7 +114,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#vars}} {{^isReadOnly}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}});{{/vendorExtensions.x-is-jackson-optional-nullable}} {{^vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = {{name}};{{/vendorExtensions.x-is-jackson-optional-nullable}} return this; @@ -189,17 +190,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#jsonb}} @JsonbProperty("{{baseName}}") {{/jsonb}} @@ -246,7 +237,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{^isReadOnly}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} -{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}} this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}}); {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -272,7 +263,8 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens }{{#hasVars}} {{classname}} {{classVarName}} = ({{classname}}) o; return {{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}equalsNullable(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#isByteArray}}Arrays{{/isByteArray}}{{^isByteArray}}Objects{{/isByteArray}}.equals(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}} && - {{/-last}}{{/vars}}{{#parent}} && + {{/-last}}{{/vars}}{{#additionalPropertiesType}} && + Objects.equals(this.additionalProperties, {{classVarName}}.additionalProperties){{/additionalPropertiesType}}{{#parent}} && super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}} return {{#parent}}super.equals(o){{/parent}}{{^parent}}true{{/parent}};{{/hasVars}} {{/useReflectionEqualsHashCode}} @@ -288,7 +280,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens return HashCodeBuilder.reflectionHashCode(this); {{/useReflectionEqualsHashCode}} {{^useReflectionEqualsHashCode}} - return Objects.hash({{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}hashCodeNullable({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{^isByteArray}}{{name}}{{/isByteArray}}{{#isByteArray}}Arrays.hashCode({{name}}){{/isByteArray}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}}, {{/-last}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}}); + return Objects.hash({{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}hashCodeNullable({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{^isByteArray}}{{name}}{{/isByteArray}}{{#isByteArray}}Arrays.hashCode({{name}}){{/isByteArray}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}}, {{/-last}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}}{{#additionalPropertiesType}}, additionalProperties{{/additionalPropertiesType}}); {{/useReflectionEqualsHashCode}} }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} @@ -309,6 +301,9 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#vars}} sb.append(" {{name}}: ").append({{#isPassword}}"*"{{/isPassword}}{{^isPassword}}toIndentedString({{name}}){{/isPassword}}).append("\n"); {{/vars}} + {{#additionalPropertiesType}} + sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); + {{/additionalPropertiesType}} sb.append("}"); return sb.toString(); } diff --git a/templates/libraries/feign/pom.mustache b/templates/libraries/feign/pom.mustache index 9be4a09..c915ea0 100644 --- a/templates/libraries/feign/pom.mustache +++ b/templates/libraries/feign/pom.mustache @@ -345,6 +345,14 @@ provided {{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons-lang3-version} + + {{/useReflectionEqualsHashCode}} @@ -403,13 +411,15 @@ {{/openApiNullable}} {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + 3.17.0 + {{/useReflectionEqualsHashCode}} 5.10.0 1.0.0 8.3.3 diff --git a/templates/libraries/google-api-client/ApiClient.mustache b/templates/libraries/google-api-client/ApiClient.mustache index 03c44a8..7d3e50f 100644 --- a/templates/libraries/google-api-client/ApiClient.mustache +++ b/templates/libraries/google-api-client/ApiClient.mustache @@ -34,7 +34,12 @@ public class ApiClient { // A reasonable default object mapper. Client can pass in a chosen ObjectMapper anyway, this is just for reasonable defaults. private static ObjectMapper createDefaultObjectMapper() { ObjectMapper objectMapper = new ObjectMapper() + {{#failOnUnknownProperties}} + .enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + {{/failOnUnknownProperties}} + {{^failOnUnknownProperties}} .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + {{/failOnUnknownProperties}} .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .setDateFormat(new RFC3339DateFormat()); {{#joda}} diff --git a/templates/libraries/jersey2/ApiClient.mustache b/templates/libraries/jersey2/ApiClient.mustache index 09563af..218f545 100644 --- a/templates/libraries/jersey2/ApiClient.mustache +++ b/templates/libraries/jersey2/ApiClient.mustache @@ -988,24 +988,10 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { if (contentType.startsWith("multipart/form-data")) { MultiPart multiPart = new MultiPart(); for (Entry param: formParams.entrySet()) { - if (param.getValue() instanceof File) { - File file = (File) param.getValue(); - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()) - .fileName(file.getName()).size(file.length()).build(); - - // Attempt to probe the content type for the file so that the form part is more correctly - // and precisely identified, but fall back to application/octet-stream if that fails. - MediaType type; - try { - type = MediaType.valueOf(Files.probeContentType(file.toPath())); - } catch (IOException | IllegalArgumentException e) { - type = MediaType.APPLICATION_OCTET_STREAM_TYPE; - } - - multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + if (param.getValue() instanceof Iterable) { + ((Iterable)param.getValue()).forEach(v -> addParamToMultipart(v, param.getKey(), multiPart)); } else { - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()).build(); - multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(param.getValue()))); + addParamToMultipart(param.getValue(), param.getKey(), multiPart); } } entity = Entity.entity(multiPart, MediaType.MULTIPART_FORM_DATA_TYPE); @@ -1034,6 +1020,36 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { return entity; } + /** + * Adds the object with the provided key to the MultiPart. + * Based on the object type sets Content-Disposition and Content-Type. + * + * @param obj Object + * @param key Key of the object + * @param multiPart MultiPart to add the form param to + */ + private void addParamToMultipart(Object value, String key, MultiPart multiPart) { + if (value instanceof File) { + File file = (File) value; + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key) + .fileName(file.getName()).size(file.length()).build(); + + // Attempt to probe the content type for the file so that the form part is more correctly + // and precisely identified, but fall back to application/octet-stream if that fails. + MediaType type; + try { + type = MediaType.valueOf(Files.probeContentType(file.toPath())); + } catch (IOException | IllegalArgumentException e) { + type = MediaType.APPLICATION_OCTET_STREAM_TYPE; + } + + multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + } else { + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key).build(); + multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(value))); + } + } + /** * Serialize the given Java object into string according the given * Content-Type (only JSON, HTTP form is supported for now). @@ -1340,7 +1356,11 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { } else if ("PUT".equals(method)) { response = invocationBuilder.put(entity); } else if ("DELETE".equals(method)) { - response = invocationBuilder.method("DELETE", entity); + if ("".equals(entity.getEntity())) { + response = invocationBuilder.method("DELETE"); + } else { + response = invocationBuilder.method("DELETE", entity); + } } else if ("PATCH".equals(method)) { response = invocationBuilder.method("PATCH", entity); } else { diff --git a/templates/libraries/jersey2/JSON.mustache b/templates/libraries/jersey2/JSON.mustache index 97cee63..615367b 100644 --- a/templates/libraries/jersey2/JSON.mustache +++ b/templates/libraries/jersey2/JSON.mustache @@ -12,9 +12,6 @@ import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; {{#joda}} import com.fasterxml.jackson.datatype.joda.JodaModule; {{/joda}} -{{#models.0}} -import {{modelPackage}}.*; -{{/models.0}} import java.text.DateFormat; import java.util.HashMap; @@ -32,7 +29,7 @@ public class JSON implements ContextResolver { mapper = JsonMapper.builder() .serializationInclusion(JsonInclude.Include.NON_NULL) .configure(MapperFeature.ALLOW_COERCION_OF_SCALARS, false) - .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true) + .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}) .configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, true) .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING) diff --git a/templates/libraries/jersey2/anyof_model.mustache b/templates/libraries/jersey2/anyof_model.mustache index d480667..46c2cdc 100644 --- a/templates/libraries/jersey2/anyof_model.mustache +++ b/templates/libraries/jersey2/anyof_model.mustache @@ -68,10 +68,23 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return ret; } {{/discriminator}} + {{#composedSchemas}} {{#anyOf}} - // deserialize {{{.}}} + // deserialize {{{dataType}}}{{#isNullable}} (nullable){{/isNullable}} try { - deserialized = tree.traverse(jp.getCodec()).readValueAs({{{.}}}.class); + {{^isArray}} + {{^isMap}} + deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class); + {{/isMap}} + {{/isArray}} + {{#isArray}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isArray}} + {{#isMap}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isMap}} {{classname}} ret = new {{classname}}(); ret.setActualInstance(deserialized); return ret; @@ -81,6 +94,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/anyOf}} + {{/composedSchemas}} throw new IOException(String.format("Failed deserialization for {{classname}}: no match found")); } @@ -119,13 +133,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties); } {{/additionalPropertiesType}} + {{#composedSchemas}} {{#anyOf}} - public {{classname}}({{{.}}} o) { + {{^vendorExtensions.x-duplicated-data-type}} + public {{classname}}({{{baseType}}} o) { super("anyOf", {{#isNullable}}Boolean.TRUE{{/isNullable}}{{^isNullable}}Boolean.FALSE{{/isNullable}}); setActualInstance(o); } + {{/vendorExtensions.x-duplicated-data-type}} {{/anyOf}} + {{/composedSchemas}} static { {{#anyOf}} schemas.put("{{{.}}}", new GenericType<{{{.}}}>() { @@ -165,13 +183,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/isNullable}} + {{#composedSchemas}} {{#anyOf}} - if (JSON.isInstanceOf({{{.}}}.class, instance, new HashSet<>())) { + {{^vendorExtensions.x-duplicated-data-type}} + if (JSON.isInstanceOf({{{baseType}}}.class, instance, new HashSet<>())) { super.setActualInstance(instance); return; } + {{/vendorExtensions.x-duplicated-data-type}} {{/anyOf}} + {{/composedSchemas}} throw new RuntimeException("Invalid instance type. Must be {{#anyOf}}{{{.}}}{{^-last}}, {{/-last}}{{/anyOf}}"); } @@ -186,17 +208,21 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return super.getActualInstance(); } + {{#composedSchemas}} {{#anyOf}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** - * Get the actual instance of `{{{.}}}`. If the actual instance is not `{{{.}}}`, + * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. * - * @return The actual instance of `{{{.}}}` - * @throws ClassCastException if the instance is not `{{{.}}}` + * @return The actual instance of `{{{dataType}}}` + * @throws ClassCastException if the instance is not `{{{dataType}}}` */ - public {{{.}}} get{{{.}}}() throws ClassCastException { - return ({{{.}}})super.getActualInstance(); + public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { + return ({{{dataType}}})super.getActualInstance(); } + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/anyOf}} + {{/composedSchemas}} } diff --git a/templates/libraries/jersey2/api.mustache b/templates/libraries/jersey2/api.mustache index 8d3e62f..62edfeb 100644 --- a/templates/libraries/jersey2/api.mustache +++ b/templates/libraries/jersey2/api.mustache @@ -12,8 +12,8 @@ import {{javaxPackage}}.ws.rs.core.GenericType; {{/imports}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import java.util.ArrayList; @@ -67,7 +67,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @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 -
+
+ {{#responses}} @@ -101,7 +102,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -195,7 +197,7 @@ public class {{classname}} { {{#returnType}} GenericType<{{{returnType}}}> localVarReturnType = new GenericType<{{{returnType}}}>() {}; {{/returnType}} - return apiClient.invokeAPI("{{classname}}.{{operationId}}", {{#hasPathParams}}localVarPath{{/hasPathParams}}{{^hasPathParams}}"{{path}}"{{/hasPathParams}}, "{{httpMethod}}", {{#queryParams}}{{#-first}}localVarQueryParams{{/-first}}{{/queryParams}}{{^queryParams}}new ArrayList<>(){{/queryParams}}, {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}}, + return apiClient.invokeAPI("{{classname}}.{{operationId}}", {{#hasPathParams}}localVarPath{{/hasPathParams}}{{^hasPathParams}}"{{{path}}}"{{/hasPathParams}}, "{{httpMethod}}", {{#queryParams}}{{#-first}}localVarQueryParams{{/-first}}{{/queryParams}}{{^queryParams}}new ArrayList<>(){{/queryParams}}, {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}}, {{#headerParams}}{{#-first}}localVarHeaderParams{{/-first}}{{/headerParams}}{{^headerParams}}new LinkedHashMap<>(){{/headerParams}}, {{#cookieParams}}{{#-first}}localVarCookieParams{{/-first}}{{/cookieParams}}{{^cookieParams}}new LinkedHashMap<>(){{/cookieParams}}, {{#formParams}}{{#-first}}localVarFormParams{{/-first}}{{/formParams}}{{^formParams}}new LinkedHashMap<>(){{/formParams}}, localVarAccept, localVarContentType, {{#hasAuthMethods}}localVarAuthNames{{/hasAuthMethods}}{{^hasAuthMethods}}null{{/hasAuthMethods}}, {{#returnType}}localVarReturnType{{/returnType}}{{^returnType}}null{{/returnType}}, {{#bodyParam}}{{#isNullable}}true{{/isNullable}}{{^isNullable}}false{{/isNullable}}{{/bodyParam}}{{^bodyParam}}false{{/bodyParam}}); } @@ -232,7 +234,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -252,7 +255,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} diff --git a/templates/libraries/jersey2/api_test.mustache b/templates/libraries/jersey2/api_test.mustache index 7b8214b..926ba0a 100644 --- a/templates/libraries/jersey2/api_test.mustache +++ b/templates/libraries/jersey2/api_test.mustache @@ -17,8 +17,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/jersey2/build.gradle.mustache b/templates/libraries/jersey2/build.gradle.mustache index a9ab962..ca6ae2a 100644 --- a/templates/libraries/jersey2/build.gradle.mustache +++ b/templates/libraries/jersey2/build.gradle.mustache @@ -116,6 +116,9 @@ ext { {{#hasHttpSignatureMethods}} tomitribe_http_signatures_version = "1.7" {{/hasHttpSignatureMethods}} + {{#useReflectionEqualsHashCode}} + commons_lang3_version = "3.17.0" + {{/useReflectionEqualsHashCode}} } dependencies { @@ -146,6 +149,9 @@ dependencies { {{#useBeanValidation}} implementation "jakarta.validation:jakarta.validation-api:$bean_validation_version" {{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + implementation "org.apache.commons:commons-lang3:$commons_lang3_version" + {{/useReflectionEqualsHashCode}} testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_version" testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version" } diff --git a/templates/libraries/jersey2/build.sbt.mustache b/templates/libraries/jersey2/build.sbt.mustache index d055cf3..fa3ead6 100644 --- a/templates/libraries/jersey2/build.sbt.mustache +++ b/templates/libraries/jersey2/build.sbt.mustache @@ -33,6 +33,9 @@ lazy val root = (project in file(".")). "org.tomitribe" % "tomitribe-http-signatures" % "1.7" % "compile", {{/hasHttpSignatureMethods}} "jakarta.annotation" % "jakarta.annotation-api" % "1.3.5" % "compile", + {{#useReflectionEqualsHashCode}} + "org.apache.commons" % "commons-lang3" % "3.17.0" % "compile", + {{/useReflectionEqualsHashCode}} "org.junit.jupiter" % "junit-jupiter-api" % "5.8.2" % "test" ) ) diff --git a/templates/libraries/jersey2/model.mustache b/templates/libraries/jersey2/model.mustache index 1904ee4..2758278 100644 --- a/templates/libraries/jersey2/model.mustache +++ b/templates/libraries/jersey2/model.mustache @@ -42,8 +42,8 @@ import android.os.Parcelable; import android.os.Parcel; {{/parcelableModel}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} import org.hibernate.validator.constraints.*; diff --git a/templates/libraries/jersey2/oneof_model.mustache b/templates/libraries/jersey2/oneof_model.mustache index 09906d7..5b60d07 100644 --- a/templates/libraries/jersey2/oneof_model.mustache +++ b/templates/libraries/jersey2/oneof_model.mustache @@ -112,7 +112,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im attemptParsing |= (token == JsonToken.VALUE_NUMBER_FLOAT); {{/isDecimal}} {{#isBoolean}} - attemptParsing |= (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE); {{/isBoolean}} {{#isNullable}} attemptParsing |= (token == JsonToken.VALUE_NULL); @@ -120,7 +120,13 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/isPrimitiveType}} if (attemptParsing) { + {{#isMap}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isMap}} + {{^isMap}} deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class); + {{/isMap}} // TODO: there is no validation against JSON schema constraints // (min, max, enum, pattern...), this does not perform a strict JSON // validation, which means the 'match' count may be higher than it should be. @@ -266,6 +272,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{#composedSchemas}} {{#oneOf}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. @@ -273,17 +280,11 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im * @return The actual instance of `{{{dataType}}}` * @throws ClassCastException if the instance is not `{{{dataType}}}` */ - {{^isArray}} - public {{{dataType}}} get{{{dataType}}}() throws ClassCastException { + public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { return ({{{dataType}}})super.getActualInstance(); } - {{/isArray}} - {{#isArray}} - public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { - return ({{{dataType}}})super.getActualInstance(); - } - {{/isArray}} + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/oneOf}} {{/composedSchemas}} } diff --git a/templates/libraries/jersey2/pojo.mustache b/templates/libraries/jersey2/pojo.mustache index 06be4dd..0d8bc23 100644 --- a/templates/libraries/jersey2/pojo.mustache +++ b/templates/libraries/jersey2/pojo.mustache @@ -81,6 +81,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} + {{>nullable_var_annotations}} private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -113,7 +114,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); @@ -197,17 +198,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#useBeanValidation}} {{>beanValidation}} {{/useBeanValidation}} @@ -257,7 +248,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens @Deprecated {{/deprecated}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} -{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); diff --git a/templates/libraries/jersey2/pom.mustache b/templates/libraries/jersey2/pom.mustache index 214d3ce..1373579 100644 --- a/templates/libraries/jersey2/pom.mustache +++ b/templates/libraries/jersey2/pom.mustache @@ -379,6 +379,15 @@ jersey-apache-connector${jersey-version} + {{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons-lang3-version} + + {{/useReflectionEqualsHashCode}} + org.junit.jupiter @@ -401,13 +410,12 @@ 0.2.6 {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} 5.10.0 {{#hasHttpSignatureMethods}} 1.8 @@ -415,6 +423,9 @@ {{#hasOAuthMethods}} 8.3.3 {{/hasOAuthMethods}} + {{#useReflectionEqualsHashCode}} + 3.17.0 + {{/useReflectionEqualsHashCode}} 2.21.0 diff --git a/templates/libraries/jersey3/ApiClient.mustache b/templates/libraries/jersey3/ApiClient.mustache index 344a2ec..026a494 100644 --- a/templates/libraries/jersey3/ApiClient.mustache +++ b/templates/libraries/jersey3/ApiClient.mustache @@ -1002,24 +1002,10 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { if (contentType.startsWith("multipart/form-data")) { MultiPart multiPart = new MultiPart(); for (Entry param: formParams.entrySet()) { - if (param.getValue() instanceof File) { - File file = (File) param.getValue(); - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()) - .fileName(file.getName()).size(file.length()).build(); - - // Attempt to probe the content type for the file so that the form part is more correctly - // and precisely identified, but fall back to application/octet-stream if that fails. - MediaType type; - try { - type = MediaType.valueOf(Files.probeContentType(file.toPath())); - } catch (IOException | IllegalArgumentException e) { - type = MediaType.APPLICATION_OCTET_STREAM_TYPE; - } - - multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + if (param.getValue() instanceof Iterable) { + ((Iterable)param.getValue()).forEach(v -> addParamToMultipart(v, param.getKey(), multiPart)); } else { - FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey()).build(); - multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(param.getValue()))); + addParamToMultipart(param.getValue(), param.getKey(), multiPart); } } entity = Entity.entity(multiPart, MediaType.MULTIPART_FORM_DATA_TYPE); @@ -1048,6 +1034,36 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { return entity; } + /** + * Adds the object with the provided key to the MultiPart. + * Based on the object type sets Content-Disposition and Content-Type. + * + * @param obj Object + * @param key Key of the object + * @param multiPart MultiPart to add the form param to + */ + private void addParamToMultipart(Object value, String key, MultiPart multiPart) { + if (value instanceof File) { + File file = (File) value; + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key) + .fileName(file.getName()).size(file.length()).build(); + + // Attempt to probe the content type for the file so that the form part is more correctly + // and precisely identified, but fall back to application/octet-stream if that fails. + MediaType type; + try { + type = MediaType.valueOf(Files.probeContentType(file.toPath())); + } catch (IOException | IllegalArgumentException e) { + type = MediaType.APPLICATION_OCTET_STREAM_TYPE; + } + + multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, type)); + } else { + FormDataContentDisposition contentDisp = FormDataContentDisposition.name(key).build(); + multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(value))); + } + } + /** * Serialize the given Java object into string according the given * Content-Type (only JSON, HTTP form is supported for now). @@ -1377,7 +1393,11 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { } else if ("PUT".equals(method)) { response = invocationBuilder.put(entity); } else if ("DELETE".equals(method)) { - response = invocationBuilder.method("DELETE", entity); + if ("".equals(entity.getEntity())) { + response = invocationBuilder.method("DELETE"); + } else { + response = invocationBuilder.method("DELETE", entity); + } } else if ("PATCH".equals(method)) { response = invocationBuilder.method("PATCH", entity); } else { diff --git a/templates/libraries/jersey3/JSON.mustache b/templates/libraries/jersey3/JSON.mustache index e1f17c9..613a4a2 100644 --- a/templates/libraries/jersey3/JSON.mustache +++ b/templates/libraries/jersey3/JSON.mustache @@ -12,9 +12,6 @@ import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; {{#joda}} import com.fasterxml.jackson.datatype.joda.JodaModule; {{/joda}} -{{#models.0}} -import {{modelPackage}}.*; -{{/models.0}} import java.text.DateFormat; import java.util.HashMap; @@ -32,12 +29,7 @@ public class JSON implements ContextResolver { mapper = JsonMapper.builder() .serializationInclusion(JsonInclude.Include.NON_NULL) .configure(MapperFeature.ALLOW_COERCION_OF_SCALARS, false) -{{^useCustomTemplateCode}} - .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true) -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false) -{{/useCustomTemplateCode}} + .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}) .configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, true) .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING) diff --git a/templates/libraries/jersey3/anyof_model.mustache b/templates/libraries/jersey3/anyof_model.mustache index d480667..46c2cdc 100644 --- a/templates/libraries/jersey3/anyof_model.mustache +++ b/templates/libraries/jersey3/anyof_model.mustache @@ -68,10 +68,23 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return ret; } {{/discriminator}} + {{#composedSchemas}} {{#anyOf}} - // deserialize {{{.}}} + // deserialize {{{dataType}}}{{#isNullable}} (nullable){{/isNullable}} try { - deserialized = tree.traverse(jp.getCodec()).readValueAs({{{.}}}.class); + {{^isArray}} + {{^isMap}} + deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class); + {{/isMap}} + {{/isArray}} + {{#isArray}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isArray}} + {{#isMap}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isMap}} {{classname}} ret = new {{classname}}(); ret.setActualInstance(deserialized); return ret; @@ -81,6 +94,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/anyOf}} + {{/composedSchemas}} throw new IOException(String.format("Failed deserialization for {{classname}}: no match found")); } @@ -119,13 +133,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return Objects.hash(getActualInstance(), isNullable(), getSchemaType(), additionalProperties); } {{/additionalPropertiesType}} + {{#composedSchemas}} {{#anyOf}} - public {{classname}}({{{.}}} o) { + {{^vendorExtensions.x-duplicated-data-type}} + public {{classname}}({{{baseType}}} o) { super("anyOf", {{#isNullable}}Boolean.TRUE{{/isNullable}}{{^isNullable}}Boolean.FALSE{{/isNullable}}); setActualInstance(o); } + {{/vendorExtensions.x-duplicated-data-type}} {{/anyOf}} + {{/composedSchemas}} static { {{#anyOf}} schemas.put("{{{.}}}", new GenericType<{{{.}}}>() { @@ -165,13 +183,17 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/isNullable}} + {{#composedSchemas}} {{#anyOf}} - if (JSON.isInstanceOf({{{.}}}.class, instance, new HashSet<>())) { + {{^vendorExtensions.x-duplicated-data-type}} + if (JSON.isInstanceOf({{{baseType}}}.class, instance, new HashSet<>())) { super.setActualInstance(instance); return; } + {{/vendorExtensions.x-duplicated-data-type}} {{/anyOf}} + {{/composedSchemas}} throw new RuntimeException("Invalid instance type. Must be {{#anyOf}}{{{.}}}{{^-last}}, {{/-last}}{{/anyOf}}"); } @@ -186,17 +208,21 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im return super.getActualInstance(); } + {{#composedSchemas}} {{#anyOf}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** - * Get the actual instance of `{{{.}}}`. If the actual instance is not `{{{.}}}`, + * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. * - * @return The actual instance of `{{{.}}}` - * @throws ClassCastException if the instance is not `{{{.}}}` + * @return The actual instance of `{{{dataType}}}` + * @throws ClassCastException if the instance is not `{{{dataType}}}` */ - public {{{.}}} get{{{.}}}() throws ClassCastException { - return ({{{.}}})super.getActualInstance(); + public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { + return ({{{dataType}}})super.getActualInstance(); } + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/anyOf}} + {{/composedSchemas}} } diff --git a/templates/libraries/jersey3/api.mustache b/templates/libraries/jersey3/api.mustache index 3ce92f7..0c0e2c8 100644 --- a/templates/libraries/jersey3/api.mustache +++ b/templates/libraries/jersey3/api.mustache @@ -56,12 +56,7 @@ public class {{classname}} { {{#operation}} {{^vendorExtensions.x-group-parameters}} /** -{{^useCustomTemplateCode}} * {{summary}} -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - * {{summary}}. -{{/useCustomTemplateCode}} * {{notes}} {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} @@ -72,7 +67,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -101,12 +97,7 @@ public class {{classname}} { {{/useCustomTemplateCode}} {{^vendorExtensions.x-group-parameters}} /** -{{^useCustomTemplateCode}} * {{summary}} -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - * {{summary}}. -{{/useCustomTemplateCode}} * {{notes}} {{#allParams}} * @param {{paramName}} {{description}}{{#required}} (required){{/required}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}} @@ -115,7 +106,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -226,7 +218,7 @@ public class {{classname}} { GenericType<{{{returnType}}}> localVarReturnType = new GenericType<{{{returnType}}}>() {}; {{/returnType}} {{^useCustomTemplateCode}} - return apiClient.invokeAPI("{{classname}}.{{operationId}}", {{#hasPathParams}}localVarPath{{/hasPathParams}}{{^hasPathParams}}"{{path}}"{{/hasPathParams}}, "{{httpMethod}}", {{#queryParams}}{{#-first}}localVarQueryParams{{/-first}}{{/queryParams}}{{^queryParams}}new ArrayList<>(){{/queryParams}}, {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}}, + return apiClient.invokeAPI("{{classname}}.{{operationId}}", {{#hasPathParams}}localVarPath{{/hasPathParams}}{{^hasPathParams}}"{{{path}}}"{{/hasPathParams}}, "{{httpMethod}}", {{#queryParams}}{{#-first}}localVarQueryParams{{/-first}}{{/queryParams}}{{^queryParams}}new ArrayList<>(){{/queryParams}}, {{#bodyParam}}{{paramName}}{{/bodyParam}}{{^bodyParam}}null{{/bodyParam}}, {{#headerParams}}{{#-first}}localVarHeaderParams{{/-first}}{{/headerParams}}{{^headerParams}}new LinkedHashMap<>(){{/headerParams}}, {{#cookieParams}}{{#-first}}localVarCookieParams{{/-first}}{{/cookieParams}}{{^cookieParams}}new LinkedHashMap<>(){{/cookieParams}}, {{#formParams}}{{#-first}}localVarFormParams{{/-first}}{{/formParams}}{{^formParams}}new LinkedHashMap<>(){{/formParams}}, localVarAccept, localVarContentType, {{#hasAuthMethods}}localVarAuthNames{{/hasAuthMethods}}{{^hasAuthMethods}}null{{/hasAuthMethods}}, {{#returnType}}localVarReturnType{{/returnType}}{{^returnType}}null{{/returnType}}, {{#bodyParam}}{{#isNullable}}true{{/isNullable}}{{^isNullable}}false{{/isNullable}}{{/bodyParam}}{{^bodyParam}}false{{/bodyParam}}); {{/useCustomTemplateCode}} @@ -281,7 +273,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -301,7 +294,8 @@ public class {{classname}} { * @throws ApiException if fails to make API call {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -320,12 +314,7 @@ public class {{classname}} { } /** -{{^useCustomTemplateCode}} * {{summary}} -{{/useCustomTemplateCode}} -{{#useCustomTemplateCode}} - * {{summary}}. -{{/useCustomTemplateCode}} * {{notes}}{{#pathParams}} * @param {{paramName}} {{description}} (required){{/pathParams}} * @return {{operationId}}Request diff --git a/templates/libraries/jersey3/build.gradle.mustache b/templates/libraries/jersey3/build.gradle.mustache index 6d9a171..e29892f 100644 --- a/templates/libraries/jersey3/build.gradle.mustache +++ b/templates/libraries/jersey3/build.gradle.mustache @@ -229,6 +229,9 @@ ext { {{#hasHttpSignatureMethods}} tomitribe_http_signatures_version = "1.7" {{/hasHttpSignatureMethods}} + {{#useReflectionEqualsHashCode}} + commons_lang3_version = "3.17.0" + {{/useReflectionEqualsHashCode}} {{#useCustomTemplateCode}} mockito_version = "3.12.4" {{/useCustomTemplateCode}} @@ -262,6 +265,9 @@ dependencies { {{#useBeanValidation}} implementation "jakarta.validation:jakarta.validation-api:$bean_validation_version" {{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + implementation "org.apache.commons:commons-lang3:$commons_lang3_version" + {{/useReflectionEqualsHashCode}} testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_version" testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junit_version" diff --git a/templates/libraries/jersey3/build.sbt.mustache b/templates/libraries/jersey3/build.sbt.mustache index e4c37f9..50d3b16 100644 --- a/templates/libraries/jersey3/build.sbt.mustache +++ b/templates/libraries/jersey3/build.sbt.mustache @@ -36,6 +36,9 @@ lazy val root = (project in file(".")). "org.tomitribe" % "tomitribe-http-signatures" % "1.7" % "compile", {{/hasHttpSignatureMethods}} "jakarta.annotation" % "jakarta.annotation-api" % "2.1.0" % "compile", + {{#useReflectionEqualsHashCode}} + "org.apache.commons" % "commons-lang3" % "3.17.0" % "compile", + {{/useReflectionEqualsHashCode}} "org.junit.jupiter" % "junit-jupiter-api" % "5.8.2" % "test" ) ) diff --git a/templates/libraries/jersey3/oneof_model.mustache b/templates/libraries/jersey3/oneof_model.mustache index 09906d7..5b60d07 100644 --- a/templates/libraries/jersey3/oneof_model.mustache +++ b/templates/libraries/jersey3/oneof_model.mustache @@ -112,7 +112,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im attemptParsing |= (token == JsonToken.VALUE_NUMBER_FLOAT); {{/isDecimal}} {{#isBoolean}} - attemptParsing |= (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE)); + attemptParsing |= (token == JsonToken.VALUE_FALSE || token == JsonToken.VALUE_TRUE); {{/isBoolean}} {{#isNullable}} attemptParsing |= (token == JsonToken.VALUE_NULL); @@ -120,7 +120,13 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im } {{/isPrimitiveType}} if (attemptParsing) { + {{#isMap}} + final TypeReference<{{{dataType}}}> ref = new TypeReference<{{{dataType}}}>(){}; + deserialized = tree.traverse(jp.getCodec()).readValueAs(ref); + {{/isMap}} + {{^isMap}} deserialized = tree.traverse(jp.getCodec()).readValueAs({{{dataType}}}.class); + {{/isMap}} // TODO: there is no validation against JSON schema constraints // (min, max, enum, pattern...), this does not perform a strict JSON // validation, which means the 'match' count may be higher than it should be. @@ -266,6 +272,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{#composedSchemas}} {{#oneOf}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. @@ -273,17 +280,11 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im * @return The actual instance of `{{{dataType}}}` * @throws ClassCastException if the instance is not `{{{dataType}}}` */ - {{^isArray}} - public {{{dataType}}} get{{{dataType}}}() throws ClassCastException { + public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { return ({{{dataType}}})super.getActualInstance(); } - {{/isArray}} - {{#isArray}} - public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { - return ({{{dataType}}})super.getActualInstance(); - } - {{/isArray}} + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/oneOf}} {{/composedSchemas}} } diff --git a/templates/libraries/jersey3/pojo.mustache b/templates/libraries/jersey3/pojo.mustache index 0ba5ad0..a73f869 100644 --- a/templates/libraries/jersey3/pojo.mustache +++ b/templates/libraries/jersey3/pojo.mustache @@ -91,6 +91,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} + {{>nullable_var_annotations}} {{^useCustomTemplateCode}} private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; {{/useCustomTemplateCode}} @@ -150,7 +151,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); @@ -242,17 +243,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#useBeanValidation}} {{>beanValidation}} {{/useBeanValidation}} @@ -302,7 +293,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens @Deprecated {{/deprecated}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} -{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); diff --git a/templates/libraries/jersey3/pom.mustache b/templates/libraries/jersey3/pom.mustache index e2bb172..23e2b05 100644 --- a/templates/libraries/jersey3/pom.mustache +++ b/templates/libraries/jersey3/pom.mustache @@ -404,6 +404,15 @@ jersey-apache-connector${jersey-version} + {{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons-lang3-version} + + {{/useReflectionEqualsHashCode}} + org.junit.jupiter @@ -433,9 +442,7 @@ 2.17.1 0.2.6 2.1.1 - {{#useBeanValidation}} 3.0.2 - {{/useBeanValidation}} 5.10.0 {{#hasHttpSignatureMethods}} 1.8 @@ -443,6 +450,9 @@ {{#hasOAuthMethods}} 8.3.3 {{/hasOAuthMethods}} + {{#useReflectionEqualsHashCode}} + 3.17.0 + {{/useReflectionEqualsHashCode}} 2.21.0 {{#useCustomTemplateCode}} 3.12.4 diff --git a/templates/libraries/microprofile/api.mustache b/templates/libraries/microprofile/api.mustache index 6e25c1f..0b0a7c4 100644 --- a/templates/libraries/microprofile/api.mustache +++ b/templates/libraries/microprofile/api.mustache @@ -71,10 +71,10 @@ public interface {{classname}} { {{#hasProduces}} @Produces({ {{#produces}}"{{{mediaType}}}"{{^-last}}, {{/-last}}{{/produces}} }) {{/hasProduces}} -{{^useSingleRequestParameter}} - {{^vendorExtensions.x-java-is-response-void}}{{#microprofileServer}}{{> server_operation}}{{/microprofileServer}}{{^microprofileServer}}{{> client_operation}}{{/microprofileServer}}{{/vendorExtensions.x-java-is-response-void}}{{#vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni{{/microprofileMutiny}}{{^microprofileMutiny}}void{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}} {{nickname}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{^-last}}, {{/-last}}{{/allParams}}) throws ApiException, ProcessingException; -{{/useSingleRequestParameter}} -{{#useSingleRequestParameter}} +{{^singleRequestParameter}} + {{^vendorExtensions.x-java-is-response-void}}{{#microprofileServer}}{{> server_operation}}{{/microprofileServer}}{{^microprofileServer}}{{> client_operation}}{{/microprofileServer}}{{/vendorExtensions.x-java-is-response-void}}{{#vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni{{/microprofileMutiny}}{{^microprofileMutiny}}void{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}} {{nickname}}({{#allParams}}{{>queryParams}}{{>pathParams}}{{>headerParams}}{{>bodyParams}}{{>formParams}}{{>cookieParams}}{{^-last}}, {{/-last}}{{/allParams}}) throws ApiException, ProcessingException; +{{/singleRequestParameter}} +{{#singleRequestParameter}} {{^vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni<{{{returnType}}}>{{/microprofileMutiny}}{{^microprofileMutiny}}{{{returnType}}}{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}}{{#vendorExtensions.x-java-is-response-void}}{{#microprofileMutiny}}Uni{{/microprofileMutiny}}{{^microprofileMutiny}}void{{/microprofileMutiny}}{{/vendorExtensions.x-java-is-response-void}} {{nickname}}({{#hasNonBodyParams}}@BeanParam {{operationIdCamelCase}}Request request{{/hasNonBodyParams}}{{#bodyParams}}{{#hasNonBodyParams}}, {{/hasNonBodyParams}}{{>bodyParams}}{{/bodyParams}}) throws ApiException, ProcessingException; {{#hasNonBodyParams}} public class {{operationIdCamelCase}}Request { @@ -91,6 +91,9 @@ public interface {{classname}} { {{#formParams}} private {{>formParams}}; {{/formParams}} + {{#cookieParams}} + private {{>cookieParams}}; + {{/cookieParams}} private {{operationIdCamelCase}}Request() { } @@ -106,7 +109,7 @@ public interface {{classname}} { * @param {{paramName}}{{>formParamsNameSuffix}} {{description}} ({{^required}}optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}{{/required}}{{#required}}required{{/required}}) * @return {{operationIdCamelCase}}Request */ - public {{operationIdCamelCase}}Request {{paramName}}{{>formParamsNameSuffix}}({{>queryParamsImpl}}{{>pathParamsImpl}}{{>headerParamsImpl}}{{>formParamsImpl}}) { + public {{operationIdCamelCase}}Request {{paramName}}{{>formParamsNameSuffix}}({{>queryParamsImpl}}{{>pathParamsImpl}}{{>headerParamsImpl}}{{>formParamsImpl}}{{>cookieParamsImpl}}) { this.{{paramName}}{{>formParamsNameSuffix}} = {{paramName}}{{>formParamsNameSuffix}}; return this; } @@ -114,7 +117,7 @@ public interface {{classname}} { {{/allParams}} } {{/hasNonBodyParams}} -{{/useSingleRequestParameter}} +{{/singleRequestParameter}} {{/operation}} } {{/operations}} diff --git a/templates/libraries/microprofile/beanValidationCookieParams.mustache b/templates/libraries/microprofile/beanValidationCookieParams.mustache new file mode 100644 index 0000000..c4ff01d --- /dev/null +++ b/templates/libraries/microprofile/beanValidationCookieParams.mustache @@ -0,0 +1 @@ +{{#required}} @NotNull{{/required}}{{>beanValidationCore}} \ No newline at end of file diff --git a/templates/libraries/microprofile/cookieParams.mustache b/templates/libraries/microprofile/cookieParams.mustache new file mode 100644 index 0000000..4cca907 --- /dev/null +++ b/templates/libraries/microprofile/cookieParams.mustache @@ -0,0 +1 @@ +{{#isCookieParam}}@CookieParam("{{baseName}}") {{#useBeanValidation}}{{>beanValidationCookieParams}}{{/useBeanValidation}} {{{dataType}}} {{paramName}}{{/isCookieParam}} \ No newline at end of file diff --git a/templates/libraries/microprofile/cookieParamsImpl.mustache b/templates/libraries/microprofile/cookieParamsImpl.mustache new file mode 100644 index 0000000..70871f0 --- /dev/null +++ b/templates/libraries/microprofile/cookieParamsImpl.mustache @@ -0,0 +1 @@ +{{#isCookieParam}}{{{dataType}}} {{paramName}}{{/isCookieParam}} \ No newline at end of file diff --git a/templates/libraries/microprofile/enumClass.mustache b/templates/libraries/microprofile/enumClass.mustache index cb8539b..7cead92 100644 --- a/templates/libraries/microprofile/enumClass.mustache +++ b/templates/libraries/microprofile/enumClass.mustache @@ -77,7 +77,7 @@ return b; } } - {{#isNullable}}return null;{{/isNullable}}{{^isNullable}}throw new IllegalArgumentException("Unexpected value '" + value + "'");{{/isNullable}} + {{#isNullable}}return null;{{/isNullable}}{{^isNullable}}{{#enumUnknownDefaultCase}}{{#allowableValues}}{{#enumVars}}{{#-last}}return {{{name}}};{{/-last}}{{/enumVars}}{{/allowableValues}}{{/enumUnknownDefaultCase}}{{^enumUnknownDefaultCase}}throw new IllegalArgumentException("Unexpected value '" + value + "'");{{/enumUnknownDefaultCase}}{{/isNullable}} } {{/jackson}} {{/withXml}} diff --git a/templates/libraries/microprofile/enumOuterClass.mustache b/templates/libraries/microprofile/enumOuterClass.mustache index 2539064..588e52c 100644 --- a/templates/libraries/microprofile/enumOuterClass.mustache +++ b/templates/libraries/microprofile/enumOuterClass.mustache @@ -65,6 +65,6 @@ import java.net.URI; return b; } } - {{#useNullForUnknownEnumValue}}return null;{{/useNullForUnknownEnumValue}}{{^useNullForUnknownEnumValue}}throw new IllegalArgumentException("Unexpected value '" + text + "'");{{/useNullForUnknownEnumValue}} + {{#useNullForUnknownEnumValue}}return null;{{/useNullForUnknownEnumValue}}{{^useNullForUnknownEnumValue}}{{#enumUnknownDefaultCase}}{{#allowableValues}}{{#enumVars}}{{#-last}}return {{{name}}};{{/-last}}{{/enumVars}}{{/allowableValues}}{{/enumUnknownDefaultCase}}{{^enumUnknownDefaultCase}}throw new IllegalArgumentException("Unexpected value '" + text + "'");{{/enumUnknownDefaultCase}}{{/useNullForUnknownEnumValue}} } } diff --git a/templates/libraries/microprofile/model.mustache b/templates/libraries/microprofile/model.mustache index e10e68d..8ac93be 100644 --- a/templates/libraries/microprofile/model.mustache +++ b/templates/libraries/microprofile/model.mustache @@ -1,6 +1,12 @@ {{>licenseInfo}} package {{package}}; +{{#useReflectionEqualsHashCode}} +import org.apache.commons.lang3.builder.EqualsBuilder; +import org.apache.commons.lang3.builder.HashCodeBuilder; +{{/useReflectionEqualsHashCode}} +import java.util.Objects; +import java.util.Arrays; {{#imports}}import {{import}}; {{/imports}} {{#serializableModel}} @@ -31,9 +37,12 @@ import {{rootJavaEEPackage}}.json.bind.serializer.SerializationContext; import {{rootJavaEEPackage}}.json.stream.JsonGenerator; import {{rootJavaEEPackage}}.json.stream.JsonParser; import {{rootJavaEEPackage}}.json.bind.annotation.JsonbProperty; -{{#vendorExtensions.x-has-readonly-properties}} +{{#jsonbPolymorphism}} +import {{rootJavaEEPackage}}.json.bind.annotation.JsonbSubtype; +import {{rootJavaEEPackage}}.json.bind.annotation.JsonbTransient; +import {{rootJavaEEPackage}}.json.bind.annotation.JsonbTypeInfo; +{{/jsonbPolymorphism}} import {{rootJavaEEPackage}}.json.bind.annotation.JsonbCreator; -{{/vendorExtensions.x-has-readonly-properties}} {{/jsonb}} {{#useBeanValidation}} import {{rootJavaEEPackage}}.validation.constraints.*; diff --git a/templates/libraries/microprofile/pojo.mustache b/templates/libraries/microprofile/pojo.mustache index afad09a..9fcac40 100644 --- a/templates/libraries/microprofile/pojo.mustache +++ b/templates/libraries/microprofile/pojo.mustache @@ -22,7 +22,7 @@ * {{{.}}} */ {{/description}} -{{>additionalModelTypeAnnotations}} +{{>additionalModelTypeAnnotations}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}} {{#vendorExtensions.x-class-extra-annotation}} {{{vendorExtensions.x-class-extra-annotation}}} {{/vendorExtensions.x-class-extra-annotation}} @@ -45,7 +45,7 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{#vendorExtensi */ {{/description}} {{^withXml}} - {{#jsonb}}@JsonbProperty("{{baseName}}"){{/jsonb}} + {{#jsonb}}{{^isDiscriminator}}@JsonbProperty("{{baseName}}"){{/isDiscriminator}}{{#isDiscriminator}}{{#jsonbPolymorphism}}@JsonbTransient{{/jsonbPolymorphism}}{{^jsonbPolymorphism}}@JsonbProperty("{{baseName}}"){{/jsonbPolymorphism}}{{/isDiscriminator}}{{/jsonb}} {{/withXml}} {{#vendorExtensions.x-field-extra-annotation}} {{{vendorExtensions.x-field-extra-annotation}}} @@ -148,28 +148,5 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}}{{#vendorExtensi {{/isReadOnly}} {{/vars}} - - /** - * Create a string representation of this pojo. - */ - @Override - public String toString() { - StringBuilder sb = new StringBuilder(); - sb.append("class {{classname}} {\n"); - {{#parent}}sb.append(" ").append(toIndentedString(super.toString())).append("\n");{{/parent}} - {{#vars}}sb.append(" {{name}}: ").append({{#isPassword}}"*"{{/isPassword}}{{^isPassword}}toIndentedString({{name}}){{/isPassword}}).append("\n"); - {{/vars}}sb.append("}"); - return sb.toString(); - } - - /** - * Convert the given object to string with each line indented by 4 spaces - * (except the first line). - */ - private static String toIndentedString(Object o) { - if (o == null) { - return "null"; - } - return o.toString().replace("\n", "\n "); - } +{{>pojoOverrides}} } diff --git a/templates/libraries/microprofile/pojoOverrides.mustache b/templates/libraries/microprofile/pojoOverrides.mustache new file mode 100644 index 0000000..f0fbb0b --- /dev/null +++ b/templates/libraries/microprofile/pojoOverrides.mustache @@ -0,0 +1,64 @@ + @Override + public boolean equals(Object o) { + {{#useReflectionEqualsHashCode}} + return EqualsBuilder.reflectionEquals(this, o, false, null, true); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + }{{#hasVars}} + {{classname}} {{classVarName}} = ({{classname}}) o; + return {{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}equalsNullable(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#isByteArray}}Arrays{{/isByteArray}}{{^isByteArray}}Objects{{/isByteArray}}.equals(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}} && + {{/-last}}{{/vars}}{{#parent}} && + super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}} + return {{#parent}}super.equals(o){{/parent}}{{^parent}}true{{/parent}};{{/hasVars}} + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + @Override + public int hashCode() { + {{#useReflectionEqualsHashCode}} + return HashCodeBuilder.reflectionHashCode(this); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + return Objects.hash({{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}hashCodeNullable({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{^isByteArray}}{{name}}{{/isByteArray}}{{#isByteArray}}Arrays.hashCode({{name}}){{/isByteArray}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}}, {{/-last}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}}); + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + /** + * Create a string representation of this pojo. + */ + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class {{classname}} {\n"); + {{#parent}}sb.append(" ").append(toIndentedString(super.toString())).append("\n");{{/parent}} + {{#vars}}sb.append(" {{name}}: ").append({{#isPassword}}"*"{{/isPassword}}{{^isPassword}}toIndentedString({{name}}){{/isPassword}}).append("\n"); + {{/vars}}sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private static String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } \ No newline at end of file diff --git a/templates/libraries/microprofile/pom.mustache b/templates/libraries/microprofile/pom.mustache index f814d4c..4fefd6d 100644 --- a/templates/libraries/microprofile/pom.mustache +++ b/templates/libraries/microprofile/pom.mustache @@ -196,6 +196,14 @@ ${mutiny.version} {{/microprofileMutiny}} +{{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons.lang3.version} + +{{/useReflectionEqualsHashCode}} @@ -210,10 +218,12 @@ 1.8 ${java.version} ${java.version} + UTF-8 + 1.5.18 9.2.9.v20150224 5.10.2 - 1.4.14 + 1.5.13 {{#useBeanValidation}} 3.0.2 {{/useBeanValidation}} @@ -238,9 +248,11 @@ 1.1.0 2.6 1.9.1 - UTF-8 {{#microprofileMutiny}} - 1.2.0 + 1.10.0 {{/microprofileMutiny}} +{{#useReflectionEqualsHashCode}} + 3.17.0 +{{/useReflectionEqualsHashCode}} diff --git a/templates/libraries/microprofile/pom_3.0.mustache b/templates/libraries/microprofile/pom_3.0.mustache index 7accc4c..9462e0d 100644 --- a/templates/libraries/microprofile/pom_3.0.mustache +++ b/templates/libraries/microprofile/pom_3.0.mustache @@ -189,6 +189,21 @@ ${jakarta.annotation.version} provided +{{#microprofileMutiny}} + + io.smallrye.reactive + mutiny + ${mutiny.version} + +{{/microprofileMutiny}} +{{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons.lang3.version} + +{{/useReflectionEqualsHashCode}} @@ -203,10 +218,12 @@ 11 ${java.version} ${java.version} + UTF-8 + 1.5.18 9.2.9.v20150224 5.10.2 - 1.4.14 + 1.5.13 {{#useBeanValidation}} 3.0.1 {{/useBeanValidation}} @@ -217,7 +234,7 @@ {{/jackson}} 2.1.0 2.0.0 - 2.0.0 + 3.0.0 2.0.1 3.0.0 3.0.1 @@ -231,6 +248,11 @@ 1.1.0 2.6 1.9.1 - UTF-8 +{{#microprofileMutiny}} + 1.10.0 +{{/microprofileMutiny}} +{{#useReflectionEqualsHashCode}} + 3.17.0 +{{/useReflectionEqualsHashCode}} diff --git a/templates/libraries/native/ApiClient.mustache b/templates/libraries/native/ApiClient.mustache index a641525..a8bede3 100644 --- a/templates/libraries/native/ApiClient.mustache +++ b/templates/libraries/native/ApiClient.mustache @@ -183,7 +183,7 @@ public class ApiClient { asyncResponseInterceptor = null; } - protected ObjectMapper createDefaultObjectMapper() { + public static ObjectMapper createDefaultObjectMapper() { ObjectMapper mapper = new ObjectMapper(); mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); @@ -199,15 +199,15 @@ public class ApiClient { return mapper; } - protected String getDefaultBaseUri() { + private String getDefaultBaseUri() { return "{{{basePath}}}"; } - protected HttpClient.Builder createDefaultHttpClientBuilder() { + public static HttpClient.Builder createDefaultHttpClientBuilder() { return HttpClient.newBuilder(); } - public void updateBaseUri(String baseUri) { + public final void updateBaseUri(String baseUri) { URI uri = URI.create(baseUri); scheme = uri.getScheme(); host = uri.getHost(); diff --git a/templates/libraries/native/JSON.mustache b/templates/libraries/native/JSON.mustache index 813bb79..496e5a1 100644 --- a/templates/libraries/native/JSON.mustache +++ b/templates/libraries/native/JSON.mustache @@ -30,7 +30,12 @@ public class JSON { mapper = JsonMapper.builder() .serializationInclusion(JsonInclude.Include.NON_NULL) .disable(MapperFeature.ALLOW_COERCION_OF_SCALARS) + {{#failOnUnknownProperties}} .enable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + {{/failOnUnknownProperties}} + {{^failOnUnknownProperties}} + .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES) + {{/failOnUnknownProperties}} .enable(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE) .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING) diff --git a/templates/libraries/native/anyof_model.mustache b/templates/libraries/native/anyof_model.mustache index dfb6464..7cc5081 100644 --- a/templates/libraries/native/anyof_model.mustache +++ b/templates/libraries/native/anyof_model.mustache @@ -16,6 +16,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.deser.std.StdDeserializer; import com.fasterxml.jackson.databind.ser.std.StdSerializer; +import {{invokerPackage}}.ApiClient; import {{invokerPackage}}.JSON; {{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{>xmlAnnotation}} @@ -241,7 +242,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for ({{{items.dataType}}} _item : ({{{dataType}}})getActualInstance()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(_item)))); } i++; } @@ -251,7 +252,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for (int i = 0; i < (({{{dataType}}})getActualInstance()).size(); i++) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(getActualInstance().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(getActualInstance().get(i))))); } } {{/uniqueItems}} @@ -289,7 +290,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im if (_item != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(_item)))); } i++; } @@ -301,7 +302,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im if (getActualInstance().get(i) != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf((({{{dataType}}})getActualInstance()).get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf((({{{dataType}}})getActualInstance()).get(i))))); } } } @@ -316,7 +317,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for (String _key : (({{{dataType}}})getActualInstance()).keySet()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix), - getActualInstance().get(_key), URLEncoder.encode(String.valueOf((({{{dataType}}})getActualInstance()).get(_key)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + getActualInstance().get(_key), ApiClient.urlEncode(String.valueOf((({{{dataType}}})getActualInstance()).get(_key))))); } } {{/items.isPrimitiveType}} @@ -334,7 +335,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{^isMap}} {{#isPrimitiveType}} if (getActualInstance() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getActualInstance()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(String.valueOf(getActualInstance())))); } {{/isPrimitiveType}} {{^isPrimitiveType}} @@ -345,7 +346,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{/isModel}} {{^isModel}} if (getActualInstance() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getActualInstance()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(String.valueOf(getActualInstance())))); } {{/isModel}} {{/isPrimitiveType}} diff --git a/templates/libraries/native/api.mustache b/templates/libraries/native/api.mustache index a80dcba..c100f2f 100644 --- a/templates/libraries/native/api.mustache +++ b/templates/libraries/native/api.mustache @@ -4,6 +4,7 @@ package {{package}}; import {{invokerPackage}}.ApiClient; import {{invokerPackage}}.ApiException; import {{invokerPackage}}.ApiResponse; +import {{invokerPackage}}.Configuration; import {{invokerPackage}}.Pair; {{#imports}} @@ -14,8 +15,8 @@ import com.fasterxml.jackson.core.type.TypeReference; import com.fasterxml.jackson.databind.ObjectMapper; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#hasFormParamsInSpec}} @@ -64,7 +65,7 @@ public class {{classname}} { private final Consumer> memberVarAsyncResponseInterceptor; public {{classname}}() { - this(new ApiClient()); + this(Configuration.getDefaultApiClient()); } public {{classname}}(ApiClient apiClient) { @@ -271,22 +272,46 @@ public class {{classname}} { } {{/vendorExtensions.x-java-text-plain-string}} {{^vendorExtensions.x-java-text-plain-string}} - return new ApiResponse<{{{returnType}}}{{^returnType}}Void{{/returnType}}>( - localVarResponse.statusCode(), - localVarResponse.headers().map(), - {{#returnType}} - localVarResponse.body() == null ? null : memberVarObjectMapper.readValue(localVarResponse.body(), new TypeReference<{{{returnType}}}>() {}) // closes the InputStream - {{/returnType}} - {{^returnType}} - null - {{/returnType}} + {{#returnType}} + {{! Fix for https://github.com/OpenAPITools/openapi-generator/issues/13968 }} + {{! This part had a bugfix for an empty response in the past, but this part of that PR was reverted because it was not doing anything. }} + {{! Keep this documentation here, because the problem is not obvious. }} + {{! `InputStream.available()` was used, but that only works for inputstreams that are already in memory, it will not give the right result if it is a remote stream. We only work with remote streams here. }} + {{! https://github.com/OpenAPITools/openapi-generator/pull/13993/commits/3e!37411d2acef0311c82e6d941a8e40b3bc0b6da }} + {{! The `available` method would work with a `PushbackInputStream`, because we could read 1 byte to check if it exists then push it back so Jackson can read it again. The issue with that is that it will also insert an ascii character for "head of input" and that will break Jackson as it does not handle special whitespace characters. }} + {{! A fix for that problem is to read it into a string and remove those characters, but if we need to read it before giving it to jackson to fix the string then just reading it into a string as is to do an emptiness check is the cleaner solution. }} + {{! We could also manipulate the inputstream to remove that bad character, but string manipulation is easier to read and this codepath is not asyncronus so we do not gain anything by reading the stream later. }} + {{! This fix does make it unsuitable for large amounts of data because `InputStream.readAllbytes` is not meant for it, but a synchronous client is already not the right tool for that.}} + if (localVarResponse.body() == null) { + return new ApiResponse<{{{returnType}}}>( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + null + ); + } + + String responseBody = new String(localVarResponse.body().readAllBytes()); + localVarResponse.body().close(); + + return new ApiResponse<{{{returnType}}}>( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + responseBody.isBlank()? null: memberVarObjectMapper.readValue(responseBody, new TypeReference<{{{returnType}}}>() {}) ); + {{/returnType}} + {{^returnType}} + return new ApiResponse<{{{returnType}}}>( + localVarResponse.statusCode(), + localVarResponse.headers().map(), + null + ); + {{/returnType}} {{/vendorExtensions.x-java-text-plain-string}} } finally { {{^returnType}} // Drain the InputStream while (localVarResponse.body().read() != -1) { - // Ignore + // Ignore } localVarResponse.body().close(); {{/returnType}} diff --git a/templates/libraries/native/api_test.mustache b/templates/libraries/native/api_test.mustache index 497bd53..8558cc6 100644 --- a/templates/libraries/native/api_test.mustache +++ b/templates/libraries/native/api_test.mustache @@ -19,8 +19,8 @@ import java.util.concurrent.CompletableFuture; {{/asyncNative}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/native/build.gradle.mustache b/templates/libraries/native/build.gradle.mustache index 24ea4fe..a04a964 100644 --- a/templates/libraries/native/build.gradle.mustache +++ b/templates/libraries/native/build.gradle.mustache @@ -50,12 +50,12 @@ task execute(type:JavaExec) { } task sourcesJar(type: Jar, dependsOn: classes) { - classifier = 'sources' + archiveClassifier = 'sources' from sourceSets.main.allSource } task javadocJar(type: Jar, dependsOn: javadoc) { - classifier = 'javadoc' + archiveClassifier = 'javadoc' from javadoc.destinationDir } @@ -73,11 +73,21 @@ ext { swagger_annotations_version = "2.2.9" {{/swagger2AnnotationLibrary}} jackson_version = "2.17.1" + {{#useJakartaEe}} + jakarta_annotation_version = "2.1.1" + beanvalidation_version = "3.0.2" + {{/useJakartaEe}} + {{^useJakartaEe}} jakarta_annotation_version = "1.3.5" + beanvalidation_version = "2.0.2" + {{/useJakartaEe}} junit_version = "5.10.2" {{#hasFormParamsInSpec}} httpmime_version = "4.5.13" {{/hasFormParamsInSpec}} + {{#useReflectionEqualsHashCode}} + commons_lang3_version = "3.17.0" + {{/useReflectionEqualsHashCode}} } dependencies { @@ -94,9 +104,15 @@ dependencies { implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version" implementation "org.openapitools:jackson-databind-nullable:0.2.1" implementation "jakarta.annotation:jakarta.annotation-api:$jakarta_annotation_version" + {{#useBeanValidation}} + implementation "jakarta.validation:jakarta.validation-api:$beanvalidation_version" + {{/useBeanValidation}} {{#hasFormParamsInSpec}} implementation "org.apache.httpcomponents:httpmime:$httpmime_version" {{/hasFormParamsInSpec}} + {{#useReflectionEqualsHashCode}} + implementation "org.apache.commons:commons-lang3:$commons_lang3_version" + {{/useReflectionEqualsHashCode}} testImplementation "org.junit.jupiter:junit-jupiter-api:$junit_version" } diff --git a/templates/libraries/native/model.mustache b/templates/libraries/native/model.mustache index cd2a85a..b3beca8 100644 --- a/templates/libraries/native/model.mustache +++ b/templates/libraries/native/model.mustache @@ -47,8 +47,8 @@ import android.os.Parcelable; import android.os.Parcel; {{/parcelableModel}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} import org.hibernate.validator.constraints.*; diff --git a/templates/libraries/native/oneof_model.mustache b/templates/libraries/native/oneof_model.mustache index 8aa2ef0..cbb4a6d 100644 --- a/templates/libraries/native/oneof_model.mustache +++ b/templates/libraries/native/oneof_model.mustache @@ -18,6 +18,7 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import com.fasterxml.jackson.databind.annotation.JsonSerialize; import com.fasterxml.jackson.databind.deser.std.StdDeserializer; import com.fasterxml.jackson.databind.ser.std.StdSerializer; +import {{invokerPackage}}.ApiClient; import {{invokerPackage}}.JSON; {{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{>xmlAnnotation}} @@ -274,7 +275,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for ({{{items.dataType}}} _item : ({{{dataType}}})getActualInstance()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(_item)))); } i++; } @@ -284,7 +285,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for (int i = 0; i < (({{{dataType}}})getActualInstance()).size(); i++) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(getActualInstance().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(getActualInstance().get(i))))); } } {{/uniqueItems}} @@ -322,7 +323,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im if (_item != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf(_item)))); } i++; } @@ -334,7 +335,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im if (getActualInstance().get(i) != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(String.valueOf((({{{dataType}}})getActualInstance()).get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(String.valueOf((({{{dataType}}})getActualInstance()).get(i))))); } } } @@ -349,7 +350,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im for (String _key : (({{{dataType}}})getActualInstance()).keySet()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix), - getActualInstance().get(_key), URLEncoder.encode(String.valueOf((({{{dataType}}})getActualInstance()).get(_key)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + getActualInstance().get(_key), ApiClient.urlEncode(String.valueOf((({{{dataType}}})getActualInstance()).get(_key))))); } } {{/items.isPrimitiveType}} @@ -367,7 +368,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{^isMap}} {{#isPrimitiveType}} if (getActualInstance() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getActualInstance()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(String.valueOf(getActualInstance())))); } {{/isPrimitiveType}} {{^isPrimitiveType}} @@ -378,7 +379,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{/isModel}} {{^isModel}} if (getActualInstance() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf(getActualInstance()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(String.valueOf(getActualInstance())))); } {{/isModel}} {{/isPrimitiveType}} diff --git a/templates/libraries/native/pojo.mustache b/templates/libraries/native/pojo.mustache index 1250a71..5413d1c 100644 --- a/templates/libraries/native/pojo.mustache +++ b/templates/libraries/native/pojo.mustache @@ -75,6 +75,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{/isContainer}} {{/vendorExtensions.x-is-jackson-optional-nullable}} {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{>nullable_var_annotations}} private {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -104,7 +105,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens )); {{/vendorExtensions.x-enum-as-string}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); @@ -188,17 +189,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#useBeanValidation}} {{>beanValidation}} {{/useBeanValidation}} @@ -244,7 +235,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{^isReadOnly}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} -{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-enum-as-string}} if (!{{{nameInSnakeCase}}}_VALUES.contains({{name}})) { throw new IllegalArgumentException({{name}} + " is invalid. Possible values for {{name}}: " + String.join(", ", {{{nameInSnakeCase}}}_VALUES)); @@ -266,7 +257,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#allVars}} {{#isOverridden}} @Override - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}} this.{{setter}}(JsonNullable.<{{{datatypeWithEnum}}}>of({{name}})); {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -395,7 +386,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens for ({{{items.dataType}}} _item : {{getter}}()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(ApiClient.valueToString(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(ApiClient.valueToString(_item)))); } i++; } @@ -405,7 +396,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens for (int i = 0; i < {{getter}}().size(); i++) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(ApiClient.valueToString({{getter}}().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(ApiClient.valueToString({{getter}}().get(i))))); } } {{/uniqueItems}} @@ -443,7 +434,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens if (_item != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(ApiClient.valueToString(_item), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(ApiClient.valueToString(_item)))); } i++; } @@ -455,7 +446,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens if ({{getter}}().get(i) != null) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), - URLEncoder.encode(ApiClient.valueToString({{getter}}().get(i)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + ApiClient.urlEncode(ApiClient.valueToString({{getter}}().get(i))))); } } } @@ -470,7 +461,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens for (String _key : {{getter}}().keySet()) { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix), - {{getter}}().get(_key), URLEncoder.encode(ApiClient.valueToString({{getter}}().get(_key)), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + {{getter}}().get(_key), ApiClient.urlEncode(ApiClient.valueToString({{getter}}().get(_key))))); } } {{/items.isModel}} @@ -488,7 +479,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{^isMap}} {{#isPrimitiveType}} if ({{getter}}() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(ApiClient.valueToString({{{getter}}}()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString({{{getter}}}())))); } {{/isPrimitiveType}} {{^isPrimitiveType}} @@ -499,7 +490,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{/isModel}} {{^isModel}} if ({{getter}}() != null) { - joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(ApiClient.valueToString({{{getter}}}()), StandardCharsets.UTF_8).replaceAll("\\+", "%20"))); + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString({{{getter}}}())))); } {{/isModel}} {{/isPrimitiveType}} diff --git a/templates/libraries/native/pom.mustache b/templates/libraries/native/pom.mustache index 8ed8277..0ccfa84 100644 --- a/templates/libraries/native/pom.mustache +++ b/templates/libraries/native/pom.mustache @@ -271,6 +271,14 @@ ${httpmime-version} {{/hasFormParamsInSpec}} + {{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons-lang3-version} + + {{/useReflectionEqualsHashCode}} @@ -295,16 +303,18 @@ 0.2.6 {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} {{#hasFormParamsInSpec}} 4.5.14 {{/hasFormParamsInSpec}} + {{#useReflectionEqualsHashCode}} + 3.17.0 + {{/useReflectionEqualsHashCode}} 5.10.2 2.27.2 diff --git a/templates/libraries/okhttp-gson/ApiClient.mustache b/templates/libraries/okhttp-gson/ApiClient.mustache index c5e7ae2..519b37e 100644 --- a/templates/libraries/okhttp-gson/ApiClient.mustache +++ b/templates/libraries/okhttp-gson/ApiClient.mustache @@ -47,9 +47,11 @@ import java.security.cert.CertificateException; import java.security.cert.CertificateFactory; import java.security.cert.X509Certificate; import java.text.DateFormat; +{{#jsr310}} import java.time.LocalDate; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; +{{/jsr310}} import java.util.*; import java.util.Map.Entry; import java.util.concurrent.TimeUnit; @@ -987,7 +989,7 @@ public class ApiClient { } {{/dynamicOperations}} - /** + /** * Formats the specified free-form query parameters to a list of {@code Pair} objects. * * @param value The free-form query parameters. @@ -1001,6 +1003,7 @@ public class ApiClient { return params; } + @SuppressWarnings("unchecked") final Map valuesMap = (Map) value; for (Map.Entry entry : valuesMap.entrySet()) { diff --git a/templates/libraries/okhttp-gson/JSON.mustache b/templates/libraries/okhttp-gson/JSON.mustache index 6cf7ec7..eee7773 100644 --- a/templates/libraries/okhttp-gson/JSON.mustache +++ b/templates/libraries/okhttp-gson/JSON.mustache @@ -28,9 +28,11 @@ import java.lang.reflect.Type; import java.text.DateFormat; import java.text.ParseException; import java.text.ParsePosition; +{{#jsr310}} import java.time.LocalDate; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; +{{/jsr310}} import java.util.Date; import java.util.Locale; import java.util.Map; diff --git a/templates/libraries/okhttp-gson/README.mustache b/templates/libraries/okhttp-gson/README.mustache index 8dbdf24..de3afa6 100644 --- a/templates/libraries/okhttp-gson/README.mustache +++ b/templates/libraries/okhttp-gson/README.mustache @@ -90,7 +90,7 @@ import {{{invokerPackage}}}.ApiClient; import {{{invokerPackage}}}.ApiException; import {{{invokerPackage}}}.Configuration;{{#hasAuthMethods}} import {{{invokerPackage}}}.auth.*;{{/hasAuthMethods}} -import {{{invokerPackage}}}.models.*; +import {{{modelPackage}}}.*; import {{{package}}}.{{{classname}}}; public class Example { diff --git a/templates/libraries/okhttp-gson/anyof_model.mustache b/templates/libraries/okhttp-gson/anyof_model.mustache index 18447fc..564c1bb 100644 --- a/templates/libraries/okhttp-gson/anyof_model.mustache +++ b/templates/libraries/okhttp-gson/anyof_model.mustache @@ -283,7 +283,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{#composedSchemas}} {{#anyOf}} - {{^vendorExtensions.x-duplicated-data-type}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. @@ -291,13 +291,13 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im * @return The actual instance of `{{{dataType}}}` * @throws ClassCastException if the instance is not `{{{dataType}}}` */ - public {{{dataType}}} get{{#isArray}}{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}{{/isArray}}{{^isArray}}{{{dataType}}}{{/isArray}}() throws ClassCastException { + public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { return ({{{dataType}}})super.getActualInstance(); } - {{/vendorExtensions.x-duplicated-data-type}} + + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/anyOf}} {{/composedSchemas}} - /** * Validates the JSON Element and throws an exception if issues found * diff --git a/templates/libraries/okhttp-gson/api.mustache b/templates/libraries/okhttp-gson/api.mustache index 96757ed..2dd7963 100644 --- a/templates/libraries/okhttp-gson/api.mustache +++ b/templates/libraries/okhttp-gson/api.mustache @@ -26,14 +26,14 @@ import io.swagger.v3.oas.models.parameters.Parameter; import java.io.IOException; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} -import jakarta.validation.ConstraintViolation; -import jakarta.validation.Validation; -import jakarta.validation.ValidatorFactory; -import jakarta.validation.executable.ExecutableValidator; +import {{javaxPackage}}.validation.ConstraintViolation; +import {{javaxPackage}}.validation.Validation; +import {{javaxPackage}}.validation.ValidatorFactory; +import {{javaxPackage}}.validation.executable.ExecutableValidator; import java.util.Set; import java.lang.reflect.Method; import java.lang.reflect.Type; @@ -98,7 +98,8 @@ public class {{classname}} { * @throws ApiException If fail to serialize the request body object {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -180,12 +181,6 @@ public class {{classname}} { {{/isQueryParam}} {{/constantParams}} - {{#headerParams}} - if ({{paramName}} != null) { - localVarHeaderParams.put("{{baseName}}", localVarApiClient.parameterToString({{paramName}})); - } - - {{/headerParams}} {{#constantParams}} {{#isHeaderParam}} // Set client side default value of Header Param "{{baseName}}". @@ -230,6 +225,15 @@ public class {{classname}} { if (localVarContentType != null) { localVarHeaderParams.put("Content-Type", localVarContentType); } + {{^dynamicOperations}} + {{#headerParams}} + + if ({{paramName}} != null) { + localVarHeaderParams.put("{{baseName}}", localVarApiClient.parameterToString({{paramName}})); + } + + {{/headerParams}} + {{/dynamicOperations}} String[] localVarAuthNames = new String[] { {{#withAWSV4Signature}}"AWS4Auth"{{/withAWSV4Signature}}{{#authMethods}}{{#-first}}{{#withAWSV4Signature}}, {{/withAWSV4Signature}}{{/-first}}"{{name}}"{{^-last}}, {{/-last}}{{/authMethods}} }; return localVarApiClient.buildCall(basePath, localVarPath, {{^dynamicOperations}}"{{httpMethod}}"{{/dynamicOperations}}{{#dynamicOperations}}apiOperation.getMethod(){{/dynamicOperations}}, localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback); @@ -287,7 +291,8 @@ public class {{classname}} { * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -327,7 +332,8 @@ public class {{classname}} { * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -395,7 +401,8 @@ public class {{classname}} { * @throws ApiException If fail to process the API call, e.g. serializing the request body object {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -455,7 +462,8 @@ public class {{classname}} { * @throws ApiException If fail to serialize the request body object {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -479,7 +487,8 @@ public class {{classname}} { * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -511,7 +520,8 @@ public class {{classname}} { * @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -543,7 +553,8 @@ public class {{classname}} { * @throws ApiException If fail to process the API call, e.g. serializing the request body object {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} @@ -569,7 +580,8 @@ public class {{classname}} { * @return API{{operationId}}Request {{#responses.0}} * @http.response.details -
Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}
+
+ {{#responses}} diff --git a/templates/libraries/okhttp-gson/api_test.mustache b/templates/libraries/okhttp-gson/api_test.mustache index 29f6826..b56bdf4 100644 --- a/templates/libraries/okhttp-gson/api_test.mustache +++ b/templates/libraries/okhttp-gson/api_test.mustache @@ -17,8 +17,8 @@ import java.io.InputStream; {{/supportStreaming}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/okhttp-gson/build.gradle.mustache b/templates/libraries/okhttp-gson/build.gradle.mustache index eb67fc1..1b52725 100644 --- a/templates/libraries/okhttp-gson/build.gradle.mustache +++ b/templates/libraries/okhttp-gson/build.gradle.mustache @@ -126,7 +126,7 @@ dependencies { {{#hasOAuthMethods}} implementation group: 'org.apache.oltu.oauth2', name: 'org.apache.oltu.oauth2.client', version: '1.0.2' {{/hasOAuthMethods}} - implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.12.0' + implementation group: 'org.apache.commons', name: 'commons-lang3', version: '3.17.0' {{#joda}} implementation 'joda-time:joda-time:2.9.9' {{/joda}} diff --git a/templates/libraries/okhttp-gson/build.sbt.mustache b/templates/libraries/okhttp-gson/build.sbt.mustache index 2045b84..54bd804 100644 --- a/templates/libraries/okhttp-gson/build.sbt.mustache +++ b/templates/libraries/okhttp-gson/build.sbt.mustache @@ -13,7 +13,7 @@ lazy val root = (project in file(".")). "com.squareup.okhttp3" % "okhttp" % "4.12.0", "com.squareup.okhttp3" % "logging-interceptor" % "4.12.0", "com.google.code.gson" % "gson" % "2.9.1", - "org.apache.commons" % "commons-lang3" % "3.12.0", + "org.apache.commons" % "commons-lang3" % "3.17.0", "jakarta.ws.rs" % "jakarta.ws.rs-api" % "2.1.6", {{#openApiNullable}} "org.openapitools" % "jackson-databind-nullable" % "0.2.6", diff --git a/templates/libraries/okhttp-gson/model.mustache b/templates/libraries/okhttp-gson/model.mustache index c82b0fb..3a1cca8 100644 --- a/templates/libraries/okhttp-gson/model.mustache +++ b/templates/libraries/okhttp-gson/model.mustache @@ -21,8 +21,8 @@ import android.os.Parcelable; import android.os.Parcel; {{/parcelableModel}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} import org.hibernate.validator.constraints.*; diff --git a/templates/libraries/okhttp-gson/oneof_model.mustache b/templates/libraries/okhttp-gson/oneof_model.mustache index 31c6326..731b36d 100644 --- a/templates/libraries/okhttp-gson/oneof_model.mustache +++ b/templates/libraries/okhttp-gson/oneof_model.mustache @@ -361,7 +361,7 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im {{#composedSchemas}} {{#oneOf}} - {{^vendorExtensions.x-duplicated-data-type}} + {{^vendorExtensions.x-duplicated-data-type-ignoring-erasure}} /** * Get the actual instance of `{{{dataType}}}`. If the actual instance is not `{{{dataType}}}`, * the ClassCastException will be thrown. @@ -372,10 +372,10 @@ public class {{classname}} extends AbstractOpenApiSchema{{#vendorExtensions.x-im public {{{dataType}}} get{{#sanitizeGeneric}}{{{dataType}}}{{/sanitizeGeneric}}() throws ClassCastException { return ({{{dataType}}})super.getActualInstance(); } - {{/vendorExtensions.x-duplicated-data-type}} + + {{/vendorExtensions.x-duplicated-data-type-ignoring-erasure}} {{/oneOf}} {{/composedSchemas}} - /** * Validates the JSON Element and throws an exception if issues found * diff --git a/templates/libraries/okhttp-gson/pojo.mustache b/templates/libraries/okhttp-gson/pojo.mustache index 0a32ef0..3d76d23 100644 --- a/templates/libraries/okhttp-gson/pojo.mustache +++ b/templates/libraries/okhttp-gson/pojo.mustache @@ -70,6 +70,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#vendorExtensions.x-field-extra-annotation}} {{{vendorExtensions.x-field-extra-annotation}}} {{/vendorExtensions.x-field-extra-annotation}} + {{>nullable_var_annotations}} {{#isDiscriminator}}protected{{/isDiscriminator}}{{^isDiscriminator}}private{{/isDiscriminator}} {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; {{/vars}} @@ -80,6 +81,11 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{/parcelableModel}} {{/parent}} {{#discriminator}} + {{#discriminator.isEnum}} +{{#readWriteVars}}{{#isDiscriminator}}{{#defaultValue}} + this.{{name}} = {{defaultValue}}; +{{/defaultValue}}{{/isDiscriminator}}{{/readWriteVars}} + {{/discriminator.isEnum}} {{^discriminator.isEnum}} this.{{{discriminatorName}}} = this.getClass().getSimpleName(); {{/discriminator.isEnum}} @@ -106,7 +112,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { this.{{name}} = {{name}}; return this; } @@ -153,17 +159,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#useBeanValidation}} {{>beanValidation}} {{/useBeanValidation}} @@ -183,7 +179,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{^isReadOnly}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} {{/vendorExtensions.x-setter-extra-annotation}}{{#deprecated}} @Deprecated -{{/deprecated}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/deprecated}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { this.{{name}} = {{name}}; } {{/isReadOnly}} diff --git a/templates/libraries/okhttp-gson/pom.mustache b/templates/libraries/okhttp-gson/pom.mustache index def53f2..5e7bd9b 100644 --- a/templates/libraries/okhttp-gson/pom.mustache +++ b/templates/libraries/okhttp-gson/pom.mustache @@ -414,7 +414,7 @@ {{/swagger2AnnotationLibrary}} 4.12.02.10.1 - 3.14.0 + 3.17.0 {{#openApiNullable}} 0.2.6 {{/openApiNullable}} @@ -423,16 +423,15 @@ {{/joda}} {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} {{#performBeanValidation}} 3.0.3 {{/performBeanValidation}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} 5.10.31.10.02.1.6 diff --git a/templates/libraries/rest-assured/JacksonObjectMapper.mustache b/templates/libraries/rest-assured/JacksonObjectMapper.mustache index 8919eda..3d875d6 100644 --- a/templates/libraries/rest-assured/JacksonObjectMapper.mustache +++ b/templates/libraries/rest-assured/JacksonObjectMapper.mustache @@ -27,7 +27,7 @@ public class JacksonObjectMapper extends Jackson2Mapper { ObjectMapper mapper = new ObjectMapper(); mapper = new ObjectMapper(); mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); - mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); mapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING); diff --git a/templates/libraries/rest-assured/api.mustache b/templates/libraries/rest-assured/api.mustache index 5ae6e50..1eae542 100644 --- a/templates/libraries/rest-assured/api.mustache +++ b/templates/libraries/rest-assured/api.mustache @@ -33,8 +33,8 @@ import io.swagger.v3.oas.annotations.security.*; {{/swagger2AnnotationLibrary}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import java.lang.reflect.Type; @@ -146,7 +146,7 @@ public class {{classname}} { public static class {{operationIdCamelCase}}Oper implements Oper { public static final Method REQ_METHOD = {{httpMethod}}; - public static final String REQ_URI = "{{path}}"; + public static final String REQ_URI = "{{{path}}}"; private RequestSpecBuilder reqSpec; private ResponseSpecBuilder respSpec; @@ -155,15 +155,15 @@ public class {{classname}} { this.reqSpec = reqSpec; {{#vendorExtensions}} {{#x-content-type}} - reqSpec.setContentType("{{x-content-type}}"); + reqSpec.setContentType("{{{x-content-type}}}"); {{/x-content-type}} - reqSpec.setAccept("{{#x-accepts}}{{.}}{{^-last}},{{/-last}}{{/x-accepts}}"); + reqSpec.setAccept("{{#x-accepts}}{{{.}}}{{^-last}},{{/-last}}{{/x-accepts}}"); {{/vendorExtensions}} this.respSpec = new ResponseSpecBuilder(); } /** - * {{httpMethod}} {{path}} + * {{httpMethod}} {{{path}}} * @param handler handler * @param type * @return type @@ -175,7 +175,7 @@ public class {{classname}} { {{#returnType}} /** - * {{httpMethod}} {{path}} + * {{httpMethod}} {{{path}}} * @param handler handler * @return {{returnType}} */ diff --git a/templates/libraries/rest-assured/api_test.mustache b/templates/libraries/rest-assured/api_test.mustache index d7d9dae..adcbd80 100644 --- a/templates/libraries/rest-assured/api_test.mustache +++ b/templates/libraries/rest-assured/api_test.mustache @@ -20,8 +20,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import static io.restassured.config.ObjectMapperConfig.objectMapperConfig; diff --git a/templates/libraries/rest-assured/pom.mustache b/templates/libraries/rest-assured/pom.mustache index 396dd69..1655d52 100644 --- a/templates/libraries/rest-assured/pom.mustache +++ b/templates/libraries/rest-assured/pom.mustache @@ -358,13 +358,12 @@ {{/jackson}} {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} 3.6.0 5.10.3 diff --git a/templates/libraries/restclient/ApiClient.mustache b/templates/libraries/restclient/ApiClient.mustache index 14b1af4..e5a4bd8 100644 --- a/templates/libraries/restclient/ApiClient.mustache +++ b/templates/libraries/restclient/ApiClient.mustache @@ -44,6 +44,7 @@ import java.util.List; import java.util.Map; import java.util.Map.Entry; import java.util.TimeZone; +import java.util.function.Supplier; import {{javaxPackage}}.annotation.Nullable; @@ -87,29 +88,26 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { public ApiClient() { - this.dateFormat = createDefaultDateFormat(); - this.objectMapper = createDefaultObjectMapper(this.dateFormat); - this.restClient = buildRestClient(this.objectMapper); - this.init(); + this(null); } public ApiClient(RestClient restClient) { - this(Optional.ofNullable(restClient).orElseGet(ApiClient::buildRestClient), createDefaultDateFormat()); + this(restClient, createDefaultDateFormat()); } public ApiClient(ObjectMapper mapper, DateFormat format) { - this(buildRestClient(mapper.copy()), format); + this(null, mapper, format); } public ApiClient(RestClient restClient, ObjectMapper mapper, DateFormat format) { - this(Optional.ofNullable(restClient).orElseGet(() -> buildRestClient(mapper.copy())), format); + this.objectMapper = mapper.copy(); + this.restClient = Optional.ofNullable(restClient).orElseGet(() -> buildRestClient(this.objectMapper)); + this.dateFormat = format; + this.init(); } private ApiClient(RestClient restClient, DateFormat format) { - this.restClient = restClient; - this.dateFormat = format; - this.objectMapper = createDefaultObjectMapper(format); - this.init(); + this(restClient, createDefaultObjectMapper(format), format); } public static DateFormat createDefaultDateFormat() { @@ -125,7 +123,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { ObjectMapper mapper = new ObjectMapper(); mapper.setDateFormat(dateFormat); mapper.registerModule(new JavaTimeModule()); - mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); {{#openApiNullable}} JsonNullableModule jnm = new JsonNullableModule(); mapper.registerModule(jnm); @@ -159,9 +157,9 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { {{/withXml}} Consumer>> messageConverters = converters -> { - converters.add(new MappingJackson2HttpMessageConverter(mapper)); + converters.add(0, new MappingJackson2HttpMessageConverter(mapper)); {{#withXml}} - converters.add(new MappingJackson2XmlHttpMessageConverter(xmlMapper)); + converters.add(0, new MappingJackson2XmlHttpMessageConverter(xmlMapper)); {{/withXml}} }; @@ -243,6 +241,21 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { throw new RuntimeException("No Bearer authentication configured!"); } + /** + * Helper method to set the supplier of access tokens for Bearer authentication. + * + * @param tokenSupplier the token supplier function + */ + public void setBearerToken(Supplier tokenSupplier) { + for (Authentication auth : authentications.values()) { + if (auth instanceof HttpBearerAuth) { + ((HttpBearerAuth) auth).setBearerToken(tokenSupplier); + return; + } + } + throw new RuntimeException("No Bearer authentication configured!"); + } + /** * Helper method to set username for the first HTTP basic authentication. * @param username the username @@ -753,4 +766,4 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { return collectionFormat.collectionToString(values); } -} \ No newline at end of file +} diff --git a/templates/libraries/restclient/api.mustache b/templates/libraries/restclient/api.mustache index 1475fc0..0fff00e 100644 --- a/templates/libraries/restclient/api.mustache +++ b/templates/libraries/restclient/api.mustache @@ -11,6 +11,11 @@ import java.util.Locale; import java.util.Map; import java.util.stream.Collectors; +{{#useBeanValidation}} +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; + +{{/useBeanValidation}} import org.springframework.beans.factory.annotation.Autowired; import org.springframework.util.LinkedMultiValueMap; import org.springframework.util.MultiValueMap; @@ -47,6 +52,91 @@ public class {{classname}} { } {{#operation}} +{{#singleRequestParameter}} +{{#hasParams}} +{{^hasSingleParam}} + + {{^staticRequest}} + public record {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request({{#allParams}}{{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}){} + {{/staticRequest}} + {{#staticRequest}} + public static class {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request { + {{#allParams}} + private {{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}; + {{/allParams}} + + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request() {} + + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request({{#allParams}}{{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) { + {{#allParams}} + this.{{paramName}} = {{paramName}}; + {{/allParams}} + } + + {{#allParams}} + public {{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}() { + return this.{{paramName}}; + } + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request {{paramName}}({{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}) { + this.{{paramName}} = {{paramName}}; + return this; + } + + {{/allParams}} + } + {{/staticRequest}} + + /** + * {{summary}} + * {{notes}} +{{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} +{{/responses}} * @param requestParameters The {{operationId}} request parameters as object +{{#returnType}} * @return {{.}} +{{/returnType}} * @throws RestClientResponseException if an error occurs while attempting to invoke the API +{{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation +{{/externalDocs}} + */ + public {{#returnType}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}} {{/returnType}}{{^returnType}}void {{/returnType}}{{operationId}}({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws RestClientResponseException { + {{#returnType}}return {{/returnType}}this.{{operationId}}({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + + /** + * {{summary}} + * {{notes}} +{{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} +{{/responses}} * @param requestParameters The {{operationId}} request parameters as object +{{#returnType}} * @return ResponseEntity<{{.}}> +{{/returnType}} * @throws RestClientResponseException if an error occurs while attempting to invoke the API +{{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation +{{/externalDocs}} + */ + public {{#returnType}}ResponseEntity<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}>{{/returnType}}{{^returnType}}ResponseEntity{{/returnType}} {{operationId}}WithHttpInfo({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws RestClientResponseException { + return this.{{operationId}}WithHttpInfo({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + + /** + * {{summary}} + * {{notes}} +{{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} +{{/responses}} * @param requestParameters The {{operationId}} request parameters as object + * @return ResponseSpec + * @throws RestClientResponseException if an error occurs while attempting to invoke the API +{{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation +{{/externalDocs}} + */ + public ResponseSpec {{operationId}}WithResponseSpec({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws RestClientResponseException { + return this.{{operationId}}WithResponseSpec({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + +{{/hasSingleParam}} +{{/hasParams}} +{{/singleRequestParameter}} /** * {{summary}} * {{notes}} diff --git a/templates/libraries/restclient/api_test.mustache b/templates/libraries/restclient/api_test.mustache index dc34083..e54a4cc 100644 --- a/templates/libraries/restclient/api_test.mustache +++ b/templates/libraries/restclient/api_test.mustache @@ -4,8 +4,8 @@ package {{package}}; {{#imports}}import {{import}}; {{/imports}} -import org.junit.Test; -import org.junit.Ignore; +import org.junit.jupiter.api.Disabled; +import org.junit.jupiter.api.Test; import java.util.ArrayList; import java.util.HashMap; @@ -13,10 +13,15 @@ import java.util.List; import java.util.Map; import java.util.stream.Collectors; +{{#useBeanValidation}} +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; + +{{/useBeanValidation}} /** * API tests for {{classname}} */ -@Ignore +@Disabled public class {{classname}}Test { private final {{classname}} api = new {{classname}}(); diff --git a/templates/libraries/restclient/auth/OAuth.mustache b/templates/libraries/restclient/auth/OAuth.mustache index 1e1e624..1b7ad33 100644 --- a/templates/libraries/restclient/auth/OAuth.mustache +++ b/templates/libraries/restclient/auth/OAuth.mustache @@ -2,25 +2,49 @@ package {{invokerPackage}}.auth; +import java.util.Optional; +import java.util.function.Supplier; import org.springframework.http.HttpHeaders; import org.springframework.util.MultiValueMap; +/** + * Provides support for RFC 6750 - Bearer Token usage for OAUTH 2.0 Authorization. + */ {{>generatedAnnotation}} public class OAuth implements Authentication { - private String accessToken; + private Supplier tokenSupplier; + /** + * Returns the bearer token used for Authorization. + * + * @return The bearer token + */ public String getAccessToken() { - return accessToken; + return tokenSupplier.get(); } + /** + * Sets the bearer access token used for Authorization. + * + * @param accessToken The bearer token to send in the Authorization header + */ public void setAccessToken(String accessToken) { - this.accessToken = accessToken; + setAccessToken(() -> accessToken); + } + + /** + * Sets the supplier of bearer tokens used for Authorization. + * + * @param tokenSupplier The supplier of bearer tokens to send in the Authorization header + */ + public void setAccessToken(Supplier tokenSupplier) { + this.tokenSupplier = tokenSupplier; } @Override public void applyToParams(MultiValueMap queryParams, HttpHeaders headerParams, MultiValueMap cookieParams) { - if (accessToken != null) { - headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken); - } + Optional.ofNullable(tokenSupplier).map(Supplier::get).ifPresent(accessToken -> + headerParams.add(HttpHeaders.AUTHORIZATION, "Bearer " + accessToken) + ); } } diff --git a/templates/libraries/restclient/pom.mustache b/templates/libraries/restclient/pom.mustache index d3f6ab6..f926d47 100644 --- a/templates/libraries/restclient/pom.mustache +++ b/templates/libraries/restclient/pom.mustache @@ -73,7 +73,7 @@ -Xms512m -Xmx1500m methods - pertest + false true @@ -337,12 +337,6 @@ ${junit-version} test - - org.junit.platform - junit-platform-runner - ${junit-platform-runner.version} - test - UTF-8 @@ -362,13 +356,10 @@ {{#joda}} 2.9.9 {{/joda}} - {{#useBeanValidation}} 3.0.2 - {{/useBeanValidation}} {{#performBeanValidation}} 5.4.3.Final {{/performBeanValidation}} 5.10.2 - 1.10.0 diff --git a/templates/libraries/resteasy/JSON.mustache b/templates/libraries/resteasy/JSON.mustache index b572830..e4097fc 100644 --- a/templates/libraries/resteasy/JSON.mustache +++ b/templates/libraries/resteasy/JSON.mustache @@ -20,7 +20,7 @@ public class JSON implements ContextResolver { public JSON() { mapper = new ObjectMapper(); mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); - mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); mapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false); mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); mapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING); diff --git a/templates/libraries/resttemplate/additional_properties.mustache b/templates/libraries/resttemplate/additional_properties.mustache new file mode 100644 index 0000000..8e71827 --- /dev/null +++ b/templates/libraries/resttemplate/additional_properties.mustache @@ -0,0 +1,45 @@ +{{#additionalPropertiesType}} + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + * @param key the name of the property + * @param value the value of the property + * @return self reference + */ + @JsonAnySetter + public {{classname}} putAdditionalProperty(String key, {{{.}}} value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) properties. + * @return the additional (undeclared) properties + */ + @JsonAnyGetter + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + * @param key the name of the property + * @return the additional (undeclared) property with the specified name + */ + public {{{.}}} getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } +{{/additionalPropertiesType}} diff --git a/templates/libraries/resttemplate/api.mustache b/templates/libraries/resttemplate/api.mustache index aa1a98f..6cf5137 100644 --- a/templates/libraries/resttemplate/api.mustache +++ b/templates/libraries/resttemplate/api.mustache @@ -14,8 +14,8 @@ import java.util.Map; import java.util.stream.Collectors; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import org.springframework.beans.factory.annotation.Autowired; diff --git a/templates/libraries/resttemplate/api_test.mustache b/templates/libraries/resttemplate/api_test.mustache index 04a19f1..e1a213c 100644 --- a/templates/libraries/resttemplate/api_test.mustache +++ b/templates/libraries/resttemplate/api_test.mustache @@ -16,8 +16,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/resttemplate/auth/OAuth.mustache b/templates/libraries/resttemplate/auth/OAuth.mustache index 1e82042..1b7ad33 100644 --- a/templates/libraries/resttemplate/auth/OAuth.mustache +++ b/templates/libraries/resttemplate/auth/OAuth.mustache @@ -26,7 +26,7 @@ public class OAuth implements Authentication { /** * Sets the bearer access token used for Authorization. * - * @param bearerToken The bearer token to send in the Authorization header + * @param accessToken The bearer token to send in the Authorization header */ public void setAccessToken(String accessToken) { setAccessToken(() -> accessToken); diff --git a/templates/libraries/resttemplate/build.gradle.mustache b/templates/libraries/resttemplate/build.gradle.mustache index a900fc8..edd170c 100644 --- a/templates/libraries/resttemplate/build.gradle.mustache +++ b/templates/libraries/resttemplate/build.gradle.mustache @@ -123,10 +123,12 @@ ext { {{#useJakartaEe}} spring_web_version = "6.1.5" jakarta_annotation_version = "2.1.1" + beanvalidation_version = "3.0.2" {{/useJakartaEe}} {{^useJakartaEe}} - spring_web_version = "5.3.33" + spring_web_version = "6.1.13" jakarta_annotation_version = "1.3.5" + beanvalidation_version = "2.0.2" {{/useJakartaEe}} jodatime_version = "2.9.9" junit_version = "5.10.2" @@ -145,7 +147,12 @@ dependencies { implementation "com.fasterxml.jackson.core:jackson-core:$jackson_version" implementation "com.fasterxml.jackson.core:jackson-annotations:$jackson_version" implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_databind_version" + {{^useJakartaEe}} implementation "com.fasterxml.jackson.jaxrs:jackson-jaxrs-json-provider:$jackson_version" + {{/useJakartaEe}} + {{#useJakartaEe}} + implementation "com.fasterxml.jackson.jakarta.rs:jackson-jakarta-rs-json-provider:$jackson_version" + {{/useJakartaEe}} {{#openApiNullable}} implementation "org.openapitools:jackson-databind-nullable:$jackson_databind_nullable_version" {{/openApiNullable}} diff --git a/templates/libraries/resttemplate/model.mustache b/templates/libraries/resttemplate/model.mustache new file mode 100644 index 0000000..108748f --- /dev/null +++ b/templates/libraries/resttemplate/model.mustache @@ -0,0 +1,78 @@ +{{>licenseInfo}} + +package {{package}}; + +{{#useReflectionEqualsHashCode}} +import org.apache.commons.lang3.builder.EqualsBuilder; +import org.apache.commons.lang3.builder.HashCodeBuilder; +{{/useReflectionEqualsHashCode}} +{{#models}} +{{#model}} +{{#additionalPropertiesType}} +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +{{/additionalPropertiesType}} +{{/model}} +{{/models}} +import java.util.Objects; +import java.util.Arrays; +{{#imports}} +import {{import}}; +{{/imports}} +{{#serializableModel}} +import java.io.Serializable; +{{/serializableModel}} +{{#jackson}} +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonTypeName; +{{#withXml}} +import com.fasterxml.jackson.dataformat.xml.annotation.*; +{{/withXml}} +{{#vendorExtensions.x-has-readonly-properties}} +import com.fasterxml.jackson.annotation.JsonCreator; +{{/vendorExtensions.x-has-readonly-properties}} +{{/jackson}} +{{#withXml}} +import {{javaxPackage}}.xml.bind.annotation.*; +import {{javaxPackage}}.xml.bind.annotation.adapters.*; +import io.github.threetenjaxb.core.*; +{{/withXml}} +{{#jsonb}} +import java.lang.reflect.Type; +import {{javaxPackage}}.json.bind.annotation.JsonbTypeDeserializer; +import {{javaxPackage}}.json.bind.annotation.JsonbTypeSerializer; +import {{javaxPackage}}.json.bind.serializer.DeserializationContext; +import {{javaxPackage}}.json.bind.serializer.JsonbDeserializer; +import {{javaxPackage}}.json.bind.serializer.JsonbSerializer; +import {{javaxPackage}}.json.bind.serializer.SerializationContext; +import {{javaxPackage}}.json.stream.JsonGenerator; +import {{javaxPackage}}.json.stream.JsonParser; +import {{javaxPackage}}.json.bind.annotation.JsonbProperty; +{{#vendorExtensions.x-has-readonly-properties}} +import {{javaxPackage}}.json.bind.annotation.JsonbCreator; +{{/vendorExtensions.x-has-readonly-properties}} +{{/jsonb}} +{{#parcelableModel}} +import android.os.Parcelable; +import android.os.Parcel; +{{/parcelableModel}} +{{#useBeanValidation}} +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; +{{/useBeanValidation}} +{{#performBeanValidation}} +import org.hibernate.validator.constraints.*; +{{/performBeanValidation}} +{{#supportUrlQuery}} +import java.io.UnsupportedEncodingException; +import java.net.URLEncoder; +import java.util.StringJoiner; +{{/supportUrlQuery}} + +{{#models}} +{{#model}} +{{#isEnum}}{{>modelEnum}}{{/isEnum}}{{^isEnum}}{{#vendorExtensions.x-is-one-of-interface}}{{>oneof_interface}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{>pojo}}{{/vendorExtensions.x-is-one-of-interface}}{{/isEnum}} +{{/model}} +{{/models}} diff --git a/templates/libraries/resttemplate/pojo.mustache b/templates/libraries/resttemplate/pojo.mustache new file mode 100644 index 0000000..192b701 --- /dev/null +++ b/templates/libraries/resttemplate/pojo.mustache @@ -0,0 +1,620 @@ +/** + * {{description}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}} + * @deprecated{{/isDeprecated}} + */{{#isDeprecated}} +@Deprecated{{/isDeprecated}} +{{#swagger1AnnotationLibrary}} +{{#description}} +@ApiModel(description = "{{{.}}}") +{{/description}} +{{/swagger1AnnotationLibrary}} +{{#swagger2AnnotationLibrary}} +{{#description}} +@Schema(description = "{{{.}}}") +{{/description}} +{{/swagger2AnnotationLibrary}} +{{#jackson}} +@JsonPropertyOrder({ +{{#vars}} + {{classname}}.JSON_PROPERTY_{{nameInSnakeCase}}{{^-last}},{{/-last}} +{{/vars}} +}) +{{#isClassnameSanitized}} +{{^hasDiscriminatorWithNonEmptyMapping}} +@JsonTypeName("{{name}}") +{{/hasDiscriminatorWithNonEmptyMapping}} +{{/isClassnameSanitized}} +{{/jackson}} +{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}} +{{#vendorExtensions.x-class-extra-annotation}} +{{{vendorExtensions.x-class-extra-annotation}}} +{{/vendorExtensions.x-class-extra-annotation}} +public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtensions.x-implements}}{{#-first}}implements {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{#-last}} {{/-last}}{{/vendorExtensions.x-implements}}{ +{{#serializableModel}} + private static final long serialVersionUID = 1L; + +{{/serializableModel}} + {{#vars}} + {{#isEnum}} + {{^isContainer}} +{{>modelInnerEnum}} + {{/isContainer}} + {{#isContainer}} + {{#mostInnerItems}} +{{>modelInnerEnum}} + {{/mostInnerItems}} + {{/isContainer}} + {{/isEnum}} + {{#gson}} + public static final String SERIALIZED_NAME_{{nameInSnakeCase}} = "{{baseName}}"; + {{/gson}} + {{#jackson}} + public static final String JSON_PROPERTY_{{nameInSnakeCase}} = "{{baseName}}"; + {{/jackson}} + {{#withXml}} + @Xml{{#isXmlAttribute}}Attribute{{/isXmlAttribute}}{{^isXmlAttribute}}Element{{/isXmlAttribute}}(name = "{{items.xmlName}}{{^items.xmlName}}{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}{{/items.xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}}) + {{#isXmlWrapped}} + @XmlElementWrapper(name = "{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}}) + {{/isXmlWrapped}} + {{^isXmlAttribute}} + {{#isDateTime}} + @XmlJavaTypeAdapter(OffsetDateTimeXmlAdapter.class) + {{/isDateTime}} + {{/isXmlAttribute}} + {{/withXml}} + {{#gson}} + @SerializedName(SERIALIZED_NAME_{{nameInSnakeCase}}) + {{/gson}} + {{>nullable_var_annotations}} + {{#vendorExtensions.x-field-extra-annotation}} + {{{vendorExtensions.x-field-extra-annotation}}} + {{/vendorExtensions.x-field-extra-annotation}} + {{#vendorExtensions.x-is-jackson-optional-nullable}} + {{#isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} JsonNullable<{{{datatypeWithEnum}}}> {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>undefined(); + {{/isContainer}} + {{^isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} JsonNullable<{{{datatypeWithEnum}}}> {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>{{#defaultValue}}of({{{.}}}){{/defaultValue}}{{^defaultValue}}undefined(){{/defaultValue}}; + {{/isContainer}} + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{#isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; + {{/isContainer}} + {{^isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; + {{/isContainer}} + {{/vendorExtensions.x-is-jackson-optional-nullable}} + + {{/vars}} + public {{classname}}() { + {{#parent}} + {{#parcelableModel}} + super();{{/parcelableModel}} + {{/parent}} + {{#gson}} + {{#discriminator}} + {{#discriminator.isEnum}} + this.{{{discriminatorName}}} = this.getClass().getSimpleName(); + {{/discriminator.isEnum}} + {{/discriminator}} + {{/gson}} + } + {{#vendorExtensions.x-has-readonly-properties}} + {{^withXml}} + /** + * Constructor with only readonly parameters{{#generateConstructorWithAllArgs}}{{^vendorExtensions.x-java-all-args-constructor}} and all parameters{{/vendorExtensions.x-java-all-args-constructor}}{{/generateConstructorWithAllArgs}} + */ + {{#jsonb}}@JsonbCreator{{/jsonb}}{{#jackson}}@JsonCreator{{/jackson}} + public {{classname}}( + {{#readOnlyVars}} + {{#jsonb}}@JsonbProperty(value = "{{baseName}}"{{^required}}, nullable = true{{/required}}){{/jsonb}}{{#jackson}}@JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}){{/jackson}} {{{datatypeWithEnum}}} {{name}}{{^-last}}, {{/-last}} + {{/readOnlyVars}} + ) { + this(); + {{#readOnlyVars}} + this.{{name}} = {{#vendorExtensions.x-is-jackson-optional-nullable}}{{name}} == null ? JsonNullable.<{{{datatypeWithEnum}}}>undefined() : JsonNullable.of({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{name}}{{/vendorExtensions.x-is-jackson-optional-nullable}}; + {{/readOnlyVars}} + } + {{/withXml}} + {{/vendorExtensions.x-has-readonly-properties}} +{{#vendorExtensions.x-java-all-args-constructor}} + + /** + * Constructor with all args parameters + */ + public {{classname}}({{#vendorExtensions.x-java-all-args-constructor-vars}}{{#jsonb}}@JsonbProperty(value = "{{baseName}}"{{^required}}, nullable = true{{/required}}){{/jsonb}}{{#jackson}}@JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}){{/jackson}} {{{datatypeWithEnum}}} {{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.x-java-all-args-constructor-vars}}) { +{{#parent}} + super({{#parentVars}}{{name}}{{^-last}}, {{/-last}}{{/parentVars}}); +{{/parent}} + {{#vars}} + this.{{name}} = {{#vendorExtensions.x-is-jackson-optional-nullable}}{{name}} == null ? JsonNullable.<{{{datatypeWithEnum}}}>undefined() : JsonNullable.of({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{name}}{{/vendorExtensions.x-is-jackson-optional-nullable}}; +{{/vars}} + } +{{/vendorExtensions.x-java-all-args-constructor}} + +{{#vars}} + {{^isReadOnly}} + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}});{{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = {{name}};{{/vendorExtensions.x-is-jackson-optional-nullable}} + return this; + } + {{#isArray}} + + public {{classname}} add{{nameInPascalCase}}Item({{{items.datatypeWithEnum}}} {{name}}Item) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null || !this.{{name}}.isPresent()) { + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}ArrayList{{/uniqueItems}}<>(){{/defaultValue}}); + } + try { + this.{{name}}.get().add({{name}}Item); + } catch (java.util.NoSuchElementException e) { + // this can never happen, as we make sure above that the value is present + } + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null) { + this.{{name}} = {{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}ArrayList{{/uniqueItems}}<>(){{/defaultValue}}; + } + this.{{name}}.add({{name}}Item); + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isArray}} + {{#isMap}} + + public {{classname}} put{{nameInPascalCase}}Item(String key, {{{items.datatypeWithEnum}}} {{name}}Item) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null || !this.{{name}}.isPresent()) { + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{{defaultValue}}}{{^defaultValue}}new HashMap<>(){{/defaultValue}}); + } + try { + this.{{name}}.get().put(key, {{name}}Item); + } catch (java.util.NoSuchElementException e) { + // this can never happen, as we make sure above that the value is present + } + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{^required}} + if (this.{{name}} == null) { + this.{{name}} = {{{defaultValue}}}{{^defaultValue}}new HashMap<>(){{/defaultValue}}; + } + {{/required}} + this.{{name}}.put(key, {{name}}Item); + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isMap}} + + {{/isReadOnly}} + /** + {{#description}} + * {{.}} + {{/description}} + {{^description}} + * Get {{name}} + {{/description}} + {{#minimum}} + * minimum: {{.}} + {{/minimum}} + {{#maximum}} + * maximum: {{.}} + {{/maximum}} + * @return {{name}} + {{#deprecated}} + * @deprecated + {{/deprecated}} + */ +{{#deprecated}} + @Deprecated +{{/deprecated}} + {{>nullable_var_annotations}} +{{#jsonb}} + @JsonbProperty("{{baseName}}") +{{/jsonb}} +{{#useBeanValidation}} +{{>beanValidation}} +{{/useBeanValidation}} +{{#swagger1AnnotationLibrary}} + @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}") +{{/swagger1AnnotationLibrary}} +{{#swagger2AnnotationLibrary}} + @Schema({{#example}}example = "{{{.}}}", {{/example}}requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}}, description = "{{{description}}}") +{{/swagger2AnnotationLibrary}} +{{#vendorExtensions.x-extra-annotation}} + {{{vendorExtensions.x-extra-annotation}}} +{{/vendorExtensions.x-extra-annotation}} +{{#vendorExtensions.x-is-jackson-optional-nullable}} + {{!unannotated, Jackson would pick this up automatically and add it *in addition* to the _JsonNullable getter field}} + @JsonIgnore +{{/vendorExtensions.x-is-jackson-optional-nullable}} +{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#jackson}}{{> jackson_annotations}}{{/jackson}}{{/vendorExtensions.x-is-jackson-optional-nullable}} + public {{{datatypeWithEnum}}} {{getter}}() { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + {{#isReadOnly}}{{! A readonly attribute doesn't have setter => jackson will set null directly if explicitly returned by API, so make sure we have an empty JsonNullable}} + if ({{name}} == null) { + {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>{{#defaultValue}}of({{{.}}}){{/defaultValue}}{{^defaultValue}}undefined(){{/defaultValue}}; + } + {{/isReadOnly}} + return {{name}}.orElse(null); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + return {{name}}; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + + {{#vendorExtensions.x-is-jackson-optional-nullable}} +{{> jackson_annotations}} + public JsonNullable<{{{datatypeWithEnum}}}> {{getter}}_JsonNullable() { + return {{name}}; + } + {{/vendorExtensions.x-is-jackson-optional-nullable}}{{#vendorExtensions.x-is-jackson-optional-nullable}} + @JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}) + {{#isReadOnly}}private{{/isReadOnly}}{{^isReadOnly}}public{{/isReadOnly}} void {{setter}}_JsonNullable(JsonNullable<{{{datatypeWithEnum}}}> {{name}}) { + {{! For getters/setters that have name differing from attribute name, we must include setter (albeit private) for jackson to be able to set the attribute}} + this.{{name}} = {{name}}; + } + {{/vendorExtensions.x-is-jackson-optional-nullable}} + + {{^isReadOnly}} +{{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}}); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + this.{{name}} = {{name}}; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isReadOnly}} + + {{/vars}} +{{>libraries/resttemplate/additional_properties}} + {{#parent}} + {{#readWriteVars}} + {{#isOverridden}} + @Override + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + this.{{setter}}(JsonNullable.<{{{datatypeWithEnum}}}>of({{name}})); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + this.{{setter}}({{name}}); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + return this; + } + + {{/isOverridden}} + {{/readWriteVars}} + {{/parent}} + @Override + public boolean equals(Object o) { + {{#useReflectionEqualsHashCode}} + return EqualsBuilder.reflectionEquals(this, o, false, null, true); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + }{{#hasVars}} + {{classname}} {{classVarName}} = ({{classname}}) o; + return {{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}equalsNullable(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#isByteArray}}Arrays{{/isByteArray}}{{^isByteArray}}Objects{{/isByteArray}}.equals(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}} && + {{/-last}}{{/vars}}{{#additionalPropertiesType}} && + Objects.equals(this.additionalProperties, {{classVarName}}.additionalProperties){{/additionalPropertiesType}}{{#parent}} && + super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}} + return {{#parent}}super.equals(o){{/parent}}{{^parent}}true{{/parent}};{{/hasVars}} + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + @Override + public int hashCode() { + {{#useReflectionEqualsHashCode}} + return HashCodeBuilder.reflectionHashCode(this); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + return Objects.hash({{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}hashCodeNullable({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{^isByteArray}}{{name}}{{/isByteArray}}{{#isByteArray}}Arrays.hashCode({{name}}){{/isByteArray}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}}, {{/-last}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}}{{#additionalPropertiesType}}, additionalProperties{{/additionalPropertiesType}}); + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class {{classname}} {\n"); + {{#parent}} + sb.append(" ").append(toIndentedString(super.toString())).append("\n"); + {{/parent}} + {{#vars}} + sb.append(" {{name}}: ").append({{#isPassword}}"*"{{/isPassword}}{{^isPassword}}toIndentedString({{name}}){{/isPassword}}).append("\n"); + {{/vars}} + {{#additionalPropertiesType}} + sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); + {{/additionalPropertiesType}} + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private{{#jsonb}} static{{/jsonb}} String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +{{#supportUrlQuery}} + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + {{#allVars}} + // add `{{baseName}}` to the URL query string + {{#isArray}} + {{#items.isPrimitiveType}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.datatypeWithEnum}}} _item : {{getter}}()) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf(_item), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + i++; + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf({{getter}}().get(i)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + {{/uniqueItems}} + {{/items.isPrimitiveType}} + {{^items.isPrimitiveType}} + {{#items.isModel}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.dataType}}} _item : {{getter}}()) { + if (_item != null) { + joiner.add(_item.toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + i++; + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + if ({{getter}}().get(i) != null) { + joiner.add({{getter}}().get(i).toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + } + {{/uniqueItems}} + {{/items.isModel}} + {{^items.isModel}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.dataType}}} _item : {{getter}}()) { + if (_item != null) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf(_item), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + i++; + } + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + if ({{getter}}().get(i) != null) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf({{getter}}().get(i)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + } + {{/uniqueItems}} + {{/items.isModel}} + {{/items.isPrimitiveType}} + {{/isArray}} + {{^isArray}} + {{#isMap}} + {{^items.isModel}} + if ({{getter}}() != null) { + for (String _key : {{getter}}().keySet()) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix), + {{getter}}().get(_key), URLEncoder.encode(String.valueOf({{getter}}().get(_key)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + {{/items.isModel}} + {{#items.isModel}} + if ({{getter}}() != null) { + for (String _key : {{getter}}().keySet()) { + if ({{getter}}().get(_key) != null) { + joiner.add({{getter}}().get(_key).toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix)))); + } + } + } + {{/items.isModel}} + {{/isMap}} + {{^isMap}} + {{#isPrimitiveType}} + if ({{getter}}() != null) { + try { + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf({{{getter}}}()), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + {{/isPrimitiveType}} + {{^isPrimitiveType}} + {{#isModel}} + if ({{getter}}() != null) { + joiner.add({{getter}}().toUrlQueryString(prefix + "{{{baseName}}}" + suffix)); + } + {{/isModel}} + {{^isModel}} + if ({{getter}}() != null) { + try { + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf({{{getter}}}()), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + {{/isModel}} + {{/isPrimitiveType}} + {{/isMap}} + {{/isArray}} + + {{/allVars}} + return joiner.toString(); + } +{{/supportUrlQuery}} +{{#parcelableModel}} + + public void writeToParcel(Parcel out, int flags) { +{{#model}} +{{#isArray}} + out.writeList(this); +{{/isArray}} +{{^isArray}} +{{#parent}} + super.writeToParcel(out, flags); +{{/parent}} +{{#vars}} + out.writeValue({{name}}); +{{/vars}} +{{/isArray}} +{{/model}} + } + + {{classname}}(Parcel in) { +{{#isArray}} + in.readTypedList(this, {{arrayModelType}}.CREATOR); +{{/isArray}} +{{^isArray}} +{{#parent}} + super(in); +{{/parent}} +{{#vars}} +{{#isPrimitiveType}} + {{name}} = ({{{datatypeWithEnum}}})in.readValue(null); +{{/isPrimitiveType}} +{{^isPrimitiveType}} + {{name}} = ({{{datatypeWithEnum}}})in.readValue({{complexType}}.class.getClassLoader()); +{{/isPrimitiveType}} +{{/vars}} +{{/isArray}} + } + + public int describeContents() { + return 0; + } + + public static final Parcelable.Creator<{{classname}}> CREATOR = new Parcelable.Creator<{{classname}}>() { + public {{classname}} createFromParcel(Parcel in) { +{{#model}} +{{#isArray}} + {{classname}} result = new {{classname}}(); + result.addAll(in.readArrayList({{arrayModelType}}.class.getClassLoader())); + return result; +{{/isArray}} +{{^isArray}} + return new {{classname}}(in); +{{/isArray}} +{{/model}} + } + public {{classname}}[] newArray(int size) { + return new {{classname}}[size]; + } + }; +{{/parcelableModel}} +{{#generateBuilders}} + + {{>javaBuilder}} +{{/generateBuilders}} + +} diff --git a/templates/libraries/resttemplate/pom.mustache b/templates/libraries/resttemplate/pom.mustache index 250417d..90de86c 100644 --- a/templates/libraries/resttemplate/pom.mustache +++ b/templates/libraries/resttemplate/pom.mustache @@ -73,7 +73,7 @@ -Xms512m -Xmx1500m methods - pertest + false true @@ -352,12 +352,6 @@ ${junit-version} test - - org.junit.platform - junit-platform-runner - ${junit-platform-runner.version} - test - UTF-8 @@ -367,33 +361,27 @@ {{#swagger2AnnotationLibrary}} 2.2.15 {{/swagger2AnnotationLibrary}} - {{#useJakartaEe}} - 6.1.5 - {{/useJakartaEe}} - {{^useJakartaEe}} - 5.3.33 - {{/useJakartaEe}} 2.17.1 2.17.1 {{#openApiNullable}} 0.2.6 {{/openApiNullable}} {{#useJakartaEe}} + 6.1.14 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} + 5.3.33 1.3.5 + 2.0.2 {{/useJakartaEe}} {{#joda}} 2.9.9 {{/joda}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} {{#performBeanValidation}} 5.4.3.Final {{/performBeanValidation}} 5.10.2 - 1.10.0 diff --git a/templates/libraries/retrofit2/ApiClient.mustache b/templates/libraries/retrofit2/ApiClient.mustache index 077e8d6..c05159d 100644 --- a/templates/libraries/retrofit2/ApiClient.mustache +++ b/templates/libraries/retrofit2/ApiClient.mustache @@ -46,7 +46,9 @@ import java.io.IOException; import java.lang.annotation.Annotation; import java.lang.reflect.Type; import java.text.DateFormat; +{{#jsr310}} import java.time.format.DateTimeFormatter; +{{/jsr310}} import java.util.LinkedHashMap; import java.util.Map; import java.util.HashMap; diff --git a/templates/libraries/retrofit2/JSON.mustache b/templates/libraries/retrofit2/JSON.mustache index 2ff8b1c..2e98648 100644 --- a/templates/libraries/retrofit2/JSON.mustache +++ b/templates/libraries/retrofit2/JSON.mustache @@ -30,9 +30,11 @@ import java.lang.reflect.Type; import java.text.DateFormat; import java.text.ParseException; import java.text.ParsePosition; +{{#jsr310}} import java.time.LocalDate; import java.time.OffsetDateTime; import java.time.format.DateTimeFormatter; +{{/jsr310}} import java.util.Date; import java.util.Locale; import java.util.Map; diff --git a/templates/libraries/retrofit2/JSON_jackson.mustache b/templates/libraries/retrofit2/JSON_jackson.mustache index 525fe5d..697e398 100644 --- a/templates/libraries/retrofit2/JSON_jackson.mustache +++ b/templates/libraries/retrofit2/JSON_jackson.mustache @@ -32,7 +32,7 @@ public class JSON implements ContextResolver { mapper = JsonMapper.builder() .serializationInclusion(JsonInclude.Include.NON_NULL) .configure(MapperFeature.ALLOW_COERCION_OF_SCALARS, false) - .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, true) + .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}) .configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, true) .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS) .enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING) diff --git a/templates/libraries/retrofit2/api.mustache b/templates/libraries/retrofit2/api.mustache index dd521a5..0b01055 100644 --- a/templates/libraries/retrofit2/api.mustache +++ b/templates/libraries/retrofit2/api.mustache @@ -35,8 +35,8 @@ import java.util.Map; import java.util.Set; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#operations}} diff --git a/templates/libraries/retrofit2/api_test.mustache b/templates/libraries/retrofit2/api_test.mustache index dab62f3..b84e6b1 100644 --- a/templates/libraries/retrofit2/api_test.mustache +++ b/templates/libraries/retrofit2/api_test.mustache @@ -15,8 +15,8 @@ import java.util.List; import java.util.Map; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/retrofit2/play26/api.mustache b/templates/libraries/retrofit2/play26/api.mustache index e78bd98..7f7b9e2 100644 --- a/templates/libraries/retrofit2/play26/api.mustache +++ b/templates/libraries/retrofit2/play26/api.mustache @@ -18,8 +18,8 @@ import okhttp3.MultipartBody; {{/imports}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import java.util.ArrayList; diff --git a/templates/libraries/retrofit2/pom.mustache b/templates/libraries/retrofit2/pom.mustache index b02a5fb..7f5d6b8 100644 --- a/templates/libraries/retrofit2/pom.mustache +++ b/templates/libraries/retrofit2/pom.mustache @@ -405,13 +405,12 @@ {{/joda}} {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} - {{#useBeanValidation}} - 3.0.2 - {{/useBeanValidation}} 1.0.1 5.10.3 diff --git a/templates/libraries/vertx/ApiClient.mustache b/templates/libraries/vertx/ApiClient.mustache index 6607107..1a90c57 100644 --- a/templates/libraries/vertx/ApiClient.mustache +++ b/templates/libraries/vertx/ApiClient.mustache @@ -81,7 +81,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { // Build object mapper this.objectMapper = new ObjectMapper(); this.objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); - this.objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + this.objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); this.objectMapper.configure(DeserializationFeature.FAIL_ON_INVALID_SUBTYPE, false); this.objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS); this.objectMapper.enable(SerializationFeature.WRITE_ENUMS_USING_TO_STRING); diff --git a/templates/libraries/webclient/ApiClient.mustache b/templates/libraries/webclient/ApiClient.mustache index 9072a88..ce69612 100644 --- a/templates/libraries/webclient/ApiClient.mustache +++ b/templates/libraries/webclient/ApiClient.mustache @@ -143,7 +143,7 @@ public class ApiClient{{#jsr310}} extends JavaTimeFormatter{{/jsr310}} { ObjectMapper mapper = new ObjectMapper(); mapper.setDateFormat(dateFormat); mapper.registerModule(new JavaTimeModule()); - mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, {{failOnUnknownProperties}}); {{#openApiNullable}} JsonNullableModule jnm = new JsonNullableModule(); mapper.registerModule(jnm); diff --git a/templates/libraries/webclient/additional_properties.mustache b/templates/libraries/webclient/additional_properties.mustache new file mode 100644 index 0000000..8e71827 --- /dev/null +++ b/templates/libraries/webclient/additional_properties.mustache @@ -0,0 +1,45 @@ +{{#additionalPropertiesType}} + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + private Map additionalProperties; + + /** + * Set the additional (undeclared) property with the specified name and value. + * If the property does not already exist, create it otherwise replace it. + * @param key the name of the property + * @param value the value of the property + * @return self reference + */ + @JsonAnySetter + public {{classname}} putAdditionalProperty(String key, {{{.}}} value) { + if (this.additionalProperties == null) { + this.additionalProperties = new HashMap(); + } + this.additionalProperties.put(key, value); + return this; + } + + /** + * Return the additional (undeclared) properties. + * @return the additional (undeclared) properties + */ + @JsonAnyGetter + public Map getAdditionalProperties() { + return additionalProperties; + } + + /** + * Return the additional (undeclared) property with the specified name. + * @param key the name of the property + * @return the additional (undeclared) property with the specified name + */ + public {{{.}}} getAdditionalProperty(String key) { + if (this.additionalProperties == null) { + return null; + } + return this.additionalProperties.get(key); + } +{{/additionalPropertiesType}} diff --git a/templates/libraries/webclient/api.mustache b/templates/libraries/webclient/api.mustache index 65600db..0a412fb 100644 --- a/templates/libraries/webclient/api.mustache +++ b/templates/libraries/webclient/api.mustache @@ -12,8 +12,8 @@ import java.util.Map; import java.util.stream.Collectors; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} import org.springframework.beans.factory.annotation.Autowired; @@ -53,7 +53,81 @@ public class {{classname}} { this.apiClient = apiClient; } - {{#operation}} + {{#operation}}{{#singleRequestParameter}}{{#hasParams}}{{^hasSingleParam}} + public {{#staticRequest}}static {{/staticRequest}}class {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request { + {{#allParams}} + private {{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}; + {{/allParams}} + + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request() {} + + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request({{#allParams}}{{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}) { + {{#allParams}} + this.{{paramName}} = {{paramName}}; + {{/allParams}} + } + + {{#allParams}} + public {{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}() { + return this.{{paramName}}; + } + public {{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request {{paramName}}({{#isFile}}{{#useAbstractionForFiles}}{{#collectionFormat}}java.util.Collection{{/collectionFormat}}{{^collectionFormat}}org.springframework.core.io.AbstractResource{{/collectionFormat}}{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{dataType}}}{{/useAbstractionForFiles}}{{/isFile}}{{^isFile}}{{{dataType}}}{{/isFile}} {{paramName}}) { + this.{{paramName}} = {{paramName}}; + return this; + } + + {{/allParams}} + } + + /** + * {{summary}} + * {{notes}} + {{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} + {{/responses}} * @param requestParameters The {{operationId}} request parameters as object + {{#returnType}} * @return {{.}} + {{/returnType}} * @throws WebClientResponseException if an error occurs while attempting to invoke the API + {{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation + {{/externalDocs}} + */ + public {{#returnType}}{{#vendorExtensions.x-webclient-blocking}}{{#vendorExtensions.x-webclient-return-except-list-of-string}}{{#uniqueItems}}Set{{/uniqueItems}}{{^uniqueItems}}List{{/uniqueItems}}<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnBaseType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnBaseType}}}{{/isResponseFile}}>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{/vendorExtensions.x-webclient-blocking}}{{^vendorExtensions.x-webclient-blocking}}{{#vendorExtensions.x-webclient-return-except-list-of-string}}Flux<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnBaseType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnBaseType}}}{{/isResponseFile}}>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}Mono<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{/vendorExtensions.x-webclient-blocking}} {{/returnType}}{{^returnType}}{{#vendorExtensions.x-webclient-blocking}}void{{/vendorExtensions.x-webclient-blocking}}{{^vendorExtensions.x-webclient-blocking}}Mono{{/vendorExtensions.x-webclient-blocking}} {{/returnType}}{{operationId}}({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws WebClientResponseException { + {{^returnType}}{{^vendorExtensions.x-webclient-blocking}}return {{/vendorExtensions.x-webclient-blocking}}{{/returnType}}{{#returnType}}return {{/returnType}}this.{{operationId}}({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + + /** + * {{summary}} + * {{notes}} + {{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} + {{/responses}} * @param requestParameters The {{operationId}} request parameters as object + {{#returnType}} * @return ResponseEntity<{{.}}> + {{/returnType}} * @throws WebClientResponseException if an error occurs while attempting to invoke the API + {{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation + {{/externalDocs}} + */ + public {{#vendorExtensions.x-webclient-blocking}}{{#returnType}}{{#vendorExtensions.x-webclient-return-except-list-of-string}}ResponseEntity>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}ResponseEntity<{{#isResponseFile}}{{#useAbstractionForFiles}}org.springframework.core.io.Resource{{/useAbstractionForFiles}}{{^useAbstractionForFiles}}{{{returnType}}}{{/useAbstractionForFiles}}{{/isResponseFile}}{{^isResponseFile}}{{{returnType}}}{{/isResponseFile}}>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{/returnType}}{{^returnType}}ResponseEntity{{/returnType}} {{/vendorExtensions.x-webclient-blocking}}{{^vendorExtensions.x-webclient-blocking}}{{#returnType}}{{#vendorExtensions.x-webclient-return-except-list-of-string}}Mono>>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{^vendorExtensions.x-webclient-return-except-list-of-string}}Mono>{{/vendorExtensions.x-webclient-return-except-list-of-string}}{{/returnType}}{{^returnType}}Mono>{{/returnType}} {{/vendorExtensions.x-webclient-blocking}}{{operationId}}WithHttpInfo({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws WebClientResponseException { + return this.{{operationId}}WithHttpInfo({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + + /** + * {{summary}} + * {{notes}} + {{#responses}} *

{{code}}{{#message}} - {{.}}{{/message}} + {{/responses}} * @param requestParameters The {{operationId}} request parameters as object + * @return ResponseSpec + * @throws WebClientResponseException if an error occurs while attempting to invoke the API + {{#externalDocs}} + * {{description}} + * @see {{summary}} Documentation + {{/externalDocs}} + */ + public ResponseSpec {{operationId}}WithResponseSpec({{#lambda.titlecase}}{{operationId}}{{/lambda.titlecase}}Request requestParameters) throws WebClientResponseException { + return this.{{operationId}}WithResponseSpec({{#allParams}}requestParameters.{{paramName}}(){{^-last}}, {{/-last}}{{/allParams}}); + } + + {{/hasSingleParam}}{{/hasParams}}{{/singleRequestParameter}} /** * {{summary}} * {{notes}} diff --git a/templates/libraries/webclient/api_test.mustache b/templates/libraries/webclient/api_test.mustache index c5d5686..e0a960d 100644 --- a/templates/libraries/webclient/api_test.mustache +++ b/templates/libraries/webclient/api_test.mustache @@ -15,8 +15,8 @@ import java.util.Map; import java.util.stream.Collectors; {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} /** diff --git a/templates/libraries/webclient/build.gradle.mustache b/templates/libraries/webclient/build.gradle.mustache index 5974116..be194ab 100644 --- a/templates/libraries/webclient/build.gradle.mustache +++ b/templates/libraries/webclient/build.gradle.mustache @@ -133,12 +133,14 @@ ext { {{#useJakartaEe}} spring_boot_version = "3.0.12" jakarta_annotation_version = "2.1.1" + beanvalidation_version = "3.0.2" reactor_version = "3.5.12" reactor_netty_version = "1.1.13" {{/useJakartaEe}} {{^useJakartaEe}} spring_boot_version = "2.7.17" jakarta_annotation_version = "1.3.5" + beanvalidation_version = "2.0.2" reactor_version = "3.4.34" reactor_netty_version = "1.0.39" {{/useJakartaEe}} diff --git a/templates/libraries/webclient/model.mustache b/templates/libraries/webclient/model.mustache new file mode 100644 index 0000000..108748f --- /dev/null +++ b/templates/libraries/webclient/model.mustache @@ -0,0 +1,78 @@ +{{>licenseInfo}} + +package {{package}}; + +{{#useReflectionEqualsHashCode}} +import org.apache.commons.lang3.builder.EqualsBuilder; +import org.apache.commons.lang3.builder.HashCodeBuilder; +{{/useReflectionEqualsHashCode}} +{{#models}} +{{#model}} +{{#additionalPropertiesType}} +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonAnyGetter; +import com.fasterxml.jackson.annotation.JsonAnySetter; +{{/additionalPropertiesType}} +{{/model}} +{{/models}} +import java.util.Objects; +import java.util.Arrays; +{{#imports}} +import {{import}}; +{{/imports}} +{{#serializableModel}} +import java.io.Serializable; +{{/serializableModel}} +{{#jackson}} +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import com.fasterxml.jackson.annotation.JsonTypeName; +{{#withXml}} +import com.fasterxml.jackson.dataformat.xml.annotation.*; +{{/withXml}} +{{#vendorExtensions.x-has-readonly-properties}} +import com.fasterxml.jackson.annotation.JsonCreator; +{{/vendorExtensions.x-has-readonly-properties}} +{{/jackson}} +{{#withXml}} +import {{javaxPackage}}.xml.bind.annotation.*; +import {{javaxPackage}}.xml.bind.annotation.adapters.*; +import io.github.threetenjaxb.core.*; +{{/withXml}} +{{#jsonb}} +import java.lang.reflect.Type; +import {{javaxPackage}}.json.bind.annotation.JsonbTypeDeserializer; +import {{javaxPackage}}.json.bind.annotation.JsonbTypeSerializer; +import {{javaxPackage}}.json.bind.serializer.DeserializationContext; +import {{javaxPackage}}.json.bind.serializer.JsonbDeserializer; +import {{javaxPackage}}.json.bind.serializer.JsonbSerializer; +import {{javaxPackage}}.json.bind.serializer.SerializationContext; +import {{javaxPackage}}.json.stream.JsonGenerator; +import {{javaxPackage}}.json.stream.JsonParser; +import {{javaxPackage}}.json.bind.annotation.JsonbProperty; +{{#vendorExtensions.x-has-readonly-properties}} +import {{javaxPackage}}.json.bind.annotation.JsonbCreator; +{{/vendorExtensions.x-has-readonly-properties}} +{{/jsonb}} +{{#parcelableModel}} +import android.os.Parcelable; +import android.os.Parcel; +{{/parcelableModel}} +{{#useBeanValidation}} +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; +{{/useBeanValidation}} +{{#performBeanValidation}} +import org.hibernate.validator.constraints.*; +{{/performBeanValidation}} +{{#supportUrlQuery}} +import java.io.UnsupportedEncodingException; +import java.net.URLEncoder; +import java.util.StringJoiner; +{{/supportUrlQuery}} + +{{#models}} +{{#model}} +{{#isEnum}}{{>modelEnum}}{{/isEnum}}{{^isEnum}}{{#vendorExtensions.x-is-one-of-interface}}{{>oneof_interface}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{>pojo}}{{/vendorExtensions.x-is-one-of-interface}}{{/isEnum}} +{{/model}} +{{/models}} diff --git a/templates/libraries/webclient/pojo.mustache b/templates/libraries/webclient/pojo.mustache new file mode 100644 index 0000000..2b9423b --- /dev/null +++ b/templates/libraries/webclient/pojo.mustache @@ -0,0 +1,620 @@ +/** + * {{description}}{{^description}}{{classname}}{{/description}}{{#isDeprecated}} + * @deprecated{{/isDeprecated}} + */{{#isDeprecated}} +@Deprecated{{/isDeprecated}} +{{#swagger1AnnotationLibrary}} +{{#description}} +@ApiModel(description = "{{{.}}}") +{{/description}} +{{/swagger1AnnotationLibrary}} +{{#swagger2AnnotationLibrary}} +{{#description}} +@Schema(description = "{{{.}}}") +{{/description}} +{{/swagger2AnnotationLibrary}} +{{#jackson}} +@JsonPropertyOrder({ +{{#vars}} + {{classname}}.JSON_PROPERTY_{{nameInSnakeCase}}{{^-last}},{{/-last}} +{{/vars}} +}) +{{#isClassnameSanitized}} +{{^hasDiscriminatorWithNonEmptyMapping}} +@JsonTypeName("{{name}}") +{{/hasDiscriminatorWithNonEmptyMapping}} +{{/isClassnameSanitized}} +{{/jackson}} +{{>additionalModelTypeAnnotations}}{{>generatedAnnotation}}{{#discriminator}}{{>typeInfoAnnotation}}{{/discriminator}}{{>xmlAnnotation}} +{{#vendorExtensions.x-class-extra-annotation}} +{{{vendorExtensions.x-class-extra-annotation}}} +{{/vendorExtensions.x-class-extra-annotation}} +public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtensions.x-implements}}{{#-first}}implements {{{.}}}{{/-first}}{{^-first}}, {{{.}}}{{/-first}}{{#-last}} {{/-last}}{{/vendorExtensions.x-implements}}{ +{{#serializableModel}} + private static final long serialVersionUID = 1L; + +{{/serializableModel}} + {{#vars}} + {{#isEnum}} + {{^isContainer}} +{{>modelInnerEnum}} + {{/isContainer}} + {{#isContainer}} + {{#mostInnerItems}} +{{>modelInnerEnum}} + {{/mostInnerItems}} + {{/isContainer}} + {{/isEnum}} + {{#gson}} + public static final String SERIALIZED_NAME_{{nameInSnakeCase}} = "{{baseName}}"; + {{/gson}} + {{#jackson}} + public static final String JSON_PROPERTY_{{nameInSnakeCase}} = "{{baseName}}"; + {{/jackson}} + {{#withXml}} + @Xml{{#isXmlAttribute}}Attribute{{/isXmlAttribute}}{{^isXmlAttribute}}Element{{/isXmlAttribute}}(name = "{{items.xmlName}}{{^items.xmlName}}{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}{{/items.xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}}) + {{#isXmlWrapped}} + @XmlElementWrapper(name = "{{xmlName}}{{^xmlName}}{{baseName}}{{/xmlName}}"{{#xmlNamespace}}, namespace = "{{.}}"{{/xmlNamespace}}) + {{/isXmlWrapped}} + {{^isXmlAttribute}} + {{#isDateTime}} + @XmlJavaTypeAdapter(OffsetDateTimeXmlAdapter.class) + {{/isDateTime}} + {{/isXmlAttribute}} + {{/withXml}} + {{#gson}} + @SerializedName(SERIALIZED_NAME_{{nameInSnakeCase}}) + {{/gson}} + {{>nullable_var_annotations}} + {{#vendorExtensions.x-field-extra-annotation}} + {{{vendorExtensions.x-field-extra-annotation}}} + {{/vendorExtensions.x-field-extra-annotation}} + {{#vendorExtensions.x-is-jackson-optional-nullable}} + {{#isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} JsonNullable<{{{datatypeWithEnum}}}> {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>undefined(); + {{/isContainer}} + {{^isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} JsonNullable<{{{datatypeWithEnum}}}> {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>{{#defaultValue}}of({{{.}}}){{/defaultValue}}{{^defaultValue}}undefined(){{/defaultValue}}; + {{/isContainer}} + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{#isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; + {{/isContainer}} + {{^isContainer}} + {{#hasChildren}}protected{{/hasChildren}}{{^hasChildren}}private{{/hasChildren}} {{{datatypeWithEnum}}} {{name}}{{#defaultValue}} = {{{.}}}{{/defaultValue}}; + {{/isContainer}} + {{/vendorExtensions.x-is-jackson-optional-nullable}} + + {{/vars}} + public {{classname}}() { + {{#parent}} + {{#parcelableModel}} + super();{{/parcelableModel}} + {{/parent}} + {{#gson}} + {{#discriminator}} + {{#discriminator.isEnum}} + this.{{{discriminatorName}}} = this.getClass().getSimpleName(); + {{/discriminator.isEnum}} + {{/discriminator}} + {{/gson}} + } + {{#vendorExtensions.x-has-readonly-properties}} + {{^withXml}} + /** + * Constructor with only readonly parameters{{#generateConstructorWithAllArgs}}{{^vendorExtensions.x-java-all-args-constructor}} and all parameters{{/vendorExtensions.x-java-all-args-constructor}}{{/generateConstructorWithAllArgs}} + */ + {{#jsonb}}@JsonbCreator{{/jsonb}}{{#jackson}}@JsonCreator{{/jackson}} + public {{classname}}( + {{#readOnlyVars}} + {{#jsonb}}@JsonbProperty(value = "{{baseName}}"{{^required}}, nullable = true{{/required}}){{/jsonb}}{{#jackson}}@JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}){{/jackson}} {{{datatypeWithEnum}}} {{name}}{{^-last}}, {{/-last}} + {{/readOnlyVars}} + ) { + this(); + {{#readOnlyVars}} + this.{{name}} = {{#vendorExtensions.x-is-jackson-optional-nullable}}{{name}} == null ? JsonNullable.<{{{datatypeWithEnum}}}>undefined() : JsonNullable.of({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{name}}{{/vendorExtensions.x-is-jackson-optional-nullable}}; + {{/readOnlyVars}} + } + {{/withXml}} + {{/vendorExtensions.x-has-readonly-properties}} +{{#vendorExtensions.x-java-all-args-constructor}} + + /** + * Constructor with all args parameters + */ + public {{classname}}({{#vendorExtensions.x-java-all-args-constructor-vars}}{{#jsonb}}@JsonbProperty(value = "{{baseName}}"{{^required}}, nullable = true{{/required}}){{/jsonb}}{{#jackson}}@JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}){{/jackson}} {{{datatypeWithEnum}}} {{name}}{{^-last}}, {{/-last}}{{/vendorExtensions.x-java-all-args-constructor-vars}}) { +{{#parent}} + super({{#parentVars}}{{name}}{{^-last}}, {{/-last}}{{/parentVars}}); +{{/parent}} + {{#vars}} + this.{{name}} = {{#vendorExtensions.x-is-jackson-optional-nullable}}{{name}} == null ? JsonNullable.<{{{datatypeWithEnum}}}>undefined() : JsonNullable.of({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{name}}{{/vendorExtensions.x-is-jackson-optional-nullable}}; +{{/vars}} + } +{{/vendorExtensions.x-java-all-args-constructor}} + +{{#vars}} + {{^isReadOnly}} + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}});{{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = {{name}};{{/vendorExtensions.x-is-jackson-optional-nullable}} + return this; + } + {{#isArray}} + + public {{classname}} add{{nameInPascalCase}}Item({{{items.datatypeWithEnum}}} {{name}}Item) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null || !this.{{name}}.isPresent()) { + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}ArrayList{{/uniqueItems}}<>(){{/defaultValue}}); + } + try { + this.{{name}}.get().add({{name}}Item); + } catch (java.util.NoSuchElementException e) { + // this can never happen, as we make sure above that the value is present + } + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null) { + this.{{name}} = {{{defaultValue}}}{{^defaultValue}}new {{#uniqueItems}}LinkedHashSet{{/uniqueItems}}{{^uniqueItems}}ArrayList{{/uniqueItems}}<>(){{/defaultValue}}; + } + this.{{name}}.add({{name}}Item); + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isArray}} + {{#isMap}} + + public {{classname}} put{{nameInPascalCase}}Item(String key, {{{items.datatypeWithEnum}}} {{name}}Item) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + if (this.{{name}} == null || !this.{{name}}.isPresent()) { + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{{defaultValue}}}{{^defaultValue}}new HashMap<>(){{/defaultValue}}); + } + try { + this.{{name}}.get().put(key, {{name}}Item); + } catch (java.util.NoSuchElementException e) { + // this can never happen, as we make sure above that the value is present + } + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + {{^required}} + if (this.{{name}} == null) { + this.{{name}} = {{{defaultValue}}}{{^defaultValue}}new HashMap<>(){{/defaultValue}}; + } + {{/required}} + this.{{name}}.put(key, {{name}}Item); + return this; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isMap}} + + {{/isReadOnly}} + /** + {{#description}} + * {{.}} + {{/description}} + {{^description}} + * Get {{name}} + {{/description}} + {{#minimum}} + * minimum: {{.}} + {{/minimum}} + {{#maximum}} + * maximum: {{.}} + {{/maximum}} + * @return {{name}} + {{#deprecated}} + * @deprecated + {{/deprecated}} + */ +{{#deprecated}} + @Deprecated +{{/deprecated}} + {{>nullable_var_annotations}} +{{#jsonb}} + @JsonbProperty("{{baseName}}") +{{/jsonb}} +{{#useBeanValidation}} +{{>beanValidation}} +{{/useBeanValidation}} +{{#swagger1AnnotationLibrary}} + @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}") +{{/swagger1AnnotationLibrary}} +{{#swagger2AnnotationLibrary}} + @Schema({{#example}}example = "{{{.}}}", {{/example}}requiredMode = {{#required}}Schema.RequiredMode.REQUIRED{{/required}}{{^required}}Schema.RequiredMode.NOT_REQUIRED{{/required}}, description = "{{{description}}}") +{{/swagger2AnnotationLibrary}} +{{#vendorExtensions.x-extra-annotation}} + {{{vendorExtensions.x-extra-annotation}}} +{{/vendorExtensions.x-extra-annotation}} +{{#vendorExtensions.x-is-jackson-optional-nullable}} + {{!unannotated, Jackson would pick this up automatically and add it *in addition* to the _JsonNullable getter field}} + @JsonIgnore +{{/vendorExtensions.x-is-jackson-optional-nullable}} +{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#jackson}}{{> jackson_annotations}}{{/jackson}}{{/vendorExtensions.x-is-jackson-optional-nullable}} + public {{{datatypeWithEnum}}} {{getter}}() { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + {{#isReadOnly}}{{! A readonly attribute doesn't have setter => jackson will set null directly if explicitly returned by API, so make sure we have an empty JsonNullable}} + if ({{name}} == null) { + {{name}} = JsonNullable.<{{{datatypeWithEnum}}}>{{#defaultValue}}of({{{.}}}){{/defaultValue}}{{^defaultValue}}undefined(){{/defaultValue}}; + } + {{/isReadOnly}} + return {{name}}.orElse(null); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + return {{name}}; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + + {{#vendorExtensions.x-is-jackson-optional-nullable}} +{{> jackson_annotations}} + public JsonNullable<{{{datatypeWithEnum}}}> {{getter}}_JsonNullable() { + return {{name}}; + } + {{/vendorExtensions.x-is-jackson-optional-nullable}}{{#vendorExtensions.x-is-jackson-optional-nullable}} + @JsonProperty(JSON_PROPERTY_{{nameInSnakeCase}}) + {{#isReadOnly}}private{{/isReadOnly}}{{^isReadOnly}}public{{/isReadOnly}} void {{setter}}_JsonNullable(JsonNullable<{{{datatypeWithEnum}}}> {{name}}) { + {{! For getters/setters that have name differing from attribute name, we must include setter (albeit private) for jackson to be able to set the attribute}} + this.{{name}} = {{name}}; + } + {{/vendorExtensions.x-is-jackson-optional-nullable}} + + {{^isReadOnly}} +{{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}}); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + this.{{name}} = {{name}}; + {{/vendorExtensions.x-is-jackson-optional-nullable}} + } + {{/isReadOnly}} + + {{/vars}} +{{>libraries/webclient/additional_properties}} + {{#parent}} + {{#readWriteVars}} + {{#isOverridden}} + @Override + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { + {{#vendorExtensions.x-is-jackson-optional-nullable}} + this.{{setter}}(JsonNullable.<{{{datatypeWithEnum}}}>of({{name}})); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + {{^vendorExtensions.x-is-jackson-optional-nullable}} + this.{{setter}}({{name}}); + {{/vendorExtensions.x-is-jackson-optional-nullable}} + return this; + } + + {{/isOverridden}} + {{/readWriteVars}} + {{/parent}} + @Override + public boolean equals(Object o) { + {{#useReflectionEqualsHashCode}} + return EqualsBuilder.reflectionEquals(this, o, false, null, true); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + }{{#hasVars}} + {{classname}} {{classVarName}} = ({{classname}}) o; + return {{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}equalsNullable(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{#isByteArray}}Arrays{{/isByteArray}}{{^isByteArray}}Objects{{/isByteArray}}.equals(this.{{name}}, {{classVarName}}.{{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}} && + {{/-last}}{{/vars}}{{#additionalPropertiesType}} && + Objects.equals(this.additionalProperties, {{classVarName}}.additionalProperties){{/additionalPropertiesType}}{{#parent}} && + super.equals(o){{/parent}};{{/hasVars}}{{^hasVars}} + return {{#parent}}super.equals(o){{/parent}}{{^parent}}true{{/parent}};{{/hasVars}} + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static boolean equalsNullable(JsonNullable a, JsonNullable b) { + return a == b || (a != null && b != null && a.isPresent() && b.isPresent() && Objects.deepEquals(a.get(), b.get())); + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + @Override + public int hashCode() { + {{#useReflectionEqualsHashCode}} + return HashCodeBuilder.reflectionHashCode(this); + {{/useReflectionEqualsHashCode}} + {{^useReflectionEqualsHashCode}} + return Objects.hash({{#vars}}{{#vendorExtensions.x-is-jackson-optional-nullable}}hashCodeNullable({{name}}){{/vendorExtensions.x-is-jackson-optional-nullable}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{^isByteArray}}{{name}}{{/isByteArray}}{{#isByteArray}}Arrays.hashCode({{name}}){{/isByteArray}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{^-last}}, {{/-last}}{{/vars}}{{#parent}}{{#hasVars}}, {{/hasVars}}super.hashCode(){{/parent}}{{#additionalPropertiesType}}, additionalProperties{{/additionalPropertiesType}}); + {{/useReflectionEqualsHashCode}} + }{{#vendorExtensions.x-jackson-optional-nullable-helpers}} + + private static int hashCodeNullable(JsonNullable a) { + if (a == null) { + return 1; + } + return a.isPresent() ? Arrays.deepHashCode(new Object[]{a.get()}) : 31; + }{{/vendorExtensions.x-jackson-optional-nullable-helpers}} + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class {{classname}} {\n"); + {{#parent}} + sb.append(" ").append(toIndentedString(super.toString())).append("\n"); + {{/parent}} + {{#vars}} + sb.append(" {{name}}: ").append({{#isPassword}}"*"{{/isPassword}}{{^isPassword}}toIndentedString({{name}}){{/isPassword}}).append("\n"); + {{/vars}} + {{#additionalPropertiesType}} + sb.append(" additionalProperties: ").append(toIndentedString(additionalProperties)).append("\n"); + {{/additionalPropertiesType}} + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private{{#jsonb}} static{{/jsonb}} String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } +{{#supportUrlQuery}} + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + {{#allVars}} + // add `{{baseName}}` to the URL query string + {{#isArray}} + {{#items.isPrimitiveType}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.datatypeWithEnum}}} _item : {{getter}}()) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf(_item), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + i++; + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf({{getter}}().get(i)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + {{/uniqueItems}} + {{/items.isPrimitiveType}} + {{^items.isPrimitiveType}} + {{#items.isModel}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.dataType}}} _item : {{getter}}()) { + if (_item != null) { + joiner.add(_item.toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + i++; + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + if ({{getter}}().get(i) != null) { + joiner.add({{getter}}().get(i).toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix)))); + } + } + } + {{/uniqueItems}} + {{/items.isModel}} + {{^items.isModel}} + {{#uniqueItems}} + if ({{getter}}() != null) { + int i = 0; + for ({{{items.dataType}}} _item : {{getter}}()) { + if (_item != null) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf(_item), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + i++; + } + } + {{/uniqueItems}} + {{^uniqueItems}} + if ({{getter}}() != null) { + for (int i = 0; i < {{getter}}().size(); i++) { + if ({{getter}}().get(i) != null) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), + URLEncoder.encode(String.valueOf({{getter}}().get(i)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + } + {{/uniqueItems}} + {{/items.isModel}} + {{/items.isPrimitiveType}} + {{/isArray}} + {{^isArray}} + {{#isMap}} + {{^items.isModel}} + if ({{getter}}() != null) { + for (String _key : {{getter}}().keySet()) { + try { + joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix), + {{getter}}().get(_key), URLEncoder.encode(String.valueOf({{getter}}().get(_key)), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + } + {{/items.isModel}} + {{#items.isModel}} + if ({{getter}}() != null) { + for (String _key : {{getter}}().keySet()) { + if ({{getter}}().get(_key) != null) { + joiner.add({{getter}}().get(_key).toUrlQueryString(String.format("%s{{baseName}}%s%s", prefix, suffix, + "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, _key, containerSuffix)))); + } + } + } + {{/items.isModel}} + {{/isMap}} + {{^isMap}} + {{#isPrimitiveType}} + if ({{getter}}() != null) { + try { + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf({{{getter}}}()), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + {{/isPrimitiveType}} + {{^isPrimitiveType}} + {{#isModel}} + if ({{getter}}() != null) { + joiner.add({{getter}}().toUrlQueryString(prefix + "{{{baseName}}}" + suffix)); + } + {{/isModel}} + {{^isModel}} + if ({{getter}}() != null) { + try { + joiner.add(String.format("%s{{{baseName}}}%s=%s", prefix, suffix, URLEncoder.encode(String.valueOf({{{getter}}}()), "UTF-8").replaceAll("\\+", "%20"))); + } catch (UnsupportedEncodingException e) { + // Should never happen, UTF-8 is always supported + throw new RuntimeException(e); + } + } + {{/isModel}} + {{/isPrimitiveType}} + {{/isMap}} + {{/isArray}} + + {{/allVars}} + return joiner.toString(); + } +{{/supportUrlQuery}} +{{#parcelableModel}} + + public void writeToParcel(Parcel out, int flags) { +{{#model}} +{{#isArray}} + out.writeList(this); +{{/isArray}} +{{^isArray}} +{{#parent}} + super.writeToParcel(out, flags); +{{/parent}} +{{#vars}} + out.writeValue({{name}}); +{{/vars}} +{{/isArray}} +{{/model}} + } + + {{classname}}(Parcel in) { +{{#isArray}} + in.readTypedList(this, {{arrayModelType}}.CREATOR); +{{/isArray}} +{{^isArray}} +{{#parent}} + super(in); +{{/parent}} +{{#vars}} +{{#isPrimitiveType}} + {{name}} = ({{{datatypeWithEnum}}})in.readValue(null); +{{/isPrimitiveType}} +{{^isPrimitiveType}} + {{name}} = ({{{datatypeWithEnum}}})in.readValue({{complexType}}.class.getClassLoader()); +{{/isPrimitiveType}} +{{/vars}} +{{/isArray}} + } + + public int describeContents() { + return 0; + } + + public static final Parcelable.Creator<{{classname}}> CREATOR = new Parcelable.Creator<{{classname}}>() { + public {{classname}} createFromParcel(Parcel in) { +{{#model}} +{{#isArray}} + {{classname}} result = new {{classname}}(); + result.addAll(in.readArrayList({{arrayModelType}}.class.getClassLoader())); + return result; +{{/isArray}} +{{^isArray}} + return new {{classname}}(in); +{{/isArray}} +{{/model}} + } + public {{classname}}[] newArray(int size) { + return new {{classname}}[size]; + } + }; +{{/parcelableModel}} +{{#generateBuilders}} + + {{>javaBuilder}} +{{/generateBuilders}} + +} diff --git a/templates/model.mustache b/templates/model.mustache index b504167..55e6678 100644 --- a/templates/model.mustache +++ b/templates/model.mustache @@ -49,8 +49,8 @@ import android.os.Parcelable; import android.os.Parcel; {{/parcelableModel}} {{#useBeanValidation}} -import jakarta.validation.constraints.*; -import jakarta.validation.Valid; +import {{javaxPackage}}.validation.constraints.*; +import {{javaxPackage}}.validation.Valid; {{/useBeanValidation}} {{#performBeanValidation}} import org.hibernate.validator.constraints.*; diff --git a/templates/modelInnerEnum.mustache b/templates/modelInnerEnum.mustache index 0096d84..f875240 100644 --- a/templates/modelInnerEnum.mustache +++ b/templates/modelInnerEnum.mustache @@ -23,7 +23,7 @@ {{#withXml}} @XmlEnumValue({{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}{{{value}}}{{#isInteger}}"{{/isInteger}}{{#isDouble}}"{{/isDouble}}{{#isLong}}"{{/isLong}}{{#isFloat}}"{{/isFloat}}) {{/withXml}} - {{{name}}}({{{value}}}){{^-last}}, + {{{name}}}({{^isUri}}{{dataType}}.valueOf({{/isUri}}{{{value}}}{{^isUri}}){{/isUri}}){{^-last}}, {{/-last}}{{#-last}};{{/-last}} {{/enumVars}} {{/allowableValues}} diff --git a/templates/nullable_var_annotations.mustache b/templates/nullable_var_annotations.mustache new file mode 100644 index 0000000..7dbaf40 --- /dev/null +++ b/templates/nullable_var_annotations.mustache @@ -0,0 +1 @@ +{{#required}}{{#isNullable}}@{{javaxPackage}}.annotation.Nullable{{/isNullable}}{{^isNullable}}@{{javaxPackage}}.annotation.Nonnull{{/isNullable}}{{/required}}{{^required}}@{{javaxPackage}}.annotation.Nullable{{/required}} \ No newline at end of file diff --git a/templates/pojo.mustache b/templates/pojo.mustache index 05be7e5..09482dd 100644 --- a/templates/pojo.mustache +++ b/templates/pojo.mustache @@ -65,6 +65,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#gson}} @SerializedName(SERIALIZED_NAME_{{nameInSnakeCase}}) {{/gson}} + {{>nullable_var_annotations}} {{#vendorExtensions.x-field-extra-annotation}} {{{vendorExtensions.x-field-extra-annotation}}} {{/vendorExtensions.x-field-extra-annotation}} @@ -134,7 +135,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#vars}} {{^isReadOnly}} - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}});{{/vendorExtensions.x-is-jackson-optional-nullable}} {{^vendorExtensions.x-is-jackson-optional-nullable}}this.{{name}} = {{name}};{{/vendorExtensions.x-is-jackson-optional-nullable}} return this; @@ -210,17 +211,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#deprecated}} @Deprecated {{/deprecated}} -{{#required}} -{{#isNullable}} - @{{javaxPackage}}.annotation.Nullable -{{/isNullable}} -{{^isNullable}} - @{{javaxPackage}}.annotation.Nonnull -{{/isNullable}} -{{/required}} -{{^required}} - @{{javaxPackage}}.annotation.Nullable -{{/required}} + {{>nullable_var_annotations}} {{#jsonb}} @JsonbProperty("{{baseName}}") {{/jsonb}} @@ -270,7 +261,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{^isReadOnly}} {{#vendorExtensions.x-setter-extra-annotation}} {{{vendorExtensions.x-setter-extra-annotation}}} -{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{{datatypeWithEnum}}} {{name}}) { +{{/vendorExtensions.x-setter-extra-annotation}}{{#jackson}}{{^vendorExtensions.x-is-jackson-optional-nullable}}{{> jackson_annotations}}{{/vendorExtensions.x-is-jackson-optional-nullable}}{{/jackson}} public void {{setter}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}} this.{{name}} = JsonNullable.<{{{datatypeWithEnum}}}>of({{name}}); {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -285,7 +276,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#readWriteVars}} {{#isOverridden}} @Override - public {{classname}} {{name}}({{{datatypeWithEnum}}} {{name}}) { + public {{classname}} {{name}}({{>nullable_var_annotations}} {{{datatypeWithEnum}}} {{name}}) { {{#vendorExtensions.x-is-jackson-optional-nullable}} this.{{setter}}(JsonNullable.<{{{datatypeWithEnum}}}>of({{name}})); {{/vendorExtensions.x-is-jackson-optional-nullable}} @@ -404,7 +395,7 @@ public class {{classname}} {{#parent}}extends {{{.}}} {{/parent}}{{#vendorExtens {{#uniqueItems}} if ({{getter}}() != null) { int i = 0; - for ({{{items.dataType}}} _item : {{getter}}()) { + for ({{{items.datatypeWithEnum}}} _item : {{getter}}()) { try { joiner.add(String.format("%s{{baseName}}%s%s=%s", prefix, suffix, "".equals(suffix) ? "" : String.format("%s%d%s", containerPrefix, i, containerSuffix), diff --git a/templates/pom.mustache b/templates/pom.mustache index b733ab9..c46bc59 100644 --- a/templates/pom.mustache +++ b/templates/pom.mustache @@ -289,12 +289,12 @@ {{/useJakartaEe}} {{#withXml}} - - - com.fasterxml.jackson.dataformat - jackson-dataformat-xml - ${jackson-version} - + + + com.fasterxml.jackson.dataformat + jackson-dataformat-xml + ${jackson-version} + {{/withXml}} {{#joda}} @@ -341,6 +341,15 @@ ${jakarta-annotation-version} provided + {{#useReflectionEqualsHashCode}} + + + org.apache.commons + commons-lang3 + ${commons-lang3-version} + + {{/useReflectionEqualsHashCode}} + org.junit.jupiter @@ -368,13 +377,15 @@ 2.17.1 {{#useJakartaEe}} 2.1.1 + 3.0.2 {{/useJakartaEe}} {{^useJakartaEe}} 1.3.5 + 2.0.2 {{/useJakartaEe}} -{{#useBeanValidation}} - 3.0.2 -{{/useBeanValidation}} + {{#useReflectionEqualsHashCode}} + 3.17.0 + {{/useReflectionEqualsHashCode}} 1.0.0 5.10.2 1.10.0 diff --git a/templates/typeInfoAnnotation.mustache b/templates/typeInfoAnnotation.mustache index c21efb4..07f77c7 100644 --- a/templates/typeInfoAnnotation.mustache +++ b/templates/typeInfoAnnotation.mustache @@ -26,3 +26,9 @@ {{/-last}} {{/discriminator.mappedModels}} {{/jackson}} +{{#jsonbPolymorphism}} +@JsonbTypeInfo(key = "{{{discriminator.propertyBaseName}}}"{{#discriminator.mappedModels}}{{#-first}}, value = { +{{/-first}} + @JsonbSubtype(alias = "{{^vendorExtensions.x-discriminator-value}}{{mappingName}}{{/vendorExtensions.x-discriminator-value}}{{#vendorExtensions.x-discriminator-value}}{{{vendorExtensions.x-discriminator-value}}}{{/vendorExtensions.x-discriminator-value}}", type = {{modelName}}.class), +{{#-last}} +}{{/-last}}{{/discriminator.mappedModels}}){{/jsonbPolymorphism}} \ No newline at end of file

Response Details
Status Code Description Response Headers
{{code}} {{message}} {{#headers}} * {{baseName}} - {{description}}
{{/headers}}{{^headers.0}} - {{/headers.0}}