checkbook 1.0.1

data/docs/Mailbox.md

@@ -0,0 +1,454 @@
+# Checkbook::Mailbox
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_mailbox**](Mailbox.md#create_mailbox) | **POST** /v3/mailbox | Create a mailbox |
+| [**get_mailbox**](Mailbox.md#get_mailbox) | **GET** /v3/mailbox/{mailbox_id} | Get mailbox info |
+| [**get_mailbox_item**](Mailbox.md#get_mailbox_item) | **GET** /v3/mailbox/{mailbox_id}/mail/{item_id} | Get mailbox item |
+| [**get_mailbox_item_attachment**](Mailbox.md#get_mailbox_item_attachment) | **GET** /v3/mailbox/{mailbox_id}/mail/{item_id}/attachment | Get attachment for a mail piece |
+| [**query_mailbox**](Mailbox.md#query_mailbox) | **GET** /v3/mailbox | Get mailboxes |
+| [**query_mailbox_item**](Mailbox.md#query_mailbox_item) | **GET** /v3/mailbox/{mailbox_id}/mail | Get mailbox info |
+
+
+## create_mailbox
+
+> <CreateMailboxResponse> create_mailbox
+
+Create a mailbox
+
+Create a new mailbox
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+
+begin
+  # Create a mailbox
+  result = api_instance.create_mailbox
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->create_mailbox: #{e}"
+end
+```
+
+#### Using the create_mailbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMailboxResponse>, Integer, Hash)> create_mailbox_with_http_info
+
+```ruby
+begin
+  # Create a mailbox
+  data, status_code, headers = api_instance.create_mailbox_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMailboxResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->create_mailbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CreateMailboxResponse**](CreateMailboxResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_mailbox
+
+> <CreateMailboxResponse> get_mailbox(mailbox_id)
+
+Get mailbox info
+
+Get mailbox details
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+mailbox_id = 'mailbox_id_example' # String | 
+
+begin
+  # Get mailbox info
+  result = api_instance.get_mailbox(mailbox_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox: #{e}"
+end
+```
+
+#### Using the get_mailbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateMailboxResponse>, Integer, Hash)> get_mailbox_with_http_info(mailbox_id)
+
+```ruby
+begin
+  # Get mailbox info
+  data, status_code, headers = api_instance.get_mailbox_with_http_info(mailbox_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateMailboxResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox_id** | **String** |  |  |
+
+### Return type
+
+[**CreateMailboxResponse**](CreateMailboxResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_mailbox_item
+
+> <MailResponse> get_mailbox_item(mailbox_id, item_id)
+
+Get mailbox item
+
+Get mailbox item
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+mailbox_id = 'mailbox_id_example' # String | 
+item_id = 'item_id_example' # String | 
+
+begin
+  # Get mailbox item
+  result = api_instance.get_mailbox_item(mailbox_id, item_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox_item: #{e}"
+end
+```
+
+#### Using the get_mailbox_item_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MailResponse>, Integer, Hash)> get_mailbox_item_with_http_info(mailbox_id, item_id)
+
+```ruby
+begin
+  # Get mailbox item
+  data, status_code, headers = api_instance.get_mailbox_item_with_http_info(mailbox_id, item_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MailResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox_id** | **String** |  |  |
+| **item_id** | **String** |  |  |
+
+### Return type
+
+[**MailResponse**](MailResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_mailbox_item_attachment
+
+> <Error> get_mailbox_item_attachment(mailbox_id, item_id)
+
+Get attachment for a mail piece
+
+Get mailbox item
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+mailbox_id = 'mailbox_id_example' # String | 
+item_id = 'item_id_example' # String | 
+
+begin
+  # Get attachment for a mail piece
+  result = api_instance.get_mailbox_item_attachment(mailbox_id, item_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox_item_attachment: #{e}"
+end
+```
+
+#### Using the get_mailbox_item_attachment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Error>, Integer, Hash)> get_mailbox_item_attachment_with_http_info(mailbox_id, item_id)
+
+```ruby
+begin
+  # Get attachment for a mail piece
+  data, status_code, headers = api_instance.get_mailbox_item_attachment_with_http_info(mailbox_id, item_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Error>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->get_mailbox_item_attachment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox_id** | **String** |  |  |
+| **item_id** | **String** |  |  |
+
+### Return type
+
+[**Error**](Error.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## query_mailbox
+
+> <GetMailboxesResponse> query_mailbox(opts)
+
+Get mailboxes
+
+Return the mailboxes for the current user
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+opts = {
+  page: 1, # Integer | Page number
+  per_page: 10 # Integer | Items per page
+}
+
+begin
+  # Get mailboxes
+  result = api_instance.query_mailbox(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->query_mailbox: #{e}"
+end
+```
+
+#### Using the query_mailbox_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMailboxesResponse>, Integer, Hash)> query_mailbox_with_http_info(opts)
+
+```ruby
+begin
+  # Get mailboxes
+  data, status_code, headers = api_instance.query_mailbox_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMailboxesResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->query_mailbox_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+
+### Return type
+
+[**GetMailboxesResponse**](GetMailboxesResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## query_mailbox_item
+
+> <GetMailResponse> query_mailbox_item(mailbox_id, opts)
+
+Get mailbox info
+
+Get mailbox items
+
+### Examples
+
+```ruby
+require 'time'
+require 'checkbook'
+# setup authorization
+Checkbook.configure do |config|
+  # Configure API key authorization: token
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = Checkbook::Mailbox.new
+mailbox_id = 'mailbox_id_example' # String | 
+opts = {
+  end_date: Date.parse('2013-10-20'), # Date | End date
+  page: 1, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'payment', # String | Query
+  start_date: Date.parse('2013-10-20') # Date | Start date
+}
+
+begin
+  # Get mailbox info
+  result = api_instance.query_mailbox_item(mailbox_id, opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->query_mailbox_item: #{e}"
+end
+```
+
+#### Using the query_mailbox_item_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMailResponse>, Integer, Hash)> query_mailbox_item_with_http_info(mailbox_id, opts)
+
+```ruby
+begin
+  # Get mailbox info
+  data, status_code, headers = api_instance.query_mailbox_item_with_http_info(mailbox_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMailResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Mailbox->query_mailbox_item_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mailbox_id** | **String** |  |  |
+| **end_date** | **Date** | End date | [optional] |
+| **page** | **Integer** | Page number | [optional][default to 1] |
+| **per_page** | **Integer** | Items per page | [optional][default to 50] |
+| **q** | **String** | Query | [optional] |
+| **start_date** | **Date** | Start date | [optional] |
+
+### Return type
+
+[**GetMailResponse**](GetMailResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+