hellosign-ruby-sdk 3.7.7 → 6.0.0.pre.beta

data/docs/TemplateApi.md

@@ -0,0 +1,638 @@
+# HelloSign::TemplateApi
+
+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_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 |
+| [`template_get`](TemplateApi.md#template_get) | **GET** `/template/{template_id}` | Get Template |
+| [`template_list`](TemplateApi.md#template_list) | **GET** `/template/list` | List Templates |
+| [`template_remove_user`](TemplateApi.md#template_remove_user) | **POST** `/template/remove_user/{template_id}` | Remove User from Template |
+| [`template_update_files`](TemplateApi.md#template_update_files) | **POST** `/template/update_files/{template_id}` | Update Template Files |
+
+
+## `template_add_user`
+
+> `<TemplateGetResponse> template_add_user(template_id, template_add_user_request)`
+
+Add User to Template
+
+Gives the specified Account access to the specified Template. The specified Account must be a part of your Team.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+data = HelloSign::TemplateAddUserRequest.new
+data.email_address = "george@hellosign.com"
+
+template_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = api.template_add_user(template_id, data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_add_user_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateGetResponse>, Integer, Hash)> template_add_user_with_http_info(template_id, template_add_user_request)`
+
+```ruby
+begin
+  # Add User to Template
+  data, status_code, headers = api_instance.template_add_user_with_http_info(template_id, template_add_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateGetResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_add_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the Template to give the Account access to. |  |
+| `template_add_user_request` | [**TemplateAddUserRequest**](TemplateAddUserRequest.md) |  |  |
+
+### Return type
+
+[**TemplateGetResponse**](TemplateGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## `template_create_embedded_draft`
+
+> `<TemplateCreateEmbeddedDraftResponse> template_create_embedded_draft(template_create_embedded_draft_request)`
+
+Create Embedded Template Draft
+
+The first step in an embedded template workflow. Creates a draft template that can then be further set up in the template 'edit' stage.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+role_1 = HelloSign::SubTemplateRole.new
+role_1.name = "Client"
+role_1.order = 0
+
+role_2 = HelloSign::SubTemplateRole.new
+role_2.name = "Witness"
+role_2.order = 1
+
+merge_field_1 = HelloSign::SubMergeField.new
+merge_field_1.name = "Full Name"
+merge_field_1.type = "text"
+
+merge_field_2 = HelloSign::SubMergeField.new
+merge_field_2.name = "Is Registered?"
+merge_field_2.type = "checkbox"
+
+field_options = HelloSign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = HelloSign::TemplateCreateEmbeddedDraftRequest.new
+data.client_id = "37dee8d8440c66d54cfa05d92c160882"
+data.file_url = ["https://app.hellosign.com/docs/example_signature_request.pdf"]
+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 = api.template_create_embedded_draft(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_create_embedded_draft_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateCreateEmbeddedDraftResponse>, Integer, Hash)> template_create_embedded_draft_with_http_info(template_create_embedded_draft_request)`
+
+```ruby
+begin
+  # Create Embedded Template Draft
+  data, status_code, headers = api_instance.template_create_embedded_draft_with_http_info(template_create_embedded_draft_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateCreateEmbeddedDraftResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_create_embedded_draft_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_create_embedded_draft_request` | [**TemplateCreateEmbeddedDraftRequest**](TemplateCreateEmbeddedDraftRequest.md) |  |  |
+
+### Return type
+
+[**TemplateCreateEmbeddedDraftResponse**](TemplateCreateEmbeddedDraftResponse.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_delete`
+
+> `template_delete(template_id)`
+
+Delete Template
+
+Completely deletes the template specified from the account.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = api.template_delete(template_id)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_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)> template_delete_with_http_info(template_id)`
+
+```ruby
+begin
+  # Delete Template
+  data, status_code, headers = api_instance.template_delete_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the Template to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `template_files`
+
+> `<FileResponse> template_files(template_id, opts)`
+
+Get Template Files
+
+Obtain a copy of the current documents specified by the `template_id` parameter.  Returns a PDF or ZIP file, or if `get_url` is set, a JSON object with a url to the file (PDFs only). If `get_data_uri` is set, a JSON object with a `data_uri` representing the base64 encoded file (PDFs only) is returned.  If the files are currently being prepared, a status code of `409` will be returned instead. In this case please wait for the `template_created` callback event.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = api.template_files(template_id)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_files_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<FileResponse>, Integer, Hash)> template_files_with_http_info(template_id, opts)`
+
+```ruby
+begin
+  # Get Template Files
+  data, status_code, headers = api_instance.template_files_with_http_info(template_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FileResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_files_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the template files to retrieve. |  |
+| `file_type` | **String** | Set to `pdf` for a single merged document or `zip` for a collection of individual documents. | [optional] |
+| `get_url` | **Boolean** | If `true`, the response will contain a url link to the file instead. Links are only available for PDFs and have a TTL of 3 days. | [optional][default to false] |
+| `get_data_uri` | **Boolean** | If `true`, the response will contain the file as base64 encoded string. Base64 encoding is only available for PDFs. | [optional][default to false] |
+
+### Return type
+
+[**FileResponse**](FileResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `template_get`
+
+> `<TemplateGetResponse> template_get(template_id)`
+
+Get Template
+
+Returns the Template specified by the `template_id` parameter.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+template_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = api.template_get(template_id)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_get_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateGetResponse>, Integer, Hash)> template_get_with_http_info(template_id)`
+
+```ruby
+begin
+  # Get Template
+  data, status_code, headers = api_instance.template_get_with_http_info(template_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateGetResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the Template to retrieve. |  |
+
+### Return type
+
+[**TemplateGetResponse**](TemplateGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `template_list`
+
+> `<TemplateListResponse> template_list(opts)`
+
+List Templates
+
+Returns a list of the Templates that are accessible by you.  Take a look at our [search guide](/api/reference/search/) to learn more about querying templates.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+account_id = "f57db65d3f933b5316d398057a36176831451a35"
+
+begin
+  result = api.template_list(account_id)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_list_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateListResponse>, Integer, Hash)> template_list_with_http_info(opts)`
+
+```ruby
+begin
+  # List Templates
+  data, status_code, headers = api_instance.template_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateListResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `account_id` | **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] |
+| `page_size` | **Integer** | Number of objects to be returned per page. Must be between `1` and `100`. Default is `20`. | [optional][default to 20] |
+| `query` | **String** | String that includes search terms and/or fields to be used to filter the Template objects. | [optional] |
+
+### Return type
+
+[**TemplateListResponse**](TemplateListResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## `template_remove_user`
+
+> `<TemplateGetResponse> template_remove_user(template_id, template_remove_user_request)`
+
+Remove User from Template
+
+Removes the specified Account's access to the specified Template.
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+data = HelloSign::TemplateRemoveUserRequest.new
+data.email_address = "george@hellosign.com"
+
+template_id = "21f920ec2b7f4b6bb64d3ed79f26303843046536"
+
+begin
+  result = api.template_remove_user(template_id, data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_remove_user_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateGetResponse>, Integer, Hash)> template_remove_user_with_http_info(template_id, template_remove_user_request)`
+
+```ruby
+begin
+  # Remove User from Template
+  data, status_code, headers = api_instance.template_remove_user_with_http_info(template_id, template_remove_user_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateGetResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_remove_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The id of the Template to remove the Account&#39;s access to. |  |
+| `template_remove_user_request` | [**TemplateRemoveUserRequest**](TemplateRemoveUserRequest.md) |  |  |
+
+### Return type
+
+[**TemplateGetResponse**](TemplateGetResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## `template_update_files`
+
+> `<TemplateUpdateFilesResponse> template_update_files(template_id, template_update_files_request)`
+
+Update Template Files
+
+Overlays a new file with the overlay of an existing template. The new file(s) must:  1. have the same or higher page count 2. the same orientation as the file(s) being replaced.  This will not overwrite or in any way affect the existing template. Both the existing template and new template will be available for use after executing this endpoint. Also note that this will decrement your template quota.  Overlaying new files is asynchronous and a successful call to this endpoint will return 200 OK response if the request passes initial validation checks.  It is recommended that a callback be implemented to listen for the callback event. A `template_created` event will be sent when the files are updated or a `template_error` event will be sent if there was a problem while updating the files. If a callback handler has been configured and the event has not been received within 60 minutes of making the call, check the status of the request in the API dashboard and retry the request if necessary.  If the page orientation or page count is different from the original template document, we will notify you with a `template_error` [callback event](https://app.hellosign.com/api/eventsAndCallbacksWalkthrough).
+
+### Examples
+
+```ruby
+require "hellosign-ruby-sdk"
+
+HelloSign.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
+
+api = HelloSign::TemplateApi.new
+
+data = HelloSign::TemplateUpdateFilesRequest.new
+data.file_url = ["https://app.hellosign.com/docs/example_signature_request.pdf"]
+
+template_id = "5de8179668f2033afac48da1868d0093bf133266"
+
+begin
+  result = api.template_update_files(template_id, data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `template_update_files_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<TemplateUpdateFilesResponse>, Integer, Hash)> template_update_files_with_http_info(template_id, template_update_files_request)`
+
+```ruby
+begin
+  # Update Template Files
+  data, status_code, headers = api_instance.template_update_files_with_http_info(template_id, template_update_files_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateUpdateFilesResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling TemplateApi->template_update_files_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | **String** | The ID of the template whose files to update. |  |
+| `template_update_files_request` | [**TemplateUpdateFilesRequest**](TemplateUpdateFilesRequest.md) |  |  |
+
+### Return type
+
+[**TemplateUpdateFilesResponse**](TemplateUpdateFilesResponse.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
+

data/docs/TemplateCreateEmbeddedDraftRequest.md

@@ -0,0 +1,34 @@
+# HelloSign::TemplateCreateEmbeddedDraftRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```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.  |  |
+| `file` | ```Array<File>``` |  Use `file[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **file** or **file_url[]**, but not both.  |  |
+| `file_url` | ```Array<String>``` |  Use `file_url[]` to have HelloSign download the file(s) to send for signature.<br><br>This endpoint requires either **file** or **file_url[]**, but not both.  |  |
+| `allow_ccs` | ```Boolean``` |  This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.  |  [default to true] |
+| `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  |  |
+| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) |    |  |
+| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) |    |  |
+| `force_signer_roles` | ```Boolean``` |  Provide users the ability to review/edit the template signer roles.  |  [default to false] |
+| `force_subject_message` | ```Boolean``` |  Provide users the ability to review/edit the template subject and message.  |  [default to false] |
+| `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`.  |  |
+| `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) |  The fields that should appear on the document, expressed as an array of objects. (We&#39;re currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: &lt;a href&#x3D;&quot;/docs/placing-fields/form-fields-per-document&quot; target&#x3D;&quot;_blank&quot;&gt;Using Form Fields per Document&lt;/a&gt;.)<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`  |  |
+| `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.  |  |
+| `show_preview` | ```Boolean``` |  This allows the requester to enable the editor/preview experience.<br><br>- `show_preview&#x3D;true`: Allows requesters to enable the editor/preview experience. - `show_preview&#x3D;false`: Allows requesters to disable the editor/preview experience.  |  [default to false] |
+| `show_progress_stepper` | ```Boolean``` |  When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.  |  [default to true] |
+| `signer_roles` | [```Array<SubTemplateRole>```](SubTemplateRole.md) |  An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.  |  |
+| `skip_me_now` | ```Boolean``` |  Disables the &quot;Me (Now)&quot; option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.  |  [default to false] |
+| `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/TemplateCreateEmbeddedDraftResponse.md

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

data/docs/TemplateCreateEmbeddedDraftResponseTemplate.md

@@ -0,0 +1,13 @@
+# HelloSign::TemplateCreateEmbeddedDraftResponseTemplate
+
+Template object with parameters: `template_id`, `edit_url`, `expires_at`.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `template_id` | ```String``` |  The id of the Template.  |  |
+| `edit_url` | ```String``` |  Link to edit the template.  |  |
+| `expires_at` | ```Integer``` |  When the link expires.  |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+