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

data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md

@@ -0,0 +1,22 @@
+# HelloSign::SignatureRequestBulkCreateEmbeddedWithTemplateRequest
+
+Calls SignatureRequestBulkSendWithTemplate in controller
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `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 template will be used.  |  |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes.  |  |
+| `signer_file` | ```File``` |  `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br>    **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br>    You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```  |  |
+| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) |  `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.  |  |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [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) |  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.  |  |
+| `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_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 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.  |  |
+

data/docs/SignatureRequestBulkSendWithTemplateRequest.md

@@ -0,0 +1,22 @@
+# HelloSign::SignatureRequestBulkSendWithTemplateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `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 template will be used.  |  |
+| `signer_file` | ```File``` |  `signer_file` is a CSV file defining values and options for signer fields. Required unless a `signer_list` is used, you may not use both. The CSV can have the following columns:<br><br>- `name`: the name of the signer filling the role of RoleName - `email_address`: email address of the signer filling the role of RoleName - `pin`: the 4- to 12-character access code that will secure this signer&#39;s signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer&#39;s signature page. (optional)<br><br>    **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field&quot; suffix will be treated as a custom field (optional)<br><br>    You may only specify field values here, any other options should be set in the custom_fields request parameter.<br><br>Example CSV:<br><br>``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```  |  |
+| `signer_list` | [```Array<SubBulkSignerList>```](SubBulkSignerList.md) |  `signer_list` is an array defining values and options for signer fields. Required unless a `signer_file` is used, you may not use both.  |  |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [default to false] |
+| `ccs` | [```Array<SubCC>```](SubCC.md) |  Add CC email recipients. Required when a CC role exists for the Template.  |  |
+| `client_id` | ```String``` |  The client id of the API App you want to associate with this request. 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.  |  |
+| `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_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 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.  |  |
+

data/docs/SignatureRequestCreateEmbeddedRequest.md

@@ -0,0 +1,31 @@
+# HelloSign::SignatureRequestCreateEmbeddedRequest
+
+Calls SignatureRequestSend in controller
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes.  |  |
+| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) |  Add Signers to your Signature Request.  |  |
+| `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] |
+| `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.  |  [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.  |  |
+| `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``` |  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] |
+| `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) |    |  |
+| `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 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_text_tags` | ```Boolean``` |  Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.  |  [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/SignatureRequestCreateEmbeddedWithTemplateRequest.md

@@ -0,0 +1,24 @@
+# HelloSign::SignatureRequestCreateEmbeddedWithTemplateRequest
+
+Calls SignatureRequestSend in controller
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `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 template will be used.  |  |
+| `client_id`<sup>*_required_</sup> | ```String``` |  Client id of the app you&#39;re using to create this embedded signature request. Used for security purposes.  |  |
+| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) |  Add Signers to your Templated-based Signature Request.  |  |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [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.  |  |
+| `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.  |  |
+| `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) |    |  |
+| `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 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/SignatureRequestGetResponse.md

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

data/docs/SignatureRequestListResponse.md

@@ -0,0 +1,12 @@
+# HelloSign::SignatureRequestListResponse
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signature_requests` | [```Array<SignatureRequestResponse>```](SignatureRequestResponse.md) |  Contains information about signature requests.  |  |
+| `list_info` | [```ListInfoResponse```](ListInfoResponse.md) |    |  |
+| `warnings` | [```Array<WarningResponse>```](WarningResponse.md) |  A list of warnings.  |  |
+

data/docs/SignatureRequestRemindRequest.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestRemindRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `email_address`<sup>*_required_</sup> | ```String``` |  The email address of the signer to send a reminder to.  |  |
+| `name` | ```String``` |  The name of the signer to send a reminder to. Include if two or more signers share an email address.  |  |
+

data/docs/SignatureRequestResponse.md

@@ -0,0 +1,31 @@
+# HelloSign::SignatureRequestResponse
+
+Contains information about a signature request.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `test_mode` | ```Boolean``` |  Whether this is a test signature request. Test requests have no legal value. Defaults to `false`.  |  [default to false] |
+| `signature_request_id` | ```String``` |  The id of the SignatureRequest.  |  |
+| `requester_email_address` | ```String``` |  The email address of the initiator of the SignatureRequest.  |  |
+| `title` | ```String``` |  The title the specified Account uses for the SignatureRequest.  |  |
+| `original_title` | ```String``` |  Default Label for account.  |  |
+| `subject` | ```String``` |  The subject in the email that was initially sent to the signers.  |  |
+| `message` | ```String``` |  The custom message in the email that was initially sent to the signers.  |  |
+| `metadata` | ```Object``` |  The metadata attached to the signature request.  |  |
+| `created_at` | ```Integer``` |  Time the signature request was created.  |  |
+| `is_complete` | ```Boolean``` |  Whether or not the SignatureRequest has been fully executed by all signers.  |  |
+| `is_declined` | ```Boolean``` |  Whether or not the SignatureRequest has been declined by a signer.  |  |
+| `has_error` | ```Boolean``` |  Whether or not an error occurred (either during the creation of the SignatureRequest or during one of the signings).  |  |
+| `files_url` | ```String``` |  The URL where a copy of the request's documents can be downloaded.  |  |
+| `signing_url` | ```String``` |  The URL where a signer, after authenticating, can sign the documents. This should only be used by users with existing HelloSign accounts as they will be required to log in before signing.  |  |
+| `details_url` | ```String``` |  The URL where the requester and the signers can view the current status of the SignatureRequest.  |  |
+| `cc_email_addresses` | ```Array<String>``` |  A list of email addresses that were CCed on the SignatureRequest. They will receive a copy of the final PDF once all the signers have signed.  |  |
+| `signing_redirect_url` | ```String``` |  The URL you want the signer redirected to after they successfully sign.  |  |
+| `template_ids` | ```Array<String>``` |  Templates IDs used in this SignatureRequest (if any).  |  |
+| `custom_fields` | [```Array<SignatureRequestResponseCustomFieldBase>```](SignatureRequestResponseCustomFieldBase.md) |  An array of Custom Field objects containing the name and type of each custom field.<br><br>* Text Field uses `SignatureRequestResponseCustomFieldText`<br>* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`  |  |
+| `attachments` | [```Array<SignatureRequestResponseAttachment>```](SignatureRequestResponseAttachment.md) |  Signer attachments.  |  |
+| `response_data` | [```Array<SignatureRequestResponseDataBase>```](SignatureRequestResponseDataBase.md) |  An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.  |  |
+| `signatures` | [```Array<SignatureRequestResponseSignatures>```](SignatureRequestResponseSignatures.md) |  An array of signature objects, 1 for each signer.  |  |
+

data/docs/SignatureRequestResponseAttachment.md

@@ -0,0 +1,15 @@
+# HelloSign::SignatureRequestResponseAttachment
+
+Signer attachments.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `id`<sup>*_required_</sup> | ```String``` |  The unique ID for this attachment.  |  |
+| `signer`<sup>*_required_</sup> | ```String``` |  The Signer this attachment is assigned to.  |  |
+| `name`<sup>*_required_</sup> | ```String``` |  The name of this attachment.  |  |
+| `required`<sup>*_required_</sup> | ```Boolean``` |  A boolean value denoting if this attachment is required.  |  |
+| `instructions` | ```String``` |  Instructions for Signer.  |  |
+| `uploaded_at` | ```Integer``` |  Timestamp when attachment was uploaded by Signer.  |  |
+

data/docs/SignatureRequestResponseCustomFieldBase.md

@@ -0,0 +1,17 @@
+# HelloSign::SignatureRequestResponseCustomFieldBase
+
+An array of Custom Field objects containing the name and type of each custom field.
+
+* Text Field uses `SignatureRequestResponseCustomFieldText`
+* Checkbox Field uses `SignatureRequestResponseCustomFieldCheckbox`
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type`<sup>*_required_</sup> | ```String``` |  The type of this Custom Field. Only &#39;text&#39; and &#39;checkbox&#39; are currently supported.  |  |
+| `name`<sup>*_required_</sup> | ```String``` |  The name of the Custom Field.  |  |
+| `required` | ```Boolean``` |  A boolean value denoting if this field is required.  |  |
+| `api_id` | ```String``` |  The unique ID for this field.  |  |
+| `editor` | ```String``` |  The name of the Role that is able to edit this field.  |  |
+

data/docs/SignatureRequestResponseCustomFieldCheckbox.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseCustomFieldCheckbox
+
+This class extends `SignatureRequestResponseCustomFieldBase`.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type`<sup>*_required_</sup> | ```String``` |  The type of this Custom Field. Only &#39;text&#39; and &#39;checkbox&#39; are currently supported.  |  [default to 'checkbox'] |
+| `value` | ```Boolean``` |  A true/false for checkbox fields  |  |
+

data/docs/SignatureRequestResponseCustomFieldText.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseCustomFieldText
+
+This class extends `SignatureRequestResponseCustomFieldBase`.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type`<sup>*_required_</sup> | ```String``` |  The type of this Custom Field. Only &#39;text&#39; and &#39;checkbox&#39; are currently supported.  |  [default to 'text'] |
+| `value` | ```String``` |  A text string for text fields  |  |
+

data/docs/SignatureRequestResponseCustomFieldTypeEnum.md

@@ -0,0 +1,9 @@
+# HelloSign::SignatureRequestResponseCustomFieldTypeEnum
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/SignatureRequestResponseData.md

@@ -0,0 +1,14 @@
+# HelloSign::SignatureRequestResponseData
+
+An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `api_id` | ```String``` |  The unique ID for this field.  |  |
+| `signature_id` | ```String``` |  The ID of the signature to which this response is linked.  |  |
+| `name` | ```String``` |  The name of the form field.  |  |
+| `required` | ```Boolean``` |  A boolean value denoting if this field is required.  |  |
+| `type` | ```String``` |    |  |
+

data/docs/SignatureRequestResponseDataBase.md

@@ -0,0 +1,14 @@
+# HelloSign::SignatureRequestResponseDataBase
+
+An array of form field objects containing the name, value, and type of each textbox or checkmark field filled in by the signers.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `api_id` | ```String``` |  The unique ID for this field.  |  |
+| `signature_id` | ```String``` |  The ID of the signature to which this response is linked.  |  |
+| `name` | ```String``` |  The name of the form field.  |  |
+| `required` | ```Boolean``` |  A boolean value denoting if this field is required.  |  |
+| `type` | ```String``` |    |  |
+

data/docs/SignatureRequestResponseDataTypeEnum.md

@@ -0,0 +1,9 @@
+# HelloSign::SignatureRequestResponseDataTypeEnum
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+

data/docs/SignatureRequestResponseDataValueCheckbox.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueCheckbox
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A yes/no checkbox  |  [default to 'checkbox'] |
+| `value` | ```Boolean``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueCheckboxMerge.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueCheckboxMerge
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A checkbox field that has default value set by the api  |  [default to 'checkbox-merge'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueDateSigned.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueDateSigned
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A date  |  [default to 'date_signed'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueDropdown.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueDropdown
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  An input field for dropdowns  |  [default to 'dropdown'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueInitials.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueInitials
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  An input field for initials  |  [default to 'initials'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueRadio.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueRadio
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  An input field for radios  |  [default to 'radio'] |
+| `value` | ```Boolean``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueSignature.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueSignature
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A signature input field  |  [default to 'signature'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueText.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueText
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A text input field  |  [default to 'text'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseDataValueTextMerge.md

@@ -0,0 +1,11 @@
+# HelloSign::SignatureRequestResponseDataValueTextMerge
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `type` | ```String``` |  A text field that has default text set by the api  |  [default to 'text-merge'] |
+| `value` | ```String``` |  The value of the form field.  |  |
+

data/docs/SignatureRequestResponseSignatures.md

@@ -0,0 +1,26 @@
+# HelloSign::SignatureRequestResponseSignatures
+
+An array of signature objects, 1 for each signer.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signature_id` | ```String``` |  Signature identifier.  |  |
+| `signer_email_address` | ```String``` |  The email address of the signer.  |  |
+| `signer_name` | ```String``` |  The name of the signer.  |  |
+| `signer_role` | ```String``` |  The role of the signer.  |  |
+| `order` | ```Integer``` |  If signer order is assigned this is the 0-based index for this signer.  |  |
+| `status_code` | ```String``` |  The current status of the signature. eg: awaiting_signature, signed, declined.  |  |
+| `decline_reason` | ```String``` |  The reason provided by the signer for declining the request.  |  |
+| `signed_at` | ```Integer``` |  Time that the document was signed or null.  |  |
+| `last_viewed_at` | ```Integer``` |  The time that the document was last viewed by this signer or null.  |  |
+| `last_reminded_at` | ```Integer``` |  The time the last reminder email was sent to the signer or null.  |  |
+| `has_pin` | ```Boolean``` |  Boolean to indicate whether this signature requires a PIN to access.  |  |
+| `has_sms_auth` | ```Boolean``` |  Boolean to indicate whether this signature has SMS authentication enabled.  |  |
+| `has_sms_delivery` | ```Boolean``` |  Boolean to indicate whether this signature has SMS delivery enabled.  |  |
+| `sms_phone_number` | ```String``` |  The SMS phone number used for authentication or signature request delivery.  |  |
+| `reassigned_by` | ```String``` |  Email address of original signer who reassigned to this signer.  |  |
+| `reassignment_reason` | ```String``` |  Reason provided by original signer who reassigned to this signer.  |  |
+| `error` | ```String``` |  Error message pertaining to this signer, or null.  |  |
+

data/docs/SignatureRequestSendRequest.md

@@ -0,0 +1,32 @@
+# HelloSign::SignatureRequestSendRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) |  Add Signers to your Signature Request.  |  |
+| `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] |
+| `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.  |  |
+| `client_id` | ```String``` |  The client id of the API App you want to associate with this request. 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``` |  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] |
+| `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) |    |  |
+| `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 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_text_tags` | ```Boolean``` |  Send with a value of `true` if you wish to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document. Defaults to disabled, or `false`.  |  [default to false] |
+

data/docs/SignatureRequestSendWithTemplateRequest.md

@@ -0,0 +1,25 @@
+# HelloSign::SignatureRequestSendWithTemplateRequest
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `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 template will be used.  |  |
+| `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) |  Add Signers to your Templated-based Signature Request.  |  |
+| `allow_decline` | ```Boolean``` |  Allows signers to decline to sign a document if `true`. Defaults to `false`.  |  [default to false] |
+| `ccs` | [```Array<SubCC>```](SubCC.md) |  Add CC email recipients. Required when a CC role exists for the Template.  |  |
+| `client_id` | ```String``` |  Client id of the app to associate with the signature request. Used to apply the branding and callback url defined for the app.  |  |
+| `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) |  An array defining values and options for custom fields. Required when a custom field exists in the Template.  |  |
+| `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.  |  |
+| `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] |
+| `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) |    |  |
+| `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 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.  |  |
+

data/docs/SignatureRequestUpdateRequest.md

@@ -0,0 +1,12 @@
+# HelloSign::SignatureRequestUpdateRequest
+
+
+
+## Properties
+
+| 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.  |  |
+| `name` | ```String``` |  The new name for the recipient.<br><br>**NOTE**: Optional if `email_address` is provided.  |  |
+

data/docs/SubAttachment.md

@@ -0,0 +1,13 @@
+# HelloSign::SubAttachment
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `name`<sup>*_required_</sup> | ```String``` |  The name of attachment.  |  |
+| `signer_index`<sup>*_required_</sup> | ```Integer``` |  The signer&#39;s index in the `signers` parameter (0-based indexing).<br><br>**NOTE**: Only one signer can be assigned per attachment.  |  |
+| `instructions` | ```String``` |  The instructions for uploading the attachment.  |  |
+| `required` | ```Boolean``` |  Determines if the attachment must be uploaded.  |  [default to false] |
+

data/docs/SubBulkSignerList.md

@@ -0,0 +1,11 @@
+# HelloSign::SubBulkSignerList
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `custom_fields` | [```Array<SubBulkSignerListCustomField>```](SubBulkSignerListCustomField.md) |  An array of custom field values.  |  |
+| `signers` | [```Array<SubSignatureRequestTemplateSigner>```](SubSignatureRequestTemplateSigner.md) |  Add Signers to your Templated-based Signature Request. Allows the requester to specify editor options when a preparing a document.<br><br>Currently only templates with a single role are supported. All signers must have the same `role` value.  |  |
+

data/docs/SubBulkSignerListCustomField.md

@@ -0,0 +1,11 @@
+# HelloSign::SubBulkSignerListCustomField
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `name`<sup>*_required_</sup> | ```String``` |  The name of the custom field. Must be the field&#39;s `name` or `api_id`.  |  |
+| `value`<sup>*_required_</sup> | ```String``` |  The value of the custom field.  |  |
+

data/docs/SubCC.md

@@ -0,0 +1,11 @@
+# HelloSign::SubCC
+
+
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `role`<sup>*_required_</sup> | ```String``` |  Must match an existing CC role in chosen Template(s). Multiple CC recipients cannot share the same CC role.  |  |
+| `email_address`<sup>*_required_</sup> | ```String``` |  The email address of the CC recipient.  |  |
+

data/docs/SubCustomField.md

@@ -0,0 +1,17 @@
+# HelloSign::SubCustomField
+
+When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests.
+
+Pre-filled data can be used with "send-once" 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.
+
+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.
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `name`<sup>*_required_</sup> | ```String``` |  The name of a custom field. When working with pre-filled data, the custom field&#39;s name must have a matching merge field name or the field will remain empty on the document during signing.  |  |
+| `editor` | ```String``` |  Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required &#x3D; true`.<br><br>**Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won&#39;t be editable.  |  |
+| `required` | ```Boolean``` |  Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.  |  [default to false] |
+| `value` | ```String``` |  The string that resolves (aka &quot;pre-fills&quot;) to the merge field on the final document(s) used for signing.  |  |
+

data/docs/SubEditorOptions.md

@@ -0,0 +1,11 @@
+# HelloSign::SubEditorOptions
+
+This allows the requester to specify editor options when a preparing a document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| `allow_edit_signers` | ```Boolean``` |  Allows requesters to edit the list of signers  |  [default to false] |
+| `allow_edit_documents` | ```Boolean``` |  Allows requesters to edit documents, including delete and add  |  [default to false] |
+