transferzero-sdk 1.0.0

data/docs/Account.md

@@ -0,0 +1,19 @@
+# TransferZero::Account
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | The account balance for the given currency | [optional] 
+**currency** | **String** | The currency of this balance | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Account.new(amount: 1000.0,
+                                 currency: USD)
+```
+
+

data/docs/AccountDebitsApi.md

@@ -0,0 +1,199 @@
+# TransferZero::AccountDebitsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_accounts_debit**](AccountDebitsApi.md#get_accounts_debit) | **GET** /accounts/debits/{Account Debit ID} | Fetching an account debit
+[**get_accounts_debits**](AccountDebitsApi.md#get_accounts_debits) | **GET** /accounts/debits | Listing Accounts debits
+[**post_accounts_debits**](AccountDebitsApi.md#post_accounts_debits) | **POST** /accounts/debits | Creating an account debit
+
+
+# **get_accounts_debit**
+> DebitResponse get_accounts_debit(account_debit_id)
+
+Fetching an account debit
+
+Returns a single account debit by the account debit ID
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountDebitsApi.new
+
+
+begin
+  #Fetching an account debit
+  result = api_instance.get_accounts_debit(account_debit_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DebitResponse")
+    p result
+  else
+    puts "Exception when calling AccountDebitsApi->get_accounts_debit: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_debit_id** | [**String**](.md)| ID of the account debit to get.  Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d` | 
+
+### Return type
+
+[**DebitResponse**](DebitResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_accounts_debits**
+> DebitListResponse get_accounts_debits(opts)
+
+Listing Accounts debits
+
+Get a list of accounts debits
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountDebitsApi.new
+
+opts = { 
+  page: 1 # Integer | The page number to request (defaults to 1)
+  per: 10 # Integer | The number of results to load per page (defaults to 10)
+}
+
+begin
+  #Listing Accounts debits
+  result = api_instance.get_accounts_debits(opts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DebitListResponse")
+    p result
+  else
+    puts "Exception when calling AccountDebitsApi->get_accounts_debits: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| The page number to request (defaults to 1) | [optional] 
+ **per** | **Integer**| The number of results to load per page (defaults to 10) | [optional] 
+
+### Return type
+
+[**DebitListResponse**](DebitListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **post_accounts_debits**
+> DebitListResponse post_accounts_debits(debit_request_wrapper)
+
+Creating an account debit
+
+Creates a new account debit finding transaction through the internal balance  To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet  Once the transaction is funded, we will immediately start trying to pay out the recipient(s).  It is also possible to create multiple account debits by supplying an array of debit objects 
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountDebitsApi.new
+
+
+begin
+  #Creating an account debit
+  result = api_instance.post_accounts_debits(debit_request_wrapper)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("DebitListResponse")
+    p result
+  else
+    puts "Exception when calling AccountDebitsApi->post_accounts_debits: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **debit_request_wrapper** | [**DebitRequestWrapper**](DebitRequestWrapper.md)|  | 
+
+### Return type
+
+[**DebitListResponse**](DebitListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AccountListResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::AccountListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<Account>**](Account.md) |  | [optional] 
+**meta** | [**AccountMeta**](AccountMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountListResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/AccountMeta.md

@@ -0,0 +1,17 @@
+# TransferZero::AccountMeta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**negative_balance** | **Boolean** | Indicates whether account balances are permitted to be debited below zero | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountMeta.new(negative_balance: null)
+```
+
+

data/docs/AccountResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::AccountResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Account**](Account.md) |  | [optional] 
+**meta** | [**AccountMeta**](AccountMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/AccountValidationApi.md

@@ -0,0 +1,70 @@
+# TransferZero::AccountValidationApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**post_account_validations**](AccountValidationApi.md#post_account_validations) | **POST** /account_validations | Validates the existence of a bank account
+
+
+# **post_account_validations**
+> AccountValidationResponse post_account_validations(account_validation_request)
+
+Validates the existence of a bank account
+
+Validates the existence of a bank account and returns the associated customer name
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountValidationApi.new
+
+
+begin
+  #Validates the existence of a bank account
+  result = api_instance.post_account_validations(account_validation_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("AccountValidationResponse")
+    p result
+  else
+    puts "Exception when calling AccountValidationApi->post_account_validations: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_validation_request** | [**AccountValidationRequest**](AccountValidationRequest.md)|  | 
+
+### Return type
+
+[**AccountValidationResponse**](AccountValidationResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/AccountValidationError.md

@@ -0,0 +1,17 @@
+# TransferZero::AccountValidationError
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountValidationError.new(error: Could not find account)
+```
+
+

data/docs/AccountValidationRequest.md

@@ -0,0 +1,25 @@
+# TransferZero::AccountValidationRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank_account** | **String** | Account Number to query | 
+**bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | 
+**country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format (only NG is currently supported) | 
+**currency** | **String** | The currency the bank account is in | 
+**method** | **String** | The method of the payment. Currently only bank is supported | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountValidationRequest.new(bank_account: null,
+                                 bank_code: null,
+                                 country: null,
+                                 currency: null,
+                                 method: null)
+```
+
+

data/docs/AccountValidationResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::AccountValidationResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**AccountValidationResult**](AccountValidationResult.md) |  | [optional] 
+**meta** | [**AccountValidationError**](AccountValidationError.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountValidationResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/AccountValidationResult.md

@@ -0,0 +1,17 @@
+# TransferZero::AccountValidationResult
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::AccountValidationResult.new(account_name: John Smith)
+```
+
+

data/docs/AccountsApi.md

@@ -0,0 +1,128 @@
+# TransferZero::AccountsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_account**](AccountsApi.md#get_account) | **GET** /accounts/{Currency} | Fetches account balance for specified currrency
+[**get_accounts**](AccountsApi.md#get_accounts) | **GET** /accounts | Fetches account balances for all currencies
+
+
+# **get_account**
+> AccountResponse get_account(currency)
+
+Fetches account balance for specified currrency
+
+Fetches account balance for specified currrency, and returns current balance and associated currency code
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountsApi.new
+
+
+begin
+  #Fetches account balance for specified currrency
+  result = api_instance.get_account(currency)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("AccountResponse")
+    p result
+  else
+    puts "Exception when calling AccountsApi->get_account: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **currency** | **String**| Currency code of account balance to fetch  Example: `/v1/accounts/USD` | 
+
+### Return type
+
+[**AccountResponse**](AccountResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_accounts**
+> AccountListResponse get_accounts
+
+Fetches account balances for all currencies
+
+Fetches account balances for all currencies, and returns an array of the current balances and associated currency codes.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::AccountsApi.new
+
+begin
+  #Fetches account balances for all currencies
+  result = api_instance.get_accounts
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("AccountListResponse")
+    p result
+  else
+    puts "Exception when calling AccountsApi->get_accounts: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AccountListResponse**](AccountListResponse.md)
+
+### Authorization
+
+You can set the API Key and Secret on the TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+