lob 6.0.5 → 6.0.7
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 +18 -18
- data/MIGRATION.md +3 -3
- data/README.md +3 -3
- data/__tests__/Integration/UsVerification.spec.rb +4 -4
- data/docs/MultipleComponents.md +3 -1
- data/docs/UsVerification.md +5 -1
- data/docs/UsVerificationOrError.md +2 -0
- data/docs/UsVerificationsWritable.md +4 -2
- data/lib/openapi_client/models/multiple_components.rb +18 -8
- data/lib/openapi_client/models/us_verification.rb +21 -11
- data/lib/openapi_client/models/us_verification_or_error.rb +16 -6
- data/lib/openapi_client/models/us_verifications.rb +1 -1
- data/lib/openapi_client/models/us_verifications_writable.rb +19 -9
- data/lib/openapi_client/version.rb +2 -2
- data/lib/openapi_client.rb +1 -1
- metadata +18 -18
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4663cb8132ba3fd458197228b78082ff4574eed5c5d7bcb177d4af9affd0a23b
|
|
4
|
+
data.tar.gz: b05e3c8343dae806adde98b41549fe7285b015f0d02c41971314cb9c396c14ce
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 2d52d9f6a6a5ad29f16ec86f59ffc7eed022bd14dcba9de6b3f50577e164bc453f2b0ec9e82eddb6de670179b5c08c114852f569b107332e79e3a47b388a55db
|
|
7
|
+
data.tar.gz: a54ba9548287a2bc4ab71575336b9557e39bb4a6ef20e9d84341b575adfdbf7577cb16cdf123d21162481cd19fa9a29a971cec159362e581b9f110e7eb00942c
|
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.7)
|
|
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
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
|
|
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",
|
data/docs/MultipleComponents.md
CHANGED
|
@@ -11,6 +11,7 @@
|
|
|
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
|
|
|
@@ -24,7 +25,8 @@ instance = Lob::MultipleComponents.new(
|
|
|
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/UsVerification.md
CHANGED
|
@@ -11,10 +11,12 @@
|
|
|
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
|
|
|
@@ -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
|
|
|
@@ -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
|
|
@@ -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
|
```
|
|
@@ -4,7 +4,7 @@
|
|
|
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,6 +12,7 @@
|
|
|
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
|
|
|
@@ -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
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -18,13 +18,13 @@ module Lob
|
|
|
18
18
|
# The intended recipient, typically a person's or firm's name.
|
|
19
19
|
attr_accessor :recipient
|
|
20
20
|
|
|
21
|
-
# The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
|
|
21
|
+
# The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`
|
|
22
22
|
attr_accessor :primary_line
|
|
23
23
|
|
|
24
|
-
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
24
|
+
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
25
25
|
attr_accessor :secondary_line
|
|
26
26
|
|
|
27
|
-
# Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
|
|
27
|
+
# Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.
|
|
28
28
|
attr_accessor :urbanization
|
|
29
29
|
|
|
30
30
|
attr_accessor :city
|
|
@@ -35,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
|
|
|
@@ -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
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -21,22 +21,22 @@ module Lob
|
|
|
21
21
|
# The intended recipient, typically a person's or firm's name.
|
|
22
22
|
attr_accessor :recipient
|
|
23
23
|
|
|
24
|
-
# 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`
|
|
24
|
+
# 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`
|
|
25
25
|
attr_accessor :primary_line
|
|
26
26
|
|
|
27
|
-
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
27
|
+
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
28
28
|
attr_accessor :secondary_line
|
|
29
29
|
|
|
30
|
-
# 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.
|
|
30
|
+
# 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.
|
|
31
31
|
attr_accessor :urbanization
|
|
32
32
|
|
|
33
|
-
# Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)
|
|
33
|
+
# Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)
|
|
34
34
|
attr_accessor :last_line
|
|
35
35
|
|
|
36
|
-
# 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.
|
|
36
|
+
# 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.
|
|
37
37
|
attr_accessor :deliverability
|
|
38
38
|
|
|
39
|
-
# 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.
|
|
39
|
+
# 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.
|
|
40
40
|
attr_accessor :valid_address
|
|
41
41
|
|
|
42
42
|
attr_accessor :components
|
|
@@ -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
|
|
|
@@ -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
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module Lob
|
|
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.
|
|
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_`.
|
|
20
20
|
attr_accessor :id
|
|
@@ -22,13 +22,13 @@ module Lob
|
|
|
22
22
|
# The intended recipient, typically a person's or firm's name.
|
|
23
23
|
attr_accessor :recipient
|
|
24
24
|
|
|
25
|
-
# 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`
|
|
25
|
+
# 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`
|
|
26
26
|
attr_accessor :primary_line
|
|
27
27
|
|
|
28
|
-
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
28
|
+
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
29
29
|
attr_accessor :secondary_line
|
|
30
30
|
|
|
31
|
-
# 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.
|
|
31
|
+
# 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.
|
|
32
32
|
attr_accessor :urbanization
|
|
33
33
|
|
|
34
34
|
attr_accessor :last_line
|
|
@@ -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
|
|
@@ -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
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -15,19 +15,19 @@ require 'time'
|
|
|
15
15
|
|
|
16
16
|
module Lob
|
|
17
17
|
class UsVerificationsWritable
|
|
18
|
-
# The entire address in one string (e.g., \"
|
|
18
|
+
# 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._
|
|
19
19
|
attr_accessor :address
|
|
20
20
|
|
|
21
21
|
# The intended recipient, typically a person's or firm's name.
|
|
22
22
|
attr_accessor :recipient
|
|
23
23
|
|
|
24
|
-
# 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`
|
|
24
|
+
# 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`
|
|
25
25
|
attr_accessor :primary_line
|
|
26
26
|
|
|
27
|
-
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
27
|
+
# The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.
|
|
28
28
|
attr_accessor :secondary_line
|
|
29
29
|
|
|
30
|
-
# 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.
|
|
30
|
+
# 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.
|
|
31
31
|
attr_accessor :urbanization
|
|
32
32
|
|
|
33
33
|
attr_accessor :city
|
|
@@ -38,6 +38,9 @@ module Lob
|
|
|
38
38
|
# 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`).
|
|
39
39
|
attr_accessor :zip_code
|
|
40
40
|
|
|
41
|
+
# ID that is returned in the response body for the verification
|
|
42
|
+
attr_accessor :transient_id
|
|
43
|
+
|
|
41
44
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
42
45
|
def self.attribute_map
|
|
43
46
|
{
|
|
@@ -48,7 +51,8 @@ module Lob
|
|
|
48
51
|
:'urbanization' => :'urbanization',
|
|
49
52
|
:'city' => :'city',
|
|
50
53
|
:'state' => :'state',
|
|
51
|
-
:'zip_code' => :'zip_code'
|
|
54
|
+
:'zip_code' => :'zip_code',
|
|
55
|
+
:'transient_id' => :'transient_id'
|
|
52
56
|
}
|
|
53
57
|
end
|
|
54
58
|
|
|
@@ -67,7 +71,8 @@ module Lob
|
|
|
67
71
|
:'urbanization' => :'String',
|
|
68
72
|
:'city' => :'String',
|
|
69
73
|
:'state' => :'String',
|
|
70
|
-
:'zip_code' => :'String'
|
|
74
|
+
:'zip_code' => :'String',
|
|
75
|
+
:'transient_id' => :'String'
|
|
71
76
|
}
|
|
72
77
|
end
|
|
73
78
|
|
|
@@ -124,6 +129,10 @@ module Lob
|
|
|
124
129
|
if attributes.key?(:'zip_code')
|
|
125
130
|
self.zip_code = attributes[:'zip_code']
|
|
126
131
|
end
|
|
132
|
+
|
|
133
|
+
if attributes.key?(:'transient_id')
|
|
134
|
+
self.transient_id = attributes[:'transient_id']
|
|
135
|
+
end
|
|
127
136
|
end
|
|
128
137
|
|
|
129
138
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -273,7 +282,8 @@ module Lob
|
|
|
273
282
|
urbanization == o.urbanization &&
|
|
274
283
|
city == o.city &&
|
|
275
284
|
state == o.state &&
|
|
276
|
-
zip_code == o.zip_code
|
|
285
|
+
zip_code == o.zip_code &&
|
|
286
|
+
transient_id == o.transient_id
|
|
277
287
|
end
|
|
278
288
|
|
|
279
289
|
# @see the `==` method
|
|
@@ -285,7 +295,7 @@ module Lob
|
|
|
285
295
|
# Calculates hash code according to all attributes.
|
|
286
296
|
# @return [Integer] Hash code
|
|
287
297
|
def hash
|
|
288
|
-
[address, recipient, primary_line, secondary_line, urbanization, city, state, zip_code].hash
|
|
298
|
+
[address, recipient, primary_line, secondary_line, urbanization, city, state, zip_code, transient_id].hash
|
|
289
299
|
end
|
|
290
300
|
|
|
291
301
|
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
|
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.1
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
13
13
|
module Lob
|
|
14
|
-
VERSION = '6.0.
|
|
14
|
+
VERSION = '6.0.7'
|
|
15
15
|
end
|
data/lib/openapi_client.rb
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
=begin
|
|
2
2
|
#Lob
|
|
3
3
|
|
|
4
|
-
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
4
|
+
#The Lob API is organized around REST. Our API is designed to have predictable, resource-oriented URLs and uses HTTP response codes to indicate any API errors. <p> Looking for our [previous documentation](https://lob.github.io/legacy-docs/)?
|
|
5
5
|
|
|
6
6
|
The version of the OpenAPI document: 1.3.0
|
|
7
7
|
Contact: lob-openapi@lob.com
|
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.7
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Lob
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2024-02-21 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/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
|
|
503
|
-
- spec/api/bank_accounts_api_spec.rb
|
|
504
|
-
- spec/api/addresses_api_spec.rb
|
|
505
|
-
- spec/api/campaigns_api_spec.rb
|
|
506
499
|
- spec/api/intl_autocompletions_api_spec.rb
|
|
507
|
-
- spec/api/cards_api_spec.rb
|
|
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
500
|
- spec/api/identity_validation_api_spec.rb
|
|
513
|
-
- spec/api/
|
|
501
|
+
- spec/api/campaigns_api_spec.rb
|
|
514
502
|
- spec/api/intl_verifications_api_spec.rb
|
|
515
|
-
- spec/api/
|
|
516
|
-
- spec/api/
|
|
503
|
+
- spec/api/letters_api_spec.rb
|
|
504
|
+
- spec/api/card_orders_api_spec.rb
|
|
505
|
+
- spec/api/template_versions_api_spec.rb
|
|
506
|
+
- spec/api/cards_api_spec.rb
|
|
507
|
+
- spec/api/billing_groups_api_spec.rb
|
|
508
|
+
- spec/api/templates_api_spec.rb
|
|
517
509
|
- spec/api/self_mailers_api_spec.rb
|
|
518
|
-
- spec/api/reverse_geocode_lookups_api_spec.rb
|
|
519
510
|
- spec/api/uploads_api_spec.rb
|
|
520
511
|
- spec/api/default_api_spec.rb
|
|
512
|
+
- spec/api/creatives_api_spec.rb
|
|
513
|
+
- spec/api/us_autocompletions_api_spec.rb
|
|
514
|
+
- spec/api/reverse_geocode_lookups_api_spec.rb
|
|
515
|
+
- spec/api/checks_api_spec.rb
|
|
516
|
+
- spec/api/addresses_api_spec.rb
|
|
517
|
+
- spec/api/bank_accounts_api_spec.rb
|
|
518
|
+
- spec/api/postcards_api_spec.rb
|
|
519
|
+
- spec/api/us_verifications_api_spec.rb
|
|
520
|
+
- spec/api/zip_lookups_api_spec.rb
|
|
521
521
|
- spec/api_client_spec.rb
|
|
522
522
|
- spec/configuration_spec.rb
|
|
523
523
|
- spec/spec_helper.rb
|