lob 5.1.2 → 6.0.5

data/docs/CheckList.md

@@ -0,0 +1,28 @@
+# Lob::CheckList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Check>**](Check.md) | list of checks | [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::CheckList.new(
+  data: null,
+  object: null,
+  next_url: null,
+  previous_url: null,
+  count: null,
+  total_count: null
+)
+```
+

data/docs/ChecksApi.md

@@ -0,0 +1,315 @@
+# Lob::ChecksApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_cancel**](ChecksApi.md#check_cancel) | **DELETE** /checks/{chk_id} | cancel |
+| [**check_create**](ChecksApi.md#check_create) | **POST** /checks | create |
+| [**check_retrieve**](ChecksApi.md#check_retrieve) | **GET** /checks/{chk_id} | get |
+| [**checks_list**](ChecksApi.md#checks_list) | **GET** /checks | list |
+
+
+## check_cancel
+
+> <CheckDeletion> check_cancel(chk_id)
+
+cancel
+
+Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access.
+
+### 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::ChecksApi.new
+chk_id = 'chk_id_example' # String | id of the check
+
+begin
+  # cancel
+  result = api_instance.cancel(chk_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->cancel: #{e}"
+end
+```
+
+#### Using the check_cancel_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckDeletion>, Integer, Hash)> check_cancel_with_http_info(chk_id)
+
+```ruby
+begin
+  # cancel
+  data, status_code, headers = api_instance.check_cancel_with_http_info(chk_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->check_cancel_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chk_id** | **String** | id of the check |  |
+
+### Return type
+
+[**CheckDeletion**](CheckDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## check_create
+
+> <Check> check_create(check_editable, opts)
+
+create
+
+Creates a new check with the provided properties.
+
+### 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::ChecksApi.new
+check_editable = Lob::CheckEditable.new({from: TODO, to: TODO, bank_account: 'bank_account_example', amount: 3.56}) # CheckEditable | 
+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(check_editable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->create: #{e}"
+end
+```
+
+#### Using the check_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Check>, Integer, Hash)> check_create_with_http_info(check_editable, opts)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.check_create_with_http_info(check_editable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Check>
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->check_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_editable** | [**CheckEditable**](CheckEditable.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
+
+[**Check**](Check.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## check_retrieve
+
+> <Check> check_retrieve(chk_id)
+
+get
+
+Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check 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::ChecksApi.new
+chk_id = 'chk_id_example' # String | id of the check
+
+begin
+  # get
+  result = api_instance.get(chk_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->get: #{e}"
+end
+```
+
+#### Using the check_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Check>, Integer, Hash)> check_retrieve_with_http_info(chk_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.check_retrieve_with_http_info(chk_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Check>
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->check_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chk_id** | **String** | id of the check |  |
+
+### Return type
+
+[**Check**](Check.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## checks_list
+
+> <CheckList> checks_list(opts)
+
+list
+
+Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks 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::ChecksApi.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`.
+  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::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 Lob::ApiError => e
+  puts "Error when calling ChecksApi->list: #{e}"
+end
+```
+
+#### Using the checks_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CheckList>, Integer, Hash)> checks_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.checks_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CheckList>
+rescue Lob::ApiError => e
+  puts "Error when calling ChecksApi->checks_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] |
+| **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** | [**SortBy3**](.md) | Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;send_date&#x60;, not both.  | [optional] |
+
+### Return type
+
+[**CheckList**](CheckList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CmpScheduleType.md

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

data/docs/CmpUseType.md

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

data/docs/CountryExtended.md

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

data/docs/CountryExtendedExpanded.md

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

data/docs/CreativePatch.md

@@ -0,0 +1,22 @@
+# Lob::CreativePatch
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. | [optional] |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [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] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CreativePatch.new(
+  from: null,
+  description: null,
+  metadata: null
+)
+```
+

data/docs/CreativeResponse.md

@@ -0,0 +1,42 @@
+# Lob::CreativeResponse
+
+## 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) | Array of campaigns associated with the creative ID | [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::CreativeResponse.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/CreativeWritable.md

@@ -0,0 +1,34 @@
+# Lob::CreativeWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [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] |
+| **resource_type** | **String** | Mailpiece type for the creative |  |
+| **campaign_id** | **String** | Unique identifier prefixed with `cmp_`. |  |
+| **details** | [**AnyType**](.md) | Either PostcardDetailsWritable or LetterDetailsWritable | [optional] |
+| **file** | **String** | PDF file containing the letter's formatting. Do not include for resource_type = postcard. | [optional] |
+| **front** | **String** | The artwork to use as the front of your postcard. Do not include for resource_type = letter.  | [optional] |
+| **back** | **String** | The artwork to use as the back of your postcard. Do not include for resource_type = letter.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CreativeWritable.new(
+  from: null,
+  description: null,
+  metadata: null,
+  resource_type: null,
+  campaign_id: null,
+  details: null,
+  file: null,
+  front: null,
+  back: null
+)
+```
+