lob 5.1.2 → 6.0.5

data/docs/SortBy2.md

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

data/docs/SortBy3.md

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

data/docs/SortByDateModified.md

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

data/docs/Suggestions.md

@@ -0,0 +1,26 @@
+# Lob::Suggestions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`  |  |
+| **city** | **String** |  |  |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.  |  |
+| **zip_code** | **String** | A 5-digit zip code. Left empty if a test key is used. |  |
+| **object** | **String** | Value is resource type. | [optional][default to 'us_autocompletion'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Suggestions.new(
+  primary_line: null,
+  city: null,
+  state: null,
+  zip_code: null,
+  object: null
+)
+```
+

data/docs/Template.md

@@ -0,0 +1,34 @@
+# Lob::Template
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). |  |
+| **versions** | [**Array<TemplateVersion>**](TemplateVersion.md) | An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. |  |
+| **published_version** | [**TemplateVersion**](TemplateVersion.md) |  |  |
+| **object** | **String** | Value is resource type. | [optional][default to 'template'] |
+| **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] |
+| **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] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Template.new(
+  description: null,
+  id: null,
+  versions: null,
+  published_version: null,
+  object: null,
+  metadata: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null
+)
+```
+

data/docs/TemplateDeletion.md

@@ -0,0 +1,22 @@
+# Lob::TemplateDeletion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **object** | **String** | Value is type of resource. | [optional][default to 'template_deleted'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateDeletion.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/TemplateList.md

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

data/docs/TemplateUpdate.md

@@ -0,0 +1,20 @@
+# Lob::TemplateUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **published_version** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateUpdate.new(
+  description: null,
+  published_version: null
+)
+```
+

data/docs/TemplateVersion.md

@@ -0,0 +1,36 @@
+# Lob::TemplateVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `vrsn_`. |  |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **html** | **String** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.  |  |
+| **engine** | [**EngineHtml**](EngineHtml.md) |  | [optional][default to 'legacy'] |
+| **suggest_json_editor** | **Boolean** | Used by frontend, true if the template uses advanced features.  | [optional] |
+| **merge_variables** | **Object** | Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings.  | [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] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **object** | **String** | Value is resource type. | [optional][default to 'version'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateVersion.new(
+  id: null,
+  description: null,
+  html: null,
+  engine: null,
+  suggest_json_editor: null,
+  merge_variables: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/TemplateVersionDeletion.md

@@ -0,0 +1,22 @@
+# Lob::TemplateVersionDeletion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+| **object** | **String** | Value is type of resource. | [optional][default to 'template_version_deleted'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateVersionDeletion.new(
+  id: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/TemplateVersionList.md

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

data/docs/TemplateVersionUpdatable.md

@@ -0,0 +1,20 @@
+# Lob::TemplateVersionUpdatable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **engine** | [**EngineHtml**](EngineHtml.md) |  | [optional][default to 'legacy'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateVersionUpdatable.new(
+  description: null,
+  engine: null
+)
+```
+

data/docs/TemplateVersionWritable.md

@@ -0,0 +1,22 @@
+# Lob::TemplateVersionWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **html** | **String** | An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back`  If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`.  |  |
+| **engine** | [**EngineHtml**](EngineHtml.md) |  | [optional][default to 'legacy'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::TemplateVersionWritable.new(
+  description: null,
+  html: null,
+  engine: null
+)
+```
+