dropbox-sign 1.4.0 → 1.4.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (83) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -2
  3. data/README.md +4 -12
  4. data/VERSION +1 -1
  5. data/docs/EmbeddedEditUrlRequest.md +1 -1
  6. data/docs/SignatureRequestApi.md +7 -422
  7. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
  8. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
  9. data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
  10. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
  11. data/docs/SignatureRequestSendRequest.md +5 -5
  12. data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
  13. data/docs/SignatureRequestUpdateRequest.md +2 -2
  14. data/docs/SubAttachment.md +1 -1
  15. data/docs/SubCustomField.md +1 -1
  16. data/docs/SubFieldOptions.md +1 -1
  17. data/docs/SubFormFieldsPerDocumentBase.md +2 -2
  18. data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
  19. data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
  20. data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
  21. data/docs/SubFormFieldsPerDocumentText.md +2 -2
  22. data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
  23. data/docs/SubSignatureRequestGroupedSigners.md +1 -1
  24. data/docs/SubSignatureRequestSigner.md +1 -1
  25. data/docs/SubSignatureRequestTemplateSigner.md +1 -1
  26. data/docs/SubSigningOptions.md +1 -1
  27. data/docs/TeamAddMemberRequest.md +1 -1
  28. data/docs/TeamRemoveMemberRequest.md +2 -2
  29. data/docs/TemplateAddUserRequest.md +2 -2
  30. data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
  31. data/docs/TemplateCreateRequest.md +2 -2
  32. data/docs/TemplateResponseDocument.md +1 -1
  33. data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
  34. data/docs/UnclaimedDraftApi.md +3 -3
  35. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
  36. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
  37. data/docs/UnclaimedDraftCreateRequest.md +2 -2
  38. data/lib/dropbox-sign/api/signature_request_api.rb +14 -474
  39. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
  40. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
  41. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
  42. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
  43. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
  44. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
  45. data/lib/dropbox-sign/models/signature_request_send_request.rb +5 -5
  46. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +2 -2
  47. data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
  48. data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
  49. data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
  50. data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
  51. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
  52. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +1 -1
  53. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +1 -1
  54. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +1 -1
  55. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +2 -2
  56. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +1 -1
  57. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
  58. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
  59. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
  60. data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
  61. data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
  62. data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
  63. data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
  64. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
  65. data/lib/dropbox-sign/models/template_create_request.rb +2 -2
  66. data/lib/dropbox-sign/models/template_response_document.rb +1 -1
  67. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
  68. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
  69. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +3 -3
  70. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
  71. data/lib/dropbox-sign/version.rb +1 -1
  72. data/lib/dropbox-sign.rb +0 -4
  73. data/openapi-config.yaml +1 -1
  74. data/openapi-sdk.yaml +1487 -2511
  75. metadata +10 -18
  76. data/docs/SignatureRequestEditEmbeddedRequest.md +0 -33
  77. data/docs/SignatureRequestEditEmbeddedWithTemplateRequest.md +0 -24
  78. data/docs/SignatureRequestEditRequest.md +0 -35
  79. data/docs/SignatureRequestEditWithTemplateRequest.md +0 -26
  80. data/lib/dropbox-sign/models/signature_request_edit_embedded_request.rb +0 -593
  81. data/lib/dropbox-sign/models/signature_request_edit_embedded_with_template_request.rb +0 -490
  82. data/lib/dropbox-sign/models/signature_request_edit_request.rb +0 -612
  83. data/lib/dropbox-sign/models/signature_request_edit_with_template_request.rb +0 -509
@@ -12,15 +12,15 @@
12
12
  | `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
13
13
  | `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
14
14
  | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
15
- | `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] |
15
+ | `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] |
16
16
  | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
17
17
  | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
18
18
  | `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 Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | |
19
19
  | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
20
20
  | `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`. | |
21
21
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
- | `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] |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
+ | `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] |
24
24
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
25
25
  | `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. | |
26
26
  | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
@@ -28,6 +28,6 @@
28
28
  | `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] |
29
29
  | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
30
30
  | `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] |
31
- | `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] |
31
+ | `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] |
32
32
  | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
33
33
 
@@ -20,5 +20,5 @@
20
20
  | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
21
21
  | `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] |
22
22
  | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
23
- | `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] |
23
+ | `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] |
24
24
 
@@ -11,7 +11,7 @@
11
11
  | `signers` | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Add Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
12
12
  | `grouped_signers` | [```Array<SubSignatureRequestGroupedSigners>```](SubSignatureRequestGroupedSigners.md) | Add Grouped Signers to your Signature Request.<br><br>This endpoint requires either **signers** or **grouped_signers**, but not both. | |
13
13
  | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
14
- | `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] |
14
+ | `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] |
15
15
  | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
16
16
  | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
17
17
  | `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. | |
@@ -19,10 +19,10 @@
19
19
  | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
20
20
  | `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`. | |
21
21
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
- | `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] |
24
- | `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] |
25
- | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
+ | `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] |
24
+ | `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] |
25
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
26
26
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
27
27
  | `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. | |
28
28
  | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
@@ -14,8 +14,8 @@
14
14
  | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
15
15
  | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
16
16
  | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
17
- | `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] |
18
- | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
17
+ | `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] |
18
+ | `is_eid` | ```Boolean``` | Send with a value of `true` if you wish to enable [electronic identification (eID)](https://www.hellosign.com/features/electronic-id), which requires the signer to verify their identity with an eID provider to sign a document.&lt;br&gt;<br>**NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer. | [default to false] |
19
19
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
20
20
  | `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. | |
21
21
  | `signing_options` | [```SubSigningOptions```](SubSigningOptions.md) | | |
@@ -7,7 +7,7 @@
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `signature_id`<sup>*_required_</sup> | ```String``` | The signature ID for the recipient. | |
10
- | `email_address` | ```String``` | The new email address for the recipient.<br><br>This will generate a new `signature_id` value.<br><br>**NOTE**: Optional if `name` is provided. | |
11
- | `name` | ```String``` | The new name for the recipient.<br><br>**NOTE**: Optional if `email_address` is provided. | |
10
+ | `email_address` | ```String``` | The new email address for the recipient.<br><br>This will generate a new `signature_id` value.<br><br>**NOTE:** Optional if `name` is provided. | |
11
+ | `name` | ```String``` | The new name for the recipient.<br><br>**NOTE:** Optional if `email_address` is provided. | |
12
12
  | `expires_at` | ```Integer``` | The new time when the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details. | |
13
13
 
@@ -7,7 +7,7 @@
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `name`<sup>*_required_</sup> | ```String``` | The name of attachment. | |
10
- | `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. | |
10
+ | `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. | |
11
11
  | `instructions` | ```String``` | The instructions for uploading the attachment. | |
12
12
  | `required` | ```Boolean``` | Determines if the attachment must be uploaded. | [default to false] |
13
13
 
@@ -11,7 +11,7 @@ For using pre-filled on repeatable signature requests, merge fields are added to
11
11
  | Name | Type | Description | Notes |
12
12
  | ---- | ---- | ----------- | ----- |
13
13
  | `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. | |
14
- | `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. | |
14
+ | `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. | |
15
15
  | `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] |
16
16
  | `value` | ```String``` | The string that resolves (aka &quot;pre-fills&quot;) to the merge field on the final document(s) used for signing. | |
17
17
 
@@ -6,5 +6,5 @@ This allows the requester to specify field options for a signature request.
6
6
 
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
- | `date_format`<sup>*_required_</sup> | ```String``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))<br><br>**Note**: Only available for Premium and higher. | |
9
+ | `date_format`<sup>*_required_</sup> | ```String``` | Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats))<br><br>**NOTE:** Only available for Premium and higher. | |
10
10
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
4
4
 
5
- **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.
5
+ **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.
6
6
 
7
7
  * Text Field use `SubFormFieldsPerDocumentText`
8
8
  * Dropdown Field use `SubFormFieldsPerDocumentDropdown`
@@ -23,7 +23,7 @@ The fields that should appear on the document, expressed as an array of objects.
23
23
  | `api_id`<sup>*_required_</sup> | ```String``` | An identifier for the field that is unique across all documents in the request. | |
24
24
  | `height`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
25
25
  | `required`<sup>*_required_</sup> | ```Boolean``` | Whether this field is required. | |
26
- | `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE**: To set the value of the field as the preparer you must set this to `me_now`<br><br>**NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | |
26
+ | `signer`<sup>*_required_</sup> | ```String``` | Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field.<br><br>**NOTE:** To set the value of the field as the preparer you must set this to `me_now`<br><br>**NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data. | |
27
27
  | `type`<sup>*_required_</sup> | ```String``` | | |
28
28
  | `width`<sup>*_required_</sup> | ```Integer``` | Size of the field in pixels. | |
29
29
  | `x`<sup>*_required_</sup> | ```Integer``` | Location coordinates of the field in pixels. | |
@@ -8,5 +8,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type`<sup>*_required_</sup> | ```String``` | A date. Use the `SubFormFieldsPerDocumentDateSigned` class. | [default to 'date_signed'] |
10
10
  | `font_family` | ```String``` | Font family for the field. | |
11
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
11
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
12
12
 
@@ -10,5 +10,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
10
10
  | `options`<sup>*_required_</sup> | ```Array<String>``` | Array of string values representing dropdown values. | |
11
11
  | `content` | ```String``` | Selected value in `options` array. Value must exist in array. | |
12
12
  | `font_family` | ```String``` | Font family for the field. | |
13
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
13
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
14
14
 
@@ -10,5 +10,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
10
10
  | `content`<sup>*_required_</sup> | ```String``` | Link Text. | |
11
11
  | `content_url`<sup>*_required_</sup> | ```String``` | Link URL. | |
12
12
  | `font_family` | ```String``` | Font family for the field. | |
13
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
13
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
14
14
 
@@ -11,10 +11,10 @@ This class extends `SubFormFieldsPerDocumentBase`.
11
11
  | `auto_fill_type` | ```String``` | Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values. | |
12
12
  | `link_id` | ```String``` | Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields. | |
13
13
  | `masked` | ```Boolean``` | Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`. | |
14
- | `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE**: When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | |
14
+ | `validation_type` | ```String``` | Each text field may contain a `validation_type` parameter. Check out the list of [validation types](https://faq.hellosign.com/hc/en-us/articles/217115577) to learn more about the possible values.<br><br>**NOTE:** When using `custom_regex` you are required to pass a second parameter `validation_custom_regex` and you can optionally provide `validation_custom_regex_format_label` for the error message the user will see in case of an invalid value. | |
15
15
  | `validation_custom_regex` | ```String``` | | |
16
16
  | `validation_custom_regex_format_label` | ```String``` | | |
17
17
  | `content` | ```String``` | Content of a `me_now` text field | |
18
18
  | `font_family` | ```String``` | Font family for the field. | |
19
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
19
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
20
20
 
@@ -8,5 +8,5 @@ This class extends `SubFormFieldsPerDocumentBase`.
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `type`<sup>*_required_</sup> | ```String``` | A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class. | [default to 'text-merge'] |
10
10
  | `font_family` | ```String``` | Font family for the field. | |
11
- | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
11
+ | `font_size` | ```Integer``` | The initial px font size for the field contents. Can be any integer value between `7` and `49`.<br><br>**NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field. | [default to 12] |
12
12
 
@@ -7,6 +7,6 @@
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `group`<sup>*_required_</sup> | ```String``` | The name of the group. | |
10
- | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Signers belonging to this Group.<br><br>**NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | |
10
+ | `signers`<sup>*_required_</sup> | [```Array<SubSignatureRequestSigner>```](SubSignatureRequestSigner.md) | Signers belonging to this Group.<br><br>**NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below. | |
11
11
  | `order` | ```Integer``` | The order the group is required to sign in. Use this instead of Signer-level `order`. | |
12
12
 
@@ -10,6 +10,6 @@
10
10
  | `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
11
11
  | `order` | ```Integer``` | The order the signer is required to sign in. | |
12
12
  | `pin` | ```String``` | The 4- to 12-character access code that will secure this signer&#39;s signature page. | |
13
- | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
13
+ | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**NOTE:** Not available in test mode and requires a Standard plan or higher. | |
14
14
  | `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
15
15
 
@@ -10,6 +10,6 @@
10
10
  | `name`<sup>*_required_</sup> | ```String``` | The name of the signer. | |
11
11
  | `email_address`<sup>*_required_</sup> | ```String``` | The email address of the signer. | |
12
12
  | `pin` | ```String``` | The 4- to 12-character access code that will secure this signer&#39;s signature page. | |
13
- | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**Note**: Not available in test mode and requires a Standard plan or higher. | |
13
+ | `sms_phone_number` | ```String``` | An E.164 formatted phone number.<br><br>By using the feature, you agree you are responsible for obtaining a signer&#39;s consent to receive text messages from Dropbox Sign related to this signature request and confirm you have obtained such consent from all signers prior to enabling SMS delivery for this signature request. [Learn more](https://faq.hellosign.com/hc/en-us/articles/15815316468877-Dropbox-Sign-SMS-tools-add-on).<br><br>**NOTE:** Not available in test mode and requires a Standard plan or higher. | |
14
14
  | `sms_phone_number_type` | ```String``` | Specifies the feature used with the `sms_phone_number`. Default `authentication`.<br><br>If `authentication`, signer is sent a verification code via SMS that is required to access the document.<br><br>If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email). | |
15
15
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  This allows the requester to specify the types allowed for creating a signature.
4
4
 
5
- **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
5
+ **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
6
6
 
7
7
  ## Properties
8
8
 
@@ -8,5 +8,5 @@
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `account_id` | ```String``` | `account_id` or `email_address` is required. If both are provided, the account id prevails.<br><br>Account id of the user to invite to your Team. | |
10
10
  | `email_address` | ```String``` | `account_id` or `email_address` is required, If both are provided, the account id prevails.<br><br>Email address of the user to invite to your Team. | |
11
- | `role` | ```String``` | A role member will take in a new Team.<br><br>**Note**: This parameter is used only if `team_id` is provided. | |
11
+ | `role` | ```String``` | A role member will take in a new Team.<br><br>**NOTE:** This parameter is used only if `team_id` is provided. | |
12
12
 
@@ -8,7 +8,7 @@
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `account_id` | ```String``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.<br><br>Account id to remove from your Team. | |
10
10
  | `email_address` | ```String``` | **account_id** or **email_address** is required. If both are provided, the account id prevails.<br><br>Email address of the Account to remove from your Team. | |
11
- | `new_owner_email_address` | ```String``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.<br><br>**Note**: Only available for Enterprise plans. | |
11
+ | `new_owner_email_address` | ```String``` | The email address of an Account on this Team to receive all documents, templates, and API apps (if applicable) from the removed Account. If not provided, and on an Enterprise plan, this data will remain with the removed Account.<br><br>**NOTE:** Only available for Enterprise plans. | |
12
12
  | `new_team_id` | ```String``` | Id of the new Team. | |
13
- | `new_role` | ```String``` | A new role member will take in a new Team.<br><br>**Note**: This parameter is used only if `new_team_id` is provided. | |
13
+ | `new_role` | ```String``` | A new role member will take in a new Team.<br><br>**NOTE:** This parameter is used only if `new_team_id` is provided. | |
14
14
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
- | `account_id` | ```String``` | The id of the Account to give access to the Template. &lt;b&gt;Note&lt;/b&gt; The account id prevails if email address is also provided. | |
10
- | `email_address` | ```String``` | The email address of the Account to give access to the Template. &lt;b&gt;Note&lt;/b&gt; The account id prevails if it is also provided. | |
9
+ | `account_id` | ```String``` | The id of the Account to give access to the Template.<br>**NOTE:** The account id prevails if email address is also provided. | |
10
+ | `email_address` | ```String``` | The email address of the Account to give access to the Template.<br>**NOTE:** The account id prevails if it is also provided. | |
11
11
  | `skip_notification` | ```Boolean``` | If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`. | [default to false] |
12
12
 
@@ -10,7 +10,7 @@
10
10
  | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
11
11
  | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
12
12
  | `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] |
13
- | `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] |
13
+ | `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] |
14
14
  | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
15
15
  | `cc_roles` | ```Array<String>``` | The CC roles that must be assigned when using the template to send a signature request | |
16
16
  | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | |
@@ -19,7 +19,7 @@
19
19
  | `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the template subject and message. | [default to false] |
20
20
  | `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`. | |
21
21
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
22
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
22
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
23
23
  | `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. | |
24
24
  | `message` | ```String``` | The default template email message. | |
25
25
  | `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. | |
@@ -6,11 +6,11 @@
6
6
 
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
- | `form_fields_per_document`<sup>*_required_</sup> | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
9
+ | `form_fields_per_document`<sup>*_required_</sup> | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
10
10
  | `signer_roles`<sup>*_required_</sup> | [```Array<SubTemplateRole>```](SubTemplateRole.md) | An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template. | |
11
11
  | `files` | ```Array<File>``` | Use `files[]` to indicate the uploaded file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
12
12
  | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
13
- | `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] |
13
+ | `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] |
14
14
  | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
15
15
  | `cc_roles` | ```Array<String>``` | The CC roles that must be assigned when using the template to send a signature request | |
16
16
  | `client_id` | ```String``` | Client id of the app you&#39;re using to create this draft. Used to apply the branding and callback url defined for the app. | |
@@ -11,5 +11,5 @@
11
11
  | `field_groups` | [```Array<TemplateResponseDocumentFieldGroup>```](TemplateResponseDocumentFieldGroup.md) | An array of Form Field Group objects. | |
12
12
  | `form_fields` | [```Array<TemplateResponseDocumentFormFieldBase>```](TemplateResponseDocumentFormFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
13
13
  | `custom_fields` | [```Array<TemplateResponseDocumentCustomFieldBase>```](TemplateResponseDocumentCustomFieldBase.md) | An array of Form Field objects containing the name and type of each named field. | |
14
- | `static_fields` | [```Array<TemplateResponseDocumentStaticFieldBase>```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **Note** only available for certain subscriptions. | |
14
+ | `static_fields` | [```Array<TemplateResponseDocumentStaticFieldBase>```](TemplateResponseDocumentStaticFieldBase.md) | An array describing static overlay fields. **NOTE:** Only available for certain subscriptions. | |
15
15
 
@@ -1,6 +1,6 @@
1
1
  # Dropbox::Sign::TemplateResponseDocumentStaticFieldBase
2
2
 
3
- An array describing static overlay fields. **Note** only available for certain subscriptions.
3
+ An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.
4
4
 
5
5
  ## Properties
6
6
 
@@ -124,7 +124,7 @@ end
124
124
 
125
125
  Create Embedded Unclaimed Draft
126
126
 
127
- 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 Dropbox Sign.
127
+ 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 Dropbox Sign.
128
128
 
129
129
  ### Examples
130
130
 
@@ -200,7 +200,7 @@ end
200
200
 
201
201
  Create Embedded Unclaimed Draft with Template
202
202
 
203
- 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 Dropbox Sign.
203
+ 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 Dropbox Sign.
204
204
 
205
205
  ### Examples
206
206
 
@@ -287,7 +287,7 @@ end
287
287
 
288
288
  Edit and Resend Unclaimed Draft
289
289
 
290
- 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 Dropbox Sign.
290
+ 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 Dropbox Sign.
291
291
 
292
292
  ### Examples
293
293
 
@@ -12,7 +12,7 @@
12
12
  | `file_urls` | ```Array<String>``` | Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature.<br><br>This endpoint requires either **files** or **file_urls[]**, but not both. | |
13
13
  | `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] |
14
14
  | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
15
- | `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] |
15
+ | `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] |
16
16
  | `attachments` | [```Array<SubAttachment>```](SubAttachment.md) | A list describing the attachments | |
17
17
  | `cc_email_addresses` | ```Array<String>``` | The email addresses that should be CCed. | |
18
18
  | `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 Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template. | |
@@ -22,7 +22,7 @@
22
22
  | `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the subject and message. | [default to false] |
23
23
  | `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`. | |
24
24
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
25
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
25
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
26
26
  | `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] |
27
27
  | `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] |
28
28
  | `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] |
@@ -40,6 +40,6 @@
40
40
  | `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'] |
41
41
  | `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] |
42
42
  | `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] |
43
- | `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] |
44
- | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.<br><br>**Note**: This does not correspond to the **expires_at** returned in the response. | |
43
+ | `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] |
44
+ | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |
45
45
 
@@ -10,7 +10,7 @@
10
10
  | `requester_email_address`<sup>*_required_</sup> | ```String``` | The email address of the user that should be designated as the requester of this draft. | |
11
11
  | `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. | |
12
12
  | `allow_decline` | ```Boolean``` | Allows signers to decline to sign a document if `true`. Defaults to `false`. | [default to false] |
13
- | `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] |
13
+ | `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] |
14
14
  | `ccs` | [```Array<SubCC>```](SubCC.md) | Add CC email recipients. Required when a CC role exists for the Template. | |
15
15
  | `custom_fields` | [```Array<SubCustomField>```](SubCustomField.md) | An array defining values and options for custom fields. Required when a custom field exists in the Template. | |
16
16
  | `editor_options` | [```SubEditorOptions```](SubEditorOptions.md) | | |
@@ -23,7 +23,7 @@
23
23
  | `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] |
24
24
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
25
25
  | `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. | |
26
- | `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] |
26
+ | `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] |
27
27
  | `requesting_redirect_url` | ```String``` | The URL you want signers redirected to after they successfully request a signature. | |
28
28
  | `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] |
29
29
  | `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] |
@@ -34,6 +34,6 @@
34
34
  | `subject` | ```String``` | The subject in the email that will be sent to the signers. | |
35
35
  | `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] |
36
36
  | `title` | ```String``` | The title you want to assign to the SignatureRequest. | |
37
- | `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] |
37
+ | `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] |
38
38
  | `allow_ccs` | ```Boolean``` | This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft. | [default to false] |
39
39
 
@@ -17,7 +17,7 @@
17
17
  | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
18
18
  | `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`. | |
19
19
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
20
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
20
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)<br><br>**NOTE:** Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
21
21
  | `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] |
22
22
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
23
23
  | `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. | |
@@ -29,5 +29,5 @@
29
29
  | `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] |
30
30
  | `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] |
31
31
  | `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] |
32
- | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.<br><br>**Note**: This does not correspond to the **expires_at** returned in the response. | |
32
+ | `expires_at` | ```Integer``` | When the signature request will expire. Unsigned signatures will be moved to the expired status, and no longer signable. See [Signature Request Expiration Date](https://developers.hellosign.com/docs/signature-request/expiration/) for details.<br><br>**NOTE:** This does not correspond to the **expires_at** returned in the response. | |
33
33