lob 6.0.4 → 6.0.5
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 +4 -4
- data/docs/DeliverabilityAnalysis.md +21 -9
- data/docs/UsComponents.md +28 -26
- 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/us_components.rb +28 -1
- data/lib/openapi_client/version.rb +1 -1
- metadata +16 -16
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: fcc5c9d3ad3f6dafba308e7ff70253d1fe30a68bee9b26d5c9c961d2fed7321b
|
|
4
|
+
data.tar.gz: 6d63f4e7a8fc195d886b947578f75134428f603d04fe0e8c8c45fca332c11746
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6244430047041e4de8e8324922c9337a842d4533ba60c4bb52a1b74aa9a53fd20caeb4ceb23343cbe02f36d95374460ca897245e486bffc6bbc12f9acfd2e5ac
|
|
7
|
+
data.tar.gz: 07b92e745d0ffd69dd9ed9ec68c7709f281995d90ff5edf91e386dcd8d3ed1a128e0966a55a275682e8ff364db50c5e81d023b7601e287454b92abaad3e69524
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
lob (6.0.
|
|
4
|
+
lob (6.0.5)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -28,7 +28,7 @@ GEM
|
|
|
28
28
|
pry (>= 0.13, < 0.15)
|
|
29
29
|
psych (5.1.1.1)
|
|
30
30
|
stringio
|
|
31
|
-
racc (1.7.
|
|
31
|
+
racc (1.7.3)
|
|
32
32
|
rainbow (3.1.1)
|
|
33
33
|
rake (13.0.6)
|
|
34
34
|
rspec (3.12.0)
|
|
@@ -53,7 +53,7 @@ GEM
|
|
|
53
53
|
ruby-progressbar (~> 1.7)
|
|
54
54
|
unicode-display_width (>= 1.4.0, < 1.6)
|
|
55
55
|
ruby-progressbar (1.13.0)
|
|
56
|
-
stringio (3.0.
|
|
56
|
+
stringio (3.0.9)
|
|
57
57
|
typhoeus (1.4.0)
|
|
58
58
|
ethon (>= 0.9.0)
|
|
59
59
|
unicode-display_width (1.5.0)
|
|
@@ -69,4 +69,4 @@ DEPENDENCIES
|
|
|
69
69
|
rubocop (~> 0.66.0)
|
|
70
70
|
|
|
71
71
|
BUNDLED WITH
|
|
72
|
-
2.4.
|
|
72
|
+
2.4.22
|
|
@@ -8,6 +8,12 @@
|
|
|
8
8
|
| **dpv_cmra** | **String** | indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | |
|
|
9
9
|
| **dpv_vacant** | **String** | indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | |
|
|
10
10
|
| **dpv_active** | **String** | 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). | |
|
|
11
|
+
| **dpv_inactive_reason** | **String** | 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. | |
|
|
12
|
+
| **dpv_throwback** | **String** | 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). | |
|
|
13
|
+
| **dpv_non_delivery_day_flag** | **String** | 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). | |
|
|
14
|
+
| **dpv_non_delivery_day_values** | **String** | 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). | |
|
|
15
|
+
| **dpv_no_secure_location** | **String** | 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). | |
|
|
16
|
+
| **dpv_door_not_accessible** | **String** | 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). | |
|
|
11
17
|
| **dpv_footnotes** | [**Array<DpvFootnote>**](DpvFootnote.md) | 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). | |
|
|
12
18
|
| **ews_match** | **Boolean** | indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months. | |
|
|
13
19
|
| **lacs_indicator** | **String** | indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | |
|
|
@@ -20,15 +26,21 @@
|
|
|
20
26
|
require 'openapi_client'
|
|
21
27
|
|
|
22
28
|
instance = Lob::DeliverabilityAnalysis.new(
|
|
23
|
-
dpv_confirmation:
|
|
24
|
-
dpv_cmra:
|
|
25
|
-
dpv_vacant:
|
|
26
|
-
dpv_active:
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
29
|
+
dpv_confirmation: nil,
|
|
30
|
+
dpv_cmra: nil,
|
|
31
|
+
dpv_vacant: nil,
|
|
32
|
+
dpv_active: nil,
|
|
33
|
+
dpv_inactive_reason: nil,
|
|
34
|
+
dpv_throwback: nil,
|
|
35
|
+
dpv_non_delivery_day_flag: nil,
|
|
36
|
+
dpv_non_delivery_day_values: nil,
|
|
37
|
+
dpv_no_secure_location: nil,
|
|
38
|
+
dpv_door_not_accessible: nil,
|
|
39
|
+
dpv_footnotes: nil,
|
|
40
|
+
ews_match: nil,
|
|
41
|
+
lacs_indicator: nil,
|
|
42
|
+
lacs_return_code: nil,
|
|
43
|
+
suite_return_code: nil
|
|
32
44
|
)
|
|
33
45
|
```
|
|
34
46
|
|
data/docs/UsComponents.md
CHANGED
|
@@ -28,6 +28,7 @@
|
|
|
28
28
|
| **county_fips** | **String** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. | |
|
|
29
29
|
| **carrier_route** | **String** | A 4-character code assigned to a mail delivery route within a ZIP code. | |
|
|
30
30
|
| **carrier_route_type** | **String** | The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). | |
|
|
31
|
+
| **po_box_only_flag** | **String** | Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available. | |
|
|
31
32
|
| **latitude** | **Float** | 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`). | [optional] |
|
|
32
33
|
| **longitude** | **Float** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). | [optional] |
|
|
33
34
|
|
|
@@ -37,32 +38,33 @@
|
|
|
37
38
|
require 'openapi_client'
|
|
38
39
|
|
|
39
40
|
instance = Lob::UsComponents.new(
|
|
40
|
-
primary_number:
|
|
41
|
-
street_predirection:
|
|
42
|
-
street_name:
|
|
43
|
-
street_suffix:
|
|
44
|
-
street_postdirection:
|
|
45
|
-
secondary_designator:
|
|
46
|
-
secondary_number:
|
|
47
|
-
pmb_designator:
|
|
48
|
-
pmb_number:
|
|
49
|
-
extra_secondary_designator:
|
|
50
|
-
extra_secondary_number:
|
|
51
|
-
city:
|
|
52
|
-
state:
|
|
53
|
-
zip_code:
|
|
54
|
-
zip_code_plus_4:
|
|
55
|
-
zip_code_type:
|
|
56
|
-
delivery_point_barcode:
|
|
57
|
-
address_type:
|
|
58
|
-
record_type:
|
|
59
|
-
default_building_address:
|
|
60
|
-
county:
|
|
61
|
-
county_fips:
|
|
62
|
-
carrier_route:
|
|
63
|
-
carrier_route_type:
|
|
64
|
-
|
|
65
|
-
|
|
41
|
+
primary_number: nil,
|
|
42
|
+
street_predirection: nil,
|
|
43
|
+
street_name: nil,
|
|
44
|
+
street_suffix: nil,
|
|
45
|
+
street_postdirection: nil,
|
|
46
|
+
secondary_designator: nil,
|
|
47
|
+
secondary_number: nil,
|
|
48
|
+
pmb_designator: nil,
|
|
49
|
+
pmb_number: nil,
|
|
50
|
+
extra_secondary_designator: nil,
|
|
51
|
+
extra_secondary_number: nil,
|
|
52
|
+
city: nil,
|
|
53
|
+
state: nil,
|
|
54
|
+
zip_code: nil,
|
|
55
|
+
zip_code_plus_4: nil,
|
|
56
|
+
zip_code_type: nil,
|
|
57
|
+
delivery_point_barcode: nil,
|
|
58
|
+
address_type: nil,
|
|
59
|
+
record_type: nil,
|
|
60
|
+
default_building_address: nil,
|
|
61
|
+
county: nil,
|
|
62
|
+
county_fips: nil,
|
|
63
|
+
carrier_route: nil,
|
|
64
|
+
carrier_route_type: nil,
|
|
65
|
+
po_box_only_flag: nil,
|
|
66
|
+
latitude: nil,
|
|
67
|
+
longitude: nil
|
|
66
68
|
)
|
|
67
69
|
```
|
|
68
70
|
|
|
@@ -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
|
|
@@ -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
|
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: lob
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 6.0.
|
|
4
|
+
version: 6.0.5
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Lob
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2023-
|
|
11
|
+
date: 2023-11-09 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: typhoeus
|
|
@@ -496,28 +496,28 @@ signing_key:
|
|
|
496
496
|
specification_version: 4
|
|
497
497
|
summary: Ruby wrapper for Lob.com API with ActiveRecord-style syntax
|
|
498
498
|
test_files:
|
|
499
|
-
- spec/api/
|
|
499
|
+
- spec/api/template_versions_api_spec.rb
|
|
500
|
+
- spec/api/us_verifications_api_spec.rb
|
|
501
|
+
- spec/api/billing_groups_api_spec.rb
|
|
502
|
+
- spec/api/zip_lookups_api_spec.rb
|
|
500
503
|
- spec/api/bank_accounts_api_spec.rb
|
|
504
|
+
- spec/api/addresses_api_spec.rb
|
|
505
|
+
- spec/api/campaigns_api_spec.rb
|
|
506
|
+
- spec/api/intl_autocompletions_api_spec.rb
|
|
507
|
+
- spec/api/cards_api_spec.rb
|
|
501
508
|
- spec/api/creatives_api_spec.rb
|
|
509
|
+
- spec/api/postcards_api_spec.rb
|
|
510
|
+
- spec/api/templates_api_spec.rb
|
|
511
|
+
- spec/api/card_orders_api_spec.rb
|
|
512
|
+
- spec/api/identity_validation_api_spec.rb
|
|
502
513
|
- spec/api/letters_api_spec.rb
|
|
503
514
|
- spec/api/intl_verifications_api_spec.rb
|
|
504
|
-
- spec/api/
|
|
505
|
-
- spec/api/
|
|
515
|
+
- spec/api/us_autocompletions_api_spec.rb
|
|
516
|
+
- spec/api/checks_api_spec.rb
|
|
506
517
|
- spec/api/self_mailers_api_spec.rb
|
|
507
518
|
- spec/api/reverse_geocode_lookups_api_spec.rb
|
|
508
|
-
- spec/api/card_orders_api_spec.rb
|
|
509
|
-
- spec/api/campaigns_api_spec.rb
|
|
510
|
-
- spec/api/template_versions_api_spec.rb
|
|
511
|
-
- spec/api/us_verifications_api_spec.rb
|
|
512
|
-
- spec/api/templates_api_spec.rb
|
|
513
|
-
- spec/api/intl_autocompletions_api_spec.rb
|
|
514
|
-
- spec/api/addresses_api_spec.rb
|
|
515
519
|
- spec/api/uploads_api_spec.rb
|
|
516
|
-
- spec/api/zip_lookups_api_spec.rb
|
|
517
|
-
- spec/api/cards_api_spec.rb
|
|
518
520
|
- spec/api/default_api_spec.rb
|
|
519
|
-
- spec/api/identity_validation_api_spec.rb
|
|
520
|
-
- spec/api/checks_api_spec.rb
|
|
521
521
|
- spec/api_client_spec.rb
|
|
522
522
|
- spec/configuration_spec.rb
|
|
523
523
|
- spec/spec_helper.rb
|