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
@@ -132,7 +132,7 @@ module Dropbox::Sign
132
132
  end
133
133
 
134
134
  # Create Embedded Unclaimed Draft
135
- # 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.
135
+ # 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.
136
136
  # @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
137
137
  # @param [Hash] opts the optional parameters
138
138
  # @return [UnclaimedDraftCreateResponse]
@@ -142,7 +142,7 @@ module Dropbox::Sign
142
142
  end
143
143
 
144
144
  # Create Embedded Unclaimed Draft
145
- # 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.
145
+ # 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.
146
146
  # @param unclaimed_draft_create_embedded_request [UnclaimedDraftCreateEmbeddedRequest]
147
147
  # @param [Hash] opts the optional parameters
148
148
  # @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
@@ -241,7 +241,7 @@ module Dropbox::Sign
241
241
  end
242
242
 
243
243
  # Create Embedded Unclaimed Draft with Template
244
- # 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.
244
+ # 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.
245
245
  # @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
246
246
  # @param [Hash] opts the optional parameters
247
247
  # @return [UnclaimedDraftCreateResponse]
@@ -251,7 +251,7 @@ module Dropbox::Sign
251
251
  end
252
252
 
253
253
  # Create Embedded Unclaimed Draft with Template
254
- # 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 \&quot;Request signature\&quot; page with the Draft loaded. Subsequent access to the claim URL will result in a &#x60;404&#x60;. For this embedded endpoint the &#x60;requester_email_address&#x60; 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.
254
+ # 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 \&quot;Request signature\&quot; page with the Draft loaded. Subsequent access to the claim URL will result in a &#x60;404&#x60;. For this embedded endpoint the &#x60;requester_email_address&#x60; 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.
255
255
  # @param unclaimed_draft_create_embedded_with_template_request [UnclaimedDraftCreateEmbeddedWithTemplateRequest]
256
256
  # @param [Hash] opts the optional parameters
257
257
  # @return [Array<(UnclaimedDraftCreateResponse, Integer, Hash)>] UnclaimedDraftCreateResponse data, response status code and response headers
@@ -350,7 +350,7 @@ module Dropbox::Sign
350
350
  end
351
351
 
352
352
  # Edit and Resend Unclaimed Draft
353
- # 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.
353
+ # 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.
354
354
  # @param signature_request_id [String] The ID of the signature request to edit and resend.
355
355
  # @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
356
356
  # @param [Hash] opts the optional parameters
@@ -361,7 +361,7 @@ module Dropbox::Sign
361
361
  end
362
362
 
363
363
  # Edit and Resend Unclaimed Draft
364
- # Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter &#x60;test_mode&#x60; can be edited prior to request. Signers can be edited in embedded editor. Requester&#39;s email address will remain unchanged if &#x60;requester_email_address&#x60; 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.
364
+ # Creates a new signature request from an embedded request that can be edited prior to being sent to the recipients. Parameter &#x60;test_mode&#x60; can be edited prior to request. Signers can be edited in embedded editor. Requester&#39;s email address will remain unchanged if &#x60;requester_email_address&#x60; 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.
365
365
  # @param signature_request_id [String] The ID of the signature request to edit and resend.
366
366
  # @param unclaimed_draft_edit_and_resend_request [UnclaimedDraftEditAndResendRequest]
367
367
  # @param [Hash] opts the optional parameters
@@ -41,7 +41,7 @@ module Dropbox::Sign
41
41
  # @return [Array<SubMergeField>]
42
42
  attr_accessor :merge_fields
43
43
 
44
- # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **Note**: This parameter overwrites `show_preview=true` (if set).
44
+ # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). **NOTE:** This parameter overwrites `show_preview=true` (if set).
45
45
  # @return [Boolean]
46
46
  attr_accessor :preview_only
47
47
 
@@ -26,7 +26,7 @@ module Dropbox::Sign
26
26
  # @return [String]
27
27
  attr_accessor :client_id
28
28
 
29
- # `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: - `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's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer'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). **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
29
+ # `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: - `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's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer'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). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
30
30
  # @return [File]
31
31
  attr_accessor :signer_file
32
32
 
@@ -22,7 +22,7 @@ module Dropbox::Sign
22
22
  # @return [Array<String>]
23
23
  attr_accessor :template_ids
24
24
 
25
- # `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: - `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's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer'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). **Note**: Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
25
+ # `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: - `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's signature page (optional) - `sms_phone_number`: An E.164 formatted phone number that will receive a code via SMS to access this signer's signature page. (optional) By using the feature, you agree you are responsible for obtaining a signer'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). **NOTE:** Not available in test mode and requires a Standard plan or higher. - `*_field`: any column with a _field\" suffix will be treated as a custom field (optional) You may only specify field values here, any other options should be set in the custom_fields request parameter. Example CSV: ``` name, email_address, pin, company_field George, george@example.com, d79a3td, ABC Corp Mary, mary@example.com, gd9as5b, 123 LLC ```
26
26
  # @return [File]
27
27
  attr_accessor :signer_file
28
28
 
@@ -42,7 +42,7 @@ module Dropbox::Sign
42
42
  # @return [Boolean]
43
43
  attr_accessor :allow_decline
44
44
 
45
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan.
45
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan.
46
46
  # @return [Boolean]
47
47
  attr_accessor :allow_reassign
48
48
 
@@ -69,11 +69,11 @@ module Dropbox::Sign
69
69
  # @return [Array<SubFormFieldRule>]
70
70
  attr_accessor :form_field_rules
71
71
 
72
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
72
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
73
73
  # @return [Array<SubFormFieldsPerDocumentBase>]
74
74
  attr_accessor :form_fields_per_document
75
75
 
76
- # Enables automatic Text Tag removal when set to true. **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.
76
+ # Enables automatic Text Tag removal when set to true. **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.
77
77
  # @return [Boolean]
78
78
  attr_accessor :hide_text_tags
79
79
 
@@ -104,7 +104,7 @@ module Dropbox::Sign
104
104
  # @return [Boolean]
105
105
  attr_accessor :use_text_tags
106
106
 
107
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
107
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
108
108
  # @return [Boolean]
109
109
  attr_accessor :populate_auto_fill_fields
110
110
 
@@ -73,7 +73,7 @@ module Dropbox::Sign
73
73
  # @return [String]
74
74
  attr_accessor :title
75
75
 
76
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
76
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
77
77
  # @return [Boolean]
78
78
  attr_accessor :populate_auto_fill_fields
79
79
 
@@ -38,7 +38,7 @@ module Dropbox::Sign
38
38
  # @return [Boolean]
39
39
  attr_accessor :allow_decline
40
40
 
41
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
41
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
42
42
  # @return [Boolean]
43
43
  attr_accessor :allow_reassign
44
44
 
@@ -69,19 +69,19 @@ module Dropbox::Sign
69
69
  # @return [Array<SubFormFieldRule>]
70
70
  attr_accessor :form_field_rules
71
71
 
72
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
72
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
73
73
  # @return [Array<SubFormFieldsPerDocumentBase>]
74
74
  attr_accessor :form_fields_per_document
75
75
 
76
- # Enables automatic Text Tag removal when set to true. **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.
76
+ # Enables automatic Text Tag removal when set to true. **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.
77
77
  # @return [Boolean]
78
78
  attr_accessor :hide_text_tags
79
79
 
80
- # 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's identity.<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.
80
+ # 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's identity.<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.
81
81
  # @return [Boolean]
82
82
  attr_accessor :is_qualified_signature
83
83
 
84
- # 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.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
84
+ # 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.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
85
85
  # @return [Boolean]
86
86
  attr_accessor :is_eid
87
87
 
@@ -50,11 +50,11 @@ module Dropbox::Sign
50
50
  # @return [Array<String>]
51
51
  attr_accessor :file_urls
52
52
 
53
- # 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's identity.<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.
53
+ # 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's identity.<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.
54
54
  # @return [Boolean]
55
55
  attr_accessor :is_qualified_signature
56
56
 
57
- # 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.<br> **Note**: eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
57
+ # 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.<br> **NOTE:** eID is only available on the Premium API plan. Cannot be used in `test_mode`. Only works on requests with one signer.
58
58
  # @return [Boolean]
59
59
  attr_accessor :is_eid
60
60
 
@@ -22,11 +22,11 @@ module Dropbox::Sign
22
22
  # @return [String]
23
23
  attr_accessor :signature_id
24
24
 
25
- # The new email address for the recipient. This will generate a new `signature_id` value. **NOTE**: Optional if `name` is provided.
25
+ # The new email address for the recipient. This will generate a new `signature_id` value. **NOTE:** Optional if `name` is provided.
26
26
  # @return [String]
27
27
  attr_accessor :email_address
28
28
 
29
- # The new name for the recipient. **NOTE**: Optional if `email_address` is provided.
29
+ # The new name for the recipient. **NOTE:** Optional if `email_address` is provided.
30
30
  # @return [String]
31
31
  attr_accessor :name
32
32
 
@@ -22,7 +22,7 @@ module Dropbox::Sign
22
22
  # @return [String]
23
23
  attr_accessor :name
24
24
 
25
- # The signer's index in the `signers` parameter (0-based indexing). **NOTE**: Only one signer can be assigned per attachment.
25
+ # The signer's index in the `signers` parameter (0-based indexing). **NOTE:** Only one signer can be assigned per attachment.
26
26
  # @return [Integer]
27
27
  attr_accessor :signer_index
28
28
 
@@ -23,7 +23,7 @@ module Dropbox::Sign
23
23
  # @return [String]
24
24
  attr_accessor :name
25
25
 
26
- # 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 = true`. **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't be editable.
26
+ # 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 = true`. **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't be editable.
27
27
  # @return [String]
28
28
  attr_accessor :editor
29
29
 
@@ -19,7 +19,7 @@ end
19
19
  module Dropbox::Sign
20
20
  # This allows the requester to specify field options for a signature request.
21
21
  class SubFieldOptions
22
- # Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **Note**: Only available for Premium and higher.
22
+ # Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **NOTE:** Only available for Premium and higher.
23
23
  # @return [String]
24
24
  attr_accessor :date_format
25
25
 
@@ -17,7 +17,7 @@ module Dropbox
17
17
  end
18
18
 
19
19
  module Dropbox::Sign
20
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
20
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
21
21
  class SubFormFieldsPerDocumentBase
22
22
  # Represents the integer index of the `file` or `file_url` document the field should be attached to.
23
23
  # @return [Integer]
@@ -35,7 +35,7 @@ module Dropbox::Sign
35
35
  # @return [Boolean]
36
36
  attr_accessor :required
37
37
 
38
- # Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE**: To set the value of the field as the preparer you must set this to `me_now` **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
38
+ # Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE:** To set the value of the field as the preparer you must set this to `me_now` **NOTE:** If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
39
39
  # @return [Integer, String]
40
40
  attr_accessor :signer
41
41
 
@@ -27,7 +27,7 @@ module Dropbox::Sign
27
27
  # @return [String]
28
28
  attr_accessor :font_family
29
29
 
30
- # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
30
+ # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
31
31
  # @return [Integer]
32
32
  attr_accessor :font_size
33
33
 
@@ -35,7 +35,7 @@ module Dropbox::Sign
35
35
  # @return [String]
36
36
  attr_accessor :font_family
37
37
 
38
- # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
38
+ # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
39
39
  # @return [Integer]
40
40
  attr_accessor :font_size
41
41
 
@@ -35,7 +35,7 @@ module Dropbox::Sign
35
35
  # @return [String]
36
36
  attr_accessor :font_family
37
37
 
38
- # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
38
+ # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
39
39
  # @return [Integer]
40
40
  attr_accessor :font_size
41
41
 
@@ -39,7 +39,7 @@ module Dropbox::Sign
39
39
  # @return [Boolean]
40
40
  attr_accessor :masked
41
41
 
42
- # 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. **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.
42
+ # 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. **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.
43
43
  # @return [String]
44
44
  attr_accessor :validation_type
45
45
 
@@ -57,7 +57,7 @@ module Dropbox::Sign
57
57
  # @return [String]
58
58
  attr_accessor :font_family
59
59
 
60
- # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
60
+ # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
61
61
  # @return [Integer]
62
62
  attr_accessor :font_size
63
63
 
@@ -27,7 +27,7 @@ module Dropbox::Sign
27
27
  # @return [String]
28
28
  attr_accessor :font_family
29
29
 
30
- # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE**: Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
30
+ # The initial px font size for the field contents. Can be any integer value between `7` and `49`. **NOTE:** Font size may be reduced during processing in order to fit the contents within the dimensions of the field.
31
31
  # @return [Integer]
32
32
  attr_accessor :font_size
33
33
 
@@ -22,7 +22,7 @@ module Dropbox::Sign
22
22
  # @return [String]
23
23
  attr_accessor :group
24
24
 
25
- # Signers belonging to this Group. **NOTE**: Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
25
+ # Signers belonging to this Group. **NOTE:** Only `name`, `email_address`, and `pin` are available to Grouped Signers. We will ignore all other properties, even though they are listed below.
26
26
  # @return [Array<SubSignatureRequestSigner>]
27
27
  attr_accessor :signers
28
28
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [String]
35
35
  attr_accessor :pin
36
36
 
37
- # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer'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). **Note**: Not available in test mode and requires a Standard plan or higher.
37
+ # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer'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). **NOTE:** Not available in test mode and requires a Standard plan or higher.
38
38
  # @return [String]
39
39
  attr_accessor :sms_phone_number
40
40
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [String]
35
35
  attr_accessor :pin
36
36
 
37
- # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer'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). **Note**: Not available in test mode and requires a Standard plan or higher.
37
+ # An E.164 formatted phone number. By using the feature, you agree you are responsible for obtaining a signer'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). **NOTE:** Not available in test mode and requires a Standard plan or higher.
38
38
  # @return [String]
39
39
  attr_accessor :sms_phone_number
40
40
 
@@ -17,7 +17,7 @@ module Dropbox
17
17
  end
18
18
 
19
19
  module Dropbox::Sign
20
- # This allows the requester to specify the types allowed for creating a signature. **Note**: If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
20
+ # This allows the requester to specify the types allowed for creating a signature. **NOTE:** If `signing_options` are not defined in the request, the allowed types will default to those specified in the account settings.
21
21
  class SubSigningOptions
22
22
  # The default type shown (limited to the listed types)
23
23
  # @return [String]
@@ -26,7 +26,7 @@ module Dropbox::Sign
26
26
  # @return [String]
27
27
  attr_accessor :email_address
28
28
 
29
- # A role member will take in a new Team. **Note**: This parameter is used only if `team_id` is provided.
29
+ # A role member will take in a new Team. **NOTE:** This parameter is used only if `team_id` is provided.
30
30
  # @return [String]
31
31
  attr_accessor :role
32
32
 
@@ -26,7 +26,7 @@ module Dropbox::Sign
26
26
  # @return [String]
27
27
  attr_accessor :email_address
28
28
 
29
- # 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. **Note**: Only available for Enterprise plans.
29
+ # 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. **NOTE:** Only available for Enterprise plans.
30
30
  # @return [String]
31
31
  attr_accessor :new_owner_email_address
32
32
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [String]
35
35
  attr_accessor :new_team_id
36
36
 
37
- # A new role member will take in a new Team. **Note**: This parameter is used only if `new_team_id` is provided.
37
+ # A new role member will take in a new Team. **NOTE:** This parameter is used only if `new_team_id` is provided.
38
38
  # @return [String]
39
39
  attr_accessor :new_role
40
40
 
@@ -18,11 +18,11 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TemplateAddUserRequest
21
- # The id of the Account to give access to the Template. <b>Note</b> The account id prevails if email address is also provided.
21
+ # The id of the Account to give access to the Template. **NOTE:** The account id prevails if email address is also provided.
22
22
  # @return [String]
23
23
  attr_accessor :account_id
24
24
 
25
- # The email address of the Account to give access to the Template. <b>Note</b> The account id prevails if it is also provided.
25
+ # The email address of the Account to give access to the Template. **NOTE:** The account id prevails if it is also provided.
26
26
  # @return [String]
27
27
  attr_accessor :email_address
28
28
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [Boolean]
35
35
  attr_accessor :allow_ccs
36
36
 
37
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
37
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
38
38
  # @return [Boolean]
39
39
  attr_accessor :allow_reassign
40
40
 
@@ -68,7 +68,7 @@ module Dropbox::Sign
68
68
  # @return [Array<SubFormFieldRule>]
69
69
  attr_accessor :form_field_rules
70
70
 
71
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
71
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
72
72
  # @return [Array<SubFormFieldsPerDocumentBase>]
73
73
  attr_accessor :form_fields_per_document
74
74
 
@@ -18,7 +18,7 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TemplateCreateRequest
21
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
21
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
22
22
  # @return [Array<SubFormFieldsPerDocumentBase>]
23
23
  attr_accessor :form_fields_per_document
24
24
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [Array<String>]
35
35
  attr_accessor :file_urls
36
36
 
37
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
37
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
38
38
  # @return [Boolean]
39
39
  attr_accessor :allow_reassign
40
40
 
@@ -38,7 +38,7 @@ module Dropbox::Sign
38
38
  # @return [Array<TemplateResponseDocumentCustomFieldBase>]
39
39
  attr_accessor :custom_fields
40
40
 
41
- # An array describing static overlay fields. **Note** only available for certain subscriptions.
41
+ # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.
42
42
  # @return [Array<TemplateResponseDocumentStaticFieldBase>, nil]
43
43
  attr_accessor :static_fields
44
44
 
@@ -17,7 +17,7 @@ module Dropbox
17
17
  end
18
18
 
19
19
  module Dropbox::Sign
20
- # An array describing static overlay fields. **Note** only available for certain subscriptions.
20
+ # An array describing static overlay fields. **NOTE:** Only available for certain subscriptions.
21
21
  class TemplateResponseDocumentStaticFieldBase
22
22
  # @return [String]
23
23
  attr_accessor :type
@@ -42,7 +42,7 @@ module Dropbox::Sign
42
42
  # @return [Boolean]
43
43
  attr_accessor :allow_decline
44
44
 
45
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
45
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
46
46
  # @return [Boolean]
47
47
  attr_accessor :allow_reassign
48
48
 
@@ -80,7 +80,7 @@ module Dropbox::Sign
80
80
  # @return [Array<SubFormFieldRule>]
81
81
  attr_accessor :form_field_rules
82
82
 
83
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
83
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
84
84
  # @return [Array<SubFormFieldsPerDocumentBase>]
85
85
  attr_accessor :form_fields_per_document
86
86
 
@@ -151,11 +151,11 @@ module Dropbox::Sign
151
151
  # @return [Boolean]
152
152
  attr_accessor :use_text_tags
153
153
 
154
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
154
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
155
155
  # @return [Boolean]
156
156
  attr_accessor :populate_auto_fill_fields
157
157
 
158
- # 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. **Note**: This does not correspond to the **expires_at** returned in the response.
158
+ # 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. **NOTE:** This does not correspond to the **expires_at** returned in the response.
159
159
  # @return [Integer, nil]
160
160
  attr_accessor :expires_at
161
161
 
@@ -34,7 +34,7 @@ module Dropbox::Sign
34
34
  # @return [Boolean]
35
35
  attr_accessor :allow_decline
36
36
 
37
- # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **Note**: Only available for Premium plan and higher.
37
+ # Allows signers to reassign their signature requests to other signers if set to `true`. Defaults to `false`. **NOTE:** Only available for Premium plan and higher.
38
38
  # @return [Boolean]
39
39
  attr_accessor :allow_reassign
40
40
 
@@ -84,7 +84,7 @@ module Dropbox::Sign
84
84
  # @return [Hash<String, Object>]
85
85
  attr_accessor :metadata
86
86
 
87
- # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **Note**: This parameter overwrites `show_preview=1` (if set).
87
+ # This allows the requester to enable the preview experience (i.e. does not allow the requester's end user to add any additional fields via the editor). - `preview_only=true`: Allows requesters to enable the preview only experience. - `preview_only=false`: Allows requesters to disable the preview only experience. **NOTE:** This parameter overwrites `show_preview=1` (if set).
88
88
  # @return [Boolean]
89
89
  attr_accessor :preview_only
90
90
 
@@ -127,7 +127,7 @@ module Dropbox::Sign
127
127
  # @return [String]
128
128
  attr_accessor :title
129
129
 
130
- # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
130
+ # Controls whether [auto fill fields](https://faq.hellosign.com/hc/en-us/articles/360051467511-Auto-Fill-Fields) can automatically populate a signer's information during signing. **NOTE:** Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
131
131
  # @return [Boolean]
132
132
  attr_accessor :populate_auto_fill_fields
133
133
 
@@ -61,7 +61,7 @@ module Dropbox::Sign
61
61
  # @return [Array<SubFormFieldRule>]
62
62
  attr_accessor :form_field_rules
63
63
 
64
- # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
64
+ # 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).) **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. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
65
65
  # @return [Array<SubFormFieldsPerDocumentBase>]
66
66
  attr_accessor :form_fields_per_document
67
67
 
@@ -108,7 +108,7 @@ module Dropbox::Sign
108
108
  # @return [Boolean]
109
109
  attr_accessor :use_text_tags
110
110
 
111
- # 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. **Note**: This does not correspond to the **expires_at** returned in the response.
111
+ # 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. **NOTE:** This does not correspond to the **expires_at** returned in the response.
112
112
  # @return [Integer, nil]
113
113
  attr_accessor :expires_at
114
114
 
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.4.0'
17
+ VERSION = '1.4.1'
18
18
  end
data/lib/dropbox-sign.rb CHANGED
@@ -63,10 +63,6 @@ require 'dropbox-sign/models/signature_request_bulk_create_embedded_with_templat
63
63
  require 'dropbox-sign/models/signature_request_bulk_send_with_template_request'
64
64
  require 'dropbox-sign/models/signature_request_create_embedded_request'
65
65
  require 'dropbox-sign/models/signature_request_create_embedded_with_template_request'
66
- require 'dropbox-sign/models/signature_request_edit_embedded_request'
67
- require 'dropbox-sign/models/signature_request_edit_embedded_with_template_request'
68
- require 'dropbox-sign/models/signature_request_edit_request'
69
- require 'dropbox-sign/models/signature_request_edit_with_template_request'
70
66
  require 'dropbox-sign/models/signature_request_get_response'
71
67
  require 'dropbox-sign/models/signature_request_list_response'
72
68
  require 'dropbox-sign/models/signature_request_remind_request'