lob 6.0.4 → 6.0.6
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/CODE_SNIPPETS.md +38 -38
- data/Gemfile.lock +20 -20
- data/MIGRATION.md +3 -3
- data/README.md +3 -3
- data/__tests__/Integration/UsVerification.spec.rb +4 -4
- data/docs/DeliverabilityAnalysis.md +21 -9
- data/docs/MultipleComponents.md +5 -3
- data/docs/UsComponents.md +28 -26
- data/docs/UsVerification.md +7 -3
- data/docs/UsVerificationOrError.md +4 -2
- data/docs/UsVerifications.md +2 -2
- data/docs/UsVerificationsWritable.md +6 -4
- data/lib/openapi_client/models/deliverability_analysis.rb +151 -1
- data/lib/openapi_client/models/dpv_footnote.rb +6 -2
- data/lib/openapi_client/models/multiple_components.rb +18 -8
- data/lib/openapi_client/models/us_components.rb +28 -1
- data/lib/openapi_client/models/us_verification.rb +18 -8
- data/lib/openapi_client/models/us_verification_or_error.rb +15 -5
- data/lib/openapi_client/models/us_verifications.rb +4 -4
- data/lib/openapi_client/models/us_verifications_writable.rb +19 -9
- data/lib/openapi_client/version.rb +2 -2
- metadata +17 -17
@@ -28,6 +28,24 @@ module Lob
|
|
28
28
|
# Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
|
29
29
|
attr_accessor :dpv_active
|
30
30
|
|
31
|
+
# Indicates the reason why an address is vacant or no longer receiving deliveries. Possible values are: * `01` –– Address does not receive mail from the USPS directly, but is serviced by a drop address. * `02` –– Address not yet deliverable. * `03` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). * `04` –– Address is a College, Military Zone, or other type. * `05` –– Address no longer receives deliveries. * `06` –– Address is missing required secondary information. * `''` –– A DPV match is not made or the address is active.
|
32
|
+
attr_accessor :dpv_inactive_reason
|
33
|
+
|
34
|
+
# Indicates a street address for which mail is delivered to a PO Box. Possible values are: * `Y` –– Address is a PO Box throwback delivery point. * `N` –– Address is not a PO Box throwback delivery point. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
|
35
|
+
attr_accessor :dpv_throwback
|
36
|
+
|
37
|
+
# Indicates whether deliveries are not performed on one or more days of the week at an address. Possible values are: * `Y` –– Mail delivery does not occur on some days of the week. * `N` –– Mail delivery occurs every day of the week. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
|
38
|
+
attr_accessor :dpv_non_delivery_day_flag
|
39
|
+
|
40
|
+
# Indicates days of the week (starting on Sunday) deliveries are not performed at an address. For example: * `YNNNNNN` –– Mail delivery does not occur on Sunday's. * `NYNNNYN` –– Mail delivery does not occur on Monday's or Friday's. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string) or address receives mail every day of the week (`deliverability_analysis[dpv_non_delivery_day_flag]` is `N` or an empty string).
|
41
|
+
attr_accessor :dpv_non_delivery_day_values
|
42
|
+
|
43
|
+
# Indicates packages to this address will not be left due to security concerns. Possible values are: * `Y` –– Address does not have a secure mailbox. * `N` –– Address has a secure mailbox. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
|
44
|
+
attr_accessor :dpv_no_secure_location
|
45
|
+
|
46
|
+
# Indicates the door of the address is not accessible for mail delivery. Possible values are: * `Y` –– Door is not accessible. * `N` –– Door is accessible. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
|
47
|
+
attr_accessor :dpv_door_not_accessible
|
48
|
+
|
31
49
|
# An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types).
|
32
50
|
attr_accessor :dpv_footnotes
|
33
51
|
|
@@ -72,6 +90,12 @@ module Lob
|
|
72
90
|
:'dpv_cmra' => :'dpv_cmra',
|
73
91
|
:'dpv_vacant' => :'dpv_vacant',
|
74
92
|
:'dpv_active' => :'dpv_active',
|
93
|
+
:'dpv_inactive_reason' => :'dpv_inactive_reason',
|
94
|
+
:'dpv_throwback' => :'dpv_throwback',
|
95
|
+
:'dpv_non_delivery_day_flag' => :'dpv_non_delivery_day_flag',
|
96
|
+
:'dpv_non_delivery_day_values' => :'dpv_non_delivery_day_values',
|
97
|
+
:'dpv_no_secure_location' => :'dpv_no_secure_location',
|
98
|
+
:'dpv_door_not_accessible' => :'dpv_door_not_accessible',
|
75
99
|
:'dpv_footnotes' => :'dpv_footnotes',
|
76
100
|
:'ews_match' => :'ews_match',
|
77
101
|
:'lacs_indicator' => :'lacs_indicator',
|
@@ -92,6 +116,12 @@ module Lob
|
|
92
116
|
:'dpv_cmra' => :'String',
|
93
117
|
:'dpv_vacant' => :'String',
|
94
118
|
:'dpv_active' => :'String',
|
119
|
+
:'dpv_inactive_reason' => :'String',
|
120
|
+
:'dpv_throwback' => :'String',
|
121
|
+
:'dpv_non_delivery_day_flag' => :'String',
|
122
|
+
:'dpv_non_delivery_day_values' => :'String',
|
123
|
+
:'dpv_no_secure_location' => :'String',
|
124
|
+
:'dpv_door_not_accessible' => :'String',
|
95
125
|
:'dpv_footnotes' => :'Array<DpvFootnote>',
|
96
126
|
:'ews_match' => :'Boolean',
|
97
127
|
:'lacs_indicator' => :'String',
|
@@ -137,6 +167,30 @@ module Lob
|
|
137
167
|
self.dpv_active = attributes[:'dpv_active']
|
138
168
|
end
|
139
169
|
|
170
|
+
if attributes.key?(:'dpv_inactive_reason')
|
171
|
+
self.dpv_inactive_reason = attributes[:'dpv_inactive_reason']
|
172
|
+
end
|
173
|
+
|
174
|
+
if attributes.key?(:'dpv_throwback')
|
175
|
+
self.dpv_throwback = attributes[:'dpv_throwback']
|
176
|
+
end
|
177
|
+
|
178
|
+
if attributes.key?(:'dpv_non_delivery_day_flag')
|
179
|
+
self.dpv_non_delivery_day_flag = attributes[:'dpv_non_delivery_day_flag']
|
180
|
+
end
|
181
|
+
|
182
|
+
if attributes.key?(:'dpv_non_delivery_day_values')
|
183
|
+
self.dpv_non_delivery_day_values = attributes[:'dpv_non_delivery_day_values']
|
184
|
+
end
|
185
|
+
|
186
|
+
if attributes.key?(:'dpv_no_secure_location')
|
187
|
+
self.dpv_no_secure_location = attributes[:'dpv_no_secure_location']
|
188
|
+
end
|
189
|
+
|
190
|
+
if attributes.key?(:'dpv_door_not_accessible')
|
191
|
+
self.dpv_door_not_accessible = attributes[:'dpv_door_not_accessible']
|
192
|
+
end
|
193
|
+
|
140
194
|
if attributes.key?(:'dpv_footnotes')
|
141
195
|
if (value = attributes[:'dpv_footnotes']).is_a?(Array)
|
142
196
|
self.dpv_footnotes = value
|
@@ -180,6 +234,30 @@ module Lob
|
|
180
234
|
invalid_properties.push('invalid value for "dpv_active", dpv_active cannot be nil.')
|
181
235
|
end
|
182
236
|
|
237
|
+
if @dpv_inactive_reason.nil?
|
238
|
+
invalid_properties.push('invalid value for "dpv_inactive_reason", dpv_inactive_reason cannot be nil.')
|
239
|
+
end
|
240
|
+
|
241
|
+
if @dpv_throwback.nil?
|
242
|
+
invalid_properties.push('invalid value for "dpv_throwback", dpv_throwback cannot be nil.')
|
243
|
+
end
|
244
|
+
|
245
|
+
if @dpv_non_delivery_day_flag.nil?
|
246
|
+
invalid_properties.push('invalid value for "dpv_non_delivery_day_flag", dpv_non_delivery_day_flag cannot be nil.')
|
247
|
+
end
|
248
|
+
|
249
|
+
if @dpv_non_delivery_day_values.nil?
|
250
|
+
invalid_properties.push('invalid value for "dpv_non_delivery_day_values", dpv_non_delivery_day_values cannot be nil.')
|
251
|
+
end
|
252
|
+
|
253
|
+
if @dpv_no_secure_location.nil?
|
254
|
+
invalid_properties.push('invalid value for "dpv_no_secure_location", dpv_no_secure_location cannot be nil.')
|
255
|
+
end
|
256
|
+
|
257
|
+
if @dpv_door_not_accessible.nil?
|
258
|
+
invalid_properties.push('invalid value for "dpv_door_not_accessible", dpv_door_not_accessible cannot be nil.')
|
259
|
+
end
|
260
|
+
|
183
261
|
if @dpv_footnotes.nil?
|
184
262
|
invalid_properties.push('invalid value for "dpv_footnotes", dpv_footnotes cannot be nil.')
|
185
263
|
end
|
@@ -218,6 +296,22 @@ module Lob
|
|
218
296
|
return false if @dpv_active.nil?
|
219
297
|
dpv_active_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
220
298
|
return false unless dpv_active_validator.valid?(@dpv_active)
|
299
|
+
return false if @dpv_inactive_reason.nil?
|
300
|
+
dpv_inactive_reason_validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", ""])
|
301
|
+
return false unless dpv_inactive_reason_validator.valid?(@dpv_inactive_reason)
|
302
|
+
return false if @dpv_throwback.nil?
|
303
|
+
dpv_throwback_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
304
|
+
return false unless dpv_throwback_validator.valid?(@dpv_throwback)
|
305
|
+
return false if @dpv_non_delivery_day_flag.nil?
|
306
|
+
dpv_non_delivery_day_flag_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
307
|
+
return false unless dpv_non_delivery_day_flag_validator.valid?(@dpv_non_delivery_day_flag)
|
308
|
+
return false if @dpv_non_delivery_day_values.nil?
|
309
|
+
return false if @dpv_no_secure_location.nil?
|
310
|
+
dpv_no_secure_location_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
311
|
+
return false unless dpv_no_secure_location_validator.valid?(@dpv_no_secure_location)
|
312
|
+
return false if @dpv_door_not_accessible.nil?
|
313
|
+
dpv_door_not_accessible_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
314
|
+
return false unless dpv_door_not_accessible_validator.valid?(@dpv_door_not_accessible)
|
221
315
|
return false if @dpv_footnotes.nil?
|
222
316
|
return false if @ews_match.nil?
|
223
317
|
return false if @lacs_indicator.nil?
|
@@ -270,6 +364,56 @@ module Lob
|
|
270
364
|
@dpv_active = dpv_active
|
271
365
|
end
|
272
366
|
|
367
|
+
# Custom attribute writer method checking allowed values (enum).
|
368
|
+
# @param [Object] dpv_inactive_reason Object to be assigned
|
369
|
+
def dpv_inactive_reason=(dpv_inactive_reason)
|
370
|
+
validator = EnumAttributeValidator.new('String', ["01", "02", "03", "04", "05", "06", ""])
|
371
|
+
unless validator.valid?(dpv_inactive_reason)
|
372
|
+
fail ArgumentError, "invalid value for \"dpv_inactive_reason\", must be one of #{validator.allowable_values}."
|
373
|
+
end
|
374
|
+
@dpv_inactive_reason = dpv_inactive_reason
|
375
|
+
end
|
376
|
+
|
377
|
+
# Custom attribute writer method checking allowed values (enum).
|
378
|
+
# @param [Object] dpv_throwback Object to be assigned
|
379
|
+
def dpv_throwback=(dpv_throwback)
|
380
|
+
validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
381
|
+
unless validator.valid?(dpv_throwback)
|
382
|
+
fail ArgumentError, "invalid value for \"dpv_throwback\", must be one of #{validator.allowable_values}."
|
383
|
+
end
|
384
|
+
@dpv_throwback = dpv_throwback
|
385
|
+
end
|
386
|
+
|
387
|
+
# Custom attribute writer method checking allowed values (enum).
|
388
|
+
# @param [Object] dpv_non_delivery_day_flag Object to be assigned
|
389
|
+
def dpv_non_delivery_day_flag=(dpv_non_delivery_day_flag)
|
390
|
+
validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
391
|
+
unless validator.valid?(dpv_non_delivery_day_flag)
|
392
|
+
fail ArgumentError, "invalid value for \"dpv_non_delivery_day_flag\", must be one of #{validator.allowable_values}."
|
393
|
+
end
|
394
|
+
@dpv_non_delivery_day_flag = dpv_non_delivery_day_flag
|
395
|
+
end
|
396
|
+
|
397
|
+
# Custom attribute writer method checking allowed values (enum).
|
398
|
+
# @param [Object] dpv_no_secure_location Object to be assigned
|
399
|
+
def dpv_no_secure_location=(dpv_no_secure_location)
|
400
|
+
validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
401
|
+
unless validator.valid?(dpv_no_secure_location)
|
402
|
+
fail ArgumentError, "invalid value for \"dpv_no_secure_location\", must be one of #{validator.allowable_values}."
|
403
|
+
end
|
404
|
+
@dpv_no_secure_location = dpv_no_secure_location
|
405
|
+
end
|
406
|
+
|
407
|
+
# Custom attribute writer method checking allowed values (enum).
|
408
|
+
# @param [Object] dpv_door_not_accessible Object to be assigned
|
409
|
+
def dpv_door_not_accessible=(dpv_door_not_accessible)
|
410
|
+
validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
411
|
+
unless validator.valid?(dpv_door_not_accessible)
|
412
|
+
fail ArgumentError, "invalid value for \"dpv_door_not_accessible\", must be one of #{validator.allowable_values}."
|
413
|
+
end
|
414
|
+
@dpv_door_not_accessible = dpv_door_not_accessible
|
415
|
+
end
|
416
|
+
|
273
417
|
# Custom attribute writer method checking allowed values (enum).
|
274
418
|
# @param [Object] lacs_indicator Object to be assigned
|
275
419
|
def lacs_indicator=(lacs_indicator)
|
@@ -299,6 +443,12 @@ module Lob
|
|
299
443
|
dpv_cmra == o.dpv_cmra &&
|
300
444
|
dpv_vacant == o.dpv_vacant &&
|
301
445
|
dpv_active == o.dpv_active &&
|
446
|
+
dpv_inactive_reason == o.dpv_inactive_reason &&
|
447
|
+
dpv_throwback == o.dpv_throwback &&
|
448
|
+
dpv_non_delivery_day_flag == o.dpv_non_delivery_day_flag &&
|
449
|
+
dpv_non_delivery_day_values == o.dpv_non_delivery_day_values &&
|
450
|
+
dpv_no_secure_location == o.dpv_no_secure_location &&
|
451
|
+
dpv_door_not_accessible == o.dpv_door_not_accessible &&
|
302
452
|
dpv_footnotes == o.dpv_footnotes &&
|
303
453
|
ews_match == o.ews_match &&
|
304
454
|
lacs_indicator == o.lacs_indicator &&
|
@@ -315,7 +465,7 @@ module Lob
|
|
315
465
|
# Calculates hash code according to all attributes.
|
316
466
|
# @return [Integer] Hash code
|
317
467
|
def hash
|
318
|
-
[dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code].hash
|
468
|
+
[dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_inactive_reason, dpv_throwback, dpv_non_delivery_day_flag, dpv_non_delivery_day_values, dpv_no_secure_location, dpv_door_not_accessible, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code].hash
|
319
469
|
end
|
320
470
|
|
321
471
|
|
@@ -19,17 +19,21 @@ module Lob
|
|
19
19
|
A1 = "A1".freeze
|
20
20
|
BB = "BB".freeze
|
21
21
|
CC = "CC".freeze
|
22
|
-
|
22
|
+
C1 = "C1".freeze
|
23
23
|
F1 = "F1".freeze
|
24
24
|
G1 = "G1".freeze
|
25
|
-
|
25
|
+
IA = "IA".freeze
|
26
26
|
M1 = "M1".freeze
|
27
27
|
M3 = "M3".freeze
|
28
|
+
N1 = "N1".freeze
|
29
|
+
PB = "PB".freeze
|
28
30
|
P1 = "P1".freeze
|
29
31
|
P3 = "P3".freeze
|
30
32
|
R1 = "R1".freeze
|
31
33
|
R7 = "R7".freeze
|
32
34
|
RR = "RR".freeze
|
35
|
+
TA = "TA".freeze
|
36
|
+
U1 = "U1".freeze
|
33
37
|
|
34
38
|
# Builds the enum from string
|
35
39
|
# @param [String] The enum value in the form of the string
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
|
|
13
13
|
require 'date'
|
14
14
|
require 'time'
|
15
15
|
|
16
|
-
module
|
16
|
+
module OpenapiClient
|
17
17
|
class MultipleComponents
|
18
18
|
# The intended recipient, typically a person's or firm's name.
|
19
19
|
attr_accessor :recipient
|
@@ -35,6 +35,9 @@ module Lob
|
|
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
|
39
|
+
attr_accessor :transient_id
|
40
|
+
|
38
41
|
# Attribute mapping from ruby-style variable name to JSON key.
|
39
42
|
def self.attribute_map
|
40
43
|
{
|
@@ -44,7 +47,8 @@ module Lob
|
|
44
47
|
:'urbanization' => :'urbanization',
|
45
48
|
:'city' => :'city',
|
46
49
|
:'state' => :'state',
|
47
|
-
:'zip_code' => :'zip_code'
|
50
|
+
:'zip_code' => :'zip_code',
|
51
|
+
:'transient_id' => :'transient_id'
|
48
52
|
}
|
49
53
|
end
|
50
54
|
|
@@ -62,7 +66,8 @@ module Lob
|
|
62
66
|
:'urbanization' => :'String',
|
63
67
|
:'city' => :'String',
|
64
68
|
:'state' => :'String',
|
65
|
-
:'zip_code' => :'String'
|
69
|
+
:'zip_code' => :'String',
|
70
|
+
:'transient_id' => :'String'
|
66
71
|
}
|
67
72
|
end
|
68
73
|
|
@@ -77,13 +82,13 @@ module Lob
|
|
77
82
|
# @param [Hash] attributes Model attributes in the form of hash
|
78
83
|
def initialize(attributes = {})
|
79
84
|
if (!attributes.is_a?(Hash))
|
80
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
85
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::MultipleComponents` initialize method"
|
81
86
|
end
|
82
87
|
|
83
88
|
# check to see if the attribute exists and convert string to symbol for hash key
|
84
89
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
85
90
|
if (!self.class.attribute_map.key?(k.to_sym))
|
86
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
91
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::MultipleComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
87
92
|
end
|
88
93
|
h[k.to_sym] = v
|
89
94
|
}
|
@@ -115,6 +120,10 @@ module Lob
|
|
115
120
|
if attributes.key?(:'zip_code')
|
116
121
|
self.zip_code = attributes[:'zip_code']
|
117
122
|
end
|
123
|
+
|
124
|
+
if attributes.key?(:'transient_id')
|
125
|
+
self.transient_id = attributes[:'transient_id']
|
126
|
+
end
|
118
127
|
end
|
119
128
|
|
120
129
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -257,7 +266,8 @@ module Lob
|
|
257
266
|
urbanization == o.urbanization &&
|
258
267
|
city == o.city &&
|
259
268
|
state == o.state &&
|
260
|
-
zip_code == o.zip_code
|
269
|
+
zip_code == o.zip_code &&
|
270
|
+
transient_id == o.transient_id
|
261
271
|
end
|
262
272
|
|
263
273
|
# @see the `==` method
|
@@ -269,7 +279,7 @@ module Lob
|
|
269
279
|
# Calculates hash code according to all attributes.
|
270
280
|
# @return [Integer] Hash code
|
271
281
|
def hash
|
272
|
-
[recipient, primary_line, secondary_line, urbanization, city, state, zip_code].hash
|
282
|
+
[recipient, primary_line, secondary_line, urbanization, city, state, zip_code, transient_id].hash
|
273
283
|
end
|
274
284
|
|
275
285
|
|
@@ -349,7 +359,7 @@ module Lob
|
|
349
359
|
end
|
350
360
|
else # model
|
351
361
|
# models (e.g. Pet) or oneOf
|
352
|
-
klass =
|
362
|
+
klass = OpenapiClient.const_get(type)
|
353
363
|
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
354
364
|
end
|
355
365
|
end
|
@@ -85,6 +85,9 @@ module Lob
|
|
85
85
|
# The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types).
|
86
86
|
attr_accessor :carrier_route_type
|
87
87
|
|
88
|
+
# Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available.
|
89
|
+
attr_accessor :po_box_only_flag
|
90
|
+
|
88
91
|
# A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
|
89
92
|
attr_accessor :latitude
|
90
93
|
|
@@ -140,6 +143,7 @@ module Lob
|
|
140
143
|
:'county_fips' => :'county_fips',
|
141
144
|
:'carrier_route' => :'carrier_route',
|
142
145
|
:'carrier_route_type' => :'carrier_route_type',
|
146
|
+
:'po_box_only_flag' => :'po_box_only_flag',
|
143
147
|
:'latitude' => :'latitude',
|
144
148
|
:'longitude' => :'longitude'
|
145
149
|
}
|
@@ -177,6 +181,7 @@ module Lob
|
|
177
181
|
:'county_fips' => :'String',
|
178
182
|
:'carrier_route' => :'String',
|
179
183
|
:'carrier_route_type' => :'String',
|
184
|
+
:'po_box_only_flag' => :'String',
|
180
185
|
:'latitude' => :'Float',
|
181
186
|
:'longitude' => :'Float'
|
182
187
|
}
|
@@ -301,6 +306,10 @@ module Lob
|
|
301
306
|
self.carrier_route_type = attributes[:'carrier_route_type']
|
302
307
|
end
|
303
308
|
|
309
|
+
if attributes.key?(:'po_box_only_flag')
|
310
|
+
self.po_box_only_flag = attributes[:'po_box_only_flag']
|
311
|
+
end
|
312
|
+
|
304
313
|
if attributes.key?(:'latitude')
|
305
314
|
self.latitude = attributes[:'latitude']
|
306
315
|
end
|
@@ -428,6 +437,10 @@ module Lob
|
|
428
437
|
invalid_properties.push('invalid value for "carrier_route_type", carrier_route_type cannot be nil.')
|
429
438
|
end
|
430
439
|
|
440
|
+
if @po_box_only_flag.nil?
|
441
|
+
invalid_properties.push('invalid value for "po_box_only_flag", po_box_only_flag cannot be nil.')
|
442
|
+
end
|
443
|
+
|
431
444
|
invalid_properties
|
432
445
|
end
|
433
446
|
|
@@ -472,6 +485,9 @@ module Lob
|
|
472
485
|
return false if @carrier_route_type.nil?
|
473
486
|
carrier_route_type_validator = EnumAttributeValidator.new('String', ["city_delivery", "rural_route", "highway_contract", "po_box", "general_delivery", ""])
|
474
487
|
return false unless carrier_route_type_validator.valid?(@carrier_route_type)
|
488
|
+
return false if @po_box_only_flag.nil?
|
489
|
+
po_box_only_flag_validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
490
|
+
return false unless po_box_only_flag_validator.valid?(@po_box_only_flag)
|
475
491
|
true
|
476
492
|
end
|
477
493
|
|
@@ -583,6 +599,16 @@ module Lob
|
|
583
599
|
@carrier_route_type = carrier_route_type
|
584
600
|
end
|
585
601
|
|
602
|
+
# Custom attribute writer method checking allowed values (enum).
|
603
|
+
# @param [Object] po_box_only_flag Object to be assigned
|
604
|
+
def po_box_only_flag=(po_box_only_flag)
|
605
|
+
validator = EnumAttributeValidator.new('String', ["Y", "N", ""])
|
606
|
+
unless validator.valid?(po_box_only_flag)
|
607
|
+
fail ArgumentError, "invalid value for \"po_box_only_flag\", must be one of #{validator.allowable_values}."
|
608
|
+
end
|
609
|
+
@po_box_only_flag = po_box_only_flag
|
610
|
+
end
|
611
|
+
|
586
612
|
# Checks equality by comparing each attribute.
|
587
613
|
# @param [Object] Object to be compared
|
588
614
|
def ==(o)
|
@@ -612,6 +638,7 @@ module Lob
|
|
612
638
|
county_fips == o.county_fips &&
|
613
639
|
carrier_route == o.carrier_route &&
|
614
640
|
carrier_route_type == o.carrier_route_type &&
|
641
|
+
po_box_only_flag == o.po_box_only_flag &&
|
615
642
|
latitude == o.latitude &&
|
616
643
|
longitude == o.longitude
|
617
644
|
end
|
@@ -625,7 +652,7 @@ module Lob
|
|
625
652
|
# Calculates hash code according to all attributes.
|
626
653
|
# @return [Integer] Hash code
|
627
654
|
def hash
|
628
|
-
[primary_number, street_predirection, street_name, street_suffix, street_postdirection, secondary_designator, secondary_number, pmb_designator, pmb_number, extra_secondary_designator, extra_secondary_number, city, state, zip_code, zip_code_plus_4, zip_code_type, delivery_point_barcode, address_type, record_type, default_building_address, county, county_fips, carrier_route, carrier_route_type, latitude, longitude].hash
|
655
|
+
[primary_number, street_predirection, street_name, street_suffix, street_postdirection, secondary_designator, secondary_number, pmb_designator, pmb_number, extra_secondary_designator, extra_secondary_number, city, state, zip_code, zip_code_plus_4, zip_code_type, delivery_point_barcode, address_type, record_type, default_building_address, county, county_fips, carrier_route, carrier_route_type, po_box_only_flag, latitude, longitude].hash
|
629
656
|
end
|
630
657
|
|
631
658
|
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
|
|
13
13
|
require 'date'
|
14
14
|
require 'time'
|
15
15
|
|
16
|
-
module
|
16
|
+
module OpenapiClient
|
17
17
|
class UsVerification
|
18
18
|
# Unique identifier prefixed with `us_ver_`.
|
19
19
|
attr_accessor :id
|
@@ -47,6 +47,9 @@ module Lob
|
|
47
47
|
|
48
48
|
attr_accessor :object
|
49
49
|
|
50
|
+
# ID that is returned in the response body for the verification
|
51
|
+
attr_accessor :transient_id
|
52
|
+
|
50
53
|
class EnumAttributeValidator
|
51
54
|
attr_reader :datatype
|
52
55
|
attr_reader :allowable_values
|
@@ -83,7 +86,8 @@ module Lob
|
|
83
86
|
:'components' => :'components',
|
84
87
|
:'deliverability_analysis' => :'deliverability_analysis',
|
85
88
|
:'lob_confidence_score' => :'lob_confidence_score',
|
86
|
-
:'object' => :'object'
|
89
|
+
:'object' => :'object',
|
90
|
+
:'transient_id' => :'transient_id'
|
87
91
|
}
|
88
92
|
end
|
89
93
|
|
@@ -106,7 +110,8 @@ module Lob
|
|
106
110
|
:'components' => :'UsComponents',
|
107
111
|
:'deliverability_analysis' => :'DeliverabilityAnalysis',
|
108
112
|
:'lob_confidence_score' => :'LobConfidenceScore',
|
109
|
-
:'object' => :'String'
|
113
|
+
:'object' => :'String',
|
114
|
+
:'transient_id' => :'String'
|
110
115
|
}
|
111
116
|
end
|
112
117
|
|
@@ -121,13 +126,13 @@ module Lob
|
|
121
126
|
# @param [Hash] attributes Model attributes in the form of hash
|
122
127
|
def initialize(attributes = {})
|
123
128
|
if (!attributes.is_a?(Hash))
|
124
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
129
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerification` initialize method"
|
125
130
|
end
|
126
131
|
|
127
132
|
# check to see if the attribute exists and convert string to symbol for hash key
|
128
133
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
129
134
|
if (!self.class.attribute_map.key?(k.to_sym))
|
130
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
135
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
131
136
|
end
|
132
137
|
h[k.to_sym] = v
|
133
138
|
}
|
@@ -181,6 +186,10 @@ module Lob
|
|
181
186
|
else
|
182
187
|
self.object = 'us_verification'
|
183
188
|
end
|
189
|
+
|
190
|
+
if attributes.key?(:'transient_id')
|
191
|
+
self.transient_id = attributes[:'transient_id']
|
192
|
+
end
|
184
193
|
end
|
185
194
|
|
186
195
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -313,7 +322,8 @@ module Lob
|
|
313
322
|
components == o.components &&
|
314
323
|
deliverability_analysis == o.deliverability_analysis &&
|
315
324
|
lob_confidence_score == o.lob_confidence_score &&
|
316
|
-
object == o.object
|
325
|
+
object == o.object &&
|
326
|
+
transient_id == o.transient_id
|
317
327
|
end
|
318
328
|
|
319
329
|
# @see the `==` method
|
@@ -325,7 +335,7 @@ module Lob
|
|
325
335
|
# Calculates hash code according to all attributes.
|
326
336
|
# @return [Integer] Hash code
|
327
337
|
def hash
|
328
|
-
[id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, valid_address, components, deliverability_analysis, lob_confidence_score, object].hash
|
338
|
+
[id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, valid_address, components, deliverability_analysis, lob_confidence_score, object, transient_id].hash
|
329
339
|
end
|
330
340
|
|
331
341
|
|
@@ -405,7 +415,7 @@ module Lob
|
|
405
415
|
end
|
406
416
|
else # model
|
407
417
|
# models (e.g. Pet) or oneOf
|
408
|
-
klass =
|
418
|
+
klass = OpenapiClient.const_get(type)
|
409
419
|
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
410
420
|
end
|
411
421
|
end
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
|
|
13
13
|
require 'date'
|
14
14
|
require 'time'
|
15
15
|
|
16
|
-
module
|
16
|
+
module OpenapiClient
|
17
17
|
# A model used to represent an entry in a result list where the entry can either be a us_verification or an Error. The SDK will perform necessary casting into the correct corresponding type.
|
18
18
|
class UsVerificationOrError
|
19
19
|
# Unique identifier prefixed with `us_ver_`.
|
@@ -43,6 +43,9 @@ module Lob
|
|
43
43
|
|
44
44
|
attr_accessor :object
|
45
45
|
|
46
|
+
# ID that is returned in the response body for the verification
|
47
|
+
attr_accessor :transient_id
|
48
|
+
|
46
49
|
attr_accessor :error
|
47
50
|
|
48
51
|
class EnumAttributeValidator
|
@@ -81,6 +84,7 @@ module Lob
|
|
81
84
|
:'deliverability_analysis' => :'deliverability_analysis',
|
82
85
|
:'lob_confidence_score' => :'lob_confidence_score',
|
83
86
|
:'object' => :'object',
|
87
|
+
:'transient_id' => :'transient_id',
|
84
88
|
:'error' => :'error'
|
85
89
|
}
|
86
90
|
end
|
@@ -104,6 +108,7 @@ module Lob
|
|
104
108
|
:'deliverability_analysis' => :'DeliverabilityAnalysis',
|
105
109
|
:'lob_confidence_score' => :'LobConfidenceScore',
|
106
110
|
:'object' => :'String',
|
111
|
+
:'transient_id' => :'String',
|
107
112
|
:'error' => :'BulkError'
|
108
113
|
}
|
109
114
|
end
|
@@ -119,13 +124,13 @@ module Lob
|
|
119
124
|
# @param [Hash] attributes Model attributes in the form of hash
|
120
125
|
def initialize(attributes = {})
|
121
126
|
if (!attributes.is_a?(Hash))
|
122
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
127
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerificationOrError` initialize method"
|
123
128
|
end
|
124
129
|
|
125
130
|
# check to see if the attribute exists and convert string to symbol for hash key
|
126
131
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
127
132
|
if (!self.class.attribute_map.key?(k.to_sym))
|
128
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
133
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerificationOrError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
129
134
|
end
|
130
135
|
h[k.to_sym] = v
|
131
136
|
}
|
@@ -176,6 +181,10 @@ module Lob
|
|
176
181
|
self.object = 'us_verification'
|
177
182
|
end
|
178
183
|
|
184
|
+
if attributes.key?(:'transient_id')
|
185
|
+
self.transient_id = attributes[:'transient_id']
|
186
|
+
end
|
187
|
+
|
179
188
|
if attributes.key?(:'error')
|
180
189
|
self.error = attributes[:'error']
|
181
190
|
end
|
@@ -311,6 +320,7 @@ module Lob
|
|
311
320
|
deliverability_analysis == o.deliverability_analysis &&
|
312
321
|
lob_confidence_score == o.lob_confidence_score &&
|
313
322
|
object == o.object &&
|
323
|
+
transient_id == o.transient_id &&
|
314
324
|
error == o.error
|
315
325
|
end
|
316
326
|
|
@@ -323,7 +333,7 @@ module Lob
|
|
323
333
|
# Calculates hash code according to all attributes.
|
324
334
|
# @return [Integer] Hash code
|
325
335
|
def hash
|
326
|
-
[id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, components, deliverability_analysis, lob_confidence_score, object, error].hash
|
336
|
+
[id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, components, deliverability_analysis, lob_confidence_score, object, transient_id, error].hash
|
327
337
|
end
|
328
338
|
|
329
339
|
|
@@ -403,7 +413,7 @@ module Lob
|
|
403
413
|
end
|
404
414
|
else # model
|
405
415
|
# models (e.g. Pet) or oneOf
|
406
|
-
klass =
|
416
|
+
klass = OpenapiClient.const_get(type)
|
407
417
|
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
408
418
|
end
|
409
419
|
end
|
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
|
|
13
13
|
require 'date'
|
14
14
|
require 'time'
|
15
15
|
|
16
|
-
module
|
16
|
+
module OpenapiClient
|
17
17
|
class UsVerifications
|
18
18
|
attr_accessor :addresses
|
19
19
|
|
@@ -51,13 +51,13 @@ module Lob
|
|
51
51
|
# @param [Hash] attributes Model attributes in the form of hash
|
52
52
|
def initialize(attributes = {})
|
53
53
|
if (!attributes.is_a?(Hash))
|
54
|
-
fail ArgumentError, "The input argument (attributes) must be a hash in `
|
54
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerifications` initialize method"
|
55
55
|
end
|
56
56
|
|
57
57
|
# check to see if the attribute exists and convert string to symbol for hash key
|
58
58
|
attributes = attributes.each_with_object({}) { |(k, v), h|
|
59
59
|
if (!self.class.attribute_map.key?(k.to_sym))
|
60
|
-
fail ArgumentError, "`#{k}` is not a valid attribute in `
|
60
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerifications`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
61
61
|
end
|
62
62
|
h[k.to_sym] = v
|
63
63
|
}
|
@@ -194,7 +194,7 @@ module Lob
|
|
194
194
|
end
|
195
195
|
else # model
|
196
196
|
# models (e.g. Pet) or oneOf
|
197
|
-
klass =
|
197
|
+
klass = OpenapiClient.const_get(type)
|
198
198
|
klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
|
199
199
|
end
|
200
200
|
end
|