lob 5.1.2 → 6.0.2

data/docs/AddressEditable.md

@@ -0,0 +1,40 @@
+# Lob::AddressEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_line1** | **String** | The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. | [optional] |
+| **address_line2** | **String** | The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. | [optional] |
+| **address_city** | **String** |  | [optional] |
+| **address_state** | **String** |  | [optional] |
+| **address_zip** | **String** | Optional postal code. For US addresses, must be either 5 or 9 digits. | [optional] |
+| **address_country** | [**CountryExtended**](CountryExtended.md) |  | [optional] |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **name** | **String** | name associated with address. | [optional] |
+| **company** | **String** | Either `name` or `company` is required, you may also add both. | [optional] |
+| **phone** | **String** | Must be no longer than 40 characters. | [optional] |
+| **email** | **String** | Must be no longer than 100 characters. | [optional] |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::AddressEditable.new(
+  address_line1: null,
+  address_line2: null,
+  address_city: null,
+  address_state: null,
+  address_zip: null,
+  address_country: null,
+  description: null,
+  name: null,
+  company: null,
+  phone: null,
+  email: null,
+  metadata: null
+)
+```
+

data/docs/AddressList.md

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

data/docs/AddressesApi.md

@@ -0,0 +1,303 @@
+# Lob::AddressesApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**address_create**](AddressesApi.md#address_create) | **POST** /addresses | create |
+| [**address_delete**](AddressesApi.md#address_delete) | **DELETE** /addresses/{adr_id} | delete |
+| [**address_retrieve**](AddressesApi.md#address_retrieve) | **GET** /addresses/{adr_id} | get |
+| [**addresses_list**](AddressesApi.md#addresses_list) | **GET** /addresses | list |
+
+
+## address_create
+
+> <Address> address_create(address_editable)
+
+create
+
+Creates a new address 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::AddressesApi.new
+address_editable = Lob::AddressEditable.new # AddressEditable | 
+
+begin
+  # create
+  result = api_instance.create(address_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->create: #{e}"
+end
+```
+
+#### Using the address_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Address>, Integer, Hash)> address_create_with_http_info(address_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.address_create_with_http_info(address_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Address>
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->address_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **address_editable** | [**AddressEditable**](AddressEditable.md) |  |  |
+
+### Return type
+
+[**Address**](Address.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## address_delete
+
+> <AddressDeletion> address_delete(adr_id)
+
+delete
+
+Deletes the details of an existing 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::AddressesApi.new
+adr_id = 'adr_id_example' # String | id of the address
+
+begin
+  # delete
+  result = api_instance.delete(adr_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->delete: #{e}"
+end
+```
+
+#### Using the address_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddressDeletion>, Integer, Hash)> address_delete_with_http_info(adr_id)
+
+```ruby
+begin
+  # delete
+  data, status_code, headers = api_instance.address_delete_with_http_info(adr_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddressDeletion>
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->address_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adr_id** | **String** | id of the address |  |
+
+### Return type
+
+[**AddressDeletion**](AddressDeletion.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## address_retrieve
+
+> <Address> address_retrieve(adr_id)
+
+get
+
+Retrieves the details of an existing 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::AddressesApi.new
+adr_id = 'adr_id_example' # String | id of the address
+
+begin
+  # get
+  result = api_instance.get(adr_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->get: #{e}"
+end
+```
+
+#### Using the address_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Address>, Integer, Hash)> address_retrieve_with_http_info(adr_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.address_retrieve_with_http_info(adr_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Address>
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->address_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adr_id** | **String** | id of the address |  |
+
+### Return type
+
+[**Address**](Address.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## addresses_list
+
+> <AddressList> addresses_list(opts)
+
+list
+
+Returns a list of your addresses.
+
+### 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::AddressesApi.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`.
+}
+
+begin
+  # list
+  result = api_instance.list(opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->list: #{e}"
+end
+```
+
+#### Using the addresses_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddressList>, Integer, Hash)> addresses_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.addresses_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddressList>
+rescue Lob::ApiError => e
+  puts "Error when calling AddressesApi->addresses_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] |
+
+### Return type
+
+[**AddressList**](AddressList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BankAccount.md

@@ -0,0 +1,44 @@
+# Lob::BankAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **routing_number** | **String** | Must be a [valid US routing number](https://www.frbservices.org/index.html). |  |
+| **account_number** | **String** |  |  |
+| **account_type** | **String** | The type of entity that holds the account. |  |
+| **signatory** | **String** | The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). |  |
+| **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] |
+| **id** | **String** | Unique identifier prefixed with `bank_`. |  |
+| **signature_url** | **String** | A signed link to the signature image. will be generated. | [optional] |
+| **bank_name** | **String** | The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`. | [optional] |
+| **verified** | **Boolean** | A bank account must be verified before a check can be created. | [optional][default to false] |
+| **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] |
+| **object** | **String** |  | [default to 'bank_account'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BankAccount.new(
+  description: null,
+  routing_number: null,
+  account_number: null,
+  account_type: null,
+  signatory: null,
+  metadata: null,
+  id: null,
+  signature_url: null,
+  bank_name: null,
+  verified: null,
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  object: null
+)
+```
+

data/docs/BankAccountDeletion.md

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

data/docs/BankAccountList.md

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

data/docs/BankAccountVerify.md

@@ -0,0 +1,18 @@
+# Lob::BankAccountVerify
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amounts** | **Array<Integer>** | In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work. |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BankAccountVerify.new(
+  amounts: null
+)
+```
+

data/docs/BankAccountWritable.md

@@ -0,0 +1,28 @@
+# Lob::BankAccountWritable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | An internal description that identifies this resource. Must be no longer than 255 characters.  | [optional] |
+| **routing_number** | **String** | Must be a [valid US routing number](https://www.frbservices.org/index.html). |  |
+| **account_number** | **String** |  |  |
+| **account_type** | [**BankTypeEnum**](BankTypeEnum.md) |  |  |
+| **signatory** | **String** | The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). |  |
+| **metadata** | **Hash<String, String>** | Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported.  See [Metadata](#section/Metadata) for more information. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BankAccountWritable.new(
+  description: null,
+  routing_number: null,
+  account_number: null,
+  account_type: null,
+  signatory: null,
+  metadata: null
+)
+```
+