dropbox-sign 1.0.0 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (139) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +26 -9
  4. data/VERSION +1 -0
  5. data/bin/release +39 -0
  6. data/bin/ruby +1 -0
  7. data/docs/BulkSendJobApi.md +5 -3
  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/TeamResponse.md +1 -0
  13. data/docs/TemplateCreateEmbeddedDraftRequest.md +1 -1
  14. data/docs/TemplateResponse.md +2 -2
  15. data/docs/TemplateResponseDocument.md +3 -3
  16. data/docs/{TemplateResponseCustomField.md → TemplateResponseDocumentCustomFieldBase.md} +6 -8
  17. data/docs/TemplateResponseDocumentCustomFieldCheckbox.md +10 -0
  18. data/docs/TemplateResponseDocumentCustomFieldText.md +14 -0
  19. data/docs/TemplateResponseDocumentFieldGroup.md +1 -1
  20. data/docs/TemplateResponseDocumentFieldGroupRule.md +11 -0
  21. data/docs/{TemplateResponseDocumentFormField.md → TemplateResponseDocumentFormFieldBase.md} +5 -8
  22. data/docs/TemplateResponseDocumentFormFieldCheckbox.md +10 -0
  23. data/docs/TemplateResponseDocumentFormFieldDateSigned.md +10 -0
  24. data/docs/TemplateResponseDocumentFormFieldDropdown.md +10 -0
  25. data/docs/TemplateResponseDocumentFormFieldHyperlink.md +14 -0
  26. data/docs/TemplateResponseDocumentFormFieldInitials.md +10 -0
  27. data/docs/TemplateResponseDocumentFormFieldRadio.md +10 -0
  28. data/docs/TemplateResponseDocumentFormFieldSignature.md +10 -0
  29. data/docs/TemplateResponseDocumentFormFieldText.md +15 -0
  30. data/docs/{TemplateResponseDocumentStaticField.md → TemplateResponseDocumentStaticFieldBase.md} +6 -5
  31. data/docs/TemplateResponseDocumentStaticFieldCheckbox.md +10 -0
  32. data/docs/TemplateResponseDocumentStaticFieldDateSigned.md +10 -0
  33. data/docs/TemplateResponseDocumentStaticFieldDropdown.md +10 -0
  34. data/docs/TemplateResponseDocumentStaticFieldHyperlink.md +10 -0
  35. data/docs/TemplateResponseDocumentStaticFieldInitials.md +10 -0
  36. data/docs/TemplateResponseDocumentStaticFieldRadio.md +10 -0
  37. data/docs/TemplateResponseDocumentStaticFieldSignature.md +10 -0
  38. data/docs/TemplateResponseDocumentStaticFieldText.md +10 -0
  39. data/docs/TemplateResponseFieldAvgTextLength.md +1 -1
  40. data/docs/UnclaimedDraftApi.md +2 -2
  41. data/docs/UnclaimedDraftCreateEmbeddedRequest.md +1 -1
  42. data/docs/UnclaimedDraftCreateRequest.md +1 -1
  43. data/examples/SignatureRequestCreateEmbedded.rb +1 -1
  44. data/examples/SignatureRequestSend.rb +2 -2
  45. data/examples/UnclaimedDraftCreate.rb +2 -2
  46. data/lib/dropbox-sign/api/bulk_send_job_api.rb +6 -0
  47. data/lib/dropbox-sign/models/signature_request_create_embedded_request.rb +1 -1
  48. data/lib/dropbox-sign/models/signature_request_send_request.rb +1 -1
  49. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
  50. data/lib/dropbox-sign/models/team_response.rb +17 -4
  51. data/lib/dropbox-sign/models/template_create_embedded_draft_request.rb +1 -1
  52. data/lib/dropbox-sign/models/template_response.rb +5 -5
  53. data/lib/dropbox-sign/models/template_response_document.rb +9 -9
  54. data/lib/dropbox-sign/models/{template_response_document_static_field.rb → template_response_document_custom_field_base.rb} +75 -43
  55. data/lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb +263 -0
  56. data/lib/dropbox-sign/models/template_response_document_custom_field_text.rb +306 -0
  57. data/lib/dropbox-sign/models/template_response_document_field_group.rb +2 -3
  58. data/lib/dropbox-sign/models/template_response_document_field_group_rule.rb +263 -0
  59. data/lib/dropbox-sign/models/{template_response_named_form_field.rb → template_response_document_form_field_base.rb} +82 -79
  60. data/lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb +263 -0
  61. data/lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb +263 -0
  62. data/lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb +263 -0
  63. data/lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb +306 -0
  64. data/lib/dropbox-sign/models/template_response_document_form_field_initials.rb +263 -0
  65. data/lib/dropbox-sign/models/template_response_document_form_field_radio.rb +263 -0
  66. data/lib/dropbox-sign/models/template_response_document_form_field_signature.rb +263 -0
  67. data/lib/dropbox-sign/models/{template_response_document_form_field.rb → template_response_document_form_field_text.rb} +53 -132
  68. data/lib/dropbox-sign/models/{template_response_custom_field.rb → template_response_document_static_field_base.rb} +94 -112
  69. data/lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb +263 -0
  70. data/lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb +263 -0
  71. data/lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb +263 -0
  72. data/lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb +263 -0
  73. data/lib/dropbox-sign/models/template_response_document_static_field_initials.rb +263 -0
  74. data/lib/dropbox-sign/models/template_response_document_static_field_radio.rb +263 -0
  75. data/lib/dropbox-sign/models/template_response_document_static_field_signature.rb +263 -0
  76. data/lib/dropbox-sign/models/template_response_document_static_field_text.rb +263 -0
  77. data/lib/dropbox-sign/models/template_response_field_avg_text_length.rb +1 -1
  78. data/lib/dropbox-sign/models/unclaimed_draft_create_embedded_request.rb +1 -1
  79. data/lib/dropbox-sign/models/unclaimed_draft_create_request.rb +1 -1
  80. data/lib/dropbox-sign/version.rb +1 -1
  81. data/lib/dropbox-sign.rb +22 -5
  82. data/openapi-config.yaml +4 -1
  83. data/openapi-sdk.yaml +598 -186
  84. data/templates/VERSION-root.mustache +1 -0
  85. data/test_fixtures/AccountCreateResponse.json +1 -0
  86. data/test_fixtures/ApiAppGetResponse.json +1 -0
  87. data/test_fixtures/ApiAppListResponse.json +1 -0
  88. data/test_fixtures/BulkSendJobGetResponse.json +8 -3
  89. data/test_fixtures/SignatureRequestGetResponse.json +65 -65
  90. data/test_fixtures/SignatureRequestListResponse.json +11 -4
  91. data/test_fixtures/TemplateGetResponse.json +1064 -41
  92. data/test_fixtures/TemplateListResponse.json +513 -44
  93. metadata +58 -64
  94. data/docs/TemplateResponseDocumentCustomField.md +0 -25
  95. data/docs/TemplateResponseNamedFormField.md +0 -23
  96. data/lib/dropbox-sign/models/template_response_document_custom_field.rb +0 -454
  97. data/vendor/autoload.php +0 -7
  98. data/vendor/bin/yaml-lint +0 -117
  99. data/vendor/composer/ClassLoader.php +0 -572
  100. data/vendor/composer/InstalledVersions.php +0 -350
  101. data/vendor/composer/LICENSE +0 -21
  102. data/vendor/composer/autoload_classmap.php +0 -10
  103. data/vendor/composer/autoload_files.php +0 -11
  104. data/vendor/composer/autoload_namespaces.php +0 -9
  105. data/vendor/composer/autoload_psr4.php +0 -11
  106. data/vendor/composer/autoload_real.php +0 -80
  107. data/vendor/composer/autoload_static.php +0 -46
  108. data/vendor/composer/installed.json +0 -239
  109. data/vendor/composer/installed.php +0 -50
  110. data/vendor/composer/platform_check.php +0 -26
  111. data/vendor/symfony/deprecation-contracts/.gitignore +0 -3
  112. data/vendor/symfony/deprecation-contracts/CHANGELOG.md +0 -5
  113. data/vendor/symfony/deprecation-contracts/LICENSE +0 -19
  114. data/vendor/symfony/deprecation-contracts/README.md +0 -26
  115. data/vendor/symfony/deprecation-contracts/composer.json +0 -35
  116. data/vendor/symfony/deprecation-contracts/function.php +0 -27
  117. data/vendor/symfony/polyfill-ctype/Ctype.php +0 -232
  118. data/vendor/symfony/polyfill-ctype/LICENSE +0 -19
  119. data/vendor/symfony/polyfill-ctype/README.md +0 -12
  120. data/vendor/symfony/polyfill-ctype/bootstrap.php +0 -50
  121. data/vendor/symfony/polyfill-ctype/bootstrap80.php +0 -46
  122. data/vendor/symfony/polyfill-ctype/composer.json +0 -41
  123. data/vendor/symfony/yaml/CHANGELOG.md +0 -237
  124. data/vendor/symfony/yaml/Command/LintCommand.php +0 -289
  125. data/vendor/symfony/yaml/Dumper.php +0 -140
  126. data/vendor/symfony/yaml/Escaper.php +0 -95
  127. data/vendor/symfony/yaml/Exception/DumpException.php +0 -21
  128. data/vendor/symfony/yaml/Exception/ExceptionInterface.php +0 -21
  129. data/vendor/symfony/yaml/Exception/ParseException.php +0 -132
  130. data/vendor/symfony/yaml/Exception/RuntimeException.php +0 -21
  131. data/vendor/symfony/yaml/Inline.php +0 -812
  132. data/vendor/symfony/yaml/LICENSE +0 -19
  133. data/vendor/symfony/yaml/Parser.php +0 -1305
  134. data/vendor/symfony/yaml/README.md +0 -13
  135. data/vendor/symfony/yaml/Resources/bin/yaml-lint +0 -45
  136. data/vendor/symfony/yaml/Tag/TaggedValue.php +0 -38
  137. data/vendor/symfony/yaml/Unescaper.php +0 -132
  138. data/vendor/symfony/yaml/Yaml.php +0 -100
  139. data/vendor/symfony/yaml/composer.json +0 -42
@@ -0,0 +1,10 @@
1
+ # Dropbox::Sign::TemplateResponseDocumentStaticFieldRadio
2
+
3
+ This class extends `TemplateResponseDocumentStaticFieldBase`
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'radio'] |
10
+
@@ -0,0 +1,10 @@
1
+ # Dropbox::Sign::TemplateResponseDocumentStaticFieldSignature
2
+
3
+ This class extends `TemplateResponseDocumentStaticFieldBase`
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'signature'] |
10
+
@@ -0,0 +1,10 @@
1
+ # Dropbox::Sign::TemplateResponseDocumentStaticFieldText
2
+
3
+ This class extends `TemplateResponseDocumentStaticFieldBase`
4
+
5
+ ## Properties
6
+
7
+ | Name | Type | Description | Notes |
8
+ | ---- | ---- | ----------- | ----- |
9
+ | `type`<sup>*_required_</sup> | ```String``` | The type of this static field. See [field types](/api/reference/constants/#field-types).<br><br>* Text Field uses `TemplateResponseDocumentStaticFieldText`<br>* Dropdown Field uses `TemplateResponseDocumentStaticFieldDropdown`<br>* Hyperlink Field uses `TemplateResponseDocumentStaticFieldHyperlink`<br>* Checkbox Field uses `TemplateResponseDocumentStaticFieldCheckbox`<br>* Radio Field uses `TemplateResponseDocumentStaticFieldRadio`<br>* Signature Field uses `TemplateResponseDocumentStaticFieldSignature`<br>* Date Signed Field uses `TemplateResponseDocumentStaticFieldDateSigned`<br>* Initials Field uses `TemplateResponseDocumentStaticFieldInitials` | [default to 'text'] |
10
+
@@ -7,5 +7,5 @@ Average text length in this field.
7
7
  | Name | Type | Description | Notes |
8
8
  | ---- | ---- | ----------- | ----- |
9
9
  | `num_lines` | ```Integer``` | Number of lines. | |
10
- | `num_chars_per_line` | ```Integer``` | Number of character per line. | |
10
+ | `num_chars_per_line` | ```Integer``` | Number of characters per line. | |
11
11
 
@@ -59,8 +59,8 @@ data.type = "request_signature"
59
59
  data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
60
60
  data.signers = [signer_1, signer_2]
61
61
  data.cc_email_addresses = [
62
- "lawyer@dropboxsign.com",
63
- "lawyer@dropboxsign.com",
62
+ "lawyer1@dropboxsign.com",
63
+ "lawyer2@dropboxsign.com",
64
64
  ]
65
65
  data.files = [File.new("example_signature_request.pdf", "r")]
66
66
  data.metadata = {
@@ -22,7 +22,7 @@
22
22
  | `force_subject_message` | ```Boolean``` | Provide users the ability to review/edit the subject and message. | [default to false] |
23
23
  | `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | 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`. | |
24
24
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
25
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We&#39;re currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: &lt;a href&#x3D;&quot;/docs/openapi/form-fields-per-document&quot; target&#x3D;&quot;_blank&quot;&gt;Using Form Fields per Document&lt;/a&gt;.)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
25
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We&#39;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).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
26
26
  | `hide_text_tags` | ```Boolean``` | 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. | [default to false] |
27
27
  | `hold_request` | ```Boolean``` | 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`. | [default to false] |
28
28
  | `is_for_embedded_signing` | ```Boolean``` | The request created from this draft will also be signable in embedded mode if set to `true`. Defaults to `false`. | [default to false] |
@@ -17,7 +17,7 @@
17
17
  | `field_options` | [```SubFieldOptions```](SubFieldOptions.md) | | |
18
18
  | `form_field_groups` | [```Array<SubFormFieldGroup>```](SubFormFieldGroup.md) | 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`. | |
19
19
  | `form_field_rules` | [```Array<SubFormFieldRule>```](SubFormFieldRule.md) | Conditional Logic rules for fields defined in `form_fields_per_document`. | |
20
- | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We&#39;re currently fixing a bug where this property only accepts a two-dimensional array. You can read about it here: &lt;a href&#x3D;&quot;/docs/openapi/form-fields-per-document&quot; target&#x3D;&quot;_blank&quot;&gt;Using Form Fields per Document&lt;/a&gt;.)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
20
+ | `form_fields_per_document` | [```Array<SubFormFieldsPerDocumentBase>```](SubFormFieldsPerDocumentBase.md) | The fields that should appear on the document, expressed as an array of objects. (We&#39;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).)<br><br>**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.<br><br>* Text Field use `SubFormFieldsPerDocumentText`<br>* Dropdown Field use `SubFormFieldsPerDocumentDropdown`<br>* Hyperlink Field use `SubFormFieldsPerDocumentHyperlink`<br>* Checkbox Field use `SubFormFieldsPerDocumentCheckbox`<br>* Radio Field use `SubFormFieldsPerDocumentRadio`<br>* Signature Field use `SubFormFieldsPerDocumentSignature`<br>* Date Signed Field use `SubFormFieldsPerDocumentDateSigned`<br>* Initials Field use `SubFormFieldsPerDocumentInitials`<br>* Text Merge Field use `SubFormFieldsPerDocumentTextMerge`<br>* Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge` | |
21
21
  | `hide_text_tags` | ```Boolean``` | 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. | [default to false] |
22
22
  | `message` | ```String``` | The custom message in the email that will be sent to the signers. | |
23
23
  | `metadata` | ```Hash<String, Object>``` | 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&#39;s order number for look up when receiving events for the signature request.<br><br>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. | |
@@ -33,7 +33,7 @@ data.title = "NDA with Acme Co."
33
33
  data.subject = "The NDA we talked about"
34
34
  data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
35
35
  data.signers = [signer_1, signer_2]
36
- data.cc_email_addresses = ["lawyer@dropboxsign.com", "lawyer@dropboxsign.com"]
36
+ data.cc_email_addresses = ["lawyer1@dropboxsign.com", "lawyer2@dropboxsign.com"]
37
37
  data.files = [File.new("example_signature_request.pdf", "r")]
38
38
  data.signing_options = signing_options
39
39
  data.test_mode = true
@@ -36,8 +36,8 @@ data.subject = "The NDA we talked about"
36
36
  data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
37
37
  data.signers = [signer_1, signer_2]
38
38
  data.cc_email_addresses = [
39
- "lawyer@dropboxsign.com",
40
- "lawyer@dropboxsign.com",
39
+ "lawyer1@dropboxsign.com",
40
+ "lawyer2@dropboxsign.com",
41
41
  ]
42
42
  data.files = [File.new("example_signature_request.pdf", "r")]
43
43
  data.metadata = {
@@ -36,8 +36,8 @@ data.type = "request_signature"
36
36
  data.message = "Please sign this NDA and then we can discuss more. Let me know if you have any questions."
37
37
  data.signers = [signer_1, signer_2]
38
38
  data.cc_email_addresses = [
39
- "lawyer@dropboxsign.com",
40
- "lawyer@dropboxsign.com",
39
+ "lawyer1@dropboxsign.com",
40
+ "lawyer2@dropboxsign.com",
41
41
  ]
42
42
  data.files = [File.new("example_signature_request.pdf", "r")]
43
43
  data.metadata = {
@@ -26,6 +26,8 @@ module Dropbox::Sign
26
26
  # Returns the status of the BulkSendJob and its SignatureRequests specified by the `bulk_send_job_id` parameter.
27
27
  # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
28
28
  # @param [Hash] opts the optional parameters
29
+ # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;. (default to 1)
30
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20. (default to 20)
29
31
  # @return [BulkSendJobGetResponse]
30
32
  def bulk_send_job_get(bulk_send_job_id, opts = {})
31
33
  data, _status_code, _headers = bulk_send_job_get_with_http_info(bulk_send_job_id, opts)
@@ -36,6 +38,8 @@ module Dropbox::Sign
36
38
  # Returns the status of the BulkSendJob and its SignatureRequests specified by the &#x60;bulk_send_job_id&#x60; parameter.
37
39
  # @param bulk_send_job_id [String] The id of the BulkSendJob to retrieve.
38
40
  # @param [Hash] opts the optional parameters
41
+ # @option opts [Integer] :page Which page number of the BulkSendJob list to return. Defaults to &#x60;1&#x60;.
42
+ # @option opts [Integer] :page_size Number of objects to be returned per page. Must be between &#x60;1&#x60; and &#x60;100&#x60;. Default is 20.
39
43
  # @return [Array<(BulkSendJobGetResponse, Integer, Hash)>] BulkSendJobGetResponse data, response status code and response headers
40
44
  def bulk_send_job_get_with_http_info(bulk_send_job_id, opts = {})
41
45
  if @api_client.config.debugging
@@ -50,6 +54,8 @@ module Dropbox::Sign
50
54
 
51
55
  # query parameters
52
56
  query_params = opts[:query_params] || {}
57
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
58
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
53
59
 
54
60
  # header parameters
55
61
  header_params = opts[:header_params] || {}
@@ -69,7 +69,7 @@ module Dropbox::Sign
69
69
  # @return [Array<SubFormFieldRule>]
70
70
  attr_accessor :form_field_rules
71
71
 
72
- # The fields that should appear on the document, expressed as an array of objects. (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`
72
+ # 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`
73
73
  # @return [Array<SubFormFieldsPerDocumentBase>]
74
74
  attr_accessor :form_fields_per_document
75
75
 
@@ -69,7 +69,7 @@ module Dropbox::Sign
69
69
  # @return [Array<SubFormFieldRule>]
70
70
  attr_accessor :form_field_rules
71
71
 
72
- # The fields that should appear on the document, expressed as an array of objects. (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`
72
+ # 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`
73
73
  # @return [Array<SubFormFieldsPerDocumentBase>]
74
74
  attr_accessor :form_fields_per_document
75
75
 
@@ -17,7 +17,7 @@ module Dropbox
17
17
  end
18
18
 
19
19
  module Dropbox::Sign
20
- # The fields that should appear on the document, expressed as an array of objects. (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`
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: [Using Form Fields per Document](/docs/openapi/form-fields-per-document).) **NOTE**: Fields like **text**, **dropdown**, **checkbox**, **radio**, and **hyperlink** have additional required and optional parameters. Check out the list of [additional parameters](/api/reference/constants/#form-fields-per-document) for these field types. * Text Field use `SubFormFieldsPerDocumentText` * Dropdown Field use `SubFormFieldsPerDocumentDropdown` * Hyperlink Field use `SubFormFieldsPerDocumentHyperlink` * Checkbox Field use `SubFormFieldsPerDocumentCheckbox` * Radio Field use `SubFormFieldsPerDocumentRadio` * Signature Field use `SubFormFieldsPerDocumentSignature` * Date Signed Field use `SubFormFieldsPerDocumentDateSigned` * Initials Field use `SubFormFieldsPerDocumentInitials` * Text Merge Field use `SubFormFieldsPerDocumentTextMerge` * Checkbox Merge Field use `SubFormFieldsPerDocumentCheckboxMerge`
21
21
  class SubFormFieldsPerDocumentBase
22
22
  # Represents the integer index of the `file` or `file_url` document the field should be attached to.
23
23
  # @return [Integer]
@@ -30,12 +30,17 @@ module Dropbox::Sign
30
30
  # @return [Array<AccountResponse>]
31
31
  attr_accessor :invited_accounts
32
32
 
33
+ # A list of email addresses that have an outstanding invitation to join your Team and do not yet have a Dropbox Sign account.
34
+ # @return [Array<String>]
35
+ attr_accessor :invited_emails
36
+
33
37
  # Attribute mapping from ruby-style variable name to JSON key.
34
38
  def self.attribute_map
35
39
  {
36
40
  :'name' => :'name',
37
41
  :'accounts' => :'accounts',
38
- :'invited_accounts' => :'invited_accounts'
42
+ :'invited_accounts' => :'invited_accounts',
43
+ :'invited_emails' => :'invited_emails'
39
44
  }
40
45
  end
41
46
 
@@ -54,7 +59,8 @@ module Dropbox::Sign
54
59
  {
55
60
  :'name' => :'String',
56
61
  :'accounts' => :'Array<AccountResponse>',
57
- :'invited_accounts' => :'Array<AccountResponse>'
62
+ :'invited_accounts' => :'Array<AccountResponse>',
63
+ :'invited_emails' => :'Array<String>'
58
64
  }
59
65
  end
60
66
 
@@ -114,6 +120,12 @@ module Dropbox::Sign
114
120
  self.invited_accounts = value
115
121
  end
116
122
  end
123
+
124
+ if attributes.key?(:'invited_emails')
125
+ if (value = attributes[:'invited_emails']).is_a?(Array)
126
+ self.invited_emails = value
127
+ end
128
+ end
117
129
  end
118
130
 
119
131
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -136,7 +148,8 @@ module Dropbox::Sign
136
148
  self.class == o.class &&
137
149
  name == o.name &&
138
150
  accounts == o.accounts &&
139
- invited_accounts == o.invited_accounts
151
+ invited_accounts == o.invited_accounts &&
152
+ invited_emails == o.invited_emails
140
153
  end
141
154
 
142
155
  # @see the `==` method
@@ -148,7 +161,7 @@ module Dropbox::Sign
148
161
  # Calculates hash code according to all attributes.
149
162
  # @return [Integer] Hash code
150
163
  def hash
151
- [name, accounts, invited_accounts].hash
164
+ [name, accounts, invited_accounts, invited_emails].hash
152
165
  end
153
166
 
154
167
  # Builds the object from hash
@@ -68,7 +68,7 @@ module Dropbox::Sign
68
68
  # @return [Array<SubFormFieldRule>]
69
69
  attr_accessor :form_field_rules
70
70
 
71
- # The fields that should appear on the document, expressed as an array of objects. (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
72
  # @return [Array<SubFormFieldsPerDocumentBase>]
73
73
  attr_accessor :form_fields_per_document
74
74
 
@@ -67,12 +67,12 @@ module Dropbox::Sign
67
67
  # @return [Array<TemplateResponseDocument>]
68
68
  attr_accessor :documents
69
69
 
70
- # An array of Custom Field objects.
71
- # @return [Array<TemplateResponseCustomField>, nil]
70
+ # Deprecated. Use `custom_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
71
+ # @return [Array<TemplateResponseDocumentCustomFieldBase>, nil]
72
72
  attr_accessor :custom_fields
73
73
 
74
74
  # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
75
- # @return [Array<TemplateResponseNamedFormField>, nil]
75
+ # @return [Array<TemplateResponseDocumentFormFieldBase>, nil]
76
76
  attr_accessor :named_form_fields
77
77
 
78
78
  # An array of the Accounts that can use this Template.
@@ -125,8 +125,8 @@ module Dropbox::Sign
125
125
  :'signer_roles' => :'Array<TemplateResponseSignerRole>',
126
126
  :'cc_roles' => :'Array<TemplateResponseCCRole>',
127
127
  :'documents' => :'Array<TemplateResponseDocument>',
128
- :'custom_fields' => :'Array<TemplateResponseCustomField>',
129
- :'named_form_fields' => :'Array<TemplateResponseNamedFormField>',
128
+ :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
129
+ :'named_form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
130
130
  :'accounts' => :'Array<TemplateResponseAccount>'
131
131
  }
132
132
  end
@@ -30,16 +30,16 @@ module Dropbox::Sign
30
30
  # @return [Array<TemplateResponseDocumentFieldGroup>]
31
31
  attr_accessor :field_groups
32
32
 
33
- # An array of Form Field objects containing the name and type of each named textbox and checkmark field.
34
- # @return [Array<TemplateResponseDocumentFormField>]
33
+ # An array of Form Field objects containing the name and type of each named field.
34
+ # @return [Array<TemplateResponseDocumentFormFieldBase>]
35
35
  attr_accessor :form_fields
36
36
 
37
- # An array of Document Custom Field objects.
38
- # @return [Array<TemplateResponseDocumentCustomField>]
37
+ # An array of Form Field objects containing the name and type of each named field.
38
+ # @return [Array<TemplateResponseDocumentCustomFieldBase>]
39
39
  attr_accessor :custom_fields
40
40
 
41
- # An array describing static overlay fields. <b>Note</b> only available for certain subscriptions.
42
- # @return [Array<TemplateResponseDocumentStaticField>, nil]
41
+ # An array describing static overlay fields. **Note** only available for certain subscriptions.
42
+ # @return [Array<TemplateResponseDocumentStaticFieldBase>, nil]
43
43
  attr_accessor :static_fields
44
44
 
45
45
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -70,9 +70,9 @@ module Dropbox::Sign
70
70
  :'name' => :'String',
71
71
  :'index' => :'Integer',
72
72
  :'field_groups' => :'Array<TemplateResponseDocumentFieldGroup>',
73
- :'form_fields' => :'Array<TemplateResponseDocumentFormField>',
74
- :'custom_fields' => :'Array<TemplateResponseDocumentCustomField>',
75
- :'static_fields' => :'Array<TemplateResponseDocumentStaticField>'
73
+ :'form_fields' => :'Array<TemplateResponseDocumentFormFieldBase>',
74
+ :'custom_fields' => :'Array<TemplateResponseDocumentCustomFieldBase>',
75
+ :'static_fields' => :'Array<TemplateResponseDocumentStaticFieldBase>'
76
76
  }
77
77
  end
78
78
 
@@ -17,32 +17,36 @@ module Dropbox
17
17
  end
18
18
 
19
19
  module Dropbox::Sign
20
- class TemplateResponseDocumentStaticField
21
- # The name of the static field.
20
+ # An array of Form Field objects containing the name and type of each named field.
21
+ class TemplateResponseDocumentCustomFieldBase
22
22
  # @return [String]
23
- attr_accessor :name
23
+ attr_accessor :type
24
24
 
25
- # The type of this static field. See [field types](/api/reference/constants/#field-types).
25
+ # The unique ID for this field.
26
26
  # @return [String]
27
- attr_accessor :type
27
+ attr_accessor :api_id
28
28
 
29
- # The signer of the Static Field.
29
+ # The name of the Custom Field.
30
30
  # @return [String]
31
+ attr_accessor :name
32
+
33
+ # The signer of the Custom Field. Can be `null` if field is a merge field (assigned to Sender).
34
+ # @return [String, nil]
31
35
  attr_accessor :signer
32
36
 
33
- # The horizontal offset in pixels for this static field.
37
+ # The horizontal offset in pixels for this form field.
34
38
  # @return [Integer]
35
39
  attr_accessor :x
36
40
 
37
- # The vertical offset in pixels for this static field.
41
+ # The vertical offset in pixels for this form field.
38
42
  # @return [Integer]
39
43
  attr_accessor :y
40
44
 
41
- # The width in pixels of this static field.
45
+ # The width in pixels of this form field.
42
46
  # @return [Integer]
43
47
  attr_accessor :width
44
48
 
45
- # The height in pixels of this static field.
49
+ # The height in pixels of this form field.
46
50
  # @return [Integer]
47
51
  attr_accessor :height
48
52
 
@@ -50,27 +54,28 @@ module Dropbox::Sign
50
54
  # @return [Boolean]
51
55
  attr_accessor :required
52
56
 
53
- # A unique id for the static field.
54
- # @return [String]
55
- attr_accessor :api_id
56
-
57
57
  # The name of the group this field is in. If this field is not a group, this defaults to `null`.
58
58
  # @return [String, nil]
59
59
  attr_accessor :group
60
60
 
61
+ # Final font size used by this form field.
62
+ # @return [Integer]
63
+ attr_accessor :font_size
64
+
61
65
  # Attribute mapping from ruby-style variable name to JSON key.
62
66
  def self.attribute_map
63
67
  {
64
- :'name' => :'name',
65
68
  :'type' => :'type',
69
+ :'api_id' => :'api_id',
70
+ :'name' => :'name',
66
71
  :'signer' => :'signer',
67
72
  :'x' => :'x',
68
73
  :'y' => :'y',
69
74
  :'width' => :'width',
70
75
  :'height' => :'height',
71
76
  :'required' => :'required',
72
- :'api_id' => :'api_id',
73
- :'group' => :'group'
77
+ :'group' => :'group',
78
+ :'font_size' => :'fontSize'
74
79
  }
75
80
  end
76
81
 
@@ -87,16 +92,17 @@ module Dropbox::Sign
87
92
  # Attribute type mapping.
88
93
  def self.openapi_types
89
94
  {
90
- :'name' => :'String',
91
95
  :'type' => :'String',
96
+ :'api_id' => :'String',
97
+ :'name' => :'String',
92
98
  :'signer' => :'String',
93
99
  :'x' => :'Integer',
94
100
  :'y' => :'Integer',
95
101
  :'width' => :'Integer',
96
102
  :'height' => :'Integer',
97
103
  :'required' => :'Boolean',
98
- :'api_id' => :'String',
99
- :'group' => :'String'
104
+ :'group' => :'String',
105
+ :'font_size' => :'Integer'
100
106
  }
101
107
  end
102
108
 
@@ -108,7 +114,8 @@ module Dropbox::Sign
108
114
  # List of attributes with nullable: true
109
115
  def self.openapi_nullable
110
116
  Set.new([
111
- :'group'
117
+ :'signer',
118
+ :'group',
112
119
  ])
113
120
  end
114
121
 
@@ -117,39 +124,51 @@ module Dropbox::Sign
117
124
  self.openapi_nullable
118
125
  end
119
126
 
120
- # Attempt to instantiate and hydrate a new instance of this class
121
- # @param [Object] data Data to be converted
122
- # @return [TemplateResponseDocumentStaticField]
123
- def self.init(data)
124
- return ApiClient.default.convert_to_type(
125
- data,
126
- "TemplateResponseDocumentStaticField"
127
- ) || TemplateResponseDocumentStaticField.new
127
+ # discriminator's property name in OpenAPI v3
128
+ def self.openapi_discriminator_name
129
+ :'type'
130
+ end
131
+
132
+ def self.discriminator_class_name(value)
133
+ return nil unless value.is_a?(String)
134
+
135
+ if value == 'checkbox'
136
+ return "Dropbox::Sign::TemplateResponseDocumentCustomFieldCheckbox"
137
+ end
138
+ if value == 'text'
139
+ return "Dropbox::Sign::TemplateResponseDocumentCustomFieldText"
140
+ end
141
+
142
+ return nil
128
143
  end
129
144
 
130
145
  # Initializes the object
131
146
  # @param [Hash] attributes Model attributes in the form of hash
132
147
  def initialize(attributes = {})
133
148
  if (!attributes.is_a?(Hash))
134
- fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentStaticField` initialize method"
149
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase` initialize method"
135
150
  end
136
151
 
137
152
  # check to see if the attribute exists and convert string to symbol for hash key
138
153
  attributes = attributes.each_with_object({}) { |(k, v), h|
139
154
  if (!self.class.merged_attributes.key?(k.to_sym))
140
- fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentStaticField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
155
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomFieldBase`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
141
156
  end
142
157
  h[k.to_sym] = v
143
158
  }
144
159
 
145
- if attributes.key?(:'name')
146
- self.name = attributes[:'name']
147
- end
148
-
149
160
  if attributes.key?(:'type')
150
161
  self.type = attributes[:'type']
151
162
  end
152
163
 
164
+ if attributes.key?(:'api_id')
165
+ self.api_id = attributes[:'api_id']
166
+ end
167
+
168
+ if attributes.key?(:'name')
169
+ self.name = attributes[:'name']
170
+ end
171
+
153
172
  if attributes.key?(:'signer')
154
173
  self.signer = attributes[:'signer']
155
174
  end
@@ -174,25 +193,30 @@ module Dropbox::Sign
174
193
  self.required = attributes[:'required']
175
194
  end
176
195
 
177
- if attributes.key?(:'api_id')
178
- self.api_id = attributes[:'api_id']
179
- end
180
-
181
196
  if attributes.key?(:'group')
182
197
  self.group = attributes[:'group']
183
198
  end
199
+
200
+ if attributes.key?(:'font_size')
201
+ self.font_size = attributes[:'font_size']
202
+ end
184
203
  end
185
204
 
186
205
  # Show invalid properties with the reasons. Usually used together with valid?
187
206
  # @return Array for valid properties with the reasons
188
207
  def list_invalid_properties
189
208
  invalid_properties = Array.new
209
+ if @type.nil?
210
+ invalid_properties.push('invalid value for "type", type cannot be nil.')
211
+ end
212
+
190
213
  invalid_properties
191
214
  end
192
215
 
193
216
  # Check to see if the all the properties in the model are valid
194
217
  # @return true if the model is valid
195
218
  def valid?
219
+ return false if @type.nil?
196
220
  true
197
221
  end
198
222
 
@@ -201,16 +225,17 @@ module Dropbox::Sign
201
225
  def ==(o)
202
226
  return true if self.equal?(o)
203
227
  self.class == o.class &&
204
- name == o.name &&
205
228
  type == o.type &&
229
+ api_id == o.api_id &&
230
+ name == o.name &&
206
231
  signer == o.signer &&
207
232
  x == o.x &&
208
233
  y == o.y &&
209
234
  width == o.width &&
210
235
  height == o.height &&
211
236
  required == o.required &&
212
- api_id == o.api_id &&
213
- group == o.group
237
+ group == o.group &&
238
+ font_size == o.font_size
214
239
  end
215
240
 
216
241
  # @see the `==` method
@@ -222,13 +247,20 @@ module Dropbox::Sign
222
247
  # Calculates hash code according to all attributes.
223
248
  # @return [Integer] Hash code
224
249
  def hash
225
- [name, type, signer, x, y, width, height, required, api_id, group].hash
250
+ [type, api_id, name, signer, x, y, width, height, required, group, font_size].hash
226
251
  end
227
252
 
228
253
  # Builds the object from hash
229
254
  # @param [Hash] attributes Model attributes in the form of hash
230
255
  # @return [Object] Returns the model itself
231
256
  def self.build_from_hash(attributes)
257
+ if !attributes[self.openapi_discriminator_name].nil?
258
+ klass = self.discriminator_class_name(attributes[self.openapi_discriminator_name])
259
+ if klass != new.class.to_s
260
+ obj = Object.const_get(klass).new.build_from_hash(attributes)
261
+ return obj
262
+ end
263
+ end
232
264
  new.build_from_hash(attributes)
233
265
  end
234
266