lob 6.0.8 → 6.1.0

data/docs/CmpScheduleType.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CmpScheduleType.new()
 ```

data/docs/CmpUseType.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CmpUseType.new()
 ```

data/docs/CountryExtended.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CountryExtended.new()
 ```

data/docs/CountryExtendedExpanded.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CountryExtendedExpanded.new()
 ```

data/docs/CreativePatch.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CreativePatch.new(
   from: null,

data/docs/CreativeResponse.md

@@ -21,7 +21,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CreativeResponse.new(
   id: null,

data/docs/CreativeWritable.md

@@ -17,7 +17,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CreativeWritable.new(
   from: null,

data/docs/CreativesApi.md

@@ -21,7 +21,7 @@ Creates a new creative with the provided properties
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -95,7 +95,7 @@ Retrieves the details of an existing creative. You need only supply the unique c
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -165,7 +165,7 @@ Update the details of an existing creative. You need only supply the unique iden
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/CustomEnvelopeReturned.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::CustomEnvelopeReturned.new(
   id: null,

data/docs/DefaultApi.md

@@ -19,7 +19,7 @@ Don't call this. It's so that the right models can be generated.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/DeliverabilityAnalysis.md

@@ -23,24 +23,24 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::DeliverabilityAnalysis.new(
-  dpv_confirmation: nil,
-  dpv_cmra: nil,
-  dpv_vacant: nil,
-  dpv_active: nil,
-  dpv_inactive_reason: nil,
-  dpv_throwback: nil,
-  dpv_non_delivery_day_flag: nil,
-  dpv_non_delivery_day_values: nil,
-  dpv_no_secure_location: nil,
-  dpv_door_not_accessible: nil,
-  dpv_footnotes: nil,
-  ews_match: nil,
-  lacs_indicator: nil,
-  lacs_return_code: nil,
-  suite_return_code: nil
+  dpv_confirmation: null,
+  dpv_cmra: null,
+  dpv_vacant: null,
+  dpv_active: null,
+  dpv_inactive_reason: null,
+  dpv_throwback: null,
+  dpv_non_delivery_day_flag: null,
+  dpv_non_delivery_day_values: null,
+  dpv_no_secure_location: null,
+  dpv_door_not_accessible: null,
+  dpv_footnotes: null,
+  ews_match: null,
+  lacs_indicator: null,
+  lacs_return_code: null,
+  suite_return_code: null
 )
 ```
 

data/docs/DpvFootnote.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::DpvFootnote.new()
 ```

data/docs/EngineHtml.md

@@ -8,7 +8,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::EngineHtml.new()
 ```

data/docs/EventType.md

@@ -12,7 +12,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::EventType.new(
   id: null,

data/docs/Events.md

@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::Events.new(
   id: null,

data/docs/Export.md

@@ -16,7 +16,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::Export.new(
   id: null,

data/docs/ExportModel.md

@@ -9,7 +9,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::ExportModel.new(
   type: null

data/docs/GeocodeAddresses.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::GeocodeAddresses.new(
   components: null,

data/docs/GeocodeComponents.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::GeocodeComponents.new(
   zip_code: null,

data/docs/HTTPValidationError.md

@@ -9,7 +9,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::HTTPValidationError.new(
   detail: null

data/docs/IdentityValidation.md

@@ -17,7 +17,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IdentityValidation.new(
   id: null,

data/docs/IdentityValidationApi.md

@@ -19,7 +19,7 @@ Validates whether a given name is associated with an address.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/InlineObject.md

@@ -9,7 +9,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::InlineObject.new(
   file: null

data/docs/IntlAddress.md

@@ -14,8 +14,8 @@
 | **address_line1** | **String** |  | [optional] |
 | **address_line2** | **String** |  | [optional] |
 | **address_city** | **String** |  | [optional] |
-| **address_state** | **String** | 2 letter state short-name code | [optional] |
-| **address_zip** | **String** | Must have a maximum of 12 characters  | [optional] |
+| **address_state** | **String** | Must be no longer than 200 characters. | [optional] |
+| **address_zip** | **String** | Must be no longer than 40 characters. | [optional] |
 | **address_country** | [**CountryExtendedExpandedNoUs**](CountryExtendedExpandedNoUs.md) |  | [optional] |
 | **object** | **String** |  | [optional][default to 'address'] |
 | **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |

data/docs/IntlAutocompletions.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlAutocompletions.new(
   id: null,

data/docs/IntlAutocompletionsApi.md

@@ -19,7 +19,7 @@ Given an address prefix consisting of a partial primary line and country, as wel
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -28,7 +28,7 @@ Lob.configure do |config|
 end
 
 api_instance = Lob::IntlAutocompletionsApi.new
-intl_autocompletions_writable = Lob::IntlAutocompletionsWritable.new({address_prefix: 'address_prefix_example', country: Lob::CountryExtended::AD}) # IntlAutocompletionsWritable | 
+intl_autocompletions_writable = Lob::IntlAutocompletionsWritable.new({address_prefix: 'address_prefix_example', country: Lob::CountryExtended::EMPTY}) # IntlAutocompletionsWritable | 
 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. 
 }

data/docs/IntlAutocompletionsWritable.md

@@ -13,7 +13,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlAutocompletionsWritable.new(
   address_prefix: null,

data/docs/IntlComponents.md

@@ -13,7 +13,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlComponents.new(
   primary_number: null,

data/docs/IntlSuggestions.md

@@ -15,7 +15,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlSuggestions.new(
   primary_number_range: null,

data/docs/IntlVerification.md

@@ -19,7 +19,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlVerification.new(
   id: null,

data/docs/IntlVerificationOrError.md

@@ -20,7 +20,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlVerificationOrError.new(
   id: null,

data/docs/IntlVerificationWritable.md

@@ -16,7 +16,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlVerificationWritable.new(
   recipient: null,

data/docs/IntlVerifications.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlVerifications.new(
   addresses: null,

data/docs/IntlVerificationsApi.md

@@ -20,7 +20,7 @@ Verify a list of international (except US or US territories) address with a live
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -29,7 +29,7 @@ Lob.configure do |config|
 end
 
 api_instance = Lob::IntlVerificationsApi.new
-intl_verifications_payload = Lob::IntlVerificationsPayload.new({addresses: [Lob::MultipleComponentsIntl.new({primary_line: 'primary_line_example', country: Lob::CountryExtended::AD})]}) # IntlVerificationsPayload | 
+intl_verifications_payload = Lob::IntlVerificationsPayload.new({addresses: [Lob::MultipleComponentsIntl.new({primary_line: 'primary_line_example', country: Lob::CountryExtended::EMPTY})]}) # IntlVerificationsPayload | 
 
 begin
   # verifyBulk
@@ -90,7 +90,7 @@ Verify an international (except US or US territories) address with a live API ke
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/IntlVerificationsPayload.md

@@ -9,7 +9,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::IntlVerificationsPayload.new(
   addresses: null

data/docs/Letter.md

@@ -32,11 +32,13 @@
 | **return_envelope** | [**AnyType**](.md) |  |  |
 | **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** | [**LetterCustomEnvelope**](LetterCustomEnvelope.md) |  | [optional] |
+| **campaign_id** | **String** | The unique ID of the associated campaign if the resource was generated from a campaign. | [optional] |
+| **use_type** | [**LtrUseType**](LtrUseType.md) |  |  |
 
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::Letter.new(
   to: null,
@@ -66,7 +68,9 @@ instance = Lob::Letter.new(
   address_placement: null,
   return_envelope: null,
   perforated_page: null,
-  custom_envelope: null
+  custom_envelope: null,
+  campaign_id: null,
+  use_type: null
 )
 ```
 

data/docs/LetterCustomEnvelope.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterCustomEnvelope.new(
   id: null,

data/docs/LetterDeletion.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterDeletion.new(
   id: null,

data/docs/LetterDetailsReturned.md

@@ -18,7 +18,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterDetailsReturned.new(
   color: null,

data/docs/LetterDetailsWritable.md

@@ -16,7 +16,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterDetailsWritable.new(
   address_placement: null,

data/docs/LetterEditable.md

@@ -22,11 +22,12 @@
 | **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] |
+| **use_type** | [**LtrUseType**](LtrUseType.md) |  |  |
 
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterEditable.new(
   description: null,
@@ -46,7 +47,8 @@ instance = Lob::LetterEditable.new(
   extra_service: null,
   cards: null,
   billing_group_id: null,
-  qr_code: null
+  qr_code: null,
+  use_type: null
 )
 ```
 

data/docs/LetterList.md

@@ -14,7 +14,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LetterList.new(
   data: null,

data/docs/LettersApi.md

@@ -22,7 +22,7 @@ Completely removes a letter from production. This can only be done if the letter
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -92,7 +92,7 @@ Creates a new letter given information
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -101,9 +101,10 @@ Lob.configure do |config|
 end
 
 api_instance = Lob::LettersApi.new
-letter_editable = Lob::LetterEditable.new({color: false, to: TODO, from: TODO, file: 'file_example'}) # LetterEditable | 
+letter_editable = Lob::LetterEditable.new({color: false, to: TODO, from: TODO, file: 'file_example', use_type: Lob::LtrUseType::MARKETING}) # 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). 
+  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). 
+  file: TODO # Object | An optional file upload as either a byte array or file type. 
 }
 
 begin
@@ -139,6 +140,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **file** | [**Object**](.md) | An optional file upload as either a byte array or file type.  | [optional] |
 
 ### Return type
 
@@ -166,7 +168,7 @@ Retrieves the details of an existing letter. You need only supply the unique let
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -236,7 +238,7 @@ Returns a list of your letters. The letters are returned sorted by creation date
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -256,7 +258,7 @@ opts = {
   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. 
+  sort_by: Lob::SortBy4.new # SortBy4 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. 
 }
 
 begin
@@ -300,7 +302,7 @@ end
 | **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] |
+| **sort_by** | [**SortBy4**](.md) | Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.  | [optional] |
 
 ### Return type
 

data/docs/LobConfidenceScore.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LobConfidenceScore.new(
   score: null,

data/docs/LobError.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LobError.new(
   message: null,

data/docs/Location.md

@@ -10,7 +10,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::Location.new(
   latitude: null,

data/docs/LocationAnalysis.md

@@ -11,7 +11,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::LocationAnalysis.new(
   latitude: null,