diff --git a/docs/MultipleComponents.md b/docs/MultipleComponents.md index 9e71577..d242de1 100755 --- a/docs/MultipleComponents.md +++ b/docs/MultipleComponents.md @@ -1,4 +1,4 @@ -# Lob::MultipleComponents +# OpenapiClient::MultipleComponents ## Properties @@ -11,20 +11,22 @@ | **city** | **String** | | [optional] | | **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] | | **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] | +| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] | ## Example ```ruby require 'openapi_client' -instance = Lob::MultipleComponents.new( +instance = OpenapiClient::MultipleComponents.new( recipient: null, primary_line: null, secondary_line: null, urbanization: null, city: null, state: null, - zip_code: null + zip_code: null, + transient_id: null ) ``` diff --git a/docs/UsVerification.md b/docs/UsVerification.md index 1a6c366..faee638 100755 --- a/docs/UsVerification.md +++ b/docs/UsVerification.md @@ -1,4 +1,4 @@ -# Lob::UsVerification +# OpenapiClient::UsVerification ## Properties @@ -11,17 +11,19 @@ | **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] | | **last_line** | **String** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional] | | **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] | +| **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] | | **components** | [**UsComponents**](UsComponents.md) | | [optional] | | **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] | | **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] | | **object** | **String** | | [optional][default to 'us_verification'] | +| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] | ## Example ```ruby require 'openapi_client' -instance = Lob::UsVerification.new( +instance = OpenapiClient::UsVerification.new( id: null, recipient: null, primary_line: null, @@ -29,10 +31,12 @@ instance = Lob::UsVerification.new( urbanization: null, last_line: null, deliverability: null, + valid_address: null, components: null, deliverability_analysis: null, lob_confidence_score: null, - object: null + object: null, + transient_id: null ) ``` diff --git a/docs/UsVerificationOrError.md b/docs/UsVerificationOrError.md index ad7cb63..4c88ea7 100755 --- a/docs/UsVerificationOrError.md +++ b/docs/UsVerificationOrError.md @@ -1,4 +1,4 @@ -# Lob::UsVerificationOrError +# OpenapiClient::UsVerificationOrError ## Properties @@ -15,6 +15,7 @@ | **deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] | | **lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] | | **object** | **String** | | [optional][default to 'us_verification'] | +| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] | | **error** | [**BulkError**](BulkError.md) | | [optional] | ## Example @@ -22,7 +23,7 @@ ```ruby require 'openapi_client' -instance = Lob::UsVerificationOrError.new( +instance = OpenapiClient::UsVerificationOrError.new( id: null, recipient: null, primary_line: null, @@ -34,6 +35,7 @@ instance = Lob::UsVerificationOrError.new( deliverability_analysis: null, lob_confidence_score: null, object: null, + transient_id: null, error: null ) ``` diff --git a/docs/UsVerifications.md b/docs/UsVerifications.md index a518ccb..9def1b7 100755 --- a/docs/UsVerifications.md +++ b/docs/UsVerifications.md @@ -1,4 +1,4 @@ -# Lob::UsVerifications +# OpenapiClient::UsVerifications ## Properties @@ -12,7 +12,7 @@ ```ruby require 'openapi_client' -instance = Lob::UsVerifications.new( +instance = OpenapiClient::UsVerifications.new( addresses: null, errors: null ) diff --git a/docs/UsVerificationsWritable.md b/docs/UsVerificationsWritable.md index 7908518..977f5b7 100755 --- a/docs/UsVerificationsWritable.md +++ b/docs/UsVerificationsWritable.md @@ -1,10 +1,10 @@ -# Lob::UsVerificationsWritable +# OpenapiClient::UsVerificationsWritable ## Properties | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | -| **address** | **String** | The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ | [optional] | +| **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] | | **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] | | **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] | | **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] | @@ -12,13 +12,14 @@ | **city** | **String** | | [optional] | | **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] | | **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] | +| **transient_id** | **String** | ID that is returned in the response body for the verification | [optional] | ## Example ```ruby require 'openapi_client' -instance = Lob::UsVerificationsWritable.new( +instance = OpenapiClient::UsVerificationsWritable.new( address: null, recipient: null, primary_line: null, @@ -26,7 +27,8 @@ instance = Lob::UsVerificationsWritable.new( urbanization: null, city: null, state: null, - zip_code: null + zip_code: null, + transient_id: null ) ``` diff --git a/lib/openapi_client/models/multiple_components.rb b/lib/openapi_client/models/multiple_components.rb index 9fae4e3..f1d1e35 100755 --- a/lib/openapi_client/models/multiple_components.rb +++ b/lib/openapi_client/models/multiple_components.rb @@ -13,7 +13,7 @@ require 'date' require 'time' -module Lob +module OpenapiClient class MultipleComponents # The intended recipient, typically a person's or firm's name. attr_accessor :recipient @@ -35,6 +35,9 @@ class MultipleComponents # 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`). attr_accessor :zip_code + # ID that is returned in the response body for the verification + attr_accessor :transient_id + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -44,7 +47,8 @@ def self.attribute_map :'urbanization' => :'urbanization', :'city' => :'city', :'state' => :'state', - :'zip_code' => :'zip_code' + :'zip_code' => :'zip_code', + :'transient_id' => :'transient_id' } end @@ -62,7 +66,8 @@ def self.openapi_types :'urbanization' => :'String', :'city' => :'String', :'state' => :'String', - :'zip_code' => :'String' + :'zip_code' => :'String', + :'transient_id' => :'String' } end @@ -77,13 +82,13 @@ def self.openapi_nullable # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::MultipleComponents` initialize method" + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::MultipleComponents` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - fail ArgumentError, "`#{k}` is not a valid attribute in `Lob::MultipleComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect + fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::MultipleComponents`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect end h[k.to_sym] = v } @@ -115,6 +120,10 @@ def initialize(attributes = {}) if attributes.key?(:'zip_code') self.zip_code = attributes[:'zip_code'] end + + if attributes.key?(:'transient_id') + self.transient_id = attributes[:'transient_id'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -257,7 +266,8 @@ def ==(o) urbanization == o.urbanization && city == o.city && state == o.state && - zip_code == o.zip_code + zip_code == o.zip_code && + transient_id == o.transient_id end # @see the `==` method @@ -269,7 +279,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [recipient, primary_line, secondary_line, urbanization, city, state, zip_code].hash + [recipient, primary_line, secondary_line, urbanization, city, state, zip_code, transient_id].hash end @@ -349,7 +359,7 @@ def _deserialize(type, value) end else # model # models (e.g. Pet) or oneOf - klass = Lob.const_get(type) + klass = OpenapiClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end diff --git a/lib/openapi_client/models/us_verification.rb b/lib/openapi_client/models/us_verification.rb index 1c78767..00e5411 100755 --- a/lib/openapi_client/models/us_verification.rb +++ b/lib/openapi_client/models/us_verification.rb @@ -13,7 +13,7 @@ require 'date' require 'time' -module Lob +module OpenapiClient class UsVerification # Unique identifier prefixed with `us_ver_`. attr_accessor :id @@ -47,6 +47,9 @@ class UsVerification attr_accessor :object + # ID that is returned in the response body for the verification + attr_accessor :transient_id + class EnumAttributeValidator attr_reader :datatype attr_reader :allowable_values @@ -83,7 +86,8 @@ def self.attribute_map :'components' => :'components', :'deliverability_analysis' => :'deliverability_analysis', :'lob_confidence_score' => :'lob_confidence_score', - :'object' => :'object' + :'object' => :'object', + :'transient_id' => :'transient_id' } end @@ -106,7 +110,8 @@ def self.openapi_types :'components' => :'UsComponents', :'deliverability_analysis' => :'DeliverabilityAnalysis', :'lob_confidence_score' => :'LobConfidenceScore', - :'object' => :'String' + :'object' => :'String', + :'transient_id' => :'String' } end @@ -121,13 +126,13 @@ def self.openapi_nullable # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerification` initialize method" + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerification` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - 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 + 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 end h[k.to_sym] = v } @@ -181,6 +186,10 @@ def initialize(attributes = {}) else self.object = 'us_verification' end + + if attributes.key?(:'transient_id') + self.transient_id = attributes[:'transient_id'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -313,7 +322,8 @@ def ==(o) components == o.components && deliverability_analysis == o.deliverability_analysis && lob_confidence_score == o.lob_confidence_score && - object == o.object + object == o.object && + transient_id == o.transient_id end # @see the `==` method @@ -325,7 +335,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, valid_address, components, deliverability_analysis, lob_confidence_score, object].hash + [id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, valid_address, components, deliverability_analysis, lob_confidence_score, object, transient_id].hash end @@ -405,7 +415,7 @@ def _deserialize(type, value) end else # model # models (e.g. Pet) or oneOf - klass = Lob.const_get(type) + klass = OpenapiClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end diff --git a/lib/openapi_client/models/us_verification_or_error.rb b/lib/openapi_client/models/us_verification_or_error.rb index 75a5ee9..30e7b5b 100755 --- a/lib/openapi_client/models/us_verification_or_error.rb +++ b/lib/openapi_client/models/us_verification_or_error.rb @@ -13,7 +13,7 @@ require 'date' require 'time' -module Lob +module OpenapiClient # 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. class UsVerificationOrError # Unique identifier prefixed with `us_ver_`. @@ -43,6 +43,9 @@ class UsVerificationOrError attr_accessor :object + # ID that is returned in the response body for the verification + attr_accessor :transient_id + attr_accessor :error class EnumAttributeValidator @@ -81,6 +84,7 @@ def self.attribute_map :'deliverability_analysis' => :'deliverability_analysis', :'lob_confidence_score' => :'lob_confidence_score', :'object' => :'object', + :'transient_id' => :'transient_id', :'error' => :'error' } end @@ -104,6 +108,7 @@ def self.openapi_types :'deliverability_analysis' => :'DeliverabilityAnalysis', :'lob_confidence_score' => :'LobConfidenceScore', :'object' => :'String', + :'transient_id' => :'String', :'error' => :'BulkError' } end @@ -119,13 +124,13 @@ def self.openapi_nullable # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerificationOrError` initialize method" + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerificationOrError` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - 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 + 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 end h[k.to_sym] = v } @@ -176,6 +181,10 @@ def initialize(attributes = {}) self.object = 'us_verification' end + if attributes.key?(:'transient_id') + self.transient_id = attributes[:'transient_id'] + end + if attributes.key?(:'error') self.error = attributes[:'error'] end @@ -311,6 +320,7 @@ def ==(o) deliverability_analysis == o.deliverability_analysis && lob_confidence_score == o.lob_confidence_score && object == o.object && + transient_id == o.transient_id && error == o.error end @@ -323,7 +333,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, components, deliverability_analysis, lob_confidence_score, object, error].hash + [id, recipient, primary_line, secondary_line, urbanization, last_line, deliverability, components, deliverability_analysis, lob_confidence_score, object, transient_id, error].hash end @@ -403,7 +413,7 @@ def _deserialize(type, value) end else # model # models (e.g. Pet) or oneOf - klass = Lob.const_get(type) + klass = OpenapiClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end diff --git a/lib/openapi_client/models/us_verifications.rb b/lib/openapi_client/models/us_verifications.rb index 41b8b17..cffb9c4 100755 --- a/lib/openapi_client/models/us_verifications.rb +++ b/lib/openapi_client/models/us_verifications.rb @@ -13,7 +13,7 @@ require 'date' require 'time' -module Lob +module OpenapiClient class UsVerifications attr_accessor :addresses @@ -51,13 +51,13 @@ def self.openapi_nullable # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerifications` initialize method" + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerifications` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - 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 + 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 end h[k.to_sym] = v } @@ -194,7 +194,7 @@ def _deserialize(type, value) end else # model # models (e.g. Pet) or oneOf - klass = Lob.const_get(type) + klass = OpenapiClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end diff --git a/lib/openapi_client/models/us_verifications_writable.rb b/lib/openapi_client/models/us_verifications_writable.rb index 6782a20..0bb99ef 100755 --- a/lib/openapi_client/models/us_verifications_writable.rb +++ b/lib/openapi_client/models/us_verifications_writable.rb @@ -13,9 +13,9 @@ require 'date' require 'time' -module Lob +module OpenapiClient class UsVerificationsWritable - # The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ + # 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._ attr_accessor :address # The intended recipient, typically a person's or firm's name. @@ -38,6 +38,9 @@ class UsVerificationsWritable # 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`). attr_accessor :zip_code + # ID that is returned in the response body for the verification + attr_accessor :transient_id + # Attribute mapping from ruby-style variable name to JSON key. def self.attribute_map { @@ -48,7 +51,8 @@ def self.attribute_map :'urbanization' => :'urbanization', :'city' => :'city', :'state' => :'state', - :'zip_code' => :'zip_code' + :'zip_code' => :'zip_code', + :'transient_id' => :'transient_id' } end @@ -67,7 +71,8 @@ def self.openapi_types :'urbanization' => :'String', :'city' => :'String', :'state' => :'String', - :'zip_code' => :'String' + :'zip_code' => :'String', + :'transient_id' => :'String' } end @@ -82,13 +87,13 @@ def self.openapi_nullable # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) if (!attributes.is_a?(Hash)) - fail ArgumentError, "The input argument (attributes) must be a hash in `Lob::UsVerificationsWritable` initialize method" + fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::UsVerificationsWritable` initialize method" end # check to see if the attribute exists and convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| if (!self.class.attribute_map.key?(k.to_sym)) - 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 + 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 end h[k.to_sym] = v } @@ -124,6 +129,10 @@ def initialize(attributes = {}) if attributes.key?(:'zip_code') self.zip_code = attributes[:'zip_code'] end + + if attributes.key?(:'transient_id') + self.transient_id = attributes[:'transient_id'] + end end # Show invalid properties with the reasons. Usually used together with valid? @@ -273,7 +282,8 @@ def ==(o) urbanization == o.urbanization && city == o.city && state == o.state && - zip_code == o.zip_code + zip_code == o.zip_code && + transient_id == o.transient_id end # @see the `==` method @@ -285,7 +295,7 @@ def eql?(o) # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash - [address, recipient, primary_line, secondary_line, urbanization, city, state, zip_code].hash + [address, recipient, primary_line, secondary_line, urbanization, city, state, zip_code, transient_id].hash end @@ -365,7 +375,7 @@ def _deserialize(type, value) end else # model # models (e.g. Pet) or oneOf - klass = Lob.const_get(type) + klass = OpenapiClient.const_get(type) klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end diff --git a/lib/openapi_client/version.rb b/lib/openapi_client/version.rb index e2bce6a..5ec1327 100755 --- a/lib/openapi_client/version.rb +++ b/lib/openapi_client/version.rb @@ -1,7 +1,7 @@ =begin #Lob -#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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? +#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.

Looking for our [previous documentation](https://lob.github.io/legacy-docs/)? The version of the OpenAPI document: 1.3.0 Contact: lob-openapi@lob.com @@ -11,5 +11,5 @@ =end module Lob - VERSION = '6.0.4' + VERSION = '6.0.6' end