lob 5.1.2 → 6.0.2

data/docs/CardOrdersApi.md

@@ -0,0 +1,157 @@
+# Lob::CardOrdersApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**card_order_create**](CardOrdersApi.md#card_order_create) | **POST** /cards/{card_id}/orders | create |
+| [**card_orders_retrieve**](CardOrdersApi.md#card_orders_retrieve) | **GET** /cards/{card_id}/orders | get |
+
+
+## card_order_create
+
+> <CardOrder> card_order_create(card_id, card_order_editable)
+
+create
+
+Creates a new card order 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::CardOrdersApi.new
+card_id = 'card_id_example' # String | The ID of the card to which the card orders belong.
+card_order_editable = Lob::CardOrderEditable.new({quantity: 37}) # CardOrderEditable | 
+
+begin
+  # create
+  result = api_instance.create(card_id, card_order_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardOrdersApi->create: #{e}"
+end
+```
+
+#### Using the card_order_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CardOrder>, Integer, Hash)> card_order_create_with_http_info(card_id, card_order_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.card_order_create_with_http_info(card_id, card_order_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CardOrder>
+rescue Lob::ApiError => e
+  puts "Error when calling CardOrdersApi->card_order_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** | The ID of the card to which the card orders belong. |  |
+| **card_order_editable** | [**CardOrderEditable**](CardOrderEditable.md) |  |  |
+
+### Return type
+
+[**CardOrder**](CardOrder.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## card_orders_retrieve
+
+> <CardOrderList> card_orders_retrieve(card_id, opts)
+
+get
+
+Retrieves the card orders associated with the given card 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::CardOrdersApi.new
+card_id = 'card_id_example' # String | The ID of the card to which the card orders belong.
+opts = {
+  limit: 56, # Integer | How many results to return.
+  offset: 56 # Integer | An integer that designates the offset at which to begin returning results. Defaults to 0.
+}
+
+begin
+  # get
+  result = api_instance.get(card_id, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardOrdersApi->get: #{e}"
+end
+```
+
+#### Using the card_orders_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CardOrderList>, Integer, Hash)> card_orders_retrieve_with_http_info(card_id, opts)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.card_orders_retrieve_with_http_info(card_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CardOrderList>
+rescue Lob::ApiError => e
+  puts "Error when calling CardOrdersApi->card_orders_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** | The ID of the card to which the card orders belong. |  |
+| **limit** | **Integer** | How many results to return. | [optional][default to 10] |
+| **offset** | **Integer** | An integer that designates the offset at which to begin returning results. Defaults to 0. | [optional][default to 0] |
+
+### Return type
+
+[**CardOrderList**](CardOrderList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CardUpdatable.md

@@ -0,0 +1,22 @@
+# Lob::CardUpdatable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the card. | [optional] |
+| **auto_reorder** | **Boolean** | Allows for auto reordering | [optional] |
+| **reorder_quantity** | **Float** | The quantity of items to be reordered (only required when auto_reorder is true). | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CardUpdatable.new(
+  description: null,
+  auto_reorder: null,
+  reorder_quantity: null
+)
+```
+

data/docs/CardsApi.md

@@ -0,0 +1,372 @@
+# Lob::CardsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**card_create**](CardsApi.md#card_create) | **POST** /cards | create |
+| [**card_delete**](CardsApi.md#card_delete) | **DELETE** /cards/{card_id} | delete |
+| [**card_retrieve**](CardsApi.md#card_retrieve) | **GET** /cards/{card_id} | get |
+| [**card_update**](CardsApi.md#card_update) | **POST** /cards/{card_id} | update |
+| [**cards_list**](CardsApi.md#cards_list) | **GET** /cards | list |
+
+
+## card_create
+
+> <Card> card_create(card_editable)
+
+create
+
+Creates a new card 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::CardsApi.new
+card_editable = Lob::CardEditable.new({front: 'front_example'}) # CardEditable | 
+
+begin
+  # create
+  result = api_instance.create(card_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->create: #{e}"
+end
+```
+
+#### Using the card_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Card>, Integer, Hash)> card_create_with_http_info(card_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.card_create_with_http_info(card_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Card>
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->card_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_editable** | [**CardEditable**](CardEditable.md) |  |  |
+
+### Return type
+
+[**Card**](Card.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## card_delete
+
+> <CardDeletion> card_delete(card_id)
+
+delete
+
+Delete an existing card. You need only supply the unique identifier that was returned upon card 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::CardsApi.new
+card_id = 'card_id_example' # String | id of the card
+
+begin
+  # delete
+  result = api_instance.delete(card_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->delete: #{e}"
+end
+```
+
+#### Using the card_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CardDeletion>, Integer, Hash)> card_delete_with_http_info(card_id)
+
+```ruby
+begin
+  # delete
+  data, status_code, headers = api_instance.card_delete_with_http_info(card_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CardDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->card_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** | id of the card |  |
+
+### Return type
+
+[**CardDeletion**](CardDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## card_retrieve
+
+> <Card> card_retrieve(card_id)
+
+get
+
+Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card 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::CardsApi.new
+card_id = 'card_id_example' # String | id of the card
+
+begin
+  # get
+  result = api_instance.get(card_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->get: #{e}"
+end
+```
+
+#### Using the card_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Card>, Integer, Hash)> card_retrieve_with_http_info(card_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.card_retrieve_with_http_info(card_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Card>
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->card_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** | id of the card |  |
+
+### Return type
+
+[**Card**](Card.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## card_update
+
+> <Card> card_update(card_id, card_updatable)
+
+update
+
+Update the details of an existing card. You need only supply the unique identifier that was returned upon card 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::CardsApi.new
+card_id = 'card_id_example' # String | id of the card
+card_updatable = Lob::CardUpdatable.new # CardUpdatable | 
+
+begin
+  # update
+  result = api_instance.update(card_id, card_updatable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->update: #{e}"
+end
+```
+
+#### Using the card_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Card>, Integer, Hash)> card_update_with_http_info(card_id, card_updatable)
+
+```ruby
+begin
+  # update
+  data, status_code, headers = api_instance.card_update_with_http_info(card_id, card_updatable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Card>
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->card_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_id** | **String** | id of the card |  |
+| **card_updatable** | [**CardUpdatable**](CardUpdatable.md) |  |  |
+
+### Return type
+
+[**Card**](Card.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## cards_list
+
+> <CardList> cards_list(opts)
+
+list
+
+Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses 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::CardsApi.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 CardsApi->list: #{e}"
+end
+```
+
+#### Using the cards_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CardList>, Integer, Hash)> cards_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.cards_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CardList>
+rescue Lob::ApiError => e
+  puts "Error when calling CardsApi->cards_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
+
+[**CardList**](CardList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Check.md

@@ -0,0 +1,68 @@
+# Lob::Check
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `chk_`. |  |
+| **to** | [**Address**](Address.md) |  |  |
+| **from** | [**Address**](Address.md) |  | [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] |
+| **merge_variables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] |
+| **send_date** | **Time** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] |
+| **mail_type** | **String** | Checks must be sent `usps_first_class` | [optional][default to 'usps_first_class'] |
+| **memo** | **String** | Text to include on the memo line of the check. | [optional] |
+| **check_number** | **Integer** | An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number. | [optional] |
+| **message** | **String** | Max of 400 characters to be included at the bottom of the check page. | [optional] |
+| **amount** | **Float** | The payment amount to be sent in US dollars. |  |
+| **bank_account** | [**BankAccount**](BankAccount.md) |  |  |
+| **check_bottom_template_id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] |
+| **attachment_template_id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] |
+| **check_bottom_template_version_id** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
+| **attachment_template_version_id** | **String** | Unique identifier prefixed with `vrsn_`. | [optional] |
+| **url** | **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. |  |
+| **carrier** | **String** |  | [default to 'USPS'] |
+| **thumbnails** | [**Array<Thumbnail>**](Thumbnail.md) |  | [optional] |
+| **expected_delivery_date** | **Date** | A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. | [optional] |
+| **tracking_events** | [**Array<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode. | [optional] |
+| **object** | **String** |  | [default to 'check'] |
+| **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] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Check.new(
+  id: null,
+  to: null,
+  from: null,
+  description: null,
+  metadata: null,
+  merge_variables: null,
+  send_date: null,
+  mail_type: null,
+  memo: null,
+  check_number: null,
+  message: null,
+  amount: null,
+  bank_account: null,
+  check_bottom_template_id: null,
+  attachment_template_id: null,
+  check_bottom_template_version_id: null,
+  attachment_template_version_id: null,
+  url: null,
+  carrier: null,
+  thumbnails: null,
+  expected_delivery_date: null,
+  tracking_events: null,
+  object: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null
+)
+```
+

data/docs/CheckDeletion.md

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

data/docs/CheckEditable.md

@@ -0,0 +1,48 @@
+# Lob::CheckEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **from** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **to** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **bank_account** | **String** |  |  |
+| **amount** | **Float** | The payment amount to be sent in US dollars. |  |
+| **logo** | **String** | Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. | [optional] |
+| **check_bottom** | **String** | The artwork to use on the bottom of the check page.  Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf).  Need more help? Consult our [HTML examples](#section/HTML-Examples). | [optional] |
+| **attachment** | **String** | A document to include with the check. | [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] |
+| **merge_variables** | **Object** | You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. | [optional] |
+| **send_date** | **Time** | A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. | [optional] |
+| **mail_type** | **String** | Checks must be sent `usps_first_class` | [optional][default to 'usps_first_class'] |
+| **memo** | **String** | Text to include on the memo line of the check. | [optional] |
+| **check_number** | **Integer** | An integer that designates the check number. | [optional] |
+| **message** | **String** | Max of 400 characters to be included at the bottom of the check page. | [optional] |
+| **billing_group_id** | **String** | An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::CheckEditable.new(
+  from: null,
+  to: null,
+  bank_account: null,
+  amount: null,
+  logo: null,
+  check_bottom: null,
+  attachment: null,
+  description: null,
+  metadata: null,
+  merge_variables: null,
+  send_date: null,
+  mail_type: null,
+  memo: null,
+  check_number: null,
+  message: null,
+  billing_group_id: null
+)
+```
+