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.
@@ -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
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
13
13
  require 'date'
14
14
  require 'time'
15
15
 
16
- module OpenapiClient
16
+ module Lob
17
17
  class UsVerification
18
18
  # Unique identifier prefixed with `us_ver_`.
19
19
  attr_accessor :id
@@ -21,22 +21,22 @@ module OpenapiClient
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,7 +47,7 @@ module OpenapiClient
47
47
 
48
48
  attr_accessor :object
49
49
 
50
- # ID that is returned in the response body for the verification
50
+ # ID that is returned in the response body for the verification
51
51
  attr_accessor :transient_id
52
52
 
53
53
  class EnumAttributeValidator
@@ -126,13 +126,13 @@ module OpenapiClient
126
126
  # @param [Hash] attributes Model attributes in the form of hash
127
127
  def initialize(attributes = {})
128
128
  if (!attributes.is_a?(Hash))
129
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerification` initialize method"
129
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerification` initialize method"
130
130
  end
131
131
 
132
132
  # check to see if the attribute exists and convert string to symbol for hash key
133
133
  attributes = attributes.each_with_object({}) { |(k, v), h|
134
134
  if (!self.class.attribute_map.key?(k.to_sym))
135
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
135
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsVerification`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
136
136
  end
137
137
  h[k.to_sym] = v
138
138
  }
@@ -415,7 +415,7 @@ module OpenapiClient
415
415
  end
416
416
  else # model
417
417
  # models (e.g. Pet) or oneOf
418
- klass = OpenapiClient.const_get(type)
418
+ klass = Lob.const_get(type)
419
419
  klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
420
420
  end
421
421
  end
@@ -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
@@ -13,8 +13,8 @@ OpenAPI Generator version: 5.2.1
13
13
  require 'date'
14
14
  require 'time'
15
15
 
16
- module OpenapiClient
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.
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.
18
18
  class UsVerificationOrError
19
19
  # Unique identifier prefixed with `us_ver_`.
20
20
  attr_accessor :id
@@ -22,13 +22,13 @@ module OpenapiClient
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,7 +43,7 @@ module OpenapiClient
43
43
 
44
44
  attr_accessor :object
45
45
 
46
- # ID that is returned in the response body for the verification
46
+ # ID that is returned in the response body for the verification
47
47
  attr_accessor :transient_id
48
48
 
49
49
  attr_accessor :error
@@ -124,13 +124,13 @@ module OpenapiClient
124
124
  # @param [Hash] attributes Model attributes in the form of hash
125
125
  def initialize(attributes = {})
126
126
  if (!attributes.is_a?(Hash))
127
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerificationOrError` initialize method"
127
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerificationOrError` initialize method"
128
128
  end
129
129
 
130
130
  # check to see if the attribute exists and convert string to symbol for hash key
131
131
  attributes = attributes.each_with_object({}) { |(k, v), h|
132
132
  if (!self.class.attribute_map.key?(k.to_sym))
133
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerificationOrError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
133
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsVerificationOrError`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
134
134
  end
135
135
  h[k.to_sym] = v
136
136
  }
@@ -413,7 +413,7 @@ module OpenapiClient
413
413
  end
414
414
  else # model
415
415
  # models (e.g. Pet) or oneOf
416
- klass = OpenapiClient.const_get(type)
416
+ klass = Lob.const_get(type)
417
417
  klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
418
418
  end
419
419
  end
@@ -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
@@ -13,7 +13,7 @@ OpenAPI Generator version: 5.2.1
13
13
  require 'date'
14
14
  require 'time'
15
15
 
16
- module OpenapiClient
16
+ module Lob
17
17
  class UsVerifications
18
18
  attr_accessor :addresses
19
19
 
@@ -51,13 +51,13 @@ module OpenapiClient
51
51
  # @param [Hash] attributes Model attributes in the form of hash
52
52
  def initialize(attributes = {})
53
53
  if (!attributes.is_a?(Hash))
54
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerifications` initialize method"
54
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerifications` initialize method"
55
55
  end
56
56
 
57
57
  # check to see if the attribute exists and convert string to symbol for hash key
58
58
  attributes = attributes.each_with_object({}) { |(k, v), h|
59
59
  if (!self.class.attribute_map.key?(k.to_sym))
60
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerifications`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
60
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsVerifications`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
61
61
  end
62
62
  h[k.to_sym] = v
63
63
  }
@@ -194,7 +194,7 @@ module OpenapiClient
194
194
  end
195
195
  else # model
196
196
  # models (e.g. Pet) or oneOf
197
- klass = OpenapiClient.const_get(type)
197
+ klass = Lob.const_get(type)
198
198
  klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
199
199
  end
200
200
  end
@@ -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
@@ -13,21 +13,21 @@ OpenAPI Generator version: 5.2.1
13
13
  require 'date'
14
14
  require 'time'
15
15
 
16
- module OpenapiClient
16
+ module Lob
17
17
  class UsVerificationsWritable
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._
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,7 +38,7 @@ module OpenapiClient
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
41
+ # ID that is returned in the response body for the verification
42
42
  attr_accessor :transient_id
43
43
 
44
44
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -87,13 +87,13 @@ module OpenapiClient
87
87
  # @param [Hash] attributes Model attributes in the form of hash
88
88
  def initialize(attributes = {})
89
89
  if (!attributes.is_a?(Hash))
90
- fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerificationsWritable` initialize method"
90
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerificationsWritable` initialize method"
91
91
  end
92
92
 
93
93
  # check to see if the attribute exists and convert string to symbol for hash key
94
94
  attributes = attributes.each_with_object({}) { |(k, v), h|
95
95
  if (!self.class.attribute_map.key?(k.to_sym))
96
- fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::UsVerificationsWritable`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
96
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::UsVerificationsWritable`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
97
97
  end
98
98
  h[k.to_sym] = v
99
99
  }
@@ -375,7 +375,7 @@ module OpenapiClient
375
375
  end
376
376
  else # model
377
377
  # models (e.g. Pet) or oneOf
378
- klass = OpenapiClient.const_get(type)
378
+ klass = Lob.const_get(type)
379
379
  klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
380
380
  end
381
381
  end
@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.2.1
11
11
  =end
12
12
 
13
13
  module Lob
14
- VERSION = '6.0.6'
14
+ VERSION = '6.0.8'
15
15
  end
@@ -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.6
4
+ version: 6.0.8
5
5
  platform: ruby
6
6
  authors:
7
7
  - Lob
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-02-16 00:00:00.000000000 Z
11
+ date: 2024-02-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus
@@ -156,6 +156,7 @@ files:
156
156
  - docs/CmpUseType.md
157
157
  - docs/CountryExtended.md
158
158
  - docs/CountryExtendedExpanded.md
159
+ - docs/CountryExtendedExpandedNoUs.md
159
160
  - docs/CreativePatch.md
160
161
  - docs/CreativeResponse.md
161
162
  - docs/CreativeWritable.md
@@ -175,6 +176,7 @@ files:
175
176
  - docs/IdentityValidation.md
176
177
  - docs/IdentityValidationApi.md
177
178
  - docs/InlineObject.md
179
+ - docs/IntlAddress.md
178
180
  - docs/IntlAutocompletions.md
179
181
  - docs/IntlAutocompletionsApi.md
180
182
  - docs/IntlAutocompletionsWritable.md
@@ -251,6 +253,7 @@ files:
251
253
  - docs/UploadUpdatable.md
252
254
  - docs/UploadWritable.md
253
255
  - docs/UploadsApi.md
256
+ - docs/UsAddress.md
254
257
  - docs/UsAutocompletions.md
255
258
  - docs/UsAutocompletionsApi.md
256
259
  - docs/UsAutocompletionsWritable.md
@@ -344,6 +347,7 @@ files:
344
347
  - lib/openapi_client/models/cmp_use_type.rb
345
348
  - lib/openapi_client/models/country_extended.rb
346
349
  - lib/openapi_client/models/country_extended_expanded.rb
350
+ - lib/openapi_client/models/country_extended_expanded_no_us.rb
347
351
  - lib/openapi_client/models/creative_patch.rb
348
352
  - lib/openapi_client/models/creative_response.rb
349
353
  - lib/openapi_client/models/creative_writable.rb
@@ -360,6 +364,7 @@ files:
360
364
  - lib/openapi_client/models/http_validation_error.rb
361
365
  - lib/openapi_client/models/identity_validation.rb
362
366
  - lib/openapi_client/models/inline_object.rb
367
+ - lib/openapi_client/models/intl_address.rb
363
368
  - lib/openapi_client/models/intl_autocompletions.rb
364
369
  - lib/openapi_client/models/intl_autocompletions_writable.rb
365
370
  - lib/openapi_client/models/intl_components.rb
@@ -433,6 +438,7 @@ files:
433
438
  - lib/openapi_client/models/upload_updatable.rb
434
439
  - lib/openapi_client/models/upload_writable.rb
435
440
  - lib/openapi_client/models/uploads_metadata.rb
441
+ - lib/openapi_client/models/us_address.rb
436
442
  - lib/openapi_client/models/us_autocompletions.rb
437
443
  - lib/openapi_client/models/us_autocompletions_writable.rb
438
444
  - lib/openapi_client/models/us_components.rb