checkbook 1.0.1

data/docs/Approval.md

@@ -0,0 +1,669 @@
+# Checkbook::Approval
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_approval_check**](Approval.md#delete_approval_check) | **DELETE** /v3/approval/{approval_id} | Remove payment approval |
+| [**get_approval_attachment**](Approval.md#get_approval_attachment) | **GET** /v3/approval/{approval_id}/attachment | Get attachment for payment approval |
+| [**get_approval_check**](Approval.md#get_approval_check) | **GET** /v3/approval/{approval_id} | Get payment approval |
+| [**get_approval_checks**](Approval.md#get_approval_checks) | **GET** /v3/approval | Get approval payments |
+| [**post_approval_digital**](Approval.md#post_approval_digital) | **POST** /v3/approval/digital | Create approval digital payment |
+| [**post_approval_multi**](Approval.md#post_approval_multi) | **POST** /v3/approval/multi | Create multi-party payment approval |
+| [**post_approval_physical**](Approval.md#post_approval_physical) | **POST** /v3/approval/physical | Create physical check approval |
+| [**post_approval_release**](Approval.md#post_approval_release) | **POST** /v3/approval/release | Approve payment |
+| [**put_approval_check**](Approval.md#put_approval_check) | **PUT** /v3/approval/{approval_id} | Update payment approval |
+
+
+## delete_approval_check
+
+> delete_approval_check(approval_id)
+
+Remove payment approval
+
+Cancel the specified check approval
+
+### 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::Approval.new
+approval_id = 'approval_id_example' # String | 
+
+begin
+  # Remove payment approval
+  api_instance.delete_approval_check(approval_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->delete_approval_check: #{e}"
+end
+```
+
+#### Using the delete_approval_check_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_approval_check_with_http_info(approval_id)
+
+```ruby
+begin
+  # Remove payment approval
+  data, status_code, headers = api_instance.delete_approval_check_with_http_info(approval_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->delete_approval_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_approval_attachment
+
+> File get_approval_attachment(approval_id)
+
+Get attachment for payment approval
+
+Get the attachment for a payment approval
+
+### 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::Approval.new
+approval_id = 'approval_id_example' # String | 
+
+begin
+  # Get attachment for payment approval
+  result = api_instance.get_approval_attachment(approval_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_attachment: #{e}"
+end
+```
+
+#### Using the get_approval_attachment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> get_approval_attachment_with_http_info(approval_id)
+
+```ruby
+begin
+  # Get attachment for payment approval
+  data, status_code, headers = api_instance.get_approval_attachment_with_http_info(approval_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_attachment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_id** | **String** |  |  |
+
+### Return type
+
+**File**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/pdf, application/json
+
+
+## get_approval_check
+
+> <GetApprovalResponse> get_approval_check(approval_id)
+
+Get payment approval
+
+Get the specified payment approval
+
+### 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::Approval.new
+approval_id = 'approval_id_example' # String | 
+
+begin
+  # Get payment approval
+  result = api_instance.get_approval_check(approval_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_check: #{e}"
+end
+```
+
+#### Using the get_approval_check_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalResponse>, Integer, Hash)> get_approval_check_with_http_info(approval_id)
+
+```ruby
+begin
+  # Get payment approval
+  data, status_code, headers = api_instance.get_approval_check_with_http_info(approval_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_id** | **String** |  |  |
+
+### Return type
+
+[**GetApprovalResponse**](GetApprovalResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_approval_checks
+
+> <GetApprovalsResponse> get_approval_checks(opts)
+
+Get approval payments
+
+Return approvals
+
+### 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::Approval.new
+opts = {
+  direction: 'INCOMING', # String | Direction
+  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
+  sort: '+NUMBER', # String | Sort
+  start_date: Date.parse('2013-10-20'), # Date | Start date
+  status: 'PAID' # String | Status
+}
+
+begin
+  # Get approval payments
+  result = api_instance.get_approval_checks(opts)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_checks: #{e}"
+end
+```
+
+#### Using the get_approval_checks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalsResponse>, Integer, Hash)> get_approval_checks_with_http_info(opts)
+
+```ruby
+begin
+  # Get approval payments
+  data, status_code, headers = api_instance.get_approval_checks_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalsResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->get_approval_checks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **direction** | **String** | Direction | [optional] |
+| **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] |
+| **sort** | **String** | Sort | [optional] |
+| **start_date** | **Date** | Start date | [optional] |
+| **status** | **String** | Status | [optional] |
+
+### Return type
+
+[**GetApprovalsResponse**](GetApprovalsResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_approval_digital
+
+> <GetApprovalResponse> post_approval_digital(create_digital_check_request)
+
+Create approval digital payment
+
+Create a new approval digital payment
+
+### 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::Approval.new
+create_digital_check_request = Checkbook::CreateDigitalCheckRequest.new({amount: 5.23, name: 'Widgets Inc.', recipient: Checkbook::DigitalRecipient.new({id: 'id_example'})}) # CreateDigitalCheckRequest | 
+
+begin
+  # Create approval digital payment
+  result = api_instance.post_approval_digital(create_digital_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_digital: #{e}"
+end
+```
+
+#### Using the post_approval_digital_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalResponse>, Integer, Hash)> post_approval_digital_with_http_info(create_digital_check_request)
+
+```ruby
+begin
+  # Create approval digital payment
+  data, status_code, headers = api_instance.post_approval_digital_with_http_info(create_digital_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_digital_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_digital_check_request** | [**CreateDigitalCheckRequest**](CreateDigitalCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetApprovalResponse**](GetApprovalResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_approval_multi
+
+> <GetApprovalResponse> post_approval_multi(create_multi_check_request)
+
+Create multi-party payment approval
+
+Create a new multi-party payment approval
+
+### 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::Approval.new
+create_multi_check_request = Checkbook::CreateMultiCheckRequest.new({amount: 5.23, recipients: [Checkbook::MultiRecipient.new({name: 'Widgets Inc.', recipient: 'testing@example.com or user_id'})]}) # CreateMultiCheckRequest | 
+
+begin
+  # Create multi-party payment approval
+  result = api_instance.post_approval_multi(create_multi_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_multi: #{e}"
+end
+```
+
+#### Using the post_approval_multi_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalResponse>, Integer, Hash)> post_approval_multi_with_http_info(create_multi_check_request)
+
+```ruby
+begin
+  # Create multi-party payment approval
+  data, status_code, headers = api_instance.post_approval_multi_with_http_info(create_multi_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_multi_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_multi_check_request** | [**CreateMultiCheckRequest**](CreateMultiCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetApprovalResponse**](GetApprovalResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_approval_physical
+
+> <GetApprovalResponse> post_approval_physical(create_physical_check_request)
+
+Create physical check approval
+
+Create a new physical check approval
+
+### 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::Approval.new
+create_physical_check_request = Checkbook::CreatePhysicalCheckRequest.new({amount: 5.23, name: 'Widgets Inc.', recipient: Checkbook::PhysicalCheckRecipient.new({city: 'Scranton', line_1: '1234 N. 1st Street', state: 'PA', zip: '55555'})}) # CreatePhysicalCheckRequest | 
+
+begin
+  # Create physical check approval
+  result = api_instance.post_approval_physical(create_physical_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_physical: #{e}"
+end
+```
+
+#### Using the post_approval_physical_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetApprovalResponse>, Integer, Hash)> post_approval_physical_with_http_info(create_physical_check_request)
+
+```ruby
+begin
+  # Create physical check approval
+  data, status_code, headers = api_instance.post_approval_physical_with_http_info(create_physical_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetApprovalResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_physical_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_physical_check_request** | [**CreatePhysicalCheckRequest**](CreatePhysicalCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetApprovalResponse**](GetApprovalResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_approval_release
+
+> <GetCheckResponse> post_approval_release(release_check_request)
+
+Approve payment
+
+Create a live payment from an approval
+
+### 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::Approval.new
+release_check_request = Checkbook::ReleaseCheckRequest.new({id: 'id_example'}) # ReleaseCheckRequest | 
+
+begin
+  # Approve payment
+  result = api_instance.post_approval_release(release_check_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_release: #{e}"
+end
+```
+
+#### Using the post_approval_release_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetCheckResponse>, Integer, Hash)> post_approval_release_with_http_info(release_check_request)
+
+```ruby
+begin
+  # Approve payment
+  data, status_code, headers = api_instance.post_approval_release_with_http_info(release_check_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetCheckResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->post_approval_release_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **release_check_request** | [**ReleaseCheckRequest**](ReleaseCheckRequest.md) |  |  |
+
+### Return type
+
+[**GetCheckResponse**](GetCheckResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_approval_check
+
+> put_approval_check(approval_id, update_approval_request)
+
+Update payment approval
+
+Update the specified payment approval
+
+### 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::Approval.new
+approval_id = 'approval_id_example' # String | 
+update_approval_request = Checkbook::UpdateApprovalRequest.new # UpdateApprovalRequest | 
+
+begin
+  # Update payment approval
+  api_instance.put_approval_check(approval_id, update_approval_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->put_approval_check: #{e}"
+end
+```
+
+#### Using the put_approval_check_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)> put_approval_check_with_http_info(approval_id, update_approval_request)
+
+```ruby
+begin
+  # Update payment approval
+  data, status_code, headers = api_instance.put_approval_check_with_http_info(approval_id, update_approval_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Approval->put_approval_check_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **approval_id** | **String** |  |  |
+| **update_approval_request** | [**UpdateApprovalRequest**](UpdateApprovalRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+