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
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dropbox-sign
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.0
4
+ version: 1.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dropbox
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-31 00:00:00.000000000 Z
11
+ date: 2023-02-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -62,9 +62,11 @@ files:
62
62
  - LICENSE
63
63
  - README.md
64
64
  - Rakefile
65
+ - VERSION
65
66
  - bin/check-clean-git-status
66
67
  - bin/generate-examples.php
67
68
  - bin/php
69
+ - bin/release
68
70
  - bin/replace
69
71
  - bin/ruby
70
72
  - bin/scan_for
@@ -210,14 +212,31 @@ files:
210
212
  - docs/TemplateResponseAccount.md
211
213
  - docs/TemplateResponseAccountQuota.md
212
214
  - docs/TemplateResponseCCRole.md
213
- - docs/TemplateResponseCustomField.md
214
215
  - docs/TemplateResponseDocument.md
215
- - docs/TemplateResponseDocumentCustomField.md
216
+ - docs/TemplateResponseDocumentCustomFieldBase.md
217
+ - docs/TemplateResponseDocumentCustomFieldCheckbox.md
218
+ - docs/TemplateResponseDocumentCustomFieldText.md
216
219
  - docs/TemplateResponseDocumentFieldGroup.md
217
- - docs/TemplateResponseDocumentFormField.md
218
- - docs/TemplateResponseDocumentStaticField.md
220
+ - docs/TemplateResponseDocumentFieldGroupRule.md
221
+ - docs/TemplateResponseDocumentFormFieldBase.md
222
+ - docs/TemplateResponseDocumentFormFieldCheckbox.md
223
+ - docs/TemplateResponseDocumentFormFieldDateSigned.md
224
+ - docs/TemplateResponseDocumentFormFieldDropdown.md
225
+ - docs/TemplateResponseDocumentFormFieldHyperlink.md
226
+ - docs/TemplateResponseDocumentFormFieldInitials.md
227
+ - docs/TemplateResponseDocumentFormFieldRadio.md
228
+ - docs/TemplateResponseDocumentFormFieldSignature.md
229
+ - docs/TemplateResponseDocumentFormFieldText.md
230
+ - docs/TemplateResponseDocumentStaticFieldBase.md
231
+ - docs/TemplateResponseDocumentStaticFieldCheckbox.md
232
+ - docs/TemplateResponseDocumentStaticFieldDateSigned.md
233
+ - docs/TemplateResponseDocumentStaticFieldDropdown.md
234
+ - docs/TemplateResponseDocumentStaticFieldHyperlink.md
235
+ - docs/TemplateResponseDocumentStaticFieldInitials.md
236
+ - docs/TemplateResponseDocumentStaticFieldRadio.md
237
+ - docs/TemplateResponseDocumentStaticFieldSignature.md
238
+ - docs/TemplateResponseDocumentStaticFieldText.md
219
239
  - docs/TemplateResponseFieldAvgTextLength.md
220
- - docs/TemplateResponseNamedFormField.md
221
240
  - docs/TemplateResponseSignerRole.md
222
241
  - docs/TemplateUpdateFilesRequest.md
223
242
  - docs/TemplateUpdateFilesResponse.md
@@ -434,14 +453,31 @@ files:
434
453
  - lib/dropbox-sign/models/template_response_account.rb
435
454
  - lib/dropbox-sign/models/template_response_account_quota.rb
436
455
  - lib/dropbox-sign/models/template_response_cc_role.rb
437
- - lib/dropbox-sign/models/template_response_custom_field.rb
438
456
  - lib/dropbox-sign/models/template_response_document.rb
439
- - lib/dropbox-sign/models/template_response_document_custom_field.rb
457
+ - lib/dropbox-sign/models/template_response_document_custom_field_base.rb
458
+ - lib/dropbox-sign/models/template_response_document_custom_field_checkbox.rb
459
+ - lib/dropbox-sign/models/template_response_document_custom_field_text.rb
440
460
  - lib/dropbox-sign/models/template_response_document_field_group.rb
441
- - lib/dropbox-sign/models/template_response_document_form_field.rb
442
- - lib/dropbox-sign/models/template_response_document_static_field.rb
461
+ - lib/dropbox-sign/models/template_response_document_field_group_rule.rb
462
+ - lib/dropbox-sign/models/template_response_document_form_field_base.rb
463
+ - lib/dropbox-sign/models/template_response_document_form_field_checkbox.rb
464
+ - lib/dropbox-sign/models/template_response_document_form_field_date_signed.rb
465
+ - lib/dropbox-sign/models/template_response_document_form_field_dropdown.rb
466
+ - lib/dropbox-sign/models/template_response_document_form_field_hyperlink.rb
467
+ - lib/dropbox-sign/models/template_response_document_form_field_initials.rb
468
+ - lib/dropbox-sign/models/template_response_document_form_field_radio.rb
469
+ - lib/dropbox-sign/models/template_response_document_form_field_signature.rb
470
+ - lib/dropbox-sign/models/template_response_document_form_field_text.rb
471
+ - lib/dropbox-sign/models/template_response_document_static_field_base.rb
472
+ - lib/dropbox-sign/models/template_response_document_static_field_checkbox.rb
473
+ - lib/dropbox-sign/models/template_response_document_static_field_date_signed.rb
474
+ - lib/dropbox-sign/models/template_response_document_static_field_dropdown.rb
475
+ - lib/dropbox-sign/models/template_response_document_static_field_hyperlink.rb
476
+ - lib/dropbox-sign/models/template_response_document_static_field_initials.rb
477
+ - lib/dropbox-sign/models/template_response_document_static_field_radio.rb
478
+ - lib/dropbox-sign/models/template_response_document_static_field_signature.rb
479
+ - lib/dropbox-sign/models/template_response_document_static_field_text.rb
443
480
  - lib/dropbox-sign/models/template_response_field_avg_text_length.rb
444
- - lib/dropbox-sign/models/template_response_named_form_field.rb
445
481
  - lib/dropbox-sign/models/template_response_signer_role.rb
446
482
  - lib/dropbox-sign/models/template_update_files_request.rb
447
483
  - lib/dropbox-sign/models/template_update_files_response.rb
@@ -477,6 +513,7 @@ files:
477
513
  - templates/Gemfile.mustache
478
514
  - templates/README.mustache
479
515
  - templates/Rakefile.mustache
516
+ - templates/VERSION-root.mustache
480
517
  - templates/api.mustache
481
518
  - templates/api_client.mustache
482
519
  - templates/api_client_faraday_partial.mustache
@@ -565,54 +602,11 @@ files:
565
602
  - test_fixtures/bulk-send-sample.csv
566
603
  - test_fixtures/pdf-sample-2.pdf
567
604
  - test_fixtures/pdf-sample.pdf
568
- - vendor/autoload.php
569
- - vendor/bin/yaml-lint
570
- - vendor/composer/ClassLoader.php
571
- - vendor/composer/InstalledVersions.php
572
- - vendor/composer/LICENSE
573
- - vendor/composer/autoload_classmap.php
574
- - vendor/composer/autoload_files.php
575
- - vendor/composer/autoload_namespaces.php
576
- - vendor/composer/autoload_psr4.php
577
- - vendor/composer/autoload_real.php
578
- - vendor/composer/autoload_static.php
579
- - vendor/composer/installed.json
580
- - vendor/composer/installed.php
581
- - vendor/composer/platform_check.php
582
- - vendor/symfony/deprecation-contracts/.gitignore
583
- - vendor/symfony/deprecation-contracts/CHANGELOG.md
584
- - vendor/symfony/deprecation-contracts/LICENSE
585
- - vendor/symfony/deprecation-contracts/README.md
586
- - vendor/symfony/deprecation-contracts/composer.json
587
- - vendor/symfony/deprecation-contracts/function.php
588
- - vendor/symfony/polyfill-ctype/Ctype.php
589
- - vendor/symfony/polyfill-ctype/LICENSE
590
- - vendor/symfony/polyfill-ctype/README.md
591
- - vendor/symfony/polyfill-ctype/bootstrap.php
592
- - vendor/symfony/polyfill-ctype/bootstrap80.php
593
- - vendor/symfony/polyfill-ctype/composer.json
594
- - vendor/symfony/yaml/CHANGELOG.md
595
- - vendor/symfony/yaml/Command/LintCommand.php
596
- - vendor/symfony/yaml/Dumper.php
597
- - vendor/symfony/yaml/Escaper.php
598
- - vendor/symfony/yaml/Exception/DumpException.php
599
- - vendor/symfony/yaml/Exception/ExceptionInterface.php
600
- - vendor/symfony/yaml/Exception/ParseException.php
601
- - vendor/symfony/yaml/Exception/RuntimeException.php
602
- - vendor/symfony/yaml/Inline.php
603
- - vendor/symfony/yaml/LICENSE
604
- - vendor/symfony/yaml/Parser.php
605
- - vendor/symfony/yaml/README.md
606
- - vendor/symfony/yaml/Resources/bin/yaml-lint
607
- - vendor/symfony/yaml/Tag/TaggedValue.php
608
- - vendor/symfony/yaml/Unescaper.php
609
- - vendor/symfony/yaml/Yaml.php
610
- - vendor/symfony/yaml/composer.json
611
605
  homepage: https://hellosign.com
612
606
  licenses:
613
607
  - MIT
614
608
  metadata: {}
615
- post_install_message:
609
+ post_install_message:
616
610
  rdoc_options: []
617
611
  require_paths:
618
612
  - lib
@@ -627,21 +621,21 @@ required_rubygems_version: !ruby/object:Gem::Requirement
627
621
  - !ruby/object:Gem::Version
628
622
  version: '0'
629
623
  requirements: []
630
- rubygems_version: 3.1.4
631
- signing_key:
624
+ rubygems_version: 3.3.26
625
+ signing_key:
632
626
  specification_version: 4
633
627
  summary: Dropbox Sign API Ruby Gem
634
628
  test_files:
635
629
  - spec/api/api_app_api_spec.rb
636
- - spec/api/signature_request_api_spec.rb
637
- - spec/api/team_api_spec.rb
638
- - spec/api/oauth_api_spec.rb
639
- - spec/api/unclaimed_draft_api_spec.rb
640
630
  - spec/api/template_api_spec.rb
631
+ - spec/api/team_api_spec.rb
641
632
  - spec/api/account_api_spec.rb
633
+ - spec/api/bulk_send_job_api_spec.rb
642
634
  - spec/api/report_api_spec.rb
635
+ - spec/api/oauth_api_spec.rb
636
+ - spec/api/signature_request_api_spec.rb
643
637
  - spec/api/embedded_api_spec.rb
644
- - spec/api/bulk_send_job_api_spec.rb
638
+ - spec/api/unclaimed_draft_api_spec.rb
645
639
  - spec/api_client_spec.rb
646
640
  - spec/configuration_spec.rb
647
641
  - spec/event_callback_helper_spec.rb
@@ -1,25 +0,0 @@
1
- # Dropbox::Sign::TemplateResponseDocumentCustomField
2
-
3
-
4
-
5
- ## Properties
6
-
7
- | Name | Type | Description | Notes |
8
- | ---- | ---- | ----------- | ----- |
9
- | `name` | ```String``` | The name of the Custom Field. | |
10
- | `type` | ```String``` | The type of this Custom Field. Only `text` and `checkbox` are currently supported. | |
11
- | `signer` | ```String``` | The signer of the Custom Field. | |
12
- | `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
13
- | `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
14
- | `width` | ```Integer``` | The width in pixels of this form field. | |
15
- | `height` | ```Integer``` | The height in pixels of this form field. | |
16
- | `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
17
- | `api_id` | ```String``` | The unique ID for this field. | |
18
- | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
19
- | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
20
- | `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
21
- | `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
22
- | `font_family` | ```String``` | Font family used in this form field's text. | |
23
- | `named_form_fields` | ```Object``` | Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead. | |
24
- | `reusable_form_id` | ```String``` | | |
25
-
@@ -1,23 +0,0 @@
1
- # Dropbox::Sign::TemplateResponseNamedFormField
2
-
3
-
4
-
5
- ## Properties
6
-
7
- | Name | Type | Description | Notes |
8
- | ---- | ---- | ----------- | ----- |
9
- | `name` | ```String``` | The name of the Named Form Field. | |
10
- | `type` | ```String``` | The type of this Named Form Field. Only `text` and `checkbox` are currently supported. | |
11
- | `signer` | ```String``` | The signer of the Named Form Field. | |
12
- | `x` | ```Integer``` | The horizontal offset in pixels for this form field. | |
13
- | `y` | ```Integer``` | The vertical offset in pixels for this form field. | |
14
- | `width` | ```Integer``` | The width in pixels of this form field. | |
15
- | `height` | ```Integer``` | The height in pixels of this form field. | |
16
- | `required` | ```Boolean``` | Boolean showing whether or not this field is required. | |
17
- | `api_id` | ```String``` | The unique ID for this field. | |
18
- | `group` | ```String``` | The name of the group this field is in. If this field is not a group, this defaults to `null`. | |
19
- | `avg_text_length` | [```TemplateResponseFieldAvgTextLength```](TemplateResponseFieldAvgTextLength.md) | | |
20
- | `is_multiline` | ```Boolean``` | Whether this form field is multiline text. | |
21
- | `original_font_size` | ```Integer``` | Original font size used in this form field's text. | |
22
- | `font_family` | ```String``` | Font family used in this form field's text. | |
23
-
@@ -1,454 +0,0 @@
1
- =begin
2
- #Dropbox Sign API
3
-
4
- #Dropbox Sign v3 API
5
-
6
- The version of the OpenAPI document: 3.0.0
7
- Contact: apisupport@hellosign.com
8
- Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.3.0
10
-
11
- =end
12
-
13
- require 'date'
14
- require 'time'
15
-
16
- module Dropbox
17
- end
18
-
19
- module Dropbox::Sign
20
- class TemplateResponseDocumentCustomField
21
- # The name of the Custom Field.
22
- # @return [String]
23
- attr_accessor :name
24
-
25
- # The type of this Custom Field. Only `text` and `checkbox` are currently supported.
26
- # @return [String]
27
- attr_accessor :type
28
-
29
- # The signer of the Custom Field.
30
- # @return [String]
31
- attr_accessor :signer
32
-
33
- # The horizontal offset in pixels for this form field.
34
- # @return [Integer]
35
- attr_accessor :x
36
-
37
- # The vertical offset in pixels for this form field.
38
- # @return [Integer]
39
- attr_accessor :y
40
-
41
- # The width in pixels of this form field.
42
- # @return [Integer]
43
- attr_accessor :width
44
-
45
- # The height in pixels of this form field.
46
- # @return [Integer]
47
- attr_accessor :height
48
-
49
- # Boolean showing whether or not this field is required.
50
- # @return [Boolean]
51
- attr_accessor :required
52
-
53
- # The unique ID for this field.
54
- # @return [String]
55
- attr_accessor :api_id
56
-
57
- # The name of the group this field is in. If this field is not a group, this defaults to `null`.
58
- # @return [String, nil]
59
- attr_accessor :group
60
-
61
- # @return [TemplateResponseFieldAvgTextLength]
62
- attr_accessor :avg_text_length
63
-
64
- # Whether this form field is multiline text.
65
- # @return [Boolean, nil]
66
- attr_accessor :is_multiline
67
-
68
- # Original font size used in this form field's text.
69
- # @return [Integer, nil]
70
- attr_accessor :original_font_size
71
-
72
- # Font family used in this form field's text.
73
- # @return [String, nil]
74
- attr_accessor :font_family
75
-
76
- # Deprecated. Use `form_fields` inside the [documents](https://developers.hellosign.com/api/reference/operation/templateGet/#!c=200&path=template/documents&t=response) array instead.
77
- # @return [Object, nil]
78
- attr_accessor :named_form_fields
79
-
80
- # @return [String, nil]
81
- attr_accessor :reusable_form_id
82
-
83
- class EnumAttributeValidator
84
- attr_reader :datatype
85
- attr_reader :allowable_values
86
-
87
- def initialize(datatype, allowable_values)
88
- @allowable_values = allowable_values.map do |value|
89
- case datatype.to_s
90
- when /Integer/i
91
- value.to_i
92
- when /Float/i
93
- value.to_f
94
- else
95
- value
96
- end
97
- end
98
- end
99
-
100
- def valid?(value)
101
- !value || allowable_values.include?(value)
102
- end
103
- end
104
-
105
- # Attribute mapping from ruby-style variable name to JSON key.
106
- def self.attribute_map
107
- {
108
- :'name' => :'name',
109
- :'type' => :'type',
110
- :'signer' => :'signer',
111
- :'x' => :'x',
112
- :'y' => :'y',
113
- :'width' => :'width',
114
- :'height' => :'height',
115
- :'required' => :'required',
116
- :'api_id' => :'api_id',
117
- :'group' => :'group',
118
- :'avg_text_length' => :'avg_text_length',
119
- :'is_multiline' => :'isMultiline',
120
- :'original_font_size' => :'originalFontSize',
121
- :'font_family' => :'fontFamily',
122
- :'named_form_fields' => :'named_form_fields',
123
- :'reusable_form_id' => :'reusable_form_id'
124
- }
125
- end
126
-
127
- # Returns all the JSON keys this model knows about
128
- def self.acceptable_attributes
129
- attribute_map.values
130
- end
131
-
132
- # Returns attribute map of this model + parent
133
- def self.merged_attributes
134
- self.attribute_map
135
- end
136
-
137
- # Attribute type mapping.
138
- def self.openapi_types
139
- {
140
- :'name' => :'String',
141
- :'type' => :'String',
142
- :'signer' => :'String',
143
- :'x' => :'Integer',
144
- :'y' => :'Integer',
145
- :'width' => :'Integer',
146
- :'height' => :'Integer',
147
- :'required' => :'Boolean',
148
- :'api_id' => :'String',
149
- :'group' => :'String',
150
- :'avg_text_length' => :'TemplateResponseFieldAvgTextLength',
151
- :'is_multiline' => :'Boolean',
152
- :'original_font_size' => :'Integer',
153
- :'font_family' => :'String',
154
- :'named_form_fields' => :'Object',
155
- :'reusable_form_id' => :'String'
156
- }
157
- end
158
-
159
- # Attribute type mapping of this model + parent
160
- def self.merged_types
161
- self.openapi_types
162
- end
163
-
164
- # List of attributes with nullable: true
165
- def self.openapi_nullable
166
- Set.new([
167
- :'group',
168
- :'is_multiline',
169
- :'original_font_size',
170
- :'font_family',
171
- :'named_form_fields',
172
- :'reusable_form_id'
173
- ])
174
- end
175
-
176
- # Returns list of attributes with nullable: true of this model + parent
177
- def self.merged_nullable
178
- self.openapi_nullable
179
- end
180
-
181
- # Attempt to instantiate and hydrate a new instance of this class
182
- # @param [Object] data Data to be converted
183
- # @return [TemplateResponseDocumentCustomField]
184
- def self.init(data)
185
- return ApiClient.default.convert_to_type(
186
- data,
187
- "TemplateResponseDocumentCustomField"
188
- ) || TemplateResponseDocumentCustomField.new
189
- end
190
-
191
- # Initializes the object
192
- # @param [Hash] attributes Model attributes in the form of hash
193
- def initialize(attributes = {})
194
- if (!attributes.is_a?(Hash))
195
- fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateResponseDocumentCustomField` initialize method"
196
- end
197
-
198
- # check to see if the attribute exists and convert string to symbol for hash key
199
- attributes = attributes.each_with_object({}) { |(k, v), h|
200
- if (!self.class.merged_attributes.key?(k.to_sym))
201
- fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateResponseDocumentCustomField`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
202
- end
203
- h[k.to_sym] = v
204
- }
205
-
206
- if attributes.key?(:'name')
207
- self.name = attributes[:'name']
208
- end
209
-
210
- if attributes.key?(:'type')
211
- self.type = attributes[:'type']
212
- end
213
-
214
- if attributes.key?(:'signer')
215
- self.signer = attributes[:'signer']
216
- end
217
-
218
- if attributes.key?(:'x')
219
- self.x = attributes[:'x']
220
- end
221
-
222
- if attributes.key?(:'y')
223
- self.y = attributes[:'y']
224
- end
225
-
226
- if attributes.key?(:'width')
227
- self.width = attributes[:'width']
228
- end
229
-
230
- if attributes.key?(:'height')
231
- self.height = attributes[:'height']
232
- end
233
-
234
- if attributes.key?(:'required')
235
- self.required = attributes[:'required']
236
- end
237
-
238
- if attributes.key?(:'api_id')
239
- self.api_id = attributes[:'api_id']
240
- end
241
-
242
- if attributes.key?(:'group')
243
- self.group = attributes[:'group']
244
- end
245
-
246
- if attributes.key?(:'avg_text_length')
247
- self.avg_text_length = attributes[:'avg_text_length']
248
- end
249
-
250
- if attributes.key?(:'is_multiline')
251
- self.is_multiline = attributes[:'is_multiline']
252
- end
253
-
254
- if attributes.key?(:'original_font_size')
255
- self.original_font_size = attributes[:'original_font_size']
256
- end
257
-
258
- if attributes.key?(:'font_family')
259
- self.font_family = attributes[:'font_family']
260
- end
261
-
262
- if attributes.key?(:'named_form_fields')
263
- self.named_form_fields = attributes[:'named_form_fields']
264
- end
265
-
266
- if attributes.key?(:'reusable_form_id')
267
- self.reusable_form_id = attributes[:'reusable_form_id']
268
- end
269
- end
270
-
271
- # Show invalid properties with the reasons. Usually used together with valid?
272
- # @return Array for valid properties with the reasons
273
- def list_invalid_properties
274
- invalid_properties = Array.new
275
- invalid_properties
276
- end
277
-
278
- # Check to see if the all the properties in the model are valid
279
- # @return true if the model is valid
280
- def valid?
281
- type_validator = EnumAttributeValidator.new('String', ["text", "checkbox"])
282
- return false unless type_validator.valid?(@type)
283
- true
284
- end
285
-
286
- # Custom attribute writer method checking allowed values (enum).
287
- # @param [Object] type Object to be assigned
288
- def type=(type)
289
- validator = EnumAttributeValidator.new('String', ["text", "checkbox"])
290
- unless validator.valid?(type)
291
- fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
292
- end
293
- @type = type
294
- end
295
-
296
- # Checks equality by comparing each attribute.
297
- # @param [Object] Object to be compared
298
- def ==(o)
299
- return true if self.equal?(o)
300
- self.class == o.class &&
301
- name == o.name &&
302
- type == o.type &&
303
- signer == o.signer &&
304
- x == o.x &&
305
- y == o.y &&
306
- width == o.width &&
307
- height == o.height &&
308
- required == o.required &&
309
- api_id == o.api_id &&
310
- group == o.group &&
311
- avg_text_length == o.avg_text_length &&
312
- is_multiline == o.is_multiline &&
313
- original_font_size == o.original_font_size &&
314
- font_family == o.font_family &&
315
- named_form_fields == o.named_form_fields &&
316
- reusable_form_id == o.reusable_form_id
317
- end
318
-
319
- # @see the `==` method
320
- # @param [Object] Object to be compared
321
- def eql?(o)
322
- self == o
323
- end
324
-
325
- # Calculates hash code according to all attributes.
326
- # @return [Integer] Hash code
327
- def hash
328
- [name, type, signer, x, y, width, height, required, api_id, group, avg_text_length, is_multiline, original_font_size, font_family, named_form_fields, reusable_form_id].hash
329
- end
330
-
331
- # Builds the object from hash
332
- # @param [Hash] attributes Model attributes in the form of hash
333
- # @return [Object] Returns the model itself
334
- def self.build_from_hash(attributes)
335
- new.build_from_hash(attributes)
336
- end
337
-
338
- # Builds the object from hash
339
- # @param [Hash] attributes Model attributes in the form of hash
340
- # @return [Object] Returns the model itself
341
- def build_from_hash(attributes)
342
- return nil unless attributes.is_a?(Hash)
343
- attribute_map = self.class.merged_attributes
344
-
345
- self.class.merged_types.each_pair do |key, type|
346
- if type =~ /\AArray<(.*)>/i
347
- # check to ensure the input is an array given that the attribute
348
- # is documented as an array but the input is not
349
- if attributes[attribute_map[key]].is_a?(Array)
350
- self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
351
- end
352
- elsif !attributes[attribute_map[key]].nil?
353
- self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
354
- end
355
- end
356
-
357
- self
358
- end
359
-
360
- # Deserializes the data based on type
361
- # @param string type Data type
362
- # @param string value Value to be deserialized
363
- # @return [Object] Deserialized data
364
- def _deserialize(type, value)
365
- case type.to_sym
366
- when :Time
367
- Time.parse(value)
368
- when :Date
369
- Date.parse(value)
370
- when :String
371
- value.to_s
372
- when :Integer
373
- value.to_i
374
- when :Float
375
- value.to_f
376
- when :Boolean
377
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
378
- true
379
- else
380
- false
381
- end
382
- when :File
383
- value
384
- when :Object
385
- # generic object (usually a Hash), return directly
386
- value
387
- when /\AArray<(?<inner_type>.+)>\z/
388
- inner_type = Regexp.last_match[:inner_type]
389
- value.map { |v| _deserialize(inner_type, v) }
390
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
391
- k_type = Regexp.last_match[:k_type]
392
- v_type = Regexp.last_match[:v_type]
393
- {}.tap do |hash|
394
- value.each do |k, v|
395
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
396
- end
397
- end
398
- else # model
399
- # models (e.g. Pet)
400
- klass = Dropbox::Sign.const_get(type)
401
- klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
402
- end
403
- end
404
-
405
- # Returns the string representation of the object
406
- # @return [String] String presentation of the object
407
- def to_s
408
- to_hash.to_s
409
- end
410
-
411
- # to_body is an alias to to_hash (backward compatibility)
412
- # @return [Hash] Returns the object in the form of hash
413
- def to_body
414
- to_hash
415
- end
416
-
417
- # Returns the object in the form of hash
418
- # @return [Hash] Returns the object in the form of hash
419
- def to_hash(include_nil = true)
420
- hash = {}
421
- self.class.merged_attributes.each_pair do |attr, param|
422
- value = self.send(attr)
423
- if value.nil?
424
- next unless include_nil
425
- is_nullable = self.class.merged_nullable.include?(attr)
426
- next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
427
- end
428
-
429
- hash[param] = _to_hash(value, include_nil)
430
- end
431
- hash
432
- end
433
-
434
- # Outputs non-array value in the form of hash
435
- # For object, use to_hash. Otherwise, just return the value
436
- # @param [Object] value Any valid value
437
- # @return [Hash] Returns the value in the form of hash
438
- def _to_hash(value, include_nil = true)
439
- if value.is_a?(Array)
440
- value.compact.map { |v| _to_hash(v, include_nil) }
441
- elsif value.is_a?(Hash)
442
- {}.tap do |hash|
443
- value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
444
- end
445
- elsif value.respond_to? :to_hash
446
- value.to_hash(include_nil)
447
- else
448
- value
449
- end
450
- end
451
-
452
- end
453
-
454
- end