lob 6.0.7 → 6.0.8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +2 -2
- data/docs/Address.md +43 -46
- data/docs/CountryExtendedExpandedNoUs.md +15 -0
- data/docs/IntlAddress.md +54 -0
- data/docs/UsAddress.md +54 -0
- data/lib/openapi_client/models/address.rb +76 -587
- data/lib/openapi_client/models/country_extended_expanded_no_us.rb +254 -0
- data/lib/openapi_client/models/intl_address.rb +624 -0
- data/lib/openapi_client/models/us_address.rb +644 -0
- data/lib/openapi_client/version.rb +1 -1
- metadata +8 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 29d831fdf01a05e3bc46718208fcff5845f358698ede6d636782fc7adf8b366f
|
|
4
|
+
data.tar.gz: 68b783ed3d2574ba00fc4eb1b85fa9360950bf5a7a0c85f6cfbb0c5ceb82e925
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 263f3bf920d469999c119a135979e7cb7492fe44ce059e87e750d5d0ea8eb2935a7a9659a90b927eaf62e6508eecf10172d274391fbcbc06be1cbdaad2d8b21d
|
|
7
|
+
data.tar.gz: 29bf3ca4f236c7044304f0a1943771a11454d348ce728b04410a8b346f6a80d8f37de08c9f184bbde47ba26727f428b03ff57d0e0459425ba40b028572c2c396
|
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.8)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -43,7 +43,7 @@ GEM
|
|
|
43
43
|
rspec-mocks (3.13.0)
|
|
44
44
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
45
45
|
rspec-support (~> 3.13.0)
|
|
46
|
-
rspec-support (3.13.
|
|
46
|
+
rspec-support (3.13.1)
|
|
47
47
|
rubocop (0.66.0)
|
|
48
48
|
jaro_winkler (~> 1.5.1)
|
|
49
49
|
parallel (~> 1.10)
|
data/docs/Address.md
CHANGED
|
@@ -1,52 +1,49 @@
|
|
|
1
1
|
# Lob::Address
|
|
2
2
|
|
|
3
|
-
##
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
3
|
+
## Class instance methods
|
|
4
|
+
|
|
5
|
+
### `openapi_one_of`
|
|
6
|
+
|
|
7
|
+
Returns the list of classes defined in oneOf.
|
|
8
|
+
|
|
9
|
+
#### Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'lob'
|
|
13
|
+
|
|
14
|
+
Lob::Address.openapi_one_of
|
|
15
|
+
# =>
|
|
16
|
+
# [
|
|
17
|
+
# :'IntlAddress',
|
|
18
|
+
# :'UsAddress'
|
|
19
|
+
# ]
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
### build
|
|
23
|
+
|
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
|
25
|
+
|
|
26
|
+
#### Example
|
|
27
27
|
|
|
28
28
|
```ruby
|
|
29
|
-
require '
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
phone: null,
|
|
37
|
-
email: null,
|
|
38
|
-
metadata: null,
|
|
39
|
-
address_line1: null,
|
|
40
|
-
address_line2: null,
|
|
41
|
-
address_city: null,
|
|
42
|
-
address_state: null,
|
|
43
|
-
address_zip: null,
|
|
44
|
-
address_country: null,
|
|
45
|
-
object: null,
|
|
46
|
-
date_created: null,
|
|
47
|
-
date_modified: null,
|
|
48
|
-
deleted: null,
|
|
49
|
-
recipient_moved: null
|
|
50
|
-
)
|
|
29
|
+
require 'lob'
|
|
30
|
+
|
|
31
|
+
Lob::Address.build(data)
|
|
32
|
+
# => #<IntlAddress:0x00007fdd4aab02a0>
|
|
33
|
+
|
|
34
|
+
Lob::Address.build(data_that_doesnt_match)
|
|
35
|
+
# => nil
|
|
51
36
|
```
|
|
52
37
|
|
|
38
|
+
#### Parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Description |
|
|
41
|
+
| ---- | ---- | ----------- |
|
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
|
43
|
+
|
|
44
|
+
#### Return type
|
|
45
|
+
|
|
46
|
+
- `IntlAddress`
|
|
47
|
+
- `UsAddress`
|
|
48
|
+
- `nil` (if no type matches)
|
|
49
|
+
|
data/docs/IntlAddress.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Lob::IntlAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `adr_`. | [optional] |
|
|
8
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
9
|
+
| **name** | **String** | name associated with address | [optional] |
|
|
10
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
11
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
12
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
13
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
|
14
|
+
| **address_line1** | **String** | | [optional] |
|
|
15
|
+
| **address_line2** | **String** | | [optional] |
|
|
16
|
+
| **address_city** | **String** | | [optional] |
|
|
17
|
+
| **address_state** | **String** | 2 letter state short-name code | [optional] |
|
|
18
|
+
| **address_zip** | **String** | Must have a maximum of 12 characters | [optional] |
|
|
19
|
+
| **address_country** | [**CountryExtendedExpandedNoUs**](CountryExtendedExpandedNoUs.md) | | [optional] |
|
|
20
|
+
| **object** | **String** | | [optional][default to 'address'] |
|
|
21
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
|
22
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
|
23
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
24
|
+
| **inline** | **Boolean** | Checks if address id is used or not | [optional] |
|
|
25
|
+
| **recipient_moved** | **Boolean** | Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'lob'
|
|
31
|
+
|
|
32
|
+
instance = Lob::IntlAddress.new(
|
|
33
|
+
id: null,
|
|
34
|
+
description: null,
|
|
35
|
+
name: null,
|
|
36
|
+
company: null,
|
|
37
|
+
phone: null,
|
|
38
|
+
email: null,
|
|
39
|
+
metadata: null,
|
|
40
|
+
address_line1: null,
|
|
41
|
+
address_line2: null,
|
|
42
|
+
address_city: null,
|
|
43
|
+
address_state: null,
|
|
44
|
+
address_zip: null,
|
|
45
|
+
address_country: null,
|
|
46
|
+
object: null,
|
|
47
|
+
date_created: null,
|
|
48
|
+
date_modified: null,
|
|
49
|
+
deleted: null,
|
|
50
|
+
inline: null,
|
|
51
|
+
recipient_moved: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|
data/docs/UsAddress.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Lob::UsAddress
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier prefixed with `adr_`. | [optional] |
|
|
8
|
+
| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters. | [optional] |
|
|
9
|
+
| **name** | **String** | name associated with address | [optional] |
|
|
10
|
+
| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
|
|
11
|
+
| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
|
|
12
|
+
| **email** | **String** | Must be no longer than 100 characters. | [optional] |
|
|
13
|
+
| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. | [optional] |
|
|
14
|
+
| **address_line1** | **String** | | [optional] |
|
|
15
|
+
| **address_line2** | **String** | | [optional] |
|
|
16
|
+
| **address_city** | **String** | | [optional] |
|
|
17
|
+
| **address_state** | **String** | 2 letter state short-name code | [optional] |
|
|
18
|
+
| **address_zip** | **String** | Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. | [optional] |
|
|
19
|
+
| **address_country** | **String** | Full name of country | [optional] |
|
|
20
|
+
| **object** | **String** | | [optional][default to 'address'] |
|
|
21
|
+
| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
|
|
22
|
+
| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
|
|
23
|
+
| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
|
|
24
|
+
| **inline** | **Boolean** | Checks if address id is used or not | [optional] |
|
|
25
|
+
| **recipient_moved** | **Boolean** | Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. | [optional] |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```ruby
|
|
30
|
+
require 'lob'
|
|
31
|
+
|
|
32
|
+
instance = Lob::UsAddress.new(
|
|
33
|
+
id: null,
|
|
34
|
+
description: null,
|
|
35
|
+
name: null,
|
|
36
|
+
company: null,
|
|
37
|
+
phone: null,
|
|
38
|
+
email: null,
|
|
39
|
+
metadata: null,
|
|
40
|
+
address_line1: null,
|
|
41
|
+
address_line2: null,
|
|
42
|
+
address_city: null,
|
|
43
|
+
address_state: null,
|
|
44
|
+
address_zip: null,
|
|
45
|
+
address_country: null,
|
|
46
|
+
object: null,
|
|
47
|
+
date_created: null,
|
|
48
|
+
date_modified: null,
|
|
49
|
+
deleted: null,
|
|
50
|
+
inline: null,
|
|
51
|
+
recipient_moved: null
|
|
52
|
+
)
|
|
53
|
+
```
|
|
54
|
+
|