lob 6.0.0.pre.rc → 6.0.0

data/docs/TemplatesApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TemplatesApi
+# Lob::TemplatesApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -25,20 +25,20 @@ Creates a new template for use with the Print & Mail API. In Live mode, you can
 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::TemplatesApi.new
-template_writable = OpenapiClient::TemplateWritable.new({html: 'html_example'}) # TemplateWritable | 
+api_instance = Lob::TemplatesApi.new
+template_writable = Lob::TemplateWritable.new({html: 'html_example'}) # TemplateWritable | 
 
 begin
   # create
   result = api_instance.create(template_writable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->create: #{e}"
 end
 ```
@@ -56,7 +56,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Template>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
 end
 ```
@@ -95,20 +95,20 @@ Permanently deletes a template.
 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::TemplatesApi.new
+api_instance = Lob::TemplatesApi.new
 tmpl_id = 'tmpl_id_example' # String | id of the template
 
 begin
   # delete
   result = api_instance.delete(tmpl_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->delete: #{e}"
 end
 ```
@@ -126,7 +126,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->template_delete_with_http_info: #{e}"
 end
 ```
@@ -165,20 +165,20 @@ Retrieves the details of an existing template.
 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::TemplatesApi.new
+api_instance = Lob::TemplatesApi.new
 tmpl_id = 'tmpl_id_example' # String | id of the template
 
 begin
   # get
   result = api_instance.get(tmpl_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->get: #{e}"
 end
 ```
@@ -196,7 +196,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Template>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->template_retrieve_with_http_info: #{e}"
 end
 ```
@@ -235,21 +235,21 @@ Updates the description and/or published version of the template with the given
 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::TemplatesApi.new
+api_instance = Lob::TemplatesApi.new
 tmpl_id = 'tmpl_id_example' # String | id of the template
-template_update = OpenapiClient::TemplateUpdate.new # TemplateUpdate | 
+template_update = Lob::TemplateUpdate.new # TemplateUpdate | 
 
 begin
   # update
   result = api_instance.update(tmpl_id, template_update)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->update: #{e}"
 end
 ```
@@ -267,7 +267,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Template>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->template_update_with_http_info: #{e}"
 end
 ```
@@ -307,13 +307,13 @@ Returns a list of your templates. The templates 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::TemplatesApi.new
+api_instance = Lob::TemplatesApi.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. 
@@ -327,7 +327,7 @@ begin
   # list
   result = api_instance.list(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->list: #{e}"
 end
 ```
@@ -345,7 +345,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplatesApi->templates_list_with_http_info: #{e}"
 end
 ```

data/docs/Thumbnail.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Thumbnail
+# Lob::Thumbnail
 
 ## Properties
 
@@ -13,7 +13,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::Thumbnail.new(
+instance = Lob::Thumbnail.new(
   small: null,
   medium: null,
   large: null

data/docs/TrackingEventCertified.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackingEventCertified
+# Lob::TrackingEventCertified
 
 ## Properties
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::TrackingEventCertified.new(
+instance = Lob::TrackingEventCertified.new(
   type: null,
   name: null,
   details: null,

data/docs/TrackingEventDetails.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackingEventDetails
+# Lob::TrackingEventDetails
 
 ## Properties
 
@@ -14,7 +14,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::TrackingEventDetails.new(
+instance = Lob::TrackingEventDetails.new(
   event: null,
   description: null,
   notes: null,

data/docs/TrackingEventNormal.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TrackingEventNormal
+# Lob::TrackingEventNormal
 
 ## Properties
 
@@ -19,7 +19,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::TrackingEventNormal.new(
+instance = Lob::TrackingEventNormal.new(
   type: null,
   name: null,
   details: null,

data/docs/Upload.md

@@ -1,4 +1,4 @@
-# OpenapiClient::Upload
+# Lob::Upload
 
 ## Properties
 
@@ -24,7 +24,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::Upload.new(
+instance = Lob::Upload.new(
   id: null,
   account_id: null,
   campaign_id: null,

data/docs/UploadCreateExport.md

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

data/docs/UploadFile.md

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

data/docs/UploadState.md

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

data/docs/UploadUpdatable.md

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

data/docs/UploadWritable.md

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

data/docs/UploadsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UploadsApi
+# Lob::UploadsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -28,13 +28,13 @@ Retrieves the details of an existing export. You need only supply the unique exp
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | ID of the upload
 ex_id = 'ex_id_example' # String | ID of the export
 
@@ -42,7 +42,7 @@ begin
   # get_export
   result = api_instance.get_export(upl_id, ex_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->get_export: #{e}"
 end
 ```
@@ -60,7 +60,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Export>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->export_retrieve_with_http_info: #{e}"
 end
 ```
@@ -100,20 +100,20 @@ Creates a new upload 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::UploadsApi.new
-upload_writable = OpenapiClient::UploadWritable.new({campaign_id: 'campaign_id_example'}) # UploadWritable | 
+api_instance = Lob::UploadsApi.new
+upload_writable = Lob::UploadWritable.new({campaign_id: 'campaign_id_example'}) # UploadWritable | 
 
 begin
   # create_upload
   result = api_instance.create_upload(upload_writable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->create_upload: #{e}"
 end
 ```
@@ -131,7 +131,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Upload>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_create_with_http_info: #{e}"
 end
 ```
@@ -170,19 +170,19 @@ Delete an existing upload. You need only supply the unique identifier that was r
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | id of the upload
 
 begin
   # delete_upload
   api_instance.delete_upload(upl_id)
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->delete_upload: #{e}"
 end
 ```
@@ -200,7 +200,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_delete_with_http_info: #{e}"
 end
 ```
@@ -239,21 +239,21 @@ Campaign Exports can help you understand exactly which records in a campaign cou
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | ID of the upload
-export_model = OpenapiClient::ExportModel.new # ExportModel | 
+export_model = Lob::ExportModel.new # ExportModel | 
 
 begin
   # create_export
   result = api_instance.create_export(upl_id, export_model)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->create_export: #{e}"
 end
 ```
@@ -271,7 +271,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UploadCreateExport>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_export_create_with_http_info: #{e}"
 end
 ```
@@ -311,13 +311,13 @@ Upload an [audience file](https://help.lob.com/best-practices/campaign-audience-
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | ID of the upload
 file = TODO # AnyType | 
 
@@ -325,7 +325,7 @@ begin
   # upload_file
   result = api_instance.upload_file(upl_id, file)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_file: #{e}"
 end
 ```
@@ -343,7 +343,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UploadFile>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_file_create_with_http_info: #{e}"
 end
 ```
@@ -383,20 +383,20 @@ Retrieves the details of an existing upload. You need only supply the unique upl
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | id of the upload
 
 begin
   # get_upload
   result = api_instance.get_upload(upl_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->get_upload: #{e}"
 end
 ```
@@ -414,7 +414,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Upload>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_retrieve_with_http_info: #{e}"
 end
 ```
@@ -453,21 +453,21 @@ Update the details of an existing upload. You need only supply the unique identi
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 upl_id = 'upl_id_example' # String | id of the upload
-upload_updatable = OpenapiClient::UploadUpdatable.new # UploadUpdatable | 
+upload_updatable = Lob::UploadUpdatable.new # UploadUpdatable | 
 
 begin
   # update_upload
   result = api_instance.update_upload(upl_id, upload_updatable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->update_upload: #{e}"
 end
 ```
@@ -485,7 +485,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Upload>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->upload_update_with_http_info: #{e}"
 end
 ```
@@ -525,13 +525,13 @@ Returns a list of your uploads. Optionally, filter uploads by campaign.
 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::UploadsApi.new
+api_instance = Lob::UploadsApi.new
 opts = {
   campaign_id: 'campaign_id_example' # String | id of the campaign
 }
@@ -540,7 +540,7 @@ begin
   # list_upload
   result = api_instance.list_upload(opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->list_upload: #{e}"
 end
 ```
@@ -558,7 +558,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<Upload>>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UploadsApi->uploads_list_with_http_info: #{e}"
 end
 ```

data/docs/UsAutocompletions.md

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

data/docs/UsAutocompletionsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UsAutocompletionsApi
+# Lob::UsAutocompletionsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -21,20 +21,20 @@ Given an address prefix consisting of a partial primary line, as well as optiona
 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::UsAutocompletionsApi.new
-us_autocompletions_writable = OpenapiClient::UsAutocompletionsWritable.new({address_prefix: 'address_prefix_example'}) # UsAutocompletionsWritable | 
+api_instance = Lob::UsAutocompletionsApi.new
+us_autocompletions_writable = Lob::UsAutocompletionsWritable.new({address_prefix: 'address_prefix_example'}) # UsAutocompletionsWritable | 
 
 begin
   # autocomplete
   result = api_instance.autocomplete(us_autocompletions_writable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UsAutocompletionsApi->autocomplete: #{e}"
 end
 ```
@@ -52,7 +52,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UsAutocompletions>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling UsAutocompletionsApi->us_autocompletion_with_http_info: #{e}"
 end
 ```

data/docs/UsAutocompletionsWritable.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UsAutocompletionsWritable
+# Lob::UsAutocompletionsWritable
 
 ## Properties
 
@@ -15,7 +15,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::UsAutocompletionsWritable.new(
+instance = Lob::UsAutocompletionsWritable.new(
   address_prefix: null,
   city: null,
   state: null,

data/docs/UsComponents.md

@@ -1,4 +1,4 @@
-# OpenapiClient::UsComponents
+# Lob::UsComponents
 
 ## Properties
 
@@ -36,7 +36,7 @@
 ```ruby
 require 'openapi_client'
 
-instance = OpenapiClient::UsComponents.new(
+instance = Lob::UsComponents.new(
   primary_number: null,
   street_predirection: null,
   street_name: null,