dropbox-sign 1.1.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d50bfef68b16710880777e5aae08b959a236077ef11e7cfcc46861f3876c32d
-  data.tar.gz: 5d97ce40c8374a2c0372f862ac5bc73c6d1b4a13f892c3827828a3236f417994
+  metadata.gz: 4e22a931bb4accf68d5d5405904dd73ef7f5d9d0d45b0a5fc2d025fb04c379e0
+  data.tar.gz: b0528240b0a4d2048d2b882f43fe0ba5f53bfc23ccd4447d65851c9b5185d494
 SHA512:
-  metadata.gz: b517dc4c093c0f6c1e6158631f56fc974d3dbf62ca94c2302550240bd279d3ec963e16b2667f64cdc9ecd6a4e3f05f05dc6f77625a35af3edc048bd519be9a94
-  data.tar.gz: 1ca8a8bf45466dc80833daeccbea76fc4ef4f8edc7ccff5f4849c6da1a00c676f3eafabd58d82beb6f0b99cf901f58cf6da90d53124b32ee399e14966c406de0
+  metadata.gz: 14d5a2bb0750c319f28d36ea7c45eb3433327e6325966afeb56e2796cc45e60e68b86f44a2bb5e85efb5f3b891915fe9b36fb0254dc3fd7f837e054c3477c21d
+  data.tar.gz: be4f028205e20b2e8675795855f83a20b68778d180f07b007226f103ee1b6d74b099b4027315103d3d56bcea508cb791e092fd2b7391dc516a32902944f6f51a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dropbox-sign (1.1.2)
+    dropbox-sign (1.3.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -13,7 +13,7 @@ GEM
     diff-lcs (1.5.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    ffi (1.15.5)
+    ffi (1.16.3)
     jaro_winkler (1.5.4)
     json_spec (1.1.5)
       multi_json (~> 1.0)
@@ -56,7 +56,7 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.11.0)
     stringio (3.0.1)
-    typhoeus (1.4.0)
+    typhoeus (1.4.1)
       ethon (>= 0.9.0)
     unicode-display_width (1.5.0)
 

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.1.2
+- Package version: 1.3.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -46,14 +46,14 @@ gem build dropbox-sign.gemspec
 Then install the gem locally:
 
 ```shell
-gem install ./dropbox-sign-1.1.2.gem
+gem install ./dropbox-sign-1.3.0.gem
 ```
 
-(for development, run `gem install --dev ./dropbox-sign-1.1.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./dropbox-sign-1.3.0.gem` to install the development dependencies)
 
 Finally add this to the Gemfile:
 
-    gem 'dropbox-sign', '~> 1.1.2'
+    gem 'dropbox-sign', '~> 1.3.0'
 
 ### Install from Git
 
@@ -149,6 +149,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_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 |
@@ -252,6 +253,7 @@ All URIs are relative to *https://api.hellosign.com/v3*
  - [Dropbox::Sign::SubFormFieldsPerDocumentCheckboxMerge](docs/SubFormFieldsPerDocumentCheckboxMerge.md)
  - [Dropbox::Sign::SubFormFieldsPerDocumentDateSigned](docs/SubFormFieldsPerDocumentDateSigned.md)
  - [Dropbox::Sign::SubFormFieldsPerDocumentDropdown](docs/SubFormFieldsPerDocumentDropdown.md)
+ - [Dropbox::Sign::SubFormFieldsPerDocumentFontEnum](docs/SubFormFieldsPerDocumentFontEnum.md)
  - [Dropbox::Sign::SubFormFieldsPerDocumentHyperlink](docs/SubFormFieldsPerDocumentHyperlink.md)
  - [Dropbox::Sign::SubFormFieldsPerDocumentInitials](docs/SubFormFieldsPerDocumentInitials.md)
  - [Dropbox::Sign::SubFormFieldsPerDocumentRadio](docs/SubFormFieldsPerDocumentRadio.md)
@@ -289,6 +291,9 @@ All URIs are relative to *https://api.hellosign.com/v3*
  - [Dropbox::Sign::TemplateCreateEmbeddedDraftRequest](docs/TemplateCreateEmbeddedDraftRequest.md)
  - [Dropbox::Sign::TemplateCreateEmbeddedDraftResponse](docs/TemplateCreateEmbeddedDraftResponse.md)
  - [Dropbox::Sign::TemplateCreateEmbeddedDraftResponseTemplate](docs/TemplateCreateEmbeddedDraftResponseTemplate.md)
+ - [Dropbox::Sign::TemplateCreateRequest](docs/TemplateCreateRequest.md)
+ - [Dropbox::Sign::TemplateCreateResponse](docs/TemplateCreateResponse.md)
+ - [Dropbox::Sign::TemplateCreateResponseTemplate](docs/TemplateCreateResponseTemplate.md)
  - [Dropbox::Sign::TemplateEditResponse](docs/TemplateEditResponse.md)
  - [Dropbox::Sign::TemplateGetResponse](docs/TemplateGetResponse.md)
  - [Dropbox::Sign::TemplateListResponse](docs/TemplateListResponse.md)

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.3.0

data/docs/OAuthApi.md

@@ -21,14 +21,6 @@ Once you have retrieved the code from the user callback, you will need to exchan
 ```ruby
 require "dropbox-sign"
 
-Dropbox::Sign.configure do |config|
-  # Configure HTTP basic authorization: api_key
-  config.username = "YOUR_API_KEY"
-
-  # or, configure Bearer (JWT) authorization: oauth2
-  # config.access_token = "YOUR_ACCESS_TOKEN"
-end
-
 oauth_api = Dropbox::Sign::OAuthApi.new
 
 data = Dropbox::Sign::OAuthTokenGenerateRequest.new
@@ -97,14 +89,6 @@ Access tokens are only valid for a given period of time (typically one hour) for
 ```ruby
 require "dropbox-sign"
 
-Dropbox::Sign.configure do |config|
-  # Configure HTTP basic authorization: api_key
-  config.username = "YOUR_API_KEY"
-
-  # or, configure Bearer (JWT) authorization: oauth2
-  # config.access_token = "YOUR_ACCESS_TOKEN"
-end
-
 oauth_api = Dropbox::Sign::OAuthApi.new
 
 data = Dropbox::Sign::OAuthTokenRefreshRequest.new

data/docs/SignatureRequestApi.md

@@ -651,7 +651,7 @@ end
 
 ## `signature_request_files_as_file_url`
 
-> `<FileResponse> signature_request_files_as_file_url(signature_request_id)`
+> `<FileResponse> signature_request_files_as_file_url(signature_request_id, opts)`
 
 Download Files as File Url
 
@@ -687,12 +687,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id)`
+> `<Array(<FileResponse>, Integer, Hash)> signature_request_files_as_file_url_with_http_info(signature_request_id, opts)`
 
 ```ruby
 begin
   # Download Files as File Url
-  data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id)
+  data, status_code, headers = api_instance.signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <FileResponse>
@@ -706,6 +706,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `signature_request_id` | **String** | The id of the SignatureRequest to retrieve. |  |
+| `force_download` | **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] |
 
 ### Return type
 
@@ -1305,7 +1306,7 @@ end
 
 Update Signature Request
 
-Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.  Updating the email address of a signer will generate a new `signature_id` value.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
 
 ### Examples
 

data/docs/SignatureRequestSendRequest.md

@@ -22,6 +22,7 @@
 | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) |  The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`  |  |
 | `hide_text_tags` | ```Boolean``` |  Enables automatic Text Tag removal when set to true.<br><br>**NOTE**: Removing text tags this way can cause unwanted clipping. We recommend leaving this setting on `false` and instead hiding your text tags using white text or a similar approach. See the [Text Tags Walkthrough](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) for more information.  |  [default to false] |
 | `is_qualified_signature` | ```Boolean``` |  Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
+| `is_eid` | ```Boolean``` |  Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
 | `message` | ```String``` |  The custom message in the email that will be sent to the signers.  |  |
 | `metadata` | ```Hash<String, Object>``` |  Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.  |  |
 | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |

data/docs/SignatureRequestSendWithTemplateRequest.md

@@ -15,6 +15,7 @@
 | `files` | ```Array<File>``` |  Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both.  |  |
 | `file_urls` | ```Array<String>``` |  Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both.  |  |
 | `is_qualified_signature` | ```Boolean``` |  Send with a value of `true` if you wish to enable [Qualified Electronic Signatures](https://www.hellosign.com/features/qualified-electronic-signatures) (QES), which requires a face-to-face call to verify the signer&#39;s identity.&lt;br&gt;<br>**Note**: QES is only available on the Premium API plan as an add-on purchase. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
+| `is_eid` | ```Boolean``` |  Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.  |  [default to false] |
 | `message` | ```String``` |  The custom message in the email that will be sent to the signers.  |  |
 | `metadata` | ```Hash<String, Object>``` |  Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.  |  |
 | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |

data/docs/SignatureRequestUpdateRequest.md

@@ -7,7 +7,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `signature_id`<sup>*_required_</sup> | ```String``` |  The signature ID for the recipient.  |  |
-| `email_address` | ```String``` |  The new email address for the recipient.<br><br>**NOTE**: Optional if `name` is provided.  |  |
+| `email_address` | ```String``` |  The new email address for the recipient.<br><br>This will generate a new `signature_id` value.<br><br>**NOTE**: Optional if `name` is provided.  |  |
 | `name` | ```String``` |  The new name for the recipient.<br><br>**NOTE**: Optional if `email_address` is provided.  |  |
 | `expires_at` | ```Integer``` |  The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.  |  |
 

data/docs/SubFormFieldsPerDocumentBase.md

@@ -23,7 +23,7 @@ The fields that should appear on the document, expressed as an array of objects.
 | `api_id`<sup>*_required_</sup> | ```String``` |  An identifier for the field that is unique across all documents in the request.  |  |
 | `height`<sup>*_required_</sup> | ```Integer``` |  Size of the field in pixels.  |  |
 | `required`<sup>*_required_</sup> | ```Boolean``` |  Whether this field is required.  |  |
-| `signer`<sup>*_required_</sup> | ```String``` |  Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.  |  |
+| `signer`<sup>*_required_</sup> | ```String``` |  Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE**: To set the value of the field as the preparer you must set this to `me_now`<br><br>**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.  |  |
 | `type`<sup>*_required_</sup> | ```String``` |    |  |
 | `width`<sup>*_required_</sup> | ```Integer``` |  Size of the field in pixels.  |  |
 | `x`<sup>*_required_</sup> | ```Integer``` |  Location coordinates of the field in pixels.  |  |

data/docs/SubFormFieldsPerDocumentDateSigned.md

@@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  A date. Use the `SubFormFieldsPerDocumentDateSigned` class.  |  [default to 'date_signed'] |
+| `font_family` | ```String``` |  Font family for the field.  |  |
+| `font_size` | ```Integer``` |  The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.  |  |
 

data/docs/SubFormFieldsPerDocumentDropdown.md

@@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
 | `type`<sup>*_required_</sup> | ```String``` |  An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.  |  [default to 'dropdown'] |
 | `options`<sup>*_required_</sup> | ```Array<String>``` |  Array of string values representing dropdown values.  |  |
 | `content` | ```String``` |  Selected value in `options` array. Value must exist in array.  |  |
+| `font_family` | ```String``` |  Font family for the field.  |  |
+| `font_size` | ```Integer``` |  The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.  |  |
 

data/docs/SubFormFieldsPerDocumentFontEnum.md

@@ -0,0 +1,9 @@
+# Dropbox::Sign::SubFormFieldsPerDocumentFontEnum
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/SubFormFieldsPerDocumentHyperlink.md

@@ -9,4 +9,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
 | `type`<sup>*_required_</sup> | ```String``` |  A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.  |  [default to 'hyperlink'] |
 | `content`<sup>*_required_</sup> | ```String``` |  Link Text.  |  |
 | `content_url`<sup>*_required_</sup> | ```String``` |  Link URL.  |  |
+| `font_family` | ```String``` |  Font family for the field.  |  |
+| `font_size` | ```Integer``` |  The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.  |  |
 

data/docs/SubFormFieldsPerDocumentText.md

@@ -14,4 +14,7 @@ This class extends `SubFormFieldsPerDocumentBase`.
 | `validation_type` | ```String``` |  Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value.  |  |
 | `validation_custom_regex` | ```String``` |    |  |
 | `validation_custom_regex_format_label` | ```String``` |    |  |
+| `content` | ```String``` |  Content of a `me_now` text field  |  |
+| `font_family` | ```String``` |  Font family for the field.  |  |
+| `font_size` | ```Integer``` |  The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.  |  |
 

data/docs/SubFormFieldsPerDocumentTextMerge.md

@@ -7,4 +7,6 @@ This class extends `SubFormFieldsPerDocumentBase`.
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `type`<sup>*_required_</sup> | ```String``` |  A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.  |  [default to 'text-merge'] |
+| `font_family` | ```String``` |  Font family for the field.  |  |
+| `font_size` | ```Integer``` |  The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.  |  |
 

data/docs/SubWhiteLabelingOptions.md

@@ -2,7 +2,7 @@
 
 An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans)
 
-Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
+Take a look at our [white labeling guide](https://developers.hellosign.com/api/reference/premium-branding/) to learn more.
 
 ## Properties
 

data/docs/TemplateApi.md

@@ -5,6 +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_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 |
@@ -92,6 +93,107 @@ end
 - **Accept**: application/json
 
 
+## `template_create`
+
+> `<TemplateCreateResponse> template_create(template_create_request)`
+
+Create  Template
+
+Creates a template that can then be used.
+
+### Examples
+
+```ruby
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+role_1 = Dropbox::Sign::SubTemplateRole.new
+role_1.name = "Client"
+role_1.order = 0
+
+role_2 = Dropbox::Sign::SubTemplateRole.new
+role_2.name = "Witness"
+role_2.order = 1
+
+merge_field_1 = Dropbox::Sign::SubMergeField.new
+merge_field_1.name = "Full Name"
+merge_field_1.type = "text"
+
+merge_field_2 = Dropbox::Sign::SubMergeField.new
+merge_field_2.name = "Is Registered?"
+merge_field_2.type = "checkbox"
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = Dropbox::Sign::TemplateCreateRequest.new
+data.client_id = "37dee8d8440c66d54cfa05d92c160882"
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.title = "Test Template"
+data.subject = "Please sign this document"
+data.message = "For your approval"
+data.signer_roles = [role_1, role_2]
+data.cc_roles = ["Manager"]
+data.merge_fields = [merge_field_1, merge_field_2]
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = template_api.template_create(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end
+
+```
+
+#### Using the `template_create_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateCreateResponse>, Integer, Hash)> template_create_with_http_info(template_create_request)`
+
+```ruby
+begin
+  # Create  Template
+  data, status_code, headers = api_instance.template_create_with_http_info(template_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateCreateResponse>
+rescue Dropbox::Sign::ApiError => e
+  puts "Error when calling TemplateApi->template_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_create_request` | [**TemplateCreateRequest**](TemplateCreateRequest.md) |  |  |
+
+### Return type
+
+[**TemplateCreateResponse**](TemplateCreateResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
 ## `template_create_embedded_draft`
 
 > `<TemplateCreateEmbeddedDraftResponse> template_create_embedded_draft(template_create_embedded_draft_request)`
@@ -412,7 +514,7 @@ end
 
 ## `template_files_as_file_url`
 
-> `<FileResponse> template_files_as_file_url(template_id)`
+> `<FileResponse> template_files_as_file_url(template_id, opts)`
 
 Get Template Files as File Url
 
@@ -448,12 +550,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id)`
+> `<Array(<FileResponse>, Integer, Hash)> template_files_as_file_url_with_http_info(template_id, opts)`
 
 ```ruby
 begin
   # Get Template Files as File Url
-  data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id)
+  data, status_code, headers = api_instance.template_files_as_file_url_with_http_info(template_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <FileResponse>
@@ -467,6 +569,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | `template_id` | **String** | The id of the template files to retrieve. |  |
+| `force_download` | **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] |
 
 ### Return type
 

data/docs/TemplateCreateRequest.md

@@ -0,0 +1,27 @@
+# Dropbox::Sign::TemplateCreateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `form_fields_per_document`<sup>*_required_</sup> | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) |  The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`  |  |
+| `signer_roles`<sup>*_required_</sup> | [```Array<SubTemplateRole>```](SubTemplateRole.md) |  An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.  |  |
+| `files` | ```Array<File>``` |  Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both.  |  |
+| `file_urls` | ```Array<String>``` |  Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both.  |  |
+| `allow_reassign` | ```Boolean``` |  Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`.<br><br>**Note**: Only available for Premium plan and higher.  |  [default to false] |
+| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) |  A list describing the attachments  |  |
+| `cc_roles` | ```Array<String>``` |  The CC roles that must be assigned when using the template to send a signature request  |  |
+| `client_id` | ```String``` |  Client id of the app you&#39;re using to create this draft. Used to apply the branding and callback url defined for the app.  |  |
+| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) |    |  |
+| `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) |  Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.  |  |
+| `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) |  Conditional Logic rules for fields defined in `form_fields_per_document`.  |  |
+| `merge_fields` | [```Array<SubMergeField>```](SubMergeField.md) |  Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.  |  |
+| `message` | ```String``` |  The default template email message.  |  |
+| `metadata` | ```Hash<String, Object>``` |  Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer&#39;s order number for look up when receiving events for the signature request.<br><br>Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.  |  |
+| `subject` | ```String``` |  The template title (alias).  |  |
+| `test_mode` | ```Boolean``` |  Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
+| `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
+| `use_preexisting_fields` | ```Boolean``` |  Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).  |  [default to false] |
+

data/docs/TemplateCreateResponse.md

@@ -0,0 +1,11 @@
+# Dropbox::Sign::TemplateCreateResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template` | [```TemplateCreateResponseTemplate```](TemplateCreateResponseTemplate.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/TemplateCreateResponseTemplate.md

@@ -0,0 +1,10 @@
+# Dropbox::Sign::TemplateCreateResponseTemplate
+
+Template object with parameters: `template_id`.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | ```String``` |  The id of the Template.  |  |
+

data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md

@@ -35,4 +35,5 @@
 | `test_mode` | ```Boolean``` |  Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.  |  [default to false] |
 | `title` | ```String``` |  The title you want to assign to the SignatureRequest.  |  |
 | `populate_auto_fill_fields` | ```Boolean``` |  Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer&#39;s information during signing.<br><br>⚠️ **Note** ⚠️: Keep your signer&#39;s information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.  |  [default to false] |
+| `allow_ccs` | ```Boolean``` |  This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.  |  [default to false] |
 

data/examples/OauthTokenGenerate.rb

@@ -1,13 +1,5 @@
 require "dropbox-sign"
 
-Dropbox::Sign.configure do |config|
-  # Configure HTTP basic authorization: api_key
-  config.username = "YOUR_API_KEY"
-
-  # or, configure Bearer (JWT) authorization: oauth2
-  # config.access_token = "YOUR_ACCESS_TOKEN"
-end
-
 oauth_api = Dropbox::Sign::OAuthApi.new
 
 data = Dropbox::Sign::OAuthTokenGenerateRequest.new

data/examples/OauthTokenRefresh.rb

@@ -1,13 +1,5 @@
 require "dropbox-sign"
 
-Dropbox::Sign.configure do |config|
-  # Configure HTTP basic authorization: api_key
-  config.username = "YOUR_API_KEY"
-
-  # or, configure Bearer (JWT) authorization: oauth2
-  # config.access_token = "YOUR_ACCESS_TOKEN"
-end
-
 oauth_api = Dropbox::Sign::OAuthApi.new
 
 data = Dropbox::Sign::OAuthTokenRefreshRequest.new

data/examples/TemplateCreate.rb

@@ -0,0 +1,49 @@
+require "dropbox-sign"
+
+Dropbox::Sign.configure do |config|
+  # Configure HTTP basic authorization: api_key
+  config.username = "YOUR_API_KEY"
+
+  # or, configure Bearer (JWT) authorization: oauth2
+  # config.access_token = "YOUR_ACCESS_TOKEN"
+end
+
+template_api = Dropbox::Sign::TemplateApi.new
+
+role_1 = Dropbox::Sign::SubTemplateRole.new
+role_1.name = "Client"
+role_1.order = 0
+
+role_2 = Dropbox::Sign::SubTemplateRole.new
+role_2.name = "Witness"
+role_2.order = 1
+
+merge_field_1 = Dropbox::Sign::SubMergeField.new
+merge_field_1.name = "Full Name"
+merge_field_1.type = "text"
+
+merge_field_2 = Dropbox::Sign::SubMergeField.new
+merge_field_2.name = "Is Registered?"
+merge_field_2.type = "checkbox"
+
+field_options = Dropbox::Sign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = Dropbox::Sign::TemplateCreateRequest.new
+data.client_id = "37dee8d8440c66d54cfa05d92c160882"
+data.files = [File.new("example_signature_request.pdf", "r")]
+data.title = "Test Template"
+data.subject = "Please sign this document"
+data.message = "For your approval"
+data.signer_roles = [role_1, role_2]
+data.cc_roles = ["Manager"]
+data.merge_fields = [merge_field_1, merge_field_2]
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = template_api.template_create(data)
+  p result
+rescue Dropbox::Sign::ApiError => e
+  puts "Exception when calling Dropbox Sign API: #{e}"
+end

data/lib/dropbox-sign/api/signature_request_api.rb

@@ -724,6 +724,7 @@ module Dropbox::Sign
     # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only).  If the files are currently being prepared, a status code of `409` will be returned instead.
     # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :force_download 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. (default to 1)
     # @return [FileResponse]
     def signature_request_files_as_file_url(signature_request_id, opts = {})
       data, _status_code, _headers = signature_request_files_as_file_url_with_http_info(signature_request_id, opts)
@@ -734,6 +735,7 @@ module Dropbox::Sign
     # Obtain a copy of the current documents specified by the `signature_request_id` parameter. Returns a JSON object with a url to the file (PDFs only).  If the files are currently being prepared, a status code of `409` will be returned instead.
     # @param signature_request_id [String] The id of the SignatureRequest to retrieve.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :force_download 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.
     # @return [Array<(FileResponse, Integer, Hash)>] FileResponse data, response status code and response headers
     def signature_request_files_as_file_url_with_http_info(signature_request_id, opts = {})
       if @api_client.config.debugging
@@ -748,6 +750,7 @@ module Dropbox::Sign
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'force_download'] = opts[:'force_download'] if !opts[:'force_download'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -1503,7 +1506,7 @@ module Dropbox::Sign
     end
 
     # Update Signature Request
-    # Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+    # Updates the email address and/or the name for a given signer on a signature request. You can listen for the `signature_request_email_bounce` event on your app or account to detect bounced emails, and respond with this method.  Updating the email address of a signer will generate a new `signature_id` value.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
     # @param signature_request_id [String] The id of the SignatureRequest to update.
     # @param signature_request_update_request [SignatureRequestUpdateRequest] 
     # @param [Hash] opts the optional parameters
@@ -1514,7 +1517,7 @@ module Dropbox::Sign
     end
 
     # Update Signature Request
-    # Updates the email address and/or the name for a given signer on a signature request. You can listen for the &#x60;signature_request_email_bounce&#x60; event on your app or account to detect bounced emails, and respond with this method.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
+    # Updates the email address and/or the name for a given signer on a signature request. You can listen for the &#x60;signature_request_email_bounce&#x60; event on your app or account to detect bounced emails, and respond with this method.  Updating the email address of a signer will generate a new &#x60;signature_id&#x60; value.  **NOTE**: This action cannot be performed on a signature request with an appended signature page.
     # @param signature_request_id [String] The id of the SignatureRequest to update.
     # @param signature_request_update_request [SignatureRequestUpdateRequest] 
     # @param [Hash] opts the optional parameters