lob 6.0.0.pre.rc → 6.0.0

data/docs/CardsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CardsApi
+# Lob::CardsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -25,20 +25,20 @@ Creates a new card given information
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CardsApi.new
-card_editable = OpenapiClient::CardEditable.new({front: 'front_example'}) # CardEditable | 
+api_instance = Lob::CardsApi.new
+card_editable = Lob::CardEditable.new({front: 'front_example'}) # CardEditable | 
 
 begin
   # create
   result = api_instance.create(card_editable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->create: #{e}"
 end
 ```
@@ -56,7 +56,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Card>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->card_create_with_http_info: #{e}"
 end
 ```
@@ -95,20 +95,20 @@ Delete an existing card. You need only supply the unique identifier that was ret
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CardsApi.new
+api_instance = Lob::CardsApi.new
 card_id = 'card_id_example' # String | id of the card
 
 begin
   # delete
   result = api_instance.delete(card_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->delete: #{e}"
 end
 ```
@@ -126,7 +126,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CardDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->card_delete_with_http_info: #{e}"
 end
 ```
@@ -165,20 +165,20 @@ Retrieves the details of an existing card. You need only supply the unique custo
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CardsApi.new
+api_instance = Lob::CardsApi.new
 card_id = 'card_id_example' # String | id of the card
 
 begin
   # get
   result = api_instance.get(card_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->get: #{e}"
 end
 ```
@@ -196,7 +196,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Card>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->card_retrieve_with_http_info: #{e}"
 end
 ```
@@ -235,21 +235,21 @@ Update the details of an existing card. You need only supply the unique identifi
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CardsApi.new
+api_instance = Lob::CardsApi.new
 card_id = 'card_id_example' # String | id of the card
-card_updatable = OpenapiClient::CardUpdatable.new # CardUpdatable | 
+card_updatable = Lob::CardUpdatable.new # CardUpdatable | 
 
 begin
   # update
   result = api_instance.update(card_id, card_updatable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->update: #{e}"
 end
 ```
@@ -267,7 +267,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Card>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->card_update_with_http_info: #{e}"
 end
 ```
@@ -307,13 +307,13 @@ Returns a list of your cards. The cards are returned sorted by creation date, wi
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CardsApi.new
+api_instance = Lob::CardsApi.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. 
@@ -325,7 +325,7 @@ begin
   # list
   result = api_instance.list(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->list: #{e}"
 end
 ```
@@ -343,7 +343,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CardList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CardsApi->cards_list_with_http_info: #{e}"
 end
 ```

data/docs/Check.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Check
+# Lob::Check
 
 ## Properties
 
@@ -36,7 +36,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::Check.new(
+instance = Lob::Check.new(
   id: null,
   to: null,
   from: null,

data/docs/CheckDeletion.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CheckDeletion
+# Lob::CheckDeletion
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CheckDeletion.new(
+instance = Lob::CheckDeletion.new(
   id: null,
   deleted: null,
   object: null

data/docs/CheckEditable.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CheckEditable
+# Lob::CheckEditable
 
 ## Properties
 
@@ -26,7 +26,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CheckEditable.new(
+instance = Lob::CheckEditable.new(
   from: null,
   to: null,
   bank_account: null,

data/docs/CheckList.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CheckList
+# Lob::CheckList
 
 ## Properties
 
@@ -16,7 +16,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CheckList.new(
+instance = Lob::CheckList.new(
   data: null,
   object: null,
   next_url: null,

data/docs/ChecksApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ChecksApi
+# Lob::ChecksApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -24,20 +24,20 @@ Completely removes a check from production. This can only be done if the check h
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::ChecksApi.new
+api_instance = Lob::ChecksApi.new
 chk_id = 'chk_id_example' # String | id of the check
 
 begin
   # cancel
   result = api_instance.cancel(chk_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->cancel: #{e}"
 end
 ```
@@ -55,7 +55,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CheckDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->check_cancel_with_http_info: #{e}"
 end
 ```
@@ -94,14 +94,14 @@ Creates a new check with the provided properties.
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::ChecksApi.new
-check_editable = OpenapiClient::CheckEditable.new({from: TODO, to: TODO, bank_account: 'bank_account_example', amount: 3.56}) # CheckEditable | 
+api_instance = Lob::ChecksApi.new
+check_editable = Lob::CheckEditable.new({from: TODO, to: TODO, bank_account: 'bank_account_example', amount: 3.56}) # CheckEditable | 
 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). 
 }
@@ -110,7 +110,7 @@ begin
   # create
   result = api_instance.create(check_editable, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->create: #{e}"
 end
 ```
@@ -128,7 +128,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Check>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->check_create_with_http_info: #{e}"
 end
 ```
@@ -168,20 +168,20 @@ Retrieves the details of an existing check. You need only supply the unique chec
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::ChecksApi.new
+api_instance = Lob::ChecksApi.new
 chk_id = 'chk_id_example' # String | id of the check
 
 begin
   # get
   result = api_instance.get(chk_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->get: #{e}"
 end
 ```
@@ -199,7 +199,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Check>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->check_retrieve_with_http_info: #{e}"
 end
 ```
@@ -238,13 +238,13 @@ Returns a list of your checks. The checks are returned sorted by creation date,
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::ChecksApi.new
+api_instance = Lob::ChecksApi.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. 
@@ -254,15 +254,15 @@ opts = {
   metadata: { key: 'inner_example'}, # Hash<String, String> | Filter by metadata key-value pair`.
   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: OpenapiClient::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: OpenapiClient::SortBy3.new # SortBy3 | Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. 
+  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 OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->list: #{e}"
 end
 ```
@@ -280,7 +280,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CheckList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ChecksApi->checks_list_with_http_info: #{e}"
 end
 ```

data/docs/CmpScheduleType.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CmpScheduleType
+# Lob::CmpScheduleType
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CmpScheduleType.new()
+instance = Lob::CmpScheduleType.new()
 ```
 

data/docs/CmpUseType.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CmpUseType
+# Lob::CmpUseType
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CmpUseType.new()
+instance = Lob::CmpUseType.new()
 ```
 

data/docs/CountryExtended.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CountryExtended
+# Lob::CountryExtended
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CountryExtended.new()
+instance = Lob::CountryExtended.new()
 ```
 

data/docs/CountryExtendedExpanded.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CountryExtendedExpanded
+# Lob::CountryExtendedExpanded
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CountryExtendedExpanded.new()
+instance = Lob::CountryExtendedExpanded.new()
 ```
 

data/docs/CreativePatch.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CreativePatch
+# Lob::CreativePatch
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CreativePatch.new(
+instance = Lob::CreativePatch.new(
   from: null,
   description: null,
   metadata: null

data/docs/CreativeResponse.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CreativeResponse
+# Lob::CreativeResponse
 
 ## Properties
 
@@ -23,7 +23,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CreativeResponse.new(
+instance = Lob::CreativeResponse.new(
   id: null,
   description: null,
   from: null,

data/docs/CreativeWritable.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CreativeWritable
+# Lob::CreativeWritable
 
 ## Properties
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CreativeWritable.new(
+instance = Lob::CreativeWritable.new(
   from: null,
   description: null,
   metadata: null,

data/docs/CreativesApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CreativesApi
+# Lob::CreativesApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -23,14 +23,14 @@ Creates a new creative with the provided properties
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CreativesApi.new
-creative_writable = OpenapiClient::CreativeWritable.new({from: TODO, resource_type: 'letter', campaign_id: 'campaign_id_example'}) # CreativeWritable | 
+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. 
 }
@@ -39,7 +39,7 @@ begin
   # create
   result = api_instance.create(creative_writable, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->create: #{e}"
 end
 ```
@@ -57,7 +57,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CreativeResponse>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->creative_create_with_http_info: #{e}"
 end
 ```
@@ -97,20 +97,20 @@ Retrieves the details of an existing creative. You need only supply the unique c
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CreativesApi.new
+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 OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->get: #{e}"
 end
 ```
@@ -128,7 +128,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CreativeResponse>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->creative_retrieve_with_http_info: #{e}"
 end
 ```
@@ -167,21 +167,21 @@ Update the details of an existing creative. You need only supply the unique iden
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::CreativesApi.new
+api_instance = Lob::CreativesApi.new
 crv_id = 'crv_id_example' # String | id of the creative
-creative_patch = OpenapiClient::CreativePatch.new # CreativePatch | 
+creative_patch = Lob::CreativePatch.new # CreativePatch | 
 
 begin
   # update
   result = api_instance.update(crv_id, creative_patch)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->update: #{e}"
 end
 ```
@@ -199,7 +199,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <CreativeResponse>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling CreativesApi->creative_update_with_http_info: #{e}"
 end
 ```

data/docs/CustomEnvelopeReturned.md

@@ -1,4 +1,4 @@
-# OpenapiClient::CustomEnvelopeReturned
+# Lob::CustomEnvelopeReturned
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::CustomEnvelopeReturned.new(
+instance = Lob::CustomEnvelopeReturned.new(
   id: null,
   url: null,
   object: null

data/docs/DefaultApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::DefaultApi
+# Lob::DefaultApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -21,19 +21,19 @@ Don't call this. It's so that the right models can be generated.
 require 'time'
 require 'openapi_client'
 # setup authorization
-OpenapiClient.configure do |config|
+Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
-api_instance = OpenapiClient::DefaultApi.new
+api_instance = Lob::DefaultApi.new
 
 begin
   # placeholder_no_call
   result = api_instance.placeholder_no_call
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling DefaultApi->placeholder_no_call: #{e}"
 end
 ```
@@ -51,7 +51,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <PlaceholderModel>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling DefaultApi->placeholder_with_http_info: #{e}"
 end
 ```

data/docs/DeliverabilityAnalysis.md

@@ -1,4 +1,4 @@
-# OpenapiClient::DeliverabilityAnalysis
+# Lob::DeliverabilityAnalysis
 
 ## Properties
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::DeliverabilityAnalysis.new(
+instance = Lob::DeliverabilityAnalysis.new(
   dpv_confirmation: null,
   dpv_cmra: null,
   dpv_vacant: null,

data/docs/DpvFootnote.md

@@ -1,4 +1,4 @@
-# OpenapiClient::DpvFootnote
+# Lob::DpvFootnote
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::DpvFootnote.new()
+instance = Lob::DpvFootnote.new()
 ```