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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b56d9139a4a3c3fcdf0c7c77574256dbb8525e8a7dabcc4e0172366105088c26
|
|
4
|
+
data.tar.gz: 2fdbc34a8bd71f3ad443822b1d0e3b1286e7983af3c45c499401ace962755ce4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 422b6e8b2d9ca04d231a76d229a7e50ea3a261a878db0fb1ced15fd5dfc839fdb45d0c0f7ac670fc75a4399a5422062115079b74980c82f5ee41d78af565a31d
|
|
7
|
+
data.tar.gz: 1db2d131f9374889c8892ad7c114182fa3ccefec61c92ed17c76a3459b52dfe1da74d66eda834b12921e12b0b94a5a56edb37ea2bb3a48929f68250661328c67
|
data/CODE_SNIPPETS.md
CHANGED
|
@@ -50,11 +50,11 @@ curl https://api.lob.com/v1/addresses \
|
|
|
50
50
|
-d "company=Lob" \
|
|
51
51
|
-d "email=harry@lob.com" \
|
|
52
52
|
-d "phone=5555555555" \
|
|
53
|
-
-d "address_line1=
|
|
54
|
-
-d "address_line2
|
|
53
|
+
-d "address_line1=2261 Market Street" \
|
|
54
|
+
-d "address_line2=Ste 5668" \
|
|
55
55
|
-d "address_city=San Francisco" \
|
|
56
56
|
-d "address_state=CA" \
|
|
57
|
-
-d "address_zip=
|
|
57
|
+
-d "address_zip=94114" \
|
|
58
58
|
-d "address_country=US" \
|
|
59
59
|
```
|
|
60
60
|
|
|
@@ -65,11 +65,11 @@ addressCreate = AddressEditable.new({
|
|
|
65
65
|
company: "Lob",
|
|
66
66
|
email: "harry@lob.com",
|
|
67
67
|
phone: "5555555555",
|
|
68
|
-
address_line1: "
|
|
69
|
-
address_line2: "
|
|
68
|
+
address_line1: "2261 Market Street",
|
|
69
|
+
address_line2: "Ste 5668",
|
|
70
70
|
address_city: "San Francisco",
|
|
71
71
|
address_state: "CA",
|
|
72
|
-
address_zip: "
|
|
72
|
+
address_zip: "94114",
|
|
73
73
|
address_country: "US",
|
|
74
74
|
});
|
|
75
75
|
|
|
@@ -195,11 +195,11 @@ curl https://api.lob.com/v1/postcards \
|
|
|
195
195
|
--data-urlencode "front=<html style='padding: 1in; font-size: 50;'>Front HTML for {{name}}</html>" \
|
|
196
196
|
--data-urlencode "back=<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>" \
|
|
197
197
|
-d "to[name]=Harry Zhang" \
|
|
198
|
-
-d "to[address_line1]=
|
|
199
|
-
-d "to[address_line2]
|
|
198
|
+
-d "to[address_line1]=2261 Market Street" \
|
|
199
|
+
-d "to[address_line2]=Ste 5668" \
|
|
200
200
|
-d "to[address_city]=San Francisco" \
|
|
201
201
|
-d "to[address_state]=CA" \
|
|
202
|
-
-d "to[address_zip]=
|
|
202
|
+
-d "to[address_zip]=94114" \
|
|
203
203
|
-d "merge_variables[name]=Harry" \
|
|
204
204
|
```
|
|
205
205
|
|
|
@@ -211,11 +211,11 @@ postcardCreate = PostcardEditable.new({
|
|
|
211
211
|
back: "<html style='padding: 1in; font-size: 20;'>Back HTML for {{name}}</html>",
|
|
212
212
|
to: AddressEditable.new({
|
|
213
213
|
name: "Harry Zhang",
|
|
214
|
-
address_line1: "
|
|
215
|
-
address_line2: "
|
|
214
|
+
address_line1: "2261 Market Street",
|
|
215
|
+
address_line2: "Ste 5668",
|
|
216
216
|
address_city: "San Francisco",
|
|
217
217
|
address_state: "CA",
|
|
218
|
-
address_zip: "
|
|
218
|
+
address_zip: "94114",
|
|
219
219
|
}),
|
|
220
220
|
merge_variables: {
|
|
221
221
|
name: "Harry"
|
|
@@ -304,11 +304,11 @@ curl https://api.lob.com/v1/self_mailers \
|
|
|
304
304
|
--data-urlencode "inside=<html style='padding: 1in; font-size: 50;'>Inside HTML for {{name}}</html>" \
|
|
305
305
|
--data-urlencode "outside=<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>" \
|
|
306
306
|
-d "to[name]=Harry Zhang" \
|
|
307
|
-
-d "to[address_line1]=
|
|
308
|
-
-d "to[address_line2]
|
|
307
|
+
-d "to[address_line1]=2261 Market Street" \
|
|
308
|
+
-d "to[address_line2]=Ste 5668" \
|
|
309
309
|
-d "to[address_city]=San Francisco" \
|
|
310
310
|
-d "to[address_state]=CA" \
|
|
311
|
-
-d "to[address_zip]=
|
|
311
|
+
-d "to[address_zip]=94114" \
|
|
312
312
|
-d "merge_variables[name]=Harry" \
|
|
313
313
|
```
|
|
314
314
|
|
|
@@ -320,11 +320,11 @@ selfMailerCreate = SelfMailerEditable.new({
|
|
|
320
320
|
outside: "<html style='padding: 1in; font-size: 20;'>Outside HTML for {{name}}</html>",
|
|
321
321
|
to: AddressEditable.new({
|
|
322
322
|
name: "Harry Zhang",
|
|
323
|
-
address_line1: "
|
|
324
|
-
address_line2: "
|
|
323
|
+
address_line1: "2261 Market Street",
|
|
324
|
+
address_line2: "Ste 5668",
|
|
325
325
|
address_city: "San Francisco",
|
|
326
326
|
address_state: "CA",
|
|
327
|
-
address_zip: "
|
|
327
|
+
address_zip: "94114",
|
|
328
328
|
}),
|
|
329
329
|
merge_variables: {
|
|
330
330
|
name: "Harry"
|
|
@@ -413,11 +413,11 @@ curl https://api.lob.com/v1/letters \
|
|
|
413
413
|
--data-urlencode "file=<html style='padding-top: 3in; margin: .5in;'>HTML Letter for {{name}}</html>" \
|
|
414
414
|
-d "color=true" \
|
|
415
415
|
-d "to[name]=Harry Zhang" \
|
|
416
|
-
-d "to[address_line1]=
|
|
417
|
-
-d "to[address_line2]
|
|
416
|
+
-d "to[address_line1]=2261 Market Street" \
|
|
417
|
+
-d "to[address_line2]=Ste 5668" \
|
|
418
418
|
-d "to[address_city]=San Francisco" \
|
|
419
419
|
-d "to[address_state]=CA" \
|
|
420
|
-
-d "to[address_zip]=
|
|
420
|
+
-d "to[address_zip]=94114" \
|
|
421
421
|
-d "merge_variables[name]=Harry" \
|
|
422
422
|
-d "cards[]=card_c51ae96f5cebf3e"
|
|
423
423
|
```
|
|
@@ -430,11 +430,11 @@ letterCreate = LetterEditable.new({
|
|
|
430
430
|
color: "true",
|
|
431
431
|
to: AddressEditable.new({
|
|
432
432
|
name: "Harry Zhang",
|
|
433
|
-
address_line1: "
|
|
434
|
-
address_line2: "
|
|
433
|
+
address_line1: "2261 Market Street",
|
|
434
|
+
address_line2: "Ste 5668",
|
|
435
435
|
address_city: "San Francisco",
|
|
436
436
|
address_state: "CA",
|
|
437
|
-
address_zip: "
|
|
437
|
+
address_zip: "94114",
|
|
438
438
|
}),
|
|
439
439
|
merge_variables: {
|
|
440
440
|
name: "Harry"
|
|
@@ -529,11 +529,11 @@ curl https://api.lob.com/v1/checks \
|
|
|
529
529
|
--data-urlencode "check_bottom=<h1 style='padding-top:4in;'>Demo Check for {{name}}</h1>" \
|
|
530
530
|
-d "from=adr_210a8d4b0b76d77b" \
|
|
531
531
|
-d "to[name]=Harry Zhang" \
|
|
532
|
-
-d "to[address_line1]=
|
|
533
|
-
-d "to[address_line2]
|
|
532
|
+
-d "to[address_line1]=2261 Market Street" \
|
|
533
|
+
-d "to[address_line2]=Ste 5668" \
|
|
534
534
|
-d "to[address_city]=San Francisco" \
|
|
535
535
|
-d "to[address_state]=CA" \
|
|
536
|
-
-d "to[address_zip]=
|
|
536
|
+
-d "to[address_zip]=94114" \
|
|
537
537
|
-d "merge_variables[name]=Harry" \
|
|
538
538
|
```
|
|
539
539
|
|
|
@@ -548,11 +548,11 @@ checkCreate = CheckEditable.new({
|
|
|
548
548
|
from: "adr_210a8d4b0b76d77b",
|
|
549
549
|
to: AddressDomestic.new({
|
|
550
550
|
name: "Harry Zhang",
|
|
551
|
-
address_line1: "
|
|
552
|
-
address_line2: "
|
|
551
|
+
address_line1: "2261 Market Street",
|
|
552
|
+
address_line2: "Ste 5668",
|
|
553
553
|
address_city: "San Francisco",
|
|
554
554
|
address_state: "CA",
|
|
555
|
-
address_zip: "
|
|
555
|
+
address_zip: "94114",
|
|
556
556
|
}),
|
|
557
557
|
merge_variables: {
|
|
558
558
|
name: "Harry"
|
|
@@ -1688,10 +1688,10 @@ end
|
|
|
1688
1688
|
curl https://api.lob.com/v1/bulk/us_verifications \
|
|
1689
1689
|
-u <YOUR LIVE API KEY>: \
|
|
1690
1690
|
--header "Content-Type: application/x-www-form-urlencoded" \
|
|
1691
|
-
--data-urlencode "addresses[0][primary_line]=
|
|
1691
|
+
--data-urlencode "addresses[0][primary_line]=2261 Market Street" \
|
|
1692
1692
|
--data-urlencode "addresses[0][city]=San Francisco" \
|
|
1693
1693
|
--data-urlencode "addresses[0][state]=CA" \
|
|
1694
|
-
--data-urlencode "addresses[0][zip_code]=
|
|
1694
|
+
--data-urlencode "addresses[0][zip_code]=94114" \
|
|
1695
1695
|
--data-urlencode "addresses[1][primary_line]=185 BERRY ST STE 6600" \
|
|
1696
1696
|
--data-urlencode "addresses[1][city]=SAN FRANCISCO" \
|
|
1697
1697
|
--data-urlencode "addresses[1][state]=CA" \
|
|
@@ -1703,10 +1703,10 @@ usVerificationsApi = UsVerificationsApi.new(config)
|
|
|
1703
1703
|
|
|
1704
1704
|
|
|
1705
1705
|
verificationData0 = MultipleComponents.new({
|
|
1706
|
-
primary_line: "
|
|
1706
|
+
primary_line: "2261 Market Street",
|
|
1707
1707
|
city: "San Francisco",
|
|
1708
1708
|
state: "CA",
|
|
1709
|
-
zip_code: "
|
|
1709
|
+
zip_code: "94114",
|
|
1710
1710
|
})
|
|
1711
1711
|
|
|
1712
1712
|
verificationData1 = MultipleComponents.new({
|
|
@@ -1735,20 +1735,20 @@ end
|
|
|
1735
1735
|
```bash
|
|
1736
1736
|
curl https://api.lob.com/v1/us_verifications \
|
|
1737
1737
|
-u <YOUR_LIVE_API_KEY>: \
|
|
1738
|
-
-d "primary_line=
|
|
1738
|
+
-d "primary_line=2261 Market Street" \
|
|
1739
1739
|
-d "city=San Francisco" \
|
|
1740
1740
|
-d "state=CA" \
|
|
1741
|
-
-d "zip_code=
|
|
1741
|
+
-d "zip_code=94114" \
|
|
1742
1742
|
```
|
|
1743
1743
|
|
|
1744
1744
|
```ruby
|
|
1745
1745
|
usVerificationsApi = UsVerificationsApi.new(config)
|
|
1746
1746
|
|
|
1747
1747
|
verificationData = UsVerificationsWritable.new({
|
|
1748
|
-
primary_line: "
|
|
1748
|
+
primary_line: "2261 Market Street",
|
|
1749
1749
|
city: "San Francisco",
|
|
1750
1750
|
state: "CA",
|
|
1751
|
-
zip_code: "
|
|
1751
|
+
zip_code: "94114",
|
|
1752
1752
|
})
|
|
1753
1753
|
|
|
1754
1754
|
begin
|
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.6)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -10,14 +10,14 @@ GEM
|
|
|
10
10
|
ast (2.4.2)
|
|
11
11
|
byebug (11.1.3)
|
|
12
12
|
coderay (1.1.3)
|
|
13
|
-
diff-lcs (1.5.
|
|
13
|
+
diff-lcs (1.5.1)
|
|
14
14
|
ethon (0.16.0)
|
|
15
15
|
ffi (>= 1.15.0)
|
|
16
16
|
ffi (1.16.3)
|
|
17
17
|
jaro_winkler (1.5.6)
|
|
18
18
|
method_source (1.0.0)
|
|
19
|
-
parallel (1.
|
|
20
|
-
parser (3.
|
|
19
|
+
parallel (1.24.0)
|
|
20
|
+
parser (3.3.0.5)
|
|
21
21
|
ast (~> 2.4.1)
|
|
22
22
|
racc
|
|
23
23
|
pry (0.14.2)
|
|
@@ -26,24 +26,24 @@ GEM
|
|
|
26
26
|
pry-byebug (3.10.1)
|
|
27
27
|
byebug (~> 11.0)
|
|
28
28
|
pry (>= 0.13, < 0.15)
|
|
29
|
-
psych (5.1.
|
|
29
|
+
psych (5.1.2)
|
|
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
|
-
rspec (3.
|
|
35
|
-
rspec-core (~> 3.
|
|
36
|
-
rspec-expectations (~> 3.
|
|
37
|
-
rspec-mocks (~> 3.
|
|
38
|
-
rspec-core (3.
|
|
39
|
-
rspec-support (~> 3.
|
|
40
|
-
rspec-expectations (3.
|
|
34
|
+
rspec (3.13.0)
|
|
35
|
+
rspec-core (~> 3.13.0)
|
|
36
|
+
rspec-expectations (~> 3.13.0)
|
|
37
|
+
rspec-mocks (~> 3.13.0)
|
|
38
|
+
rspec-core (3.13.0)
|
|
39
|
+
rspec-support (~> 3.13.0)
|
|
40
|
+
rspec-expectations (3.13.0)
|
|
41
41
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
42
|
-
rspec-support (~> 3.
|
|
43
|
-
rspec-mocks (3.
|
|
42
|
+
rspec-support (~> 3.13.0)
|
|
43
|
+
rspec-mocks (3.13.0)
|
|
44
44
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
45
|
-
rspec-support (~> 3.
|
|
46
|
-
rspec-support (3.
|
|
45
|
+
rspec-support (~> 3.13.0)
|
|
46
|
+
rspec-support (3.13.0)
|
|
47
47
|
rubocop (0.66.0)
|
|
48
48
|
jaro_winkler (~> 1.5.1)
|
|
49
49
|
parallel (~> 1.10)
|
|
@@ -53,8 +53,8 @@ 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
|
|
57
|
-
typhoeus (1.4.
|
|
56
|
+
stringio (3.1.0)
|
|
57
|
+
typhoeus (1.4.1)
|
|
58
58
|
ethon (>= 0.9.0)
|
|
59
59
|
unicode-display_width (1.5.0)
|
|
60
60
|
|
|
@@ -69,4 +69,4 @@ DEPENDENCIES
|
|
|
69
69
|
rubocop (~> 0.66.0)
|
|
70
70
|
|
|
71
71
|
BUNDLED WITH
|
|
72
|
-
2.4.
|
|
72
|
+
2.4.22
|
data/MIGRATION.md
CHANGED
|
@@ -50,12 +50,12 @@ Here is a sample of the legacy lob-ruby CREATE function:
|
|
|
50
50
|
company: 'Lob',
|
|
51
51
|
email: 'harry@lob.com',
|
|
52
52
|
phone: '5555555555',
|
|
53
|
-
address_line1: '
|
|
54
|
-
address_line2: '
|
|
53
|
+
address_line1: '2261 Market Street',
|
|
54
|
+
address_line2: 'Ste 5668',
|
|
55
55
|
address_city: 'San Francisco',
|
|
56
56
|
address_state: 'CA',
|
|
57
57
|
address_country: 'US',
|
|
58
|
-
address_zip: '
|
|
58
|
+
address_zip: '94114'
|
|
59
59
|
)
|
|
60
60
|
```
|
|
61
61
|
|
data/README.md
CHANGED
|
@@ -44,11 +44,11 @@ addressEditable = Lob::AddressEditable.new({
|
|
|
44
44
|
company: "Lob",
|
|
45
45
|
email: "harry@lob.com",
|
|
46
46
|
phone: "5555555555",
|
|
47
|
-
address_line1: "
|
|
48
|
-
address_line2: "
|
|
47
|
+
address_line1: "2261 Market Street",
|
|
48
|
+
address_line2: "Ste 5668",
|
|
49
49
|
address_city: "San Francisco",
|
|
50
50
|
address_state: "CA",
|
|
51
|
-
address_zip: "
|
|
51
|
+
address_zip: "94114",
|
|
52
52
|
address_country: "US",
|
|
53
53
|
});
|
|
54
54
|
|
|
@@ -17,10 +17,10 @@ RSpec.describe "UsVerificationsApi" do
|
|
|
17
17
|
@usVerificationApi = UsVerificationsApi.new(api)
|
|
18
18
|
|
|
19
19
|
@validAddress = UsVerificationsWritable.new({
|
|
20
|
-
primary_line: "
|
|
20
|
+
primary_line: "2261 MARKET ST",
|
|
21
21
|
city: "SAN FRANCISCO",
|
|
22
22
|
state: "CA",
|
|
23
|
-
zip_code: "
|
|
23
|
+
zip_code: "94114"
|
|
24
24
|
})
|
|
25
25
|
@invalidAddress = UsVerificationsWritable.new({
|
|
26
26
|
primary_line: "1 CEMETERY ST",
|
|
@@ -29,10 +29,10 @@ RSpec.describe "UsVerificationsApi" do
|
|
|
29
29
|
zip_code: "07000"
|
|
30
30
|
})
|
|
31
31
|
mc1 = MultipleComponents.new({
|
|
32
|
-
primary_line: "
|
|
32
|
+
primary_line: "2261 MARKET Street",
|
|
33
33
|
city: "SAN FRANCISCO",
|
|
34
34
|
state: "CA",
|
|
35
|
-
zip_code: "
|
|
35
|
+
zip_code: "94114"
|
|
36
36
|
})
|
|
37
37
|
mc2 = MultipleComponents.new({
|
|
38
38
|
primary_line: "001 CEMETERY LN",
|
|
@@ -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/MultipleComponents.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenapiClient::MultipleComponents
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,20 +11,22 @@
|
|
|
11
11
|
| **city** | **String** | | [optional] |
|
|
12
12
|
| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] |
|
|
13
13
|
| **zip_code** | **String** | 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`). | [optional] |
|
|
14
|
+
| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] |
|
|
14
15
|
|
|
15
16
|
## Example
|
|
16
17
|
|
|
17
18
|
```ruby
|
|
18
19
|
require 'openapi_client'
|
|
19
20
|
|
|
20
|
-
instance =
|
|
21
|
+
instance = OpenapiClient::MultipleComponents.new(
|
|
21
22
|
recipient: null,
|
|
22
23
|
primary_line: null,
|
|
23
24
|
secondary_line: null,
|
|
24
25
|
urbanization: null,
|
|
25
26
|
city: null,
|
|
26
27
|
state: null,
|
|
27
|
-
zip_code: null
|
|
28
|
+
zip_code: null,
|
|
29
|
+
transient_id: null
|
|
28
30
|
)
|
|
29
31
|
```
|
|
30
32
|
|
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
|
|
data/docs/UsVerification.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenapiClient::UsVerification
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -11,17 +11,19 @@
|
|
|
11
11
|
| **urbanization** | **String** | 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. | [optional] |
|
|
12
12
|
| **last_line** | **String** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional] |
|
|
13
13
|
| **deliverability** | **String** | Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS. | [optional] |
|
|
14
|
+
| **valid_address** | **Boolean** | This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address. | [optional] |
|
|
14
15
|
| **components** | [**UsComponents**](UsComponents.md) | | [optional] |
|
|
15
16
|
| **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] |
|
|
16
17
|
| **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] |
|
|
17
18
|
| **object** | **String** | | [optional][default to 'us_verification'] |
|
|
19
|
+
| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] |
|
|
18
20
|
|
|
19
21
|
## Example
|
|
20
22
|
|
|
21
23
|
```ruby
|
|
22
24
|
require 'openapi_client'
|
|
23
25
|
|
|
24
|
-
instance =
|
|
26
|
+
instance = OpenapiClient::UsVerification.new(
|
|
25
27
|
id: null,
|
|
26
28
|
recipient: null,
|
|
27
29
|
primary_line: null,
|
|
@@ -29,10 +31,12 @@ instance = Lob::UsVerification.new(
|
|
|
29
31
|
urbanization: null,
|
|
30
32
|
last_line: null,
|
|
31
33
|
deliverability: null,
|
|
34
|
+
valid_address: null,
|
|
32
35
|
components: null,
|
|
33
36
|
deliverability_analysis: null,
|
|
34
37
|
lob_confidence_score: null,
|
|
35
|
-
object: null
|
|
38
|
+
object: null,
|
|
39
|
+
transient_id: null
|
|
36
40
|
)
|
|
37
41
|
```
|
|
38
42
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenapiClient::UsVerificationOrError
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -15,6 +15,7 @@
|
|
|
15
15
|
| **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] |
|
|
16
16
|
| **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] |
|
|
17
17
|
| **object** | **String** | | [optional][default to 'us_verification'] |
|
|
18
|
+
| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] |
|
|
18
19
|
| **error** | [**BulkError**](BulkError.md) | | [optional] |
|
|
19
20
|
|
|
20
21
|
## Example
|
|
@@ -22,7 +23,7 @@
|
|
|
22
23
|
```ruby
|
|
23
24
|
require 'openapi_client'
|
|
24
25
|
|
|
25
|
-
instance =
|
|
26
|
+
instance = OpenapiClient::UsVerificationOrError.new(
|
|
26
27
|
id: null,
|
|
27
28
|
recipient: null,
|
|
28
29
|
primary_line: null,
|
|
@@ -34,6 +35,7 @@ instance = Lob::UsVerificationOrError.new(
|
|
|
34
35
|
deliverability_analysis: null,
|
|
35
36
|
lob_confidence_score: null,
|
|
36
37
|
object: null,
|
|
38
|
+
transient_id: null,
|
|
37
39
|
error: null
|
|
38
40
|
)
|
|
39
41
|
```
|
data/docs/UsVerifications.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenapiClient::UsVerifications
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
```ruby
|
|
13
13
|
require 'openapi_client'
|
|
14
14
|
|
|
15
|
-
instance =
|
|
15
|
+
instance = OpenapiClient::UsVerifications.new(
|
|
16
16
|
addresses: null,
|
|
17
17
|
errors: null
|
|
18
18
|
)
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
#
|
|
1
|
+
# OpenapiClient::UsVerificationsWritable
|
|
2
2
|
|
|
3
3
|
## Properties
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **address** | **String** | The entire address in one string (e.g., \"
|
|
7
|
+
| **address** | **String** | The entire address in one string (e.g., \"2261 Market Street 94114\"). _Does not support a recipient and will error when other payload parameters are provided._ | [optional] |
|
|
8
8
|
| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
|
|
9
9
|
| **primary_line** | **String** | 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` | [optional] |
|
|
10
10
|
| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] |
|
|
@@ -12,13 +12,14 @@
|
|
|
12
12
|
| **city** | **String** | | [optional] |
|
|
13
13
|
| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] |
|
|
14
14
|
| **zip_code** | **String** | 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`). | [optional] |
|
|
15
|
+
| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] |
|
|
15
16
|
|
|
16
17
|
## Example
|
|
17
18
|
|
|
18
19
|
```ruby
|
|
19
20
|
require 'openapi_client'
|
|
20
21
|
|
|
21
|
-
instance =
|
|
22
|
+
instance = OpenapiClient::UsVerificationsWritable.new(
|
|
22
23
|
address: null,
|
|
23
24
|
recipient: null,
|
|
24
25
|
primary_line: null,
|
|
@@ -26,7 +27,8 @@ instance = Lob::UsVerificationsWritable.new(
|
|
|
26
27
|
urbanization: null,
|
|
27
28
|
city: null,
|
|
28
29
|
state: null,
|
|
29
|
-
zip_code: null
|
|
30
|
+
zip_code: null,
|
|
31
|
+
transient_id: null
|
|
30
32
|
)
|
|
31
33
|
```
|
|
32
34
|
|