lob 5.4.6 → 6.0.5

data/docs/MultipleComponents.md

@@ -0,0 +1,30 @@
+# Lob::MultipleComponents
+
+## 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. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number`  |  |
+| **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] |
+| **urbanization** | **String** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.  | [optional] |
+| **city** | **String** |  | [optional] |
+| **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional] |
+| **zip_code** | **String** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::MultipleComponents.new(
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  urbanization: null,
+  city: null,
+  state: null,
+  zip_code: null
+)
+```
+

data/docs/MultipleComponentsIntl.md

@@ -0,0 +1,30 @@
+# Lob::MultipleComponentsIntl
+
+## 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.  |  |
+| **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) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::MultipleComponentsIntl.new(
+  recipient: null,
+  primary_line: null,
+  secondary_line: null,
+  city: null,
+  state: null,
+  postal_code: null,
+  country: null
+)
+```
+

data/docs/MultipleComponentsList.md

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

data/docs/PlaceholderModel.md

@@ -0,0 +1,28 @@
+# Lob::PlaceholderModel
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **return_envelope** | [**ReturnEnvelope**](ReturnEnvelope.md) |  | [optional] |
+| **address_domestic** | [**AddressDomestic**](AddressDomestic.md) |  | [optional] |
+| **letter_details_writable** | [**LetterDetailsWritable**](LetterDetailsWritable.md) |  | [optional] |
+| **postcard_details_writable** | [**PostcardDetailsWritable**](PostcardDetailsWritable.md) |  | [optional] |
+| **letter_details_returned** | [**LetterDetailsReturned**](LetterDetailsReturned.md) |  | [optional] |
+| **postcard_details_returned** | [**PostcardDetailsReturned**](PostcardDetailsReturned.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::PlaceholderModel.new(
+  return_envelope: null,
+  address_domestic: null,
+  letter_details_writable: null,
+  postcard_details_writable: null,
+  letter_details_returned: null,
+  postcard_details_returned: null
+)
+```
+

data/docs/Postcard.md

@@ -0,0 +1,60 @@
+# Lob::Postcard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `psc_`. |  |
+| **to** | [**Address**](Address.md) |  | [optional] |
+| **from** | [**AddressDomesticExpanded**](AddressDomesticExpanded.md) |  | [optional] |
+| **carrier** | **String** |  | [optional][default to 'USPS'] |
+| **thumbnails** | [**Array<Thumbnail>**](Thumbnail.md) |  | [optional] |
+| **size** | [**PostcardSize**](PostcardSize.md) |  | [optional][default to '4x6'] |
+| **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. | [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] |
+| **front_template_id** | **String** | The unique ID of the HTML template used for the front of the postcard. | [optional] |
+| **back_template_id** | **String** | The unique ID of the HTML template used for the back of the postcard. | [optional] |
+| **front_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the front of the postcard. | [optional] |
+| **back_template_version_id** | **String** | The unique ID of the specific version of the HTML template used for the back of the postcard. | [optional] |
+| **tracking_events** | [**Array<TrackingEventNormal>**](TrackingEventNormal.md) | An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode. | [optional] |
+| **object** | **String** |  | [optional][default to 'postcard'] |
+| **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. |  |
+| **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] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **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] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Postcard.new(
+  id: null,
+  to: null,
+  from: null,
+  carrier: null,
+  thumbnails: null,
+  size: null,
+  expected_delivery_date: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  front_template_id: null,
+  back_template_id: null,
+  front_template_version_id: null,
+  back_template_version_id: null,
+  tracking_events: null,
+  object: null,
+  url: null,
+  description: null,
+  metadata: null,
+  mail_type: null,
+  merge_variables: null,
+  send_date: null
+)
+```
+

data/docs/PostcardDeletion.md

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

data/docs/PostcardDetailsReturned.md

@@ -0,0 +1,26 @@
+# Lob::PostcardDetailsReturned
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **size** | [**PostcardSize**](PostcardSize.md) |  | [optional][default to '4x6'] |
+| **setting** | **Integer** |  | [optional][default to 1001] |
+| **front_original_url** | **String** | The original URL of the front template. | [optional] |
+| **back_original_url** | **String** | The original URL of the back template. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::PostcardDetailsReturned.new(
+  mail_type: null,
+  size: null,
+  setting: null,
+  front_original_url: null,
+  back_original_url: null
+)
+```
+

data/docs/PostcardDetailsWritable.md

@@ -0,0 +1,20 @@
+# Lob::PostcardDetailsWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **size** | [**PostcardSize**](PostcardSize.md) |  | [optional][default to '4x6'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::PostcardDetailsWritable.new(
+  mail_type: null,
+  size: null
+)
+```
+

data/docs/PostcardEditable.md

@@ -0,0 +1,40 @@
+# Lob::PostcardEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **to** | [**AnyType**](.md) | Must either be an address ID or an inline object with correct address parameters. |  |
+| **from** | [**AnyType**](.md) | Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. | [optional] |
+| **size** | [**PostcardSize**](PostcardSize.md) |  | [optional][default to '4x6'] |
+| **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] |
+| **mail_type** | [**MailType**](MailType.md) |  | [optional][default to 'usps_first_class'] |
+| **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] |
+| **front** | **String** | The artwork to use as the front of your postcard.  |  |
+| **back** | **String** | The artwork to use as the back of your postcard.  |  |
+| **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] |
+| **qr_code** | [**QrCode**](QrCode.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::PostcardEditable.new(
+  to: null,
+  from: null,
+  size: null,
+  description: null,
+  metadata: null,
+  mail_type: null,
+  merge_variables: null,
+  send_date: null,
+  front: null,
+  back: null,
+  billing_group_id: null,
+  qr_code: null
+)
+```
+

data/docs/PostcardList.md

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

data/docs/PostcardSize.md

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

data/docs/PostcardsApi.md

@@ -0,0 +1,317 @@
+# Lob::PostcardsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**postcard_create**](PostcardsApi.md#postcard_create) | **POST** /postcards | create |
+| [**postcard_delete**](PostcardsApi.md#postcard_delete) | **DELETE** /postcards/{psc_id} | cancel |
+| [**postcard_retrieve**](PostcardsApi.md#postcard_retrieve) | **GET** /postcards/{psc_id} | get |
+| [**postcards_list**](PostcardsApi.md#postcards_list) | **GET** /postcards | list |
+
+
+## postcard_create
+
+> <Postcard> postcard_create(postcard_editable, opts)
+
+create
+
+Creates a new postcard 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::PostcardsApi.new
+postcard_editable = Lob::PostcardEditable.new({to: TODO, front: 'front_example', back: 'back_example'}) # PostcardEditable | 
+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(postcard_editable, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->create: #{e}"
+end
+```
+
+#### Using the postcard_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Postcard>, Integer, Hash)> postcard_create_with_http_info(postcard_editable, opts)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.postcard_create_with_http_info(postcard_editable, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Postcard>
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->postcard_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **postcard_editable** | [**PostcardEditable**](PostcardEditable.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
+
+[**Postcard**](Postcard.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## postcard_delete
+
+> <PostcardDeletion> postcard_delete(psc_id)
+
+cancel
+
+Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard 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::PostcardsApi.new
+psc_id = 'psc_id_example' # String | id of the postcard
+
+begin
+  # cancel
+  result = api_instance.cancel(psc_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->cancel: #{e}"
+end
+```
+
+#### Using the postcard_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostcardDeletion>, Integer, Hash)> postcard_delete_with_http_info(psc_id)
+
+```ruby
+begin
+  # cancel
+  data, status_code, headers = api_instance.postcard_delete_with_http_info(psc_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostcardDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->postcard_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **psc_id** | **String** | id of the postcard |  |
+
+### Return type
+
+[**PostcardDeletion**](PostcardDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## postcard_retrieve
+
+> <Postcard> postcard_retrieve(psc_id)
+
+get
+
+Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard 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::PostcardsApi.new
+psc_id = 'psc_id_example' # String | id of the postcard
+
+begin
+  # get
+  result = api_instance.get(psc_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->get: #{e}"
+end
+```
+
+#### Using the postcard_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Postcard>, Integer, Hash)> postcard_retrieve_with_http_info(psc_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.postcard_retrieve_with_http_info(psc_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Postcard>
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->postcard_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **psc_id** | **String** | id of the postcard |  |
+
+### Return type
+
+[**Postcard**](Postcard.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## postcards_list
+
+> <PostcardList> postcards_list(opts)
+
+list
+
+Returns a list of your postcards. The addresses 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::PostcardsApi.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`.
+  size: [Lob::PostcardSize::N4X6], # Array<PostcardSize> | Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations.
+  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 PostcardsApi->list: #{e}"
+end
+```
+
+#### Using the postcards_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PostcardList>, Integer, Hash)> postcards_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.postcards_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PostcardList>
+rescue Lob::ApiError => e
+  puts "Error when calling PostcardsApi->postcards_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] |
+| **size** | [**Array&lt;PostcardSize&gt;**](PostcardSize.md) | Specifies the size of the postcard. Only &#x60;4x6&#x60; postcards can be sent to international destinations. | [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
+
+[**PostcardList**](PostcardList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+