lob 6.0.0.pre.rc → 6.0.0

data/docs/SelfMailerDeletion.md

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

data/docs/SelfMailerEditable.md

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

data/docs/SelfMailerList.md

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

data/docs/SelfMailerSize.md

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

data/docs/SelfMailersApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::SelfMailersApi
+# Lob::SelfMailersApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -24,14 +24,14 @@ Creates a new self_mailer 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::SelfMailersApi.new
-self_mailer_editable = OpenapiClient::SelfMailerEditable.new({to: 'to_example', inside: 'inside_example', outside: 'outside_example'}) # SelfMailerEditable | 
+api_instance = Lob::SelfMailersApi.new
+self_mailer_editable = Lob::SelfMailerEditable.new({to: 'to_example', inside: 'inside_example', outside: 'outside_example'}) # SelfMailerEditable | 
 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(self_mailer_editable, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->create: #{e}"
 end
 ```
@@ -58,7 +58,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SelfMailer>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->self_mailer_create_with_http_info: #{e}"
 end
 ```
@@ -98,20 +98,20 @@ Completely removes a self mailer from production. This can only be done if the s
 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::SelfMailersApi.new
+api_instance = Lob::SelfMailersApi.new
 sfm_id = 'sfm_id_example' # String | id of the self_mailer
 
 begin
   # delete
   result = api_instance.delete(sfm_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->delete: #{e}"
 end
 ```
@@ -129,7 +129,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SelfMailerDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->self_mailer_delete_with_http_info: #{e}"
 end
 ```
@@ -168,20 +168,20 @@ Retrieves the details of an existing self_mailer. You need only supply the uniqu
 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::SelfMailersApi.new
+api_instance = Lob::SelfMailersApi.new
 sfm_id = 'sfm_id_example' # String | id of the self_mailer
 
 begin
   # get
   result = api_instance.get(sfm_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->get: #{e}"
 end
 ```
@@ -199,7 +199,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SelfMailer>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->self_mailer_retrieve_with_http_info: #{e}"
 end
 ```
@@ -238,13 +238,13 @@ Returns a list of your self_mailers. The self_mailers are returned sorted by cre
 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::SelfMailersApi.new
+api_instance = Lob::SelfMailersApi.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::SelfMailerSize::N6X18_BIFOLD], # Array<SelfMailerSize> | The self mailer sizes to be returned.
+  size: [Lob::SelfMailerSize::N6X18_BIFOLD], # Array<SelfMailerSize> | The self mailer sizes to be returned.
   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 SelfMailersApi->list: #{e}"
 end
 ```
@@ -281,7 +281,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SelfMailerList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling SelfMailersApi->self_mailers_list_with_http_info: #{e}"
 end
 ```

data/docs/SortBy.md

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

data/docs/SortBy1.md

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

data/docs/SortBy2.md

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

data/docs/SortBy3.md

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

data/docs/SortByDateModified.md

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

data/docs/Suggestions.md

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

data/docs/Template.md

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

data/docs/TemplateDeletion.md

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

data/docs/TemplateList.md

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

data/docs/TemplateUpdate.md

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

data/docs/TemplateVersion.md

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

data/docs/TemplateVersionDeletion.md

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

data/docs/TemplateVersionList.md

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

data/docs/TemplateVersionUpdatable.md

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

data/docs/TemplateVersionWritable.md

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

data/docs/TemplateVersionsApi.md

@@ -1,4 +1,4 @@
-# OpenapiClient::TemplateVersionsApi
+# Lob::TemplateVersionsApi
 
 All URIs are relative to *https://api.lob.com/v1*
 
@@ -25,21 +25,21 @@ Creates a new template version attached to the specified 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::TemplateVersionsApi.new
+api_instance = Lob::TemplateVersionsApi.new
 tmpl_id = 'tmpl_id_example' # String | The ID of the template the new version will be attached to
-template_version_writable = OpenapiClient::TemplateVersionWritable.new({html: 'html_example'}) # TemplateVersionWritable | 
+template_version_writable = Lob::TemplateVersionWritable.new({html: 'html_example'}) # TemplateVersionWritable | 
 
 begin
   # create
   result = api_instance.create(tmpl_id, template_version_writable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->create: #{e}"
 end
 ```
@@ -57,7 +57,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateVersion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->create_template_version_with_http_info: #{e}"
 end
 ```
@@ -97,13 +97,13 @@ Permanently deletes a template version. A template's `published_version` can not
 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::TemplateVersionsApi.new
+api_instance = Lob::TemplateVersionsApi.new
 tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
 vrsn_id = 'vrsn_id_example' # String | id of the template_version
 
@@ -111,7 +111,7 @@ begin
   # delete
   result = api_instance.delete(tmpl_id, vrsn_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->delete: #{e}"
 end
 ```
@@ -129,7 +129,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateVersionDeletion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->template_version_delete_with_http_info: #{e}"
 end
 ```
@@ -169,13 +169,13 @@ Retrieves the template version with the given template and version ids.
 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::TemplateVersionsApi.new
+api_instance = Lob::TemplateVersionsApi.new
 tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
 vrsn_id = 'vrsn_id_example' # String | id of the template_version
 
@@ -183,7 +183,7 @@ begin
   # get
   result = api_instance.get(tmpl_id, vrsn_id)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->get: #{e}"
 end
 ```
@@ -201,7 +201,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateVersion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->template_version_retrieve_with_http_info: #{e}"
 end
 ```
@@ -241,22 +241,22 @@ Updates the template version with the given template and version ids.
 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::TemplateVersionsApi.new
+api_instance = Lob::TemplateVersionsApi.new
 tmpl_id = 'tmpl_id_example' # String | The ID of the template to which the version belongs.
 vrsn_id = 'vrsn_id_example' # String | id of the template_version
-template_version_updatable = OpenapiClient::TemplateVersionUpdatable.new # TemplateVersionUpdatable | 
+template_version_updatable = Lob::TemplateVersionUpdatable.new # TemplateVersionUpdatable | 
 
 begin
   # update
   result = api_instance.update(tmpl_id, vrsn_id, template_version_updatable)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->update: #{e}"
 end
 ```
@@ -274,7 +274,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateVersion>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->template_version_update_with_http_info: #{e}"
 end
 ```
@@ -315,13 +315,13 @@ Returns a list of template versions for the given template ID. The template vers
 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::TemplateVersionsApi.new
+api_instance = Lob::TemplateVersionsApi.new
 tmpl_id = 'tmpl_id_example' # String | The ID of the template associated with the retrieved versions
 opts = {
   limit: 56, # Integer | How many results to return.
@@ -335,7 +335,7 @@ begin
   # list
   result = api_instance.list(tmpl_id, opts)
   p result
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->list: #{e}"
 end
 ```
@@ -353,7 +353,7 @@ begin
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TemplateVersionList>
-rescue OpenapiClient::ApiError => e
+rescue Lob::ApiError => e
   puts "Error when calling TemplateVersionsApi->template_versions_list_with_http_info: #{e}"
 end
 ```

data/docs/TemplateWritable.md

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