dropbox-sign 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3cb41913278d9c7c079a351cd4d65e136ed0fdbd666b9a20d3849a9c0a055df
-  data.tar.gz: d8bf984f6fcf37534a384f3aac7f84c79bf869b17153cbde84e0691f295fff62
+  metadata.gz: e4a4bf5fa059cb4f6ad1d44989afda4fe6cda83bea9692a2e73d50e8f0f8dc6c
+  data.tar.gz: 6c6765e5adf2e5b4734ef7d5bed6d7fe329b20881b9b9df484b0e9594dae4bfd
 SHA512:
-  metadata.gz: a4bbe3ea8f55471f3cfb28fdde518cf07e624877dc5fdb8248984e453ba735bddd0322a0510315a59be10c751a5e33bfbd92de5f8fa6b6e00ff211476b977491
-  data.tar.gz: a2eb4aa246b94d4002d18ff3910a754db5f89c048d2ec461179164895f78c243ca27d8a023ee6d2540642525c4097fb1755b50ac0e374cafe0b144097b151825
+  metadata.gz: 7bdad2bf4c2d5e4d9d72e53d64c785140fc0e7fc4addb2187ccacb9795b29b2b1d7d6508a0fe4df705bb491dea7ce9547195490ab71a87f3315993965248f63d
+  data.tar.gz: 26eaf172fb40a46bee4531e40fba88c35dce1a2326bab42efc5bc47b96a83ce24c98d71971ec47ee99a020410e04f25a0d0246b27408c3e162e32616625bd19a

data/Gemfile.lock

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

data/README.md

@@ -25,7 +25,7 @@ directory that corresponds to the file you want updated.
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 3.0.0
-- Package version: 1.6.1
+- Package version: 1.7.0
 - Generator version: 7.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -47,15 +47,15 @@ gem build dropbox-sign.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.6.1.gem
+gem install ./dropbox-sign-1.7.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.6.1.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dropbox-sign-1.7.0.gem` to install the development dependencies)
 
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.6.1'
+    gem 'dropbox-sign', '~> 1.7.0'
 
 ### Install from Git
 
@@ -121,6 +121,11 @@ All URIs are relative to *https://api.hellosign.com/v3*
 |*Dropbox::Sign::BulkSendJobApi* | [**bulk_send_job_list**](docs/BulkSendJobApi.md#bulk_send_job_list) | **GET** /bulk_send_job/list | List Bulk Send Jobs |
 |*Dropbox::Sign::EmbeddedApi* | [**embedded_edit_url**](docs/EmbeddedApi.md#embedded_edit_url) | **POST** /embedded/edit_url/{template_id} | Get Embedded Template Edit URL |
 |*Dropbox::Sign::EmbeddedApi* | [**embedded_sign_url**](docs/EmbeddedApi.md#embedded_sign_url) | **GET** /embedded/sign_url/{signature_id} | Get Embedded Sign URL |
+|*Dropbox::Sign::FaxApi* | [**fax_delete**](docs/FaxApi.md#fax_delete) | **DELETE** /fax/{fax_id} | Delete Fax |
+|*Dropbox::Sign::FaxApi* | [**fax_files**](docs/FaxApi.md#fax_files) | **GET** /fax/files/{fax_id} | List Fax Files |
+|*Dropbox::Sign::FaxApi* | [**fax_get**](docs/FaxApi.md#fax_get) | **GET** /fax/{fax_id} | Get Fax |
+|*Dropbox::Sign::FaxApi* | [**fax_list**](docs/FaxApi.md#fax_list) | **GET** /fax/list | Lists Faxes |
+|*Dropbox::Sign::FaxApi* | [**fax_send**](docs/FaxApi.md#fax_send) | **POST** /fax/send | Send Fax |
 |*Dropbox::Sign::FaxLineApi* | [**fax_line_add_user**](docs/FaxLineApi.md#fax_line_add_user) | **PUT** /fax_line/add_user | Add Fax Line User |
 |*Dropbox::Sign::FaxLineApi* | [**fax_line_area_code_get**](docs/FaxLineApi.md#fax_line_area_code_get) | **GET** /fax_line/area_codes | Get Available Fax Line Area Codes |
 |*Dropbox::Sign::FaxLineApi* | [**fax_line_create**](docs/FaxLineApi.md#fax_line_create) | **POST** /fax_line/create | Purchase Fax Line |
@@ -158,7 +163,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
 |*Dropbox::Sign::TeamApi* | [**team_sub_teams**](docs/TeamApi.md#team_sub_teams) | **GET** /team/sub_teams/{team_id} | List Sub Teams |
 |*Dropbox::Sign::TeamApi* | [**team_update**](docs/TeamApi.md#team_update) | **PUT** /team | Update Team |
 |*Dropbox::Sign::TemplateApi* | [**template_add_user**](docs/TemplateApi.md#template_add_user) | **POST** /template/add_user/{template_id} | Add User to Template |
-|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create  Template |
+|*Dropbox::Sign::TemplateApi* | [**template_create**](docs/TemplateApi.md#template_create) | **POST** /template/create | Create Template |
 |*Dropbox::Sign::TemplateApi* | [**template_create_embedded_draft**](docs/TemplateApi.md#template_create_embedded_draft) | **POST** /template/create_embedded_draft | Create Embedded Template Draft |
 |*Dropbox::Sign::TemplateApi* | [**template_delete**](docs/TemplateApi.md#template_delete) | **POST** /template/delete/{template_id} | Delete Template |
 |*Dropbox::Sign::TemplateApi* | [**template_files**](docs/TemplateApi.md#template_files) | **GET** /template/files/{template_id} | Get Template Files |
@@ -210,6 +215,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
  - [Dropbox::Sign::EventCallbackRequest](docs/EventCallbackRequest.md)
  - [Dropbox::Sign::EventCallbackRequestEvent](docs/EventCallbackRequestEvent.md)
  - [Dropbox::Sign::EventCallbackRequestEventMetadata](docs/EventCallbackRequestEventMetadata.md)
+ - [Dropbox::Sign::FaxGetResponse](docs/FaxGetResponse.md)
  - [Dropbox::Sign::FaxLineAddUserRequest](docs/FaxLineAddUserRequest.md)
  - [Dropbox::Sign::FaxLineAreaCodeGetCountryEnum](docs/FaxLineAreaCodeGetCountryEnum.md)
  - [Dropbox::Sign::FaxLineAreaCodeGetProvinceEnum](docs/FaxLineAreaCodeGetProvinceEnum.md)
@@ -221,6 +227,10 @@ All URIs are relative to *https://api.hellosign.com/v3*
  - [Dropbox::Sign::FaxLineRemoveUserRequest](docs/FaxLineRemoveUserRequest.md)
  - [Dropbox::Sign::FaxLineResponse](docs/FaxLineResponse.md)
  - [Dropbox::Sign::FaxLineResponseFaxLine](docs/FaxLineResponseFaxLine.md)
+ - [Dropbox::Sign::FaxListResponse](docs/FaxListResponse.md)
+ - [Dropbox::Sign::FaxResponse](docs/FaxResponse.md)
+ - [Dropbox::Sign::FaxResponseTransmission](docs/FaxResponseTransmission.md)
+ - [Dropbox::Sign::FaxSendRequest](docs/FaxSendRequest.md)
  - [Dropbox::Sign::FileResponse](docs/FileResponse.md)
  - [Dropbox::Sign::FileResponseDataUri](docs/FileResponseDataUri.md)
  - [Dropbox::Sign::ListInfoResponse](docs/ListInfoResponse.md)

data/VERSION

@@ -1 +1 @@
-1.6.1
+1.7.0

data/docs/AccountResponseQuotas.md

@@ -10,6 +10,6 @@ Details concerning remaining monthly quotas.
 | `documents_left` | ```Integer``` |  Signature requests remaining.  |  |
 | `templates_total` | ```Integer``` |  Total API templates allowed.  |  |
 | `templates_left` | ```Integer``` |  API templates remaining.  |  |
-| `sms_verifications_left` | ```Integer``` |  SMS verifications  remaining.  |  |
+| `sms_verifications_left` | ```Integer``` |  SMS verifications remaining.  |  |
 | `num_fax_pages_left` | ```Integer``` |  Number of fax pages left  |  |
 

data/docs/FaxApi.md

@@ -0,0 +1,364 @@
+# Dropbox::Sign::FaxApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`fax_delete`](FaxApi.md#fax_delete) | **DELETE** `/fax/{fax_id}` | Delete Fax |
+| [`fax_files`](FaxApi.md#fax_files) | **GET** `/fax/files/{fax_id}` | List Fax Files |
+| [`fax_get`](FaxApi.md#fax_get) | **GET** `/fax/{fax_id}` | Get Fax |
+| [`fax_list`](FaxApi.md#fax_list) | **GET** `/fax/list` | Lists Faxes |
+| [`fax_send`](FaxApi.md#fax_send) | **POST** `/fax/send` | Send Fax |
+
+
+## `fax_delete`
+
+> `fax_delete(fax_id)`
+
+Delete Fax
+
+Deletes the specified Fax from the system.
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+begin
+  fax_api.fax_delete("fa5c8a0b0f492d768749333ad6fcc214c111e967")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `fax_delete_with_http_info` variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> `<Array(nil, Integer, Hash)> fax_delete_with_http_info(fax_id)`
+
+```ruby
+begin
+  # Delete Fax
+  data, status_code, headers = api_instance.fax_delete_with_http_info(fax_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling FaxApi->fax_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_id` | **String** | Fax ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `fax_files`
+
+> `File fax_files(fax_id)`
+
+List Fax Files
+
+Returns list of fax files
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+faxId = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
+
+begin
+  file_bin = fax_api.fax_files(data)
+  FileUtils.cp(file_bin.path, "path/to/file.pdf")
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `fax_files_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(File, Integer, Hash)> fax_files_with_http_info(fax_id)`
+
+```ruby
+begin
+  # List Fax Files
+  data, status_code, headers = api_instance.fax_files_with_http_info(fax_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling FaxApi->fax_files_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_id` | **String** | Fax ID |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## `fax_get`
+
+> `<FaxGetResponse> fax_get(fax_id)`
+
+Get Fax
+
+Returns information about fax
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+fax_id = "fa5c8a0b0f492d768749333ad6fcc214c111e967"
+
+begin
+  result = fax_api.fax_get(fax_id)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `fax_get_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<FaxGetResponse>, Integer, Hash)> fax_get_with_http_info(fax_id)`
+
+```ruby
+begin
+  # Get Fax
+  data, status_code, headers = api_instance.fax_get_with_http_info(fax_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FaxGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling FaxApi->fax_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_id` | **String** | Fax ID |  |
+
+### Return type
+
+[**FaxGetResponse**](FaxGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `fax_list`
+
+> `<FaxListResponse> fax_list(opts)`
+
+Lists Faxes
+
+Returns properties of multiple faxes
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+page = 1
+page_size = 2
+
+begin
+  result = fax_api.fax_list({ page: page, page_size: page_size })
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `fax_list_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<FaxListResponse>, Integer, Hash)> fax_list_with_http_info(opts)`
+
+```ruby
+begin
+  # Lists Faxes
+  data, status_code, headers = api_instance.fax_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FaxListResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling FaxApi->fax_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `page` | **Integer** | Page | [optional][default to 1] |
+| `page_size` | **Integer** | Page size | [optional][default to 20] |
+
+### Return type
+
+[**FaxListResponse**](FaxListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `fax_send`
+
+> `<FaxGetResponse> fax_send(fax_send_request)`
+
+Send Fax
+
+Action to prepare and send a fax
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+end
+
+fax_api = Dropbox::Sign::FaxApi.new
+
+data = Dropbox::Sign::FaxSendRequest.new
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.test_mode = true
+data.recipient = "16690000001"
+data.sender = "16690000000"
+data.cover_page_to = "Jill Fax"
+data.cover_page_message = "I'm sending you a fax!"
+data.cover_page_from = "Faxer Faxerson"
+data.title = "This is what the fax is about!"
+
+begin
+  result = fax_api.fax_send(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `fax_send_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<FaxGetResponse>, Integer, Hash)> fax_send_with_http_info(fax_send_request)`
+
+```ruby
+begin
+  # Send Fax
+  data, status_code, headers = api_instance.fax_send_with_http_info(fax_send_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FaxGetResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling FaxApi->fax_send_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_send_request` | [**FaxSendRequest**](FaxSendRequest.md) |  |  |
+
+### Return type
+
+[**FaxGetResponse**](FaxGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+

data/docs/FaxGetResponse.md

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

data/docs/FaxListResponse.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::FaxListResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `faxes`<sup>*_required_</sup> | [```Array<FaxResponse>```](FaxResponse.md) |    |  |
+| `list_info`<sup>*_required_</sup> | [```ListInfoResponse```](ListInfoResponse.md) |    |  |
+

data/docs/FaxResponse.md

@@ -0,0 +1,19 @@
+# Dropbox::Sign::FaxResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `fax_id`<sup>*_required_</sup> | ```String``` |  Fax ID  |  |
+| `title`<sup>*_required_</sup> | ```String``` |  Fax Title  |  |
+| `original_title`<sup>*_required_</sup> | ```String``` |  Fax Original Title  |  |
+| `subject`<sup>*_required_</sup> | ```String``` |  Fax Subject  |  |
+| `message`<sup>*_required_</sup> | ```String``` |  Fax Message  |  |
+| `metadata`<sup>*_required_</sup> | ```Hash<String, Object>``` |  Fax Metadata  |  |
+| `created_at`<sup>*_required_</sup> | ```Integer``` |  Fax Created At Timestamp  |  |
+| `sender`<sup>*_required_</sup> | ```String``` |  Fax Sender Email  |  |
+| `transmissions`<sup>*_required_</sup> | [```Array<FaxResponseTransmission>```](FaxResponseTransmission.md) |  Fax Transmissions List  |  |
+| `files_url`<sup>*_required_</sup> | ```String``` |  Fax Files URL  |  |
+

data/docs/FaxResponseTransmission.md

@@ -0,0 +1,13 @@
+# Dropbox::Sign::FaxResponseTransmission
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `recipient`<sup>*_required_</sup> | ```String``` |  Fax Transmission Recipient  |  |
+| `sender`<sup>*_required_</sup> | ```String``` |  Fax Transmission Sender  |  |
+| `status_code`<sup>*_required_</sup> | ```String``` |  Fax Transmission Status Code  |  |
+| `sent_at` | ```Integer``` |  Fax Transmission Sent Timestamp  |  |
+

data/docs/FaxSendRequest.md

@@ -0,0 +1,18 @@
+# Dropbox::Sign::FaxSendRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `recipient`<sup>*_required_</sup> | ```String``` |  Fax Send To Recipient  |  |
+| `sender` | ```String``` |  Fax Send From Sender (used only with fax number)  |  |
+| `files` | ```Array<File>``` |  Fax File to Send  |  |
+| `file_urls` | ```Array<String>``` |  Fax File URL to Send  |  |
+| `test_mode` | ```Boolean``` |  API Test Mode Setting  |  [default to false] |
+| `cover_page_to` | ```String``` |  Fax Cover Page for Recipient  |  |
+| `cover_page_from` | ```String``` |  Fax Cover Page for Sender  |  |
+| `cover_page_message` | ```String``` |  Fax Cover Page Message  |  |
+| `title` | ```String``` |  Fax Title  |  |
+

data/docs/OAuthTokenRefreshRequest.md

@@ -8,4 +8,6 @@
 | ---- | ---- | ----------- | ----- |
 | `grant_type`<sup>*_required_</sup> | ```String``` |  When refreshing an existing token use `refresh_token`.  |  [default to 'refresh_token'] |
 | `refresh_token`<sup>*_required_</sup> | ```String``` |  The token provided when you got the expired access token.  |  |
+| `client_id` | ```String``` |  The client ID for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled.  |  |
+| `client_secret` | ```String``` |  The client secret for your API app. Mandatory from August 1st, 2025. Until then, required if the &quot;Client Credentials Required&quot; setting is enabled for token refresh; optional if disabled.  |  |
 

data/docs/SignatureRequestApi.md

@@ -249,7 +249,7 @@ end
 
 Cancel Incomplete Signature Request
 
-Cancels an incomplete signature request. This action is **not reversible**.  The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.  This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a  [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.  To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.  **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
+Cancels an incomplete signature request. This action is **not reversible**.  The request will be canceled and signers will no longer be able to sign. If they try to access the signature request they will receive a HTTP 410 status code indicating that the resource has been deleted. Cancelation is asynchronous and a successful call to this endpoint will return an empty 200 OK response if the signature request is eligible to be canceled and has been successfully queued.  This 200 OK response does not indicate a successful cancelation of the signature request itself. The cancelation is confirmed via the `signature_request_canceled` event. It is recommended that a [callback handler](/api/reference/tag/Callbacks-and-Events) be implemented to listen for the `signature_request_canceled` event. This callback will be sent only when the cancelation has completed successfully. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the [API Dashboard](https://app.hellosign.com/apidashboard) and retry the cancelation if necessary.  To be eligible for cancelation, a signature request must have been sent successfully, must not yet have been signed by all signers, and you must either be the sender or own the API app under which it was sent. A partially signed signature request can be canceled.  **NOTE:** To remove your access to a completed signature request, use the endpoint: `POST /signature_request/remove/[:signature_request_id]`.
 
 ### Examples
 

data/docs/SubWhiteLabelingOptions.md

@@ -8,19 +8,19 @@ Take a look at our [white labeling guide](https://developers.hellosign.com/api/r
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| `header_background_color` | ```String``` |    |  [default to '#1A1A1A'] |
+| `header_background_color` | ```String``` |    |  [default to '#1a1a1a'] |
 | `legal_version` | ```String``` |    |  [default to 'terms1'] |
-| `link_color` | ```String``` |    |  [default to '#00B3E6'] |
-| `page_background_color` | ```String``` |    |  [default to '#F7F8F9'] |
-| `primary_button_color` | ```String``` |    |  [default to '#00B3E6'] |
-| `primary_button_color_hover` | ```String``` |    |  [default to '#00B3E6'] |
-| `primary_button_text_color` | ```String``` |    |  [default to '#FFFFFF'] |
-| `primary_button_text_color_hover` | ```String``` |    |  [default to '#FFFFFF'] |
-| `secondary_button_color` | ```String``` |    |  [default to '#FFFFFF'] |
-| `secondary_button_color_hover` | ```String``` |    |  [default to '#FFFFFF'] |
-| `secondary_button_text_color` | ```String``` |    |  [default to '#00B3E6'] |
-| `secondary_button_text_color_hover` | ```String``` |    |  [default to '#00B3E6'] |
+| `link_color` | ```String``` |    |  [default to '#0061FE'] |
+| `page_background_color` | ```String``` |    |  [default to '#f7f8f9'] |
+| `primary_button_color` | ```String``` |    |  [default to '#0061FE'] |
+| `primary_button_color_hover` | ```String``` |    |  [default to '#0061FE'] |
+| `primary_button_text_color` | ```String``` |    |  [default to '#ffffff'] |
+| `primary_button_text_color_hover` | ```String``` |    |  [default to '#ffffff'] |
+| `secondary_button_color` | ```String``` |    |  [default to '#ffffff'] |
+| `secondary_button_color_hover` | ```String``` |    |  [default to '#ffffff'] |
+| `secondary_button_text_color` | ```String``` |    |  [default to '#0061FE'] |
+| `secondary_button_text_color_hover` | ```String``` |    |  [default to '#0061FE'] |
 | `text_color1` | ```String``` |    |  [default to '#808080'] |
-| `text_color2` | ```String``` |    |  [default to '#FFFFFF'] |
+| `text_color2` | ```String``` |    |  [default to '#ffffff'] |
 | `reset_to_default` | ```Boolean``` |  Resets white labeling options to defaults. Only useful when updating an API App.  |  |
 

data/docs/TemplateApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [`template_add_user`](TemplateApi.md#template_add_user) | **POST** `/template/add_user/{template_id}` | Add User to Template |
-| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create  Template |
+| [`template_create`](TemplateApi.md#template_create) | **POST** `/template/create` | Create Template |
 | [`template_create_embedded_draft`](TemplateApi.md#template_create_embedded_draft) | **POST** `/template/create_embedded_draft` | Create Embedded Template Draft |
 | [`template_delete`](TemplateApi.md#template_delete) | **POST** `/template/delete/{template_id}` | Delete Template |
 | [`template_files`](TemplateApi.md#template_files) | **GET** `/template/files/{template_id}` | Get Template Files |
@@ -97,7 +97,7 @@ end
 
 > `<TemplateCreateResponse> template_create(template_create_request)`
 
-Create  Template
+Create Template
 
 Creates a template that can then be used.
 
@@ -164,7 +164,7 @@ This returns an Array which contains the response data, status code and headers.
 
 ```ruby
 begin
-  # Create  Template
+  # Create Template
   data, status_code, headers = api_instance.template_create_with_http_info(template_create_request)
   p status_code # => 2xx
   p headers # => { ... }

data/docs/TemplateResponse.md

@@ -10,7 +10,7 @@ Contains information about the templates you and your team have created.
 | `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.  |  |
 | `updated_at` | ```Integer``` |  Time the template was last updated.  |  |
-| `is_embedded` | ```Boolean``` |  `true` if this template was created using an embedded flow, `false` if it was created on our website.  |  |
+| `is_embedded` | ```Boolean``` |  `true` if this template was created using an embedded flow, `false` if it was created on our website. Will be `null` when you are not the creator of the Template.  |  |
 | `is_creator` | ```Boolean``` |  `true` if you are the owner of this template, `false` if it's been shared with you by a team member.  |  |
 | `can_edit` | ```Boolean``` |  Indicates whether edit rights have been granted to you by the owner (always `true` if that's you).  |  |
 | `is_locked` | ```Boolean``` |  Indicates whether the template is locked. If `true`, then the template was created outside your quota and can only be used in `test_mode`. If `false`, then the template is within your quota and can be used to create signature requests.  |  |
@@ -21,4 +21,5 @@ Contains information about the templates you and your team have created.
 | `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) |  Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead.  |  |
 | `named_form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) |  Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c&#x3D;200&amp;path&#x3D;template/documents&amp;t&#x3D;response) array instead.  |  |
 | `accounts` | [```Array<TemplateResponseAccount>```](TemplateResponseAccount.md) |  An array of the Accounts that can use this Template.  |  |
+| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) |  Signer attachments.  |  |
 

data/docs/TemplateResponseDocumentFormFieldBase.md

@@ -15,5 +15,4 @@ An array of Form Field objects containing the name and type of each named field.
 | `width` | ```Integer``` |  The width in pixels of this form field.  |  |
 | `height` | ```Integer``` |  The height in pixels of this form field.  |  |
 | `required` | ```Boolean``` |  Boolean showing whether or not this field is required.  |  |
-| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldCheckbox.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'checkbox'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |
 

data/docs/TemplateResponseDocumentFormFieldDateSigned.md

@@ -7,4 +7,5 @@ This class extends `TemplateResponseDocumentFormFieldBase`
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  The type of this form field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentFormFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentFormFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentFormFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentFormFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentFormFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentFormFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentFormFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentFormFieldInitials`  |  [default to 'date_signed'] |
+| `group` | ```String``` |  The name of the group this field is in. If this field is not a group, this defaults to `null` except for Radio fields.  |  |