dropbox-sign 1.1.2 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +9 -4
  4. data/VERSION +1 -1
  5. data/docs/OAuthApi.md +0 -16
  6. data/docs/SignatureRequestApi.md +1 -1
  7. data/docs/SignatureRequestSendRequest.md +1 -0
  8. data/docs/SignatureRequestSendWithTemplateRequest.md +1 -0
  9. data/docs/SignatureRequestUpdateRequest.md +1 -1
  10. data/docs/SubFormFieldsPerDocumentBase.md +1 -1
  11. data/docs/SubFormFieldsPerDocumentDateSigned.md +2 -0
  12. data/docs/SubFormFieldsPerDocumentDropdown.md +2 -0
  13. data/docs/SubFormFieldsPerDocumentFontEnum.md +9 -0
  14. data/docs/SubFormFieldsPerDocumentHyperlink.md +2 -0
  15. data/docs/SubFormFieldsPerDocumentText.md +3 -0
  16. data/docs/SubFormFieldsPerDocumentTextMerge.md +2 -0
  17. data/docs/SubWhiteLabelingOptions.md +1 -1
  18. data/docs/TemplateApi.md +102 -0
  19. data/docs/TemplateCreateRequest.md +27 -0
  20. data/docs/TemplateCreateResponse.md +11 -0
  21. data/docs/TemplateCreateResponseTemplate.md +10 -0
  22. data/examples/OauthTokenGenerate.rb +0 -8
  23. data/examples/OauthTokenRefresh.rb +0 -8
  24. data/examples/TemplateCreate.rb +49 -0
  25. data/lib/dropbox-sign/api/signature_request_api.rb +2 -2
  26. data/lib/dropbox-sign/api/template_api.rb +109 -0
  27. data/lib/dropbox-sign/models/signature_request_send_request.rb +14 -1
  28. data/lib/dropbox-sign/models/signature_request_send_with_template_request.rb +14 -1
  29. data/lib/dropbox-sign/models/signature_request_update_request.rb +1 -1
  30. data/lib/dropbox-sign/models/sub_form_fields_per_document_base.rb +1 -1
  31. data/lib/dropbox-sign/models/sub_form_fields_per_document_date_signed.rb +60 -4
  32. data/lib/dropbox-sign/models/sub_form_fields_per_document_dropdown.rb +60 -4
  33. data/lib/dropbox-sign/models/sub_form_fields_per_document_font_enum.rb +54 -0
  34. data/lib/dropbox-sign/models/sub_form_fields_per_document_hyperlink.rb +60 -4
  35. data/lib/dropbox-sign/models/sub_form_fields_per_document_text.rb +49 -4
  36. data/lib/dropbox-sign/models/sub_form_fields_per_document_text_merge.rb +60 -4
  37. data/lib/dropbox-sign/models/sub_white_labeling_options.rb +1 -1
  38. data/lib/dropbox-sign/models/template_create_request.rb +509 -0
  39. data/lib/dropbox-sign/models/template_create_response.rb +263 -0
  40. data/lib/dropbox-sign/models/template_create_response_template.rb +252 -0
  41. data/lib/dropbox-sign/version.rb +1 -1
  42. data/lib/dropbox-sign.rb +4 -0
  43. data/openapi-config.yaml +1 -1
  44. data/openapi-sdk.yaml +701 -241
  45. data/test_fixtures/SignatureRequestCreateEmbeddedRequest.json +6 -2
  46. data/test_fixtures/SignatureRequestSendRequest.json +8 -2
  47. data/test_fixtures/SignatureRequestSendWithTemplateRequest.json +1 -0
  48. data/test_fixtures/TemplateCreateEmbeddedDraftRequest.json +3 -1
  49. data/test_fixtures/TemplateCreateRequest.json +120 -0
  50. data/test_fixtures/TemplateCreateResponse.json +7 -0
  51. data/test_fixtures/UnclaimedDraftCreateEmbeddedRequest.json +3 -1
  52. data/test_fixtures/UnclaimedDraftCreateRequest.json +3 -1
  53. metadata +21 -10
@@ -0,0 +1,263 @@
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 TemplateCreateResponse
21
+ # @return [TemplateCreateResponse]
22
+ attr_accessor :template
23
+
24
+ # A list of warnings.
25
+ # @return [Array<WarningResponse>]
26
+ attr_accessor :warnings
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'template' => :'template',
32
+ :'warnings' => :'warnings'
33
+ }
34
+ end
35
+
36
+ # Returns all the JSON keys this model knows about
37
+ def self.acceptable_attributes
38
+ attribute_map.values
39
+ end
40
+
41
+ # Returns attribute map of this model + parent
42
+ def self.merged_attributes
43
+ self.attribute_map
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'template' => :'TemplateCreateResponse',
50
+ :'warnings' => :'Array<WarningResponse>'
51
+ }
52
+ end
53
+
54
+ # Attribute type mapping of this model + parent
55
+ def self.merged_types
56
+ self.openapi_types
57
+ end
58
+
59
+ # List of attributes with nullable: true
60
+ def self.openapi_nullable
61
+ Set.new([
62
+ ])
63
+ end
64
+
65
+ # Returns list of attributes with nullable: true of this model + parent
66
+ def self.merged_nullable
67
+ self.openapi_nullable
68
+ end
69
+
70
+ # Attempt to instantiate and hydrate a new instance of this class
71
+ # @param [Object] data Data to be converted
72
+ # @return [TemplateCreateResponse]
73
+ def self.init(data)
74
+ return ApiClient.default.convert_to_type(
75
+ data,
76
+ "TemplateCreateResponse"
77
+ ) || TemplateCreateResponse.new
78
+ end
79
+
80
+ # Initializes the object
81
+ # @param [Hash] attributes Model attributes in the form of hash
82
+ def initialize(attributes = {})
83
+ if (!attributes.is_a?(Hash))
84
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateCreateResponse` initialize method"
85
+ end
86
+
87
+ # check to see if the attribute exists and convert string to symbol for hash key
88
+ attributes = attributes.each_with_object({}) { |(k, v), h|
89
+ if (!self.class.merged_attributes.key?(k.to_sym))
90
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
91
+ end
92
+ h[k.to_sym] = v
93
+ }
94
+
95
+ if attributes.key?(:'template')
96
+ self.template = attributes[:'template']
97
+ end
98
+
99
+ if attributes.key?(:'warnings')
100
+ if (value = attributes[:'warnings']).is_a?(Array)
101
+ self.warnings = value
102
+ end
103
+ end
104
+ end
105
+
106
+ # Show invalid properties with the reasons. Usually used together with valid?
107
+ # @return Array for valid properties with the reasons
108
+ def list_invalid_properties
109
+ invalid_properties = Array.new
110
+ invalid_properties
111
+ end
112
+
113
+ # Check to see if the all the properties in the model are valid
114
+ # @return true if the model is valid
115
+ def valid?
116
+ true
117
+ end
118
+
119
+ # Checks equality by comparing each attribute.
120
+ # @param [Object] Object to be compared
121
+ def ==(o)
122
+ return true if self.equal?(o)
123
+ self.class == o.class &&
124
+ template == o.template &&
125
+ warnings == o.warnings
126
+ end
127
+
128
+ # @see the `==` method
129
+ # @param [Object] Object to be compared
130
+ def eql?(o)
131
+ self == o
132
+ end
133
+
134
+ # Calculates hash code according to all attributes.
135
+ # @return [Integer] Hash code
136
+ def hash
137
+ [template, warnings].hash
138
+ end
139
+
140
+ # Builds the object from hash
141
+ # @param [Hash] attributes Model attributes in the form of hash
142
+ # @return [Object] Returns the model itself
143
+ def self.build_from_hash(attributes)
144
+ new.build_from_hash(attributes)
145
+ end
146
+
147
+ # Builds the object from hash
148
+ # @param [Hash] attributes Model attributes in the form of hash
149
+ # @return [Object] Returns the model itself
150
+ def build_from_hash(attributes)
151
+ return nil unless attributes.is_a?(Hash)
152
+ attribute_map = self.class.merged_attributes
153
+
154
+ self.class.merged_types.each_pair do |key, type|
155
+ if type =~ /\AArray<(.*)>/i
156
+ # check to ensure the input is an array given that the attribute
157
+ # is documented as an array but the input is not
158
+ if attributes[attribute_map[key]].is_a?(Array)
159
+ self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
160
+ end
161
+ elsif !attributes[attribute_map[key]].nil?
162
+ self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
163
+ end
164
+ end
165
+
166
+ self
167
+ end
168
+
169
+ # Deserializes the data based on type
170
+ # @param string type Data type
171
+ # @param string value Value to be deserialized
172
+ # @return [Object] Deserialized data
173
+ def _deserialize(type, value)
174
+ case type.to_sym
175
+ when :Time
176
+ Time.parse(value)
177
+ when :Date
178
+ Date.parse(value)
179
+ when :String
180
+ value.to_s
181
+ when :Integer
182
+ value.to_i
183
+ when :Float
184
+ value.to_f
185
+ when :Boolean
186
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
187
+ true
188
+ else
189
+ false
190
+ end
191
+ when :File
192
+ value
193
+ when :Object
194
+ # generic object (usually a Hash), return directly
195
+ value
196
+ when /\AArray<(?<inner_type>.+)>\z/
197
+ inner_type = Regexp.last_match[:inner_type]
198
+ value.map { |v| _deserialize(inner_type, v) }
199
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
200
+ k_type = Regexp.last_match[:k_type]
201
+ v_type = Regexp.last_match[:v_type]
202
+ {}.tap do |hash|
203
+ value.each do |k, v|
204
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
205
+ end
206
+ end
207
+ else # model
208
+ # models (e.g. Pet)
209
+ klass = Dropbox::Sign.const_get(type)
210
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
211
+ end
212
+ end
213
+
214
+ # Returns the string representation of the object
215
+ # @return [String] String presentation of the object
216
+ def to_s
217
+ to_hash.to_s
218
+ end
219
+
220
+ # to_body is an alias to to_hash (backward compatibility)
221
+ # @return [Hash] Returns the object in the form of hash
222
+ def to_body
223
+ to_hash
224
+ end
225
+
226
+ # Returns the object in the form of hash
227
+ # @return [Hash] Returns the object in the form of hash
228
+ def to_hash(include_nil = true)
229
+ hash = {}
230
+ self.class.merged_attributes.each_pair do |attr, param|
231
+ value = self.send(attr)
232
+ if value.nil?
233
+ next unless include_nil
234
+ is_nullable = self.class.merged_nullable.include?(attr)
235
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
236
+ end
237
+
238
+ hash[param] = _to_hash(value, include_nil)
239
+ end
240
+ hash
241
+ end
242
+
243
+ # Outputs non-array value in the form of hash
244
+ # For object, use to_hash. Otherwise, just return the value
245
+ # @param [Object] value Any valid value
246
+ # @return [Hash] Returns the value in the form of hash
247
+ def _to_hash(value, include_nil = true)
248
+ if value.is_a?(Array)
249
+ value.compact.map { |v| _to_hash(v, include_nil) }
250
+ elsif value.is_a?(Hash)
251
+ {}.tap do |hash|
252
+ value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
253
+ end
254
+ elsif value.respond_to? :to_hash
255
+ value.to_hash(include_nil)
256
+ else
257
+ value
258
+ end
259
+ end
260
+
261
+ end
262
+
263
+ end
@@ -0,0 +1,252 @@
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
+ # Template object with parameters: `template_id`.
21
+ class TemplateCreateResponseTemplate
22
+ # The id of the Template.
23
+ # @return [String]
24
+ attr_accessor :template_id
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'template_id' => :'template_id'
30
+ }
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ attribute_map.values
36
+ end
37
+
38
+ # Returns attribute map of this model + parent
39
+ def self.merged_attributes
40
+ self.attribute_map
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'template_id' => :'String'
47
+ }
48
+ end
49
+
50
+ # Attribute type mapping of this model + parent
51
+ def self.merged_types
52
+ self.openapi_types
53
+ end
54
+
55
+ # List of attributes with nullable: true
56
+ def self.openapi_nullable
57
+ Set.new([
58
+ ])
59
+ end
60
+
61
+ # Returns list of attributes with nullable: true of this model + parent
62
+ def self.merged_nullable
63
+ self.openapi_nullable
64
+ end
65
+
66
+ # Attempt to instantiate and hydrate a new instance of this class
67
+ # @param [Object] data Data to be converted
68
+ # @return [TemplateCreateResponseTemplate]
69
+ def self.init(data)
70
+ return ApiClient.default.convert_to_type(
71
+ data,
72
+ "TemplateCreateResponseTemplate"
73
+ ) || TemplateCreateResponseTemplate.new
74
+ end
75
+
76
+ # Initializes the object
77
+ # @param [Hash] attributes Model attributes in the form of hash
78
+ def initialize(attributes = {})
79
+ if (!attributes.is_a?(Hash))
80
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Dropbox::Sign::TemplateCreateResponseTemplate` initialize method"
81
+ end
82
+
83
+ # check to see if the attribute exists and convert string to symbol for hash key
84
+ attributes = attributes.each_with_object({}) { |(k, v), h|
85
+ if (!self.class.merged_attributes.key?(k.to_sym))
86
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Dropbox::Sign::TemplateCreateResponseTemplate`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
87
+ end
88
+ h[k.to_sym] = v
89
+ }
90
+
91
+ if attributes.key?(:'template_id')
92
+ self.template_id = attributes[:'template_id']
93
+ end
94
+ end
95
+
96
+ # Show invalid properties with the reasons. Usually used together with valid?
97
+ # @return Array for valid properties with the reasons
98
+ def list_invalid_properties
99
+ invalid_properties = Array.new
100
+ invalid_properties
101
+ end
102
+
103
+ # Check to see if the all the properties in the model are valid
104
+ # @return true if the model is valid
105
+ def valid?
106
+ true
107
+ end
108
+
109
+ # Checks equality by comparing each attribute.
110
+ # @param [Object] Object to be compared
111
+ def ==(o)
112
+ return true if self.equal?(o)
113
+ self.class == o.class &&
114
+ template_id == o.template_id
115
+ end
116
+
117
+ # @see the `==` method
118
+ # @param [Object] Object to be compared
119
+ def eql?(o)
120
+ self == o
121
+ end
122
+
123
+ # Calculates hash code according to all attributes.
124
+ # @return [Integer] Hash code
125
+ def hash
126
+ [template_id].hash
127
+ end
128
+
129
+ # Builds the object from hash
130
+ # @param [Hash] attributes Model attributes in the form of hash
131
+ # @return [Object] Returns the model itself
132
+ def self.build_from_hash(attributes)
133
+ new.build_from_hash(attributes)
134
+ end
135
+
136
+ # Builds the object from hash
137
+ # @param [Hash] attributes Model attributes in the form of hash
138
+ # @return [Object] Returns the model itself
139
+ def build_from_hash(attributes)
140
+ return nil unless attributes.is_a?(Hash)
141
+ attribute_map = self.class.merged_attributes
142
+
143
+ self.class.merged_types.each_pair do |key, type|
144
+ if type =~ /\AArray<(.*)>/i
145
+ # check to ensure the input is an array given that the attribute
146
+ # is documented as an array but the input is not
147
+ if attributes[attribute_map[key]].is_a?(Array)
148
+ self.send("#{key}=", attributes[attribute_map[key]].map { |v| _deserialize($1, v) })
149
+ end
150
+ elsif !attributes[attribute_map[key]].nil?
151
+ self.send("#{key}=", _deserialize(type, attributes[attribute_map[key]]))
152
+ end
153
+ end
154
+
155
+ self
156
+ end
157
+
158
+ # Deserializes the data based on type
159
+ # @param string type Data type
160
+ # @param string value Value to be deserialized
161
+ # @return [Object] Deserialized data
162
+ def _deserialize(type, value)
163
+ case type.to_sym
164
+ when :Time
165
+ Time.parse(value)
166
+ when :Date
167
+ Date.parse(value)
168
+ when :String
169
+ value.to_s
170
+ when :Integer
171
+ value.to_i
172
+ when :Float
173
+ value.to_f
174
+ when :Boolean
175
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
176
+ true
177
+ else
178
+ false
179
+ end
180
+ when :File
181
+ value
182
+ when :Object
183
+ # generic object (usually a Hash), return directly
184
+ value
185
+ when /\AArray<(?<inner_type>.+)>\z/
186
+ inner_type = Regexp.last_match[:inner_type]
187
+ value.map { |v| _deserialize(inner_type, v) }
188
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
189
+ k_type = Regexp.last_match[:k_type]
190
+ v_type = Regexp.last_match[:v_type]
191
+ {}.tap do |hash|
192
+ value.each do |k, v|
193
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
194
+ end
195
+ end
196
+ else # model
197
+ # models (e.g. Pet)
198
+ klass = Dropbox::Sign.const_get(type)
199
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
200
+ end
201
+ end
202
+
203
+ # Returns the string representation of the object
204
+ # @return [String] String presentation of the object
205
+ def to_s
206
+ to_hash.to_s
207
+ end
208
+
209
+ # to_body is an alias to to_hash (backward compatibility)
210
+ # @return [Hash] Returns the object in the form of hash
211
+ def to_body
212
+ to_hash
213
+ end
214
+
215
+ # Returns the object in the form of hash
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_hash(include_nil = true)
218
+ hash = {}
219
+ self.class.merged_attributes.each_pair do |attr, param|
220
+ value = self.send(attr)
221
+ if value.nil?
222
+ next unless include_nil
223
+ is_nullable = self.class.merged_nullable.include?(attr)
224
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
225
+ end
226
+
227
+ hash[param] = _to_hash(value, include_nil)
228
+ end
229
+ hash
230
+ end
231
+
232
+ # Outputs non-array value in the form of hash
233
+ # For object, use to_hash. Otherwise, just return the value
234
+ # @param [Object] value Any valid value
235
+ # @return [Hash] Returns the value in the form of hash
236
+ def _to_hash(value, include_nil = true)
237
+ if value.is_a?(Array)
238
+ value.compact.map { |v| _to_hash(v, include_nil) }
239
+ elsif value.is_a?(Hash)
240
+ {}.tap do |hash|
241
+ value.each { |k, v| hash[k] = _to_hash(v, include_nil) }
242
+ end
243
+ elsif value.respond_to? :to_hash
244
+ value.to_hash(include_nil)
245
+ else
246
+ value
247
+ end
248
+ end
249
+
250
+ end
251
+
252
+ end
@@ -14,5 +14,5 @@ module Dropbox
14
14
  end
15
15
 
16
16
  module Dropbox::Sign
17
- VERSION = '1.1.2'
17
+ VERSION = '1.2.0'
18
18
  end
data/lib/dropbox-sign.rb CHANGED
@@ -88,6 +88,7 @@ require 'dropbox-sign/models/sub_form_field_rule'
88
88
  require 'dropbox-sign/models/sub_form_field_rule_action'
89
89
  require 'dropbox-sign/models/sub_form_field_rule_trigger'
90
90
  require 'dropbox-sign/models/sub_form_fields_per_document_base'
91
+ require 'dropbox-sign/models/sub_form_fields_per_document_font_enum'
91
92
  require 'dropbox-sign/models/sub_form_fields_per_document_type_enum'
92
93
  require 'dropbox-sign/models/sub_merge_field'
93
94
  require 'dropbox-sign/models/sub_o_auth'
@@ -119,6 +120,9 @@ require 'dropbox-sign/models/template_add_user_request'
119
120
  require 'dropbox-sign/models/template_create_embedded_draft_request'
120
121
  require 'dropbox-sign/models/template_create_embedded_draft_response'
121
122
  require 'dropbox-sign/models/template_create_embedded_draft_response_template'
123
+ require 'dropbox-sign/models/template_create_request'
124
+ require 'dropbox-sign/models/template_create_response'
125
+ require 'dropbox-sign/models/template_create_response_template'
122
126
  require 'dropbox-sign/models/template_edit_response'
123
127
  require 'dropbox-sign/models/template_get_response'
124
128
  require 'dropbox-sign/models/template_list_response'
data/openapi-config.yaml CHANGED
@@ -9,7 +9,7 @@ additionalProperties:
9
9
  gemName: dropbox-sign
10
10
  gemRequiredRubyVersion: '>= 2.7'
11
11
  moduleName: "Dropbox::Sign"
12
- gemVersion: 1.1.2
12
+ gemVersion: 1.2.0
13
13
  sortModelPropertiesByRequiredFlag: true
14
14
  legacyDiscriminatorBehavior: true
15
15
  gitUserId: hellosign