lob 5.4.6 → 6.0.5

data/docs/BillingGroupsApi.md

@@ -0,0 +1,305 @@
+# Lob::BillingGroupsApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**billing_group_create**](BillingGroupsApi.md#billing_group_create) | **POST** /billing_groups | create |
+| [**billing_group_retrieve**](BillingGroupsApi.md#billing_group_retrieve) | **GET** /billing_groups/{bg_id} | get |
+| [**billing_group_update**](BillingGroupsApi.md#billing_group_update) | **POST** /billing_groups/{bg_id} | update |
+| [**billing_groups_list**](BillingGroupsApi.md#billing_groups_list) | **GET** /billing_groups | list |
+
+
+## billing_group_create
+
+> <BillingGroup> billing_group_create(billing_group_editable)
+
+create
+
+Creates a new billing_group with the provided properties.
+
+### 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::BillingGroupsApi.new
+billing_group_editable = Lob::BillingGroupEditable.new({name: 'name_example'}) # BillingGroupEditable | 
+
+begin
+  # create
+  result = api_instance.create(billing_group_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->create: #{e}"
+end
+```
+
+#### Using the billing_group_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingGroup>, Integer, Hash)> billing_group_create_with_http_info(billing_group_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.billing_group_create_with_http_info(billing_group_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingGroup>
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->billing_group_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_group_editable** | [**BillingGroupEditable**](BillingGroupEditable.md) |  |  |
+
+### Return type
+
+[**BillingGroup**](BillingGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## billing_group_retrieve
+
+> <BillingGroup> billing_group_retrieve(bg_id)
+
+get
+
+Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group 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::BillingGroupsApi.new
+bg_id = 'bg_id_example' # String | id of the billing_group
+
+begin
+  # get
+  result = api_instance.get(bg_id)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->get: #{e}"
+end
+```
+
+#### Using the billing_group_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingGroup>, Integer, Hash)> billing_group_retrieve_with_http_info(bg_id)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.billing_group_retrieve_with_http_info(bg_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingGroup>
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->billing_group_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bg_id** | **String** | id of the billing_group |  |
+
+### Return type
+
+[**BillingGroup**](BillingGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## billing_group_update
+
+> <BillingGroup> billing_group_update(bg_id, billing_group_editable)
+
+update
+
+Updates all editable attributes of the billing_group with the given 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::BillingGroupsApi.new
+bg_id = 'bg_id_example' # String | id of the billing_group
+billing_group_editable = Lob::BillingGroupEditable.new({name: 'name_example'}) # BillingGroupEditable | 
+
+begin
+  # update
+  result = api_instance.update(bg_id, billing_group_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->update: #{e}"
+end
+```
+
+#### Using the billing_group_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingGroup>, Integer, Hash)> billing_group_update_with_http_info(bg_id, billing_group_editable)
+
+```ruby
+begin
+  # update
+  data, status_code, headers = api_instance.billing_group_update_with_http_info(bg_id, billing_group_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingGroup>
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->billing_group_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bg_id** | **String** | id of the billing_group |  |
+| **billing_group_editable** | [**BillingGroupEditable**](BillingGroupEditable.md) |  |  |
+
+### Return type
+
+[**BillingGroup**](BillingGroup.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## billing_groups_list
+
+> <BillingGroupList> billing_groups_list(opts)
+
+list
+
+Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups 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::BillingGroupsApi.new
+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.
+  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.
+  date_modified: { key: 'inner_example'}, # Hash<String, String> | Filter by date modified.
+  sort_by_date_modified: Lob::SortByDateModified.new # SortByDateModified | Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. 
+}
+
+begin
+  # list
+  result = api_instance.list(opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->list: #{e}"
+end
+```
+
+#### Using the billing_groups_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BillingGroupList>, Integer, Hash)> billing_groups_list_with_http_info(opts)
+
+```ruby
+begin
+  # list
+  data, status_code, headers = api_instance.billing_groups_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BillingGroupList>
+rescue Lob::ApiError => e
+  puts "Error when calling BillingGroupsApi->billing_groups_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **date_modified** | [**Hash&lt;String, String&gt;**](String.md) | Filter by date modified. | [optional] |
+| **sort_by_date_modified** | [**SortByDateModified**](.md) | Sorts items by ascending or descending dates. Use either &#x60;date_created&#x60; or &#x60;date_modfied&#x60;, not both.  | [optional] |
+
+### Return type
+
+[**BillingGroupList**](BillingGroupList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Buckslip.md

@@ -0,0 +1,60 @@
+# Lob::Buckslip
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `bck_`. |  |
+| **auto_reorder** | **Boolean** | True if the buckslips should be auto-reordered. | [default to false] |
+| **reorder_quantity** | **Integer** | The number of buckslips to be reordered. |  |
+| **threshold_amount** | **Integer** | The threshold amount of the buckslip | [default to 0] |
+| **url** | **String** | The signed link for the buckslip. |  |
+| **raw_url** | **String** | The raw URL of the buckslip. |  |
+| **front_original_url** | **String** | The original URL of the front template. |  |
+| **back_original_url** | **String** | The original URL of the back template. |  |
+| **thumbnails** | [**Array<Thumbnail>**](Thumbnail.md) |  |  |
+| **available_quantity** | **Float** | The available quantity of buckslips. | [default to 0] |
+| **allocated_quantity** | **Float** | The allocated quantity of buckslips. | [default to 0] |
+| **onhand_quantity** | **Float** | The onhand quantity of buckslips. | [default to 0] |
+| **pending_quantity** | **Float** | The pending quantity of buckslips. | [default to 0] |
+| **projected_quantity** | **Float** | The sum of pending and onhand quantities of buckslips. | [default to 0] |
+| **buckslip_orders** | [**Array<BuckslipOrder>**](BuckslipOrder.md) | An array of buckslip orders that are associated with the buckslip. |  |
+| **stock** | **String** |  |  |
+| **weight** | **String** |  |  |
+| **finish** | **String** |  |  |
+| **status** | **String** |  |  |
+| **object** | **String** | object | [default to 'buckslip'] |
+| **description** | **String** | Description of the buckslip. |  |
+| **size** | **String** | The size of the buckslip | [optional][default to '8.75x3.75'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::Buckslip.new(
+  id: null,
+  auto_reorder: null,
+  reorder_quantity: null,
+  threshold_amount: null,
+  url: null,
+  raw_url: null,
+  front_original_url: null,
+  back_original_url: null,
+  thumbnails: null,
+  available_quantity: null,
+  allocated_quantity: null,
+  onhand_quantity: null,
+  pending_quantity: null,
+  projected_quantity: null,
+  buckslip_orders: null,
+  stock: null,
+  weight: null,
+  finish: null,
+  status: null,
+  object: null,
+  description: null,
+  size: null
+)
+```
+

data/docs/BuckslipDeletion.md

@@ -0,0 +1,20 @@
+# Lob::BuckslipDeletion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier prefixed with `bck_`. | [optional] |
+| **deleted** | **Boolean** | Only returned if the resource has been successfully deleted. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BuckslipDeletion.new(
+  id: null,
+  deleted: null
+)
+```
+

data/docs/BuckslipEditable.md

@@ -0,0 +1,24 @@
+# Lob::BuckslipEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **front** | **String** | A PDF template for the front of the buckslip |  |
+| **back** | **String** | A PDF template for the back of the buckslip | [optional] |
+| **description** | **String** | Description of the buckslip. | [optional] |
+| **size** | **String** | The size of the buckslip | [optional][default to '8.75x3.75'] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BuckslipEditable.new(
+  front: null,
+  back: null,
+  description: null,
+  size: null
+)
+```
+

data/docs/BuckslipOrder.md

@@ -0,0 +1,42 @@
+# Lob::BuckslipOrder
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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** | Value is type of resource. |  |
+| **id** | **String** | Unique identifier prefixed with `bo_`. | [optional] |
+| **buckslip_id** | **String** | Unique identifier prefixed with `bck_`. | [optional] |
+| **status** | **String** | The status of the buckslip order. | [optional] |
+| **quantity_ordered** | **Float** | The quantity of buckslips ordered. | [optional][default to 0] |
+| **unit_price** | **Float** | The unit price for the buckslip order. | [optional][default to 0] |
+| **inventory** | **Float** | The inventory of the buckslip order. | [optional][default to 0] |
+| **cancelled_reason** | **String** | The reason for cancellation. | [optional] |
+| **availability_date** | **Time** | A timestamp in ISO 8601 format of the date the resource was created. | [optional] |
+| **expected_availability_date** | **Time** | The fixed deadline for the buckslips to be printed. | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BuckslipOrder.new(
+  date_created: null,
+  date_modified: null,
+  deleted: null,
+  object: null,
+  id: null,
+  buckslip_id: null,
+  status: null,
+  quantity_ordered: null,
+  unit_price: null,
+  inventory: null,
+  cancelled_reason: null,
+  availability_date: null,
+  expected_availability_date: null
+)
+```
+

data/docs/BuckslipOrderEditable.md

@@ -0,0 +1,18 @@
+# Lob::BuckslipOrderEditable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **quantity** | **Integer** | The quantity of buckslips in the order (minimum 5,000). |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = Lob::BuckslipOrderEditable.new(
+  quantity: null
+)
+```
+

data/docs/BuckslipOrdersApi.md

@@ -0,0 +1,157 @@
+# Lob::BuckslipOrdersApi
+
+All URIs are relative to *https://api.lob.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**buckslip_order_create**](BuckslipOrdersApi.md#buckslip_order_create) | **POST** /buckslips/{buckslip_id}/orders | create |
+| [**buckslip_orders_retrieve**](BuckslipOrdersApi.md#buckslip_orders_retrieve) | **GET** /buckslips/{buckslip_id}/orders | get |
+
+
+## buckslip_order_create
+
+> <BuckslipOrder> buckslip_order_create(buckslip_id, buckslip_order_editable)
+
+create
+
+Creates a new buckslip 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::BuckslipOrdersApi.new
+buckslip_id = 'buckslip_id_example' # String | The ID of the buckslip to which the buckslip orders belong.
+buckslip_order_editable = Lob::BuckslipOrderEditable.new({quantity: 37}) # BuckslipOrderEditable | 
+
+begin
+  # create
+  result = api_instance.create(buckslip_id, buckslip_order_editable)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipOrdersApi->create: #{e}"
+end
+```
+
+#### Using the buckslip_order_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BuckslipOrder>, Integer, Hash)> buckslip_order_create_with_http_info(buckslip_id, buckslip_order_editable)
+
+```ruby
+begin
+  # create
+  data, status_code, headers = api_instance.buckslip_order_create_with_http_info(buckslip_id, buckslip_order_editable)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BuckslipOrder>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipOrdersApi->buckslip_order_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_id** | **String** | The ID of the buckslip to which the buckslip orders belong. |  |
+| **buckslip_order_editable** | [**BuckslipOrderEditable**](BuckslipOrderEditable.md) |  |  |
+
+### Return type
+
+[**BuckslipOrder**](BuckslipOrder.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
+- **Accept**: application/json
+
+
+## buckslip_orders_retrieve
+
+> <BuckslipOrdersList> buckslip_orders_retrieve(buckslip_id, opts)
+
+get
+
+Retrieves the buckslip orders associated with the given buckslip 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::BuckslipOrdersApi.new
+buckslip_id = 'buckslip_id_example' # String | The ID of the buckslip to which the buckslip 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(buckslip_id, opts)
+  p result
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipOrdersApi->get: #{e}"
+end
+```
+
+#### Using the buckslip_orders_retrieve_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BuckslipOrdersList>, Integer, Hash)> buckslip_orders_retrieve_with_http_info(buckslip_id, opts)
+
+```ruby
+begin
+  # get
+  data, status_code, headers = api_instance.buckslip_orders_retrieve_with_http_info(buckslip_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BuckslipOrdersList>
+rescue Lob::ApiError => e
+  puts "Error when calling BuckslipOrdersApi->buckslip_orders_retrieve_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **buckslip_id** | **String** | The ID of the buckslip to which the buckslip 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
+
+[**BuckslipOrdersList**](BuckslipOrdersList.md)
+
+### Authorization
+
+[basicAuth](../README.md#basicAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/BuckslipOrdersList.md

@@ -0,0 +1,26 @@
+# Lob::BuckslipOrdersList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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::BuckslipOrdersList.new(
+  object: null,
+  next_url: null,
+  previous_url: null,
+  count: null,
+  total_count: null
+)
+```
+

data/docs/BuckslipUpdatable.md

@@ -0,0 +1,22 @@
+# Lob::BuckslipUpdatable
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description of the buckslip. | [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::BuckslipUpdatable.new(
+  description: null,
+  auto_reorder: null,
+  reorder_quantity: null
+)
+```
+