lob 5.4.6 → 6.0.0

data/docs/LetterDetailsReturned.md

@@ -0,0 +1,36 @@
+# Lob::LetterDetailsReturned
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **color** | **Boolean** | Set this key to `true` if you would like to print in color, false for black and white. |  |
+| **cards** | **Array<String>** | A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. |  |
+| **address_placement** | **String** | Specifies the location of the address information that will show through the double-window envelope.  | [optional][default to 'top_first_page'] |
+| **custom_envelope** | [**CustomEnvelopeReturned**](CustomEnvelopeReturned.md) |  | [optional] |
+| **double_sided** | **Boolean** | Set this attribute to `true` for double sided printing,  `false` for for single sided printing. | [optional][default to true] |
+| **extra_service** | **String** | Add an extra service to your letter. | [optional] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **return_envelope** | [**AnyType**](.md) |  | [optional] |
+| **bleed** | **Boolean** | Allows for letter bleed. Enabled only with specific feature flags. | [optional][default to false] |
+| **file_original_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LetterDetailsReturned.new(
+  color: null,
+  cards: null,
+  address_placement: null,
+  custom_envelope: null,
+  double_sided: null,
+  extra_service: null,
+  mail_type: null,
+  return_envelope: null,
+  bleed: null,
+  file_original_url: null
+)
+```
+

data/docs/LetterDetailsWritable.md

@@ -0,0 +1,32 @@
+# Lob::LetterDetailsWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_placement** | **String** | Specifies the location of the address information that will show through the double-window envelope.  | [optional][default to 'top_first_page'] |
+| **cards** | **Array<String>** | A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. |  |
+| **color** | **Boolean** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. |  |
+| **double_sided** | **Boolean** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional][default to true] |
+| **extra_service** | **String** | Add an extra service to your letter. | [optional] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **return_envelope** | **Boolean** |  | [optional][default to false] |
+| **custom_envelope** | **String** | Accepts an envelope ID for any customized envelope with available inventory. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LetterDetailsWritable.new(
+  address_placement: null,
+  cards: null,
+  color: null,
+  double_sided: null,
+  extra_service: null,
+  mail_type: null,
+  return_envelope: null,
+  custom_envelope: null
+)
+```
+

data/docs/LetterEditable.md

@@ -0,0 +1,52 @@
+# Lob::LetterEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **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] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **merge_variables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] |
+| **send_date** | **Time** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] |
+| **color** | **Boolean** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. |  |
+| **double_sided** | **Boolean** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional][default to true] |
+| **address_placement** | **String** | Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template.   * `top_first_page` - (default) print address information at the top of your provided first page   * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page)   * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page   * `bottom_first_page` - print address information at the bottom of your provided first page  | [optional][default to 'top_first_page'] |
+| **return_envelope** | [**AnyType**](.md) | indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes.  To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. | [optional] |
+| **perforated_page** | **Integer** | Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). | [optional] |
+| **custom_envelope** | **String** |  | [optional] |
+| **to** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **file** | **String** | PDF file containing the letter's formatting. |  |
+| **extra_service** | **String** | Add an extra service to your letter:   * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet.   * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter   * `registered` - provides tracking and confirmation for international addresses  | [optional] |
+| **cards** | **Array<String>** | A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. | [optional] |
+| **billing_group_id** | **String** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] |
+| **qr_code** | [**QrCode**](QrCode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LetterEditable.new(
+  description: null,
+  metadata: null,
+  mail_type: null,
+  merge_variables: null,
+  send_date: null,
+  color: null,
+  double_sided: null,
+  address_placement: null,
+  return_envelope: null,
+  perforated_page: null,
+  custom_envelope: null,
+  to: null,
+  from: null,
+  file: null,
+  extra_service: null,
+  cards: null,
+  billing_group_id: null,
+  qr_code: null
+)
+```
+

data/docs/LetterList.md

@@ -0,0 +1,28 @@
+# Lob::LetterList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Letter>**](Letter.md) | list of letters | [optional] |
+| **object** | **String** | Value is type of resource. | [optional] |
+| **next_url** | **String** | url of next page of items in list. | [optional] |
+| **previous_url** | **String** | url of previous page of items in list. | [optional] |
+| **count** | **Integer** | number of resources in a set | [optional] |
+| **total_count** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LetterList.new(
+  data: null,
+  object: null,
+  next_url: null,
+  previous_url: null,
+  count: null,
+  total_count: null
+)
+```
+

data/docs/LettersApi.md

@@ -0,0 +1,317 @@
+# Lob::LettersApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**letter_cancel**](LettersApi.md#letter_cancel) | **DELETE** /letters/{ltr_id} | cancel |
+| [**letter_create**](LettersApi.md#letter_create) | **POST** /letters | create |
+| [**letter_retrieve**](LettersApi.md#letter_retrieve) | **GET** /letters/{ltr_id} | get |
+| [**letters_list**](LettersApi.md#letters_list) | **GET** /letters | list |
+
+
+## letter_cancel
+
+> <LetterDeletion> letter_cancel(ltr_id)
+
+cancel
+
+Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.
+
+### 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::LettersApi.new
+ltr_id = 'ltr_id_example' # String | id of the letter
+
+begin
+  # cancel
+  result = api_instance.cancel(ltr_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->cancel: #{e}"
+end
+```
+
+#### Using the letter_cancel_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LetterDeletion>, Integer, Hash)> letter_cancel_with_http_info(ltr_id)
+
+```ruby
+begin
+  # cancel
+  data, status_code, headers = api_instance.letter_cancel_with_http_info(ltr_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LetterDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->letter_cancel_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ltr_id** | **String** | id of the letter |  |
+
+### Return type
+
+[**LetterDeletion**](LetterDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## letter_create
+
+> <Letter> letter_create(letter_editable, opts)
+
+create
+
+Creates a new letter given information
+
+### 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::LettersApi.new
+letter_editable = Lob::LetterEditable.new({color: false, to: TODO, from: TODO, file: 'file_example'}) # LetterEditable | 
+opts = {
+  idempotency_key: 'idempotency_key_example' # String | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). 
+}
+
+begin
+  # create
+  result = api_instance.create(letter_editable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->create: #{e}"
+end
+```
+
+#### Using the letter_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Letter>, Integer, Hash)> letter_create_with_http_info(letter_editable, opts)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.letter_create_with_http_info(letter_editable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Letter>
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->letter_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **letter_editable** | [**LetterEditable**](LetterEditable.md) |  |  |
+| **idempotency_key** | **String** | A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request).  | [optional] |
+
+### Return type
+
+[**Letter**](Letter.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## letter_retrieve
+
+> <Letter> letter_retrieve(ltr_id)
+
+get
+
+Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter 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::LettersApi.new
+ltr_id = 'ltr_id_example' # String | id of the letter
+
+begin
+  # get
+  result = api_instance.get(ltr_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->get: #{e}"
+end
+```
+
+#### Using the letter_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Letter>, Integer, Hash)> letter_retrieve_with_http_info(ltr_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.letter_retrieve_with_http_info(ltr_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Letter>
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->letter_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ltr_id** | **String** | id of the letter |  |
+
+### Return type
+
+[**Letter**](Letter.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## letters_list
+
+> <LetterList> letters_list(opts)
+
+list
+
+Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first.
+
+### 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::LettersApi.new
+opts = {
+  limit: 56, # Integer | How many results to return.
+  before: 'before_example', # String | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. 
+  after: 'after_example', # String | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. 
+  include: ['inner_example'], # Array<String> | Request that the response include the total count by specifying `include[]=total_count`. 
+  date_created: { key: Time.now}, # Hash<String, Time> | Filter by date created.
+  metadata: { key: 'inner_example'}, # Hash<String, String> | Filter by metadata key-value pair`.
+  color: true, # Boolean | Set to `true` to return only color letters. Set to `false` to return only black & white letters.
+  scheduled: true, # Boolean | * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` 
+  send_date: { key: 'inner_example'}, # Hash<String, String> | Filter by date sent.
+  mail_type: Lob::MailType::FIRST_CLASS, # MailType | A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. 
+  sort_by: Lob::SortBy3.new # SortBy3 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. 
+}
+
+begin
+  # list
+  result = api_instance.list(opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->list: #{e}"
+end
+```
+
+#### Using the letters_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LetterList>, Integer, Hash)> letters_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.letters_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LetterList>
+rescue Lob::ApiError => e
+  puts "Error when calling LettersApi->letters_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | How many results to return. | [optional][default to 10] |
+| **before** | **String** | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.  | [optional] |
+| **after** | **String** | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.  | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.  | [optional] |
+| **date_created** | [**Hash&lt;String, Time&gt;**](Time.md) | Filter by date created. | [optional] |
+| **metadata** | [**Hash&lt;String, String&gt;**](String.md) | Filter by metadata key-value pair&#x60;. | [optional] |
+| **color** | **Boolean** | Set to &#x60;true&#x60; to return only color letters. Set to &#x60;false&#x60; to return only black &amp; white letters. | [optional] |
+| **scheduled** | **Boolean** | * &#x60;true&#x60; - only return orders (past or future) where &#x60;send_date&#x60; is greater than &#x60;date_created&#x60; * &#x60;false&#x60; - only return orders where &#x60;send_date&#x60; is equal to &#x60;date_created&#x60;  | [optional] |
+| **send_date** | [**Hash&lt;String, String&gt;**](String.md) | Filter by date sent. | [optional] |
+| **mail_type** | [**MailType**](.md) | A string designating the mail postage type: * &#x60;usps_first_class&#x60; - (default) * &#x60;usps_standard&#x60; - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. &#x60;usps_standard&#x60; cannot be used with &#x60;4x6&#x60; postcards or for any postcards sent outside of the United States.  | [optional][default to &#39;usps_first_class&#39;] |
+| **sort_by** | [**SortBy3**](.md) | Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.  | [optional] |
+
+### Return type
+
+[**LetterList**](LetterList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/LobConfidenceScore.md

@@ -0,0 +1,20 @@
+# Lob::LobConfidenceScore
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **score** | **Float** | A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address.  | [optional] |
+| **level** | **String** | indicates the likelihood that the address is a valid, mail-receiving address. Possible values are:   - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful.   - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully.   - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful.   - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LobConfidenceScore.new(
+  score: null,
+  level: null
+)
+```
+

data/docs/LobError.md

@@ -0,0 +1,22 @@
+# Lob::LobError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A human-readable message with more details about the error | [optional] |
+| **status_code** | **Integer** | A conventional HTTP status code. | [optional] |
+| **code** | **String** | A pre-defined string identifying an error. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LobError.new(
+  message: null,
+  status_code: null,
+  code: null
+)
+```
+

data/docs/Location.md

@@ -0,0 +1,20 @@
+# Lob::Location
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** | A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map.  |  |
+| **longitude** | **Float** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map.  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Location.new(
+  latitude: null,
+  longitude: null
+)
+```
+

data/docs/LocationAnalysis.md

@@ -0,0 +1,22 @@
+# Lob::LocationAnalysis
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **latitude** | **Float** | A positive or negative decimal indicating the geographic latitude of the address. |  |
+| **longitude** | **Float** | A positive or negative decimal indicating the geographic longitude of the address. |  |
+| **distance** | **Float** | The distance from the input location to this exact zip code in miles. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::LocationAnalysis.new(
+  latitude: null,
+  longitude: null,
+  distance: null
+)
+```
+

data/docs/MailType.md

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

data/docs/MultiLineAddress.md

@@ -0,0 +1,32 @@
+# Lob::MultiLineAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **company** | **String** | Either `name` or `company` is required, you may also add both. | [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`  |  |
+| **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] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** | The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> 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] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::MultiLineAddress.new(
+  recipient: null,
+  company: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  city: null,
+  state: null,
+  zip_code: null
+)
+```
+

data/docs/MultipleComponents.md

@@ -0,0 +1,30 @@
+# Lob::MultipleComponents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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`  |  |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::MultipleComponents.new(
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  city: null,
+  state: null,
+  zip_code: null
+)
+```
+