checkbook 1.0.1

data/docs/Venmo.md

@@ -0,0 +1,290 @@
+# Checkbook::Venmo
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_venmo**](Venmo.md#add_venmo) | **POST** /v3/account/venmo | Create Venmo account |
+| [**get_venmo**](Venmo.md#get_venmo) | **GET** /v3/account/venmo | Get Venmo accounts |
+| [**put_venmo**](Venmo.md#put_venmo) | **PUT** /v3/account/venmo/{venmo_id} | Update Venmo account |
+| [**remove_venmo**](Venmo.md#remove_venmo) | **DELETE** /v3/account/venmo/{venmo_id} | Remove Venmo account |
+
+
+## add_venmo
+
+> <VenmoAccountResponse> add_venmo(create_venmo_request)
+
+Create Venmo account
+
+Add a new Venmo account 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::Venmo.new
+create_venmo_request = Checkbook::CreateVenmoRequest.new({username: 'dunder-mifflin@checkbook.io'}) # CreateVenmoRequest | 
+
+begin
+  # Create Venmo account
+  result = api_instance.add_venmo(create_venmo_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->add_venmo: #{e}"
+end
+```
+
+#### Using the add_venmo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VenmoAccountResponse>, Integer, Hash)> add_venmo_with_http_info(create_venmo_request)
+
+```ruby
+begin
+  # Create Venmo account
+  data, status_code, headers = api_instance.add_venmo_with_http_info(create_venmo_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VenmoAccountResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->add_venmo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_venmo_request** | [**CreateVenmoRequest**](CreateVenmoRequest.md) |  |  |
+
+### Return type
+
+[**VenmoAccountResponse**](VenmoAccountResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_venmo
+
+> <GetVenmoResponse> get_venmo
+
+Get Venmo accounts
+
+Return the Venmo accounts of 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::Venmo.new
+
+begin
+  # Get Venmo accounts
+  result = api_instance.get_venmo
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->get_venmo: #{e}"
+end
+```
+
+#### Using the get_venmo_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetVenmoResponse>, Integer, Hash)> get_venmo_with_http_info
+
+```ruby
+begin
+  # Get Venmo accounts
+  data, status_code, headers = api_instance.get_venmo_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetVenmoResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->get_venmo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetVenmoResponse**](GetVenmoResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## put_venmo
+
+> put_venmo(venmo_id, update_venmo_request)
+
+Update Venmo account
+
+Update an existing Venmo 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::Venmo.new
+venmo_id = 'venmo_id_example' # String | 
+update_venmo_request = Checkbook::UpdateVenmoRequest.new # UpdateVenmoRequest | 
+
+begin
+  # Update Venmo account
+  api_instance.put_venmo(venmo_id, update_venmo_request)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->put_venmo: #{e}"
+end
+```
+
+#### Using the put_venmo_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_venmo_with_http_info(venmo_id, update_venmo_request)
+
+```ruby
+begin
+  # Update Venmo account
+  data, status_code, headers = api_instance.put_venmo_with_http_info(venmo_id, update_venmo_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->put_venmo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **venmo_id** | **String** |  |  |
+| **update_venmo_request** | [**UpdateVenmoRequest**](UpdateVenmoRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## remove_venmo
+
+> remove_venmo(venmo_id)
+
+Remove Venmo account
+
+Remove an existing Venmo 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::Venmo.new
+venmo_id = 'venmo_id_example' # String | 
+
+begin
+  # Remove Venmo account
+  api_instance.remove_venmo(venmo_id)
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->remove_venmo: #{e}"
+end
+```
+
+#### Using the remove_venmo_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)> remove_venmo_with_http_info(venmo_id)
+
+```ruby
+begin
+  # Remove Venmo account
+  data, status_code, headers = api_instance.remove_venmo_with_http_info(venmo_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Checkbook::ApiError => e
+  puts "Error when calling Venmo->remove_venmo_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **venmo_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Wallet.md

@@ -0,0 +1,292 @@
+# Checkbook::Wallet
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_wallet**](Wallet.md#add_wallet) | **POST** /v3/account/wallet | Create wallet |
+| [**delete_wallet**](Wallet.md#delete_wallet) | **DELETE** /v3/account/wallet/{wallet_id} | Delete wallet |
+| [**get_wallet**](Wallet.md#get_wallet) | **GET** /v3/account/wallet | Get wallets |
+| [**update_wallet**](Wallet.md#update_wallet) | **PUT** /v3/account/wallet/{wallet_id} | Update wallet |
+
+
+## add_wallet
+
+> <CreateWalletResponse> add_wallet(create_wallet_request)
+
+Create wallet
+
+Add a new wallet account for user  > [!NOTE] > **Tip**   > Please securely save the unique routing and account numbers for EXTERNAL wallets after generation, as they are only revealed once.
+
+### 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::Wallet.new
+create_wallet_request = Checkbook::CreateWalletRequest.new # CreateWalletRequest | 
+
+begin
+  # Create wallet
+  result = api_instance.add_wallet(create_wallet_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->add_wallet: #{e}"
+end
+```
+
+#### Using the add_wallet_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWalletResponse>, Integer, Hash)> add_wallet_with_http_info(create_wallet_request)
+
+```ruby
+begin
+  # Create wallet
+  data, status_code, headers = api_instance.add_wallet_with_http_info(create_wallet_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWalletResponse>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->add_wallet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_wallet_request** | [**CreateWalletRequest**](CreateWalletRequest.md) |  |  |
+
+### Return type
+
+[**CreateWalletResponse**](CreateWalletResponse.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_wallet
+
+> Object delete_wallet(wallet_id)
+
+Delete wallet
+
+Delete a wallet 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::Wallet.new
+wallet_id = 'wallet_id_example' # String | The ID of the wallet to be deleted
+
+begin
+  # Delete wallet
+  result = api_instance.delete_wallet(wallet_id)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->delete_wallet: #{e}"
+end
+```
+
+#### Using the delete_wallet_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> delete_wallet_with_http_info(wallet_id)
+
+```ruby
+begin
+  # Delete wallet
+  data, status_code, headers = api_instance.delete_wallet_with_http_info(wallet_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->delete_wallet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_id** | **String** | The ID of the wallet to be deleted |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_wallet
+
+> <InlineResponse200> get_wallet
+
+Get wallets
+
+Get wallet accounts for 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::Wallet.new
+
+begin
+  # Get wallets
+  result = api_instance.get_wallet
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->get_wallet: #{e}"
+end
+```
+
+#### Using the get_wallet_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InlineResponse200>, Integer, Hash)> get_wallet_with_http_info
+
+```ruby
+begin
+  # Get wallets
+  data, status_code, headers = api_instance.get_wallet_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InlineResponse200>
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->get_wallet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**InlineResponse200**](InlineResponse200.md)
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_wallet
+
+> Object update_wallet(wallet_id, update_wallet_request)
+
+Update wallet
+
+Update wallet
+
+### 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::Wallet.new
+wallet_id = 'wallet_id_example' # String | The ID of the wallet to be updated
+update_wallet_request = Checkbook::UpdateWalletRequest.new # UpdateWalletRequest | 
+
+begin
+  # Update wallet
+  result = api_instance.update_wallet(wallet_id, update_wallet_request)
+  p result
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->update_wallet: #{e}"
+end
+```
+
+#### Using the update_wallet_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> update_wallet_with_http_info(wallet_id, update_wallet_request)
+
+```ruby
+begin
+  # Update wallet
+  data, status_code, headers = api_instance.update_wallet_with_http_info(wallet_id, update_wallet_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Checkbook::ApiError => e
+  puts "Error when calling Wallet->update_wallet_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **wallet_id** | **String** | The ID of the wallet to be updated |  |
+| **update_wallet_request** | [**UpdateWalletRequest**](UpdateWalletRequest.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+