dropbox-sign 1.0.0.pre.beta2301 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (217) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +7 -9
  4. data/VERSION +1 -0
  5. data/bin/check-clean-git-status +15 -0
  6. data/bin/release +39 -0
  7. data/bin/ruby +1 -0
  8. data/docs/SignatureRequestApi.md +3 -3
  9. data/docs/SignatureRequestCreateEmbeddedRequest.md +1 -1
  10. data/docs/SignatureRequestSendRequest.md +1 -1
  11. data/docs/SubFormFieldsPerDocumentBase.md +1 -1
  12. data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
  13. data/docs/UnclaimedDraftApi.md +2 -2
  14. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
  15. data/docs/UnclaimedDraftCreateRequest.md +1 -1
  16. data/examples/EventCallback.rb +1 -4
  17. data/examples/SignatureRequestCreateEmbedded.rb +1 -1
  18. data/examples/SignatureRequestSend.rb +2 -2
  19. data/examples/UnclaimedDraftCreate.rb +2 -2
  20. data/lib/dropbox-sign/models/account_create_request.rb +4 -0
  21. data/lib/dropbox-sign/models/account_create_response.rb +3 -0
  22. data/lib/dropbox-sign/models/account_get_response.rb +2 -0
  23. data/lib/dropbox-sign/models/account_response.rb +10 -0
  24. data/lib/dropbox-sign/models/account_response_quotas.rb +5 -0
  25. data/lib/dropbox-sign/models/account_update_request.rb +3 -0
  26. data/lib/dropbox-sign/models/account_verify_request.rb +1 -0
  27. data/lib/dropbox-sign/models/account_verify_response.rb +2 -0
  28. data/lib/dropbox-sign/models/account_verify_response_account.rb +1 -0
  29. data/lib/dropbox-sign/models/api_app_create_request.rb +7 -0
  30. data/lib/dropbox-sign/models/api_app_get_response.rb +2 -0
  31. data/lib/dropbox-sign/models/api_app_list_response.rb +3 -0
  32. data/lib/dropbox-sign/models/api_app_response.rb +10 -0
  33. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +4 -0
  34. data/lib/dropbox-sign/models/api_app_response_options.rb +1 -0
  35. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +2 -0
  36. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +14 -0
  37. data/lib/dropbox-sign/models/api_app_update_request.rb +7 -0
  38. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +4 -0
  39. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +24 -0
  40. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +3 -0
  41. data/lib/dropbox-sign/models/bulk_send_job_response.rb +4 -0
  42. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +2 -0
  43. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +10 -0
  44. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +2 -0
  45. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +2 -0
  46. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +2 -0
  47. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +2 -0
  48. data/lib/dropbox-sign/models/error_response.rb +1 -0
  49. data/lib/dropbox-sign/models/error_response_error.rb +3 -0
  50. data/lib/dropbox-sign/models/event_callback_request.rb +4 -0
  51. data/lib/dropbox-sign/models/event_callback_request_event.rb +4 -0
  52. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +4 -0
  53. data/lib/dropbox-sign/models/file_response.rb +2 -0
  54. data/lib/dropbox-sign/models/file_response_data_uri.rb +1 -0
  55. data/lib/dropbox-sign/models/list_info_response.rb +4 -0
  56. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +5 -0
  57. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +2 -0
  58. data/lib/dropbox-sign/models/o_auth_token_response.rb +5 -0
  59. data/lib/dropbox-sign/models/report_create_request.rb +3 -0
  60. data/lib/dropbox-sign/models/report_create_response.rb +2 -0
  61. data/lib/dropbox-sign/models/report_response.rb +4 -0
  62. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +13 -0
  63. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +13 -0
  64. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +25 -1
  65. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +15 -0
  66. data/lib/dropbox-sign/models/signature_request_get_response.rb +2 -0
  67. data/lib/dropbox-sign/models/signature_request_list_response.rb +3 -0
  68. data/lib/dropbox-sign/models/signature_request_remind_request.rb +2 -0
  69. data/lib/dropbox-sign/models/signature_request_response.rb +23 -0
  70. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +6 -0
  71. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +5 -0
  72. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +2 -0
  73. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +2 -0
  74. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +5 -0
  75. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +2 -0
  76. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +2 -0
  77. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +2 -0
  78. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +2 -0
  79. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +2 -0
  80. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +2 -0
  81. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +2 -0
  82. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +2 -0
  83. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +2 -0
  84. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +19 -0
  85. data/lib/dropbox-sign/models/signature_request_send_request.rb +26 -1
  86. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +16 -0
  87. data/lib/dropbox-sign/models/signature_request_update_request.rb +4 -0
  88. data/lib/dropbox-sign/models/sub_attachment.rb +4 -0
  89. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +2 -0
  90. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +2 -0
  91. data/lib/dropbox-sign/models/sub_cc.rb +2 -0
  92. data/lib/dropbox-sign/models/sub_custom_field.rb +4 -0
  93. data/lib/dropbox-sign/models/sub_editor_options.rb +2 -0
  94. data/lib/dropbox-sign/models/sub_field_options.rb +1 -0
  95. data/lib/dropbox-sign/models/sub_form_field_group.rb +3 -0
  96. data/lib/dropbox-sign/models/sub_form_field_rule.rb +4 -0
  97. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +4 -0
  98. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +4 -0
  99. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +12 -1
  100. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +3 -0
  101. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +1 -0
  102. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +1 -0
  103. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -0
  104. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -0
  105. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +1 -0
  106. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +3 -0
  107. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +1 -0
  108. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +8 -0
  109. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +1 -0
  110. data/lib/dropbox-sign/models/sub_merge_field.rb +2 -0
  111. data/lib/dropbox-sign/models/sub_o_auth.rb +2 -0
  112. data/lib/dropbox-sign/models/sub_options.rb +1 -0
  113. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +3 -0
  114. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +6 -0
  115. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +6 -0
  116. data/lib/dropbox-sign/models/sub_signing_options.rb +5 -0
  117. data/lib/dropbox-sign/models/sub_team_response.rb +2 -0
  118. data/lib/dropbox-sign/models/sub_template_role.rb +2 -0
  119. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +3 -0
  120. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +3 -0
  121. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +15 -0
  122. data/lib/dropbox-sign/models/team_add_member_request.rb +3 -0
  123. data/lib/dropbox-sign/models/team_create_request.rb +1 -0
  124. data/lib/dropbox-sign/models/team_get_info_response.rb +2 -0
  125. data/lib/dropbox-sign/models/team_get_response.rb +2 -0
  126. data/lib/dropbox-sign/models/team_info_response.rb +5 -0
  127. data/lib/dropbox-sign/models/team_invite_response.rb +6 -0
  128. data/lib/dropbox-sign/models/team_invites_response.rb +2 -0
  129. data/lib/dropbox-sign/models/team_member_response.rb +3 -0
  130. data/lib/dropbox-sign/models/team_members_response.rb +3 -0
  131. data/lib/dropbox-sign/models/team_parent_response.rb +2 -0
  132. data/lib/dropbox-sign/models/team_remove_member_request.rb +5 -0
  133. data/lib/dropbox-sign/models/team_response.rb +3 -0
  134. data/lib/dropbox-sign/models/team_sub_teams_response.rb +3 -0
  135. data/lib/dropbox-sign/models/team_update_request.rb +1 -0
  136. data/lib/dropbox-sign/models/template_add_user_request.rb +3 -0
  137. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +26 -1
  138. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +2 -0
  139. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +4 -0
  140. data/lib/dropbox-sign/models/template_edit_response.rb +1 -0
  141. data/lib/dropbox-sign/models/template_get_response.rb +2 -0
  142. data/lib/dropbox-sign/models/template_list_response.rb +3 -0
  143. data/lib/dropbox-sign/models/template_remove_user_request.rb +2 -0
  144. data/lib/dropbox-sign/models/template_response.rb +15 -0
  145. data/lib/dropbox-sign/models/template_response_account.rb +6 -0
  146. data/lib/dropbox-sign/models/template_response_account_quota.rb +4 -0
  147. data/lib/dropbox-sign/models/template_response_cc_role.rb +1 -0
  148. data/lib/dropbox-sign/models/template_response_custom_field.rb +13 -0
  149. data/lib/dropbox-sign/models/template_response_document.rb +6 -0
  150. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +16 -0
  151. data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -0
  152. data/lib/dropbox-sign/models/template_response_document_form_field.rb +14 -0
  153. data/lib/dropbox-sign/models/template_response_document_static_field.rb +10 -0
  154. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +2 -0
  155. data/lib/dropbox-sign/models/template_response_named_form_field.rb +14 -0
  156. data/lib/dropbox-sign/models/template_response_signer_role.rb +2 -0
  157. data/lib/dropbox-sign/models/template_update_files_request.rb +6 -0
  158. data/lib/dropbox-sign/models/template_update_files_response.rb +1 -0
  159. data/lib/dropbox-sign/models/template_update_files_response_template.rb +2 -0
  160. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +37 -1
  161. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +29 -0
  162. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +25 -1
  163. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +2 -0
  164. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +8 -0
  165. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +6 -0
  166. data/lib/dropbox-sign/models/warning_response.rb +2 -0
  167. data/lib/dropbox-sign/version.rb +1 -1
  168. data/openapi-config.yaml +6 -1
  169. data/openapi-sdk.yaml +7 -10
  170. data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
  171. data/templates/README.mustache +3 -5
  172. data/templates/VERSION-root.mustache +1 -0
  173. data/templates/partial_model_generic.mustache +1 -0
  174. metadata +17 -56
  175. data/vendor/autoload.php +0 -7
  176. data/vendor/bin/yaml-lint +0 -117
  177. data/vendor/composer/ClassLoader.php +0 -572
  178. data/vendor/composer/InstalledVersions.php +0 -350
  179. data/vendor/composer/LICENSE +0 -21
  180. data/vendor/composer/autoload_classmap.php +0 -10
  181. data/vendor/composer/autoload_files.php +0 -11
  182. data/vendor/composer/autoload_namespaces.php +0 -9
  183. data/vendor/composer/autoload_psr4.php +0 -11
  184. data/vendor/composer/autoload_real.php +0 -80
  185. data/vendor/composer/autoload_static.php +0 -46
  186. data/vendor/composer/installed.json +0 -239
  187. data/vendor/composer/installed.php +0 -50
  188. data/vendor/composer/platform_check.php +0 -26
  189. data/vendor/symfony/deprecation-contracts/.gitignore +0 -3
  190. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +0 -5
  191. data/vendor/symfony/deprecation-contracts/LICENSE +0 -19
  192. data/vendor/symfony/deprecation-contracts/README.md +0 -26
  193. data/vendor/symfony/deprecation-contracts/composer.json +0 -35
  194. data/vendor/symfony/deprecation-contracts/function.php +0 -27
  195. data/vendor/symfony/polyfill-ctype/Ctype.php +0 -232
  196. data/vendor/symfony/polyfill-ctype/LICENSE +0 -19
  197. data/vendor/symfony/polyfill-ctype/README.md +0 -12
  198. data/vendor/symfony/polyfill-ctype/bootstrap.php +0 -50
  199. data/vendor/symfony/polyfill-ctype/bootstrap80.php +0 -46
  200. data/vendor/symfony/polyfill-ctype/composer.json +0 -41
  201. data/vendor/symfony/yaml/CHANGELOG.md +0 -237
  202. data/vendor/symfony/yaml/Command/LintCommand.php +0 -289
  203. data/vendor/symfony/yaml/Dumper.php +0 -140
  204. data/vendor/symfony/yaml/Escaper.php +0 -95
  205. data/vendor/symfony/yaml/Exception/DumpException.php +0 -21
  206. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +0 -21
  207. data/vendor/symfony/yaml/Exception/ParseException.php +0 -132
  208. data/vendor/symfony/yaml/Exception/RuntimeException.php +0 -21
  209. data/vendor/symfony/yaml/Inline.php +0 -812
  210. data/vendor/symfony/yaml/LICENSE +0 -19
  211. data/vendor/symfony/yaml/Parser.php +0 -1305
  212. data/vendor/symfony/yaml/README.md +0 -13
  213. data/vendor/symfony/yaml/Resources/bin/yaml-lint +0 -45
  214. data/vendor/symfony/yaml/Tag/TaggedValue.php +0 -38
  215. data/vendor/symfony/yaml/Unescaper.php +0 -132
  216. data/vendor/symfony/yaml/Yaml.php +0 -100
  217. data/vendor/symfony/yaml/composer.json +0 -42
@@ -19,108 +19,144 @@ end
19
19
  module Dropbox::Sign
20
20
  class UnclaimedDraftCreateEmbeddedRequest
21
21
  # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
22
+ # @return [String]
22
23
  attr_accessor :client_id
23
24
 
24
25
  # The email address of the user that should be designated as the requester of this draft, if the draft type is `request_signature`.
26
+ # @return [String]
25
27
  attr_accessor :requester_email_address
26
28
 
27
29
  # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
30
+ # @return [Array<File>]
28
31
  attr_accessor :files
29
32
 
30
33
  # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
34
+ # @return [Array<String>]
31
35
  attr_accessor :file_urls
32
36
 
33
37
  # This allows the requester to specify whether the user is allowed to provide email addresses to CC when claiming the draft.
38
+ # @return [Boolean]
34
39
  attr_accessor :allow_ccs
35
40
 
36
41
  # Allows signers to decline to sign a document if `true`. Defaults to `false`.
42
+ # @return [Boolean]
37
43
  attr_accessor :allow_decline
38
44
 
39
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
+ # @return [Boolean]
40
47
  attr_accessor :allow_reassign
41
48
 
42
49
  # A list describing the attachments
50
+ # @return [Array<SubAttachment>]
43
51
  attr_accessor :attachments
44
52
 
45
53
  # The email addresses that should be CCed.
54
+ # @return [Array<String>]
46
55
  attr_accessor :cc_email_addresses
47
56
 
48
57
  # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
58
+ # @return [Array<SubCustomField>]
49
59
  attr_accessor :custom_fields
50
60
 
61
+ # @return [SubEditorOptions]
51
62
  attr_accessor :editor_options
52
63
 
64
+ # @return [SubFieldOptions]
53
65
  attr_accessor :field_options
54
66
 
55
67
  # Provide users the ability to review/edit the signers.
68
+ # @return [Boolean]
56
69
  attr_accessor :force_signer_page
57
70
 
58
71
  # Provide users the ability to review/edit the subject and message.
72
+ # @return [Boolean]
59
73
  attr_accessor :force_subject_message
60
74
 
61
75
  # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
76
+ # @return [Array<SubFormFieldGroup>]
62
77
  attr_accessor :form_field_groups
63
78
 
64
79
  # Conditional Logic rules for fields defined in `form_fields_per_document`.
80
+ # @return [Array<SubFormFieldRule>]
65
81
  attr_accessor :form_field_rules
66
82
 
67
- # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.) **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. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
+ # @return [Array<SubFormFieldsPerDocumentBase>]
68
85
  attr_accessor :form_fields_per_document
69
86
 
70
87
  # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
88
+ # @return [Boolean]
71
89
  attr_accessor :hide_text_tags
72
90
 
73
91
  # The request from this draft will not automatically send to signers post-claim if set to `true`. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
92
+ # @return [Boolean]
74
93
  attr_accessor :hold_request
75
94
 
76
95
  # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
96
+ # @return [Boolean]
77
97
  attr_accessor :is_for_embedded_signing
78
98
 
79
99
  # The custom message in the email that will be sent to the signers.
100
+ # @return [String]
80
101
  attr_accessor :message
81
102
 
82
103
  # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
104
+ # @return [Hash<String, Object>]
83
105
  attr_accessor :metadata
84
106
 
85
107
  # The URL you want signers redirected to after they successfully request a signature.
108
+ # @return [String]
86
109
  attr_accessor :requesting_redirect_url
87
110
 
88
111
  # This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
112
+ # @return [Boolean]
89
113
  attr_accessor :show_preview
90
114
 
91
115
  # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
116
+ # @return [Boolean]
92
117
  attr_accessor :show_progress_stepper
93
118
 
94
119
  # Add Signers to your Unclaimed Draft Signature Request.
120
+ # @return [Array<SubUnclaimedDraftSigner>]
95
121
  attr_accessor :signers
96
122
 
123
+ # @return [SubSigningOptions]
97
124
  attr_accessor :signing_options
98
125
 
99
126
  # The URL you want signers redirected to after they successfully sign.
127
+ # @return [String]
100
128
  attr_accessor :signing_redirect_url
101
129
 
102
130
  # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
131
+ # @return [Boolean]
103
132
  attr_accessor :skip_me_now
104
133
 
105
134
  # The subject in the email that will be sent to the signers.
135
+ # @return [String]
106
136
  attr_accessor :subject
107
137
 
108
138
  # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
139
+ # @return [Boolean]
109
140
  attr_accessor :test_mode
110
141
 
111
142
  # The type of the draft. By default this is `request_signature`, but you can set it to `send_document` if you want to self sign a document and download it.
143
+ # @return [String]
112
144
  attr_accessor :type
113
145
 
114
146
  # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
147
+ # @return [Boolean]
115
148
  attr_accessor :use_preexisting_fields
116
149
 
117
150
  # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
151
+ # @return [Boolean]
118
152
  attr_accessor :use_text_tags
119
153
 
120
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
+ # @return [Boolean]
121
156
  attr_accessor :populate_auto_fill_fields
122
157
 
123
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
+ # @return [Integer, nil]
124
160
  attr_accessor :expires_at
125
161
 
126
162
  class EnumAttributeValidator
@@ -19,87 +19,116 @@ end
19
19
  module Dropbox::Sign
20
20
  class UnclaimedDraftCreateEmbeddedWithTemplateRequest
21
21
  # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
22
+ # @return [String]
22
23
  attr_accessor :client_id
23
24
 
24
25
  # The email address of the user that should be designated as the requester of this draft.
26
+ # @return [String]
25
27
  attr_accessor :requester_email_address
26
28
 
27
29
  # Use `template_ids` to create a SignatureRequest from one or more templates, in the order in which the templates will be used.
30
+ # @return [Array<String>]
28
31
  attr_accessor :template_ids
29
32
 
30
33
  # Allows signers to decline to sign a document if `true`. Defaults to `false`.
34
+ # @return [Boolean]
31
35
  attr_accessor :allow_decline
32
36
 
33
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
+ # @return [Boolean]
34
39
  attr_accessor :allow_reassign
35
40
 
36
41
  # Add CC email recipients. Required when a CC role exists for the Template.
42
+ # @return [Array<SubCC>]
37
43
  attr_accessor :ccs
38
44
 
39
45
  # An array defining values and options for custom fields. Required when a custom field exists in the Template.
46
+ # @return [Array<SubCustomField>]
40
47
  attr_accessor :custom_fields
41
48
 
49
+ # @return [SubEditorOptions]
42
50
  attr_accessor :editor_options
43
51
 
52
+ # @return [SubFieldOptions]
44
53
  attr_accessor :field_options
45
54
 
46
55
  # Use `files[]` to append additional files to the signature request being created from the template. Dropbox Sign will parse the files for [text tags](https://app.hellosign.com/api/textTagsWalkthrough) and append it to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both.
56
+ # @return [Array<File>]
47
57
  attr_accessor :files
48
58
 
49
59
  # Use file_urls[] to append additional files to the signature request being created from the template. Dropbox Sign will download the file, then parse it for [text tags](https://app.hellosign.com/api/textTagsWalkthrough), and append to the signature request. Text tags for signers not on the template(s) will be ignored. **files** or **file_urls[]** is required, but not both.
60
+ # @return [Array<String>]
50
61
  attr_accessor :file_urls
51
62
 
52
63
  # Provide users the ability to review/edit the template signer roles.
64
+ # @return [Boolean]
53
65
  attr_accessor :force_signer_roles
54
66
 
55
67
  # Provide users the ability to review/edit the template subject and message.
68
+ # @return [Boolean]
56
69
  attr_accessor :force_subject_message
57
70
 
58
71
  # The request from this draft will not automatically send to signers post-claim if set to 1. Requester must [release](/api/reference/operation/signatureRequestReleaseHold/) the request from hold when ready to send. Defaults to `false`.
72
+ # @return [Boolean]
59
73
  attr_accessor :hold_request
60
74
 
61
75
  # The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`.
76
+ # @return [Boolean]
62
77
  attr_accessor :is_for_embedded_signing
63
78
 
64
79
  # The custom message in the email that will be sent to the signers.
80
+ # @return [String]
65
81
  attr_accessor :message
66
82
 
67
83
  # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
84
+ # @return [Hash<String, Object>]
68
85
  attr_accessor :metadata
69
86
 
70
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
+ # @return [Boolean]
71
89
  attr_accessor :preview_only
72
90
 
73
91
  # The URL you want signers redirected to after they successfully request a signature.
92
+ # @return [String]
74
93
  attr_accessor :requesting_redirect_url
75
94
 
76
95
  # This allows the requester to enable the editor/preview experience. - `show_preview=true`: Allows requesters to enable the editor/preview experience. - `show_preview=false`: Allows requesters to disable the editor/preview experience.
96
+ # @return [Boolean]
77
97
  attr_accessor :show_preview
78
98
 
79
99
  # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
100
+ # @return [Boolean]
80
101
  attr_accessor :show_progress_stepper
81
102
 
82
103
  # Add Signers to your Templated-based Signature Request.
104
+ # @return [Array<SubUnclaimedDraftTemplateSigner>]
83
105
  attr_accessor :signers
84
106
 
107
+ # @return [SubSigningOptions]
85
108
  attr_accessor :signing_options
86
109
 
87
110
  # The URL you want signers redirected to after they successfully sign.
111
+ # @return [String]
88
112
  attr_accessor :signing_redirect_url
89
113
 
90
114
  # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
115
+ # @return [Boolean]
91
116
  attr_accessor :skip_me_now
92
117
 
93
118
  # The subject in the email that will be sent to the signers.
119
+ # @return [String]
94
120
  attr_accessor :subject
95
121
 
96
122
  # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
123
+ # @return [Boolean]
97
124
  attr_accessor :test_mode
98
125
 
99
126
  # The title you want to assign to the SignatureRequest.
127
+ # @return [String]
100
128
  attr_accessor :title
101
129
 
102
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
+ # @return [Boolean]
103
132
  attr_accessor :populate_auto_fill_fields
104
133
 
105
134
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,73 +19,97 @@ end
19
19
  module Dropbox::Sign
20
20
  class UnclaimedDraftCreateRequest
21
21
  # The type of unclaimed draft to create. Use `send_document` to create a claimable file, and `request_signature` for a claimable signature request. If the type is `request_signature` then signers name and email_address are not optional.
22
+ # @return [String]
22
23
  attr_accessor :type
23
24
 
24
25
  # Use `files[]` to indicate the uploaded file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
26
+ # @return [Array<File>]
25
27
  attr_accessor :files
26
28
 
27
29
  # Use `file_urls[]` to have Dropbox Sign download the file(s) to send for signature. This endpoint requires either **files** or **file_urls[]**, but not both.
30
+ # @return [Array<String>]
28
31
  attr_accessor :file_urls
29
32
 
30
33
  # Allows signers to decline to sign a document if `true`. Defaults to `false`.
34
+ # @return [Boolean]
31
35
  attr_accessor :allow_decline
32
36
 
33
37
  # A list describing the attachments
38
+ # @return [Array<SubAttachment>]
34
39
  attr_accessor :attachments
35
40
 
36
41
  # The email addresses that should be CCed.
42
+ # @return [Array<String>]
37
43
  attr_accessor :cc_email_addresses
38
44
 
39
45
  # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
46
+ # @return [String]
40
47
  attr_accessor :client_id
41
48
 
42
49
  # When used together with merge fields, `custom_fields` allows users to add pre-filled data to their signature requests. Pre-filled data can be used with \"send-once\" signature requests by adding merge fields with `form_fields_per_document` or [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) while passing values back with `custom_fields` together in one API call. For using pre-filled on repeatable signature requests, merge fields are added to templates in the Dropbox Sign UI or by calling [/template/create_embedded_draft](/api/reference/operation/templateCreateEmbeddedDraft) and then passing `custom_fields` on subsequent signature requests referencing that template.
50
+ # @return [Array<SubCustomField>]
43
51
  attr_accessor :custom_fields
44
52
 
53
+ # @return [SubFieldOptions]
45
54
  attr_accessor :field_options
46
55
 
47
56
  # Group information for fields defined in `form_fields_per_document`. String-indexed JSON array with `group_label` and `requirement` keys. `form_fields_per_document` must contain fields referencing a group defined in `form_field_groups`.
57
+ # @return [Array<SubFormFieldGroup>]
48
58
  attr_accessor :form_field_groups
49
59
 
50
60
  # Conditional Logic rules for fields defined in `form_fields_per_document`.
61
+ # @return [Array<SubFormFieldRule>]
51
62
  attr_accessor :form_field_rules
52
63
 
53
- # The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href=\"/docs/openapi/form-fields-per-document\" target=\"_blank\">Using Form Fields per Document</a>.) **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. (We're currently fixing a bug where this property only accepts a two-dimensional array. 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
+ # @return [Array<SubFormFieldsPerDocumentBase>]
54
66
  attr_accessor :form_fields_per_document
55
67
 
56
68
  # Send with a value of `true` if you wish to enable automatic Text Tag removal. Defaults to `false`. When using Text Tags it is preferred that you set this to `false` and hide your tags with white text or something similar because the automatic removal system can cause unwanted clipping. See the [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) walkthrough for more details.
69
+ # @return [Boolean]
57
70
  attr_accessor :hide_text_tags
58
71
 
59
72
  # The custom message in the email that will be sent to the signers.
73
+ # @return [String]
60
74
  attr_accessor :message
61
75
 
62
76
  # Key-value data that should be attached to the signature request. This metadata is included in all API responses and events involving the signature request. For example, use the metadata field to store a signer's order number for look up when receiving events for the signature request. Each request can include up to 10 metadata keys (or 50 nested metadata keys), with key names up to 40 characters long and values up to 1000 characters long.
77
+ # @return [Hash<String, Object>]
63
78
  attr_accessor :metadata
64
79
 
65
80
  # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
81
+ # @return [Boolean]
66
82
  attr_accessor :show_progress_stepper
67
83
 
68
84
  # Add Signers to your Unclaimed Draft Signature Request.
85
+ # @return [Array<SubUnclaimedDraftSigner>]
69
86
  attr_accessor :signers
70
87
 
88
+ # @return [SubSigningOptions]
71
89
  attr_accessor :signing_options
72
90
 
73
91
  # The URL you want signers redirected to after they successfully sign.
92
+ # @return [String]
74
93
  attr_accessor :signing_redirect_url
75
94
 
76
95
  # The subject in the email that will be sent to the signers.
96
+ # @return [String]
77
97
  attr_accessor :subject
78
98
 
79
99
  # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
100
+ # @return [Boolean]
80
101
  attr_accessor :test_mode
81
102
 
82
103
  # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
104
+ # @return [Boolean]
83
105
  attr_accessor :use_preexisting_fields
84
106
 
85
107
  # Set `use_text_tags` to `true` to enable [Text Tags](https://app.hellosign.com/api/textTagsWalkthrough#TextTagIntro) parsing in your document (defaults to disabled, or `false`). Alternatively, if your PDF contains pre-defined fields, enable the detection of these fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`). Currently we only support use of either `use_text_tags` or `use_preexisting_fields` parameter, not both.
108
+ # @return [Boolean]
86
109
  attr_accessor :use_text_tags
87
110
 
88
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
+ # @return [Integer, nil]
89
113
  attr_accessor :expires_at
90
114
 
91
115
  class EnumAttributeValidator
@@ -18,9 +18,11 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class UnclaimedDraftCreateResponse
21
+ # @return [UnclaimedDraftResponse]
21
22
  attr_accessor :unclaimed_draft
22
23
 
23
24
  # A list of warnings.
25
+ # @return [Array<WarningResponse>]
24
26
  attr_accessor :warnings
25
27
 
26
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,26 +19,34 @@ end
19
19
  module Dropbox::Sign
20
20
  class UnclaimedDraftEditAndResendRequest
21
21
  # Client id of the app used to create the draft. Used to apply the branding and callback url defined for the app.
22
+ # @return [String]
22
23
  attr_accessor :client_id
23
24
 
25
+ # @return [SubEditorOptions]
24
26
  attr_accessor :editor_options
25
27
 
26
28
  # The request created from this draft will also be signable in embedded mode if set to `true`.
29
+ # @return [Boolean]
27
30
  attr_accessor :is_for_embedded_signing
28
31
 
29
32
  # The email address of the user that should be designated as the requester of this draft. If not set, original requester's email address will be used.
33
+ # @return [String]
30
34
  attr_accessor :requester_email_address
31
35
 
32
36
  # The URL you want signers redirected to after they successfully request a signature.
37
+ # @return [String]
33
38
  attr_accessor :requesting_redirect_url
34
39
 
35
40
  # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
41
+ # @return [Boolean]
36
42
  attr_accessor :show_progress_stepper
37
43
 
38
44
  # The URL you want signers redirected to after they successfully sign.
45
+ # @return [String]
39
46
  attr_accessor :signing_redirect_url
40
47
 
41
48
  # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
49
+ # @return [Boolean]
42
50
  attr_accessor :test_mode
43
51
 
44
52
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,21 +20,27 @@ module Dropbox::Sign
20
20
  # A group of documents that a user can take ownership of via the claim URL.
21
21
  class UnclaimedDraftResponse
22
22
  # The ID of the signature request that is represented by this UnclaimedDraft.
23
+ # @return [String, nil]
23
24
  attr_accessor :signature_request_id
24
25
 
25
26
  # The URL to be used to claim this UnclaimedDraft.
27
+ # @return [String]
26
28
  attr_accessor :claim_url
27
29
 
28
30
  # The URL you want signers redirected to after they successfully sign.
31
+ # @return [String, nil]
29
32
  attr_accessor :signing_redirect_url
30
33
 
31
34
  # The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
35
+ # @return [String, nil]
32
36
  attr_accessor :requesting_redirect_url
33
37
 
34
38
  # When the link expires.
39
+ # @return [Integer, nil]
35
40
  attr_accessor :expires_at
36
41
 
37
42
  # Whether this is a test draft. Signature requests made from test drafts have no legal value.
43
+ # @return [Boolean]
38
44
  attr_accessor :test_mode
39
45
 
40
46
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,9 +20,11 @@ module Dropbox::Sign
20
20
  # A list of warnings.
21
21
  class WarningResponse
22
22
  # Warning message
23
+ # @return [String]
23
24
  attr_accessor :warning_msg
24
25
 
25
26
  # Warning name
27
+ # @return [String]
26
28
  attr_accessor :warning_name
27
29
 
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.0.0-beta2301'
17
+ VERSION = '1.0.1'
18
18
  end
data/openapi-config.yaml CHANGED
@@ -9,13 +9,18 @@ additionalProperties:
9
9
  gemName: dropbox-sign
10
10
  gemRequiredRubyVersion: '>= 2.7'
11
11
  moduleName: "Dropbox::Sign"
12
- gemVersion: 1.0.0-beta2301
12
+ gemVersion: 1.0.1
13
13
  sortModelPropertiesByRequiredFlag: true
14
14
  legacyDiscriminatorBehavior: true
15
+ gitUserId: hellosign
16
+ gitRepoId: dropbox-sign-ruby
15
17
  files:
16
18
  event_callback_helper.mustache:
17
19
  templateType: SupportingFiles
18
20
  destinationFilename: lib/dropbox-sign/event_callback_helper.rb
21
+ VERSION-root.mustache:
22
+ templateType: SupportingFiles
23
+ destinationFilename: VERSION
19
24
  globalProperties:
20
25
  apiTests: false
21
26
  modelTests: false
data/openapi-sdk.yaml CHANGED
@@ -6821,7 +6821,7 @@ components:
6821
6821
  $ref: '#/components/schemas/SubFormFieldRule'
6822
6822
  form_fields_per_document:
6823
6823
  description: |-
6824
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
6824
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
6825
6825
 
6826
6826
  **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.
6827
6827
 
@@ -6882,7 +6882,6 @@ components:
6882
6882
  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
6883
6883
  type: boolean
6884
6884
  default: false
6885
- x-beta: closed
6886
6885
  expires_at:
6887
6886
  description: |-
6888
6887
  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.
@@ -6975,7 +6974,6 @@ components:
6975
6974
  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
6976
6975
  type: boolean
6977
6976
  default: false
6978
- x-beta: closed
6979
6977
  type: object
6980
6978
  SignatureRequestRemindRequest:
6981
6979
  required:
@@ -7073,7 +7071,7 @@ components:
7073
7071
  $ref: '#/components/schemas/SubFormFieldRule'
7074
7072
  form_fields_per_document:
7075
7073
  description: |-
7076
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
7074
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
7077
7075
 
7078
7076
  **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.
7079
7077
 
@@ -7531,7 +7529,7 @@ components:
7531
7529
  type: object
7532
7530
  SubFormFieldsPerDocumentBase:
7533
7531
  description: |-
7534
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
7532
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
7535
7533
 
7536
7534
  **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.
7537
7535
 
@@ -7585,6 +7583,7 @@ components:
7585
7583
 
7586
7584
  **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7587
7585
  type: string
7586
+ x-int-or-string: true
7588
7587
  type:
7589
7588
  type: string
7590
7589
  width:
@@ -8059,7 +8058,7 @@ components:
8059
8058
  $ref: '#/components/schemas/SubFormFieldRule'
8060
8059
  form_fields_per_document:
8061
8060
  description: |-
8062
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
8061
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8063
8062
 
8064
8063
  **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.
8065
8064
 
@@ -8241,7 +8240,7 @@ components:
8241
8240
  $ref: '#/components/schemas/SubFormFieldRule'
8242
8241
  form_fields_per_document:
8243
8242
  description: |-
8244
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
8243
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8245
8244
 
8246
8245
  **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.
8247
8246
 
@@ -8405,7 +8404,7 @@ components:
8405
8404
  $ref: '#/components/schemas/SubFormFieldRule'
8406
8405
  form_fields_per_document:
8407
8406
  description: |-
8408
- The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: <a href="/docs/openapi/form-fields-per-document" target="_blank">Using Form Fields per Document</a>.)
8407
+ The fields that should appear on the document, expressed as an array of objects. (We're currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).)
8409
8408
 
8410
8409
  **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.
8411
8410
 
@@ -8508,7 +8507,6 @@ components:
8508
8507
  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
8509
8508
  type: boolean
8510
8509
  default: false
8511
- x-beta: closed
8512
8510
  expires_at:
8513
8511
  description: |-
8514
8512
  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.
@@ -8664,7 +8662,6 @@ components:
8664
8662
  ⚠️ **Note** ⚠️: Keep your signer's information safe by ensuring that the _signer on your signature request is the intended party_ before using this feature.
8665
8663
  type: boolean
8666
8664
  default: false
8667
- x-beta: closed
8668
8665
  type: object
8669
8666
  UnclaimedDraftEditAndResendRequest:
8670
8667
  required:
@@ -20,5 +20,29 @@ describe Dropbox::Sign::SubFormFieldsPerDocumentBase do
20
20
  expect(serialized.to_json).to be_json_eql(JSON.dump(data))
21
21
  end
22
22
  end
23
+
24
+ fixture_data.each do |type, data|
25
+ it "SubFormFieldsPerDocument allows int for signer property" do
26
+ data[:signer] = 1234
27
+ payload = { form_fields_per_document: [data] }
28
+ expected_signer = '1234'
29
+
30
+ obj = Dropbox::Sign::SignatureRequestSendRequest.init(payload)
31
+ form_fields_per_document = obj.form_fields_per_document[0]
32
+ expect(form_fields_per_document.signer).to eq(expected_signer)
33
+ end
34
+ end
35
+
36
+ fixture_data.each do |type, data|
37
+ it "SubFormFieldsPerDocument allows string for signer property" do
38
+ data[:signer] = 'sender'
39
+ payload = { form_fields_per_document: [data] }
40
+ expected_signer = 'sender'
41
+
42
+ obj = Dropbox::Sign::SignatureRequestSendRequest.init(payload)
43
+ form_fields_per_document = obj.form_fields_per_document[0]
44
+ expect(form_fields_per_document.signer).to eq(expected_signer)
45
+ end
46
+ end
23
47
  end
24
48
  end