lob 5.4.6 → 6.0.5

data/docs/BuckslipsApi.md

@@ -0,0 +1,372 @@
+# Lob::BuckslipsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**buckslip_create**](BuckslipsApi.md#buckslip_create) | **POST** /buckslips | create |
+| [**buckslip_delete**](BuckslipsApi.md#buckslip_delete) | **DELETE** /buckslips/{buckslip_id} | delete |
+| [**buckslip_retrieve**](BuckslipsApi.md#buckslip_retrieve) | **GET** /buckslips/{buckslip_id} | get |
+| [**buckslip_update**](BuckslipsApi.md#buckslip_update) | **PATCH** /buckslips/{buckslip_id} | update |
+| [**buckslips_list**](BuckslipsApi.md#buckslips_list) | **GET** /buckslips | List |
+
+
+## buckslip_create
+
+> <Buckslip> buckslip_create(buckslip_editable)
+
+create
+
+Creates a new buckslip given information
+
+### 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::BuckslipsApi.new
+buckslip_editable = Lob::BuckslipEditable.new({front: 'front_example'}) # BuckslipEditable | 
+
+begin
+  # create
+  result = api_instance.create(buckslip_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->create: #{e}"
+end
+```
+
+#### Using the buckslip_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Buckslip>, Integer, Hash)> buckslip_create_with_http_info(buckslip_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.buckslip_create_with_http_info(buckslip_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Buckslip>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->buckslip_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_editable** | [**BuckslipEditable**](BuckslipEditable.md) |  |  |
+
+### Return type
+
+[**Buckslip**](Buckslip.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## buckslip_delete
+
+> <BuckslipDeletion> buckslip_delete(buckslip_id)
+
+delete
+
+Delete an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.
+
+### 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::BuckslipsApi.new
+buckslip_id = 'buckslip_id_example' # String | id of the buckslip
+
+begin
+  # delete
+  result = api_instance.delete(buckslip_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->delete: #{e}"
+end
+```
+
+#### Using the buckslip_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BuckslipDeletion>, Integer, Hash)> buckslip_delete_with_http_info(buckslip_id)
+
+```ruby
+begin
+  # delete
+  data, status_code, headers = api_instance.buckslip_delete_with_http_info(buckslip_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BuckslipDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->buckslip_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_id** | **String** | id of the buckslip |  |
+
+### Return type
+
+[**BuckslipDeletion**](BuckslipDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## buckslip_retrieve
+
+> <Buckslip> buckslip_retrieve(buckslip_id)
+
+get
+
+Retrieves the details of an existing buckslip. You need only supply the unique customer identifier that was returned upon buckslip creation.
+
+### 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::BuckslipsApi.new
+buckslip_id = 'buckslip_id_example' # String | id of the buckslip
+
+begin
+  # get
+  result = api_instance.get(buckslip_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->get: #{e}"
+end
+```
+
+#### Using the buckslip_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Buckslip>, Integer, Hash)> buckslip_retrieve_with_http_info(buckslip_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.buckslip_retrieve_with_http_info(buckslip_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Buckslip>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->buckslip_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_id** | **String** | id of the buckslip |  |
+
+### Return type
+
+[**Buckslip**](Buckslip.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## buckslip_update
+
+> <Buckslip> buckslip_update(buckslip_id, buckslip_updatable)
+
+update
+
+Update the details of an existing buckslip. You need only supply the unique identifier that was returned upon buckslip creation.
+
+### 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::BuckslipsApi.new
+buckslip_id = 'buckslip_id_example' # String | id of the buckslip
+buckslip_updatable = Lob::BuckslipUpdatable.new # BuckslipUpdatable | 
+
+begin
+  # update
+  result = api_instance.update(buckslip_id, buckslip_updatable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->update: #{e}"
+end
+```
+
+#### Using the buckslip_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Buckslip>, Integer, Hash)> buckslip_update_with_http_info(buckslip_id, buckslip_updatable)
+
+```ruby
+begin
+  # update
+  data, status_code, headers = api_instance.buckslip_update_with_http_info(buckslip_id, buckslip_updatable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Buckslip>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->buckslip_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_id** | **String** | id of the buckslip |  |
+| **buckslip_updatable** | [**BuckslipUpdatable**](BuckslipUpdatable.md) |  |  |
+
+### Return type
+
+[**Buckslip**](Buckslip.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## buckslips_list
+
+> <BuckslipsList> buckslips_list(opts)
+
+List
+
+Returns a list of your buckslips. The buckslips are returned sorted by creation date, with the most recently created buckslips 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::BuckslipsApi.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`. 
+}
+
+begin
+  # List
+  result = api_instance.List(opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->List: #{e}"
+end
+```
+
+#### Using the buckslips_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BuckslipsList>, Integer, Hash)> buckslips_list_with_http_info(opts)
+
+```ruby
+begin
+  # List
+  data, status_code, headers = api_instance.buckslips_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BuckslipsList>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipsApi->buckslips_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] |
+
+### Return type
+
+[**BuckslipsList**](BuckslipsList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BuckslipsList.md

@@ -0,0 +1,28 @@
+# Lob::BuckslipsList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Buckslip>**](Buckslip.md) | list of buckslips | [optional] |
+| **object** | **String** | Value is type of resource. | [optional] |
+| **next_url** | **String** | url of next page of items in list. | [optional] |
+| **previous_url** | **String** | url of previous page of items in list. | [optional] |
+| **count** | **Integer** | number of resources in a set | [optional] |
+| **total_count** | **Integer** | indicates the total number of records. Provided when the request specifies an \"include\" query parameter | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BuckslipsList.new(
+  data: null,
+  object: null,
+  next_url: null,
+  previous_url: null,
+  count: null,
+  total_count: null
+)
+```
+

data/docs/BulkError.md

@@ -0,0 +1,18 @@
+# Lob::BulkError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**BulkErrorProperties**](BulkErrorProperties.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BulkError.new(
+  error: null
+)
+```
+

data/docs/BulkErrorProperties.md

@@ -0,0 +1,20 @@
+# Lob::BulkErrorProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | A human-readable message with more details about the error | [optional] |
+| **status_code** | **Integer** | A conventional HTTP status code. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BulkErrorProperties.new(
+  message: null,
+  status_code: null
+)
+```
+

data/docs/Campaign.md

@@ -0,0 +1,52 @@
+# Lob::Campaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_group_id** | **String** | Unique identifier prefixed with `bg_`. | [optional] |
+| **name** | **String** | Name of the campaign. |  |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **schedule_type** | [**CmpScheduleType**](CmpScheduleType.md) |  |  |
+| **target_delivery_date** | **Time** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] |
+| **send_date** | **Time** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] |
+| **cancel_window_campaign_minutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+| **use_type** | [**CmpUseType**](CmpUseType.md) |  | [optional] |
+| **auto_cancel_if_ncoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. |  |
+| **id** | **String** | Unique identifier prefixed with `cmp_`. |  |
+| **account_id** | **String** | Account ID that this campaign is associated with. | [optional] |
+| **is_draft** | **Boolean** | Whether or not the campaign is still a draft. | [default to true] |
+| **creatives** | [**Array<CampaignCreative>**](CampaignCreative.md) | An array of creatives that have been associated with this campaign. |  |
+| **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. |  |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **object** | **String** | Value is resource type. | [default to 'campaign'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Campaign.new(
+  billing_group_id: null,
+  name: null,
+  description: null,
+  schedule_type: null,
+  target_delivery_date: null,
+  send_date: null,
+  cancel_window_campaign_minutes: null,
+  metadata: null,
+  use_type: null,
+  auto_cancel_if_ncoa: null,
+  id: null,
+  account_id: null,
+  is_draft: null,
+  creatives: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/CampaignCreative.md

@@ -0,0 +1,42 @@
+# Lob::CampaignCreative
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `crv_`. | [optional] |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. | [optional] |
+| **resource_type** | **String** | Mailpiece type for the creative | [optional] |
+| **details** | [**AnyType**](.md) | Either PostcardDetailsReturned or LetterDetailsReturned | [optional] |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+| **template_preview_urls** | **Object** | Preview URLs associated with a creative's artwork asset(s) if the creative uses HTML templates as assets. | [optional] |
+| **template_previews** | **Array<Object>** | A list of template preview objects if the creative uses HTML template(s) as artwork asset(s). | [optional] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **campaigns** | [**Array<Campaign>**](Campaign.md) |  | [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** | Value is resource type. | [optional][default to 'creative'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CampaignCreative.new(
+  id: null,
+  description: null,
+  from: null,
+  resource_type: null,
+  details: null,
+  metadata: null,
+  template_preview_urls: null,
+  template_previews: null,
+  deleted: null,
+  campaigns: null,
+  date_created: null,
+  date_modified: null,
+  object: null
+)
+```
+

data/docs/CampaignDeletion.md

@@ -0,0 +1,20 @@
+# Lob::CampaignDeletion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `cmp_`. | [optional] |
+| **deleted** | **Boolean** | True if the resource has been successfully deleted. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CampaignDeletion.new(
+  id: null,
+  deleted: null
+)
+```
+

data/docs/CampaignUpdatable.md

@@ -0,0 +1,36 @@
+# Lob::CampaignUpdatable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **schedule_type** | [**CmpScheduleType**](CmpScheduleType.md) |  | [optional] |
+| **target_delivery_date** | **Time** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] |
+| **send_date** | **Time** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] |
+| **cancel_window_campaign_minutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+| **is_draft** | **Boolean** | Whether or not the campaign is still a draft. | [optional] |
+| **use_type** | [**CmpUseType**](CmpUseType.md) |  | [optional] |
+| **auto_cancel_if_ncoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CampaignUpdatable.new(
+  name: null,
+  description: null,
+  schedule_type: null,
+  target_delivery_date: null,
+  send_date: null,
+  cancel_window_campaign_minutes: null,
+  metadata: null,
+  is_draft: null,
+  use_type: null,
+  auto_cancel_if_ncoa: null
+)
+```
+

data/docs/CampaignWritable.md

@@ -0,0 +1,36 @@
+# Lob::CampaignWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_group_id** | **String** | Unique identifier prefixed with `bg_`. | [optional] |
+| **name** | **String** | Name of the campaign. |  |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **schedule_type** | [**CmpScheduleType**](CmpScheduleType.md) |  |  |
+| **target_delivery_date** | **Time** | If `schedule_type` is `target_delivery_date`, provide a targeted delivery date for mail pieces in this campaign. | [optional] |
+| **send_date** | **Time** | If `schedule_type` is `scheduled_send_date`, provide a date to send this campaign. | [optional] |
+| **cancel_window_campaign_minutes** | **Integer** | A window, in minutes, within which the campaign can be canceled. | [optional] |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+| **use_type** | [**CmpUseType**](CmpUseType.md) |  | [optional] |
+| **auto_cancel_if_ncoa** | **Boolean** | Whether or not a mail piece should be automatically canceled and not sent if the address is updated via NCOA. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CampaignWritable.new(
+  billing_group_id: null,
+  name: null,
+  description: null,
+  schedule_type: null,
+  target_delivery_date: null,
+  send_date: null,
+  cancel_window_campaign_minutes: null,
+  metadata: null,
+  use_type: null,
+  auto_cancel_if_ncoa: null
+)
+```
+