checkbook 1.0.1

data/docs/Directory.md

@@ -0,0 +1,520 @@
+# Checkbook::Directory
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_directory**](Directory.md#create_directory) | **POST** /v3/directory | Create a directory entry |
+| [**create_directory_bank**](Directory.md#create_directory_bank) | **POST** /v3/directory/{directory_id}/account/bank | Add a bank account to a directory entry |
+| [**create_directory_card**](Directory.md#create_directory_card) | **POST** /v3/directory/{directory_id}/account/card | Add a credit/debit card to a directory entry |
+| [**delete_directory**](Directory.md#delete_directory) | **DELETE** /v3/directory/{directory_id} | Remove a directory entry |
+| [**delete_directory_account**](Directory.md#delete_directory_account) | **DELETE** /v3/directory/{directory_id}/account/{account_id} | Remove a payment account from a directory entry |
+| [**get_directory**](Directory.md#get_directory) | **GET** /v3/directory | Get directory entries |
+| [**update_directory**](Directory.md#update_directory) | **PUT** /v3/directory/{directory_id} | Update a directory entry |
+
+
+## create_directory
+
+> <CreateDirectoryResponse> create_directory(create_directory_request)
+
+Create a directory entry
+
+Create a new directory 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::Directory.new
+create_directory_request = Checkbook::CreateDirectoryRequest.new({name: 'name_example'}) # CreateDirectoryRequest | 
+
+begin
+  # Create a directory entry
+  result = api_instance.create_directory(create_directory_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory: #{e}"
+end
+```
+
+#### Using the create_directory_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateDirectoryResponse>, Integer, Hash)> create_directory_with_http_info(create_directory_request)
+
+```ruby
+begin
+  # Create a directory entry
+  data, status_code, headers = api_instance.create_directory_with_http_info(create_directory_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateDirectoryResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_directory_request** | [**CreateDirectoryRequest**](CreateDirectoryRequest.md) |  |  |
+
+### Return type
+
+[**CreateDirectoryResponse**](CreateDirectoryResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_directory_bank
+
+> <CreateDirectoryBankResponse> create_directory_bank(directory_id, create_directory_bank_request)
+
+Add a bank account to a directory entry
+
+Create a new directory bank account
+
+### 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::Directory.new
+directory_id = 'directory_id_example' # String | 
+create_directory_bank_request = Checkbook::CreateDirectoryBankRequest.new({account: 'account_example', routing: 'routing_example', type: 'CHECKING'}) # CreateDirectoryBankRequest | 
+
+begin
+  # Add a bank account to a directory entry
+  result = api_instance.create_directory_bank(directory_id, create_directory_bank_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory_bank: #{e}"
+end
+```
+
+#### Using the create_directory_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateDirectoryBankResponse>, Integer, Hash)> create_directory_bank_with_http_info(directory_id, create_directory_bank_request)
+
+```ruby
+begin
+  # Add a bank account to a directory entry
+  data, status_code, headers = api_instance.create_directory_bank_with_http_info(directory_id, create_directory_bank_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateDirectoryBankResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **directory_id** | **String** |  |  |
+| **create_directory_bank_request** | [**CreateDirectoryBankRequest**](CreateDirectoryBankRequest.md) |  |  |
+
+### Return type
+
+[**CreateDirectoryBankResponse**](CreateDirectoryBankResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_directory_card
+
+> <CreateDirectoryCardResponse> create_directory_card(directory_id, create_directory_card_request)
+
+Add a credit/debit card to a directory entry
+
+Create a new directory card account
+
+### 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::Directory.new
+directory_id = 'directory_id_example' # String | 
+create_directory_card_request = Checkbook::CreateDirectoryCardRequest.new({card_number: 'card_number_example', expiration_date: 'expiration_date_example'}) # CreateDirectoryCardRequest | 
+
+begin
+  # Add a credit/debit card to a directory entry
+  result = api_instance.create_directory_card(directory_id, create_directory_card_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory_card: #{e}"
+end
+```
+
+#### Using the create_directory_card_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateDirectoryCardResponse>, Integer, Hash)> create_directory_card_with_http_info(directory_id, create_directory_card_request)
+
+```ruby
+begin
+  # Add a credit/debit card to a directory entry
+  data, status_code, headers = api_instance.create_directory_card_with_http_info(directory_id, create_directory_card_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateDirectoryCardResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->create_directory_card_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **directory_id** | **String** |  |  |
+| **create_directory_card_request** | [**CreateDirectoryCardRequest**](CreateDirectoryCardRequest.md) |  |  |
+
+### Return type
+
+[**CreateDirectoryCardResponse**](CreateDirectoryCardResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_directory
+
+> delete_directory(directory_id)
+
+Remove a directory entry
+
+Remove the directory 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::Directory.new
+directory_id = 'directory_id_example' # String | 
+
+begin
+  # Remove a directory entry
+  api_instance.delete_directory(directory_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->delete_directory: #{e}"
+end
+```
+
+#### Using the delete_directory_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_directory_with_http_info(directory_id)
+
+```ruby
+begin
+  # Remove a directory entry
+  data, status_code, headers = api_instance.delete_directory_with_http_info(directory_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->delete_directory_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **directory_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_directory_account
+
+> delete_directory_account(directory_id, account_id)
+
+Remove a payment account from a directory entry
+
+Remove a directory account
+
+### 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::Directory.new
+directory_id = 'directory_id_example' # String | 
+account_id = 'account_id_example' # String | 
+
+begin
+  # Remove a payment account from a directory entry
+  api_instance.delete_directory_account(directory_id, account_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->delete_directory_account: #{e}"
+end
+```
+
+#### Using the delete_directory_account_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_directory_account_with_http_info(directory_id, account_id)
+
+```ruby
+begin
+  # Remove a payment account from a directory entry
+  data, status_code, headers = api_instance.delete_directory_account_with_http_info(directory_id, account_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->delete_directory_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **directory_id** | **String** |  |  |
+| **account_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_directory
+
+> <GetDirectoriesResponse> get_directory(opts)
+
+Get directory entries
+
+Return the directory entry
+
+### 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::Directory.new
+opts = {
+  page: 1, # Integer | Page number
+  per_page: 10, # Integer | Items per page
+  q: 'q_example' # String | Query
+}
+
+begin
+  # Get directory entries
+  result = api_instance.get_directory(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->get_directory: #{e}"
+end
+```
+
+#### Using the get_directory_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetDirectoriesResponse>, Integer, Hash)> get_directory_with_http_info(opts)
+
+```ruby
+begin
+  # Get directory entries
+  data, status_code, headers = api_instance.get_directory_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetDirectoriesResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->get_directory_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] |
+| **q** | **String** | Query | [optional] |
+
+### Return type
+
+[**GetDirectoriesResponse**](GetDirectoriesResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_directory
+
+> update_directory(directory_id, update_directory_request)
+
+Update a directory entry
+
+Update a directory 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::Directory.new
+directory_id = 'directory_id_example' # String | 
+update_directory_request = Checkbook::UpdateDirectoryRequest.new # UpdateDirectoryRequest | 
+
+begin
+  # Update a directory entry
+  api_instance.update_directory(directory_id, update_directory_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->update_directory: #{e}"
+end
+```
+
+#### Using the update_directory_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> update_directory_with_http_info(directory_id, update_directory_request)
+
+```ruby
+begin
+  # Update a directory entry
+  data, status_code, headers = api_instance.update_directory_with_http_info(directory_id, update_directory_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Directory->update_directory_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **directory_id** | **String** |  |  |
+| **update_directory_request** | [**UpdateDirectoryRequest**](UpdateDirectoryRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+