lob 5.1.2 → 6.0.5

data/docs/IdentityValidationApi.md

@@ -0,0 +1,78 @@
+# Lob::IdentityValidationApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**identity_validation**](IdentityValidationApi.md#identity_validation) | **POST** /identity_validation | validate |
+
+
+## identity_validation
+
+> <IdentityValidation> identity_validation(multi_line_address)
+
+validate
+
+Validates whether a given name is associated with an address.
+
+### 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::IdentityValidationApi.new
+multi_line_address = Lob::MultiLineAddress.new({primary_line: 'primary_line_example'}) # MultiLineAddress | 
+
+begin
+  # validate
+  result = api_instance.validate(multi_line_address)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling IdentityValidationApi->validate: #{e}"
+end
+```
+
+#### Using the identity_validation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IdentityValidation>, Integer, Hash)> identity_validation_with_http_info(multi_line_address)
+
+```ruby
+begin
+  # validate
+  data, status_code, headers = api_instance.identity_validation_with_http_info(multi_line_address)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IdentityValidation>
+rescue Lob::ApiError => e
+  puts "Error when calling IdentityValidationApi->identity_validation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **multi_line_address** | [**MultiLineAddress**](MultiLineAddress.md) |  |  |
+
+### Return type
+
+[**IdentityValidation**](IdentityValidation.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/InlineObject.md

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

data/docs/IntlAutocompletions.md

@@ -0,0 +1,20 @@
+# Lob::IntlAutocompletions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `intl_auto_`. | [optional] |
+| **suggestions** | [**Array<IntlSuggestions>**](IntlSuggestions.md) | An array of objects representing suggested addresses.  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlAutocompletions.new(
+  id: null,
+  suggestions: null
+)
+```
+

data/docs/IntlAutocompletionsApi.md

@@ -0,0 +1,82 @@
+# Lob::IntlAutocompletionsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**intl_autocompletion**](IntlAutocompletionsApi.md#intl_autocompletion) | **POST** /intl_autocompletions | autocomplete |
+
+
+## intl_autocompletion
+
+> <IntlAutocompletions> intl_autocompletion(intl_autocompletions_writable, opts)
+
+autocomplete
+
+Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification).
+
+### 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::IntlAutocompletionsApi.new
+intl_autocompletions_writable = Lob::IntlAutocompletionsWritable.new({address_prefix: 'address_prefix_example', country: Lob::CountryExtended::AD}) # IntlAutocompletionsWritable | 
+opts = {
+  x_lang_output: 'native' # String | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request  Default response is in English. 
+}
+
+begin
+  # autocomplete
+  result = api_instance.autocomplete(intl_autocompletions_writable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling IntlAutocompletionsApi->autocomplete: #{e}"
+end
+```
+
+#### Using the intl_autocompletion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntlAutocompletions>, Integer, Hash)> intl_autocompletion_with_http_info(intl_autocompletions_writable, opts)
+
+```ruby
+begin
+  # autocomplete
+  data, status_code, headers = api_instance.intl_autocompletion_with_http_info(intl_autocompletions_writable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntlAutocompletions>
+rescue Lob::ApiError => e
+  puts "Error when calling IntlAutocompletionsApi->intl_autocompletion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **intl_autocompletions_writable** | [**IntlAutocompletionsWritable**](IntlAutocompletionsWritable.md) |  |  |
+| **x_lang_output** | **String** | * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.  | [optional] |
+
+### Return type
+
+[**IntlAutocompletions**](IntlAutocompletions.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/IntlAutocompletionsWritable.md

@@ -0,0 +1,26 @@
+# Lob::IntlAutocompletionsWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_prefix** | **String** | Only accepts numbers and street names in an alphanumeric format.  |  |
+| **city** | **String** | An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations.  | [optional] |
+| **state** | **String** | An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations.  | [optional] |
+| **zip_code** | **String** | An optional Zip Code input used to filter suggestions. Matches partial entries.  | [optional] |
+| **country** | [**CountryExtended**](CountryExtended.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlAutocompletionsWritable.new(
+  address_prefix: null,
+  city: null,
+  state: null,
+  zip_code: null,
+  country: null
+)
+```
+

data/docs/IntlComponents.md

@@ -0,0 +1,26 @@
+# Lob::IntlComponents
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_number** | **String** | The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. | [optional] |
+| **street_name** | **String** | The name of the street. | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state.  | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlComponents.new(
+  primary_number: null,
+  street_name: null,
+  city: null,
+  state: null,
+  postal_code: null
+)
+```
+

data/docs/IntlSuggestions.md

@@ -0,0 +1,30 @@
+# Lob::IntlSuggestions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **primary_number_range** | **String** | The primary number range of the address that identifies a building at street level.  |  |
+| **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.  |  |
+| **country** | [**CountryExtended**](CountryExtended.md) |  |  |
+| **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 'intl_autocompletion'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlSuggestions.new(
+  primary_number_range: null,
+  primary_line: null,
+  city: null,
+  state: null,
+  country: null,
+  zip_code: null,
+  object: null
+)
+```
+

data/docs/IntlVerification.md

@@ -0,0 +1,38 @@
+# Lob::IntlVerification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `intl_ver_`. | [optional] |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address.  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **last_line** | **String** | Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4`  | [optional] |
+| **country** | **String** | The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166). | [optional] |
+| **coverage** | **String** | The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to.  * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases  | [optional] |
+| **deliverability** | **String** | Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code.  | [optional] |
+| **status** | **String** | The status level for the country. This represents the maximum level of accuracy an input address can be verified to.  * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched.  | [optional] |
+| **components** | [**IntlComponents**](IntlComponents.md) |  | [optional] |
+| **object** | **String** | Value is resource type. | [optional][default to 'intl_verification'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlVerification.new(
+  id: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  last_line: null,
+  country: null,
+  coverage: null,
+  deliverability: null,
+  status: null,
+  components: null,
+  object: null
+)
+```
+

data/docs/IntlVerificationOrError.md

@@ -0,0 +1,40 @@
+# Lob::IntlVerificationOrError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `intl_ver_`. | [optional] |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** |  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **last_line** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+| **coverage** | **String** |  | [optional] |
+| **deliverability** | **String** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **components** | [**IntlComponents**](IntlComponents.md) |  | [optional] |
+| **object** | **String** |  | [optional][default to 'intl_verification'] |
+| **error** | [**BulkError**](BulkError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlVerificationOrError.new(
+  id: null,
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  last_line: null,
+  country: null,
+  coverage: null,
+  deliverability: null,
+  status: null,
+  components: null,
+  object: null,
+  error: null
+)
+```
+

data/docs/IntlVerificationWritable.md

@@ -0,0 +1,32 @@
+# Lob::IntlVerificationWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **recipient** | **String** | The intended recipient, typically a person's or firm's name. | [optional] |
+| **primary_line** | **String** | The primary delivery line (usually the street address) of the address.  | [optional] |
+| **secondary_line** | **String** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long.  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** | The name of the state. | [optional] |
+| **postal_code** | **String** | The postal code. | [optional] |
+| **country** | [**CountryExtended**](CountryExtended.md) |  | [optional] |
+| **address** | **String** | The entire address in one string (e.g., \"370 Water St C1N 1C4\").  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlVerificationWritable.new(
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  city: null,
+  state: null,
+  postal_code: null,
+  country: null,
+  address: null
+)
+```
+

data/docs/IntlVerifications.md

@@ -0,0 +1,20 @@
+# Lob::IntlVerifications
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addresses** | [**Array<IntlVerificationOrError>**](IntlVerificationOrError.md) |  |  |
+| **errors** | **Boolean** | Indicates whether any errors occurred during the verification process. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlVerifications.new(
+  addresses: null,
+  errors: null
+)
+```
+

data/docs/IntlVerificationsApi.md

@@ -0,0 +1,153 @@
+# Lob::IntlVerificationsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_intl_verifications**](IntlVerificationsApi.md#bulk_intl_verifications) | **POST** /bulk/intl_verifications | verifyBulk |
+| [**intl_verification**](IntlVerificationsApi.md#intl_verification) | **POST** /intl_verifications | verifySingle |
+
+
+## bulk_intl_verifications
+
+> <IntlVerifications> bulk_intl_verifications(intl_verifications_payload)
+
+verifyBulk
+
+Verify a list of international (except US or US territories) address with a live API key.
+
+### 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::IntlVerificationsApi.new
+intl_verifications_payload = Lob::IntlVerificationsPayload.new({addresses: [Lob::MultipleComponentsIntl.new({primary_line: 'primary_line_example', country: Lob::CountryExtended::AD})]}) # IntlVerificationsPayload | 
+
+begin
+  # verifyBulk
+  result = api_instance.verifyBulk(intl_verifications_payload)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling IntlVerificationsApi->verifyBulk: #{e}"
+end
+```
+
+#### Using the bulk_intl_verifications_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntlVerifications>, Integer, Hash)> bulk_intl_verifications_with_http_info(intl_verifications_payload)
+
+```ruby
+begin
+  # verifyBulk
+  data, status_code, headers = api_instance.bulk_intl_verifications_with_http_info(intl_verifications_payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntlVerifications>
+rescue Lob::ApiError => e
+  puts "Error when calling IntlVerificationsApi->bulk_intl_verifications_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **intl_verifications_payload** | [**IntlVerificationsPayload**](IntlVerificationsPayload.md) |  |  |
+
+### Return type
+
+[**IntlVerifications**](IntlVerifications.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## intl_verification
+
+> <IntlVerification> intl_verification(intl_verification_writable, opts)
+
+verifySingle
+
+Verify an international (except US or US territories) address with a live API key.
+
+### 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::IntlVerificationsApi.new
+intl_verification_writable = Lob::IntlVerificationWritable.new # IntlVerificationWritable | 
+opts = {
+  x_lang_output: 'native' # String | * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request  Default response is in English. 
+}
+
+begin
+  # verifySingle
+  result = api_instance.verifySingle(intl_verification_writable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling IntlVerificationsApi->verifySingle: #{e}"
+end
+```
+
+#### Using the intl_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IntlVerification>, Integer, Hash)> intl_verification_with_http_info(intl_verification_writable, opts)
+
+```ruby
+begin
+  # verifySingle
+  data, status_code, headers = api_instance.intl_verification_with_http_info(intl_verification_writable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IntlVerification>
+rescue Lob::ApiError => e
+  puts "Error when calling IntlVerificationsApi->intl_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **intl_verification_writable** | [**IntlVerificationWritable**](IntlVerificationWritable.md) |  |  |
+| **x_lang_output** | **String** | * &#x60;native&#x60; - Translate response to the native language of the country in the request * &#x60;match&#x60; - match the response to the language in the request  Default response is in English.  | [optional] |
+
+### Return type
+
+[**IntlVerification**](IntlVerification.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+

data/docs/IntlVerificationsPayload.md

@@ -0,0 +1,18 @@
+# Lob::IntlVerificationsPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **addresses** | [**Array<MultipleComponentsIntl>**](MultipleComponentsIntl.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::IntlVerificationsPayload.new(
+  addresses: null
+)
+```
+

data/docs/Letter.md

@@ -0,0 +1,72 @@
+# Lob::Letter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | [**Address**](Address.md) |  |  |
+| **from** | [**Address**](Address.md) |  |  |
+| **carrier** | **String** |  | [optional][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] |
+| **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] |
+| **id** | **String** | Unique identifier prefixed with `ltr_`. |  |
+| **template_id** | **String** | Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). | [optional] |
+| **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. | [optional] |
+| **object** | **String** |  | [default to 'letter'] |
+| **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] |
+| **extra_service** | **String** | Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. | [optional] |
+| **tracking_number** | **String** | The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode. | [optional] |
+| **tracking_events** | [**Array<TrackingEventNormal>**](TrackingEventNormal.md) | Tracking events are not populated for registered or regular (no extra service) letters. | [optional] |
+| **return_address** | [**AnyType**](.md) | Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request. | [optional] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **color** | **Boolean** | Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. | [optional] |
+| **double_sided** | **Boolean** | Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. | [optional][default to true] |
+| **address_placement** | **String** | Specifies the location of the address information that will show through the double-window envelope.  | [optional][default to 'top_first_page'] |
+| **return_envelope** | [**AnyType**](.md) |  |  |
+| **perforated_page** | **Integer** | Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). | [optional] |
+| **custom_envelope** | [**LetterCustomEnvelope**](LetterCustomEnvelope.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Letter.new(
+  to: null,
+  from: null,
+  carrier: null,
+  thumbnails: null,
+  expected_delivery_date: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  id: null,
+  template_id: null,
+  template_version_id: null,
+  url: null,
+  object: null,
+  description: null,
+  metadata: null,
+  merge_variables: null,
+  send_date: null,
+  extra_service: null,
+  tracking_number: null,
+  tracking_events: null,
+  return_address: null,
+  mail_type: null,
+  color: null,
+  double_sided: null,
+  address_placement: null,
+  return_envelope: null,
+  perforated_page: null,
+  custom_envelope: null
+)
+```
+