lob 5.4.6 → 6.0.2

data/docs/CreativesApi.md

@@ -0,0 +1,226 @@
+# Lob::CreativesApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**creative_create**](CreativesApi.md#creative_create) | **POST** /creatives | create |
+| [**creative_retrieve**](CreativesApi.md#creative_retrieve) | **GET** /creatives/{crv_id} | get |
+| [**creative_update**](CreativesApi.md#creative_update) | **PATCH** /creatives/{crv_id} | update |
+
+
+## creative_create
+
+> <CreativeResponse> creative_create(creative_writable, opts)
+
+create
+
+Creates a new creative with the provided properties
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::CreativesApi.new
+creative_writable = Lob::CreativeWritable.new({from: TODO, resource_type: 'letter', campaign_id: 'campaign_id_example'}) # CreativeWritable | 
+opts = {
+  x_lang_output: 'native' # String | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request  Default response is in English. 
+}
+
+begin
+  # create
+  result = api_instance.create(creative_writable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->create: #{e}"
+end
+```
+
+#### Using the creative_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreativeResponse>, Integer, Hash)> creative_create_with_http_info(creative_writable, opts)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.creative_create_with_http_info(creative_writable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreativeResponse>
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->creative_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **creative_writable** | [**CreativeWritable**](CreativeWritable.md) |  |  |
+| **x_lang_output** | **String** | * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.  | [optional] |
+
+### Return type
+
+[**CreativeResponse**](CreativeResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## creative_retrieve
+
+> <CreativeResponse> creative_retrieve(crv_id)
+
+get
+
+Retrieves the details of an existing creative. You need only supply the unique creative identifier that was returned upon creative creation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::CreativesApi.new
+crv_id = 'crv_id_example' # String | id of the creative
+
+begin
+  # get
+  result = api_instance.get(crv_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->get: #{e}"
+end
+```
+
+#### Using the creative_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreativeResponse>, Integer, Hash)> creative_retrieve_with_http_info(crv_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.creative_retrieve_with_http_info(crv_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreativeResponse>
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->creative_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crv_id** | **String** | id of the creative |  |
+
+### Return type
+
+[**CreativeResponse**](CreativeResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## creative_update
+
+> <CreativeResponse> creative_update(crv_id, creative_patch)
+
+update
+
+Update the details of an existing creative. You need only supply the unique identifier that was returned upon creative creation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::CreativesApi.new
+crv_id = 'crv_id_example' # String | id of the creative
+creative_patch = Lob::CreativePatch.new # CreativePatch | 
+
+begin
+  # update
+  result = api_instance.update(crv_id, creative_patch)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->update: #{e}"
+end
+```
+
+#### Using the creative_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreativeResponse>, Integer, Hash)> creative_update_with_http_info(crv_id, creative_patch)
+
+```ruby
+begin
+  # update
+  data, status_code, headers = api_instance.creative_update_with_http_info(crv_id, creative_patch)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreativeResponse>
+rescue Lob::ApiError => e
+  puts "Error when calling CreativesApi->creative_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crv_id** | **String** | id of the creative |  |
+| **creative_patch** | [**CreativePatch**](CreativePatch.md) |  |  |
+
+### Return type
+
+[**CreativeResponse**](CreativeResponse.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/CustomEnvelopeReturned.md

@@ -0,0 +1,22 @@
+# Lob::CustomEnvelopeReturned
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier of the custom envelope used. |  |
+| **url** | **String** | The url of the envelope asset used. |  |
+| **object** | **String** |  | [default to 'envelope'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CustomEnvelopeReturned.new(
+  id: null,
+  url: null,
+  object: null
+)
+```
+

data/docs/DefaultApi.md

@@ -0,0 +1,75 @@
+# Lob::DefaultApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**placeholder**](DefaultApi.md#placeholder) | **GET** /shared_dont_call | placeholder_no_call |
+
+
+## placeholder
+
+> <PlaceholderModel> placeholder
+
+placeholder_no_call
+
+Don't call this. It's so that the right models can be generated.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::DefaultApi.new
+
+begin
+  # placeholder_no_call
+  result = api_instance.placeholder_no_call
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling DefaultApi->placeholder_no_call: #{e}"
+end
+```
+
+#### Using the placeholder_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PlaceholderModel>, Integer, Hash)> placeholder_with_http_info
+
+```ruby
+begin
+  # placeholder_no_call
+  data, status_code, headers = api_instance.placeholder_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PlaceholderModel>
+rescue Lob::ApiError => e
+  puts "Error when calling DefaultApi->placeholder_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PlaceholderModel**](PlaceholderModel.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/DeliverabilityAnalysis.md

@@ -0,0 +1,34 @@
+# Lob::DeliverabilityAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dpv_confirmation** | **String** | Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number.   There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `''` –– This address is not deliverable. No matching street could be found within the city or ZIP code.  |  |
+| **dpv_cmra** | **String** | indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).  |  |
+| **dpv_vacant** | **String** | indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).  |  |
+| **dpv_active** | **String** | Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).  |  |
+| **dpv_footnotes** | [**Array<DpvFootnote>**](DpvFootnote.md) | An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types).  |  |
+| **ews_match** | **Boolean** | indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months.  |  |
+| **lacs_indicator** | **String** | indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).  |  |
+| **lacs_return_code** | **String** | A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted.  |  |
+| **suite_return_code** | **String** | A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted.  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::DeliverabilityAnalysis.new(
+  dpv_confirmation: null,
+  dpv_cmra: null,
+  dpv_vacant: null,
+  dpv_active: null,
+  dpv_footnotes: null,
+  ews_match: null,
+  lacs_indicator: null,
+  lacs_return_code: null,
+  suite_return_code: null
+)
+```
+

data/docs/DpvFootnote.md

@@ -0,0 +1,15 @@
+# Lob::DpvFootnote
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::DpvFootnote.new()
+```
+

data/docs/EngineHtml.md

@@ -0,0 +1,15 @@
+# Lob::EngineHtml
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::EngineHtml.new()
+```
+

data/docs/EventType.md

@@ -0,0 +1,24 @@
+# Lob::EventType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **enabled_for_test** | **Boolean** | Value is `true` if the event type is enabled in both the test and live environments. |  |
+| **resource** | **String** |  |  |
+| **object** | **String** | Value is resource type. | [default to 'event_type'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::EventType.new(
+  id: null,
+  enabled_for_test: null,
+  resource: null,
+  object: null
+)
+```
+

data/docs/Events.md

@@ -0,0 +1,28 @@
+# Lob::Events
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `evt_`. |  |
+| **body** | **Object** | The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)). |  |
+| **reference_id** | **String** | Unique identifier of the related resource for the event. |  |
+| **event_type** | [**EventType**](EventType.md) |  |  |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. |  |
+| **object** | **String** | Value is resource type. | [default to 'event'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Events.new(
+  id: null,
+  body: null,
+  reference_id: null,
+  event_type: null,
+  date_created: null,
+  object: null
+)
+```
+

data/docs/Export.md

@@ -0,0 +1,32 @@
+# Lob::Export
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `ex_`. |  |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the export was created |  |
+| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the export was last modified |  |
+| **deleted** | **Boolean** | Returns as `true` if the resource has been successfully deleted. |  |
+| **s3_url** | **String** | The URL for the generated export file. | [optional] |
+| **state** | **String** | The state of the export file, which can be `in_progress`, `failed` or `succeeded`. |  |
+| **type** | **String** | The export file type, which can be `all`, `failures` or `successes`. |  |
+| **upload_id** | **String** | Unique identifier prefixed with `upl_`. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Export.new(
+  id: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  s3_url: null,
+  state: null,
+  type: null,
+  upload_id: null
+)
+```
+

data/docs/ExportModel.md

@@ -0,0 +1,18 @@
+# Lob::ExportModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::ExportModel.new(
+  type: null
+)
+```
+

data/docs/GeocodeAddresses.md

@@ -0,0 +1,20 @@
+# Lob::GeocodeAddresses
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **components** | [**GeocodeComponents**](GeocodeComponents.md) |  | [optional] |
+| **location_analysis** | [**LocationAnalysis**](LocationAnalysis.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::GeocodeAddresses.new(
+  components: null,
+  location_analysis: null
+)
+```
+

data/docs/GeocodeComponents.md

@@ -0,0 +1,20 @@
+# Lob::GeocodeComponents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **zip_code** | **String** | The 5-digit ZIP code |  |
+| **zip_code_plus_4** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::GeocodeComponents.new(
+  zip_code: null,
+  zip_code_plus_4: null
+)
+```
+

data/docs/HTTPValidationError.md

@@ -0,0 +1,18 @@
+# Lob::HTTPValidationError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **detail** | [**Array<ValidationError>**](ValidationError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::HTTPValidationError.new(
+  detail: null
+)
+```
+

data/docs/IdentityValidation.md

@@ -0,0 +1,34 @@
+# Lob::IdentityValidation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `id_validation_`. | [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] |
+| **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] |
+| **score** | **Float** | A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address.  | [optional] |
+| **confidence** | **String** | Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address.  | [optional] |
+| **object** | **String** | Value is resource type. | [optional][default to 'id_validation'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IdentityValidation.new(
+  id: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  last_line: null,
+  score: null,
+  confidence: null,
+  object: null
+)
+```
+

data/docs/IdentityValidationApi.md

@@ -0,0 +1,78 @@
+# Lob::IdentityValidationApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**identity_validation**](IdentityValidationApi.md#identity_validation) | **POST** /identity_validation | validate |
+
+
+## identity_validation
+
+> <IdentityValidation> identity_validation(multi_line_address)
+
+validate
+
+Validates whether a given name is associated with an address.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::IdentityValidationApi.new
+multi_line_address = Lob::MultiLineAddress.new({primary_line: 'primary_line_example'}) # MultiLineAddress | 
+
+begin
+  # validate
+  result = api_instance.validate(multi_line_address)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling IdentityValidationApi->validate: #{e}"
+end
+```
+
+#### Using the identity_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IdentityValidation>, Integer, Hash)> identity_validation_with_http_info(multi_line_address)
+
+```ruby
+begin
+  # validate
+  data, status_code, headers = api_instance.identity_validation_with_http_info(multi_line_address)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IdentityValidation>
+rescue Lob::ApiError => e
+  puts "Error when calling IdentityValidationApi->identity_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **multi_line_address** | [**MultiLineAddress**](MultiLineAddress.md) |  |  |
+
+### Return type
+
+[**IdentityValidation**](IdentityValidation.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+