dropbox-sign 1.3.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +5 -2
  3. data/README.md +4 -4
  4. data/VERSION +1 -1
  5. data/docs/BulkSendJobGetResponseSignatureRequests.md +1 -0
  6. data/docs/EmbeddedEditUrlRequest.md +1 -1
  7. data/docs/EventCallbackRequestEvent.md +1 -1
  8. data/docs/SignatureRequestApi.md +7 -7
  9. data/docs/SignatureRequestBulkCreateEmbeddedWithTemplateRequest.md +1 -1
  10. data/docs/SignatureRequestBulkSendWithTemplateRequest.md +1 -1
  11. data/docs/SignatureRequestCreateEmbeddedRequest.md +4 -4
  12. data/docs/SignatureRequestCreateEmbeddedWithTemplateRequest.md +1 -1
  13. data/docs/SignatureRequestResponse.md +2 -0
  14. data/docs/SignatureRequestSendRequest.md +5 -5
  15. data/docs/SignatureRequestSendWithTemplateRequest.md +2 -2
  16. data/docs/SignatureRequestUpdateRequest.md +2 -2
  17. data/docs/SubAttachment.md +1 -1
  18. data/docs/SubCustomField.md +1 -1
  19. data/docs/SubFieldOptions.md +1 -1
  20. data/docs/SubFormFieldsPerDocumentBase.md +2 -2
  21. data/docs/SubFormFieldsPerDocumentDateSigned.md +1 -1
  22. data/docs/SubFormFieldsPerDocumentDropdown.md +1 -1
  23. data/docs/SubFormFieldsPerDocumentHyperlink.md +1 -1
  24. data/docs/SubFormFieldsPerDocumentText.md +2 -2
  25. data/docs/SubFormFieldsPerDocumentTextMerge.md +1 -1
  26. data/docs/SubSignatureRequestGroupedSigners.md +1 -1
  27. data/docs/SubSignatureRequestSigner.md +1 -1
  28. data/docs/SubSignatureRequestTemplateSigner.md +1 -1
  29. data/docs/SubSigningOptions.md +1 -1
  30. data/docs/TeamAddMemberRequest.md +1 -1
  31. data/docs/TeamRemoveMemberRequest.md +2 -2
  32. data/docs/TemplateAddUserRequest.md +2 -2
  33. data/docs/TemplateCreateEmbeddedDraftRequest.md +2 -2
  34. data/docs/TemplateCreateRequest.md +2 -2
  35. data/docs/TemplateResponseDocument.md +1 -1
  36. data/docs/TemplateResponseDocumentStaticFieldBase.md +1 -1
  37. data/docs/UnclaimedDraftApi.md +3 -3
  38. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +4 -4
  39. data/docs/UnclaimedDraftCreateEmbeddedWithTemplateRequest.md +3 -3
  40. data/docs/UnclaimedDraftCreateRequest.md +2 -2
  41. data/examples/SignatureRequestEdit.rb +58 -0
  42. data/examples/SignatureRequestEditEmbedded.rb +48 -0
  43. data/examples/SignatureRequestEditEmbeddedWithTemplate.rb +41 -0
  44. data/examples/SignatureRequestEditWithTemplate.rb +52 -0
  45. data/lib/dropbox-sign/api/api_app_api.rb +1 -1
  46. data/lib/dropbox-sign/api/signature_request_api.rb +14 -14
  47. data/lib/dropbox-sign/api/team_api.rb +1 -1
  48. data/lib/dropbox-sign/api/unclaimed_draft_api.rb +6 -6
  49. data/lib/dropbox-sign/event_callback_helper.rb +1 -1
  50. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +13 -1
  51. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +1 -1
  52. data/lib/dropbox-sign/models/event_callback_request_event.rb +2 -7
  53. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +1 -1
  54. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +1 -1
  55. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +4 -4
  56. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +1 -1
  57. data/lib/dropbox-sign/models/signature_request_response.rb +28 -4
  58. data/lib/dropbox-sign/models/signature_request_send_request.rb +5 -5
  59. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +2 -2
  60. data/lib/dropbox-sign/models/signature_request_update_request.rb +2 -2
  61. data/lib/dropbox-sign/models/sub_attachment.rb +1 -1
  62. data/lib/dropbox-sign/models/sub_custom_field.rb +1 -1
  63. data/lib/dropbox-sign/models/sub_field_options.rb +1 -1
  64. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +2 -2
  65. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +3 -1
  66. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -1
  67. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -1
  68. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +4 -2
  69. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +3 -1
  70. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +1 -1
  71. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +1 -1
  72. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +1 -1
  73. data/lib/dropbox-sign/models/sub_signing_options.rb +1 -1
  74. data/lib/dropbox-sign/models/team_add_member_request.rb +1 -1
  75. data/lib/dropbox-sign/models/team_remove_member_request.rb +2 -2
  76. data/lib/dropbox-sign/models/template_add_user_request.rb +2 -2
  77. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +2 -2
  78. data/lib/dropbox-sign/models/template_create_request.rb +2 -2
  79. data/lib/dropbox-sign/models/template_response_document.rb +1 -1
  80. data/lib/dropbox-sign/models/template_response_document_static_field_base.rb +1 -1
  81. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +4 -4
  82. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +3 -3
  83. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +2 -2
  84. data/lib/dropbox-sign/version.rb +1 -1
  85. data/openapi-config.yaml +1 -1
  86. data/openapi-sdk.yaml +154 -121
  87. data/spec/event_callback_helper_spec.rb +17 -3
  88. data/templates/event_callback_helper.mustache +1 -1
  89. data/test_fixtures/EventCallbackHelper_AccountCallbacks.json +82 -0
  90. data/test_fixtures/{EventCallbackHelper.json → EventCallbackHelper_AppCallbacks.json} +8 -4
  91. data/test_fixtures/SignatureRequestSendRequest.json +12 -6
  92. data/test_fixtures/SubFormFieldsPerDocument.json +8 -4
  93. metadata +14 -9
@@ -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
 
@@ -160,10 +160,6 @@ module Dropbox::Sign
160
160
  invalid_properties.push('invalid value for "event_hash", event_hash cannot be nil.')
161
161
  end
162
162
 
163
- if @event_metadata.nil?
164
- invalid_properties.push('invalid value for "event_metadata", event_metadata cannot be nil.')
165
- end
166
-
167
163
  invalid_properties
168
164
  end
169
165
 
@@ -172,17 +168,16 @@ module Dropbox::Sign
172
168
  def valid?
173
169
  return false if @event_time.nil?
174
170
  return false if @event_type.nil?
175
- event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test"])
171
+ event_type_validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"])
176
172
  return false unless event_type_validator.valid?(@event_type)
177
173
  return false if @event_hash.nil?
178
- return false if @event_metadata.nil?
179
174
  true
180
175
  end
181
176
 
182
177
  # Custom attribute writer method checking allowed values (enum).
183
178
  # @param [Object] event_type Object to be assigned
184
179
  def event_type=(event_type)
185
- validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test"])
180
+ validator = EnumAttributeValidator.new('String', ["account_confirmed", "unknown_error", "file_error", "sign_url_invalid", "signature_request_viewed", "signature_request_signed", "signature_request_sent", "signature_request_all_signed", "signature_request_email_bounce", "signature_request_remind", "signature_request_incomplete_qes", "signature_request_destroyed", "signature_request_canceled", "signature_request_downloadable", "signature_request_declined", "signature_request_reassigned", "signature_request_invalid", "signature_request_prepared", "signature_request_expired", "template_created", "template_error", "callback_test", "signature_request_signer_removed"])
186
181
  unless validator.valid?(event_type)
187
182
  fail ArgumentError, "invalid value for \"event_type\", must be one of #{validator.allowable_values}."
188
183
  end
@@ -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) **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) **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
 
@@ -91,6 +91,10 @@ module Dropbox::Sign
91
91
  # @return [String, nil]
92
92
  attr_accessor :signing_redirect_url
93
93
 
94
+ # The path where the completed document can be downloaded
95
+ # @return [String, nil]
96
+ attr_accessor :final_copy_uri
97
+
94
98
  # Templates IDs used in this SignatureRequest (if any).
95
99
  # @return [Array<String>, nil]
96
100
  attr_accessor :template_ids
@@ -111,6 +115,10 @@ module Dropbox::Sign
111
115
  # @return [Array<SignatureRequestResponseSignatures>]
112
116
  attr_accessor :signatures
113
117
 
118
+ # The ID of the Bulk Send job which sent the signature request, if applicable.
119
+ # @return [String, nil]
120
+ attr_accessor :bulk_send_job_id
121
+
114
122
  # Attribute mapping from ruby-style variable name to JSON key.
115
123
  def self.attribute_map
116
124
  {
@@ -132,11 +140,13 @@ module Dropbox::Sign
132
140
  :'details_url' => :'details_url',
133
141
  :'cc_email_addresses' => :'cc_email_addresses',
134
142
  :'signing_redirect_url' => :'signing_redirect_url',
143
+ :'final_copy_uri' => :'final_copy_uri',
135
144
  :'template_ids' => :'template_ids',
136
145
  :'custom_fields' => :'custom_fields',
137
146
  :'attachments' => :'attachments',
138
147
  :'response_data' => :'response_data',
139
- :'signatures' => :'signatures'
148
+ :'signatures' => :'signatures',
149
+ :'bulk_send_job_id' => :'bulk_send_job_id'
140
150
  }
141
151
  end
142
152
 
@@ -171,11 +181,13 @@ module Dropbox::Sign
171
181
  :'details_url' => :'String',
172
182
  :'cc_email_addresses' => :'Array<String>',
173
183
  :'signing_redirect_url' => :'String',
184
+ :'final_copy_uri' => :'String',
174
185
  :'template_ids' => :'Array<String>',
175
186
  :'custom_fields' => :'Array<SignatureRequestResponseCustomFieldBase>',
176
187
  :'attachments' => :'Array<SignatureRequestResponseAttachment>',
177
188
  :'response_data' => :'Array<SignatureRequestResponseDataBase>',
178
- :'signatures' => :'Array<SignatureRequestResponseSignatures>'
189
+ :'signatures' => :'Array<SignatureRequestResponseSignatures>',
190
+ :'bulk_send_job_id' => :'String'
179
191
  }
180
192
  end
181
193
 
@@ -192,10 +204,12 @@ module Dropbox::Sign
192
204
  :'message',
193
205
  :'signing_url',
194
206
  :'signing_redirect_url',
207
+ :'final_copy_uri',
195
208
  :'template_ids',
196
209
  :'custom_fields',
197
210
  :'attachments',
198
211
  :'response_data',
212
+ :'bulk_send_job_id'
199
213
  ])
200
214
  end
201
215
 
@@ -305,6 +319,10 @@ module Dropbox::Sign
305
319
  self.signing_redirect_url = attributes[:'signing_redirect_url']
306
320
  end
307
321
 
322
+ if attributes.key?(:'final_copy_uri')
323
+ self.final_copy_uri = attributes[:'final_copy_uri']
324
+ end
325
+
308
326
  if attributes.key?(:'template_ids')
309
327
  if (value = attributes[:'template_ids']).is_a?(Array)
310
328
  self.template_ids = value
@@ -334,6 +352,10 @@ module Dropbox::Sign
334
352
  self.signatures = value
335
353
  end
336
354
  end
355
+
356
+ if attributes.key?(:'bulk_send_job_id')
357
+ self.bulk_send_job_id = attributes[:'bulk_send_job_id']
358
+ end
337
359
  end
338
360
 
339
361
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -372,11 +394,13 @@ module Dropbox::Sign
372
394
  details_url == o.details_url &&
373
395
  cc_email_addresses == o.cc_email_addresses &&
374
396
  signing_redirect_url == o.signing_redirect_url &&
397
+ final_copy_uri == o.final_copy_uri &&
375
398
  template_ids == o.template_ids &&
376
399
  custom_fields == o.custom_fields &&
377
400
  attachments == o.attachments &&
378
401
  response_data == o.response_data &&
379
- signatures == o.signatures
402
+ signatures == o.signatures &&
403
+ bulk_send_job_id == o.bulk_send_job_id
380
404
  end
381
405
 
382
406
  # @see the `==` method
@@ -388,7 +412,7 @@ module Dropbox::Sign
388
412
  # Calculates hash code according to all attributes.
389
413
  # @return [Integer] Hash code
390
414
  def hash
391
- [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, template_ids, custom_fields, attachments, response_data, signatures].hash
415
+ [test_mode, signature_request_id, requester_email_address, title, original_title, subject, message, metadata, created_at, expires_at, is_complete, is_declined, has_error, files_url, signing_url, details_url, cc_email_addresses, signing_redirect_url, final_copy_uri, template_ids, custom_fields, attachments, response_data, signatures, bulk_send_job_id].hash
392
416
  end
393
417
 
394
418
  # Builds the object from hash
@@ -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
 
@@ -137,6 +137,8 @@ module Dropbox::Sign
137
137
 
138
138
  if attributes.key?(:'font_size')
139
139
  self.font_size = attributes[:'font_size']
140
+ else
141
+ self.font_size = 12
140
142
  end
141
143
  end
142
144
 
@@ -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
 
@@ -159,6 +159,8 @@ module Dropbox::Sign
159
159
 
160
160
  if attributes.key?(:'font_size')
161
161
  self.font_size = attributes[:'font_size']
162
+ else
163
+ self.font_size = 12
162
164
  end
163
165
  end
164
166
 
@@ -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
 
@@ -157,6 +157,8 @@ module Dropbox::Sign
157
157
 
158
158
  if attributes.key?(:'font_size')
159
159
  self.font_size = attributes[:'font_size']
160
+ else
161
+ self.font_size = 12
160
162
  end
161
163
  end
162
164
 
@@ -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
 
@@ -215,6 +215,8 @@ module Dropbox::Sign
215
215
 
216
216
  if attributes.key?(:'font_size')
217
217
  self.font_size = attributes[:'font_size']
218
+ else
219
+ self.font_size = 12
218
220
  end
219
221
  end
220
222
 
@@ -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
 
@@ -137,6 +137,8 @@ module Dropbox::Sign
137
137
 
138
138
  if attributes.key?(:'font_size')
139
139
  self.font_size = attributes[:'font_size']
140
+ else
141
+ self.font_size = 12
140
142
  end
141
143
  end
142
144
 
@@ -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. **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. **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