lob 6.0.6 → 6.0.8

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b56d9139a4a3c3fcdf0c7c77574256dbb8525e8a7dabcc4e0172366105088c26
4
- data.tar.gz: 2fdbc34a8bd71f3ad443822b1d0e3b1286e7983af3c45c499401ace962755ce4
3
+ metadata.gz: 29d831fdf01a05e3bc46718208fcff5845f358698ede6d636782fc7adf8b366f
4
+ data.tar.gz: 68b783ed3d2574ba00fc4eb1b85fa9360950bf5a7a0c85f6cfbb0c5ceb82e925
5
5
  SHA512:
6
- metadata.gz: 422b6e8b2d9ca04d231a76d229a7e50ea3a261a878db0fb1ced15fd5dfc839fdb45d0c0f7ac670fc75a4399a5422062115079b74980c82f5ee41d78af565a31d
7
- data.tar.gz: 1db2d131f9374889c8892ad7c114182fa3ccefec61c92ed17c76a3459b52dfe1da74d66eda834b12921e12b0b94a5a56edb37ea2bb3a48929f68250661328c67
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.6)
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.0)
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
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | Unique identifier prefixed with &#x60;adr_&#x60;. | [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 &#x60;name&#x60; or &#x60;company&#x60; 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&lt;String, String&gt;** | 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 &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; 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 &#x60;12345&#x60; or ZIP+4 format of &#x60;12345-1234&#x60;. | [optional] |
19
- | **address_country** | [**CountryExtendedExpanded**](CountryExtendedExpanded.md) | | [optional] |
20
- | **object** | **String** | | [optional][default to &#39;address&#39;] |
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
- | **recipient_moved** | **Boolean** | Only returned for accounts on certain &lt;a href&#x3D;\&quot;https://dashboard.lob.com/#/settings/editions\&quot;&gt;Print &amp;amp; Mail Editions&lt;/a&gt;. Value is &#x60;true&#x60; if the address was altered because the recipient filed for a &lt;a href&#x3D;\&quot;#ncoa\&quot;&gt;National Change of Address (NCOA)&lt;/a&gt;, &#x60;false&#x60; if the NCOA check was run but no altered address was found, and &#x60;null&#x60; 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] |
25
-
26
- ## Example
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 'openapi_client'
30
-
31
- instance = Lob::Address.new(
32
- id: null,
33
- description: null,
34
- name: null,
35
- company: null,
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
+
@@ -0,0 +1,15 @@
1
+ # Lob::CountryExtendedExpandedNoUs
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'lob'
12
+
13
+ instance = Lob::CountryExtendedExpandedNoUs.new()
14
+ ```
15
+
@@ -0,0 +1,54 @@
1
+ # Lob::IntlAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | Unique identifier prefixed with &#x60;adr_&#x60;. | [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 &#x60;name&#x60; or &#x60;company&#x60; 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&lt;String, String&gt;** | 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 &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; 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 &#39;address&#39;] |
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 &lt;a href&#x3D;\&quot;https://dashboard.lob.com/#/settings/editions\&quot;&gt;Print &amp;amp; Mail Editions&lt;/a&gt;. Value is &#x60;true&#x60; if the address was altered because the recipient filed for a &lt;a href&#x3D;\&quot;#ncoa\&quot;&gt;National Change of Address (NCOA)&lt;/a&gt;, &#x60;false&#x60; if the NCOA check was run but no altered address was found, and &#x60;null&#x60; 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
+
@@ -1,4 +1,4 @@
1
- # OpenapiClient::MultipleComponents
1
+ # Lob::MultipleComponents
2
2
 
3
3
  ## Properties
4
4
 
@@ -18,7 +18,7 @@
18
18
  ```ruby
19
19
  require 'openapi_client'
20
20
 
21
- instance = OpenapiClient::MultipleComponents.new(
21
+ instance = Lob::MultipleComponents.new(
22
22
  recipient: null,
23
23
  primary_line: null,
24
24
  secondary_line: null,
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 &#x60;adr_&#x60;. | [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 &#x60;name&#x60; or &#x60;company&#x60; 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&lt;String, String&gt;** | 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 &#x60;\&quot;&#x60; and &#x60;\\&#x60;. i.e. &#39;{\&quot;customer_id\&quot; : \&quot;NEWYORK2015\&quot;}&#39; 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 &#x60;12345&#x60; or ZIP+4 format of &#x60;12345-1234&#x60;. | [optional] |
19
+ | **address_country** | **String** | Full name of country | [optional] |
20
+ | **object** | **String** | | [optional][default to &#39;address&#39;] |
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 &lt;a href&#x3D;\&quot;https://dashboard.lob.com/#/settings/editions\&quot;&gt;Print &amp;amp; Mail Editions&lt;/a&gt;. Value is &#x60;true&#x60; if the address was altered because the recipient filed for a &lt;a href&#x3D;\&quot;#ncoa\&quot;&gt;National Change of Address (NCOA)&lt;/a&gt;, &#x60;false&#x60; if the NCOA check was run but no altered address was found, and &#x60;null&#x60; 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
+
@@ -1,4 +1,4 @@
1
- # OpenapiClient::UsVerification
1
+ # Lob::UsVerification
2
2
 
3
3
  ## Properties
4
4
 
@@ -23,7 +23,7 @@
23
23
  ```ruby
24
24
  require 'openapi_client'
25
25
 
26
- instance = OpenapiClient::UsVerification.new(
26
+ instance = Lob::UsVerification.new(
27
27
  id: null,
28
28
  recipient: null,
29
29
  primary_line: null,
@@ -1,4 +1,4 @@
1
- # OpenapiClient::UsVerificationOrError
1
+ # Lob::UsVerificationOrError
2
2
 
3
3
  ## Properties
4
4
 
@@ -23,7 +23,7 @@
23
23
  ```ruby
24
24
  require 'openapi_client'
25
25
 
26
- instance = OpenapiClient::UsVerificationOrError.new(
26
+ instance = Lob::UsVerificationOrError.new(
27
27
  id: null,
28
28
  recipient: null,
29
29
  primary_line: null,
@@ -1,4 +1,4 @@
1
- # OpenapiClient::UsVerifications
1
+ # Lob::UsVerifications
2
2
 
3
3
  ## Properties
4
4
 
@@ -12,7 +12,7 @@
12
12
  ```ruby
13
13
  require 'openapi_client'
14
14
 
15
- instance = OpenapiClient::UsVerifications.new(
15
+ instance = Lob::UsVerifications.new(
16
16
  addresses: null,
17
17
  errors: null
18
18
  )
@@ -1,4 +1,4 @@
1
- # OpenapiClient::UsVerificationsWritable
1
+ # Lob::UsVerificationsWritable
2
2
 
3
3
  ## Properties
4
4
 
@@ -19,7 +19,7 @@
19
19
  ```ruby
20
20
  require 'openapi_client'
21
21
 
22
- instance = OpenapiClient::UsVerificationsWritable.new(
22
+ instance = Lob::UsVerificationsWritable.new(
23
23
  address: null,
24
24
  recipient: null,
25
25
  primary_line: null,