transferzero-sdk 1.0.0

data/docs/ApiLog.md

@@ -0,0 +1,33 @@
+# TransferZero::ApiLog
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the API log | [optional] 
+**request_method** | **String** | Initial HTTP request method | [optional] 
+**request_url** | **String** | URL to which initial request was sent | [optional] 
+**request_body** | **String** | Body sent with initial request returned as a string | [optional] 
+**request_headers** | **Hash<String, String>** | Authorization and access information sent with initial request | [optional] 
+**response_status** | **String** | Status of response | [optional] 
+**response_body** | **String** | Full response body returned as a string | [optional] 
+**response_headers** | **Hash<String, String>** | Headers returned with response | [optional] 
+**created_at** | **String** | Date and time of response | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ApiLog.new(id: a0696374-de2f-4b4e-a2d7-cb4e0a1240c0,
+                                 request_method: POST,
+                                 request_url: https://api.transferzero/v1/transactions/validate,
+                                 request_body: {"message":"Email dispatched: Accepted (user@transferzero.com)"},
+                                 request_headers: {"HTTP_VERSION":"HTTP/1.1","HTTP_ACCEPT":"application/json","HTTP_USER_AGENT":"TransferZero Ruby","HTTP_AUTHORIZATION_NONCE":"0000","HTTP_AUTHORIZATION_KEY":"0000","HTTP_AUTHORIZATION_SIGNATURE":"0000","HTTP_CONNECTION":"close","HTTP_HOST":"localhost:3002"},
+                                 response_status: 200,
+                                 response_body: {"object":{"result":0}},
+                                 response_headers: {"X-Frame-Options":"SAMEORIGIN","X-XSS-Protection":"1; mode=block","X-Content-Type-Options":"nosniff","Content-Type":"application/json; charset=UTF-8"},
+                                 created_at: 2019-01-11T00:00:00.001+0000)
+```
+
+

data/docs/ApiLogListResponse.md

@@ -0,0 +1,19 @@
+# TransferZero::ApiLogListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<ApiLog>**](ApiLog.md) | Array of API log objects | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ApiLogListResponse.new(object: null,
+                                 meta: null)
+```
+
+

data/docs/ApiLogResponse.md

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

data/docs/Currency.md

@@ -0,0 +1,35 @@
+# TransferZero::Currency
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The currency code in 3-character alpha ISO 4217 currency format | [optional] 
+**name** | **String** | Name of currency | [optional] 
+**symbol** | **String** | Symbol of currency | [optional] 
+**decimals** | **Float** | Number of decimal points | [optional] 
+**subunit_to_unit** | **String** | Subunits in Unit (eg. there are 100 cents in 1 US Dollar) | [optional] 
+**primary** | **Boolean** | Is this a primary currency? | [optional] 
+**min** | **String** | The minimum amount allowed in a transaction | [optional] 
+**max** | **String** | The maximum amount allowed in a transaction | [optional] 
+**margin** | **String** | The margin set for transactions in this currency | [optional] 
+**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Currency.new(code: NGN,
+                                 name: Nigerian Naira,
+                                 symbol: ₦,
+                                 decimals: 2,
+                                 subunit_to_unit: 100,
+                                 primary: null,
+                                 min: 100,
+                                 max: 50000000,
+                                 margin: null,
+                                 usd_equivalent: null)
+```
+
+

data/docs/CurrencyExchange.md

@@ -0,0 +1,37 @@
+# TransferZero::CurrencyExchange
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The currency code in 3-character alpha ISO 4217 currency format | [optional] 
+**name** | **String** | Name of currency | [optional] 
+**symbol** | **String** | Symbol of currency | [optional] 
+**decimals** | **Float** | Number of decimal points | [optional] 
+**subunit_to_unit** | **String** | Subunits in Unit (eg. there are 100 cents in 1 US Dollar) | [optional] 
+**primary** | **Boolean** | Is this a primary currency? | [optional] 
+**min** | **String** | The minimum amount allowed in a transaction | [optional] 
+**max** | **String** | The maximum amount allowed in a transaction | [optional] 
+**margin** | **String** | The margin set for transactions in this currency | [optional] 
+**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
+**opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyExchange.new(code: NGN,
+                                 name: Nigerian Naira,
+                                 symbol: ₦,
+                                 decimals: 2,
+                                 subunit_to_unit: 100,
+                                 primary: null,
+                                 min: 100,
+                                 max: 50000000,
+                                 margin: null,
+                                 usd_equivalent: null,
+                                 opposites: null)
+```
+
+

data/docs/CurrencyExchangeListResponse.md

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

data/docs/CurrencyInfoApi.md

@@ -0,0 +1,182 @@
+# TransferZero::CurrencyInfoApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**info_currencies**](CurrencyInfoApi.md#info_currencies) | **GET** /info/currencies | Getting a list of possible requested currencies
+[**info_currencies_in**](CurrencyInfoApi.md#info_currencies_in) | **GET** /info/currencies/in | Getting a list of possible input currencies
+[**info_currencies_out**](CurrencyInfoApi.md#info_currencies_out) | **GET** /info/currencies/out | Getting a list of possible output currencies
+
+
+# **info_currencies**
+> CurrencyListResponse info_currencies
+
+Getting a list of possible requested currencies
+
+Fetches a list of currencies available to use in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible requested currencies
+  result = api_instance.info_currencies
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("CurrencyListResponse")
+    p result
+  else
+    puts "Exception when calling CurrencyInfoApi->info_currencies: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CurrencyListResponse**](CurrencyListResponse.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
+
+
+
+# **info_currencies_in**
+> CurrencyExchangeListResponse info_currencies_in
+
+Getting a list of possible input currencies
+
+Fetches a list of currencies available to use as the input currency in other API requests. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. Use this endpoint to determine the current exchange rate from a specific input currency to any output currency that's available. 
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible input currencies
+  result = api_instance.info_currencies_in
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("CurrencyExchangeListResponse")
+    p result
+  else
+    puts "Exception when calling CurrencyInfoApi->info_currencies_in: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CurrencyExchangeListResponse**](CurrencyExchangeListResponse.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
+
+
+
+# **info_currencies_out**
+> CurrencyExchangeListResponse info_currencies_out
+
+Getting a list of possible output currencies
+
+Fetches a list of currencies available to use as the output currency and their exchange rates against the available input currencies. Usually the 3-character alpha ISO 4217 currency code (eg. USD) is used as the identifier. 
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible output currencies
+  result = api_instance.info_currencies_out
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("CurrencyExchangeListResponse")
+    p result
+  else
+    puts "Exception when calling CurrencyInfoApi->info_currencies_out: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CurrencyExchangeListResponse**](CurrencyExchangeListResponse.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
+
+
+

data/docs/CurrencyListResponse.md

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

data/docs/CurrencyOpposite.md

@@ -0,0 +1,37 @@
+# TransferZero::CurrencyOpposite
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | The currency code in 3-character alpha ISO 4217 currency format | [optional] 
+**name** | **String** | Name of currency | [optional] 
+**symbol** | **String** | Symbol of currency | [optional] 
+**decimals** | **Float** | Number of decimal points | [optional] 
+**subunit_to_unit** | **String** | Subunits in Unit (eg. there are 100 cents in 1 US Dollar) | [optional] 
+**primary** | **Boolean** | Is this a primary currency? | [optional] 
+**min** | **String** | The minimum amount allowed in a transaction | [optional] 
+**max** | **String** | The maximum amount allowed in a transaction | [optional] 
+**margin** | **String** | The margin set for transactions in this currency | [optional] 
+**usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
+**rate** | **Float** | The rate of this particular currency with the base one | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::CurrencyOpposite.new(code: NGN,
+                                 name: Nigerian Naira,
+                                 symbol: ₦,
+                                 decimals: 2,
+                                 subunit_to_unit: 100,
+                                 primary: null,
+                                 min: 100,
+                                 max: 50000000,
+                                 margin: null,
+                                 usd_equivalent: null,
+                                 rate: null)
+```
+
+

data/docs/Debit.md

@@ -0,0 +1,35 @@
+# TransferZero::Debit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | The amount to be debited from your account.  The “amount” parameter is optional - - if included, it must equal the amount required to fund the transaction. - if omitted, it will default to the amount required to fund the transaction.  | [optional] 
+**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format | 
+**to_type** | **String** | Describes what the debit is funding | 
+**to_id** | **String** | The ID of the resource the debit is funding | 
+**metadata** | [**Object**](.md) | Metadata of account debit | [optional] 
+**id** | **String** |  | [optional] 
+**created_at** | **DateTime** | Date and time that the debit was created | [optional] 
+**usd_amount** | **Float** | The amount to be debited from your account converted to USD  | [optional] 
+**running_balance** | **Float** | The total amount remaining in your account after the debit call  | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Debit.new(amount: 10000,
+                                 currency: NGN,
+                                 to_type: Transaction,
+                                 to_id: 5f44026b-7904-4c30-87d6-f8972d790ded,
+                                 metadata: {},
+                                 id: 5f44026b-7904-4c30-87d6-f8972d790ded,
+                                 created_at: null,
+                                 usd_amount: 200.06211683187206,
+                                 running_balance: 2000000,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+```
+
+

data/docs/DebitListRequest.md

@@ -0,0 +1,17 @@
+# TransferZero::DebitListRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**debit** | [**Array<Debit>**](Debit.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::DebitListRequest.new(debit: null)
+```
+
+