lob 6.0.8 → 6.0.9

data/docs/SnapPacksApi.md

@@ -0,0 +1,317 @@
+# Lob::SnapPacksApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**snap_pack_create**](SnapPacksApi.md#snap_pack_create) | **POST** /snap_packs | create |
+| [**snap_pack_delete**](SnapPacksApi.md#snap_pack_delete) | **DELETE** /snap_packs/{snp_id} | delete |
+| [**snap_pack_retrieve**](SnapPacksApi.md#snap_pack_retrieve) | **GET** /snap_packs/{snp_id} | get |
+| [**snap_packs_list**](SnapPacksApi.md#snap_packs_list) | **GET** /snap_packs | list |
+
+
+## snap_pack_create
+
+> <SnapPack> snap_pack_create(snap_pack_editable, opts)
+
+create
+
+Creates a new snap_pack given information
+
+### Examples
+
+```ruby
+require 'time'
+require 'lob'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::SnapPacksApi.new
+snap_pack_editable = Lob::SnapPackEditable.new({to: TODO, inside: 'inside_example', outside: 'outside_example', use_type: Lob::SnpUseType::MARKETING}) # SnapPackEditable | 
+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). 
+}
+
+begin
+  # create
+  result = api_instance.create(snap_pack_editable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->create: #{e}"
+end
+```
+
+#### Using the snap_pack_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapPack>, Integer, Hash)> snap_pack_create_with_http_info(snap_pack_editable, opts)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.snap_pack_create_with_http_info(snap_pack_editable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapPack>
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->snap_pack_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snap_pack_editable** | [**SnapPackEditable**](SnapPackEditable.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] |
+
+### Return type
+
+[**SnapPack**](SnapPack.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## snap_pack_delete
+
+> <SnapPackDeletion> snap_pack_delete(snp_id)
+
+delete
+
+Completely removes a snap pack from production. This can only be done if the snap pack's `send_date` has not yet passed.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lob'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::SnapPacksApi.new
+snp_id = 'snp_id_example' # String | id of the snap_pack
+
+begin
+  # delete
+  result = api_instance.delete(snp_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->delete: #{e}"
+end
+```
+
+#### Using the snap_pack_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapPackDeletion>, Integer, Hash)> snap_pack_delete_with_http_info(snp_id)
+
+```ruby
+begin
+  # delete
+  data, status_code, headers = api_instance.snap_pack_delete_with_http_info(snp_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapPackDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->snap_pack_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snp_id** | **String** | id of the snap_pack |  |
+
+### Return type
+
+[**SnapPackDeletion**](SnapPackDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## snap_pack_retrieve
+
+> <SnapPack> snap_pack_retrieve(snp_id)
+
+get
+
+Retrieves the details of an existing snap_pack. You need only supply the unique snap_pack identifier that was returned upon snap_pack creation.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lob'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::SnapPacksApi.new
+snp_id = 'snp_id_example' # String | id of the snap_pack
+
+begin
+  # get
+  result = api_instance.get(snp_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->get: #{e}"
+end
+```
+
+#### Using the snap_pack_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapPack>, Integer, Hash)> snap_pack_retrieve_with_http_info(snp_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.snap_pack_retrieve_with_http_info(snp_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapPack>
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->snap_pack_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **snp_id** | **String** | id of the snap_pack |  |
+
+### Return type
+
+[**SnapPack**](SnapPack.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## snap_packs_list
+
+> <SnapPackList> snap_packs_list(opts)
+
+list
+
+Returns a list of your Snap Packs. The snap packs are returned sorted by creation date, with the most recently created snap packs appearing first.
+
+### Examples
+
+```ruby
+require 'time'
+require 'lob'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::SnapPacksApi.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. 
+  after: 'after_example', # String | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. 
+  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: [Lob::SnapPackSize::N8_5X11], # Array<SnapPackSize> | The Snap Pack 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: 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::SortBy4.new # SortBy4 | 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 Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->list: #{e}"
+end
+```
+
+#### Using the snap_packs_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SnapPackList>, Integer, Hash)> snap_packs_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.snap_packs_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SnapPackList>
+rescue Lob::ApiError => e
+  puts "Error when calling SnapPacksApi->snap_packs_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | How many results to return. | [optional][default to 10] |
+| **before** | **String** | A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the &#x60;previous_url&#x60; field in the return response.  | [optional] |
+| **after** | **String** | A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the &#x60;next_url&#x60; field in the return response.  | [optional] |
+| **include** | [**Array&lt;String&gt;**](String.md) | Request that the response include the total count by specifying &#x60;include[]&#x3D;total_count&#x60;.  | [optional] |
+| **date_created** | [**Hash&lt;String, Time&gt;**](Time.md) | Filter by date created. | [optional] |
+| **metadata** | [**Hash&lt;String, String&gt;**](String.md) | Filter by metadata key-value pair&#x60;. | [optional] |
+| **size** | [**Array&lt;SnapPackSize&gt;**](SnapPackSize.md) | The Snap Pack sizes to be returned. | [optional] |
+| **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** | [**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
+
+[**SnapPackList**](SnapPackList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SnpUseType.md

@@ -0,0 +1,15 @@
+# Lob::SnpUseType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'lob'
+
+instance = Lob::SnpUseType.new()
+```
+

data/docs/SortBy.md

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

data/docs/SortBy1.md

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

data/docs/SortBy2.md

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

data/docs/SortBy3.md

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

data/docs/SortBy4.md

@@ -0,0 +1,20 @@
+# Lob::SortBy4
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **date_created** | **String** |  | [optional] |
+| **send_date** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lob'
+
+instance = Lob::SortBy4.new(
+  date_created: null,
+  send_date: null
+)
+```
+

data/docs/SortByDateModified.md

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

data/docs/Suggestions.md

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

data/docs/Template.md

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

data/docs/TemplateDeletion.md

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

data/docs/TemplateList.md

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

data/docs/TemplateUpdate.md

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

data/docs/TemplateVersion.md

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

data/docs/TemplateVersionDeletion.md

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

data/docs/TemplateVersionList.md

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

data/docs/TemplateVersionUpdatable.md

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

data/docs/TemplateVersionWritable.md

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

data/docs/TemplateVersionsApi.md

@@ -23,7 +23,7 @@ Creates a new template version attached to the specified template.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -95,7 +95,7 @@ Permanently deletes a template version. A template's `published_version` can not
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -167,7 +167,7 @@ Retrieves the template version with the given template and version ids.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -239,7 +239,7 @@ Updates the template version with the given template and version ids.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -313,7 +313,7 @@ Returns a list of template versions for the given template ID. The template vers
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/TemplateWritable.md

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

data/docs/TemplatesApi.md

@@ -23,7 +23,7 @@ Creates a new template for use with the Print & Mail API. In Live mode, you can
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -93,7 +93,7 @@ Permanently deletes a template.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -163,7 +163,7 @@ Retrieves the details of an existing template.
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -233,7 +233,7 @@ Updates the description and/or published version of the template with the given
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth
@@ -305,7 +305,7 @@ Returns a list of your templates. The templates are returned sorted by creation
 
 ```ruby
 require 'time'
-require 'openapi_client'
+require 'lob'
 # setup authorization
 Lob.configure do |config|
   # Configure HTTP basic authorization: basicAuth

data/docs/Thumbnail.md

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

data/docs/TrackingEventCertified.md

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

data/docs/TrackingEventDetails.md

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

data/docs/TrackingEventNormal.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **type** | **String** | non-Certified postcards, self mailers, letters, and checks |  |
-| **name** | **String** | Name of tracking event (for normal postcards, self mailers, letters, and checks):    * `In Transit` - The mailpiece is being processed at the entry/origin facility.    * `In Local Area` - The mailpiece is being processed at the destination facility.    * `Processed for Delivery` - The mailpiece has been greenlit for     delivery at the recipient's nearest postal facility. The mailpiece     should reach the mailbox within 1 business day of this tracking     event.    * `Re-Routed` - The mailpiece is re-routed due to recipient change of     address, address errors, or USPS relabeling of barcode/ID tag     area.    * `Returned to Sender` - The mailpiece is being returned to sender due     to barcode, ID tag area, or address errors.    * `Mailed` - The mailpiece has been handed off to and accepted by USPS     and is en route. [More about     Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-)     Note this data is only available in Enterprise editions of     Lob. [Contact Sales](https://lob.com/support/contact#contact) if     you want access to this feature.  [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-)  |  |
+| **name** | **String** | Name of tracking event (for normal postcards, self mailers, letters, and checks):    * `Mailed` - The mailpiece has been handed off to and accepted by USPS   and is en route. <a href=\"https://help.lob.com/print-and-mail/getting-data-and-results/tracking-your-mail#mailed-tracking-events-4\" target=\"_blank\">More about   Mailed.</a>   Note this data is only available in Enterprise editions of   Lob. <a href=\"https://lob.com/support/contact#contact\" target=\"_blank\">Contact Sales</a> if   you want access to this feature.  * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for   delivery at the recipient's nearest postal facility. The mailpiece   should reach the mailbox within 1 business day of this tracking   event.  * `Delivered` - The mail piece has been delivered to    the recipients address. The final scan is generated when the mail    carrier's GPS unit leaves the delivery area.  * `Re-Routed` - The mailpiece is re-routed due to recipient change of   address, address errors, or USPS relabeling of barcode/ID tag   area.  * `Returned to Sender` - The mailpiece is being returned to sender due   to barcode, ID tag area, or address errors.  * `International Exit` - The mail piece has been processed to    ship to a destination abroad. This is typically the last    scan a US-originated international mail piece will receive    from the USPS.  [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-)  |  |
 | **details** | **Object** | Will be `null` for `type=normal` events | [optional] |
 | **location** | **String** | The zip code in which the scan event occurred. Null for `Mailed` events.  | [optional] |
 | **id** | **String** | Unique identifier prefixed with `evnt_`. | [optional] |
@@ -17,7 +17,7 @@
 ## Example
 
 ```ruby
-require 'openapi_client'
+require 'lob'
 
 instance = Lob::TrackingEventNormal.new(
   type: null,