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,21 +20,27 @@ module Dropbox::Sign
20
20
  # A group of documents that a user can take ownership of via the claim URL.
21
21
  class UnclaimedDraftResponse
22
22
  # The ID of the signature request that is represented by this UnclaimedDraft.
23
+ # @return [String, nil]
23
24
  attr_accessor :signature_request_id
24
25
 
25
26
  # The URL to be used to claim this UnclaimedDraft.
27
+ # @return [String]
26
28
  attr_accessor :claim_url
27
29
 
28
30
  # The URL you want signers redirected to after they successfully sign.
31
+ # @return [String, nil]
29
32
  attr_accessor :signing_redirect_url
30
33
 
31
34
  # The URL you want signers redirected to after they successfully request a signature (Will only be returned in the response if it is applicable to the request.).
35
+ # @return [String, nil]
32
36
  attr_accessor :requesting_redirect_url
33
37
 
34
38
  # When the link expires.
39
+ # @return [Integer, nil]
35
40
  attr_accessor :expires_at
36
41
 
37
42
  # Whether this is a test draft. Signature requests made from test drafts have no legal value.
43
+ # @return [Boolean]
38
44
  attr_accessor :test_mode
39
45
 
40
46
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -20,9 +20,11 @@ module Dropbox::Sign
20
20
  # A list of warnings.
21
21
  class WarningResponse
22
22
  # Warning message
23
+ # @return [String]
23
24
  attr_accessor :warning_msg
24
25
 
25
26
  # Warning name
27
+ # @return [String]
26
28
  attr_accessor :warning_name
27
29
 
28
30
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.0.0-beta2301'
17
+ VERSION = '1.0.0'
18
18
  end
data/openapi-config.yaml CHANGED
@@ -9,9 +9,11 @@ additionalProperties:
9
9
  gemName: dropbox-sign
10
10
  gemRequiredRubyVersion: '>= 2.7'
11
11
  moduleName: "Dropbox::Sign"
12
- gemVersion: 1.0.0-beta2301
12
+ gemVersion: 1.0.0
13
13
  sortModelPropertiesByRequiredFlag: true
14
14
  legacyDiscriminatorBehavior: true
15
+ gitUserId: hellosign
16
+ gitRepoId: dropbox-sign-ruby
15
17
  files:
16
18
  event_callback_helper.mustache:
17
19
  templateType: SupportingFiles
data/openapi-sdk.yaml CHANGED
@@ -7585,6 +7585,7 @@ components:
7585
7585
 
7586
7586
  **NOTE**: If type is `text-merge` or `checkbox-merge`, you must set this to sender in order to use pre-filled data.
7587
7587
  type: string
7588
+ x-int-or-string: true
7588
7589
  type:
7589
7590
  type: string
7590
7591
  width:
@@ -20,5 +20,29 @@ describe Dropbox::Sign::SubFormFieldsPerDocumentBase do
20
20
  expect(serialized.to_json).to be_json_eql(JSON.dump(data))
21
21
  end
22
22
  end
23
+
24
+ fixture_data.each do |type, data|
25
+ it "SubFormFieldsPerDocument allows int for signer property" do
26
+ data[:signer] = 1234
27
+ payload = { form_fields_per_document: [data] }
28
+ expected_signer = '1234'
29
+
30
+ obj = Dropbox::Sign::SignatureRequestSendRequest.init(payload)
31
+ form_fields_per_document = obj.form_fields_per_document[0]
32
+ expect(form_fields_per_document.signer).to eq(expected_signer)
33
+ end
34
+ end
35
+
36
+ fixture_data.each do |type, data|
37
+ it "SubFormFieldsPerDocument allows string for signer property" do
38
+ data[:signer] = 'sender'
39
+ payload = { form_fields_per_document: [data] }
40
+ expected_signer = 'sender'
41
+
42
+ obj = Dropbox::Sign::SignatureRequestSendRequest.init(payload)
43
+ form_fields_per_document = obj.form_fields_per_document[0]
44
+ expect(form_fields_per_document.signer).to eq(expected_signer)
45
+ end
46
+ end
23
47
  end
24
48
  end
@@ -8,7 +8,7 @@
8
8
 
9
9
  ## Migrating from legacy SDK
10
10
 
11
- This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/development/openapi.yaml).
11
+ This SDK is generated from our officially maintained [OpenAPI spec](https://github.com/hellosign/hellosign-openapi/blob/main/openapi.yaml).
12
12
  We've made important updates that introduce new functionality and create feature parity between the Dropbox Sign API and the SDK.
13
13
  However, some of these changes are considered "breaking" in the sense that they'll require you to update your existing code in order to continue using the SDK.
14
14
  Please refer to this [migration guide](https://developers.hellosign.com/docs/sdks/ruby/migration-guide/) for more information.
@@ -40,7 +40,7 @@ For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
40
40
 
41
41
  ### Install gem
42
42
  ```shell
43
- gem install {{{gemName}}} --pre
43
+ gem install {{{gemName}}}
44
44
  ```
45
45
 
46
46
  ### Build a gem
@@ -51,7 +51,7 @@ To build the Ruby code into a gem:
51
51
  gem build {{{gemName}}}.gemspec
52
52
  ```
53
53
 
54
- Then either install the gem locally:
54
+ Then install the gem locally:
55
55
 
56
56
  ```shell
57
57
  gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
@@ -59,8 +59,6 @@ gem install ./{{{gemName}}}-{{{gemVersion}}}.gem
59
59
 
60
60
  (for development, run `gem install --dev ./{{{gemName}}}-{{{gemVersion}}}.gem` to install the development dependencies)
61
61
 
62
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
63
-
64
62
  Finally add this to the Gemfile:
65
63
 
66
64
  gem '{{{gemName}}}', '~> {{{gemVersion}}}'
@@ -6,6 +6,7 @@
6
6
  {{#description}}
7
7
  # {{{.}}}
8
8
  {{/description}}
9
+ # @return [{{#vendorExtensions.x-int-or-string}}Integer, String{{/vendorExtensions.x-int-or-string}}{{^vendorExtensions.x-int-or-string}}{{{dataType}}}{{/vendorExtensions.x-int-or-string}}{{#isNullable}}, nil{{/isNullable}}]
9
10
  attr_accessor :{{{name}}}
10
11
 
11
12
  {{/vars}}
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.pre.beta2301
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dropbox
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-19 00:00:00.000000000 Z
11
+ date: 2023-01-31 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -62,6 +62,7 @@ files:
62
62
  - LICENSE
63
63
  - README.md
64
64
  - Rakefile
65
+ - bin/check-clean-git-status
65
66
  - bin/generate-examples.php
66
67
  - bin/php
67
68
  - bin/replace
@@ -622,9 +623,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
622
623
  version: '2.7'
623
624
  required_rubygems_version: !ruby/object:Gem::Requirement
624
625
  requirements:
625
- - - ">"
626
+ - - ">="
626
627
  - !ruby/object:Gem::Version
627
- version: 1.3.1
628
+ version: '0'
628
629
  requirements: []
629
630
  rubygems_version: 3.1.4
630
631
  signing_key: