bitpesa-sdk 0.1.0

data/docs/ApiLog.md

@@ -0,0 +1,16 @@
+# Bitpesa::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] 
+
+

data/docs/ApiLogBase.md

@@ -0,0 +1,16 @@
+# Bitpesa::ApiLogBase
+
+## 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** | **Object** | 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** | **Object** | Headers returned with response | [optional] 
+**created_at** | **String** | Date and time of response | [optional] 
+
+

data/docs/ApiLogListResponse.md

@@ -0,0 +1,9 @@
+# Bitpesa::ApiLogListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<ApiLog>**](ApiLog.md) | Array of API log objects | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+

data/docs/ApiLogResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::ApiLogResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**ApiLog**](ApiLog.md) |  | [optional] 
+
+

data/docs/Body.md

@@ -0,0 +1,12 @@
+# Bitpesa::Body
+
+## 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 | 
+
+

data/docs/Currency.md

@@ -0,0 +1,17 @@
+# Bitpesa::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] 
+
+

data/docs/CurrencyBase.md

@@ -0,0 +1,17 @@
+# Bitpesa::CurrencyBase
+
+## 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] 
+
+

data/docs/CurrencyExchange.md

@@ -0,0 +1,18 @@
+# Bitpesa::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] 
+
+

data/docs/CurrencyExchangeListResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::CurrencyExchangeListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<CurrencyExchange>**](CurrencyExchange.md) |  | [optional] 
+
+

data/docs/CurrencyInfoApi.md

@@ -0,0 +1,182 @@
+# Bitpesa::CurrencyInfoApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/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 'bitpesa-sdk'
+
+api_instance = Bitpesa::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible requested currencies
+  result = api_instance.info_currencies
+  p result
+rescue Bitpesa::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 Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/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 'bitpesa-sdk'
+
+api_instance = Bitpesa::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible input currencies
+  result = api_instance.info_currencies_in
+  p result
+rescue Bitpesa::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 Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/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 'bitpesa-sdk'
+
+api_instance = Bitpesa::CurrencyInfoApi.new
+
+begin
+  #Getting a list of possible output currencies
+  result = api_instance.info_currencies_out
+  p result
+rescue Bitpesa::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 Bitpesa object when setting it up:
+
+```ruby
+
+Bitpesa.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.bitpesa.co/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/CurrencyListResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::CurrencyListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<Currency>**](Currency.md) |  | [optional] 
+
+

data/docs/CurrencyOpposite.md

@@ -0,0 +1,18 @@
+# Bitpesa::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] 
+
+

data/docs/Debit.md

@@ -0,0 +1,17 @@
+# Bitpesa::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] 
+
+

data/docs/DebitBase.md

@@ -0,0 +1,12 @@
+# Bitpesa::DebitBase
+
+## 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** | Metadata of account debit | [optional] 
+
+

data/docs/DebitErrorResponse.md

@@ -0,0 +1,13 @@
+# Bitpesa::DebitErrorResponse
+
+## 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** | Metadata of account debit | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/DebitListRequest.md

@@ -0,0 +1,8 @@
+# Bitpesa::DebitListRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**debit** | [**Array<Debit>**](Debit.md) |  | [optional] 
+
+

data/docs/DebitListResponse.md

@@ -0,0 +1,9 @@
+# Bitpesa::DebitListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<Debit>**](Debit.md) |  | [optional] 
+**meta** | [**PaginationMeta**](PaginationMeta.md) |  | [optional] 
+
+

data/docs/DebitRequest.md

@@ -0,0 +1,8 @@
+# Bitpesa::DebitRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**debit** | [**Debit**](Debit.md) |  | [optional] 
+
+

data/docs/DebitRequestWrapper.md

@@ -0,0 +1,8 @@
+# Bitpesa::DebitRequestWrapper
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**debit** | [**Array<Debit>**](Debit.md) |  | [optional] 
+
+

data/docs/DebitResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::DebitResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Debit**](Debit.md) |  | [optional] 
+
+