bitpesa-sdk 0.1.0

data/docs/PayoutMethodResponse.md

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

data/docs/PayoutMethodValidResponse.md

@@ -0,0 +1,11 @@
+# Bitpesa::PayoutMethodValidResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Contains the currency to send the money to, and the type of the money movement  Commonly used payout types are:  - `NGN::Bank` - for Nigerian bank account payments. - `NGN::Mobile` - for Nigerian mobile money payments. - `GHS::Bank` - for Ghanaian bank account payments. - `GHS::Mobile` - for Ghanaian mobile money payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for Senegalese mobile money payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank transfers in GBP.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**details** | [**PayoutMethodDetailsBase**](PayoutMethodDetailsBase.md) |  | [optional] 
+**metadata** | **Object** | Metadata of payout method. You can store any kind of information in this field. | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/PayoutMethodWebhook.md

@@ -0,0 +1,10 @@
+# Bitpesa::PayoutMethodWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **String** | The ID of the webhook that was used to send out this callback | 
+**event** | **String** | The event that triggered this webhook | 
+**object** | [**PayoutMethod**](PayoutMethod.md) |  | 
+
+

data/docs/PayoutMethodsApi.md

@@ -0,0 +1,334 @@
+# Bitpesa::PayoutMethodsApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_payout_method**](PayoutMethodsApi.md#delete_payout_method) | **DELETE** /payout_methods/{Payout Method ID} | Deleting a payout method
+[**get_payout_method**](PayoutMethodsApi.md#get_payout_method) | **GET** /payout_methods/{Payout Method ID} | Fetching a payout method
+[**get_payout_methods**](PayoutMethodsApi.md#get_payout_methods) | **GET** /payout_methods | Listing payout methods
+[**patch_payout_method**](PayoutMethodsApi.md#patch_payout_method) | **PATCH** /payout_methods/{Payout Method ID} | Updating a payout method
+[**post_payout_methods**](PayoutMethodsApi.md#post_payout_methods) | **POST** /payout_methods | Creating a payout method
+
+
+# **delete_payout_method**
+> PayoutMethodResponse delete_payout_method(payout_method_id)
+
+Deleting a payout method
+
+Deletes a single payout method by the Payout Method ID
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PayoutMethodsApi.new
+
+
+begin
+  #Deleting a payout method
+  result = api_instance.delete_payout_method(payout_method_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->delete_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to delete.  Example: `/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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
+
+
+
+# **get_payout_method**
+> PayoutMethodResponse get_payout_method(payout_method_id)
+
+Fetching a payout method
+
+Show a payout method by id
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PayoutMethodsApi.new
+
+
+begin
+  #Fetching a payout method
+  result = api_instance.get_payout_method(payout_method_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->get_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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
+
+
+
+# **get_payout_methods**
+> PayoutMethodListResponse get_payout_methods(opts)
+
+Listing payout methods
+
+List available payout methods
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PayoutMethodsApi.new
+
+opts = { 
+  state: ['state_example'] # Array<String> | Allows filtering results by `state` of the payout method.  Example: `/v1/payout_methods?state[]=enabled`
+  type: ['type_example'] # Array<String> | Allows filtering results by the specified type.  Example: `/v1/payout_methods?type[]=NGN::Bank`
+  sender_id: 'sender_id_example' # String | Allows filtering results by the specified sender id.  Example: `/v1/payout_methods?sender_id=bf9ff782-e182-45ac-abea-5bce83ad6670`
+  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)
+  created_at_from: 'created_at_from_example' # String | Start date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+  created_at_to: 'created_at_to_example' # String | End date to filter recipients by created_at range Allows filtering results by the specified `created_at` timeframe.  Example: `/v1/recipients?created_at_from=2018-06-06&created_at_to=2018-06-08`
+}
+
+begin
+  #Listing payout methods
+  result = api_instance.get_payout_methods(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodListResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->get_payout_methods: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of the payout method.  Example: &#x60;/v1/payout_methods?state[]&#x3D;enabled&#x60; | [optional] 
+ **type** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by the specified type.  Example: &#x60;/v1/payout_methods?type[]&#x3D;NGN::Bank&#x60; | [optional] 
+ **sender_id** | **String**| Allows filtering results by the specified sender id.  Example: &#x60;/v1/payout_methods?sender_id&#x3D;bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | [optional] 
+ **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] 
+ **created_at_from** | **String**| Start date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60; | [optional] 
+ **created_at_to** | **String**| End date to filter recipients by created_at range Allows filtering results by the specified &#x60;created_at&#x60; timeframe.  Example: &#x60;/v1/recipients?created_at_from&#x3D;2018-06-06&amp;created_at_to&#x3D;2018-06-08&#x60; | [optional] 
+
+### Return type
+
+[**PayoutMethodListResponse**](PayoutMethodListResponse.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
+
+
+
+# **patch_payout_method**
+> PayoutMethodResponse patch_payout_method(payout_method_idpayout_method)
+
+Updating a payout method
+
+Updates the payout method specified in the URL path.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PayoutMethodsApi.new
+
+
+begin
+  #Updating a payout method
+  result = api_instance.patch_payout_method(payout_method_idpayout_method)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->patch_payout_method: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_id** | [**String**](.md)| ID of the payout method to get.  Example: &#x60;/v1/payout_methods/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **payout_method** | [**PayoutMethod**](PayoutMethod.md)|  | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_payout_methods**
+> PayoutMethodResponse post_payout_methods(payout_method_request)
+
+Creating a payout method
+
+Creates a new payout method in our system. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PayoutMethodsApi.new
+
+
+begin
+  #Creating a payout method
+  result = api_instance.post_payout_methods(payout_method_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PayoutMethodResponse")
+    p result
+  else
+    puts "Exception when calling PayoutMethodsApi->post_payout_methods: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_method_request** | [**PayoutMethodRequest**](PayoutMethodRequest.md)|  | 
+
+### Return type
+
+[**PayoutMethodResponse**](PayoutMethodResponse.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**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Recipient.md

@@ -0,0 +1,27 @@
+# Bitpesa::Recipient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_amount** | **Float** | the amount that should be paid to the recipient. This can be in any currency, usually either the input or the output currency. If the value here is not the output currency we will calculate how much the recipient is going to get using the exchange rates active when the transaction was created. | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethod**](PayoutMethod.md) |  | 
+**metadata** | [**Object**](.md) | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
+**created_at** | **DateTime** | Date and time that the recipient was created. | [optional] 
+**editable** | **BOOLEAN** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
+**input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
+**may_cancel** | **BOOLEAN** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
+**state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state** | [**RecipientState**](RecipientState.md) |  | [optional] 
+**transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
+**transaction_state** | [**TransactionState**](TransactionState.md) |  | [optional] 
+**exchange_rate** | **Float** | The exchange rate used in this payment | [optional] 
+**fee_fractional** | **Float** | The fee for this payment in fractional units (for example cents for USD transactions) | [optional] 
+**input_amount** | **Float** | The amount that had to be paid in for this payment to proceed | [optional] 
+**input_currency** | **String** | The currency this payment was paid in | [optional] 
+**output_amount** | **Float** | The amount that will be paid to the recipient | [optional] 
+**output_currency** | **String** | The currency the payment will be delivered in | [optional] 
+**id** | **String** |  | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+

data/docs/RecipientBase.md

@@ -0,0 +1,11 @@
+# Bitpesa::RecipientBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_amount** | **Float** | the amount that should be paid to the recipient. This can be in any currency, usually either the input or the output currency. If the value here is not the output currency we will calculate how much the recipient is going to get using the exchange rates active when the transaction was created. | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethodBase**](PayoutMethodBase.md) |  | 
+**metadata** | **Object** | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
+
+

data/docs/RecipientErrorResponse.md

@@ -0,0 +1,26 @@
+# Bitpesa::RecipientErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_amount** | **Float** | the amount that should be paid to the recipient. This can be in any currency, usually either the input or the output currency. If the value here is not the output currency we will calculate how much the recipient is going to get using the exchange rates active when the transaction was created. | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethodBase**](PayoutMethodBase.md) |  | 
+**metadata** | **Object** | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
+**created_at** | **DateTime** | Date and time that the recipient was created. | [optional] 
+**editable** | **BOOLEAN** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
+**input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
+**may_cancel** | **BOOLEAN** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
+**state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state** | **String** | The state of the recipient. Can be one of the following:  * `initial`: We haven't initiated the payout yet, you can still cancel the transaction * `pending`: Payout has been initiated and we're waiting from a response from the provider. The transaction cannot be cancelled * `success`: Payout is done, and the recipient has been paid. * `error`: There was an error from the provider, you can find more details in the `state_reason` attribute. We will usually retry the transaction at a later date. You can either wait, edit the recipient or cancel the transaction. * `refunded`: You asked us to cancel the transaction and we refunded the money. * `manual`: There were too many errors on this transaction, and we stopped retrying. Please edit the recipient, contact us or cancel the transaction. * `stuck`: We didn't receive a response from the provider in time, and we don't know whether it has been paid our not. Please contact us for further details. * `overpaid`: The recipient was paid out more than was requested (not applicable for most of the payout providers) * `canceled`: The transaction has been cancelled, and we will refund the money soon * `exception`: Some exception has happened; please contact BitPesa | [optional] 
+**transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
+**transaction_state** | **String** | The state of the transaction related to this recipient. Please note that even if the transaction's state is `approved`, the state here will only say `initial`. This still means that the sender is approved however and the transaction can be funded. | [optional] 
+**exchange_rate** | **Float** | The exchange rate used in this payment | [optional] 
+**fee_fractional** | **Float** | The fee for this payment in fractioanl units (for example cents for USD transactions) | [optional] 
+**input_amount** | **Float** | The amount that had to be paid in for this payment to proceed | [optional] 
+**input_currency** | **String** | The currency this payment was paid in | [optional] 
+**output_amount** | **Float** | The amount that will be paid to the recipient | [optional] 
+**output_currency** | **String** | The currency the payment will be delivered in | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/RecipientListResponse.md

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