checkbook 1.0.1

data/docs/Bank.md

@@ -0,0 +1,645 @@
+# Checkbook::Bank
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_bank**](Bank.md#delete_bank) | **DELETE** /v3/account/bank/{bank_id} | Remove bank account |
+| [**get_bank_institutions**](Bank.md#get_bank_institutions) | **GET** /v3/account/bank/institutions | Get institutions |
+| [**get_banks**](Bank.md#get_banks) | **GET** /v3/account/bank | Get bank accounts |
+| [**post_bank**](Bank.md#post_bank) | **POST** /v3/account/bank | Add bank account |
+| [**post_bank_iav**](Bank.md#post_bank_iav) | **POST** /v3/account/bank/iav | Add bank account with IAV |
+| [**post_bank_plaid**](Bank.md#post_bank_plaid) | **POST** /v3/account/bank/iav/plaid | Retrieve bank account with Plaid |
+| [**post_bank_release**](Bank.md#post_bank_release) | **POST** /v3/account/bank/release | Release micro-deposits |
+| [**post_bank_verify**](Bank.md#post_bank_verify) | **POST** /v3/account/bank/verify | Verify micro-deposits |
+| [**put_bank**](Bank.md#put_bank) | **PUT** /v3/account/bank/{bank_id} | Update bank account |
+
+
+## delete_bank
+
+> delete_bank(bank_id)
+
+Remove bank account
+
+Remove the specified 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::Bank.new
+bank_id = 'bank_id_example' # String | 
+
+begin
+  # Remove bank account
+  api_instance.delete_bank(bank_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->delete_bank: #{e}"
+end
+```
+
+#### Using the delete_bank_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_bank_with_http_info(bank_id)
+
+```ruby
+begin
+  # Remove bank account
+  data, status_code, headers = api_instance.delete_bank_with_http_info(bank_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->delete_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_bank_institutions
+
+> <GetInstitutionsResponse> get_bank_institutions
+
+Get institutions
+
+Return a list of our supported institutions for instant account verification
+
+### 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::Bank.new
+
+begin
+  # Get institutions
+  result = api_instance.get_bank_institutions
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->get_bank_institutions: #{e}"
+end
+```
+
+#### Using the get_bank_institutions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetInstitutionsResponse>, Integer, Hash)> get_bank_institutions_with_http_info
+
+```ruby
+begin
+  # Get institutions
+  data, status_code, headers = api_instance.get_bank_institutions_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetInstitutionsResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->get_bank_institutions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetInstitutionsResponse**](GetInstitutionsResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_banks
+
+> <GetBanksResponse> get_banks
+
+Get bank accounts
+
+Get the bank accounts for a 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::Bank.new
+
+begin
+  # Get bank accounts
+  result = api_instance.get_banks
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->get_banks: #{e}"
+end
+```
+
+#### Using the get_banks_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetBanksResponse>, Integer, Hash)> get_banks_with_http_info
+
+```ruby
+begin
+  # Get bank accounts
+  data, status_code, headers = api_instance.get_banks_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetBanksResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->get_banks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetBanksResponse**](GetBanksResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## post_bank
+
+> <CreateBankResponse> post_bank(create_bank_request)
+
+Add bank account
+
+Add a new 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::Bank.new
+create_bank_request = Checkbook::CreateBankRequest.new({account: '428100000', routing: '021000021', type: 'CHECKING'}) # CreateBankRequest | 
+
+begin
+  # Add bank account
+  result = api_instance.post_bank(create_bank_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank: #{e}"
+end
+```
+
+#### Using the post_bank_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateBankResponse>, Integer, Hash)> post_bank_with_http_info(create_bank_request)
+
+```ruby
+begin
+  # Add bank account
+  data, status_code, headers = api_instance.post_bank_with_http_info(create_bank_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateBankResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_bank_request** | [**CreateBankRequest**](CreateBankRequest.md) |  |  |
+
+### Return type
+
+[**CreateBankResponse**](CreateBankResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_bank_iav
+
+> <IAVLoginResponse> post_bank_iav(post_bank_iav_request)
+
+Add bank account with IAV
+
+Add a new bank account with instant account verification
+
+### 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::Bank.new
+post_bank_iav_request = Checkbook::IAVLoginSchema.new({institution_id: 'institution_id_example'}) # PostBankIavRequest | 
+
+begin
+  # Add bank account with IAV
+  result = api_instance.post_bank_iav(post_bank_iav_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_iav: #{e}"
+end
+```
+
+#### Using the post_bank_iav_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IAVLoginResponse>, Integer, Hash)> post_bank_iav_with_http_info(post_bank_iav_request)
+
+```ruby
+begin
+  # Add bank account with IAV
+  data, status_code, headers = api_instance.post_bank_iav_with_http_info(post_bank_iav_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IAVLoginResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_iav_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **post_bank_iav_request** | [**PostBankIavRequest**](PostBankIavRequest.md) |  |  |
+
+### Return type
+
+[**IAVLoginResponse**](IAVLoginResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_bank_plaid
+
+> <IAVPlaidResponse> post_bank_plaid(iav_plaid_request)
+
+Retrieve bank account with Plaid
+
+Retrieve the bank account(s) associated with the Plaid token.   > [!NOTE] > **Common Errors** > > - **`User login is required`** or **`Token Expired`**: The specified Plaid processor token has expired and a new token is required.
+
+### 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::Bank.new
+iav_plaid_request = Checkbook::IAVPlaidRequest.new({processor_token: 'processor_token_example'}) # IAVPlaidRequest | 
+
+begin
+  # Retrieve bank account with Plaid
+  result = api_instance.post_bank_plaid(iav_plaid_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_plaid: #{e}"
+end
+```
+
+#### Using the post_bank_plaid_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<IAVPlaidResponse>, Integer, Hash)> post_bank_plaid_with_http_info(iav_plaid_request)
+
+```ruby
+begin
+  # Retrieve bank account with Plaid
+  data, status_code, headers = api_instance.post_bank_plaid_with_http_info(iav_plaid_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <IAVPlaidResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_plaid_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **iav_plaid_request** | [**IAVPlaidRequest**](IAVPlaidRequest.md) |  |  |
+
+### Return type
+
+[**IAVPlaidResponse**](IAVPlaidResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_bank_release
+
+> post_bank_release(bank_release_request)
+
+Release micro-deposits
+
+Release the micro-deposits for a 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::Bank.new
+bank_release_request = Checkbook::BankReleaseRequest.new({account: 'account_example'}) # BankReleaseRequest | 
+
+begin
+  # Release micro-deposits
+  api_instance.post_bank_release(bank_release_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_release: #{e}"
+end
+```
+
+#### Using the post_bank_release_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)> post_bank_release_with_http_info(bank_release_request)
+
+```ruby
+begin
+  # Release micro-deposits
+  data, status_code, headers = api_instance.post_bank_release_with_http_info(bank_release_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_release_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_release_request** | [**BankReleaseRequest**](BankReleaseRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## post_bank_verify
+
+> post_bank_verify(bank_verify_request)
+
+Verify micro-deposits
+
+Verify the micro-deposits for a 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::Bank.new
+bank_verify_request = Checkbook::BankVerifyRequest.new({amount_1: 0.03, amount_2: 0.05}) # BankVerifyRequest | 
+
+begin
+  # Verify micro-deposits
+  api_instance.post_bank_verify(bank_verify_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_verify: #{e}"
+end
+```
+
+#### Using the post_bank_verify_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)> post_bank_verify_with_http_info(bank_verify_request)
+
+```ruby
+begin
+  # Verify micro-deposits
+  data, status_code, headers = api_instance.post_bank_verify_with_http_info(bank_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->post_bank_verify_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_verify_request** | [**BankVerifyRequest**](BankVerifyRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## put_bank
+
+> put_bank(bank_id, update_bank_request)
+
+Update bank account
+
+Update an existing 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::Bank.new
+bank_id = 'bank_id_example' # String | 
+update_bank_request = Checkbook::UpdateBankRequest.new # UpdateBankRequest | 
+
+begin
+  # Update bank account
+  api_instance.put_bank(bank_id, update_bank_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->put_bank: #{e}"
+end
+```
+
+#### Using the put_bank_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_bank_with_http_info(bank_id, update_bank_request)
+
+```ruby
+begin
+  # Update bank account
+  data, status_code, headers = api_instance.put_bank_with_http_info(bank_id, update_bank_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Bank->put_bank_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bank_id** | **String** |  |  |
+| **update_bank_request** | [**UpdateBankRequest**](UpdateBankRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+