lob 6.0.6 → 6.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/docs/Address.md +43 -46
- data/docs/CountryExtendedExpandedNoUs.md +15 -0
- data/docs/IntlAddress.md +54 -0
- data/docs/MultipleComponents.md +2 -2
- data/docs/UsAddress.md +54 -0
- data/docs/UsVerification.md +2 -2
- data/docs/UsVerificationOrError.md +2 -2
- data/docs/UsVerifications.md +2 -2
- data/docs/UsVerificationsWritable.md +2 -2
- data/lib/openapi_client/models/address.rb +76 -587
- data/lib/openapi_client/models/country_extended_expanded_no_us.rb +254 -0
- data/lib/openapi_client/models/intl_address.rb +624 -0
- data/lib/openapi_client/models/multiple_components.rb +9 -9
- data/lib/openapi_client/models/us_address.rb +644 -0
- data/lib/openapi_client/models/us_verification.rb +12 -12
- data/lib/openapi_client/models/us_verification_or_error.rb +10 -10
- data/lib/openapi_client/models/us_verifications.rb +5 -5
- data/lib/openapi_client/models/us_verifications_writable.rb +10 -10
- data/lib/openapi_client/version.rb +1 -1
- data/lib/openapi_client.rb +1 -1
- metadata +8 -2
@@ -0,0 +1,624 @@
|
|
1
|
+
=begin
|
2
|
+
#Lob
|
3
|
+
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.3.0
|
7
|
+
Contact: lob-openapi@lob.com
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 5.2.1
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
require 'time'
|
15
|
+
|
16
|
+
module Lob
|
17
|
+
class IntlAddress
|
18
|
+
# Unique identifier prefixed with `adr_`.
|
19
|
+
attr_accessor :id
|
20
|
+
|
21
|
+
# An internal description that identifies this resource. Must be no longer than 255 characters.
|
22
|
+
attr_accessor :description
|
23
|
+
|
24
|
+
# name associated with address
|
25
|
+
attr_accessor :name
|
26
|
+
|
27
|
+
# Either `name` or `company` is required, you may also add both.
|
28
|
+
attr_accessor :company
|
29
|
+
|
30
|
+
# Must be no longer than 40 characters.
|
31
|
+
attr_accessor :phone
|
32
|
+
|
33
|
+
# Must be no longer than 100 characters.
|
34
|
+
attr_accessor :email
|
35
|
+
|
36
|
+
# Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.
|
37
|
+
attr_accessor :metadata
|
38
|
+
|
39
|
+
attr_accessor :address_line1
|
40
|
+
|
41
|
+
attr_accessor :address_line2
|
42
|
+
|
43
|
+
attr_accessor :address_city
|
44
|
+
|
45
|
+
# 2 letter state short-name code
|
46
|
+
attr_accessor :address_state
|
47
|
+
|
48
|
+
# Must have a maximum of 12 characters
|
49
|
+
attr_accessor :address_zip
|
50
|
+
|
51
|
+
attr_accessor :address_country
|
52
|
+
|
53
|
+
attr_accessor :object
|
54
|
+
|
55
|
+
# A timestamp in ISO 8601 format of the date the resource was created.
|
56
|
+
attr_accessor :date_created
|
57
|
+
|
58
|
+
# A timestamp in ISO 8601 format of the date the resource was last modified.
|
59
|
+
attr_accessor :date_modified
|
60
|
+
|
61
|
+
# Only returned if the resource has been successfully deleted.
|
62
|
+
attr_accessor :deleted
|
63
|
+
|
64
|
+
# Checks if address id is used or not
|
65
|
+
attr_accessor :inline
|
66
|
+
|
67
|
+
# Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print & Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account.
|
68
|
+
attr_accessor :recipient_moved
|
69
|
+
|
70
|
+
class EnumAttributeValidator
|
71
|
+
attr_reader :datatype
|
72
|
+
attr_reader :allowable_values
|
73
|
+
|
74
|
+
def initialize(datatype, allowable_values)
|
75
|
+
@allowable_values = allowable_values.map do |value|
|
76
|
+
case datatype.to_s
|
77
|
+
when /Integer/i
|
78
|
+
value.to_i
|
79
|
+
when /Float/i
|
80
|
+
value.to_f
|
81
|
+
else
|
82
|
+
value
|
83
|
+
end
|
84
|
+
end
|
85
|
+
end
|
86
|
+
|
87
|
+
def valid?(value)
|
88
|
+
!value || allowable_values.include?(value)
|
89
|
+
end
|
90
|
+
end
|
91
|
+
|
92
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
93
|
+
def self.attribute_map
|
94
|
+
{
|
95
|
+
:'id' => :'id',
|
96
|
+
:'description' => :'description',
|
97
|
+
:'name' => :'name',
|
98
|
+
:'company' => :'company',
|
99
|
+
:'phone' => :'phone',
|
100
|
+
:'email' => :'email',
|
101
|
+
:'metadata' => :'metadata',
|
102
|
+
:'address_line1' => :'address_line1',
|
103
|
+
:'address_line2' => :'address_line2',
|
104
|
+
:'address_city' => :'address_city',
|
105
|
+
:'address_state' => :'address_state',
|
106
|
+
:'address_zip' => :'address_zip',
|
107
|
+
:'address_country' => :'address_country',
|
108
|
+
:'object' => :'object',
|
109
|
+
:'date_created' => :'date_created',
|
110
|
+
:'date_modified' => :'date_modified',
|
111
|
+
:'deleted' => :'deleted',
|
112
|
+
:'inline' => :'inline',
|
113
|
+
:'recipient_moved' => :'recipient_moved'
|
114
|
+
}
|
115
|
+
end
|
116
|
+
|
117
|
+
# Returns all the JSON keys this model knows about
|
118
|
+
def self.acceptable_attributes
|
119
|
+
attribute_map.values
|
120
|
+
end
|
121
|
+
|
122
|
+
# Attribute type mapping.
|
123
|
+
def self.openapi_types
|
124
|
+
{
|
125
|
+
:'id' => :'String',
|
126
|
+
:'description' => :'String',
|
127
|
+
:'name' => :'String',
|
128
|
+
:'company' => :'String',
|
129
|
+
:'phone' => :'String',
|
130
|
+
:'email' => :'String',
|
131
|
+
:'metadata' => :'Hash<String, String>',
|
132
|
+
:'address_line1' => :'String',
|
133
|
+
:'address_line2' => :'String',
|
134
|
+
:'address_city' => :'String',
|
135
|
+
:'address_state' => :'String',
|
136
|
+
:'address_zip' => :'String',
|
137
|
+
:'address_country' => :'CountryExtendedExpandedNoUs',
|
138
|
+
:'object' => :'String',
|
139
|
+
:'date_created' => :'Time',
|
140
|
+
:'date_modified' => :'Time',
|
141
|
+
:'deleted' => :'Boolean',
|
142
|
+
:'inline' => :'Boolean',
|
143
|
+
:'recipient_moved' => :'Boolean'
|
144
|
+
}
|
145
|
+
end
|
146
|
+
|
147
|
+
# List of attributes with nullable: true
|
148
|
+
def self.openapi_nullable
|
149
|
+
Set.new([
|
150
|
+
:'description',
|
151
|
+
:'name',
|
152
|
+
:'company',
|
153
|
+
:'phone',
|
154
|
+
:'email',
|
155
|
+
:'address_line2',
|
156
|
+
:'recipient_moved'
|
157
|
+
])
|
158
|
+
end
|
159
|
+
|
160
|
+
# Initializes the object
|
161
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
162
|
+
def initialize(attributes = {})
|
163
|
+
if (!attributes.is_a?(Hash))
|
164
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::IntlAddress` initialize method"
|
165
|
+
end
|
166
|
+
|
167
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
168
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
169
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
170
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::IntlAddress`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
171
|
+
end
|
172
|
+
h[k.to_sym] = v
|
173
|
+
}
|
174
|
+
|
175
|
+
if attributes.key?(:'id')
|
176
|
+
self.id = attributes[:'id']
|
177
|
+
end
|
178
|
+
|
179
|
+
if attributes.key?(:'description')
|
180
|
+
self.description = attributes[:'description']
|
181
|
+
end
|
182
|
+
|
183
|
+
if attributes.key?(:'name')
|
184
|
+
self.name = attributes[:'name']
|
185
|
+
end
|
186
|
+
|
187
|
+
if attributes.key?(:'company')
|
188
|
+
self.company = attributes[:'company']
|
189
|
+
end
|
190
|
+
|
191
|
+
if attributes.key?(:'phone')
|
192
|
+
self.phone = attributes[:'phone']
|
193
|
+
end
|
194
|
+
|
195
|
+
if attributes.key?(:'email')
|
196
|
+
self.email = attributes[:'email']
|
197
|
+
end
|
198
|
+
|
199
|
+
if attributes.key?(:'metadata')
|
200
|
+
if (value = attributes[:'metadata']).is_a?(Hash)
|
201
|
+
self.metadata = value
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
if attributes.key?(:'address_line1')
|
206
|
+
self.address_line1 = attributes[:'address_line1']
|
207
|
+
end
|
208
|
+
|
209
|
+
if attributes.key?(:'address_line2')
|
210
|
+
self.address_line2 = attributes[:'address_line2']
|
211
|
+
end
|
212
|
+
|
213
|
+
if attributes.key?(:'address_city')
|
214
|
+
self.address_city = attributes[:'address_city']
|
215
|
+
end
|
216
|
+
|
217
|
+
if attributes.key?(:'address_state')
|
218
|
+
self.address_state = attributes[:'address_state']
|
219
|
+
end
|
220
|
+
|
221
|
+
if attributes.key?(:'address_zip')
|
222
|
+
self.address_zip = attributes[:'address_zip']
|
223
|
+
end
|
224
|
+
|
225
|
+
if attributes.key?(:'address_country')
|
226
|
+
self.address_country = attributes[:'address_country']
|
227
|
+
end
|
228
|
+
|
229
|
+
if attributes.key?(:'object')
|
230
|
+
self.object = attributes[:'object']
|
231
|
+
else
|
232
|
+
self.object = 'address'
|
233
|
+
end
|
234
|
+
|
235
|
+
if attributes.key?(:'date_created')
|
236
|
+
self.date_created = attributes[:'date_created']
|
237
|
+
end
|
238
|
+
|
239
|
+
if attributes.key?(:'date_modified')
|
240
|
+
self.date_modified = attributes[:'date_modified']
|
241
|
+
end
|
242
|
+
|
243
|
+
if attributes.key?(:'deleted')
|
244
|
+
self.deleted = attributes[:'deleted']
|
245
|
+
end
|
246
|
+
|
247
|
+
if attributes.key?(:'inline')
|
248
|
+
self.inline = attributes[:'inline']
|
249
|
+
end
|
250
|
+
|
251
|
+
if attributes.key?(:'recipient_moved')
|
252
|
+
self.recipient_moved = attributes[:'recipient_moved']
|
253
|
+
end
|
254
|
+
end
|
255
|
+
|
256
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
257
|
+
# @return Array for valid properties with the reasons
|
258
|
+
def list_invalid_properties
|
259
|
+
invalid_properties = Array.new
|
260
|
+
pattern = Regexp.new(/^adr_[a-zA-Z0-9]+$/)
|
261
|
+
if !@id.nil? && @id !~ pattern
|
262
|
+
invalid_properties.push("invalid value for \"id\", must conform to the pattern #{pattern}.")
|
263
|
+
end
|
264
|
+
|
265
|
+
if !@description.nil? && @description.to_s.length > 255
|
266
|
+
invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 255.')
|
267
|
+
end
|
268
|
+
|
269
|
+
if !@name.nil? && @name.to_s.length > 40
|
270
|
+
invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 40.')
|
271
|
+
end
|
272
|
+
|
273
|
+
if !@company.nil? && @company.to_s.length > 40
|
274
|
+
invalid_properties.push('invalid value for "company", the character length must be smaller than or equal to 40.')
|
275
|
+
end
|
276
|
+
|
277
|
+
if !@phone.nil? && @phone.to_s.length > 40
|
278
|
+
invalid_properties.push('invalid value for "phone", the character length must be smaller than or equal to 40.')
|
279
|
+
end
|
280
|
+
|
281
|
+
if !@email.nil? && @email.to_s.length > 100
|
282
|
+
invalid_properties.push('invalid value for "email", the character length must be smaller than or equal to 100.')
|
283
|
+
end
|
284
|
+
|
285
|
+
if !@address_line1.nil? && @address_line1.to_s.length > 64
|
286
|
+
invalid_properties.push('invalid value for "address_line1", the character length must be smaller than or equal to 64.')
|
287
|
+
end
|
288
|
+
|
289
|
+
if !@address_line2.nil? && @address_line2.to_s.length > 64
|
290
|
+
invalid_properties.push('invalid value for "address_line2", the character length must be smaller than or equal to 64.')
|
291
|
+
end
|
292
|
+
|
293
|
+
if !@address_city.nil? && @address_city.to_s.length > 200
|
294
|
+
invalid_properties.push('invalid value for "address_city", the character length must be smaller than or equal to 200.')
|
295
|
+
end
|
296
|
+
|
297
|
+
pattern = Regexp.new(/^[a-zA-Z]{2}$/)
|
298
|
+
if !@address_state.nil? && @address_state !~ pattern
|
299
|
+
invalid_properties.push("invalid value for \"address_state\", must conform to the pattern #{pattern}.")
|
300
|
+
end
|
301
|
+
|
302
|
+
if !@address_zip.nil? && @address_zip.to_s.length > 12
|
303
|
+
invalid_properties.push('invalid value for "address_zip", the character length must be smaller than or equal to 12.')
|
304
|
+
end
|
305
|
+
|
306
|
+
invalid_properties
|
307
|
+
end
|
308
|
+
|
309
|
+
# Check to see if the all the properties in the model are valid
|
310
|
+
# @return true if the model is valid
|
311
|
+
def valid?
|
312
|
+
return false if !@id.nil? && @id !~ Regexp.new(/^adr_[a-zA-Z0-9]+$/)
|
313
|
+
return false if !@description.nil? && @description.to_s.length > 255
|
314
|
+
return false if !@name.nil? && @name.to_s.length > 40
|
315
|
+
return false if !@company.nil? && @company.to_s.length > 40
|
316
|
+
return false if !@phone.nil? && @phone.to_s.length > 40
|
317
|
+
return false if !@email.nil? && @email.to_s.length > 100
|
318
|
+
return false if !@address_line1.nil? && @address_line1.to_s.length > 64
|
319
|
+
return false if !@address_line2.nil? && @address_line2.to_s.length > 64
|
320
|
+
return false if !@address_city.nil? && @address_city.to_s.length > 200
|
321
|
+
return false if !@address_state.nil? && @address_state !~ Regexp.new(/^[a-zA-Z]{2}$/)
|
322
|
+
return false if !@address_zip.nil? && @address_zip.to_s.length > 12
|
323
|
+
object_validator = EnumAttributeValidator.new('String', ["address"])
|
324
|
+
return false unless object_validator.valid?(@object)
|
325
|
+
true
|
326
|
+
end
|
327
|
+
|
328
|
+
# Custom attribute writer method with validation
|
329
|
+
# @param [Object] id Value to be assigned
|
330
|
+
def id=(id)
|
331
|
+
pattern = Regexp.new(/^adr_[a-zA-Z0-9]+$/)
|
332
|
+
if !id.nil? && id !~ pattern
|
333
|
+
fail ArgumentError, "invalid value for \"id\", must conform to the pattern #{pattern}."
|
334
|
+
end
|
335
|
+
|
336
|
+
@id = id
|
337
|
+
end
|
338
|
+
|
339
|
+
# Custom attribute writer method with validation
|
340
|
+
# @param [Object] description Value to be assigned
|
341
|
+
def description=(description)
|
342
|
+
if !description.nil? && description.to_s.length > 255
|
343
|
+
fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 255.'
|
344
|
+
end
|
345
|
+
|
346
|
+
@description = description
|
347
|
+
end
|
348
|
+
|
349
|
+
# Custom attribute writer method with validation
|
350
|
+
# @param [Object] name Value to be assigned
|
351
|
+
def name=(name)
|
352
|
+
if !name.nil? && name.to_s.length > 40
|
353
|
+
fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 40.'
|
354
|
+
end
|
355
|
+
|
356
|
+
@name = name
|
357
|
+
end
|
358
|
+
|
359
|
+
# Custom attribute writer method with validation
|
360
|
+
# @param [Object] company Value to be assigned
|
361
|
+
def company=(company)
|
362
|
+
if !company.nil? && company.to_s.length > 40
|
363
|
+
fail ArgumentError, 'invalid value for "company", the character length must be smaller than or equal to 40.'
|
364
|
+
end
|
365
|
+
|
366
|
+
@company = company
|
367
|
+
end
|
368
|
+
|
369
|
+
# Custom attribute writer method with validation
|
370
|
+
# @param [Object] phone Value to be assigned
|
371
|
+
def phone=(phone)
|
372
|
+
if !phone.nil? && phone.to_s.length > 40
|
373
|
+
fail ArgumentError, 'invalid value for "phone", the character length must be smaller than or equal to 40.'
|
374
|
+
end
|
375
|
+
|
376
|
+
@phone = phone
|
377
|
+
end
|
378
|
+
|
379
|
+
# Custom attribute writer method with validation
|
380
|
+
# @param [Object] email Value to be assigned
|
381
|
+
def email=(email)
|
382
|
+
if !email.nil? && email.to_s.length > 100
|
383
|
+
fail ArgumentError, 'invalid value for "email", the character length must be smaller than or equal to 100.'
|
384
|
+
end
|
385
|
+
|
386
|
+
@email = email
|
387
|
+
end
|
388
|
+
|
389
|
+
# Custom attribute writer method with validation
|
390
|
+
# @param [Object] metadata Value to be assigned
|
391
|
+
def metadata=(metadata)
|
392
|
+
@metadata = metadata
|
393
|
+
end
|
394
|
+
|
395
|
+
# Custom attribute writer method with validation
|
396
|
+
# @param [Object] address_line1 Value to be assigned
|
397
|
+
def address_line1=(address_line1)
|
398
|
+
if !address_line1.nil? && address_line1.to_s.length > 64
|
399
|
+
fail ArgumentError, 'invalid value for "address_line1", the character length must be smaller than or equal to 64.'
|
400
|
+
end
|
401
|
+
|
402
|
+
@address_line1 = address_line1
|
403
|
+
end
|
404
|
+
|
405
|
+
# Custom attribute writer method with validation
|
406
|
+
# @param [Object] address_line2 Value to be assigned
|
407
|
+
def address_line2=(address_line2)
|
408
|
+
if !address_line2.nil? && address_line2.to_s.length > 64
|
409
|
+
fail ArgumentError, 'invalid value for "address_line2", the character length must be smaller than or equal to 64.'
|
410
|
+
end
|
411
|
+
|
412
|
+
@address_line2 = address_line2
|
413
|
+
end
|
414
|
+
|
415
|
+
# Custom attribute writer method with validation
|
416
|
+
# @param [Object] address_city Value to be assigned
|
417
|
+
def address_city=(address_city)
|
418
|
+
if !address_city.nil? && address_city.to_s.length > 200
|
419
|
+
fail ArgumentError, 'invalid value for "address_city", the character length must be smaller than or equal to 200.'
|
420
|
+
end
|
421
|
+
|
422
|
+
@address_city = address_city
|
423
|
+
end
|
424
|
+
|
425
|
+
# Custom attribute writer method with validation
|
426
|
+
# @param [Object] address_state Value to be assigned
|
427
|
+
def address_state=(address_state)
|
428
|
+
pattern = Regexp.new(/^[a-zA-Z]{2}$/)
|
429
|
+
if !address_state.nil? && address_state !~ pattern
|
430
|
+
fail ArgumentError, "invalid value for \"address_state\", must conform to the pattern #{pattern}."
|
431
|
+
end
|
432
|
+
|
433
|
+
@address_state = address_state
|
434
|
+
end
|
435
|
+
|
436
|
+
# Custom attribute writer method with validation
|
437
|
+
# @param [Object] address_zip Value to be assigned
|
438
|
+
def address_zip=(address_zip)
|
439
|
+
if !address_zip.nil? && address_zip.to_s.length > 12
|
440
|
+
fail ArgumentError, 'invalid value for "address_zip", the character length must be smaller than or equal to 12.'
|
441
|
+
end
|
442
|
+
|
443
|
+
@address_zip = address_zip
|
444
|
+
end
|
445
|
+
|
446
|
+
# Custom attribute writer method checking allowed values (enum).
|
447
|
+
# @param [Object] object Object to be assigned
|
448
|
+
def object=(object)
|
449
|
+
validator = EnumAttributeValidator.new('String', ["address"])
|
450
|
+
unless validator.valid?(object)
|
451
|
+
fail ArgumentError, "invalid value for \"object\", must be one of #{validator.allowable_values}."
|
452
|
+
end
|
453
|
+
@object = object
|
454
|
+
end
|
455
|
+
|
456
|
+
# Checks equality by comparing each attribute.
|
457
|
+
# @param [Object] Object to be compared
|
458
|
+
def ==(o)
|
459
|
+
return true if self.equal?(o)
|
460
|
+
self.class == o.class &&
|
461
|
+
id == o.id &&
|
462
|
+
description == o.description &&
|
463
|
+
name == o.name &&
|
464
|
+
company == o.company &&
|
465
|
+
phone == o.phone &&
|
466
|
+
email == o.email &&
|
467
|
+
metadata == o.metadata &&
|
468
|
+
address_line1 == o.address_line1 &&
|
469
|
+
address_line2 == o.address_line2 &&
|
470
|
+
address_city == o.address_city &&
|
471
|
+
address_state == o.address_state &&
|
472
|
+
address_zip == o.address_zip &&
|
473
|
+
address_country == o.address_country &&
|
474
|
+
object == o.object &&
|
475
|
+
date_created == o.date_created &&
|
476
|
+
date_modified == o.date_modified &&
|
477
|
+
deleted == o.deleted &&
|
478
|
+
inline == o.inline &&
|
479
|
+
recipient_moved == o.recipient_moved
|
480
|
+
end
|
481
|
+
|
482
|
+
# @see the `==` method
|
483
|
+
# @param [Object] Object to be compared
|
484
|
+
def eql?(o)
|
485
|
+
self == o
|
486
|
+
end
|
487
|
+
|
488
|
+
# Calculates hash code according to all attributes.
|
489
|
+
# @return [Integer] Hash code
|
490
|
+
def hash
|
491
|
+
[id, description, name, company, phone, email, metadata, address_line1, address_line2, address_city, address_state, address_zip, address_country, object, date_created, date_modified, deleted, inline, recipient_moved].hash
|
492
|
+
end
|
493
|
+
|
494
|
+
|
495
|
+
# Builds the object from hash
|
496
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
497
|
+
# @return [Object] Returns the model itself
|
498
|
+
def self.build_from_hash(attributes)
|
499
|
+
new.build_from_hash(attributes)
|
500
|
+
end
|
501
|
+
|
502
|
+
# Builds the object from hash
|
503
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
504
|
+
# @return [Object] Returns the model itself
|
505
|
+
def build_from_hash(attributes)
|
506
|
+
return nil unless attributes.is_a?(Hash)
|
507
|
+
attributes = attributes.transform_keys(&:to_sym)
|
508
|
+
self.class.openapi_types.each_pair do |key, type|
|
509
|
+
if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
|
510
|
+
self.send("#{key}=", nil) # // guardrails-disable-line
|
511
|
+
elsif type =~ /\AArray<(.*)>/i
|
512
|
+
# check to ensure the input is an array given that the attribute
|
513
|
+
# is documented as an array but the input is not
|
514
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
515
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) }) # // guardrails-disable-line
|
516
|
+
end
|
517
|
+
elsif !attributes[self.class.attribute_map[key]].nil? && type.kind_of?(Array)
|
518
|
+
for base_type in type do
|
519
|
+
res = _deserialize(base_type, attributes[self.class.attribute_map[key]])
|
520
|
+
if !res.nil?
|
521
|
+
self.send("#{key}=", res) # // guardrails-disable-line
|
522
|
+
break
|
523
|
+
end
|
524
|
+
end
|
525
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
526
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]])) # // guardrails-disable-line
|
527
|
+
end
|
528
|
+
end
|
529
|
+
|
530
|
+
self
|
531
|
+
end
|
532
|
+
|
533
|
+
# Deserializes the data based on type
|
534
|
+
# @param string type Data type
|
535
|
+
# @param string value Value to be deserialized
|
536
|
+
# @return [Object] Deserialized data
|
537
|
+
def _deserialize(type, value)
|
538
|
+
case type.to_sym
|
539
|
+
when :Time
|
540
|
+
Time.parse(value)
|
541
|
+
when :Date
|
542
|
+
Date.parse(value)
|
543
|
+
when :String
|
544
|
+
value.to_s
|
545
|
+
when :Integer
|
546
|
+
value.to_i
|
547
|
+
when :Float
|
548
|
+
value.to_f
|
549
|
+
when :Boolean
|
550
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
551
|
+
true
|
552
|
+
else
|
553
|
+
false
|
554
|
+
end
|
555
|
+
when :Object
|
556
|
+
# generic object (usually a Hash), return directly
|
557
|
+
value
|
558
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
559
|
+
inner_type = Regexp.last_match[:inner_type]
|
560
|
+
value.map { |v| _deserialize(inner_type, v) }
|
561
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
562
|
+
k_type = Regexp.last_match[:k_type]
|
563
|
+
v_type = Regexp.last_match[:v_type]
|
564
|
+
{}.tap do |hash|
|
565
|
+
value.each do |k, v|
|
566
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
567
|
+
end
|
568
|
+
end
|
569
|
+
else # model
|
570
|
+
# models (e.g. Pet) or oneOf
|
571
|
+
klass = Lob.const_get(type)
|
572
|
+
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
573
|
+
end
|
574
|
+
end
|
575
|
+
|
576
|
+
# Returns the string representation of the object
|
577
|
+
# @return [String] String presentation of the object
|
578
|
+
def to_s
|
579
|
+
to_hash.to_s
|
580
|
+
end
|
581
|
+
|
582
|
+
# to_body is an alias to to_hash (backward compatibility)
|
583
|
+
# @return [Hash] Returns the object in the form of hash
|
584
|
+
def to_body
|
585
|
+
to_hash
|
586
|
+
end
|
587
|
+
|
588
|
+
# Returns the object in the form of hash
|
589
|
+
# @return [Hash] Returns the object in the form of hash
|
590
|
+
def to_hash
|
591
|
+
hash = {}
|
592
|
+
self.class.attribute_map.each_pair do |attr, param|
|
593
|
+
value = self.send(attr) # // guardrails-disable-line
|
594
|
+
if value.nil?
|
595
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
596
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
597
|
+
end
|
598
|
+
|
599
|
+
hash[param] = _to_hash(value)
|
600
|
+
end
|
601
|
+
hash
|
602
|
+
end
|
603
|
+
|
604
|
+
# Outputs non-array value in the form of hash
|
605
|
+
# For object, use to_hash. Otherwise, just return the value
|
606
|
+
# @param [Object] value Any valid value
|
607
|
+
# @return [Hash] Returns the value in the form of hash
|
608
|
+
def _to_hash(value)
|
609
|
+
if value.is_a?(Array)
|
610
|
+
value.compact.map { |v| _to_hash(v) }
|
611
|
+
elsif value.is_a?(Hash)
|
612
|
+
{}.tap do |hash|
|
613
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
614
|
+
end
|
615
|
+
elsif value.respond_to? :to_hash
|
616
|
+
value.to_hash
|
617
|
+
else
|
618
|
+
value
|
619
|
+
end
|
620
|
+
end
|
621
|
+
|
622
|
+
end
|
623
|
+
|
624
|
+
end
|
@@ -1,7 +1,7 @@
|
|
1
1
|
=begin
|
2
2
|
#Lob
|
3
3
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
7
7
|
Contact: lob-openapi@lob.com
|
@@ -13,18 +13,18 @@ OpenAPI Generator version: 5.2.1
|
|
13
13
|
require 'date'
|
14
14
|
require 'time'
|
15
15
|
|
16
|
-
module
|
16
|
+
module Lob
|
17
17
|
class MultipleComponents
|
18
18
|
# The intended recipient, typically a person's or firm's name.
|
19
19
|
attr_accessor :recipient
|
20
20
|
|
21
|
-
# The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
|
21
|
+
# The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
|
22
22
|
attr_accessor :primary_line
|
23
23
|
|
24
|
-
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
24
|
+
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
25
25
|
attr_accessor :secondary_line
|
26
26
|
|
27
|
-
# Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
|
27
|
+
# Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
|
28
28
|
attr_accessor :urbanization
|
29
29
|
|
30
30
|
attr_accessor :city
|
@@ -35,7 +35,7 @@ module OpenapiClient
|
|
35
35
|
# Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`).
|
36
36
|
attr_accessor :zip_code
|
37
37
|
|
38
|
-
# ID that is returned in the response body for the verification
|
38
|
+
# ID that is returned in the response body for the verification
|
39
39
|
attr_accessor :transient_id
|
40
40
|
|
41
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
@@ -82,13 +82,13 @@ module OpenapiClient
|
|
82
82
|
# @param [Hash] attributes Model attributes in the form of hash
|
83
83
|
def initialize(attributes = {})
|
84
84
|
if (!attributes.is_a?(Hash))
|
85
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
85
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::MultipleComponents` initialize method"
|
86
86
|
end
|
87
87
|
|
88
88
|
# check to see if the attribute exists and convert string to symbol for hash key
|
89
89
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
90
90
|
if (!self.class.attribute_map.key?(k.to_sym))
|
91
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
91
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::MultipleComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
92
92
|
end
|
93
93
|
h[k.to_sym] = v
|
94
94
|
}
|
@@ -359,7 +359,7 @@ module OpenapiClient
|
|
359
359
|
end
|
360
360
|
else # model
|
361
361
|
# models (e.g. Pet) or oneOf
|
362
|
-
klass =
|
362
|
+
klass = Lob.const_get(type)
|
363
363
|
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
364
364
|
end
|
365
365
|
end
|