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
@@ -20,25 +20,33 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentText < SubFormFieldsPerDocumentBase
22
22
  # A text input field. Use the `SubFormFieldsPerDocumentText` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Placeholder value for text field.
27
+ # @return [String]
26
28
  attr_accessor :placeholder
27
29
 
28
30
  # Auto fill type for populating fields automatically. Check out the list of [auto fill types](/api/reference/constants/#auto-fill-types) to learn more about the possible values.
31
+ # @return [String]
29
32
  attr_accessor :auto_fill_type
30
33
 
31
34
  # Link two or more text fields. Enter data into one linked text field, which automatically fill all other linked text fields.
35
+ # @return [String]
32
36
  attr_accessor :link_id
33
37
 
34
38
  # Masks entered data. For more information see [Masking sensitive information](https://faq.hellosign.com/hc/en-us/articles/360040742811-Masking-sensitive-information). `true` for masking the data in a text field, otherwise `false`.
39
+ # @return [Boolean]
35
40
  attr_accessor :masked
36
41
 
37
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
+ # @return [String]
38
44
  attr_accessor :validation_type
39
45
 
46
+ # @return [String]
40
47
  attr_accessor :validation_custom_regex
41
48
 
49
+ # @return [String]
42
50
  attr_accessor :validation_custom_regex_format_label
43
51
 
44
52
  class EnumAttributeValidator
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentTextMerge < SubFormFieldsPerDocumentBase
22
22
  # A text field that has default text set using pre-filled data. Use the `SubFormFieldsPerDocumentTextMerge` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,9 +19,11 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubMergeField
21
21
  # The name of the merge field. Must be unique.
22
+ # @return [String]
22
23
  attr_accessor :name
23
24
 
24
25
  # The type of merge field.
26
+ # @return [String]
25
27
  attr_accessor :type
26
28
 
27
29
  class EnumAttributeValidator
@@ -20,9 +20,11 @@ module Dropbox::Sign
20
20
  # OAuth related parameters.
21
21
  class SubOAuth
22
22
  # The callback URL to be used for OAuth flows. (Required if `oauth[scopes]` is provided)
23
+ # @return [String]
23
24
  attr_accessor :callback_url
24
25
 
25
26
  # A list of [OAuth scopes](/api/reference/tag/OAuth) to be granted to the app. (Required if `oauth[callback_url]` is provided).
27
+ # @return [Array<String>]
26
28
  attr_accessor :scopes
27
29
 
28
30
  class EnumAttributeValidator
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # Additional options supported by API App.
21
21
  class SubOptions
22
22
  # Determines if signers can use \"Insert Everywhere\" when signing a document.
23
+ # @return [Boolean]
23
24
  attr_accessor :can_insert_everywhere
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubSignatureRequestGroupedSigners
21
21
  # The name of the group.
22
+ # @return [String]
22
23
  attr_accessor :group
23
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.
26
+ # @return [Array<SubSignatureRequestSigner>]
25
27
  attr_accessor :signers
26
28
 
27
29
  # The order the group is required to sign in. Use this instead of Signer-level `order`.
30
+ # @return [Integer, nil]
28
31
  attr_accessor :order
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,21 +19,27 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubSignatureRequestSigner
21
21
  # The name of the signer.
22
+ # @return [String]
22
23
  attr_accessor :name
23
24
 
24
25
  # The email address of the signer.
26
+ # @return [String]
25
27
  attr_accessor :email_address
26
28
 
27
29
  # The order the signer is required to sign in.
30
+ # @return [Integer, nil]
28
31
  attr_accessor :order
29
32
 
30
33
  # The 4- to 12-character access code that will secure this signer's signature page.
34
+ # @return [String]
31
35
  attr_accessor :pin
32
36
 
33
37
  # An E.164 formatted phone number. **Note**: Not available in test mode and requires a Standard plan or higher.
38
+ # @return [String]
34
39
  attr_accessor :sms_phone_number
35
40
 
36
41
  # Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).
42
+ # @return [String]
37
43
  attr_accessor :sms_phone_number_type
38
44
 
39
45
  class EnumAttributeValidator
@@ -19,21 +19,27 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubSignatureRequestTemplateSigner
21
21
  # Must match an existing role in chosen Template(s). It's case-sensitive.
22
+ # @return [String]
22
23
  attr_accessor :role
23
24
 
24
25
  # The name of the signer.
26
+ # @return [String]
25
27
  attr_accessor :name
26
28
 
27
29
  # The email address of the signer.
30
+ # @return [String]
28
31
  attr_accessor :email_address
29
32
 
30
33
  # The 4- to 12-character access code that will secure this signer's signature page.
34
+ # @return [String]
31
35
  attr_accessor :pin
32
36
 
33
37
  # An E.164 formatted phone number. **Note**: Not available in test mode and requires a Standard plan or higher.
38
+ # @return [String]
34
39
  attr_accessor :sms_phone_number
35
40
 
36
41
  # Specifies the feature used with the `sms_phone_number`. Default `authentication`. If `authentication`, signer is sent a verification code via SMS that is required to access the document. If `delivery`, a link to complete the signature request is delivered via SMS (_and_ email).
42
+ # @return [String]
37
43
  attr_accessor :sms_phone_number_type
38
44
 
39
45
  class EnumAttributeValidator
@@ -20,18 +20,23 @@ module Dropbox::Sign
20
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
+ # @return [String]
23
24
  attr_accessor :default_type
24
25
 
25
26
  # Allows drawing the signature
27
+ # @return [Boolean]
26
28
  attr_accessor :draw
27
29
 
28
30
  # Allows using a smartphone to email the signature
31
+ # @return [Boolean]
29
32
  attr_accessor :phone
30
33
 
31
34
  # Allows typing the signature
35
+ # @return [Boolean]
32
36
  attr_accessor :type
33
37
 
34
38
  # Allows uploading the signature
39
+ # @return [Boolean]
35
40
  attr_accessor :upload
36
41
 
37
42
  class EnumAttributeValidator
@@ -19,9 +19,11 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubTeamResponse
21
21
  # The id of a team
22
+ # @return [String]
22
23
  attr_accessor :team_id
23
24
 
24
25
  # The name of a team
26
+ # @return [String]
25
27
  attr_accessor :name
26
28
 
27
29
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,9 +19,11 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubTemplateRole
21
21
  # The role name of the signer that will be displayed when the template is used to create a signature request.
22
+ # @return [String]
22
23
  attr_accessor :name
23
24
 
24
25
  # The order in which this signer role is required to sign.
26
+ # @return [Integer, nil]
25
27
  attr_accessor :order
26
28
 
27
29
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubUnclaimedDraftSigner
21
21
  # The email address of the signer.
22
+ # @return [String]
22
23
  attr_accessor :email_address
23
24
 
24
25
  # The name of the signer.
26
+ # @return [String]
25
27
  attr_accessor :name
26
28
 
27
29
  # The order the signer is required to sign in.
30
+ # @return [Integer, nil]
28
31
  attr_accessor :order
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubUnclaimedDraftTemplateSigner
21
21
  # Must match an existing role in chosen Template(s).
22
+ # @return [String]
22
23
  attr_accessor :role
23
24
 
24
25
  # The name of the signer filling the role of `role`.
26
+ # @return [String]
25
27
  attr_accessor :name
26
28
 
27
29
  # The email address of the signer filling the role of `role`.
30
+ # @return [String]
28
31
  attr_accessor :email_address
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,35 +19,50 @@ end
19
19
  module Dropbox::Sign
20
20
  # An array of elements and values serialized to a string, to be used to customize the app's signer page. (Only applies to some API plans) Take a look at our [white labeling guide](/api/reference/white-labeling/) to learn more.
21
21
  class SubWhiteLabelingOptions
22
+ # @return [String]
22
23
  attr_accessor :header_background_color
23
24
 
25
+ # @return [String]
24
26
  attr_accessor :legal_version
25
27
 
28
+ # @return [String]
26
29
  attr_accessor :link_color
27
30
 
31
+ # @return [String]
28
32
  attr_accessor :page_background_color
29
33
 
34
+ # @return [String]
30
35
  attr_accessor :primary_button_color
31
36
 
37
+ # @return [String]
32
38
  attr_accessor :primary_button_color_hover
33
39
 
40
+ # @return [String]
34
41
  attr_accessor :primary_button_text_color
35
42
 
43
+ # @return [String]
36
44
  attr_accessor :primary_button_text_color_hover
37
45
 
46
+ # @return [String]
38
47
  attr_accessor :secondary_button_color
39
48
 
49
+ # @return [String]
40
50
  attr_accessor :secondary_button_color_hover
41
51
 
52
+ # @return [String]
42
53
  attr_accessor :secondary_button_text_color
43
54
 
55
+ # @return [String]
44
56
  attr_accessor :secondary_button_text_color_hover
45
57
 
58
+ # @return [String]
46
59
  attr_accessor :text_color1
47
60
 
61
+ # @return [String]
48
62
  attr_accessor :text_color2
49
63
 
50
64
  # Resets white labeling options to defaults. Only useful when updating an API App.
65
+ # @return [Boolean]
51
66
  attr_accessor :reset_to_default
52
67
 
53
68
  class EnumAttributeValidator
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamAddMemberRequest
21
21
  # `account_id` or `email_address` is required. If both are provided, the account id prevails. Account id of the user to invite to your Team.
22
+ # @return [String]
22
23
  attr_accessor :account_id
23
24
 
24
25
  # `account_id` or `email_address` is required, If both are provided, the account id prevails. Email address of the user to invite to your Team.
26
+ # @return [String]
25
27
  attr_accessor :email_address
26
28
 
27
29
  # A role member will take in a new Team. **Note**: This parameter is used only if `team_id` is provided.
30
+ # @return [String]
28
31
  attr_accessor :role
29
32
 
30
33
  class EnumAttributeValidator
@@ -19,6 +19,7 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamCreateRequest
21
21
  # The name of your Team.
22
+ # @return [String]
22
23
  attr_accessor :name
23
24
 
24
25
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -18,9 +18,11 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TeamGetInfoResponse
21
+ # @return [TeamInfoResponse]
21
22
  attr_accessor :team
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.
@@ -18,9 +18,11 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TeamGetResponse
21
+ # @return [TeamResponse]
21
22
  attr_accessor :team
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,17 +19,22 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamInfoResponse
21
21
  # The id of a team
22
+ # @return [String]
22
23
  attr_accessor :team_id
23
24
 
25
+ # @return [TeamParentResponse, nil]
24
26
  attr_accessor :team_parent
25
27
 
26
28
  # The name of a team
29
+ # @return [String]
27
30
  attr_accessor :name
28
31
 
29
32
  # Number of members within a team
33
+ # @return [Integer]
30
34
  attr_accessor :num_members
31
35
 
32
36
  # Number of sub teams within a team
37
+ # @return [Integer]
33
38
  attr_accessor :num_sub_teams
34
39
 
35
40
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,21 +19,27 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamInviteResponse
21
21
  # Email address of the user invited to this team.
22
+ # @return [String]
22
23
  attr_accessor :email_address
23
24
 
24
25
  # Id of the team.
26
+ # @return [String]
25
27
  attr_accessor :team_id
26
28
 
27
29
  # Role of the user invited to this team.
30
+ # @return [String]
28
31
  attr_accessor :role
29
32
 
30
33
  # Timestamp when the invitation was sent.
34
+ # @return [Integer]
31
35
  attr_accessor :sent_at
32
36
 
33
37
  # Timestamp when the invitation was redeemed.
38
+ # @return [Integer]
34
39
  attr_accessor :redeemed_at
35
40
 
36
41
  # Timestamp when the invitation is expiring.
42
+ # @return [Integer]
37
43
  attr_accessor :expires_at
38
44
 
39
45
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,8 +19,10 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamInvitesResponse
21
21
  # Contains a list of team invites and their roles.
22
+ # @return [Array<TeamInviteResponse>]
22
23
  attr_accessor :team_invites
23
24
 
25
+ # @return [Array<WarningResponse>]
24
26
  attr_accessor :warnings
25
27
 
26
28
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamMemberResponse
21
21
  # Account id of the team member.
22
+ # @return [String]
22
23
  attr_accessor :account_id
23
24
 
24
25
  # Email address of the team member.
26
+ # @return [String]
25
27
  attr_accessor :email_address
26
28
 
27
29
  # The specific role a member has on the team.
30
+ # @return [String]
28
31
  attr_accessor :role
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,10 +19,13 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamMembersResponse
21
21
  # Contains a list of team members and their roles for a specific team.
22
+ # @return [Array<TeamMemberResponse>]
22
23
  attr_accessor :team_members
23
24
 
25
+ # @return [ListInfoResponse]
24
26
  attr_accessor :list_info
25
27
 
28
+ # @return [Array<WarningResponse>]
26
29
  attr_accessor :warnings
27
30
 
28
31
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,9 +20,11 @@ module Dropbox::Sign
20
20
  # Information about the parent team if a team has one, set to `null` otherwise.
21
21
  class TeamParentResponse
22
22
  # The id of a team
23
+ # @return [String]
23
24
  attr_accessor :team_id
24
25
 
25
26
  # The name of a team
27
+ # @return [String]
26
28
  attr_accessor :name
27
29
 
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,18 +19,23 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamRemoveMemberRequest
21
21
  # **account_id** or **email_address** is required. If both are provided, the account id prevails. Account id to remove from your Team.
22
+ # @return [String]
22
23
  attr_accessor :account_id
23
24
 
24
25
  # **account_id** or **email_address** is required. If both are provided, the account id prevails. Email address of the Account to remove from your Team.
26
+ # @return [String]
25
27
  attr_accessor :email_address
26
28
 
27
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
+ # @return [String]
28
31
  attr_accessor :new_owner_email_address
29
32
 
30
33
  # Id of the new Team.
34
+ # @return [String]
31
35
  attr_accessor :new_team_id
32
36
 
33
37
  # A new role member will take in a new Team. **Note**: This parameter is used only if `new_team_id` is provided.
38
+ # @return [String]
34
39
  attr_accessor :new_role
35
40
 
36
41
  class EnumAttributeValidator
@@ -20,11 +20,14 @@ module Dropbox::Sign
20
20
  # Contains information about your team and its members
21
21
  class TeamResponse
22
22
  # The name of your Team
23
+ # @return [String]
23
24
  attr_accessor :name
24
25
 
26
+ # @return [Array<AccountResponse>]
25
27
  attr_accessor :accounts
26
28
 
27
29
  # A list of all Accounts that have an outstanding invitation to join your Team. Note that this response is a subset of the response parameters found in `GET /account`.
30
+ # @return [Array<AccountResponse>]
28
31
  attr_accessor :invited_accounts
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,10 +19,13 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamSubTeamsResponse
21
21
  # Contains a list with sub teams.
22
+ # @return [Array<SubTeamResponse>]
22
23
  attr_accessor :sub_teams
23
24
 
25
+ # @return [ListInfoResponse]
24
26
  attr_accessor :list_info
25
27
 
28
+ # @return [Array<WarningResponse>]
26
29
  attr_accessor :warnings
27
30
 
28
31
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,6 +19,7 @@ end
19
19
  module Dropbox::Sign
20
20
  class TeamUpdateRequest
21
21
  # The name of your Team.
22
+ # @return [String]
22
23
  attr_accessor :name
23
24
 
24
25
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class TemplateAddUserRequest
21
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.
22
+ # @return [String]
22
23
  attr_accessor :account_id
23
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.
26
+ # @return [String]
25
27
  attr_accessor :email_address
26
28
 
27
29
  # If set to `true`, the user does not receive an email notification when a template has been shared with them. Defaults to `false`.
30
+ # @return [Boolean]
28
31
  attr_accessor :skip_notification
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,76 +19,101 @@ end
19
19
  module Dropbox::Sign
20
20
  class TemplateCreateEmbeddedDraftRequest
21
21
  # Client id of the app you're using to create this 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
  # 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
  # This allows the requester to specify whether the user is allowed to provide email addresses to CC when creating a template.
34
+ # @return [Boolean]
31
35
  attr_accessor :allow_ccs
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
  # A list describing the attachments
42
+ # @return [Array<SubAttachment>]
37
43
  attr_accessor :attachments
38
44
 
39
45
  # The CC roles that must be assigned when using the template to send a signature request
46
+ # @return [Array<String>]
40
47
  attr_accessor :cc_roles
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
  # Provide users the ability to review/edit the template signer roles.
56
+ # @return [Boolean]
47
57
  attr_accessor :force_signer_roles
48
58
 
49
59
  # Provide users the ability to review/edit the template subject and message.
60
+ # @return [Boolean]
50
61
  attr_accessor :force_subject_message
51
62
 
52
63
  # 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`.
64
+ # @return [Array<SubFormFieldGroup>]
53
65
  attr_accessor :form_field_groups
54
66
 
55
67
  # Conditional Logic rules for fields defined in `form_fields_per_document`.
68
+ # @return [Array<SubFormFieldRule>]
56
69
  attr_accessor :form_field_rules
57
70
 
58
- # 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`
71
+ # 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`
72
+ # @return [Array<SubFormFieldsPerDocumentBase>]
59
73
  attr_accessor :form_fields_per_document
60
74
 
61
75
  # Add merge fields to the template. Merge fields are placed by the user creating the template and used to pre-fill data by passing values into signature requests with the `custom_fields` parameter. If the signature request using that template *does not* pass a value into a merge field, then an empty field remains in the document.
76
+ # @return [Array<SubMergeField>]
62
77
  attr_accessor :merge_fields
63
78
 
64
79
  # The default template email message.
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 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.
88
+ # @return [Boolean]
71
89
  attr_accessor :show_preview
72
90
 
73
91
  # When only one step remains in the signature request process and this parameter is set to `false` then the progress stepper will be hidden.
92
+ # @return [Boolean]
74
93
  attr_accessor :show_progress_stepper
75
94
 
76
95
  # An array of the designated signer roles that must be specified when sending a SignatureRequest using this Template.
96
+ # @return [Array<SubTemplateRole>]
77
97
  attr_accessor :signer_roles
78
98
 
79
99
  # Disables the \"Me (Now)\" option for the person preparing the document. Does not work with type `send_document`. Defaults to `false`.
100
+ # @return [Boolean]
80
101
  attr_accessor :skip_me_now
81
102
 
82
103
  # The template title (alias).
104
+ # @return [String]
83
105
  attr_accessor :subject
84
106
 
85
107
  # Whether this is a test, the signature request created from this draft will not be legally binding if set to `true`. Defaults to `false`.
108
+ # @return [Boolean]
86
109
  attr_accessor :test_mode
87
110
 
88
111
  # The title you want to assign to the SignatureRequest.
112
+ # @return [String]
89
113
  attr_accessor :title
90
114
 
91
115
  # Enable the detection of predefined PDF fields by setting the `use_preexisting_fields` to `true` (defaults to disabled, or `false`).
116
+ # @return [Boolean]
92
117
  attr_accessor :use_preexisting_fields
93
118
 
94
119
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -18,9 +18,11 @@ end
18
18
 
19
19
  module Dropbox::Sign
20
20
  class TemplateCreateEmbeddedDraftResponse
21
+ # @return [TemplateCreateEmbeddedDraftResponseTemplate]
21
22
  attr_accessor :template
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.