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

data/docs/UnclaimedDraftApi.md

@@ -0,0 +1,359 @@
+# HelloSign::UnclaimedDraftApi
+
+All URIs are relative to *https://api.hellosign.com/v3*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [`unclaimed_draft_create`](UnclaimedDraftApi.md#unclaimed_draft_create) | **POST** `/unclaimed_draft/create` | Create Unclaimed Draft |
+| [`unclaimed_draft_create_embedded`](UnclaimedDraftApi.md#unclaimed_draft_create_embedded) | **POST** `/unclaimed_draft/create_embedded` | Create Embedded Unclaimed Draft |
+| [`unclaimed_draft_create_embedded_with_template`](UnclaimedDraftApi.md#unclaimed_draft_create_embedded_with_template) | **POST** `/unclaimed_draft/create_embedded_with_template` | Create Embedded Unclaimed Draft with Template |
+| [`unclaimed_draft_edit_and_resend`](UnclaimedDraftApi.md#unclaimed_draft_edit_and_resend) | **POST** `/unclaimed_draft/edit_and_resend/{signature_request_id}` | Edit and Resend Unclaimed Draft |
+
+
+## `unclaimed_draft_create`
+
+> `<UnclaimedDraftCreateResponse> unclaimed_draft_create(unclaimed_draft_create_request)`
+
+Create Unclaimed Draft
+
+Creates a new Draft that can be claimed using the claim URL. The first authenticated user to access the URL will claim the Draft and will be shown either the \"Sign and send\" or the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a 404.
+
+### 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::UnclaimedDraftApi.new
+
+signer_1 = HelloSign::SubUnclaimedDraftSigner.new
+signer_1.email_address = "jack@example.com"
+signer_1.name = "Jack"
+signer_1.order = 0
+
+signer_2 = HelloSign::SubUnclaimedDraftSigner.new
+signer_2.email_address = "jill@example.com"
+signer_2.name = "Jill"
+signer_2.order = 1
+
+signing_options = HelloSign::SubSigningOptions.new
+signing_options.draw = true
+signing_options.type = true
+signing_options.upload = true
+signing_options.phone = false
+signing_options.default_type = "draw"
+
+field_options = HelloSign::SubFieldOptions.new
+field_options.date_format = "DD - MM - YYYY"
+
+data = HelloSign::UnclaimedDraftCreateRequest.new
+data.subject = "The NDA we talked about"
+data.type = "request_signature"
+data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
+data.signers = [signer_1, signer_2]
+data.cc_email_addresses = [
+  "lawyer@hellosign.com",
+  "lawyer@example.com",
+]
+data.file_url = ["https://app.hellosign.com/docs/example_signature_request.pdf"]
+data.metadata = {
+  custom_id: 1234,
+  custom_text: "NDA #9",
+}
+data.signing_options = signing_options
+data.field_options = field_options
+data.test_mode = true
+
+begin
+  result = api.unclaimed_draft_create(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `unclaimed_draft_create_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<UnclaimedDraftCreateResponse>, Integer, Hash)> unclaimed_draft_create_with_http_info(unclaimed_draft_create_request)`
+
+```ruby
+begin
+  # Create Unclaimed Draft
+  data, status_code, headers = api_instance.unclaimed_draft_create_with_http_info(unclaimed_draft_create_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnclaimedDraftCreateResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling UnclaimedDraftApi->unclaimed_draft_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `unclaimed_draft_create_request` | [**UnclaimedDraftCreateRequest**](UnclaimedDraftCreateRequest.md) |  |  |
+
+### Return type
+
+[**UnclaimedDraftCreateResponse**](UnclaimedDraftCreateResponse.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
+
+
+## `unclaimed_draft_create_embedded`
+
+> `<UnclaimedDraftCreateResponse> unclaimed_draft_create_embedded(unclaimed_draft_create_embedded_request)`
+
+Create Embedded Unclaimed Draft
+
+Creates a new Draft that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.  **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
+
+### 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::UnclaimedDraftApi.new
+
+data = HelloSign::UnclaimedDraftCreateEmbeddedRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.file_url = ["https://app.hellosign.com/docs/example_signature_request.pdf"]
+data.requester_email_address = "jack@hellosign.com"
+data.test_mode = true
+
+begin
+  result = api.unclaimed_draft_create_embedded(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `unclaimed_draft_create_embedded_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<UnclaimedDraftCreateResponse>, Integer, Hash)> unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedded_request)`
+
+```ruby
+begin
+  # Create Embedded Unclaimed Draft
+  data, status_code, headers = api_instance.unclaimed_draft_create_embedded_with_http_info(unclaimed_draft_create_embedded_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnclaimedDraftCreateResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling UnclaimedDraftApi->unclaimed_draft_create_embedded_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `unclaimed_draft_create_embedded_request` | [**UnclaimedDraftCreateEmbeddedRequest**](UnclaimedDraftCreateEmbeddedRequest.md) |  |  |
+
+### Return type
+
+[**UnclaimedDraftCreateResponse**](UnclaimedDraftCreateResponse.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
+
+
+## `unclaimed_draft_create_embedded_with_template`
+
+> `<UnclaimedDraftCreateResponse> unclaimed_draft_create_embedded_with_template(unclaimed_draft_create_embedded_with_template_request)`
+
+Create Embedded Unclaimed Draft with Template
+
+Creates a new Draft with a previously saved template(s) that can be claimed and used in an embedded iFrame. The first authenticated user to access the URL will claim the Draft and will be shown the \"Request signature\" page with the Draft loaded. Subsequent access to the claim URL will result in a `404`. For this embedded endpoint the `requester_email_address` parameter is required.  **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
+
+### 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::UnclaimedDraftApi.new
+
+signer_1 = HelloSign::SubUnclaimedDraftTemplateSigner.new
+signer_1.role = "Client"
+signer_1.name = "George"
+signer_1.email_address = "george@example.com"
+
+cc_1 = HelloSign::SubCC.new
+cc_1.role = "Accounting"
+cc_1.email_address = "accounting@example.com"
+
+data = HelloSign::UnclaimedDraftCreateEmbeddedWithTemplateRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.template_ids = ["61a832ff0d8423f91d503e76bfbcc750f7417c78"]
+data.requester_email_address = "jack@hellosign.com"
+data.signers = [signer_1]
+data.ccs = [cc_1]
+data.test_mode = true
+
+begin
+  result = api.unclaimed_draft_create_embedded_with_template(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `unclaimed_draft_create_embedded_with_template_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<UnclaimedDraftCreateResponse>, Integer, Hash)> unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft_create_embedded_with_template_request)`
+
+```ruby
+begin
+  # Create Embedded Unclaimed Draft with Template
+  data, status_code, headers = api_instance.unclaimed_draft_create_embedded_with_template_with_http_info(unclaimed_draft_create_embedded_with_template_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnclaimedDraftCreateResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling UnclaimedDraftApi->unclaimed_draft_create_embedded_with_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `unclaimed_draft_create_embedded_with_template_request` | [**UnclaimedDraftCreateEmbeddedWithTemplateRequest**](UnclaimedDraftCreateEmbeddedWithTemplateRequest.md) |  |  |
+
+### Return type
+
+[**UnclaimedDraftCreateResponse**](UnclaimedDraftCreateResponse.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
+
+
+## `unclaimed_draft_edit_and_resend`
+
+> `<UnclaimedDraftCreateResponse> unclaimed_draft_edit_and_resend(signature_request_id, unclaimed_draft_edit_and_resend_request)`
+
+Edit and Resend Unclaimed Draft
+
+Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter `test_mode` can be edited prior to request. Signers can be edited in embedded editor. Requester's email address will remain unchanged if `requester_email_address` parameter is not set.  **NOTE**: Embedded unclaimed drafts can only be accessed in embedded iFrames whereas normal drafts can be used and accessed on HelloSign.
+
+### 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::UnclaimedDraftApi.new
+
+data = HelloSign::UnclaimedDraftEditAndResendRequest.new
+data.client_id = "ec64a202072370a737edf4a0eb7f4437"
+data.test_mode = true
+
+signature_request_id = "2f9781e1a83jdja934d808c153c2e1d3df6f8f2f"
+
+begin
+  result = api.unclaimed_draft_edit_and_resend(signature_request_id, data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end
+
+```
+
+#### Using the `unclaimed_draft_edit_and_resend_with_http_info` variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> `<Array(<UnclaimedDraftCreateResponse>, Integer, Hash)> unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaimed_draft_edit_and_resend_request)`
+
+```ruby
+begin
+  # Edit and Resend Unclaimed Draft
+  data, status_code, headers = api_instance.unclaimed_draft_edit_and_resend_with_http_info(signature_request_id, unclaimed_draft_edit_and_resend_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UnclaimedDraftCreateResponse>
+rescue HelloSign::ApiError => e
+  puts "Error when calling UnclaimedDraftApi->unclaimed_draft_edit_and_resend_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signature_request_id` | **String** | The ID of the signature request to edit and resend. |  |
+| `unclaimed_draft_edit_and_resend_request` | [**UnclaimedDraftEditAndResendRequest**](UnclaimedDraftEditAndResendRequest.md) |  |  |
+
+### Return type
+
+[**UnclaimedDraftCreateResponse**](UnclaimedDraftCreateResponse.md)
+
+### Authorization
+
+[api_key](../README.md#api_key), [oauth2](../README.md#oauth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UnclaimedDraftCreateEmbeddedRequest.md

@@ -0,0 +1,44 @@
+# HelloSign::UnclaimedDraftCreateEmbeddedRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.  |  |
+| `requester_email_address`<sup>*_required_</sup> | ```String``` |  The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.  |  |
+| `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 claiming the draft.  |  [default to true] |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [default to false] |
+| `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_email_addresses` | ```Array<String>``` |  The email addresses that should be CCed.  |  |
+| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) |  When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with &quot;send-once&quot; signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.<br><br>For using pre-filled on repeatable signature requests, merge fields are added to templates in the HelloSign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.  |  |
+| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) |    |  |
+| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) |    |  |
+| `force_signer_page` | ```Boolean``` |  Provide users the ability to review/edit the signers.  |  [default to false] |
+| `force_subject_message` | ```Boolean``` |  Provide users the ability to review/edit the 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`  |  |
+| `hide_text_tags` | ```Boolean``` |  Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.  |  [default to false] |
+| `hold_request` | ```Boolean``` |  The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.  |  [default to false] |
+| `is_for_embedded_signing` | ```Boolean``` |  The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.  |  [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.  |  |
+| `requesting_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully request a signature.  |  |
+| `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.  |  |
+| `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] |
+| `signers` | [```Array<SubUnclaimedDraftSigner>```](SubUnclaimedDraftSigner.md) |  Add Signers to your Unclaimed Draft Signature Request.  |  |
+| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |
+| `signing_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully sign.  |  |
+| `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 subject in the email that will be sent to the signers.  |  |
+| `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] |
+| `type` | ```String``` |  The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.  |  [default to 'request_signature'] |
+| `use_preexisting_fields` | ```Boolean``` |  Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.  |  [default to false] |
+| `use_text_tags` | ```Boolean``` |  Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.  |  [default to false] |
+| `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] |
+

data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md

@@ -0,0 +1,38 @@
+# HelloSign::UnclaimedDraftCreateEmbeddedWithTemplateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.  |  |
+| `requester_email_address`<sup>*_required_</sup> | ```String``` |  The email address of the user that should be designated as the requester of this draft.  |  |
+| `template_ids`<sup>*_required_</sup> | ```Array<String>``` |  Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.  |  |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [default to false] |
+| `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] |
+| `ccs` | [```Array<SubCC>```](SubCC.md) |  Add CC email recipients. Required when a CC role exists for the Template.  |  |
+| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) |  An array defining values and options for custom fields. Required when a custom field exists in the Template.  |  |
+| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) |    |  |
+| `field_options` | [```SubFieldOptions```](SubFieldOptions.md) |    |  |
+| `file` | ```Array<File>``` |  Use `file[]` to append additional files to the signature request being created from the template. HelloSign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored.<br><br>**file** or **file_url[]** is required, but not both.  |  |
+| `file_url` | ```Array<String>``` |  Use file_url[] to append additional files to the signature request being created from the template. HelloSign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored.<br><br>**file** or **file_url[]** is required, but not both.  |  |
+| `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] |
+| `hold_request` | ```Boolean``` |  The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.  |  [default to false] |
+| `is_for_embedded_signing` | ```Boolean``` |  The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.  |  [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.  |  |
+| `preview_only` | ```Boolean``` |  This allows the requester to enable the preview experience (i.e. does not allow the requester&#39;s end user to add any additional fields via the editor).<br><br>- `preview_only&#x3D;true`: Allows requesters to enable the preview only experience. - `preview_only&#x3D;false`: Allows requesters to disable the preview only experience.<br><br>**Note**: This parameter overwrites `show_preview&#x3D;1` (if set).  |  [default to false] |
+| `requesting_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully request a signature.  |  |
+| `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] |
+| `signers` | [```Array<SubUnclaimedDraftTemplateSigner>```](SubUnclaimedDraftTemplateSigner.md) |  Add Signers to your Templated-based Signature Request.  |  |
+| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |
+| `signing_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully sign.  |  |
+| `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 subject in the email that will be sent to the signers.  |  |
+| `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] |
+

data/docs/UnclaimedDraftCreateRequest.md

@@ -0,0 +1,32 @@
+# HelloSign::UnclaimedDraftCreateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type`<sup>*_required_</sup> | ```String``` |  The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.  |  |
+| `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_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [default to false] |
+| `attachments` | [```Array<SubAttachment>```](SubAttachment.md) |  A list describing the attachments  |  |
+| `cc_email_addresses` | ```Array<String>``` |  The email addresses that should be CCed.  |  |
+| `client_id` | ```String``` |  Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.  |  |
+| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) |  When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.<br><br>Pre-filled data can be used with &quot;send-once&quot; signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call.<br><br>For using pre-filled on repeatable signature requests, merge fields are added to templates in the HelloSign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.  |  |
+| `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`.  |  |
+| `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`  |  |
+| `hide_text_tags` | ```Boolean``` |  Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.  |  [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.  |  |
+| `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] |
+| `signers` | [```Array<SubUnclaimedDraftSigner>```](SubUnclaimedDraftSigner.md) |  Add Signers to your Unclaimed Draft Signature Request.  |  |
+| `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) |    |  |
+| `signing_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully sign.  |  |
+| `subject` | ```String``` |  The subject in the email that will be sent to the signers.  |  |
+| `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] |
+| `use_preexisting_fields` | ```Boolean``` |  Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.  |  [default to false] |
+| `use_text_tags` | ```Boolean``` |  Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.  |  [default to false] |
+

data/docs/UnclaimedDraftCreateResponse.md

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

data/docs/UnclaimedDraftEditAndResendRequest.md

@@ -0,0 +1,17 @@
+# HelloSign::UnclaimedDraftEditAndResendRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.  |  |
+| `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) |    |  |
+| `is_for_embedded_signing` | ```Boolean``` |  The request created from this draft will also be signable in embedded mode if set to `true`.  |  |
+| `requester_email_address` | ```String``` |  The email address of the user that should be designated as the requester of this draft. If not set, original requester&#39;s email address will be used.  |  |
+| `requesting_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully request a signature.  |  |
+| `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] |
+| `signing_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully sign.  |  |
+| `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] |
+

data/docs/UnclaimedDraftResponse.md

@@ -0,0 +1,15 @@
+# HelloSign::UnclaimedDraftResponse
+
+A group of documents that a user can take ownership of via the claim URL.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signature_request_id` | ```String``` |  The ID of the signature request that is represented by this UnclaimedDraft.  |  |
+| `claim_url` | ```String``` |  The URL to be used to claim this UnclaimedDraft.  |  |
+| `signing_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully sign.  |  |
+| `requesting_redirect_url` | ```String``` |  The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).  |  |
+| `expires_at` | ```Integer``` |  When the link expires.  |  |
+| `test_mode` | ```Boolean``` |  Whether this is a test draft. Signature requests made from test drafts have no legal value.  |  |
+

data/docs/WarningResponse.md

@@ -0,0 +1,11 @@
+# HelloSign::WarningResponse
+
+A list of warnings.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `warning_msg`<sup>*_required_</sup> | ```String``` |  Warning message  |  |
+| `warning_name`<sup>*_required_</sup> | ```String``` |  Warning name  |  |
+

data/examples/AccountCreate.rb

@@ -0,0 +1,21 @@
+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::AccountApi.new
+
+data = HelloSign::AccountCreateRequest.new
+data.email_address = "newuser@hellosign.com"
+
+begin
+  result = api.account_create(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end

data/examples/AccountGet.rb

@@ -0,0 +1,18 @@
+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::AccountApi.new
+
+begin
+  result = api.account_get
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end

data/examples/AccountUpdate.rb

@@ -0,0 +1,21 @@
+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::AccountApi.new
+
+data = HelloSign::AccountUpdateRequest.new
+data.callback_url = "https://www.example.com/callback"
+
+begin
+  result = api.account_update(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end

data/examples/AccountVerify.rb

@@ -0,0 +1,21 @@
+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::AccountApi.new
+
+data = HelloSign::AccountVerifyRequest.new
+data.email_address = "some_user@hellosign.com"
+
+begin
+  result = api.account_verify(data)
+  p result
+rescue HelloSign::ApiError => e
+  puts "Exception when calling HelloSign API: #{e}"
+end