lob 5.1.2 → 6.0.5

data/docs/TemplatesApi.md

@@ -0,0 +1,376 @@
+# Lob::TemplatesApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_template**](TemplatesApi.md#create_template) | **POST** /templates | create |
+| [**template_delete**](TemplatesApi.md#template_delete) | **DELETE** /templates/{tmpl_id} | delete |
+| [**template_retrieve**](TemplatesApi.md#template_retrieve) | **GET** /templates/{tmpl_id} | get |
+| [**template_update**](TemplatesApi.md#template_update) | **POST** /templates/{tmpl_id} | update |
+| [**templates_list**](TemplatesApi.md#templates_list) | **GET** /templates | list |
+
+
+## create_template
+
+> <Template> create_template(template_writable)
+
+create
+
+Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+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 Lob::ApiError => e
+  puts "Error when calling TemplatesApi->create: #{e}"
+end
+```
+
+#### Using the create_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> create_template_with_http_info(template_writable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.create_template_with_http_info(template_writable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->create_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_writable** | [**TemplateWritable**](TemplateWritable.md) |  |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## template_delete
+
+> <TemplateDeletion> template_delete(tmpl_id)
+
+delete
+
+Permanently deletes a template.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+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 Lob::ApiError => e
+  puts "Error when calling TemplatesApi->delete: #{e}"
+end
+```
+
+#### Using the template_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplateDeletion>, Integer, Hash)> template_delete_with_http_info(tmpl_id)
+
+```ruby
+begin
+  # delete
+  data, status_code, headers = api_instance.template_delete_with_http_info(tmpl_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->template_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tmpl_id** | **String** | id of the template |  |
+
+### Return type
+
+[**TemplateDeletion**](TemplateDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## template_retrieve
+
+> <Template> template_retrieve(tmpl_id)
+
+get
+
+Retrieves the details of an existing template.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+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 Lob::ApiError => e
+  puts "Error when calling TemplatesApi->get: #{e}"
+end
+```
+
+#### Using the template_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> template_retrieve_with_http_info(tmpl_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.template_retrieve_with_http_info(tmpl_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->template_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tmpl_id** | **String** | id of the template |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## template_update
+
+> <Template> template_update(tmpl_id, template_update)
+
+update
+
+Updates the description and/or published version of the template with the given id.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Lob::TemplatesApi.new
+tmpl_id = 'tmpl_id_example' # String | id of the template
+template_update = Lob::TemplateUpdate.new # TemplateUpdate | 
+
+begin
+  # update
+  result = api_instance.update(tmpl_id, template_update)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->update: #{e}"
+end
+```
+
+#### Using the template_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> template_update_with_http_info(tmpl_id, template_update)
+
+```ruby
+begin
+  # update
+  data, status_code, headers = api_instance.template_update_with_http_info(tmpl_id, template_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->template_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tmpl_id** | **String** | id of the template |  |
+| **template_update** | [**TemplateUpdate**](TemplateUpdate.md) |  |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## templates_list
+
+> <TemplateList> templates_list(opts)
+
+list
+
+Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+Lob.configure do |config|
+  # Configure HTTP basic authorization: basicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+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. 
+  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`.
+}
+
+begin
+  # list
+  result = api_instance.list(opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->list: #{e}"
+end
+```
+
+#### Using the templates_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TemplateList>, Integer, Hash)> templates_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.templates_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TemplateList>
+rescue Lob::ApiError => e
+  puts "Error when calling TemplatesApi->templates_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] |
+
+### Return type
+
+[**TemplateList**](TemplateList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Thumbnail.md

@@ -0,0 +1,22 @@
+# Lob::Thumbnail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **small** | **String** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] |
+| **medium** | **String** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] |
+| **large** | **String** | A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Thumbnail.new(
+  small: null,
+  medium: null,
+  large: null
+)
+```
+

data/docs/TrackingEventCertified.md

@@ -0,0 +1,34 @@
+# Lob::TrackingEventCertified
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** | a Certified letter tracking event |  |
+| **name** | **String** | Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings.    * `Mailed` - Package has been accepted into the carrier network for delivery.    * `In Transit` - Maps to four distinct stages of transit.    * `In Local Area` - Package is at a location near the end destination.    * `Processed for Delivery` - Maps to two distinct stages of delivery.    * `Pickup Available` - Package is available for pickup at carrier location.    * `Delivered` - Package has been delivered.    * `Re-Routed` - Package has been forwarded.    * `Returned to Sender` - Package is to be returned to sender.    * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable.  |  |
+| **details** | [**TrackingEventDetails**](TrackingEventDetails.md) |  | [optional] |
+| **location** | **String** | The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null.  | [optional] |
+| **id** | **String** | Unique identifier prefixed with `evnt_`. |  |
+| **time** | **Time** | A timestamp in ISO 8601 format of the date USPS registered the event. | [optional] |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. |  |
+| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. |  |
+| **object** | **String** |  | [default to 'tracking_event'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TrackingEventCertified.new(
+  type: null,
+  name: null,
+  details: null,
+  location: null,
+  id: null,
+  time: null,
+  date_created: null,
+  date_modified: null,
+  object: null
+)
+```
+

data/docs/TrackingEventDetails.md

@@ -0,0 +1,24 @@
+# Lob::TrackingEventDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** | Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status.  |  |
+| **description** | **String** | The description as listed in the description for event. |  |
+| **notes** | **String** | Event-specific notes from USPS about the tracking event. | [optional] |
+| **action_required** | **Boolean** | `true` if action is required by the end recipient, `false` otherwise.  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TrackingEventDetails.new(
+  event: null,
+  description: null,
+  notes: null,
+  action_required: null
+)
+```
+

data/docs/TrackingEventNormal.md

@@ -0,0 +1,34 @@
+# Lob::TrackingEventNormal
+
+## Properties
+
+| 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-)  |  |
+| **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] |
+| **time** | **Time** | A timestamp in ISO 8601 format of the date USPS registered the event. | [optional] |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
+| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the resource was last modified. | [optional] |
+| **object** | **String** |  | [optional][default to 'tracking_event'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TrackingEventNormal.new(
+  type: null,
+  name: null,
+  details: null,
+  location: null,
+  id: null,
+  time: null,
+  date_created: null,
+  date_modified: null,
+  object: null
+)
+```
+

data/docs/Upload.md

@@ -0,0 +1,44 @@
+# Lob::Upload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `upl_`. |  |
+| **account_id** | **String** | Account ID that made the request |  |
+| **campaign_id** | **String** | Unique identifier prefixed with `cmp_`. |  |
+| **mode** | **String** | The environment in which the mailpieces were created. Today, will only be `live`. |  |
+| **failures_url** | **String** | Url where your campaign mailpiece failures can be retrieved | [optional] |
+| **original_filename** | **String** | Filename of the upload | [optional] |
+| **state** | [**UploadState**](UploadState.md) |  | [default to 'Draft'] |
+| **total_mailpieces** | **Integer** | Total number of recipients for the campaign |  |
+| **failed_mailpieces** | **Integer** | Number of mailpieces that failed to create |  |
+| **validated_mailpieces** | **Integer** | Number of mailpieces that were successfully created |  |
+| **bytes_processed** | **Integer** | Number of bytes processed in your CSV |  |
+| **date_created** | **Time** | A timestamp in ISO 8601 format of the date the upload was created |  |
+| **date_modified** | **Time** | A timestamp in ISO 8601 format of the date the upload was last modified |  |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Upload.new(
+  id: null,
+  account_id: null,
+  campaign_id: null,
+  mode: null,
+  failures_url: null,
+  original_filename: null,
+  state: null,
+  total_mailpieces: null,
+  failed_mailpieces: null,
+  validated_mailpieces: null,
+  bytes_processed: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null
+)
+```
+

data/docs/UploadCreateExport.md

@@ -0,0 +1,20 @@
+# Lob::UploadCreateExport
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [default to 'Export is processing.'] |
+| **export_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::UploadCreateExport.new(
+  message: null,
+  export_id: null
+)
+```
+

data/docs/UploadFile.md

@@ -0,0 +1,20 @@
+# Lob::UploadFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [default to 'File uploaded successfully'] |
+| **filename** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::UploadFile.new(
+  message: null,
+  filename: null
+)
+```
+

data/docs/UploadState.md

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

data/docs/UploadUpdatable.md

@@ -0,0 +1,20 @@
+# Lob::UploadUpdatable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **state** | [**UploadState**](UploadState.md) |  | [optional][default to 'Draft'] |
+| **original_filename** | **String** | Original filename provided when the upload is created. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::UploadUpdatable.new(
+  state: null,
+  original_filename: null
+)
+```
+

data/docs/UploadWritable.md

@@ -0,0 +1,18 @@
+# Lob::UploadWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_id** | **String** | Unique identifier prefixed with `cmp_`. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::UploadWritable.new(
+  campaign_id: null
+)
+```
+