lob 6.0.0.pre.rc → 6.0.0

data/docs/LettersApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LettersApi
+# Lob::LettersApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -24,20 +24,20 @@ Completely removes a letter from production. This can only be done if the letter
 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::LettersApi.new
+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 OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->cancel: #{e}"
 end
 ```
@@ -55,7 +55,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <LetterDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->letter_cancel_with_http_info: #{e}"
 end
 ```
@@ -94,14 +94,14 @@ Creates a new letter 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::LettersApi.new
-letter_editable = OpenapiClient::LetterEditable.new({color: false, to: TODO, from: TODO, file: 'file_example'}) # LetterEditable | 
+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). 
 }
@@ -110,7 +110,7 @@ begin
   # create
   result = api_instance.create(letter_editable, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->create: #{e}"
 end
 ```
@@ -128,7 +128,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Letter>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->letter_create_with_http_info: #{e}"
 end
 ```
@@ -168,20 +168,20 @@ Retrieves the details of an existing letter. You need only supply the unique let
 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::LettersApi.new
+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 OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->get: #{e}"
 end
 ```
@@ -199,7 +199,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Letter>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->letter_retrieve_with_http_info: #{e}"
 end
 ```
@@ -238,13 +238,13 @@ Returns a list of your letters. The letters 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::LettersApi.new
+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. 
@@ -255,15 +255,15 @@ opts = {
   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: 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 LettersApi->list: #{e}"
 end
 ```
@@ -281,7 +281,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <LetterList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling LettersApi->letters_list_with_http_info: #{e}"
 end
 ```

data/docs/LobConfidenceScore.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LobConfidenceScore
+# Lob::LobConfidenceScore
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::LobConfidenceScore.new(
+instance = Lob::LobConfidenceScore.new(
   score: null,
   level: null
 )

data/docs/LobError.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LobError
+# Lob::LobError
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::LobError.new(
+instance = Lob::LobError.new(
   message: null,
   status_code: null,
   code: null

data/docs/Location.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Location
+# Lob::Location
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::Location.new(
+instance = Lob::Location.new(
   latitude: null,
   longitude: null
 )

data/docs/LocationAnalysis.md

@@ -1,4 +1,4 @@
-# OpenapiClient::LocationAnalysis
+# Lob::LocationAnalysis
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::LocationAnalysis.new(
+instance = Lob::LocationAnalysis.new(
   latitude: null,
   longitude: null,
   distance: null

data/docs/MailType.md

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

data/docs/MultiLineAddress.md

@@ -1,4 +1,4 @@
-# OpenapiClient::MultiLineAddress
+# Lob::MultiLineAddress
 
 ## Properties
 
@@ -18,7 +18,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::MultiLineAddress.new(
+instance = Lob::MultiLineAddress.new(
   recipient: null,
   company: null,
   primary_line: null,

data/docs/MultipleComponents.md

@@ -1,4 +1,4 @@
-# OpenapiClient::MultipleComponents
+# Lob::MultipleComponents
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::MultipleComponents.new(
+instance = Lob::MultipleComponents.new(
   recipient: null,
   primary_line: null,
   secondary_line: null,

data/docs/MultipleComponentsIntl.md

@@ -1,4 +1,4 @@
-# OpenapiClient::MultipleComponentsIntl
+# Lob::MultipleComponentsIntl
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::MultipleComponentsIntl.new(
+instance = Lob::MultipleComponentsIntl.new(
   recipient: null,
   primary_line: null,
   secondary_line: null,

data/docs/MultipleComponentsList.md

@@ -1,4 +1,4 @@
-# OpenapiClient::MultipleComponentsList
+# Lob::MultipleComponentsList
 
 ## Properties
 
@@ -11,7 +11,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::MultipleComponentsList.new(
+instance = Lob::MultipleComponentsList.new(
   addresses: null
 )
 ```

data/docs/PlaceholderModel.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PlaceholderModel
+# Lob::PlaceholderModel
 
 ## Properties
 
@@ -16,7 +16,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::PlaceholderModel.new(
+instance = Lob::PlaceholderModel.new(
   return_envelope: null,
   address_domestic: null,
   letter_details_writable: null,

data/docs/Postcard.md

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

data/docs/PostcardDeletion.md

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

data/docs/PostcardDetailsReturned.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PostcardDetailsReturned
+# Lob::PostcardDetailsReturned
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::PostcardDetailsReturned.new(
+instance = Lob::PostcardDetailsReturned.new(
   mail_type: null,
   size: null,
   setting: null,

data/docs/PostcardDetailsWritable.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PostcardDetailsWritable
+# Lob::PostcardDetailsWritable
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::PostcardDetailsWritable.new(
+instance = Lob::PostcardDetailsWritable.new(
   mail_type: null,
   size: null
 )

data/docs/PostcardEditable.md

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

data/docs/PostcardList.md

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

data/docs/PostcardSize.md

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

data/docs/PostcardsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::PostcardsApi
+# Lob::PostcardsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -24,14 +24,14 @@ Creates a new postcard 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::PostcardsApi.new
-postcard_editable = OpenapiClient::PostcardEditable.new({to: TODO, front: 'front_example', back: 'back_example'}) # PostcardEditable | 
+api_instance = Lob::PostcardsApi.new
+postcard_editable = Lob::PostcardEditable.new({to: TODO, front: 'front_example', back: 'back_example'}) # PostcardEditable | 
 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). 
 }
@@ -40,7 +40,7 @@ begin
   # create
   result = api_instance.create(postcard_editable, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->create: #{e}"
 end
 ```
@@ -58,7 +58,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Postcard>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->postcard_create_with_http_info: #{e}"
 end
 ```
@@ -98,20 +98,20 @@ Completely removes a postcard from production. This can only be done if the post
 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::PostcardsApi.new
+api_instance = Lob::PostcardsApi.new
 psc_id = 'psc_id_example' # String | id of the postcard
 
 begin
   # cancel
   result = api_instance.cancel(psc_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->cancel: #{e}"
 end
 ```
@@ -129,7 +129,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <PostcardDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->postcard_delete_with_http_info: #{e}"
 end
 ```
@@ -168,20 +168,20 @@ Retrieves the details of an existing postcard. 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::PostcardsApi.new
+api_instance = Lob::PostcardsApi.new
 psc_id = 'psc_id_example' # String | id of the postcard
 
 begin
   # get
   result = api_instance.get(psc_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->get: #{e}"
 end
 ```
@@ -199,7 +199,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Postcard>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->postcard_retrieve_with_http_info: #{e}"
 end
 ```
@@ -238,13 +238,13 @@ Returns a list of your postcards. The addresses are returned sorted by creation
 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::PostcardsApi.new
+api_instance = Lob::PostcardsApi.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. 
@@ -252,18 +252,18 @@ opts = {
   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`.
-  size: [OpenapiClient::PostcardSize::N4X6], # Array<PostcardSize> | Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations.
+  size: [Lob::PostcardSize::N4X6], # Array<PostcardSize> | Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations.
   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 PostcardsApi->list: #{e}"
 end
 ```
@@ -281,7 +281,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <PostcardList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling PostcardsApi->postcards_list_with_http_info: #{e}"
 end
 ```

data/docs/QrCode.md

@@ -1,4 +1,4 @@
-# OpenapiClient::QrCode
+# Lob::QrCode
 
 ## Properties
 
@@ -17,7 +17,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::QrCode.new(
+instance = Lob::QrCode.new(
   position: null,
   top: null,
   right: null,

data/docs/ReturnEnvelope.md

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

data/docs/ReverseGeocode.md

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

data/docs/ReverseGeocodeLookupsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::ReverseGeocodeLookupsApi
+# Lob::ReverseGeocodeLookupsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -21,14 +21,14 @@ Reverse geocode a valid US location with a live API key.
 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::ReverseGeocodeLookupsApi.new
-location = OpenapiClient::Location.new({latitude: 3.56, longitude: 3.56}) # Location | 
+api_instance = Lob::ReverseGeocodeLookupsApi.new
+location = Lob::Location.new({latitude: 3.56, longitude: 3.56}) # Location | 
 opts = {
   size: 56 # Integer | Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations.
 }
@@ -37,7 +37,7 @@ begin
   # lookup
   result = api_instance.lookup(location, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ReverseGeocodeLookupsApi->lookup: #{e}"
 end
 ```
@@ -55,7 +55,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ReverseGeocode>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling ReverseGeocodeLookupsApi->reverse_geocode_lookup_with_http_info: #{e}"
 end
 ```

data/docs/SelfMailer.md

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