See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
| `clientSecret` | ```String``` | Used when creating a new account with OAuth authorization.
See [OAuth 2.0 Authorization](https://app.hellosign.com/api/oauthWalkthrough#OAuthAuthorization) | |
diff --git a/docs/AccountCreateResponse.md b/docs/AccountCreateResponse.md
index 59279d1..7e09def 100644
--- a/docs/AccountCreateResponse.md
+++ b/docs/AccountCreateResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `account` | [```AccountResponse```](AccountResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | |
| `oauthData` | [```OAuthTokenResponse```](OAuthTokenResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/AccountGetResponse.md b/docs/AccountGetResponse.md
index 41508ab..f5ed78b 100644
--- a/docs/AccountGetResponse.md
+++ b/docs/AccountGetResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `account` | [```AccountResponse```](AccountResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `account`*_required_ | [```AccountResponse```](AccountResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/AccountResponse.md b/docs/AccountResponse.md
index e763487..5b73aa0 100644
--- a/docs/AccountResponse.md
+++ b/docs/AccountResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The ID of the Account | |
| `emailAddress` | ```String``` | The email address associated with the Account. | |
| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | |
diff --git a/docs/AccountResponseQuotas.md b/docs/AccountResponseQuotas.md
index c591ff8..3b7fe4e 100644
--- a/docs/AccountResponseQuotas.md
+++ b/docs/AccountResponseQuotas.md
@@ -6,8 +6,8 @@ Details concerning remaining monthly quotas.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | |
| `documentsLeft` | ```Integer``` | Signature requests remaining. | |
| `templatesTotal` | ```Integer``` | Total API templates allowed. | |
diff --git a/docs/AccountResponseUsage.md b/docs/AccountResponseUsage.md
index f9f3671..1cdb766 100644
--- a/docs/AccountResponseUsage.md
+++ b/docs/AccountResponseUsage.md
@@ -6,8 +6,8 @@ Details concerning monthly usage
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `faxPagesSent` | ```Integer``` | Number of fax pages sent | |
diff --git a/docs/AccountUpdateRequest.md b/docs/AccountUpdateRequest.md
index d1dac21..43121c8 100644
--- a/docs/AccountUpdateRequest.md
+++ b/docs/AccountUpdateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The ID of the Account | |
| `callbackUrl` | ```String``` | The URL that Dropbox Sign should POST events to. | |
| `locale` | ```String``` | 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. | |
diff --git a/docs/AccountVerifyRequest.md b/docs/AccountVerifyRequest.md
index de912c5..d14a8eb 100644
--- a/docs/AccountVerifyRequest.md
+++ b/docs/AccountVerifyRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `emailAddress`*_required_ | ```String``` | Email address to run the verification for. | |
diff --git a/docs/AccountVerifyResponse.md b/docs/AccountVerifyResponse.md
index 07f01ff..8868f15 100644
--- a/docs/AccountVerifyResponse.md
+++ b/docs/AccountVerifyResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `account` | [```AccountVerifyResponseAccount```](AccountVerifyResponseAccount.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/AccountVerifyResponseAccount.md b/docs/AccountVerifyResponseAccount.md
index efa24dc..f83f9f0 100644
--- a/docs/AccountVerifyResponseAccount.md
+++ b/docs/AccountVerifyResponseAccount.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `emailAddress` | ```String``` | The email address associated with the Account. | |
diff --git a/docs/ApiAppApi.md b/docs/ApiAppApi.md
index a22cd2e..02630c9 100644
--- a/docs/ApiAppApi.md
+++ b/docs/ApiAppApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**apiAppCreate**](ApiAppApi.md#apiAppCreate) | **POST** /api_app | Create API App
[**apiAppDelete**](ApiAppApi.md#apiAppDelete) | **DELETE** /api_app/{client_id} | Delete API App
[**apiAppGet**](ApiAppApi.md#apiAppGet) | **GET** /api_app/{client_id} | Get API App
@@ -80,8 +80,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**apiAppCreateRequest** | [**ApiAppCreateRequest**](ApiAppCreateRequest.md)| |
### Return type
@@ -152,8 +152,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**clientId** | **String**| The client id of the API App to delete. |
### Return type
@@ -226,8 +226,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**clientId** | **String**| The client id of the API App to retrieve. |
### Return type
@@ -301,8 +301,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**page** | **Integer**| Which page number of the API App 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]
@@ -396,8 +396,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**clientId** | **String**| The client id of the API App to update. |
**apiAppUpdateRequest** | [**ApiAppUpdateRequest**](ApiAppUpdateRequest.md)| |
diff --git a/docs/ApiAppCreateRequest.md b/docs/ApiAppCreateRequest.md
index 59c2028..b787bc7 100644
--- a/docs/ApiAppCreateRequest.md
+++ b/docs/ApiAppCreateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `domains`*_required_ | ```List``` | The domain names the ApiApp will be associated with. | |
| `name`*_required_ | ```String``` | The name you want to assign to the ApiApp. | |
| `callbackUrl` | ```String``` | The URL at which the ApiApp should receive event callbacks. | |
diff --git a/docs/ApiAppGetResponse.md b/docs/ApiAppGetResponse.md
index b90c30a..98e2f98 100644
--- a/docs/ApiAppGetResponse.md
+++ b/docs/ApiAppGetResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `apiApp` | [```ApiAppResponse```](ApiAppResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `apiApp`*_required_ | [```ApiAppResponse```](ApiAppResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/ApiAppListResponse.md b/docs/ApiAppListResponse.md
index 144b0f4..14c287f 100644
--- a/docs/ApiAppListResponse.md
+++ b/docs/ApiAppListResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `apiApps` | [```List```](ApiAppResponse.md) | Contains information about API Apps. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `apiApps`*_required_ | [```List```](ApiAppResponse.md) | Contains information about API Apps. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/ApiAppResponse.md b/docs/ApiAppResponse.md
index bb0836d..afe95c8 100644
--- a/docs/ApiAppResponse.md
+++ b/docs/ApiAppResponse.md
@@ -6,8 +6,8 @@ Contains information about an API App.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `callbackUrl` | ```String``` | The app's callback URL (for events) | |
| `clientId` | ```String``` | The app's client id | |
| `createdAt` | ```Integer``` | The time that the app was created | |
diff --git a/docs/ApiAppResponseOAuth.md b/docs/ApiAppResponseOAuth.md
index 20c678a..c2f705c 100644
--- a/docs/ApiAppResponseOAuth.md
+++ b/docs/ApiAppResponseOAuth.md
@@ -6,8 +6,8 @@ An object describing the app's OAuth properties, or null if OAuth is not con
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `callbackUrl` | ```String``` | The app's OAuth callback URL. | |
| `secret` | ```String``` | The app's OAuth secret, or null if the app does not belong to user. | |
| `scopes` | ```List``` | Array of OAuth scopes used by the app. | |
diff --git a/docs/ApiAppResponseOptions.md b/docs/ApiAppResponseOptions.md
index 827b3b5..07979f3 100644
--- a/docs/ApiAppResponseOptions.md
+++ b/docs/ApiAppResponseOptions.md
@@ -6,8 +6,8 @@ An object with options that override account settings.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `canInsertEverywhere` | ```Boolean``` | Boolean denoting if signers can "Insert Everywhere" in one click while signing a document | |
diff --git a/docs/ApiAppResponseOwnerAccount.md b/docs/ApiAppResponseOwnerAccount.md
index 0ac35ee..b4d6d42 100644
--- a/docs/ApiAppResponseOwnerAccount.md
+++ b/docs/ApiAppResponseOwnerAccount.md
@@ -6,8 +6,8 @@ An object describing the app's owner
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The owner account's ID | |
| `emailAddress` | ```String``` | The owner account's email address | |
diff --git a/docs/ApiAppResponseWhiteLabelingOptions.md b/docs/ApiAppResponseWhiteLabelingOptions.md
index 1ed534a..be6d022 100644
--- a/docs/ApiAppResponseWhiteLabelingOptions.md
+++ b/docs/ApiAppResponseWhiteLabelingOptions.md
@@ -6,8 +6,8 @@ An object with options to customize the app's signer page
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `headerBackgroundColor` | ```String``` | | |
| `legalVersion` | ```String``` | | |
| `linkColor` | ```String``` | | |
diff --git a/docs/ApiAppUpdateRequest.md b/docs/ApiAppUpdateRequest.md
index 62bc8fd..1c0efaf 100644
--- a/docs/ApiAppUpdateRequest.md
+++ b/docs/ApiAppUpdateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `callbackUrl` | ```String``` | The URL at which the API App should receive event callbacks. | |
| `customLogoFile` | ```File``` | An image file to use as a custom logo in embedded contexts. (Only applies to some API plans) | |
| `domains` | ```List``` | The domain names the ApiApp will be associated with. | |
diff --git a/docs/BulkSendJobApi.md b/docs/BulkSendJobApi.md
index c369376..5d7335a 100644
--- a/docs/BulkSendJobApi.md
+++ b/docs/BulkSendJobApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**bulkSendJobGet**](BulkSendJobApi.md#bulkSendJobGet) | **GET** /bulk_send_job/{bulk_send_job_id} | Get Bulk Send Job
[**bulkSendJobList**](BulkSendJobApi.md#bulkSendJobList) | **GET** /bulk_send_job/list | List Bulk Send Jobs
@@ -59,8 +59,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**bulkSendJobId** | **String**| The id of the BulkSendJob to retrieve. |
**page** | **Integer**| Which page number of the BulkSendJob 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]
@@ -136,8 +136,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**page** | **Integer**| Which page number of the BulkSendJob 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]
diff --git a/docs/BulkSendJobGetResponse.md b/docs/BulkSendJobGetResponse.md
index 977a108..93395ee 100644
--- a/docs/BulkSendJobGetResponse.md
+++ b/docs/BulkSendJobGetResponse.md
@@ -6,11 +6,11 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `bulkSendJob` | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
-| `signatureRequests` | [```List```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| `signatureRequests`*_required_ | [```List```](BulkSendJobGetResponseSignatureRequests.md) | Contains information about the Signature Requests sent in bulk. | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/BulkSendJobGetResponseSignatureRequests.md b/docs/BulkSendJobGetResponseSignatureRequests.md
index 8cf2c0b..ba283af 100644
--- a/docs/BulkSendJobGetResponseSignatureRequests.md
+++ b/docs/BulkSendJobGetResponseSignatureRequests.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | |
| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | |
| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | |
diff --git a/docs/BulkSendJobListResponse.md b/docs/BulkSendJobListResponse.md
index f0ef7df..e5eb231 100644
--- a/docs/BulkSendJobListResponse.md
+++ b/docs/BulkSendJobListResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `bulkSendJobs` | [```List```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `bulkSendJobs`*_required_ | [```List```](BulkSendJobResponse.md) | Contains a list of BulkSendJobs that the API caller has access to. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/BulkSendJobResponse.md b/docs/BulkSendJobResponse.md
index c97fb3d..eb2278a 100644
--- a/docs/BulkSendJobResponse.md
+++ b/docs/BulkSendJobResponse.md
@@ -6,8 +6,8 @@ Contains information about the BulkSendJob such as when it was created and how m
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `bulkSendJobId` | ```String``` | The id of the BulkSendJob. | |
| `total` | ```Integer``` | The total amount of Signature Requests queued for sending. | |
| `isCreator` | ```Boolean``` | True if you are the owner of this BulkSendJob, false if it's been shared with you by a team member. | |
diff --git a/docs/BulkSendJobSendResponse.md b/docs/BulkSendJobSendResponse.md
index 9ca5095..532b64b 100644
--- a/docs/BulkSendJobSendResponse.md
+++ b/docs/BulkSendJobSendResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `bulkSendJob` | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `bulkSendJob`*_required_ | [```BulkSendJobResponse```](BulkSendJobResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/EmbeddedApi.md b/docs/EmbeddedApi.md
index 7ea121b..62955f9 100644
--- a/docs/EmbeddedApi.md
+++ b/docs/EmbeddedApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**embeddedEditUrl**](EmbeddedApi.md#embeddedEditUrl) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL
[**embeddedSignUrl**](EmbeddedApi.md#embeddedSignUrl) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL
@@ -65,8 +65,8 @@ public class Main {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the template to edit. |
**embeddedEditUrlRequest** | [**EmbeddedEditUrlRequest**](EmbeddedEditUrlRequest.md)| |
@@ -140,8 +140,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureId** | **String**| The id of the signature to get a signature url for. |
### Return type
diff --git a/docs/EmbeddedEditUrlRequest.md b/docs/EmbeddedEditUrlRequest.md
index 3026512..4e2d8c2 100644
--- a/docs/EmbeddedEditUrlRequest.md
+++ b/docs/EmbeddedEditUrlRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `allowEditCcs` | ```Boolean``` | This allows the requester to enable/disable to add or change CC roles when editing the template. | |
| `ccRoles` | ```List``` | The CC roles that must be assigned when using the template to send a signature request. To remove all CC roles, pass in a single role with no name. For use in a POST request. | |
| `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | |
diff --git a/docs/EmbeddedEditUrlResponse.md b/docs/EmbeddedEditUrlResponse.md
index ec2ce55..959e0c7 100644
--- a/docs/EmbeddedEditUrlResponse.md
+++ b/docs/EmbeddedEditUrlResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `embedded` | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `embedded`*_required_ | [```EmbeddedEditUrlResponseEmbedded```](EmbeddedEditUrlResponseEmbedded.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/EmbeddedEditUrlResponseEmbedded.md b/docs/EmbeddedEditUrlResponseEmbedded.md
index 6406555..78ad702 100644
--- a/docs/EmbeddedEditUrlResponseEmbedded.md
+++ b/docs/EmbeddedEditUrlResponseEmbedded.md
@@ -6,8 +6,8 @@ An embedded template object.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `editUrl` | ```String``` | A template url that can be opened in an iFrame. | |
| `expiresAt` | ```Integer``` | The specific time that the the `edit_url` link expires, in epoch. | |
diff --git a/docs/EmbeddedSignUrlResponse.md b/docs/EmbeddedSignUrlResponse.md
index a6f119c..6f39b97 100644
--- a/docs/EmbeddedSignUrlResponse.md
+++ b/docs/EmbeddedSignUrlResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `embedded` | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `embedded`*_required_ | [```EmbeddedSignUrlResponseEmbedded```](EmbeddedSignUrlResponseEmbedded.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/EmbeddedSignUrlResponseEmbedded.md b/docs/EmbeddedSignUrlResponseEmbedded.md
index 4f3a834..b2fd6c9 100644
--- a/docs/EmbeddedSignUrlResponseEmbedded.md
+++ b/docs/EmbeddedSignUrlResponseEmbedded.md
@@ -6,8 +6,8 @@ An object that contains necessary information to set up embedded signing.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `signUrl` | ```String``` | A signature url that can be opened in an iFrame. | |
| `expiresAt` | ```Integer``` | The specific time that the the `sign_url` link expires, in epoch. | |
diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md
index e3153c6..f1a560c 100644
--- a/docs/ErrorResponse.md
+++ b/docs/ErrorResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `error`*_required_ | [```ErrorResponseError```](ErrorResponseError.md) | | |
diff --git a/docs/ErrorResponseError.md b/docs/ErrorResponseError.md
index 91f1e8e..656aa5c 100644
--- a/docs/ErrorResponseError.md
+++ b/docs/ErrorResponseError.md
@@ -6,8 +6,8 @@ Contains information about an error that occurred.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `errorMsg`*_required_ | ```String``` | Message describing an error. | |
| `errorName`*_required_ | ```String``` | Name of the error. | |
| `errorPath` | ```String``` | Path at which an error occurred. | |
diff --git a/docs/EventCallbackRequest.md b/docs/EventCallbackRequest.md
index 9286aec..73daf94 100644
--- a/docs/EventCallbackRequest.md
+++ b/docs/EventCallbackRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `event`*_required_ | [```EventCallbackRequestEvent```](EventCallbackRequestEvent.md) | | |
| `account` | [```AccountResponse```](AccountResponse.md) | | |
| `signatureRequest` | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | |
diff --git a/docs/EventCallbackRequestEvent.md b/docs/EventCallbackRequestEvent.md
index 1e71c97..19ab491 100644
--- a/docs/EventCallbackRequestEvent.md
+++ b/docs/EventCallbackRequestEvent.md
@@ -6,8 +6,8 @@ Basic information about the event that occurred.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `eventTime`*_required_ | ```String``` | Time the event was created (using Unix time). | |
| `eventType`*_required_ | [```EventTypeEnum```](#EventTypeEnum) | Type of callback event that was triggered. | |
| `eventHash`*_required_ | ```String``` | Generated hash used to verify source of event data. | |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Enum: EventTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| ACCOUNT_CONFIRMED | "account_confirmed" |
| UNKNOWN_ERROR | "unknown_error" |
diff --git a/docs/EventCallbackRequestEventMetadata.md b/docs/EventCallbackRequestEventMetadata.md
index c8a911f..13208c2 100644
--- a/docs/EventCallbackRequestEventMetadata.md
+++ b/docs/EventCallbackRequestEventMetadata.md
@@ -6,8 +6,8 @@ Specific metadata about the event.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `relatedSignatureId` | ```String``` | Signature ID for a specific signer. Applicable to `signature_request_signed` and `signature_request_viewed` events. | |
| `reportedForAccountId` | ```String``` | Account ID the event was reported for. | |
| `reportedForAppId` | ```String``` | App ID the event was reported for. | |
diff --git a/docs/FaxLineAddUserRequest.md b/docs/FaxLineAddUserRequest.md
new file mode 100644
index 0000000..1c9e997
--- /dev/null
+++ b/docs/FaxLineAddUserRequest.md
@@ -0,0 +1,16 @@
+
+
+# FaxLineAddUserRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `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
new file mode 100644
index 0000000..1997f1f
--- /dev/null
+++ b/docs/FaxLineApi.md
@@ -0,0 +1,504 @@
+# FaxLineApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+[**faxLineAddUser**](FaxLineApi.md#faxLineAddUser) | **PUT** /fax_line/add_user | Add Fax Line User
+[**faxLineAreaCodeGet**](FaxLineApi.md#faxLineAreaCodeGet) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes
+[**faxLineCreate**](FaxLineApi.md#faxLineCreate) | **POST** /fax_line/create | Purchase Fax Line
+[**faxLineDelete**](FaxLineApi.md#faxLineDelete) | **DELETE** /fax_line | Delete Fax Line
+[**faxLineGet**](FaxLineApi.md#faxLineGet) | **GET** /fax_line | Get Fax Line
+[**faxLineList**](FaxLineApi.md#faxLineList) | **GET** /fax_line/list | List Fax Lines
+[**faxLineRemoveUser**](FaxLineApi.md#faxLineRemoveUser) | **PUT** /fax_line/remove_user | Remove Fax Line Access
+
+
+
+## faxLineAddUser
+
+> FaxLineResponse faxLineAddUser(faxLineAddUserRequest)
+
+Add Fax Line User
+
+Grants a user access to the specified Fax Line.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **faxLineAddUserRequest** | [**FaxLineAddUserRequest**](FaxLineAddUserRequest.md)| |
+
+### Return type
+
+[**FaxLineResponse**](FaxLineResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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 | - |
+
+
+## faxLineAreaCodeGet
+
+> FaxLineAreaCodeGetResponse faxLineAreaCodeGet(country, state, province, city)
+
+Get Available Fax Line Area Codes
+
+Returns a response with the area codes available for a given state/provice and city.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| 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]
+
+### Return type
+
+[**FaxLineAreaCodeGetResponse**](FaxLineAreaCodeGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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 | - |
+
+
+## faxLineCreate
+
+> FaxLineResponse faxLineCreate(faxLineCreateRequest)
+
+Purchase Fax Line
+
+Purchases a new Fax Line.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **faxLineCreateRequest** | [**FaxLineCreateRequest**](FaxLineCreateRequest.md)| |
+
+### Return type
+
+[**FaxLineResponse**](FaxLineResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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 | - |
+
+
+## faxLineDelete
+
+> faxLineDelete(faxLineDeleteRequest)
+
+Delete Fax Line
+
+Deletes the specified Fax Line from the subscription.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **faxLineDeleteRequest** | [**FaxLineDeleteRequest**](FaxLineDeleteRequest.md)| |
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **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 | - |
+
+
+## faxLineGet
+
+> FaxLineResponse faxLineGet(number)
+
+Get Fax Line
+
+Returns the properties and settings of a Fax Line.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **number** | **String**| The Fax Line number. |
+
+### Return type
+
+[**FaxLineResponse**](FaxLineResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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 | - |
+
+
+## faxLineList
+
+> FaxLineListResponse faxLineList(accountId, page, pageSize, showTeamLines)
+
+List Fax Lines
+
+Returns the properties and settings of multiple Fax Lines.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| 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]
+
+### Return type
+
+[**FaxLineListResponse**](FaxLineListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **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 | - |
+
+
+## faxLineRemoveUser
+
+> FaxLineResponse faxLineRemoveUser(faxLineRemoveUserRequest)
+
+Remove Fax Line Access
+
+Removes a user's access to the specified Fax Line.
+
+### Example
+
+```java
+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();
+ }
+ }
+}
+
+```
+
+### Parameters
+
+
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
+ **faxLineRemoveUserRequest** | [**FaxLineRemoveUserRequest**](FaxLineRemoveUserRequest.md)| |
+
+### Return type
+
+[**FaxLineResponse**](FaxLineResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | successful operation | * X-RateLimit-Limit - * X-RateLimit-Remaining - * X-Ratelimit-Reset - |
+| **4XX** | failed_operation | - |
+
diff --git a/docs/FaxLineAreaCodeGetCountryEnum.md b/docs/FaxLineAreaCodeGetCountryEnum.md
new file mode 100644
index 0000000..10275bc
--- /dev/null
+++ b/docs/FaxLineAreaCodeGetCountryEnum.md
@@ -0,0 +1,15 @@
+
+
+# FaxLineAreaCodeGetCountryEnum
+
+## Enum
+
+
+* `CA` (value: `"CA"`)
+
+* `US` (value: `"US"`)
+
+* `UK` (value: `"UK"`)
+
+
+
diff --git a/docs/FaxLineAreaCodeGetProvinceEnum.md b/docs/FaxLineAreaCodeGetProvinceEnum.md
new file mode 100644
index 0000000..13cf500
--- /dev/null
+++ b/docs/FaxLineAreaCodeGetProvinceEnum.md
@@ -0,0 +1,35 @@
+
+
+# FaxLineAreaCodeGetProvinceEnum
+
+## Enum
+
+
+* `AB` (value: `"AB"`)
+
+* `BC` (value: `"BC"`)
+
+* `MB` (value: `"MB"`)
+
+* `NB` (value: `"NB"`)
+
+* `NL` (value: `"NL"`)
+
+* `NT` (value: `"NT"`)
+
+* `NS` (value: `"NS"`)
+
+* `NU` (value: `"NU"`)
+
+* `ON` (value: `"ON"`)
+
+* `PE` (value: `"PE"`)
+
+* `QC` (value: `"QC"`)
+
+* `SK` (value: `"SK"`)
+
+* `YT` (value: `"YT"`)
+
+
+
diff --git a/docs/FaxLineAreaCodeGetResponse.md b/docs/FaxLineAreaCodeGetResponse.md
new file mode 100644
index 0000000..0026193
--- /dev/null
+++ b/docs/FaxLineAreaCodeGetResponse.md
@@ -0,0 +1,14 @@
+
+
+# FaxLineAreaCodeGetResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `areaCodes`*_required_ | ```List``` | | |
+
+
+
diff --git a/docs/FaxLineAreaCodeGetStateEnum.md b/docs/FaxLineAreaCodeGetStateEnum.md
new file mode 100644
index 0000000..577a48c
--- /dev/null
+++ b/docs/FaxLineAreaCodeGetStateEnum.md
@@ -0,0 +1,111 @@
+
+
+# FaxLineAreaCodeGetStateEnum
+
+## Enum
+
+
+* `AK` (value: `"AK"`)
+
+* `AL` (value: `"AL"`)
+
+* `AR` (value: `"AR"`)
+
+* `AZ` (value: `"AZ"`)
+
+* `CA` (value: `"CA"`)
+
+* `CO` (value: `"CO"`)
+
+* `CT` (value: `"CT"`)
+
+* `DC` (value: `"DC"`)
+
+* `DE` (value: `"DE"`)
+
+* `FL` (value: `"FL"`)
+
+* `GA` (value: `"GA"`)
+
+* `HI` (value: `"HI"`)
+
+* `IA` (value: `"IA"`)
+
+* `ID` (value: `"ID"`)
+
+* `IL` (value: `"IL"`)
+
+* `IN` (value: `"IN"`)
+
+* `KS` (value: `"KS"`)
+
+* `KY` (value: `"KY"`)
+
+* `LA` (value: `"LA"`)
+
+* `MA` (value: `"MA"`)
+
+* `MD` (value: `"MD"`)
+
+* `ME` (value: `"ME"`)
+
+* `MI` (value: `"MI"`)
+
+* `MN` (value: `"MN"`)
+
+* `MO` (value: `"MO"`)
+
+* `MS` (value: `"MS"`)
+
+* `MT` (value: `"MT"`)
+
+* `NC` (value: `"NC"`)
+
+* `ND` (value: `"ND"`)
+
+* `NE` (value: `"NE"`)
+
+* `NH` (value: `"NH"`)
+
+* `NJ` (value: `"NJ"`)
+
+* `NM` (value: `"NM"`)
+
+* `NV` (value: `"NV"`)
+
+* `NY` (value: `"NY"`)
+
+* `OH` (value: `"OH"`)
+
+* `OK` (value: `"OK"`)
+
+* `OR` (value: `"OR"`)
+
+* `PA` (value: `"PA"`)
+
+* `RI` (value: `"RI"`)
+
+* `SC` (value: `"SC"`)
+
+* `SD` (value: `"SD"`)
+
+* `TN` (value: `"TN"`)
+
+* `TX` (value: `"TX"`)
+
+* `UT` (value: `"UT"`)
+
+* `VA` (value: `"VA"`)
+
+* `VT` (value: `"VT"`)
+
+* `WA` (value: `"WA"`)
+
+* `WI` (value: `"WI"`)
+
+* `WV` (value: `"WV"`)
+
+* `WY` (value: `"WY"`)
+
+
+
diff --git a/docs/FaxLineCreateRequest.md b/docs/FaxLineCreateRequest.md
new file mode 100644
index 0000000..da9ba39
--- /dev/null
+++ b/docs/FaxLineCreateRequest.md
@@ -0,0 +1,27 @@
+
+
+# FaxLineCreateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `areaCode`*_required_ | ```Integer``` | Area code | |
+| `country`*_required_ | [```CountryEnum```](#CountryEnum) | Country | |
+| `city` | ```String``` | City | |
+| `accountId` | ```String``` | Account ID | |
+
+
+
+## Enum: CountryEnum
+
+| Name | Value |
+---- | -----
+| CA | "CA" |
+| US | "US" |
+| UK | "UK" |
+
+
+
diff --git a/docs/FaxLineDeleteRequest.md b/docs/FaxLineDeleteRequest.md
new file mode 100644
index 0000000..de1748f
--- /dev/null
+++ b/docs/FaxLineDeleteRequest.md
@@ -0,0 +1,14 @@
+
+
+# FaxLineDeleteRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `number`*_required_ | ```String``` | The Fax Line number. | |
+
+
+
diff --git a/docs/FaxLineListResponse.md b/docs/FaxLineListResponse.md
new file mode 100644
index 0000000..69891dc
--- /dev/null
+++ b/docs/FaxLineListResponse.md
@@ -0,0 +1,16 @@
+
+
+# FaxLineListResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| `faxLines`*_required_ | [```List```](FaxLineResponseFaxLine.md) | | |
+| `warnings` | [```WarningResponse```](WarningResponse.md) | | |
+
+
+
diff --git a/docs/FaxLineRemoveUserRequest.md b/docs/FaxLineRemoveUserRequest.md
new file mode 100644
index 0000000..51d81b8
--- /dev/null
+++ b/docs/FaxLineRemoveUserRequest.md
@@ -0,0 +1,16 @@
+
+
+# FaxLineRemoveUserRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `number`*_required_ | ```String``` | The Fax Line number. | |
+| `accountId` | ```String``` | Account ID | |
+| `emailAddress` | ```String``` | Email address | |
+
+
+
diff --git a/docs/FaxLineResponse.md b/docs/FaxLineResponse.md
new file mode 100644
index 0000000..c5256bb
--- /dev/null
+++ b/docs/FaxLineResponse.md
@@ -0,0 +1,15 @@
+
+
+# FaxLineResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `faxLine`*_required_ | [```FaxLineResponseFaxLine```](FaxLineResponseFaxLine.md) | | |
+| `warnings` | [```WarningResponse```](WarningResponse.md) | | |
+
+
+
diff --git a/docs/FaxLineResponseFaxLine.md b/docs/FaxLineResponseFaxLine.md
new file mode 100644
index 0000000..daf0d20
--- /dev/null
+++ b/docs/FaxLineResponseFaxLine.md
@@ -0,0 +1,17 @@
+
+
+# FaxLineResponseFaxLine
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `number` | ```String``` | Number | |
+| `createdAt` | ```Integer``` | Created at | |
+| `updatedAt` | ```Integer``` | Updated at | |
+| `accounts` | [```List```](AccountResponse.md) | | |
+
+
+
diff --git a/docs/FileResponse.md b/docs/FileResponse.md
index 4851cb4..058a80e 100644
--- a/docs/FileResponse.md
+++ b/docs/FileResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `fileUrl` | ```String``` | URL to the file. | |
-| `expiresAt` | ```Integer``` | When the link expires. | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `fileUrl`*_required_ | ```String``` | URL to the file. | |
+| `expiresAt`*_required_ | ```Integer``` | When the link expires. | |
diff --git a/docs/FileResponseDataUri.md b/docs/FileResponseDataUri.md
index 1950223..65c0b7d 100644
--- a/docs/FileResponseDataUri.md
+++ b/docs/FileResponseDataUri.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `dataUri` | ```String``` | File as base64 encoded string. | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `dataUri`*_required_ | ```String``` | File as base64 encoded string. | |
diff --git a/docs/ListInfoResponse.md b/docs/ListInfoResponse.md
index 02063e7..b9d464e 100644
--- a/docs/ListInfoResponse.md
+++ b/docs/ListInfoResponse.md
@@ -6,8 +6,8 @@ Contains pagination information about the data returned.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `numPages` | ```Integer``` | Total number of pages available. | |
| `numResults` | ```Integer``` | Total number of objects available. | |
| `page` | ```Integer``` | Number of the page being returned. | |
diff --git a/docs/OAuthApi.md b/docs/OAuthApi.md
index 466367a..533052b 100644
--- a/docs/OAuthApi.md
+++ b/docs/OAuthApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**oauthTokenGenerate**](OAuthApi.md#oauthTokenGenerate) | **POST** /oauth/token | OAuth Token Generate
[**oauthTokenRefresh**](OAuthApi.md#oauthTokenRefresh) | **POST** /oauth/token?refresh | OAuth Token Refresh
@@ -56,8 +56,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**oauthTokenGenerateRequest** | [**OAuthTokenGenerateRequest**](OAuthTokenGenerateRequest.md)| |
### Return type
@@ -123,8 +123,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**oauthTokenRefreshRequest** | [**OAuthTokenRefreshRequest**](OAuthTokenRefreshRequest.md)| |
### Return type
diff --git a/docs/OAuthTokenGenerateRequest.md b/docs/OAuthTokenGenerateRequest.md
index 7f376db..45ad0b0 100644
--- a/docs/OAuthTokenGenerateRequest.md
+++ b/docs/OAuthTokenGenerateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId`*_required_ | ```String``` | The client id of the app requesting authorization. | |
| `clientSecret`*_required_ | ```String``` | The secret token of your app. | |
| `code`*_required_ | ```String``` | The code passed to your callback when the user granted access. | |
diff --git a/docs/OAuthTokenRefreshRequest.md b/docs/OAuthTokenRefreshRequest.md
index b88bb9e..2b985fa 100644
--- a/docs/OAuthTokenRefreshRequest.md
+++ b/docs/OAuthTokenRefreshRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `grantType`*_required_ | ```String``` | When refreshing an existing token use `refresh_token`. | |
| `refreshToken`*_required_ | ```String``` | The token provided when you got the expired access token. | |
diff --git a/docs/OAuthTokenResponse.md b/docs/OAuthTokenResponse.md
index 28da620..86824cc 100644
--- a/docs/OAuthTokenResponse.md
+++ b/docs/OAuthTokenResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accessToken` | ```String``` | | |
| `tokenType` | ```String``` | | |
| `refreshToken` | ```String``` | | |
diff --git a/docs/ReportApi.md b/docs/ReportApi.md
index e6af8fa..e0a4097 100644
--- a/docs/ReportApi.md
+++ b/docs/ReportApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**reportCreate**](ReportApi.md#reportCreate) | **POST** /report/create | Create Report
@@ -68,8 +68,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**reportCreateRequest** | [**ReportCreateRequest**](ReportCreateRequest.md)| |
### Return type
diff --git a/docs/ReportCreateRequest.md b/docs/ReportCreateRequest.md
index 99053df..d2f4b67 100644
--- a/docs/ReportCreateRequest.md
+++ b/docs/ReportCreateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `endDate`*_required_ | ```String``` | The (inclusive) end date for the report data in `MM/DD/YYYY` format. | |
| `reportType`*_required_ | [```List<ReportTypeEnum>```](#List<ReportTypeEnum>) | The type(s) of the report you are requesting. Allowed values are `user_activity` and `document_status`. User activity reports contain list of all users and their activity during the specified date range. Document status report contain a list of signature requests created in the specified time range (and their status). | |
| `startDate`*_required_ | ```String``` | The (inclusive) start date for the report data in `MM/DD/YYYY` format. | |
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Enum: List<ReportTypeEnum>
-Name | Value
+| Name | Value |
---- | -----
| USER_ACTIVITY | "user_activity" |
| DOCUMENT_STATUS | "document_status" |
diff --git a/docs/ReportCreateResponse.md b/docs/ReportCreateResponse.md
index 9f8c117..9fc8565 100644
--- a/docs/ReportCreateResponse.md
+++ b/docs/ReportCreateResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `report` | [```ReportResponse```](ReportResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `report`*_required_ | [```ReportResponse```](ReportResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/ReportResponse.md b/docs/ReportResponse.md
index ade5b63..b48dde6 100644
--- a/docs/ReportResponse.md
+++ b/docs/ReportResponse.md
@@ -6,8 +6,8 @@ Contains information about the report request.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `success` | ```String``` | A message indicating the requested operation's success | |
| `startDate` | ```String``` | The (inclusive) start date for the report data in MM/DD/YYYY format. | |
| `endDate` | ```String``` | The (inclusive) end date for the report data in MM/DD/YYYY format. | |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Enum: List<ReportTypeEnum>
-Name | Value
+| Name | Value |
---- | -----
| USER_ACTIVITY | "user_activity" |
| DOCUMENT_STATUS | "document_status" |
diff --git a/docs/SignatureRequestApi.md b/docs/SignatureRequestApi.md
index f8e0100..ee42461 100644
--- a/docs/SignatureRequestApi.md
+++ b/docs/SignatureRequestApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**signatureRequestBulkCreateEmbeddedWithTemplate**](SignatureRequestApi.md#signatureRequestBulkCreateEmbeddedWithTemplate) | **POST** /signature_request/bulk_create_embedded_with_template | Embedded Bulk Send with Template
[**signatureRequestBulkSendWithTemplate**](SignatureRequestApi.md#signatureRequestBulkSendWithTemplate) | **POST** /signature_request/bulk_send_with_template | Bulk Send with Template
[**signatureRequestCancel**](SignatureRequestApi.md#signatureRequestCancel) | **POST** /signature_request/cancel/{signature_request_id} | Cancel Incomplete Signature Request
@@ -115,8 +115,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestBulkCreateEmbeddedWithTemplateRequest** | [**SignatureRequestBulkCreateEmbeddedWithTemplateRequest**](SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md)| |
### Return type
@@ -231,8 +231,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestBulkSendWithTemplateRequest** | [**SignatureRequestBulkSendWithTemplateRequest**](SignatureRequestBulkSendWithTemplateRequest.md)| |
### Return type
@@ -311,8 +311,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the incomplete SignatureRequest to cancel. |
### Return type
@@ -414,8 +414,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestCreateEmbeddedRequest** | [**SignatureRequestCreateEmbeddedRequest**](SignatureRequestCreateEmbeddedRequest.md)| |
### Return type
@@ -508,8 +508,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestCreateEmbeddedWithTemplateRequest** | [**SignatureRequestCreateEmbeddedWithTemplateRequest**](SignatureRequestCreateEmbeddedWithTemplateRequest.md)| |
### Return type
@@ -585,8 +585,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to retrieve. |
**fileType** | **String**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [default to pdf] [enum: pdf, zip]
@@ -662,8 +662,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to retrieve. |
### Return type
@@ -738,8 +738,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to retrieve. |
**forceDownload** | **Integer**| 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]
@@ -813,8 +813,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to retrieve. |
### Return type
@@ -897,8 +897,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**accountId** | **String**| Which account to return SignatureRequests for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional]
**page** | **Integer**| Which page number of the SignatureRequest 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]
@@ -974,8 +974,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to release. |
### Return type
@@ -1053,8 +1053,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to send a reminder for. |
**signatureRequestRemindRequest** | [**SignatureRequestRemindRequest**](SignatureRequestRemindRequest.md)| |
@@ -1130,8 +1130,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to remove. |
### Return type
@@ -1238,8 +1238,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestSendRequest** | [**SignatureRequestSendRequest**](SignatureRequestSendRequest.md)| |
### Return type
@@ -1344,8 +1344,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestSendWithTemplateRequest** | [**SignatureRequestSendWithTemplateRequest**](SignatureRequestSendWithTemplateRequest.md)| |
### Return type
@@ -1426,8 +1426,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The id of the SignatureRequest to update. |
**signatureRequestUpdateRequest** | [**SignatureRequestUpdateRequest**](SignatureRequestUpdateRequest.md)| |
diff --git a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
index fae117a..4243ead 100644
--- a/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
+++ b/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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. | |
| `signerFile` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
diff --git a/docs/SignatureRequestBulkSendWithTemplateRequest.md b/docs/SignatureRequestBulkSendWithTemplateRequest.md
index e573522..1798f6f 100644
--- a/docs/SignatureRequestBulkSendWithTemplateRequest.md
+++ b/docs/SignatureRequestBulkSendWithTemplateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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. | |
| `signerFile` | ```File``` | `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:
- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional)
By using the feature, you agree you are responsible for obtaining a signer's consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).
**NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field" suffix will be treated as a custom field (optional)
You may only specify field values here, any other options should be set in the custom_fields request parameter.
Example CSV:
``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ``` | |
| `signerList` | [```List```](SubBulkSignerList.md) | `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both. | |
diff --git a/docs/SignatureRequestCreateEmbeddedRequest.md b/docs/SignatureRequestCreateEmbeddedRequest.md
index fcfd185..383f8a8 100644
--- a/docs/SignatureRequestCreateEmbeddedRequest.md
+++ b/docs/SignatureRequestCreateEmbeddedRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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. | |
diff --git a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
index a4dd8ce..050a7e6 100644
--- a/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
+++ b/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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. | |
diff --git a/docs/SignatureRequestGetResponse.md b/docs/SignatureRequestGetResponse.md
index 7ce17ba..25ce665 100644
--- a/docs/SignatureRequestGetResponse.md
+++ b/docs/SignatureRequestGetResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `signatureRequest` | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `signatureRequest`*_required_ | [```SignatureRequestResponse```](SignatureRequestResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/SignatureRequestListResponse.md b/docs/SignatureRequestListResponse.md
index 94fb156..6384d2a 100644
--- a/docs/SignatureRequestListResponse.md
+++ b/docs/SignatureRequestListResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `signatureRequests` | [```List```](SignatureRequestResponse.md) | Contains information about signature requests. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `signatureRequests`*_required_ | [```List```](SignatureRequestResponse.md) | Contains information about signature requests. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/SignatureRequestRemindRequest.md b/docs/SignatureRequestRemindRequest.md
index 1a16fc5..bf76e08 100644
--- a/docs/SignatureRequestRemindRequest.md
+++ b/docs/SignatureRequestRemindRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `emailAddress`*_required_ | ```String``` | The email address of the signer to send a reminder to. | |
| `name` | ```String``` | The name of the signer to send a reminder to. Include if two or more signers share an email address. | |
diff --git a/docs/SignatureRequestResponse.md b/docs/SignatureRequestResponse.md
index 50ae417..2c9efa5 100644
--- a/docs/SignatureRequestResponse.md
+++ b/docs/SignatureRequestResponse.md
@@ -6,8 +6,8 @@ Contains information about a signature request.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `testMode` | ```Boolean``` | Whether this is a test signature request. Test requests have no legal value. Defaults to `false`. | |
| `signatureRequestId` | ```String``` | The id of the SignatureRequest. | |
| `requesterEmailAddress` | ```String``` | The email address of the initiator of the SignatureRequest. | |
diff --git a/docs/SignatureRequestResponseAttachment.md b/docs/SignatureRequestResponseAttachment.md
index 23267b6..1ef3a20 100644
--- a/docs/SignatureRequestResponseAttachment.md
+++ b/docs/SignatureRequestResponseAttachment.md
@@ -6,8 +6,8 @@ Signer attachments.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `id`*_required_ | ```String``` | The unique ID for this attachment. | |
| `signer`*_required_ | ```String``` | The Signer this attachment is assigned to. | |
| `name`*_required_ | ```String``` | The name of this attachment. | |
diff --git a/docs/SignatureRequestResponseCustomFieldBase.md b/docs/SignatureRequestResponseCustomFieldBase.md
index 7dbca6c..7b5f104 100644
--- a/docs/SignatureRequestResponseCustomFieldBase.md
+++ b/docs/SignatureRequestResponseCustomFieldBase.md
@@ -9,8 +9,8 @@ An array of Custom Field objects containing the name and type of each custom fie
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | |
| `name`*_required_ | ```String``` | The name of the Custom Field. | |
| `required` | ```Boolean``` | A boolean value denoting if this field is required. | |
diff --git a/docs/SignatureRequestResponseCustomFieldCheckbox.md b/docs/SignatureRequestResponseCustomFieldCheckbox.md
index e0f8e10..c2cb841 100644
--- a/docs/SignatureRequestResponseCustomFieldCheckbox.md
+++ b/docs/SignatureRequestResponseCustomFieldCheckbox.md
@@ -6,8 +6,8 @@ This class extends `SignatureRequestResponseCustomFieldBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | |
| `value` | ```Boolean``` | A true/false for checkbox fields | |
diff --git a/docs/SignatureRequestResponseCustomFieldText.md b/docs/SignatureRequestResponseCustomFieldText.md
index c78e24d..23ceb56 100644
--- a/docs/SignatureRequestResponseCustomFieldText.md
+++ b/docs/SignatureRequestResponseCustomFieldText.md
@@ -6,8 +6,8 @@ This class extends `SignatureRequestResponseCustomFieldBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this Custom Field. Only 'text' and 'checkbox' are currently supported. | |
| `value` | ```String``` | A text string for text fields | |
diff --git a/docs/SignatureRequestResponseDataBase.md b/docs/SignatureRequestResponseDataBase.md
index 7504c49..a9605a4 100644
--- a/docs/SignatureRequestResponseDataBase.md
+++ b/docs/SignatureRequestResponseDataBase.md
@@ -6,8 +6,8 @@ An array of form field objects containing the name, value, and type of each text
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `apiId` | ```String``` | The unique ID for this field. | |
| `signatureId` | ```String``` | The ID of the signature to which this response is linked. | |
| `name` | ```String``` | The name of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueCheckbox.md b/docs/SignatureRequestResponseDataValueCheckbox.md
index 972c48d..fda5704 100644
--- a/docs/SignatureRequestResponseDataValueCheckbox.md
+++ b/docs/SignatureRequestResponseDataValueCheckbox.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A yes/no checkbox | |
| `value` | ```Boolean``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueCheckboxMerge.md b/docs/SignatureRequestResponseDataValueCheckboxMerge.md
index 6abdf96..96af5eb 100644
--- a/docs/SignatureRequestResponseDataValueCheckboxMerge.md
+++ b/docs/SignatureRequestResponseDataValueCheckboxMerge.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A checkbox field that has default value set by the api | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueDateSigned.md b/docs/SignatureRequestResponseDataValueDateSigned.md
index 2b9e5a7..308bd8b 100644
--- a/docs/SignatureRequestResponseDataValueDateSigned.md
+++ b/docs/SignatureRequestResponseDataValueDateSigned.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A date | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueDropdown.md b/docs/SignatureRequestResponseDataValueDropdown.md
index 8b5a0f1..599cb3c 100644
--- a/docs/SignatureRequestResponseDataValueDropdown.md
+++ b/docs/SignatureRequestResponseDataValueDropdown.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | An input field for dropdowns | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueInitials.md b/docs/SignatureRequestResponseDataValueInitials.md
index f1d0453..7f82d74 100644
--- a/docs/SignatureRequestResponseDataValueInitials.md
+++ b/docs/SignatureRequestResponseDataValueInitials.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | An input field for initials | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueRadio.md b/docs/SignatureRequestResponseDataValueRadio.md
index 2897f89..b8e073f 100644
--- a/docs/SignatureRequestResponseDataValueRadio.md
+++ b/docs/SignatureRequestResponseDataValueRadio.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | An input field for radios | |
| `value` | ```Boolean``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueSignature.md b/docs/SignatureRequestResponseDataValueSignature.md
index bb7ce7f..910932c 100644
--- a/docs/SignatureRequestResponseDataValueSignature.md
+++ b/docs/SignatureRequestResponseDataValueSignature.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A signature input field | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueText.md b/docs/SignatureRequestResponseDataValueText.md
index 837f27c..e08ec8f 100644
--- a/docs/SignatureRequestResponseDataValueText.md
+++ b/docs/SignatureRequestResponseDataValueText.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A text input field | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseDataValueTextMerge.md b/docs/SignatureRequestResponseDataValueTextMerge.md
index 60349e2..2b5e0d3 100644
--- a/docs/SignatureRequestResponseDataValueTextMerge.md
+++ b/docs/SignatureRequestResponseDataValueTextMerge.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type` | ```String``` | A text field that has default text set by the api | |
| `value` | ```String``` | The value of the form field. | |
diff --git a/docs/SignatureRequestResponseSignatures.md b/docs/SignatureRequestResponseSignatures.md
index 3eac9df..2f0e16d 100644
--- a/docs/SignatureRequestResponseSignatures.md
+++ b/docs/SignatureRequestResponseSignatures.md
@@ -6,8 +6,8 @@ An array of signature objects, 1 for each signer.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `signatureId` | ```String``` | Signature identifier. | |
| `signerGroupGuid` | ```String``` | Signer Group GUID | |
| `signerEmailAddress` | ```String``` | The email address of the signer. | |
diff --git a/docs/SignatureRequestSendRequest.md b/docs/SignatureRequestSendRequest.md
index 5b156ef..9143039 100644
--- a/docs/SignatureRequestSendRequest.md
+++ b/docs/SignatureRequestSendRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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. | |
diff --git a/docs/SignatureRequestSendWithTemplateRequest.md b/docs/SignatureRequestSendWithTemplateRequest.md
index 5ccd15d..7a8d8c8 100644
--- a/docs/SignatureRequestSendWithTemplateRequest.md
+++ b/docs/SignatureRequestSendWithTemplateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| 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`. | |
diff --git a/docs/SignatureRequestUpdateRequest.md b/docs/SignatureRequestUpdateRequest.md
index 4e11595..4b38c53 100644
--- a/docs/SignatureRequestUpdateRequest.md
+++ b/docs/SignatureRequestUpdateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `signatureId`*_required_ | ```String``` | The signature ID for the recipient. | |
| `emailAddress` | ```String``` | The new email address for the recipient.
This will generate a new `signature_id` value.
**NOTE:** Optional if `name` is provided. | |
| `name` | ```String``` | The new name for the recipient.
**NOTE:** Optional if `email_address` is provided. | |
diff --git a/docs/SubAttachment.md b/docs/SubAttachment.md
index a7e00e0..b5e9c80 100644
--- a/docs/SubAttachment.md
+++ b/docs/SubAttachment.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name`*_required_ | ```String``` | The name of attachment. | |
| `signerIndex`*_required_ | ```Integer``` | The signer's index in the `signers` parameter (0-based indexing).
**NOTE:** Only one signer can be assigned per attachment. | |
| `instructions` | ```String``` | The instructions for uploading the attachment. | |
diff --git a/docs/SubBulkSignerList.md b/docs/SubBulkSignerList.md
index 043abbb..918c935 100644
--- a/docs/SubBulkSignerList.md
+++ b/docs/SubBulkSignerList.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `customFields` | [```List```](SubBulkSignerListCustomField.md) | An array of custom field values. | |
| `signers` | [```List```](SubSignatureRequestTemplateSigner.md) | Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.
Currently only templates with a single role are supported. All signers must have the same `role` value. | |
diff --git a/docs/SubBulkSignerListCustomField.md b/docs/SubBulkSignerListCustomField.md
index 2a7c9c0..b37ad53 100644
--- a/docs/SubBulkSignerListCustomField.md
+++ b/docs/SubBulkSignerListCustomField.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name`*_required_ | ```String``` | The name of the custom field. Must be the field's `name` or `api_id`. | |
| `value`*_required_ | ```String``` | The value of the custom field. | |
diff --git a/docs/SubCC.md b/docs/SubCC.md
index 4f59a76..37eacd3 100644
--- a/docs/SubCC.md
+++ b/docs/SubCC.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `role`*_required_ | ```String``` | Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role. | |
| `emailAddress`*_required_ | ```String``` | The email address of the CC recipient. | |
diff --git a/docs/SubCustomField.md b/docs/SubCustomField.md
index b65f804..a309fd6 100644
--- a/docs/SubCustomField.md
+++ b/docs/SubCustomField.md
@@ -10,8 +10,8 @@ For using pre-filled on repeatable signature requests, merge fields are added to
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name`*_required_ | ```String``` | The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing. | |
| `editor` | ```String``` | Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`.
**NOTE:** Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable. | |
| `required` | ```Boolean``` | Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`. | |
diff --git a/docs/SubEditorOptions.md b/docs/SubEditorOptions.md
index b1c284b..5483d25 100644
--- a/docs/SubEditorOptions.md
+++ b/docs/SubEditorOptions.md
@@ -6,8 +6,8 @@ This allows the requester to specify editor options when a preparing a document
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `allowEditSigners` | ```Boolean``` | Allows requesters to edit the list of signers | |
| `allowEditDocuments` | ```Boolean``` | Allows requesters to edit documents, including delete and add | |
diff --git a/docs/SubFieldOptions.md b/docs/SubFieldOptions.md
index 92ef40d..e1be769 100644
--- a/docs/SubFieldOptions.md
+++ b/docs/SubFieldOptions.md
@@ -6,15 +6,15 @@ This allows the requester to specify field options for a signature request.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `dateFormat`*_required_ | [```DateFormatEnum```](#DateFormatEnum) | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))
**NOTE:** Only available for Premium and higher. | |
## Enum: DateFormatEnum
-Name | Value
+| Name | Value |
---- | -----
| MMDDYYYY | "MM / DD / YYYY" |
| MM_DD_YYYY | "MM - DD - YYYY" |
diff --git a/docs/SubFormFieldGroup.md b/docs/SubFormFieldGroup.md
index 676afdd..c55ffa3 100644
--- a/docs/SubFormFieldGroup.md
+++ b/docs/SubFormFieldGroup.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `groupId`*_required_ | ```String``` | ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`. | |
| `groupLabel`*_required_ | ```String``` | Name of the group | |
| `requirement`*_required_ | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`
- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | |
diff --git a/docs/SubFormFieldRule.md b/docs/SubFormFieldRule.md
index eb4d25e..ca44afd 100644
--- a/docs/SubFormFieldRule.md
+++ b/docs/SubFormFieldRule.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `id`*_required_ | ```String``` | Must be unique across all defined rules. | |
| `triggerOperator`*_required_ | ```String``` | Currently only `AND` is supported. Support for `OR` is being worked on. | |
| `triggers`*_required_ | [```List```](SubFormFieldRuleTrigger.md) | An array of trigger definitions, the "if this" part of "**if this**, then that". Currently only a single trigger per rule is allowed. | |
diff --git a/docs/SubFormFieldRuleAction.md b/docs/SubFormFieldRuleAction.md
index 12828ad..6a2d434 100644
--- a/docs/SubFormFieldRuleAction.md
+++ b/docs/SubFormFieldRuleAction.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `hidden`*_required_ | ```Boolean``` | `true` to hide the target field when rule is satisfied, otherwise `false`. | |
| `type`*_required_ | [```TypeEnum```](#TypeEnum) | | |
| `fieldId` | ```String``` | **field_id** or **group_id** is required, but not both.
Must reference the `api_id` of an existing field defined within `form_fields_per_document`.
Cannot use with `group_id`. Trigger and action fields must belong to the same signer. | |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Enum: TypeEnum
-Name | Value
+| Name | Value |
---- | -----
| FIELD_VISIBILITY | "change-field-visibility" |
| GROUP_VISIBILITY | "change-group-visibility" |
diff --git a/docs/SubFormFieldRuleTrigger.md b/docs/SubFormFieldRuleTrigger.md
index ed866d0..3a82561 100644
--- a/docs/SubFormFieldRuleTrigger.md
+++ b/docs/SubFormFieldRuleTrigger.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `id`*_required_ | ```String``` | Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer. | |
| `operator`*_required_ | [```OperatorEnum```](#OperatorEnum) | 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 | |
| `value` | ```String``` | **value** or **values** is required, but not both.
The value to match against **operator**.
- When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match`
Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1` | |
@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Enum: OperatorEnum
-Name | Value
+| Name | Value |
---- | -----
| ANY | "any" |
| IS | "is" |
diff --git a/docs/SubFormFieldsPerDocumentBase.md b/docs/SubFormFieldsPerDocumentBase.md
index 26ce88d..a44994a 100644
--- a/docs/SubFormFieldsPerDocumentBase.md
+++ b/docs/SubFormFieldsPerDocumentBase.md
@@ -19,8 +19,8 @@ The fields that should appear on the document, expressed as an array of objects.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `documentIndex`*_required_ | ```Integer``` | Represents the integer index of the `file` or `file_url` document the field should be attached to. | |
| `apiId`*_required_ | ```String``` | An identifier for the field that is unique across all documents in the request. | |
| `height`*_required_ | ```Integer``` | Size of the field in pixels. | |
diff --git a/docs/SubFormFieldsPerDocumentCheckbox.md b/docs/SubFormFieldsPerDocumentCheckbox.md
index efcf95d..c4e473f 100644
--- a/docs/SubFormFieldsPerDocumentCheckbox.md
+++ b/docs/SubFormFieldsPerDocumentCheckbox.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class. | |
| `isChecked`*_required_ | ```Boolean``` | `true` for checking the checkbox field by default, otherwise `false`. | |
| `group` | ```String``` | String referencing group defined in `form_field_groups` parameter. | |
diff --git a/docs/SubFormFieldsPerDocumentCheckboxMerge.md b/docs/SubFormFieldsPerDocumentCheckboxMerge.md
index efdc811..8243596 100644
--- a/docs/SubFormFieldsPerDocumentCheckboxMerge.md
+++ b/docs/SubFormFieldsPerDocumentCheckboxMerge.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class. | |
diff --git a/docs/SubFormFieldsPerDocumentDateSigned.md b/docs/SubFormFieldsPerDocumentDateSigned.md
index 49d4b5f..bffc1a4 100644
--- a/docs/SubFormFieldsPerDocumentDateSigned.md
+++ b/docs/SubFormFieldsPerDocumentDateSigned.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | |
| `fontFamily` | [```FontFamilyEnum```](#FontFamilyEnum) | Font family for the field. | |
| `fontSize` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Enum: FontFamilyEnum
-Name | Value
+| Name | Value |
---- | -----
| HELVETICA | "helvetica" |
| ARIAL | "arial" |
@@ -28,12 +28,12 @@ Name | Value
| TREBUCHET | "trebuchet" |
| VERDANA | "verdana" |
| ROBOTO | "roboto" |
-| ROBOTOMONO | "robotoMono" |
-| NOTOSANS | "notoSans" |
-| NOTOSERIF | "notoSerif" |
-| NOTOCJK_JP_REGULAR | "notoCJK-JP-Regular" |
-| NOTOHEBREW_REGULAR | "notoHebrew-Regular" |
-| NOTOSANTHAIMERGED | "notoSanThaiMerged" |
+| ROBOTO_MONO | "robotoMono" |
+| NOTO_SANS | "notoSans" |
+| NOTO_SERIF | "notoSerif" |
+| NOTO_CJK_JP_REGULAR | "notoCJK-JP-Regular" |
+| NOTO_HEBREW_REGULAR | "notoHebrew-Regular" |
+| NOTO_SAN_THAI_MERGED | "notoSanThaiMerged" |
diff --git a/docs/SubFormFieldsPerDocumentDropdown.md b/docs/SubFormFieldsPerDocumentDropdown.md
index afed12e..ca470ea 100644
--- a/docs/SubFormFieldsPerDocumentDropdown.md
+++ b/docs/SubFormFieldsPerDocumentDropdown.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class. | |
| `options`*_required_ | ```List``` | Array of string values representing dropdown values. | |
| `content` | ```String``` | Selected value in `options` array. Value must exist in array. | |
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
## Enum: FontFamilyEnum
-Name | Value
+| Name | Value |
---- | -----
| HELVETICA | "helvetica" |
| ARIAL | "arial" |
@@ -30,12 +30,12 @@ Name | Value
| TREBUCHET | "trebuchet" |
| VERDANA | "verdana" |
| ROBOTO | "roboto" |
-| ROBOTOMONO | "robotoMono" |
-| NOTOSANS | "notoSans" |
-| NOTOSERIF | "notoSerif" |
-| NOTOCJK_JP_REGULAR | "notoCJK-JP-Regular" |
-| NOTOHEBREW_REGULAR | "notoHebrew-Regular" |
-| NOTOSANTHAIMERGED | "notoSanThaiMerged" |
+| ROBOTO_MONO | "robotoMono" |
+| NOTO_SANS | "notoSans" |
+| NOTO_SERIF | "notoSerif" |
+| NOTO_CJK_JP_REGULAR | "notoCJK-JP-Regular" |
+| NOTO_HEBREW_REGULAR | "notoHebrew-Regular" |
+| NOTO_SAN_THAI_MERGED | "notoSanThaiMerged" |
diff --git a/docs/SubFormFieldsPerDocumentFontEnum.md b/docs/SubFormFieldsPerDocumentFontEnum.md
index c4ea623..b7582a2 100644
--- a/docs/SubFormFieldsPerDocumentFontEnum.md
+++ b/docs/SubFormFieldsPerDocumentFontEnum.md
@@ -25,17 +25,17 @@
* `ROBOTO` (value: `"roboto"`)
-* `ROBOTOMONO` (value: `"robotoMono"`)
+* `ROBOTO_MONO` (value: `"robotoMono"`)
-* `NOTOSANS` (value: `"notoSans"`)
+* `NOTO_SANS` (value: `"notoSans"`)
-* `NOTOSERIF` (value: `"notoSerif"`)
+* `NOTO_SERIF` (value: `"notoSerif"`)
-* `NOTOCJK_JP_REGULAR` (value: `"notoCJK-JP-Regular"`)
+* `NOTO_CJK_JP_REGULAR` (value: `"notoCJK-JP-Regular"`)
-* `NOTOHEBREW_REGULAR` (value: `"notoHebrew-Regular"`)
+* `NOTO_HEBREW_REGULAR` (value: `"notoHebrew-Regular"`)
-* `NOTOSANTHAIMERGED` (value: `"notoSanThaiMerged"`)
+* `NOTO_SAN_THAI_MERGED` (value: `"notoSanThaiMerged"`)
diff --git a/docs/SubFormFieldsPerDocumentHyperlink.md b/docs/SubFormFieldsPerDocumentHyperlink.md
index 220f6f9..543312b 100644
--- a/docs/SubFormFieldsPerDocumentHyperlink.md
+++ b/docs/SubFormFieldsPerDocumentHyperlink.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class. | |
| `content`*_required_ | ```String``` | Link Text. | |
| `contentUrl`*_required_ | ```String``` | Link URL. | |
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
## Enum: FontFamilyEnum
-Name | Value
+| Name | Value |
---- | -----
| HELVETICA | "helvetica" |
| ARIAL | "arial" |
@@ -30,12 +30,12 @@ Name | Value
| TREBUCHET | "trebuchet" |
| VERDANA | "verdana" |
| ROBOTO | "roboto" |
-| ROBOTOMONO | "robotoMono" |
-| NOTOSANS | "notoSans" |
-| NOTOSERIF | "notoSerif" |
-| NOTOCJK_JP_REGULAR | "notoCJK-JP-Regular" |
-| NOTOHEBREW_REGULAR | "notoHebrew-Regular" |
-| NOTOSANTHAIMERGED | "notoSanThaiMerged" |
+| ROBOTO_MONO | "robotoMono" |
+| NOTO_SANS | "notoSans" |
+| NOTO_SERIF | "notoSerif" |
+| NOTO_CJK_JP_REGULAR | "notoCJK-JP-Regular" |
+| NOTO_HEBREW_REGULAR | "notoHebrew-Regular" |
+| NOTO_SAN_THAI_MERGED | "notoSanThaiMerged" |
diff --git a/docs/SubFormFieldsPerDocumentInitials.md b/docs/SubFormFieldsPerDocumentInitials.md
index 155c7a5..c3537c2 100644
--- a/docs/SubFormFieldsPerDocumentInitials.md
+++ b/docs/SubFormFieldsPerDocumentInitials.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class. | |
diff --git a/docs/SubFormFieldsPerDocumentRadio.md b/docs/SubFormFieldsPerDocumentRadio.md
index 38150a4..c194876 100644
--- a/docs/SubFormFieldsPerDocumentRadio.md
+++ b/docs/SubFormFieldsPerDocumentRadio.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class. | |
| `group`*_required_ | ```String``` | String referencing group defined in `form_field_groups` parameter. | |
| `isChecked`*_required_ | ```Boolean``` | `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`. | |
diff --git a/docs/SubFormFieldsPerDocumentSignature.md b/docs/SubFormFieldsPerDocumentSignature.md
index 949922a..187b145 100644
--- a/docs/SubFormFieldsPerDocumentSignature.md
+++ b/docs/SubFormFieldsPerDocumentSignature.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A signature input field. Use the `SubFormFieldsPerDocumentSignature` class. | |
diff --git a/docs/SubFormFieldsPerDocumentText.md b/docs/SubFormFieldsPerDocumentText.md
index 9a0c2d6..d431f54 100644
--- a/docs/SubFormFieldsPerDocumentText.md
+++ b/docs/SubFormFieldsPerDocumentText.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A text input field. Use the `SubFormFieldsPerDocumentText` class. | |
| `placeholder` | ```String``` | Placeholder value for text field. | |
| `autoFillType` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | |
@@ -24,7 +24,7 @@ Name | Type | Description | Notes
## Enum: ValidationTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| NUMBERS_ONLY | "numbers_only" |
| LETTERS_ONLY | "letters_only" |
@@ -41,7 +41,7 @@ Name | Value
## Enum: FontFamilyEnum
-Name | Value
+| Name | Value |
---- | -----
| HELVETICA | "helvetica" |
| ARIAL | "arial" |
@@ -53,12 +53,12 @@ Name | Value
| TREBUCHET | "trebuchet" |
| VERDANA | "verdana" |
| ROBOTO | "roboto" |
-| ROBOTOMONO | "robotoMono" |
-| NOTOSANS | "notoSans" |
-| NOTOSERIF | "notoSerif" |
-| NOTOCJK_JP_REGULAR | "notoCJK-JP-Regular" |
-| NOTOHEBREW_REGULAR | "notoHebrew-Regular" |
-| NOTOSANTHAIMERGED | "notoSanThaiMerged" |
+| ROBOTO_MONO | "robotoMono" |
+| NOTO_SANS | "notoSans" |
+| NOTO_SERIF | "notoSerif" |
+| NOTO_CJK_JP_REGULAR | "notoCJK-JP-Regular" |
+| NOTO_HEBREW_REGULAR | "notoHebrew-Regular" |
+| NOTO_SAN_THAI_MERGED | "notoSanThaiMerged" |
diff --git a/docs/SubFormFieldsPerDocumentTextMerge.md b/docs/SubFormFieldsPerDocumentTextMerge.md
index a5fc080..e1876cc 100644
--- a/docs/SubFormFieldsPerDocumentTextMerge.md
+++ b/docs/SubFormFieldsPerDocumentTextMerge.md
@@ -6,8 +6,8 @@ This class extends `SubFormFieldsPerDocumentBase`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | |
| `fontFamily` | [```FontFamilyEnum```](#FontFamilyEnum) | Font family for the field. | |
| `fontSize` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.
**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | |
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Enum: FontFamilyEnum
-Name | Value
+| Name | Value |
---- | -----
| HELVETICA | "helvetica" |
| ARIAL | "arial" |
@@ -28,12 +28,12 @@ Name | Value
| TREBUCHET | "trebuchet" |
| VERDANA | "verdana" |
| ROBOTO | "roboto" |
-| ROBOTOMONO | "robotoMono" |
-| NOTOSANS | "notoSans" |
-| NOTOSERIF | "notoSerif" |
-| NOTOCJK_JP_REGULAR | "notoCJK-JP-Regular" |
-| NOTOHEBREW_REGULAR | "notoHebrew-Regular" |
-| NOTOSANTHAIMERGED | "notoSanThaiMerged" |
+| ROBOTO_MONO | "robotoMono" |
+| NOTO_SANS | "notoSans" |
+| NOTO_SERIF | "notoSerif" |
+| NOTO_CJK_JP_REGULAR | "notoCJK-JP-Regular" |
+| NOTO_HEBREW_REGULAR | "notoHebrew-Regular" |
+| NOTO_SAN_THAI_MERGED | "notoSanThaiMerged" |
diff --git a/docs/SubMergeField.md b/docs/SubMergeField.md
index f509e12..6658235 100644
--- a/docs/SubMergeField.md
+++ b/docs/SubMergeField.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name`*_required_ | ```String``` | The name of the merge field. Must be unique. | |
| `type`*_required_ | [```TypeEnum```](#TypeEnum) | The type of merge field. | |
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Enum: TypeEnum
-Name | Value
+| Name | Value |
---- | -----
| TEXT | "text" |
| CHECKBOX | "checkbox" |
diff --git a/docs/SubOAuth.md b/docs/SubOAuth.md
index 23beca8..527d0be 100644
--- a/docs/SubOAuth.md
+++ b/docs/SubOAuth.md
@@ -6,8 +6,8 @@ OAuth related parameters.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `callbackUrl` | ```String``` | The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided) | |
| `scopes` | [```List<ScopesEnum>```](#List<ScopesEnum>) | A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided). | |
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Enum: List<ScopesEnum>
-Name | Value
+| Name | Value |
---- | -----
| REQUEST_SIGNATURE | "request_signature" |
| BASIC_ACCOUNT_INFO | "basic_account_info" |
diff --git a/docs/SubOptions.md b/docs/SubOptions.md
index 3ddab2e..c36523a 100644
--- a/docs/SubOptions.md
+++ b/docs/SubOptions.md
@@ -6,8 +6,8 @@ Additional options supported by API App.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `canInsertEverywhere` | ```Boolean``` | Determines if signers can use "Insert Everywhere" when signing a document. | |
diff --git a/docs/SubSignatureRequestGroupedSigners.md b/docs/SubSignatureRequestGroupedSigners.md
index d1845fb..80ace34 100644
--- a/docs/SubSignatureRequestGroupedSigners.md
+++ b/docs/SubSignatureRequestGroupedSigners.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `group`*_required_ | ```String``` | The name of the group. | |
| `signers`*_required_ | [```List```](SubSignatureRequestSigner.md) | Signers belonging to this Group.
**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | |
| `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | |
diff --git a/docs/SubSignatureRequestSigner.md b/docs/SubSignatureRequestSigner.md
index affc504..109c422 100644
--- a/docs/SubSignatureRequestSigner.md
+++ b/docs/SubSignatureRequestSigner.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name`*_required_ | ```String``` | The name of the signer. | |
| `emailAddress`*_required_ | ```String``` | The email address of the signer. | |
| `order` | ```Integer``` | The order the signer is required to sign in. | |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
## Enum: SmsPhoneNumberTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| AUTHENTICATION | "authentication" |
| DELIVERY | "delivery" |
diff --git a/docs/SubSignatureRequestTemplateSigner.md b/docs/SubSignatureRequestTemplateSigner.md
index 0db962b..866b373 100644
--- a/docs/SubSignatureRequestTemplateSigner.md
+++ b/docs/SubSignatureRequestTemplateSigner.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). It's case-sensitive. | |
| `name`*_required_ | ```String``` | The name of the signer. | |
| `emailAddress`*_required_ | ```String``` | The email address of the signer. | |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
## Enum: SmsPhoneNumberTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| AUTHENTICATION | "authentication" |
| DELIVERY | "delivery" |
diff --git a/docs/SubSigningOptions.md b/docs/SubSigningOptions.md
index b4acf7f..bca1160 100644
--- a/docs/SubSigningOptions.md
+++ b/docs/SubSigningOptions.md
@@ -8,8 +8,8 @@ This allows the requester to specify the types allowed for creating a signature.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `defaultType`*_required_ | [```DefaultTypeEnum```](#DefaultTypeEnum) | The default type shown (limited to the listed types) | |
| `draw` | ```Boolean``` | Allows drawing the signature | |
| `phone` | ```Boolean``` | Allows using a smartphone to email the signature | |
@@ -20,7 +20,7 @@ Name | Type | Description | Notes
## Enum: DefaultTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| DRAW | "draw" |
| PHONE | "phone" |
diff --git a/docs/SubTeamResponse.md b/docs/SubTeamResponse.md
index 2b67530..df784d0 100644
--- a/docs/SubTeamResponse.md
+++ b/docs/SubTeamResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `teamId` | ```String``` | The id of a team | |
| `name` | ```String``` | The name of a team | |
diff --git a/docs/SubTemplateRole.md b/docs/SubTemplateRole.md
index 88784cd..a1ee8e0 100644
--- a/docs/SubTemplateRole.md
+++ b/docs/SubTemplateRole.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The role name of the signer that will be displayed when the template is used to create a signature request. | |
| `order` | ```Integer``` | The order in which this signer role is required to sign. | |
diff --git a/docs/SubUnclaimedDraftSigner.md b/docs/SubUnclaimedDraftSigner.md
index 70eeb3b..fec680a 100644
--- a/docs/SubUnclaimedDraftSigner.md
+++ b/docs/SubUnclaimedDraftSigner.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `emailAddress`*_required_ | ```String``` | The email address of the signer. | |
| `name`*_required_ | ```String``` | The name of the signer. | |
| `order` | ```Integer``` | The order the signer is required to sign in. | |
diff --git a/docs/SubUnclaimedDraftTemplateSigner.md b/docs/SubUnclaimedDraftTemplateSigner.md
index 5e164c4..1c65476 100644
--- a/docs/SubUnclaimedDraftTemplateSigner.md
+++ b/docs/SubUnclaimedDraftTemplateSigner.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `role`*_required_ | ```String``` | Must match an existing role in chosen Template(s). | |
| `name`*_required_ | ```String``` | The name of the signer filling the role of `role`. | |
| `emailAddress`*_required_ | ```String``` | The email address of the signer filling the role of `role`. | |
diff --git a/docs/SubWhiteLabelingOptions.md b/docs/SubWhiteLabelingOptions.md
index c3cb045..0a5880d 100644
--- a/docs/SubWhiteLabelingOptions.md
+++ b/docs/SubWhiteLabelingOptions.md
@@ -8,8 +8,8 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `headerBackgroundColor` | ```String``` | | |
| `legalVersion` | [```LegalVersionEnum```](#LegalVersionEnum) | | |
| `linkColor` | ```String``` | | |
@@ -30,7 +30,7 @@ Name | Type | Description | Notes
## Enum: LegalVersionEnum
-Name | Value
+| Name | Value |
---- | -----
| TERMS1 | "terms1" |
| TERMS2 | "terms2" |
diff --git a/docs/TeamAddMemberRequest.md b/docs/TeamAddMemberRequest.md
index 062c8b8..122e45b 100644
--- a/docs/TeamAddMemberRequest.md
+++ b/docs/TeamAddMemberRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.
Account id of the user to invite to your Team. | |
| `emailAddress` | ```String``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.
Email address of the user to invite to your Team. | |
| `role` | [```RoleEnum```](#RoleEnum) | A role member will take in a new Team.
**NOTE:** This parameter is used only if `team_id` is provided. | |
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Enum: RoleEnum
-Name | Value
+| Name | Value |
---- | -----
| MEMBER | "Member" |
| DEVELOPER | "Developer" |
diff --git a/docs/TeamApi.md b/docs/TeamApi.md
index 2525598..b35b40e 100644
--- a/docs/TeamApi.md
+++ b/docs/TeamApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**teamAddMember**](TeamApi.md#teamAddMember) | **PUT** /team/add_member | Add User to Team
[**teamCreate**](TeamApi.md#teamCreate) | **POST** /team/create | Create Team
[**teamDelete**](TeamApi.md#teamDelete) | **DELETE** /team/destroy | Delete Team
@@ -70,8 +70,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamAddMemberRequest** | [**TeamAddMemberRequest**](TeamAddMemberRequest.md)| |
**teamId** | **String**| The id of the team. | [optional]
@@ -146,8 +146,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamCreateRequest** | [**TeamCreateRequest**](TeamCreateRequest.md)| |
### Return type
@@ -354,8 +354,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamId** | **String**| The id of the team. | [optional]
### Return type
@@ -428,8 +428,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**emailAddress** | **String**| The email address for which to display the team invites. | [optional]
### Return type
@@ -504,8 +504,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamId** | **String**| The id of the team that a member list is being requested from. |
**page** | **Integer**| Which page number of the team member 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]
@@ -582,8 +582,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamRemoveMemberRequest** | [**TeamRemoveMemberRequest**](TeamRemoveMemberRequest.md)| |
### Return type
@@ -658,8 +658,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamId** | **String**| The id of the parent Team. |
**page** | **Integer**| Which page number of the SubTeam 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]
@@ -735,8 +735,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**teamUpdateRequest** | [**TeamUpdateRequest**](TeamUpdateRequest.md)| |
### Return type
diff --git a/docs/TeamCreateRequest.md b/docs/TeamCreateRequest.md
index cb70adc..1a48616 100644
--- a/docs/TeamCreateRequest.md
+++ b/docs/TeamCreateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of your Team. | |
diff --git a/docs/TeamGetInfoResponse.md b/docs/TeamGetInfoResponse.md
index 3b6d3e3..1d2bc62 100644
--- a/docs/TeamGetInfoResponse.md
+++ b/docs/TeamGetInfoResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `team` | [```TeamInfoResponse```](TeamInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `team`*_required_ | [```TeamInfoResponse```](TeamInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TeamGetResponse.md b/docs/TeamGetResponse.md
index fe2d79f..690796e 100644
--- a/docs/TeamGetResponse.md
+++ b/docs/TeamGetResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `team` | [```TeamResponse```](TeamResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `team`*_required_ | [```TeamResponse```](TeamResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TeamInfoResponse.md b/docs/TeamInfoResponse.md
index aaf76ca..a776d4e 100644
--- a/docs/TeamInfoResponse.md
+++ b/docs/TeamInfoResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `teamId` | ```String``` | The id of a team | |
| `teamParent` | [```TeamParentResponse```](TeamParentResponse.md) | | |
| `name` | ```String``` | The name of a team | |
diff --git a/docs/TeamInviteResponse.md b/docs/TeamInviteResponse.md
index 317bec3..c23aa4e 100644
--- a/docs/TeamInviteResponse.md
+++ b/docs/TeamInviteResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `emailAddress` | ```String``` | Email address of the user invited to this team. | |
| `teamId` | ```String``` | Id of the team. | |
| `role` | ```String``` | Role of the user invited to this team. | |
diff --git a/docs/TeamInvitesResponse.md b/docs/TeamInvitesResponse.md
index 5f0e669..bdb648b 100644
--- a/docs/TeamInvitesResponse.md
+++ b/docs/TeamInvitesResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `teamInvites` | [```List```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `teamInvites`*_required_ | [```List```](TeamInviteResponse.md) | Contains a list of team invites and their roles. | |
| `warnings` | [```List```](WarningResponse.md) | | |
diff --git a/docs/TeamMemberResponse.md b/docs/TeamMemberResponse.md
index e35f8f6..eb42aa0 100644
--- a/docs/TeamMemberResponse.md
+++ b/docs/TeamMemberResponse.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | Account id of the team member. | |
| `emailAddress` | ```String``` | Email address of the team member. | |
| `role` | ```String``` | The specific role a member has on the team. | |
diff --git a/docs/TeamMembersResponse.md b/docs/TeamMembersResponse.md
index d3e5e67..7853182 100644
--- a/docs/TeamMembersResponse.md
+++ b/docs/TeamMembersResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `teamMembers` | [```List```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `teamMembers`*_required_ | [```List```](TeamMemberResponse.md) | Contains a list of team members and their roles for a specific team. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | | |
diff --git a/docs/TeamParentResponse.md b/docs/TeamParentResponse.md
index 1a0d49c..c6ba18a 100644
--- a/docs/TeamParentResponse.md
+++ b/docs/TeamParentResponse.md
@@ -6,8 +6,8 @@ Information about the parent team if a team has one, set to `null` otherwise.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `teamId` | ```String``` | The id of a team | |
| `name` | ```String``` | The name of a team | |
diff --git a/docs/TeamRemoveMemberRequest.md b/docs/TeamRemoveMemberRequest.md
index 79d3a4c..46f4853 100644
--- a/docs/TeamRemoveMemberRequest.md
+++ b/docs/TeamRemoveMemberRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.
Account id to remove from your Team. | |
| `emailAddress` | ```String``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.
Email address of the Account to remove from your Team. | |
| `newOwnerEmailAddress` | ```String``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.
**NOTE:** Only available for Enterprise plans. | |
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
## Enum: NewRoleEnum
-Name | Value
+| Name | Value |
---- | -----
| MEMBER | "Member" |
| DEVELOPER | "Developer" |
diff --git a/docs/TeamResponse.md b/docs/TeamResponse.md
index 2606103..ca6344c 100644
--- a/docs/TeamResponse.md
+++ b/docs/TeamResponse.md
@@ -6,8 +6,8 @@ Contains information about your team and its members
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of your Team | |
| `accounts` | [```List```](AccountResponse.md) | | |
| `invitedAccounts` | [```List```](AccountResponse.md) | A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`. | |
diff --git a/docs/TeamSubTeamsResponse.md b/docs/TeamSubTeamsResponse.md
index 1b618f8..636aa33 100644
--- a/docs/TeamSubTeamsResponse.md
+++ b/docs/TeamSubTeamsResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `subTeams` | [```List```](SubTeamResponse.md) | Contains a list with sub teams. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `subTeams`*_required_ | [```List```](SubTeamResponse.md) | Contains a list with sub teams. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | | |
diff --git a/docs/TeamUpdateRequest.md b/docs/TeamUpdateRequest.md
index 545510d..9df0fe1 100644
--- a/docs/TeamUpdateRequest.md
+++ b/docs/TeamUpdateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of your Team. | |
diff --git a/docs/TemplateAddUserRequest.md b/docs/TemplateAddUserRequest.md
index 5415106..7496619 100644
--- a/docs/TemplateAddUserRequest.md
+++ b/docs/TemplateAddUserRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The id of the Account to give access to the Template. **NOTE:** The account id prevails if email address is also provided. | |
| `emailAddress` | ```String``` | The email address of the Account to give access to the Template. **NOTE:** The account id prevails if it is also provided. | |
| `skipNotification` | ```Boolean``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | |
diff --git a/docs/TemplateApi.md b/docs/TemplateApi.md
index 0a2a448..a3394d6 100644
--- a/docs/TemplateApi.md
+++ b/docs/TemplateApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**templateAddUser**](TemplateApi.md#templateAddUser) | **POST** /template/add_user/{template_id} | Add User to Template
[**templateCreate**](TemplateApi.md#templateCreate) | **POST** /template/create | Create Template
[**templateCreateEmbeddedDraft**](TemplateApi.md#templateCreateEmbeddedDraft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft
@@ -71,8 +71,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the Template to give the Account access to. |
**templateAddUserRequest** | [**TemplateAddUserRequest**](TemplateAddUserRequest.md)| |
@@ -178,8 +178,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateCreateRequest** | [**TemplateCreateRequest**](TemplateCreateRequest.md)| |
### Return type
@@ -284,8 +284,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateCreateEmbeddedDraftRequest** | [**TemplateCreateEmbeddedDraftRequest**](TemplateCreateEmbeddedDraftRequest.md)| |
### Return type
@@ -356,8 +356,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the Template to delete. |
### Return type
@@ -433,8 +433,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the template files to retrieve. |
**fileType** | **String**| Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] [enum: pdf, zip]
@@ -510,8 +510,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the template files to retrieve. |
### Return type
@@ -586,8 +586,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the template files to retrieve. |
**forceDownload** | **Integer**| 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]
@@ -661,8 +661,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the Template to retrieve. |
### Return type
@@ -740,8 +740,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**accountId** | **String**| Which account to return Templates for. Must be a team member. Use `all` to indicate all team members. Defaults to your account. | [optional]
**page** | **Integer**| Which page number of the Template 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]
@@ -820,8 +820,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The id of the Template to remove the Account's access to. |
**templateRemoveUserRequest** | [**TemplateRemoveUserRequest**](TemplateRemoveUserRequest.md)| |
@@ -911,8 +911,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**templateId** | **String**| The ID of the template whose files to update. |
**templateUpdateFilesRequest** | [**TemplateUpdateFilesRequest**](TemplateUpdateFilesRequest.md)| |
diff --git a/docs/TemplateCreateEmbeddedDraftRequest.md b/docs/TemplateCreateEmbeddedDraftRequest.md
index be051c8..05f2497 100644
--- a/docs/TemplateCreateEmbeddedDraftRequest.md
+++ b/docs/TemplateCreateEmbeddedDraftRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId`*_required_ | ```String``` | Client id of the app you're using to create this draft. Used to apply the branding and callback url defined for the app. | |
| `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. | |
diff --git a/docs/TemplateCreateEmbeddedDraftResponse.md b/docs/TemplateCreateEmbeddedDraftResponse.md
index 2109e4f..f25b48d 100644
--- a/docs/TemplateCreateEmbeddedDraftResponse.md
+++ b/docs/TemplateCreateEmbeddedDraftResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `template` | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `template`*_required_ | [```TemplateCreateEmbeddedDraftResponseTemplate```](TemplateCreateEmbeddedDraftResponseTemplate.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TemplateCreateEmbeddedDraftResponseTemplate.md b/docs/TemplateCreateEmbeddedDraftResponseTemplate.md
index 7b7dc1e..770cce4 100644
--- a/docs/TemplateCreateEmbeddedDraftResponseTemplate.md
+++ b/docs/TemplateCreateEmbeddedDraftResponseTemplate.md
@@ -6,8 +6,8 @@ Template object with parameters: `template_id`, `edit_url`, `expires_at`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `templateId` | ```String``` | The id of the Template. | |
| `editUrl` | ```String``` | Link to edit the template. | |
| `expiresAt` | ```Integer``` | When the link expires. | |
diff --git a/docs/TemplateCreateRequest.md b/docs/TemplateCreateRequest.md
index 4d529fd..5f99510 100644
--- a/docs/TemplateCreateRequest.md
+++ b/docs/TemplateCreateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `formFieldsPerDocument`*_required_ | [```List```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.
* Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
| `signerRoles`*_required_ | [```List```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this 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. | |
diff --git a/docs/TemplateCreateResponse.md b/docs/TemplateCreateResponse.md
index 6554466..3c73896 100644
--- a/docs/TemplateCreateResponse.md
+++ b/docs/TemplateCreateResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `template`*_required_ | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TemplateCreateResponseTemplate.md b/docs/TemplateCreateResponseTemplate.md
index ae09826..1dcd4bd 100644
--- a/docs/TemplateCreateResponseTemplate.md
+++ b/docs/TemplateCreateResponseTemplate.md
@@ -6,8 +6,8 @@ Template object with parameters: `template_id`.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `templateId` | ```String``` | The id of the Template. | |
diff --git a/docs/TemplateEditResponse.md b/docs/TemplateEditResponse.md
index fe7f907..88d225e 100644
--- a/docs/TemplateEditResponse.md
+++ b/docs/TemplateEditResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `templateId` | ```String``` | The id of the Template. | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `templateId`*_required_ | ```String``` | The id of the Template. | |
diff --git a/docs/TemplateGetResponse.md b/docs/TemplateGetResponse.md
index 3e073ba..2ee4867 100644
--- a/docs/TemplateGetResponse.md
+++ b/docs/TemplateGetResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `template` | [```TemplateResponse```](TemplateResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `template`*_required_ | [```TemplateResponse```](TemplateResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TemplateListResponse.md b/docs/TemplateListResponse.md
index 83e54d7..92b720c 100644
--- a/docs/TemplateListResponse.md
+++ b/docs/TemplateListResponse.md
@@ -6,10 +6,10 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `templates` | [```List```](TemplateResponse.md) | List of templates that the API caller has access to. | |
-| `listInfo` | [```ListInfoResponse```](ListInfoResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `templates`*_required_ | [```List```](TemplateResponse.md) | List of templates that the API caller has access to. | |
+| `listInfo`*_required_ | [```ListInfoResponse```](ListInfoResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/TemplateRemoveUserRequest.md b/docs/TemplateRemoveUserRequest.md
index c269702..72a3a58 100644
--- a/docs/TemplateRemoveUserRequest.md
+++ b/docs/TemplateRemoveUserRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | |
| `emailAddress` | ```String``` | The id or email address of the Account to remove access to the Template. The account id prevails if both are provided. | |
diff --git a/docs/TemplateResponse.md b/docs/TemplateResponse.md
index 7811ccc..078685f 100644
--- a/docs/TemplateResponse.md
+++ b/docs/TemplateResponse.md
@@ -6,8 +6,8 @@ Contains information about the templates you and your team have created.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `templateId` | ```String``` | The id of the Template. | |
| `title` | ```String``` | The title of the Template. This will also be the default subject of the message sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | |
| `message` | ```String``` | The default message that will be sent to signers when using this Template to send a SignatureRequest. This can be overridden when sending the SignatureRequest. | |
diff --git a/docs/TemplateResponseAccount.md b/docs/TemplateResponseAccount.md
index bf956bf..10c9964 100644
--- a/docs/TemplateResponseAccount.md
+++ b/docs/TemplateResponseAccount.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `accountId` | ```String``` | The id of the Account. | |
| `emailAddress` | ```String``` | The email address associated with the Account. | |
| `isLocked` | ```Boolean``` | Returns `true` if the user has been locked out of their account by a team admin. | |
diff --git a/docs/TemplateResponseAccountQuota.md b/docs/TemplateResponseAccountQuota.md
index 2ef4344..ad94c24 100644
--- a/docs/TemplateResponseAccountQuota.md
+++ b/docs/TemplateResponseAccountQuota.md
@@ -6,8 +6,8 @@ An array of the designated CC roles that must be specified when sending a Signat
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `templatesLeft` | ```Integer``` | API templates remaining. | |
| `apiSignatureRequestsLeft` | ```Integer``` | API signature requests remaining. | |
| `documentsLeft` | ```Integer``` | Signature requests remaining. | |
diff --git a/docs/TemplateResponseCCRole.md b/docs/TemplateResponseCCRole.md
index 1701c97..64069b8 100644
--- a/docs/TemplateResponseCCRole.md
+++ b/docs/TemplateResponseCCRole.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of the Role. | |
diff --git a/docs/TemplateResponseDocument.md b/docs/TemplateResponseDocument.md
index e0a090d..65da85d 100644
--- a/docs/TemplateResponseDocument.md
+++ b/docs/TemplateResponseDocument.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | Name of the associated file. | |
| `index` | ```Integer``` | Document ordering, the lowest index is displayed first and the highest last (0-based indexing). | |
| `fieldGroups` | [```List```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
diff --git a/docs/TemplateResponseDocumentCustomFieldBase.md b/docs/TemplateResponseDocumentCustomFieldBase.md
index 33ba5cd..edd4617 100644
--- a/docs/TemplateResponseDocumentCustomFieldBase.md
+++ b/docs/TemplateResponseDocumentCustomFieldBase.md
@@ -6,8 +6,8 @@ An array of Form Field objects containing the name and type of each named field.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | | |
| `apiId` | ```String``` | The unique ID for this field. | |
| `name` | ```String``` | The name of the Custom Field. | |
diff --git a/docs/TemplateResponseDocumentCustomFieldCheckbox.md b/docs/TemplateResponseDocumentCustomFieldCheckbox.md
index f69fa79..dbde790 100644
--- a/docs/TemplateResponseDocumentCustomFieldCheckbox.md
+++ b/docs/TemplateResponseDocumentCustomFieldCheckbox.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentCustomFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.
* Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | |
diff --git a/docs/TemplateResponseDocumentCustomFieldText.md b/docs/TemplateResponseDocumentCustomFieldText.md
index 9fa8d7a..ccaf193 100644
--- a/docs/TemplateResponseDocumentCustomFieldText.md
+++ b/docs/TemplateResponseDocumentCustomFieldText.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentCustomFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported.
* Text uses `TemplateResponseDocumentCustomFieldText` * Checkbox uses `TemplateResponseDocumentCustomFieldCheckbox` | |
| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | |
diff --git a/docs/TemplateResponseDocumentFieldGroup.md b/docs/TemplateResponseDocumentFieldGroup.md
index 568bd52..03b5ffb 100644
--- a/docs/TemplateResponseDocumentFieldGroup.md
+++ b/docs/TemplateResponseDocumentFieldGroup.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of the form field group. | |
| `rule` | [```TemplateResponseDocumentFieldGroupRule```](TemplateResponseDocumentFieldGroupRule.md) | | |
diff --git a/docs/TemplateResponseDocumentFieldGroupRule.md b/docs/TemplateResponseDocumentFieldGroupRule.md
index 48b234a..e0f4dcc 100644
--- a/docs/TemplateResponseDocumentFieldGroupRule.md
+++ b/docs/TemplateResponseDocumentFieldGroupRule.md
@@ -6,8 +6,8 @@ The rule used to validate checkboxes in the form field group. See [checkbox fiel
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `requirement` | ```String``` | Examples: `require_0-1` `require_1` `require_1-ormore`
- Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group. | |
| `groupLabel` | ```String``` | Name of the group | |
diff --git a/docs/TemplateResponseDocumentFormFieldBase.md b/docs/TemplateResponseDocumentFormFieldBase.md
index 00696c3..656070a 100644
--- a/docs/TemplateResponseDocumentFormFieldBase.md
+++ b/docs/TemplateResponseDocumentFormFieldBase.md
@@ -6,8 +6,8 @@ An array of Form Field objects containing the name and type of each named field.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | | |
| `apiId` | ```String``` | A unique id for the form field. | |
| `name` | ```String``` | The name of the form field. | |
diff --git a/docs/TemplateResponseDocumentFormFieldCheckbox.md b/docs/TemplateResponseDocumentFormFieldCheckbox.md
index 95a9c47..83d36e0 100644
--- a/docs/TemplateResponseDocumentFormFieldCheckbox.md
+++ b/docs/TemplateResponseDocumentFormFieldCheckbox.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldDateSigned.md b/docs/TemplateResponseDocumentFormFieldDateSigned.md
index 4aeb9b3..5ba66ef 100644
--- a/docs/TemplateResponseDocumentFormFieldDateSigned.md
+++ b/docs/TemplateResponseDocumentFormFieldDateSigned.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldDropdown.md b/docs/TemplateResponseDocumentFormFieldDropdown.md
index f4abfa6..b4f2030 100644
--- a/docs/TemplateResponseDocumentFormFieldDropdown.md
+++ b/docs/TemplateResponseDocumentFormFieldDropdown.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldHyperlink.md b/docs/TemplateResponseDocumentFormFieldHyperlink.md
index c59fa68..0cf89df 100644
--- a/docs/TemplateResponseDocumentFormFieldHyperlink.md
+++ b/docs/TemplateResponseDocumentFormFieldHyperlink.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | |
diff --git a/docs/TemplateResponseDocumentFormFieldInitials.md b/docs/TemplateResponseDocumentFormFieldInitials.md
index 487fde4..707d67e 100644
--- a/docs/TemplateResponseDocumentFormFieldInitials.md
+++ b/docs/TemplateResponseDocumentFormFieldInitials.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldRadio.md b/docs/TemplateResponseDocumentFormFieldRadio.md
index d08e650..b83d96d 100644
--- a/docs/TemplateResponseDocumentFormFieldRadio.md
+++ b/docs/TemplateResponseDocumentFormFieldRadio.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldSignature.md b/docs/TemplateResponseDocumentFormFieldSignature.md
index 08173e8..8be2987 100644
--- a/docs/TemplateResponseDocumentFormFieldSignature.md
+++ b/docs/TemplateResponseDocumentFormFieldSignature.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentFormFieldText.md b/docs/TemplateResponseDocumentFormFieldText.md
index a7eec6d..3581d38 100644
--- a/docs/TemplateResponseDocumentFormFieldText.md
+++ b/docs/TemplateResponseDocumentFormFieldText.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentFormFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this form field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentFormFieldText` * Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox` * Radio Field uses `TemplateResponseDocumentFormFieldRadio` * Signature Field uses `TemplateResponseDocumentFormFieldSignature` * Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned` * Initials Field uses `TemplateResponseDocumentFormFieldInitials` | |
| `avgTextLength` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
| `isMultiline` | ```Boolean``` | Whether this form field is multiline text. | |
@@ -19,7 +19,7 @@ Name | Type | Description | Notes
## Enum: ValidationTypeEnum
-Name | Value
+| Name | Value |
---- | -----
| NUMBERS_ONLY | "numbers_only" |
| LETTERS_ONLY | "letters_only" |
diff --git a/docs/TemplateResponseDocumentStaticFieldBase.md b/docs/TemplateResponseDocumentStaticFieldBase.md
index 18c56b8..4be3cf0 100644
--- a/docs/TemplateResponseDocumentStaticFieldBase.md
+++ b/docs/TemplateResponseDocumentStaticFieldBase.md
@@ -6,8 +6,8 @@ An array describing static overlay fields. **NOTE:** Only available for certain
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | | |
| `apiId` | ```String``` | A unique id for the static field. | |
| `name` | ```String``` | The name of the static field. | |
diff --git a/docs/TemplateResponseDocumentStaticFieldCheckbox.md b/docs/TemplateResponseDocumentStaticFieldCheckbox.md
index d33f03d..6cd9485 100644
--- a/docs/TemplateResponseDocumentStaticFieldCheckbox.md
+++ b/docs/TemplateResponseDocumentStaticFieldCheckbox.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldDateSigned.md b/docs/TemplateResponseDocumentStaticFieldDateSigned.md
index 5e0eaa6..d5c530d 100644
--- a/docs/TemplateResponseDocumentStaticFieldDateSigned.md
+++ b/docs/TemplateResponseDocumentStaticFieldDateSigned.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldDropdown.md b/docs/TemplateResponseDocumentStaticFieldDropdown.md
index bb9f131..5350531 100644
--- a/docs/TemplateResponseDocumentStaticFieldDropdown.md
+++ b/docs/TemplateResponseDocumentStaticFieldDropdown.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldHyperlink.md b/docs/TemplateResponseDocumentStaticFieldHyperlink.md
index a38e229..930658b 100644
--- a/docs/TemplateResponseDocumentStaticFieldHyperlink.md
+++ b/docs/TemplateResponseDocumentStaticFieldHyperlink.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldInitials.md b/docs/TemplateResponseDocumentStaticFieldInitials.md
index 2026401..67d7557 100644
--- a/docs/TemplateResponseDocumentStaticFieldInitials.md
+++ b/docs/TemplateResponseDocumentStaticFieldInitials.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldRadio.md b/docs/TemplateResponseDocumentStaticFieldRadio.md
index 7a140fa..ed32ccc 100644
--- a/docs/TemplateResponseDocumentStaticFieldRadio.md
+++ b/docs/TemplateResponseDocumentStaticFieldRadio.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldSignature.md b/docs/TemplateResponseDocumentStaticFieldSignature.md
index e9a0372..61f8902 100644
--- a/docs/TemplateResponseDocumentStaticFieldSignature.md
+++ b/docs/TemplateResponseDocumentStaticFieldSignature.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseDocumentStaticFieldText.md b/docs/TemplateResponseDocumentStaticFieldText.md
index 4135e5f..3dced01 100644
--- a/docs/TemplateResponseDocumentStaticFieldText.md
+++ b/docs/TemplateResponseDocumentStaticFieldText.md
@@ -6,8 +6,8 @@ This class extends `TemplateResponseDocumentStaticFieldBase`
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).
* Text Field uses `TemplateResponseDocumentStaticFieldText` * Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown` * Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink` * Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox` * Radio Field uses `TemplateResponseDocumentStaticFieldRadio` * Signature Field uses `TemplateResponseDocumentStaticFieldSignature` * Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned` * Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | |
diff --git a/docs/TemplateResponseFieldAvgTextLength.md b/docs/TemplateResponseFieldAvgTextLength.md
index c1fda15..bb66f30 100644
--- a/docs/TemplateResponseFieldAvgTextLength.md
+++ b/docs/TemplateResponseFieldAvgTextLength.md
@@ -6,8 +6,8 @@ Average text length in this field.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `numLines` | ```Integer``` | Number of lines. | |
| `numCharsPerLine` | ```Integer``` | Number of characters per line. | |
diff --git a/docs/TemplateResponseSignerRole.md b/docs/TemplateResponseSignerRole.md
index b95231d..15b48cf 100644
--- a/docs/TemplateResponseSignerRole.md
+++ b/docs/TemplateResponseSignerRole.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `name` | ```String``` | The name of the Role. | |
| `order` | ```Integer``` | If signer order is assigned this is the 0-based index for this role. | |
diff --git a/docs/TemplateUpdateFilesRequest.md b/docs/TemplateUpdateFilesRequest.md
index 2bebedb..8671b87 100644
--- a/docs/TemplateUpdateFilesRequest.md
+++ b/docs/TemplateUpdateFilesRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId` | ```String``` | Client id of the app you're using to update this template. | |
| `files` | ```List``` | Use `files[]` to indicate the uploaded file(s) to use for the template.
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 use for the template.
This endpoint requires either **files** or **file_urls[]**, but not both. | |
diff --git a/docs/TemplateUpdateFilesResponse.md b/docs/TemplateUpdateFilesResponse.md
index 127b295..70930e1 100644
--- a/docs/TemplateUpdateFilesResponse.md
+++ b/docs/TemplateUpdateFilesResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `template` | [```TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `template`*_required_ | [```TemplateUpdateFilesResponseTemplate```](TemplateUpdateFilesResponseTemplate.md) | | |
diff --git a/docs/TemplateUpdateFilesResponseTemplate.md b/docs/TemplateUpdateFilesResponseTemplate.md
index 9c198aa..6289a99 100644
--- a/docs/TemplateUpdateFilesResponseTemplate.md
+++ b/docs/TemplateUpdateFilesResponseTemplate.md
@@ -6,8 +6,8 @@ Contains template id
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `templateId` | ```String``` | The id of the Template. | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/UnclaimedDraftApi.md b/docs/UnclaimedDraftApi.md
index fbdf782..4d6d124 100644
--- a/docs/UnclaimedDraftApi.md
+++ b/docs/UnclaimedDraftApi.md
@@ -2,8 +2,8 @@
All URIs are relative to *https://api.hellosign.com/v3*
-Method | HTTP request | Description
-------------- | ------------- | -------------
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
[**unclaimedDraftCreate**](UnclaimedDraftApi.md#unclaimedDraftCreate) | **POST** /unclaimed_draft/create | Create Unclaimed Draft
[**unclaimedDraftCreateEmbedded**](UnclaimedDraftApi.md#unclaimedDraftCreateEmbedded) | **POST** /unclaimed_draft/create_embedded | Create Embedded Unclaimed Draft
[**unclaimedDraftCreateEmbeddedWithTemplate**](UnclaimedDraftApi.md#unclaimedDraftCreateEmbeddedWithTemplate) | **POST** /unclaimed_draft/create_embedded_with_template | Create Embedded Unclaimed Draft with Template
@@ -95,8 +95,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**unclaimedDraftCreateRequest** | [**UnclaimedDraftCreateRequest**](UnclaimedDraftCreateRequest.md)| |
### Return type
@@ -177,8 +177,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**unclaimedDraftCreateEmbeddedRequest** | [**UnclaimedDraftCreateEmbeddedRequest**](UnclaimedDraftCreateEmbeddedRequest.md)| |
### Return type
@@ -270,8 +270,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**unclaimedDraftCreateEmbeddedWithTemplateRequest** | [**UnclaimedDraftCreateEmbeddedWithTemplateRequest**](UnclaimedDraftCreateEmbeddedWithTemplateRequest.md)| |
### Return type
@@ -350,8 +350,8 @@ public class Example {
### Parameters
-Name | Type | Description | Notes
-------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------- | ------------- | ------------- | -------------|
**signatureRequestId** | **String**| The ID of the signature request to edit and resend. |
**unclaimedDraftEditAndResendRequest** | [**UnclaimedDraftEditAndResendRequest**](UnclaimedDraftEditAndResendRequest.md)| |
diff --git a/docs/UnclaimedDraftCreateEmbeddedRequest.md b/docs/UnclaimedDraftCreateEmbeddedRequest.md
index 60eebef..aab362d 100644
--- a/docs/UnclaimedDraftCreateEmbeddedRequest.md
+++ b/docs/UnclaimedDraftCreateEmbeddedRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId`*_required_ | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | |
| `requesterEmailAddress`*_required_ | ```String``` | The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`. | |
| `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. | |
@@ -49,7 +49,7 @@ Name | Type | Description | Notes
## Enum: TypeEnum
-Name | Value
+| Name | Value |
---- | -----
| SEND_DOCUMENT | "send_document" |
| REQUEST_SIGNATURE | "request_signature" |
diff --git a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
index 52b5175..03ad8b9 100644
--- a/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
+++ b/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId`*_required_ | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | |
| `requesterEmailAddress`*_required_ | ```String``` | The email address of the user that should be designated as the requester of this draft. | |
| `templateIds`*_required_ | ```List``` | Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used. | |
diff --git a/docs/UnclaimedDraftCreateRequest.md b/docs/UnclaimedDraftCreateRequest.md
index cd8249a..f23c6f4 100644
--- a/docs/UnclaimedDraftCreateRequest.md
+++ b/docs/UnclaimedDraftCreateRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `type`*_required_ | [```TypeEnum```](#TypeEnum) | 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. | |
| `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. | |
@@ -37,7 +37,7 @@ Name | Type | Description | Notes
## Enum: TypeEnum
-Name | Value
+| Name | Value |
---- | -----
| SEND_DOCUMENT | "send_document" |
| REQUEST_SIGNATURE | "request_signature" |
diff --git a/docs/UnclaimedDraftCreateResponse.md b/docs/UnclaimedDraftCreateResponse.md
index 65ed7f9..d2d3a7c 100644
--- a/docs/UnclaimedDraftCreateResponse.md
+++ b/docs/UnclaimedDraftCreateResponse.md
@@ -6,9 +6,9 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-| `unclaimedDraft` | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | |
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
+| `unclaimedDraft`*_required_ | [```UnclaimedDraftResponse```](UnclaimedDraftResponse.md) | | |
| `warnings` | [```List```](WarningResponse.md) | A list of warnings. | |
diff --git a/docs/UnclaimedDraftEditAndResendRequest.md b/docs/UnclaimedDraftEditAndResendRequest.md
index daefa5a..8eb306a 100644
--- a/docs/UnclaimedDraftEditAndResendRequest.md
+++ b/docs/UnclaimedDraftEditAndResendRequest.md
@@ -6,8 +6,8 @@
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `clientId`*_required_ | ```String``` | Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app. | |
| `editorOptions` | [```SubEditorOptions```](SubEditorOptions.md) | | |
| `isForEmbeddedSigning` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. | |
diff --git a/docs/UnclaimedDraftResponse.md b/docs/UnclaimedDraftResponse.md
index ab1858d..ab470a2 100644
--- a/docs/UnclaimedDraftResponse.md
+++ b/docs/UnclaimedDraftResponse.md
@@ -6,8 +6,8 @@ A group of documents that a user can take ownership of via the claim URL.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `signatureRequestId` | ```String``` | The ID of the signature request that is represented by this UnclaimedDraft. | |
| `claimUrl` | ```String``` | The URL to be used to claim this UnclaimedDraft. | |
| `signingRedirectUrl` | ```String``` | The URL you want signers redirected to after they successfully sign. | |
diff --git a/docs/WarningResponse.md b/docs/WarningResponse.md
index b041bb3..50cad9b 100644
--- a/docs/WarningResponse.md
+++ b/docs/WarningResponse.md
@@ -6,8 +6,8 @@ A list of warnings.
## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
+| Name | Type | Description | Notes |
+|------------ | ------------- | ------------- | -------------|
| `warningMsg`*_required_ | ```String``` | Warning message | |
| `warningName`*_required_ | ```String``` | Warning name | |
diff --git a/examples/FaxLineAddUser.java b/examples/FaxLineAddUser.java
new file mode 100644
index 0000000..34e455d
--- /dev/null
+++ b/examples/FaxLineAddUser.java
@@ -0,0 +1,30 @@
+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/FaxLineAreaCodeGet.java b/examples/FaxLineAreaCodeGet.java
new file mode 100644
index 0000000..1df071a
--- /dev/null
+++ b/examples/FaxLineAreaCodeGet.java
@@ -0,0 +1,26 @@
+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/FaxLineCreate.java b/examples/FaxLineCreate.java
new file mode 100644
index 0000000..fca1018
--- /dev/null
+++ b/examples/FaxLineCreate.java
@@ -0,0 +1,30 @@
+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/FaxLineDelete.java b/examples/FaxLineDelete.java
new file mode 100644
index 0000000..6b989d2
--- /dev/null
+++ b/examples/FaxLineDelete.java
@@ -0,0 +1,28 @@
+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/FaxLineGet.java b/examples/FaxLineGet.java
new file mode 100644
index 0000000..69281b3
--- /dev/null
+++ b/examples/FaxLineGet.java
@@ -0,0 +1,26 @@
+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/FaxLineList.java b/examples/FaxLineList.java
new file mode 100644
index 0000000..df1d0bd
--- /dev/null
+++ b/examples/FaxLineList.java
@@ -0,0 +1,26 @@
+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/FaxLineRemoveUser.java b/examples/FaxLineRemoveUser.java
new file mode 100644
index 0000000..7864b05
--- /dev/null
+++ b/examples/FaxLineRemoveUser.java
@@ -0,0 +1,30 @@
+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/gradle.properties b/gradle.properties
index 77ba83c..53d9dbe 100644
--- a/gradle.properties
+++ b/gradle.properties
@@ -6,7 +6,7 @@
#target = android
GROUP=com.dropbox.sign
POM_ARTIFACT_ID=dropbox-sign
-VERSION_NAME=1.5.0
+VERSION_NAME=1.6.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/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
index 7454180..e644113 100644
Binary files a/gradle/wrapper/gradle-wrapper.jar and b/gradle/wrapper/gradle-wrapper.jar differ
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
index 774fae8..5c6f89d 100644
--- a/gradle/wrapper/gradle-wrapper.properties
+++ b/gradle/wrapper/gradle-wrapper.properties
@@ -1,5 +1,7 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
index 005bcde..9d0ce63 100755
--- a/gradlew
+++ b/gradlew
@@ -55,7 +55,7 @@
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
-# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
@@ -69,37 +69,35 @@ app_path=$0
# Need this for daisy-chained symlinks.
while
- APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
- [ -h "$app_path" ]
+APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
+[ -h "$app_path" ]
do
- ls=$( ls -ld "$app_path" )
- link=${ls#*' -> '}
- case $link in #(
- /*) app_path=$link ;; #(
- *) app_path=$APP_HOME$link ;;
- esac
+ls=$( ls -ld "$app_path" )
+link=${ls#*' -> '}
+case $link in #(
+/*) app_path=$link ;; #(
+*) app_path=$APP_HOME$link ;;
+esac
done
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
-
-APP_NAME="Gradle"
+# This is normally unused
+# shellcheck disable=SC2034
APP_BASE_NAME=${0##*/}
-
-# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m"'
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD=maximum
warn () {
- echo "$*"
+echo "$*"
} >&2
die () {
- echo
- echo "$*"
- echo
- exit 1
+echo
+echo "$*"
+echo
+exit 1
} >&2
# OS specific support (must be 'true' or 'false').
@@ -108,10 +106,10 @@ msys=false
darwin=false
nonstop=false
case "$( uname )" in #(
- CYGWIN* ) cygwin=true ;; #(
- Darwin* ) darwin=true ;; #(
- MSYS* | MINGW* ) msys=true ;; #(
- NONSTOP* ) nonstop=true ;;
+CYGWIN* ) cygwin=true ;; #(
+Darwin* ) darwin=true ;; #(
+MSYS* | MINGW* ) msys=true ;; #(
+NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
@@ -119,39 +117,46 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
# Determine the Java command to use to start the JVM.
if [ -n "$JAVA_HOME" ] ; then
- if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
- # IBM's JDK on AIX uses strange locations for the executables
- JAVACMD=$JAVA_HOME/jre/sh/java
- else
- JAVACMD=$JAVA_HOME/bin/java
- fi
- if [ ! -x "$JAVACMD" ] ; then
- die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+# IBM's JDK on AIX uses strange locations for the executables
+JAVACMD=$JAVA_HOME/jre/sh/java
+else
+JAVACMD=$JAVA_HOME/bin/java
+fi
+if [ ! -x "$JAVACMD" ] ; then
+die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
- fi
+fi
else
- JAVACMD=java
- which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+JAVACMD=java
+if ! command -v java >/dev/null 2>&1
+then
+die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
+fi
# Increase the maximum file descriptors if we can.
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
- case $MAX_FD in #(
- max*)
- MAX_FD=$( ulimit -H -n ) ||
- warn "Could not query maximum file descriptor limit"
- esac
- case $MAX_FD in #(
- '' | soft) :;; #(
- *)
- ulimit -n "$MAX_FD" ||
- warn "Could not set maximum file descriptor limit to $MAX_FD"
- esac
+case $MAX_FD in #(
+max*)
+# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+# shellcheck disable=SC2039,SC3045
+MAX_FD=$( ulimit -H -n ) ||
+warn "Could not query maximum file descriptor limit"
+esac
+case $MAX_FD in #(
+'' | soft) :;; #(
+*)
+# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+# shellcheck disable=SC2039,SC3045
+ulimit -n "$MAX_FD" ||
+warn "Could not set maximum file descriptor limit to $MAX_FD"
+esac
fi
# Collect all arguments for the java command, stacking in reverse order:
@@ -164,46 +169,56 @@ fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
- APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
- CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
-
- JAVACMD=$( cygpath --unix "$JAVACMD" )
-
- # Now convert the arguments - kludge to limit ourselves to /bin/sh
- for arg do
- if
- case $arg in #(
- -*) false ;; # don't mess with options #(
- /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
- [ -e "$t" ] ;; #(
- *) false ;;
- esac
- then
- arg=$( cygpath --path --ignore --mixed "$arg" )
- fi
- # Roll the args list around exactly as many times as the number of
- # args, so each arg winds up back in the position where it started, but
- # possibly modified.
- #
- # NB: a `for` loop captures its iteration list before it begins, so
- # changing the positional parameters here affects neither the number of
- # iterations, nor the values presented in `arg`.
- shift # remove old arg
- set -- "$@" "$arg" # push replacement arg
- done
+APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+# Now convert the arguments - kludge to limit ourselves to /bin/sh
+for arg do
+if
+case $arg in #(
+-*) false ;; # don't mess with options #(
+/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
+[ -e "$t" ] ;; #(
+*) false ;;
+esac
+then
+arg=$( cygpath --path --ignore --mixed "$arg" )
+fi
+# Roll the args list around exactly as many times as the number of
+# args, so each arg winds up back in the position where it started, but
+# possibly modified.
+#
+# NB: a `for` loop captures its iteration list before it begins, so
+# changing the positional parameters here affects neither the number of
+# iterations, nor the values presented in `arg`.
+shift # remove old arg
+set -- "$@" "$arg" # push replacement arg
+done
fi
-# Collect all arguments for the java command;
-# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-# shell script including quotes and variable substitutions, so put them in
-# double quotes to make sure that they get re-expanded; and
-# * put everything else in single quotes, so that it's not re-expanded.
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+# and any embedded shellness will be escaped.
+# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+# treated as '${Hostname}' itself on the command line.
set -- \
- "-Dorg.gradle.appname=$APP_BASE_NAME" \
- -classpath "$CLASSPATH" \
- org.gradle.wrapper.GradleWrapperMain \
- "$@"
+"-Dorg.gradle.appname=$APP_BASE_NAME" \
+-classpath "$CLASSPATH" \
+org.gradle.wrapper.GradleWrapperMain \
+"$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+die "xargs is not available"
+fi
# Use "xargs" to parse quoted args.
#
@@ -225,10 +240,10 @@ set -- \
#
eval "set -- $(
- printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
- xargs -n1 |
- sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
- tr '\n' ' '
- )" '"$@"'
+printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+xargs -n1 |
+sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+tr '\n' ' '
+)" '"$@"'
exec "$JAVACMD" "$@"
diff --git a/gradlew.bat b/gradlew.bat
index 6a68175..25da30d 100644
--- a/gradlew.bat
+++ b/gradlew.bat
@@ -14,7 +14,7 @@
@rem limitations under the License.
@rem
-@if "%DEBUG%" == "" @echo off
+@if "%DEBUG%"=="" @echo off
@rem ##########################################################################
@rem
@rem Gradle startup script for Windows
@@ -25,7 +25,8 @@
if "%OS%"=="Windows_NT" setlocal
set DIRNAME=%~dp0
-if "%DIRNAME%" == "" set DIRNAME=.
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
set APP_BASE_NAME=%~n0
set APP_HOME=%DIRNAME%
@@ -33,20 +34,20 @@ set APP_HOME=%DIRNAME%
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-set DEFAULT_JVM_OPTS=-Dfile.encoding=UTF-8 "-Xmx64m" "-Xms64m"
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
@rem Find java.exe
if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
-if "%ERRORLEVEL%" == "0" goto execute
+if %ERRORLEVEL% equ 0 goto execute
-echo.
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
goto fail
@@ -56,11 +57,11 @@ set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto execute
-echo.
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
-echo.
-echo Please set the JAVA_HOME variable in your environment to match the
-echo location of your Java installation.
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
goto fail
@@ -75,13 +76,15 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
:end
@rem End local scope for the variables with windows NT shell
-if "%ERRORLEVEL%"=="0" goto mainEnd
+if %ERRORLEVEL% equ 0 goto mainEnd
:fail
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
rem the _cmd.exe /c_ return code!
-if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
-exit /b 1
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
:mainEnd
if "%OS%"=="Windows_NT" endlocal
diff --git a/openapi-config.yaml b/openapi-config.yaml
index 459ef9c..a6ecfdc 100644
--- a/openapi-config.yaml
+++ b/openapi-config.yaml
@@ -16,7 +16,7 @@ additionalProperties:
groupId: com.dropbox.sign
artifactId: dropbox-sign
artifactName: Dropbox Sign Java SDK
- artifactVersion: "1.5.0"
+ artifactVersion: "1.6.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
@@ -24,7 +24,7 @@ additionalProperties:
scmUrl: https://github.com/hellosign/dropbox-sign-java
licenseName: MIT License
licenseUrl: https://www.opensource.org/licenses/mit-license.php
-
+ useCustomTemplateCode: true
files:
EventCallbackHelper.mustache:
templateType: SupportingFiles
diff --git a/openapi-sdk.yaml b/openapi-sdk.yaml
index 9bf5a68..c7189fd 100644
--- a/openapi-sdk.yaml
+++ b/openapi-sdk.yaml
@@ -1409,6 +1409,803 @@ paths:
seo:
title: 'Get Embedded Sign URL | iFrame | Dropbox Sign for Developers'
description: 'The Dropbox Sign API allows you to build custom integrations. To find out how to retrieve an embedded iFrame object containing a signature url, click here.'
+ /fax_line/add_user:
+ put:
+ tags:
+ - 'Fax Line'
+ summary: 'Add Fax Line User'
+ description: 'Grants a user access to the specified Fax Line.'
+ operationId: faxLineAddUser
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineAddUserRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineAddUserRequestExample'
+ 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/FaxLineResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineAddUser.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineAddUser.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineAddUser.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineAddUser.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineAddUser.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineAddUser.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineAddUser.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineAddUser.sh
+ x-meta:
+ seo:
+ title: 'Fax Line Add User | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to add a user to an existing fax line, click here.'
+ /fax_line/area_codes:
+ get:
+ 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.'
+ operationId: faxLineAreaCodeGet
+ parameters:
+ -
+ name: country
+ in: query
+ description: 'Filter area codes by country.'
+ required: true
+ schema:
+ type: string
+ enum:
+ - CA
+ - US
+ - UK
+ -
+ name: state
+ in: query
+ description: 'Filter area codes by state.'
+ schema:
+ type: string
+ 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
+ -
+ name: province
+ in: query
+ description: 'Filter area codes by province.'
+ schema:
+ type: string
+ enum:
+ - AB
+ - BC
+ - MB
+ - NB
+ - NL
+ - NT
+ - NS
+ - NU
+ - 'ON'
+ - PE
+ - QC
+ - SK
+ - YT
+ -
+ name: city
+ in: query
+ description: 'Filter area codes by city.'
+ schema:
+ type: string
+ 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/FaxLineAreaCodeGetResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineAreaCodeGetResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineAreaCodeGet.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineAreaCodeGet.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineAreaCodeGet.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineAreaCodeGet.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineAreaCodeGet.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineAreaCodeGet.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineAreaCodeGet.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineAreaCodeGet.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.'
+ /fax_line/create:
+ post:
+ tags:
+ - 'Fax Line'
+ summary: 'Purchase Fax Line'
+ description: 'Purchases a new Fax Line.'
+ operationId: faxLineCreate
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineCreateRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineCreateRequestExample'
+ 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/FaxLineResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineCreate.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineCreate.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineCreate.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineCreate.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineCreate.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineCreate.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineCreate.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineCreate.sh
+ x-meta:
+ seo:
+ title: 'Purchase Fax Line | 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.'
+ /fax_line:
+ get:
+ tags:
+ - 'Fax Line'
+ summary: 'Get Fax Line'
+ description: 'Returns the properties and settings of a Fax Line.'
+ operationId: faxLineGet
+ parameters:
+ -
+ name: number
+ in: query
+ description: 'The Fax Line number.'
+ required: true
+ schema:
+ type: string
+ 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/FaxLineResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineGet.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineGet.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineGet.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineGet.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineGet.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineGet.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineGet.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineGet.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.'
+ delete:
+ tags:
+ - 'Fax Line'
+ summary: 'Delete Fax Line'
+ description: 'Deletes the specified Fax Line from the subscription.'
+ operationId: faxLineDelete
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineDeleteRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineDeleteRequestExample'
+ 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: {}
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineDelete.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineDelete.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineDelete.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineDelete.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineDelete.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineDelete.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineDelete.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineDelete.sh
+ x-meta:
+ seo:
+ title: 'Delete Fax Line | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to delete a fax line, click here.'
+ /fax_line/list:
+ get:
+ tags:
+ - 'Fax Line'
+ summary: 'List Fax Lines'
+ description: 'Returns the properties and settings of multiple Fax Lines.'
+ operationId: faxLineList
+ parameters:
+ -
+ name: account_id
+ in: query
+ description: 'Account ID'
+ schema:
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ -
+ name: page
+ in: query
+ description: Page
+ schema:
+ type: integer
+ default: 1
+ example: 1
+ -
+ name: page_size
+ in: query
+ description: 'Page size'
+ schema:
+ type: integer
+ default: 20
+ example: 20
+ -
+ name: show_team_lines
+ in: query
+ description: 'Show team lines'
+ schema:
+ type: boolean
+ 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/FaxLineListResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineListResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineList.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineList.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineList.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineList.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineList.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineList.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineList.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineList.sh
+ x-meta:
+ seo:
+ title: 'List Fax Lines | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to list your fax lines, click here.'
+ /fax_line/remove_user:
+ put:
+ tags:
+ - 'Fax Line'
+ summary: 'Remove Fax Line Access'
+ description: 'Removes a user''s access to the specified Fax Line.'
+ operationId: faxLineRemoveUser
+ requestBody:
+ required: true
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/FaxLineRemoveUserRequest'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineRemoveUserRequestExample'
+ 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/FaxLineResponse'
+ examples:
+ default_example:
+ $ref: '#/components/examples/FaxLineResponseExample'
+ 4XX:
+ description: failed_operation
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ examples:
+ 400_example:
+ $ref: '#/components/examples/Error400ResponseExample'
+ 401_example:
+ $ref: '#/components/examples/Error401ResponseExample'
+ 402_example:
+ $ref: '#/components/examples/Error402ResponseExample'
+ 403_example:
+ $ref: '#/components/examples/Error403ResponseExample'
+ 404_example:
+ $ref: '#/components/examples/Error404ResponseExample'
+ 4XX_example:
+ $ref: '#/components/examples/Error4XXResponseExample'
+ security:
+ -
+ api_key: []
+ x-codeSamples:
+ -
+ lang: PHP
+ label: PHP
+ source:
+ $ref: examples/FaxLineRemoveUser.php
+ -
+ lang: 'C#'
+ label: 'C#'
+ source:
+ $ref: examples/FaxLineRemoveUser.cs
+ -
+ lang: JavaScript
+ label: JavaScript
+ source:
+ $ref: examples/FaxLineRemoveUser.js
+ -
+ lang: TypeScript
+ label: TypeScript
+ source:
+ $ref: examples/FaxLineRemoveUser.ts
+ -
+ lang: Java
+ label: Java
+ source:
+ $ref: examples/FaxLineRemoveUser.java
+ -
+ lang: Ruby
+ label: Ruby
+ source:
+ $ref: examples/FaxLineRemoveUser.rb
+ -
+ lang: Python
+ label: Python
+ source:
+ $ref: examples/FaxLineRemoveUser.py
+ -
+ lang: cURL
+ label: cURL
+ source:
+ $ref: examples/FaxLineRemoveUser.sh
+ x-meta:
+ seo:
+ title: 'Fax Line Remove User | API Documentation | Dropbox Fax for Developers'
+ description: 'The Dropbox Fax API allows you to build custom integrations. To find out how to remove a user from an existing fax line, click here.'
/oauth/token:
post:
tags:
@@ -6409,6 +7206,145 @@ components:
type: boolean
default: false
type: object
+ FaxLineAddUserRequest:
+ required:
+ - number
+ properties:
+ number:
+ description: 'The Fax Line number.'
+ type: string
+ account_id:
+ description: 'Account ID'
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ email_address:
+ description: 'Email address'
+ type: string
+ format: email
+ type: object
+ FaxLineAreaCodeGetStateEnum:
+ type: string
+ 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
+ FaxLineAreaCodeGetProvinceEnum:
+ type: string
+ enum:
+ - AB
+ - BC
+ - MB
+ - NB
+ - NL
+ - NT
+ - NS
+ - NU
+ - 'ON'
+ - PE
+ - QC
+ - SK
+ - YT
+ FaxLineAreaCodeGetCountryEnum:
+ type: string
+ enum:
+ - CA
+ - US
+ - UK
+ FaxLineCreateRequest:
+ required:
+ - area_code
+ - country
+ properties:
+ area_code:
+ description: 'Area code'
+ type: integer
+ country:
+ description: Country
+ type: string
+ enum:
+ - CA
+ - US
+ - UK
+ city:
+ description: City
+ type: string
+ account_id:
+ description: 'Account ID'
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ type: object
+ FaxLineDeleteRequest:
+ required:
+ - number
+ properties:
+ number:
+ description: 'The Fax Line number.'
+ type: string
+ type: object
+ FaxLineRemoveUserRequest:
+ required:
+ - number
+ properties:
+ number:
+ description: 'The Fax Line number.'
+ type: string
+ account_id:
+ description: 'Account ID'
+ type: string
+ example: ab55cd14a97219e36b5ff5fe23f2f9329b0c1e97
+ email_address:
+ description: 'Email address'
+ type: string
+ format: email
+ type: object
OAuthTokenGenerateRequest:
required:
- client_id
@@ -9118,6 +10054,8 @@ components:
default: false
type: object
AccountCreateResponse:
+ required:
+ - account
properties:
account:
$ref: '#/components/schemas/AccountResponse'
@@ -9131,6 +10069,8 @@ components:
type: object
x-internal-class: true
AccountGetResponse:
+ required:
+ - account
properties:
account:
$ref: '#/components/schemas/AccountResponse'
@@ -9153,6 +10093,8 @@ components:
type: object
x-internal-class: true
ApiAppGetResponse:
+ required:
+ - api_app
properties:
api_app:
$ref: '#/components/schemas/ApiAppResponse'
@@ -9164,6 +10106,9 @@ components:
type: object
x-internal-class: true
ApiAppListResponse:
+ required:
+ - api_apps
+ - list_info
properties:
api_apps:
description: 'Contains information about API Apps.'
@@ -9180,6 +10125,10 @@ components:
type: object
x-internal-class: true
BulkSendJobGetResponse:
+ required:
+ - bulk_send_job
+ - list_info
+ - signature_requests
properties:
bulk_send_job:
$ref: '#/components/schemas/BulkSendJobResponse'
@@ -9198,6 +10147,9 @@ components:
type: object
x-internal-class: true
BulkSendJobListResponse:
+ required:
+ - bulk_send_jobs
+ - list_info
properties:
bulk_send_jobs:
description: 'Contains a list of BulkSendJobs that the API caller has access to.'
@@ -9214,6 +10166,8 @@ components:
type: object
x-internal-class: true
BulkSendJobSendResponse:
+ required:
+ - bulk_send_job
properties:
bulk_send_job:
$ref: '#/components/schemas/BulkSendJobResponse'
@@ -9225,6 +10179,8 @@ components:
type: object
x-internal-class: true
EmbeddedEditUrlResponse:
+ required:
+ - embedded
properties:
embedded:
$ref: '#/components/schemas/EmbeddedEditUrlResponseEmbedded'
@@ -9236,6 +10192,8 @@ components:
type: object
x-internal-class: true
EmbeddedSignUrlResponse:
+ required:
+ - embedded
properties:
embedded:
$ref: '#/components/schemas/EmbeddedSignUrlResponseEmbedded'
@@ -9253,7 +10211,45 @@ components:
error:
$ref: '#/components/schemas/ErrorResponseError'
type: object
+ FaxLineResponse:
+ required:
+ - fax_line
+ properties:
+ fax_line:
+ $ref: '#/components/schemas/FaxLineResponseFaxLine'
+ warnings:
+ $ref: '#/components/schemas/WarningResponse'
+ type: object
+ x-internal-class: true
+ FaxLineAreaCodeGetResponse:
+ required:
+ - area_codes
+ properties:
+ area_codes:
+ type: array
+ items:
+ type: integer
+ type: object
+ x-internal-class: true
+ FaxLineListResponse:
+ required:
+ - fax_lines
+ - list_info
+ properties:
+ list_info:
+ $ref: '#/components/schemas/ListInfoResponse'
+ fax_lines:
+ type: array
+ items:
+ $ref: '#/components/schemas/FaxLineResponseFaxLine'
+ warnings:
+ $ref: '#/components/schemas/WarningResponse'
+ type: object
+ x-internal-class: true
FileResponse:
+ required:
+ - file_url
+ - expires_at
properties:
file_url:
description: 'URL to the file.'
@@ -9264,6 +10260,8 @@ components:
type: object
x-internal-class: true
FileResponseDataUri:
+ required:
+ - data_uri
properties:
data_uri:
description: 'File as base64 encoded string.'
@@ -9271,6 +10269,8 @@ components:
type: object
x-internal-class: true
ReportCreateResponse:
+ required:
+ - report
properties:
report:
$ref: '#/components/schemas/ReportResponse'
@@ -9282,6 +10282,8 @@ components:
type: object
x-internal-class: true
SignatureRequestGetResponse:
+ required:
+ - signature_request
properties:
signature_request:
$ref: '#/components/schemas/SignatureRequestResponse'
@@ -9293,6 +10295,9 @@ components:
type: object
x-internal-class: true
SignatureRequestListResponse:
+ required:
+ - signature_requests
+ - list_info
properties:
signature_requests:
description: 'Contains information about signature requests.'
@@ -9584,6 +10589,23 @@ components:
description: 'Name of the error.'
type: string
type: object
+ FaxLineResponseFaxLine:
+ properties:
+ number:
+ description: Number
+ type: string
+ created_at:
+ description: 'Created at'
+ type: integer
+ updated_at:
+ description: 'Updated at'
+ type: integer
+ accounts:
+ type: array
+ items:
+ $ref: '#/components/schemas/AccountResponse'
+ type: object
+ x-internal-class: true
ListInfoResponse:
description: 'Contains pagination information about the data returned.'
properties:
@@ -9745,6 +10767,7 @@ components:
signer:
description: 'The Signer this attachment is assigned to.'
type: string
+ x-int-or-string: true
name:
description: 'The name of this attachment.'
type: string
@@ -10374,6 +11397,7 @@ components:
description: 'The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).'
type: string
nullable: true
+ x-int-or-string: true
x:
description: 'The horizontal offset in pixels for this form field.'
type: integer
@@ -10489,6 +11513,7 @@ components:
signer:
description: 'The signer of the Form Field.'
type: string
+ x-int-or-string: true
x:
description: 'The horizontal offset in pixels for this form field.'
type: integer
@@ -11100,6 +12125,8 @@ components:
type: string
type: object
TeamGetResponse:
+ required:
+ - team
properties:
team:
$ref: '#/components/schemas/TeamResponse'
@@ -11111,6 +12138,8 @@ components:
type: object
x-internal-class: true
TeamGetInfoResponse:
+ required:
+ - team
properties:
team:
$ref: '#/components/schemas/TeamInfoResponse'
@@ -11122,6 +12151,8 @@ components:
type: object
x-internal-class: true
TeamInvitesResponse:
+ required:
+ - team_invites
properties:
team_invites:
description: 'Contains a list of team invites and their roles.'
@@ -11135,6 +12166,9 @@ components:
type: object
x-internal-class: true
TeamMembersResponse:
+ required:
+ - team_members
+ - list_info
properties:
team_members:
description: 'Contains a list of team members and their roles for a specific team.'
@@ -11150,6 +12184,9 @@ components:
type: object
x-internal-class: true
TeamSubTeamsResponse:
+ required:
+ - sub_teams
+ - list_info
properties:
sub_teams:
description: 'Contains a list with sub teams.'
@@ -11165,6 +12202,8 @@ components:
type: object
x-internal-class: true
TemplateCreateResponse:
+ required:
+ - template
properties:
template:
$ref: '#/components/schemas/TemplateCreateResponseTemplate'
@@ -11176,6 +12215,8 @@ components:
type: object
x-internal-class: true
TemplateCreateEmbeddedDraftResponse:
+ required:
+ - template
properties:
template:
$ref: '#/components/schemas/TemplateCreateEmbeddedDraftResponseTemplate'
@@ -11187,12 +12228,16 @@ components:
type: object
x-internal-class: true
TemplateEditResponse:
+ required:
+ - template_id
properties:
template_id:
description: 'The id of the Template.'
type: string
type: object
TemplateGetResponse:
+ required:
+ - template
properties:
template:
$ref: '#/components/schemas/TemplateResponse'
@@ -11204,6 +12249,9 @@ components:
type: object
x-internal-class: true
TemplateListResponse:
+ required:
+ - templates
+ - list_info
properties:
templates:
description: 'List of templates that the API caller has access to.'
@@ -11220,12 +12268,16 @@ components:
type: object
x-internal-class: true
TemplateUpdateFilesResponse:
+ required:
+ - template
properties:
template:
$ref: '#/components/schemas/TemplateUpdateFilesResponseTemplate'
type: object
x-internal-class: true
UnclaimedDraftCreateResponse:
+ required:
+ - unclaimed_draft
properties:
unclaimed_draft:
$ref: '#/components/schemas/UnclaimedDraftResponse'
@@ -11350,6 +12402,22 @@ components:
summary: 'Default Example'
value:
$ref: examples/json/EmbeddedEditUrlRequestDefaultExample.json
+ FaxLineAddUserRequestExample:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/FaxLineAddUserRequestExample.json
+ FaxLineCreateRequestExample:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/FaxLineCreateRequestExample.json
+ FaxLineDeleteRequestExample:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/FaxLineDeleteRequestExample.json
+ FaxLineRemoveUserRequestExample:
+ summary: 'Default Example'
+ value:
+ $ref: examples/json/FaxLineRemoveUserRequestExample.json
OAuthTokenGenerateRequestExample:
summary: 'OAuth Token Generate Example'
value:
@@ -11594,6 +12662,18 @@ components:
summary: 'Error 4XX failed_operation'
value:
$ref: examples/json/Error4XXResponseExample.json
+ FaxLineResponseExample:
+ summary: 'Sample Fax Line Response'
+ value:
+ $ref: examples/json/FaxLineResponseExample.json
+ FaxLineAreaCodeGetResponseExample:
+ summary: 'Sample Area Code Response'
+ value:
+ $ref: examples/json/FaxLineAreaCodeGetResponseExample.json
+ FaxLineListResponseExample:
+ summary: 'Sample Fax Line List Response'
+ value:
+ $ref: examples/json/FaxLineListResponseExample.json
ReportCreateResponseExample:
summary: Report
value:
diff --git a/pom.xml b/pom.xml
index e8b3eed..93887dd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -5,7 +5,7 @@
dropbox-signjardropbox-sign
- 1.5.0
+ 1.6.0https://github.com/hellosign/dropbox-sign-javaUse the Dropbox Sign Java SDK to connect your Java app to the service of Dropbox Sign in microseconds!
@@ -58,12 +58,12 @@
maven-surefire-plugin3.0.0-M5
-
+ loggerPathconf/log4j.properties
-
+
-Xms512m -Xmx1500mmethods10
@@ -104,7 +104,7 @@
org.apache.maven.pluginsmaven-jar-plugin
- 3.2.0
+ 3.2.2
@@ -118,7 +118,7 @@
org.codehaus.mojobuild-helper-maven-plugin
- 3.2.0
+ 3.3.0add_sources
@@ -149,7 +149,7 @@
org.apache.maven.pluginsmaven-compiler-plugin
- 3.8.1
+ 3.10.11.81.8
@@ -165,7 +165,7 @@
org.apache.maven.pluginsmaven-javadoc-plugin
- 3.3.1
+ 3.3.2attach-javadocs
@@ -250,7 +250,7 @@
org.apache.maven.pluginsmaven-gpg-plugin
- 1.5
+ 3.0.1sign-artifacts
@@ -267,12 +267,6 @@
-
- io.swagger
- swagger-annotations
- ${swagger-annotations-version}
-
-
commons-codeccommons-codec
@@ -329,11 +323,6 @@
jackson-datatype-jsr310${jackson-version}
-
- com.github.joschi.jackson
- jackson-datatype-threetenbp
- ${threetenbp-version}
- jakarta.annotationjakarta.annotation-api
@@ -347,8 +336,8 @@
- junit
- junit
+ org.junit.jupiter
+ junit-jupiter-api${junit-version}test
@@ -361,15 +350,13 @@
UTF-8
- 1.6.3
- 2.35
- 2.13.0
- 2.13.0
- 0.2.2
- 2.9.10
+ 2.37
+ 2.17.1
+ 2.17.1
+ 0.2.61.3.5
- 4.13.2
- 2.17.3
+ 5.10.0
+ 2.21.03.12.4
diff --git a/run-build b/run-build
index 82ab396..1e1cfec 100755
--- a/run-build
+++ b/run-build
@@ -1,6 +1,6 @@
#!/usr/bin/env bash
-# see https://github.com/OpenAPITools/openapi-generator/tree/v5.4.0/modules/openapi-generator/src/main/resources/Java
+# see https://github.com/OpenAPITools/openapi-generator/tree/v7.8.0/modules/openapi-generator/src/main/resources/Java
set -e
@@ -9,7 +9,7 @@ WORKING_DIR="/app/java"
docker run --rm \
-v "${DIR}/:/local" \
- openapitools/openapi-generator-cli:v5.3.0 generate \
+ openapitools/openapi-generator-cli:v7.8.0 generate \
-i "/local/openapi-sdk.yaml" \
-c "/local/openapi-config.yaml" \
-t "/local/templates" \
diff --git a/src/main/java/com/dropbox/sign/ApiClient.java b/src/main/java/com/dropbox/sign/ApiClient.java
index 635c863..09041f2 100644
--- a/src/main/java/com/dropbox/sign/ApiClient.java
+++ b/src/main/java/com/dropbox/sign/ApiClient.java
@@ -1,3 +1,16 @@
+/*
+ * 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;
import javax.ws.rs.client.Client;
@@ -35,6 +48,7 @@
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import org.glassfish.jersey.logging.LoggingFeature;
+import java.util.AbstractMap.SimpleEntry;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.Collection;
@@ -42,12 +56,15 @@
import java.util.Map;
import java.util.Map.Entry;
import java.util.HashMap;
-import java.util.HashSet;
+import java.util.LinkedHashMap;
+import java.util.LinkedHashSet;
import java.util.List;
import java.util.Arrays;
import java.util.ArrayList;
import java.util.Date;
-import org.threeten.bp.OffsetDateTime;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+import java.time.OffsetDateTime;
import java.net.URLEncoder;
@@ -62,47 +79,53 @@
import com.dropbox.sign.auth.HttpBasicAuth;
import com.dropbox.sign.auth.HttpBearerAuth;
import com.dropbox.sign.auth.ApiKeyAuth;
-
import com.dropbox.sign.model.ErrorResponse;
/**
*
ApiClient class.
*/
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.8.0")
public class ApiClient extends JavaTimeFormatter {
- protected Map defaultHeaderMap = new HashMap();
- protected Map defaultCookieMap = new HashMap();
+ private static final Pattern JSON_MIME_PATTERN = Pattern.compile("(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$");
+
+ protected Map defaultHeaderMap = new HashMap<>();
+ protected Map defaultCookieMap = new HashMap<>();
protected String basePath = "https://api.hellosign.com/v3";
protected String userAgent;
private static final Logger log = Logger.getLogger(ApiClient.class.getName());
- protected List servers = new ArrayList(Arrays.asList(
- new ServerConfiguration(
- "https://api.hellosign.com/v3",
- "No description provided",
- new HashMap()
- )
+ protected List servers = new ArrayList<>(Arrays.asList(
+ new ServerConfiguration(
+ "https://api.hellosign.com/v3",
+ "No description provided",
+ new LinkedHashMap<>()
+ )
));
protected Integer serverIndex = 0;
protected Map serverVariables = null;
- protected Map> operationServers = new HashMap>() {{
- put("OAuthApi.oauthTokenGenerate", new ArrayList(Arrays.asList(
- new ServerConfiguration(
- "https://app.hellosign.com",
- "No description provided",
- new HashMap()
- )
+ protected Map> operationServers;
+
+ {
+ Map> operationServers = new HashMap<>();
+ operationServers.put("OAuthApi.oauthTokenGenerate", new ArrayList<>(Arrays.asList(
+ new ServerConfiguration(
+ "https://app.hellosign.com",
+ "No description provided",
+ new LinkedHashMap<>()
+ )
)));
- put("OAuthApi.oauthTokenRefresh", new ArrayList(Arrays.asList(
- new ServerConfiguration(
- "https://app.hellosign.com",
- "No description provided",
- new HashMap()
- )
+ operationServers.put("OAuthApi.oauthTokenRefresh", new ArrayList<>(Arrays.asList(
+ new ServerConfiguration(
+ "https://app.hellosign.com",
+ "No description provided",
+ new LinkedHashMap<>()
+ )
)));
- }};
- protected Map operationServerIndex = new HashMap();
- protected Map> operationServerVariables = new HashMap>();
+ this.operationServers = operationServers;
+ }
+
+ protected Map operationServerIndex = new HashMap<>();
+ protected Map> operationServerVariables = new HashMap<>();
protected boolean debugging = false;
protected ClientConfig clientConfig;
protected int connectionTimeout = 0;
@@ -136,10 +159,10 @@ public ApiClient(Map authMap) {
this.dateFormat = new RFC3339DateFormat();
// Set default User-Agent.
- setUserAgent("OpenAPI-Generator/1.5.0/java");
+ setUserAgent("OpenAPI-Generator/1.6.0/java");
// Setup authentications (key: authentication name, value: authentication).
- authentications = new HashMap();
+ authentications = new HashMap<>();
Authentication auth = null;
if (authMap != null) {
auth = authMap.get("api_key");
@@ -161,7 +184,7 @@ public ApiClient(Map authMap) {
authentications = Collections.unmodifiableMap(authentications);
// Setup authentication lookup (key: authentication alias, value: authentication name)
- authenticationLookup = new HashMap();
+ authenticationLookup = new HashMap<>();
}
/**
@@ -186,7 +209,7 @@ public Client getHttpClient() {
*
Setter for the field httpClient.
*
* @param httpClient a {@link javax.ws.rs.client.Client} object.
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setHttpClient(Client httpClient) {
this.httpClient = httpClient;
@@ -206,7 +229,7 @@ public String getBasePath() {
* Sets the base URL to the location where the OpenAPI document is being served.
*
* @param basePath The base URL to the target host.
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setBasePath(String basePath) {
this.basePath = basePath;
@@ -226,7 +249,7 @@ public List getServers() {
*
Setter for the field servers.
*
* @param servers a {@link java.util.List} of servers.
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setServers(List servers) {
this.servers = servers;
@@ -247,7 +270,7 @@ public Integer getServerIndex() {
*
Setter for the field serverIndex.
*
* @param serverIndex the server index
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setServerIndex(Integer serverIndex) {
this.serverIndex = serverIndex;
@@ -268,7 +291,7 @@ public Map getServerVariables() {
*
Setter for the field serverVariables.
*
* @param serverVariables a {@link java.util.Map} of server variables.
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setServerVariables(Map serverVariables) {
this.serverVariables = serverVariables;
@@ -305,7 +328,7 @@ public Authentication getAuthentication(String authName) {
* Helper method to set username for the first HTTP basic authentication.
*
* @param username Username
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setUsername(String username) {
for (Authentication auth : authentications.values()) {
@@ -321,7 +344,7 @@ public ApiClient setUsername(String username) {
* Helper method to set password for the first HTTP basic authentication.
*
* @param password Password
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setPassword(String password) {
for (Authentication auth : authentications.values()) {
@@ -337,7 +360,7 @@ public ApiClient setPassword(String password) {
* Helper method to set API key value for the first API key authentication.
*
* @param apiKey API key
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setApiKey(String apiKey) {
for (Authentication auth : authentications.values()) {
@@ -352,11 +375,12 @@ public ApiClient setApiKey(String apiKey) {
throw new RuntimeException("No API key authentication configured!");
}
+
/**
* Helper method to set bearer token for the first Bearer authentication.
*
* @param bearerToken Bearer token
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setBearerToken(String bearerToken) {
for (Authentication auth : authentications.values()) {
@@ -372,7 +396,7 @@ public ApiClient setBearerToken(String bearerToken) {
* Set the User-Agent header's value (by adding to the default header map).
*
* @param userAgent Http user agent
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setUserAgent(String userAgent) {
this.userAgent = userAgent;
@@ -394,7 +418,7 @@ public String getUserAgent(){
*
* @param key The header's key
* @param value The header's value
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient addDefaultHeader(String key, String value) {
defaultHeaderMap.put(key, value);
@@ -406,7 +430,7 @@ public ApiClient addDefaultHeader(String key, String value) {
*
* @param key The cookie's key
* @param value The cookie's value
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient addDefaultCookie(String key, String value) {
defaultCookieMap.put(key, value);
@@ -426,7 +450,7 @@ public ClientConfig getClientConfig() {
* Set the client config.
*
* @param clientConfig Set the client config
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setClientConfig(ClientConfig clientConfig) {
this.clientConfig = clientConfig;
@@ -448,7 +472,7 @@ public boolean isDebugging() {
* Enable/disable debugging for this API client.
*
* @param debugging To enable (true) or disable (false) debugging
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setDebugging(boolean debugging) {
this.debugging = debugging;
@@ -472,7 +496,7 @@ public String getTempFolderPath() {
* Set temp folder path
*
* @param tempFolderPath Temp folder path
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setTempFolderPath(String tempFolderPath) {
this.tempFolderPath = tempFolderPath;
@@ -494,7 +518,7 @@ public int getConnectTimeout() {
* {@link Integer#MAX_VALUE}.
*
* @param connectionTimeout Connection timeout in milliseconds
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setConnectTimeout(int connectionTimeout) {
this.connectionTimeout = connectionTimeout;
@@ -517,7 +541,7 @@ public int getReadTimeout() {
* {@link Integer#MAX_VALUE}.
*
* @param readTimeout Read timeout in milliseconds
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setReadTimeout(int readTimeout) {
this.readTimeout = readTimeout;
@@ -538,7 +562,7 @@ public DateFormat getDateFormat() {
* Set the date format used to parse/format date parameters.
*
* @param dateFormat Date format
- * @return a {@link com.dropbox.sign.ApiClient} object.
+ * @return a {@link ApiClient} object.
*/
public ApiClient setDateFormat(DateFormat dateFormat) {
this.dateFormat = dateFormat;
@@ -584,9 +608,9 @@ public String parameterToString(Object param) {
return formatDate((Date) param);
} else if (param instanceof OffsetDateTime) {
return formatOffsetDateTime((OffsetDateTime) param);
- } else if (param instanceof Collection) {
+ } else if (param instanceof Collection) {
StringBuilder b = new StringBuilder();
- for(Object o : (Collection)param) {
+ for(Object o : (Collection)param) {
if(b.length() > 0) {
b.append(',');
}
@@ -607,14 +631,14 @@ public String parameterToString(Object param) {
* @return List of pairs
*/
public List parameterToPairs(String collectionFormat, String name, Object value){
- List params = new ArrayList();
+ List params = new ArrayList<>();
// preconditions
if (name == null || name.isEmpty() || value == null) return params;
- Collection valueCollection;
- if (value instanceof Collection) {
- valueCollection = (Collection) value;
+ Collection valueCollection;
+ if (value instanceof Collection) {
+ valueCollection = (Collection) value;
} else {
params.add(new Pair(name, parameterToString(value)));
return params;
@@ -666,14 +690,13 @@ public List parameterToPairs(String collectionFormat, String name, Object
* application/json; charset=UTF8
* APPLICATION/JSON
* application/vnd.company+json
- * "* / *" is also default to JSON
+ * "*{@literal /}*" is also considered JSON by this method.
*
* @param mime MIME
* @return True if the MIME type is JSON
*/
public boolean isJsonMime(String mime) {
- String jsonMime = "(?i)^(application/json|[^;/ \t]+/[^;/ \t]+[+]json)[ \t]*(;.*)?$";
- return mime != null && (mime.matches(jsonMime) || mime.equals("*/*"));
+ return mime != null && (mime.equals("*/*") || JSON_MIME_PATTERN.matcher(mime).matches());
}
/**
@@ -685,8 +708,8 @@ public boolean isJsonMime(String mime) {
* @return The Accept header to use. If the given array is empty,
* null will be returned (not to set the Accept header explicitly).
*/
- public String selectHeaderAccept(String[] accepts) {
- if (accepts.length == 0) {
+ public String selectHeaderAccept(String... accepts) {
+ if (accepts == null || accepts.length == 0) {
return null;
}
for (String accept : accepts) {
@@ -706,8 +729,8 @@ public String selectHeaderAccept(String[] accepts) {
* @return The Content-Type header to use. If the given array is empty,
* JSON will be used.
*/
- public String selectHeaderContentType(String[] contentTypes) {
- if (contentTypes.length == 0) {
+ public String selectHeaderContentType(String... contentTypes) {
+ if (contentTypes == null || contentTypes.length == 0) {
return "application/json";
}
for (String contentType : contentTypes) {
@@ -751,7 +774,17 @@ public Entity serialize(Object obj, Map formParams, String co
File file = (File) param.getValue();
FormDataContentDisposition contentDisp = FormDataContentDisposition.name(param.getKey())
.fileName(file.getName()).size(file.length()).build();
- multiPart.bodyPart(new FormDataBodyPart(contentDisp, file, MediaType.APPLICATION_OCTET_STREAM_TYPE));
+
+ // 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(param.getKey()).build();
multiPart.bodyPart(new FormDataBodyPart(contentDisp, parameterToString(param.getValue())));
@@ -845,11 +878,6 @@ public T deserialize(Response response, GenericType returnType) throws Ap
return file;
}
- String contentType = null;
- List