dropbox-sign 1.0.0.pre.beta2301 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (159) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +7 -9
  4. data/bin/check-clean-git-status +15 -0
  5. data/examples/EventCallback.rb +1 -4
  6. data/lib/dropbox-sign/models/account_create_request.rb +4 -0
  7. data/lib/dropbox-sign/models/account_create_response.rb +3 -0
  8. data/lib/dropbox-sign/models/account_get_response.rb +2 -0
  9. data/lib/dropbox-sign/models/account_response.rb +10 -0
  10. data/lib/dropbox-sign/models/account_response_quotas.rb +5 -0
  11. data/lib/dropbox-sign/models/account_update_request.rb +3 -0
  12. data/lib/dropbox-sign/models/account_verify_request.rb +1 -0
  13. data/lib/dropbox-sign/models/account_verify_response.rb +2 -0
  14. data/lib/dropbox-sign/models/account_verify_response_account.rb +1 -0
  15. data/lib/dropbox-sign/models/api_app_create_request.rb +7 -0
  16. data/lib/dropbox-sign/models/api_app_get_response.rb +2 -0
  17. data/lib/dropbox-sign/models/api_app_list_response.rb +3 -0
  18. data/lib/dropbox-sign/models/api_app_response.rb +10 -0
  19. data/lib/dropbox-sign/models/api_app_response_o_auth.rb +4 -0
  20. data/lib/dropbox-sign/models/api_app_response_options.rb +1 -0
  21. data/lib/dropbox-sign/models/api_app_response_owner_account.rb +2 -0
  22. data/lib/dropbox-sign/models/api_app_response_white_labeling_options.rb +14 -0
  23. data/lib/dropbox-sign/models/api_app_update_request.rb +7 -0
  24. data/lib/dropbox-sign/models/bulk_send_job_get_response.rb +4 -0
  25. data/lib/dropbox-sign/models/bulk_send_job_get_response_signature_requests.rb +24 -0
  26. data/lib/dropbox-sign/models/bulk_send_job_list_response.rb +3 -0
  27. data/lib/dropbox-sign/models/bulk_send_job_response.rb +4 -0
  28. data/lib/dropbox-sign/models/bulk_send_job_send_response.rb +2 -0
  29. data/lib/dropbox-sign/models/embedded_edit_url_request.rb +10 -0
  30. data/lib/dropbox-sign/models/embedded_edit_url_response.rb +2 -0
  31. data/lib/dropbox-sign/models/embedded_edit_url_response_embedded.rb +2 -0
  32. data/lib/dropbox-sign/models/embedded_sign_url_response.rb +2 -0
  33. data/lib/dropbox-sign/models/embedded_sign_url_response_embedded.rb +2 -0
  34. data/lib/dropbox-sign/models/error_response.rb +1 -0
  35. data/lib/dropbox-sign/models/error_response_error.rb +3 -0
  36. data/lib/dropbox-sign/models/event_callback_request.rb +4 -0
  37. data/lib/dropbox-sign/models/event_callback_request_event.rb +4 -0
  38. data/lib/dropbox-sign/models/event_callback_request_event_metadata.rb +4 -0
  39. data/lib/dropbox-sign/models/file_response.rb +2 -0
  40. data/lib/dropbox-sign/models/file_response_data_uri.rb +1 -0
  41. data/lib/dropbox-sign/models/list_info_response.rb +4 -0
  42. data/lib/dropbox-sign/models/o_auth_token_generate_request.rb +5 -0
  43. data/lib/dropbox-sign/models/o_auth_token_refresh_request.rb +2 -0
  44. data/lib/dropbox-sign/models/o_auth_token_response.rb +5 -0
  45. data/lib/dropbox-sign/models/report_create_request.rb +3 -0
  46. data/lib/dropbox-sign/models/report_create_response.rb +2 -0
  47. data/lib/dropbox-sign/models/report_response.rb +4 -0
  48. data/lib/dropbox-sign/models/signature_request_bulk_create_embedded_with_template_request.rb +13 -0
  49. data/lib/dropbox-sign/models/signature_request_bulk_send_with_template_request.rb +13 -0
  50. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +24 -0
  51. data/lib/dropbox-sign/models/signature_request_create_embedded_with_template_request.rb +15 -0
  52. data/lib/dropbox-sign/models/signature_request_get_response.rb +2 -0
  53. data/lib/dropbox-sign/models/signature_request_list_response.rb +3 -0
  54. data/lib/dropbox-sign/models/signature_request_remind_request.rb +2 -0
  55. data/lib/dropbox-sign/models/signature_request_response.rb +23 -0
  56. data/lib/dropbox-sign/models/signature_request_response_attachment.rb +6 -0
  57. data/lib/dropbox-sign/models/signature_request_response_custom_field_base.rb +5 -0
  58. data/lib/dropbox-sign/models/signature_request_response_custom_field_checkbox.rb +2 -0
  59. data/lib/dropbox-sign/models/signature_request_response_custom_field_text.rb +2 -0
  60. data/lib/dropbox-sign/models/signature_request_response_data_base.rb +5 -0
  61. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox.rb +2 -0
  62. data/lib/dropbox-sign/models/signature_request_response_data_value_checkbox_merge.rb +2 -0
  63. data/lib/dropbox-sign/models/signature_request_response_data_value_date_signed.rb +2 -0
  64. data/lib/dropbox-sign/models/signature_request_response_data_value_dropdown.rb +2 -0
  65. data/lib/dropbox-sign/models/signature_request_response_data_value_initials.rb +2 -0
  66. data/lib/dropbox-sign/models/signature_request_response_data_value_radio.rb +2 -0
  67. data/lib/dropbox-sign/models/signature_request_response_data_value_signature.rb +2 -0
  68. data/lib/dropbox-sign/models/signature_request_response_data_value_text.rb +2 -0
  69. data/lib/dropbox-sign/models/signature_request_response_data_value_text_merge.rb +2 -0
  70. data/lib/dropbox-sign/models/signature_request_response_signatures.rb +19 -0
  71. data/lib/dropbox-sign/models/signature_request_send_request.rb +25 -0
  72. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +16 -0
  73. data/lib/dropbox-sign/models/signature_request_update_request.rb +4 -0
  74. data/lib/dropbox-sign/models/sub_attachment.rb +4 -0
  75. data/lib/dropbox-sign/models/sub_bulk_signer_list.rb +2 -0
  76. data/lib/dropbox-sign/models/sub_bulk_signer_list_custom_field.rb +2 -0
  77. data/lib/dropbox-sign/models/sub_cc.rb +2 -0
  78. data/lib/dropbox-sign/models/sub_custom_field.rb +4 -0
  79. data/lib/dropbox-sign/models/sub_editor_options.rb +2 -0
  80. data/lib/dropbox-sign/models/sub_field_options.rb +1 -0
  81. data/lib/dropbox-sign/models/sub_form_field_group.rb +3 -0
  82. data/lib/dropbox-sign/models/sub_form_field_rule.rb +4 -0
  83. data/lib/dropbox-sign/models/sub_form_field_rule_action.rb +4 -0
  84. data/lib/dropbox-sign/models/sub_form_field_rule_trigger.rb +4 -0
  85. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +11 -0
  86. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox.rb +3 -0
  87. data/lib/dropbox-sign/models/sub_form_fields_per_document_checkbox_merge.rb +1 -0
  88. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +1 -0
  89. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +3 -0
  90. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +3 -0
  91. data/lib/dropbox-sign/models/sub_form_fields_per_document_initials.rb +1 -0
  92. data/lib/dropbox-sign/models/sub_form_fields_per_document_radio.rb +3 -0
  93. data/lib/dropbox-sign/models/sub_form_fields_per_document_signature.rb +1 -0
  94. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +8 -0
  95. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +1 -0
  96. data/lib/dropbox-sign/models/sub_merge_field.rb +2 -0
  97. data/lib/dropbox-sign/models/sub_o_auth.rb +2 -0
  98. data/lib/dropbox-sign/models/sub_options.rb +1 -0
  99. data/lib/dropbox-sign/models/sub_signature_request_grouped_signers.rb +3 -0
  100. data/lib/dropbox-sign/models/sub_signature_request_signer.rb +6 -0
  101. data/lib/dropbox-sign/models/sub_signature_request_template_signer.rb +6 -0
  102. data/lib/dropbox-sign/models/sub_signing_options.rb +5 -0
  103. data/lib/dropbox-sign/models/sub_team_response.rb +2 -0
  104. data/lib/dropbox-sign/models/sub_template_role.rb +2 -0
  105. data/lib/dropbox-sign/models/sub_unclaimed_draft_signer.rb +3 -0
  106. data/lib/dropbox-sign/models/sub_unclaimed_draft_template_signer.rb +3 -0
  107. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +15 -0
  108. data/lib/dropbox-sign/models/team_add_member_request.rb +3 -0
  109. data/lib/dropbox-sign/models/team_create_request.rb +1 -0
  110. data/lib/dropbox-sign/models/team_get_info_response.rb +2 -0
  111. data/lib/dropbox-sign/models/team_get_response.rb +2 -0
  112. data/lib/dropbox-sign/models/team_info_response.rb +5 -0
  113. data/lib/dropbox-sign/models/team_invite_response.rb +6 -0
  114. data/lib/dropbox-sign/models/team_invites_response.rb +2 -0
  115. data/lib/dropbox-sign/models/team_member_response.rb +3 -0
  116. data/lib/dropbox-sign/models/team_members_response.rb +3 -0
  117. data/lib/dropbox-sign/models/team_parent_response.rb +2 -0
  118. data/lib/dropbox-sign/models/team_remove_member_request.rb +5 -0
  119. data/lib/dropbox-sign/models/team_response.rb +3 -0
  120. data/lib/dropbox-sign/models/team_sub_teams_response.rb +3 -0
  121. data/lib/dropbox-sign/models/team_update_request.rb +1 -0
  122. data/lib/dropbox-sign/models/template_add_user_request.rb +3 -0
  123. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +25 -0
  124. data/lib/dropbox-sign/models/template_create_embedded_draft_response.rb +2 -0
  125. data/lib/dropbox-sign/models/template_create_embedded_draft_response_template.rb +4 -0
  126. data/lib/dropbox-sign/models/template_edit_response.rb +1 -0
  127. data/lib/dropbox-sign/models/template_get_response.rb +2 -0
  128. data/lib/dropbox-sign/models/template_list_response.rb +3 -0
  129. data/lib/dropbox-sign/models/template_remove_user_request.rb +2 -0
  130. data/lib/dropbox-sign/models/template_response.rb +15 -0
  131. data/lib/dropbox-sign/models/template_response_account.rb +6 -0
  132. data/lib/dropbox-sign/models/template_response_account_quota.rb +4 -0
  133. data/lib/dropbox-sign/models/template_response_cc_role.rb +1 -0
  134. data/lib/dropbox-sign/models/template_response_custom_field.rb +13 -0
  135. data/lib/dropbox-sign/models/template_response_document.rb +6 -0
  136. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +16 -0
  137. data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -0
  138. data/lib/dropbox-sign/models/template_response_document_form_field.rb +14 -0
  139. data/lib/dropbox-sign/models/template_response_document_static_field.rb +10 -0
  140. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +2 -0
  141. data/lib/dropbox-sign/models/template_response_named_form_field.rb +14 -0
  142. data/lib/dropbox-sign/models/template_response_signer_role.rb +2 -0
  143. data/lib/dropbox-sign/models/template_update_files_request.rb +6 -0
  144. data/lib/dropbox-sign/models/template_update_files_response.rb +1 -0
  145. data/lib/dropbox-sign/models/template_update_files_response_template.rb +2 -0
  146. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +36 -0
  147. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_with_template_request.rb +29 -0
  148. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +24 -0
  149. data/lib/dropbox-sign/models/unclaimed_draft_create_response.rb +2 -0
  150. data/lib/dropbox-sign/models/unclaimed_draft_edit_and_resend_request.rb +8 -0
  151. data/lib/dropbox-sign/models/unclaimed_draft_response.rb +6 -0
  152. data/lib/dropbox-sign/models/warning_response.rb +2 -0
  153. data/lib/dropbox-sign/version.rb +1 -1
  154. data/openapi-config.yaml +3 -1
  155. data/openapi-sdk.yaml +1 -0
  156. data/spec/models/sub_form_fields_per_document_base_spec.rb +24 -0
  157. data/templates/README.mustache +3 -5
  158. data/templates/partial_model_generic.mustache +1 -0
  159. metadata +5 -4
@@ -20,15 +20,19 @@ module Dropbox::Sign
20
20
  # 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.
21
21
  class SubCustomField
22
22
  # The name of a custom field. When working with pre-filled data, the custom field's name must have a matching merge field name or the field will remain empty on the document during signing.
23
+ # @return [String]
23
24
  attr_accessor :name
24
25
 
25
26
  # Used to create editable merge fields. When the value matches a role passed in with `signers`, that role can edit the data that was pre-filled to that field. This field is optional, but required when this custom field object is set to `required = true`. **Note**: Editable merge fields are only supported for single signer requests (or the first signer in ordered signature requests). If used when there are multiple signers in an unordered signature request, the editor value is ignored and the field won't be editable.
27
+ # @return [String]
26
28
  attr_accessor :editor
27
29
 
28
30
  # Used to set an editable merge field when working with pre-filled data. When `true`, the custom field must specify a signer role in `editor`.
31
+ # @return [Boolean]
29
32
  attr_accessor :required
30
33
 
31
34
  # The string that resolves (aka \"pre-fills\") to the merge field on the final document(s) used for signing.
35
+ # @return [String]
32
36
  attr_accessor :value
33
37
 
34
38
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,9 +20,11 @@ module Dropbox::Sign
20
20
  # This allows the requester to specify editor options when a preparing a document
21
21
  class SubEditorOptions
22
22
  # Allows requesters to edit the list of signers
23
+ # @return [Boolean]
23
24
  attr_accessor :allow_edit_signers
24
25
 
25
26
  # Allows requesters to edit documents, including delete and add
27
+ # @return [Boolean]
26
28
  attr_accessor :allow_edit_documents
27
29
 
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This allows the requester to specify field options for a signature request.
21
21
  class SubFieldOptions
22
22
  # Allows requester to specify the date format (see list of allowed [formats](/api/reference/constants/#date-formats)) **Note**: Only available for Premium and higher.
23
+ # @return [String]
23
24
  attr_accessor :date_format
24
25
 
25
26
  class EnumAttributeValidator
@@ -19,12 +19,15 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubFormFieldGroup
21
21
  # ID of group. Use this to reference a specific group from the `group` value in `form_fields_per_document`.
22
+ # @return [String]
22
23
  attr_accessor :group_id
23
24
 
24
25
  # Name of the group
26
+ # @return [String]
25
27
  attr_accessor :group_label
26
28
 
27
29
  # Examples: `require_0-1` `require_1` `require_1-ormore` - Check out the list of [acceptable `requirement` checkbox type values](/api/reference/constants/#checkbox-field-grouping). - Check out the list of [acceptable `requirement` radio type fields](/api/reference/constants/#radio-field-grouping). - Radio groups require **at least** two fields per group.
30
+ # @return [String]
28
31
  attr_accessor :requirement
29
32
 
30
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,15 +19,19 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubFormFieldRule
21
21
  # Must be unique across all defined rules.
22
+ # @return [String]
22
23
  attr_accessor :id
23
24
 
24
25
  # Currently only `AND` is supported. Support for `OR` is being worked on.
26
+ # @return [String]
25
27
  attr_accessor :trigger_operator
26
28
 
27
29
  # An array of trigger definitions, the \"if this\" part of \"**if this**, then that\". Currently only a single trigger per rule is allowed.
30
+ # @return [Array<SubFormFieldRuleTrigger>]
28
31
  attr_accessor :triggers
29
32
 
30
33
  # An array of action definitions, the \"then that\" part of \"if this, **then that**\". Any number of actions may be attached to a single rule.
34
+ # @return [Array<SubFormFieldRuleAction>]
31
35
  attr_accessor :actions
32
36
 
33
37
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,14 +19,18 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubFormFieldRuleAction
21
21
  # `true` to hide the target field when rule is satisfied, otherwise `false`.
22
+ # @return [Boolean]
22
23
  attr_accessor :hidden
23
24
 
25
+ # @return [String]
24
26
  attr_accessor :type
25
27
 
26
28
  # **field_id** or **group_id** is required, but not both. Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Cannot use with `group_id`. Trigger and action fields must belong to the same signer.
29
+ # @return [String]
27
30
  attr_accessor :field_id
28
31
 
29
32
  # **group_id** or **field_id** is required, but not both. Must reference the ID of an existing group defined within `form_field_groups`. Cannot use with `field_id`. Trigger and action fields and groups must belong to the same signer.
33
+ # @return [String]
30
34
  attr_accessor :group_id
31
35
 
32
36
  class EnumAttributeValidator
@@ -19,15 +19,19 @@ end
19
19
  module Dropbox::Sign
20
20
  class SubFormFieldRuleTrigger
21
21
  # Must reference the `api_id` of an existing field defined within `form_fields_per_document`. Trigger and action fields and groups must belong to the same signer.
22
+ # @return [String]
22
23
  attr_accessor :id
23
24
 
24
25
  # Different field types allow different `operator` values: - Field type of **text**: - **is**: exact match - **not**: not exact match - **match**: regular expression, without /. Example: - OK `[a-zA-Z0-9]` - Not OK `/[a-zA-Z0-9]/` - Field type of **dropdown**: - **is**: exact match, single value - **not**: not exact match, single value - **any**: exact match, array of values. - **none**: not exact match, array of values. - Field type of **checkbox**: - **is**: exact match, single value - **not**: not exact match, single value - Field type of **radio**: - **is**: exact match, single value - **not**: not exact match, single value
26
+ # @return [String]
25
27
  attr_accessor :operator
26
28
 
27
29
  # **value** or **values** is required, but not both. The value to match against **operator**. - When **operator** is one of the following, **value** must be `String`: - `is` - `not` - `match` Otherwise, - **checkbox**: When **type** of trigger is **checkbox**, **value** must be `0` or `1` - **radio**: When **type** of trigger is **radio**, **value** must be `1`
30
+ # @return [String]
28
31
  attr_accessor :value
29
32
 
30
33
  # **values** or **value** is required, but not both. The values to match against **operator** when it is one of the following: - `any` - `none`
34
+ # @return [Array<String>]
31
35
  attr_accessor :values
32
36
 
33
37
  class EnumAttributeValidator
@@ -20,35 +20,46 @@ module Dropbox::Sign
20
20
  # 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`
21
21
  class SubFormFieldsPerDocumentBase
22
22
  # Represents the integer index of the `file` or `file_url` document the field should be attached to.
23
+ # @return [Integer]
23
24
  attr_accessor :document_index
24
25
 
25
26
  # An identifier for the field that is unique across all documents in the request.
27
+ # @return [String]
26
28
  attr_accessor :api_id
27
29
 
28
30
  # Size of the field in pixels.
31
+ # @return [Integer]
29
32
  attr_accessor :height
30
33
 
31
34
  # Whether this field is required.
35
+ # @return [Boolean]
32
36
  attr_accessor :required
33
37
 
34
38
  # Signer index identified by the offset in the signers parameter (0-based indexing), indicating which signer should fill out the field. **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
39
+ # @return [Integer, String]
35
40
  attr_accessor :signer
36
41
 
42
+ # @return [String]
37
43
  attr_accessor :type
38
44
 
39
45
  # Size of the field in pixels.
46
+ # @return [Integer]
40
47
  attr_accessor :width
41
48
 
42
49
  # Location coordinates of the field in pixels.
50
+ # @return [Integer]
43
51
  attr_accessor :x
44
52
 
45
53
  # Location coordinates of the field in pixels.
54
+ # @return [Integer]
46
55
  attr_accessor :y
47
56
 
48
57
  # Display name for the field.
58
+ # @return [String]
49
59
  attr_accessor :name
50
60
 
51
61
  # Page in the document where the field should be placed (requires documents be PDF files). - When the page number parameter is supplied, the API will use the new coordinate system. - Check out the differences between both [coordinate systems](https://faq.hellosign.com/hc/en-us/articles/217115577) and how to use them.
62
+ # @return [Integer, nil]
52
63
  attr_accessor :page
53
64
 
54
65
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,12 +20,15 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentCheckbox < SubFormFieldsPerDocumentBase
22
22
  # A yes/no checkbox. Use the `SubFormFieldsPerDocumentCheckbox` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # `true` for checking the checkbox field by default, otherwise `false`.
27
+ # @return [Boolean]
26
28
  attr_accessor :is_checked
27
29
 
28
30
  # String referencing group defined in `form_field_groups` parameter.
31
+ # @return [String]
29
32
  attr_accessor :group
30
33
 
31
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentCheckboxMerge < SubFormFieldsPerDocumentBase
22
22
  # A checkbox field that has default value set using pre-filled data. Use the `SubFormFieldsPerDocumentCheckboxMerge` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentDateSigned < SubFormFieldsPerDocumentBase
22
22
  # A date. Use the `SubFormFieldsPerDocumentDateSigned` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,12 +20,15 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentDropdown < SubFormFieldsPerDocumentBase
22
22
  # An input field for dropdowns. Use the `SubFormFieldsPerDocumentDropdown` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Array of string values representing dropdown values.
27
+ # @return [Array<String>]
26
28
  attr_accessor :options
27
29
 
28
30
  # Selected value in `options` array. Value must exist in array.
31
+ # @return [String]
29
32
  attr_accessor :content
30
33
 
31
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,12 +20,15 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentHyperlink < SubFormFieldsPerDocumentBase
22
22
  # A hyperlink field. Use the `SubFormFieldsPerDocumentHyperlink` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Link Text.
27
+ # @return [String]
26
28
  attr_accessor :content
27
29
 
28
30
  # Link URL.
31
+ # @return [String]
29
32
  attr_accessor :content_url
30
33
 
31
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentInitials < SubFormFieldsPerDocumentBase
22
22
  # An input field for initials. Use the `SubFormFieldsPerDocumentInitials` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,12 +20,15 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentRadio < SubFormFieldsPerDocumentBase
22
22
  # An input field for radios. Use the `SubFormFieldsPerDocumentRadio` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # String referencing group defined in `form_field_groups` parameter.
27
+ # @return [String]
26
28
  attr_accessor :group
27
29
 
28
30
  # `true` for checking the radio field by default, otherwise `false`. Only one radio field per group can be `true`.
31
+ # @return [Boolean]
29
32
  attr_accessor :is_checked
30
33
 
31
34
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,6 +20,7 @@ module Dropbox::Sign
20
20
  # This class extends `SubFormFieldsPerDocumentBase`.
21
21
  class SubFormFieldsPerDocumentSignature < SubFormFieldsPerDocumentBase
22
22
  # A signature input field. Use the `SubFormFieldsPerDocumentSignature` class.
23
+ # @return [String]
23
24
  attr_accessor :type
24
25
 
25
26
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -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.