bitpesa-sdk 0.1.0

data/docs/SenderState.md

@@ -0,0 +1,7 @@
+# Bitpesa::SenderState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/SenderValidResponse.md

@@ -0,0 +1,32 @@
+# Bitpesa::SenderValidResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of sender to create - either person or business (defaults to person)  | [optional] 
+**country** | **String** | Country of sender in 2-character alpha ISO 3166-2 country format | 
+**phone_country** | **String** | Phone country of sender in 2-character alpha ISO 3166-2 country format | 
+**phone_number** | **String** | Phone number of sender (without country callcode) | [optional] 
+**email** | **String** | Email of sender | 
+**first_name** | **String** | First name of sender (used only with a Personal sender) | [optional] 
+**middle_name** | **String** | Middle name of sender (used only with a Personal sender) | [optional] 
+**last_name** | **String** | Last name of sender (used only with a Personal sender) | [optional] 
+**occupation** | **String** | Occupation of sender (used only with a Personal sender) | [optional] 
+**nationality** | **String** | The nationality of the sender (used only with a Personal sender) | [optional] 
+**onboarding_status** | **String** | The onboarding status of the sender | [optional] 
+**address** | **String** | The address of the sender | [optional] 
+**description** | **String** | Description of the sender | [optional] 
+**name** | **String** | Name of sender (used only with a Business sender) | [optional] 
+**city** | **String** | Sender's city | 
+**street** | **String** | Sender's street | 
+**address_description** | **String** | Description of address | [optional] 
+**postal_code** | **String** | Zip code of sender | 
+**birth_date** | **Date** | Date of birth of sender | [optional] 
+**ip** | **String** | IP of sender | 
+**documents** | [**Array<DocumentBase>**](DocumentBase.md) | Needed for KYC checks. Required to approve the sender unless KYC is waived for your account. Please send us an empty list of documents: `\"documents\": [ ]` in the request if KYC has been waived.  If the documents already exist, please send the Document ID eg. ```JSON \"documents\": [   {     \"id\": \"b6648ba3-1c7b-4f59-8580-684899c84a07\"   } ] ``` | 
+**metadata** | **Object** | Metadata of sender. You can store any detail specific to your integration here (for example the local ID of the sender on your end). When requesting sender details you will receive the sent metadata back. Also when sending sender related webhooks you will receive the details stored here as well. | [optional] 
+**providers** | **Object** | Providers associated with sender (deprecated) | [optional] 
+**state** | **String** | The state of the sender. Can be one of the following:  - `initial`: When a sender is created and has not been through any KYC checking (cannot transact) - `verified`: A sender has passed sanction list checks (cannot transact) - `approved`: The sender has passed both KYC and sanction checks (can transact) - `banned`: An admin has banned the sender (cannot transact) - `rejected`: The sender has failed sanction list checks (cannot transact) - `disabled`: A sender is put into this state as a result of a delete request via the API (cannot transact) | [optional] 
+**id** | **String** |  | [optional] 
+
+

data/docs/SenderWebhook.md

@@ -0,0 +1,10 @@
+# Bitpesa::SenderWebhook
+
+## 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** | [**Sender**](Sender.md) |  | 
+
+

data/docs/SendersApi.md

@@ -0,0 +1,328 @@
+# Bitpesa::SendersApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_sender**](SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
+[**get_sender**](SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
+[**get_senders**](SendersApi.md#get_senders) | **GET** /senders | Listing senders
+[**patch_sender**](SendersApi.md#patch_sender) | **PATCH** /senders/{Sender ID} | Updating a sender
+[**post_senders**](SendersApi.md#post_senders) | **POST** /senders | Creating a sender
+
+
+# **delete_sender**
+> SenderResponse delete_sender(sender_id)
+
+Deleting a sender
+
+Deletes a single sender by the Sender ID
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::SendersApi.new
+
+
+begin
+  #Deleting a sender
+  result = api_instance.delete_sender(sender_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("SenderResponse")
+    p result
+  else
+    puts "Exception when calling SendersApi->delete_sender: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | [**String**](.md)| ID of the sender to delete.  Example: `/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670` | 
+
+### Return type
+
+[**SenderResponse**](SenderResponse.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_sender**
+> SenderResponse get_sender(sender_id)
+
+Fetching a sender
+
+Returns a single sender by the Sender ID
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::SendersApi.new
+
+
+begin
+  #Fetching a sender
+  result = api_instance.get_sender(sender_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("SenderResponse")
+    p result
+  else
+    puts "Exception when calling SendersApi->get_sender: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | [**String**](.md)| ID of the sender to get.  Example: &#x60;/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+
+### Return type
+
+[**SenderResponse**](SenderResponse.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_senders**
+> SenderListResponse get_senders(opts)
+
+Listing senders
+
+Get a list of available senders
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::SendersApi.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)
+  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 senders
+  result = api_instance.get_senders(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("SenderListResponse")
+    p result
+  else
+    puts "Exception when calling SendersApi->get_senders: #{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] 
+ **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
+
+[**SenderListResponse**](SenderListResponse.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_sender**
+> SenderResponse patch_sender(sender_idsender_request)
+
+Updating a sender
+
+Updates the sender specified in the URL path.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::SendersApi.new
+
+
+begin
+  #Updating a sender
+  result = api_instance.patch_sender(sender_idsender_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("SenderResponse")
+    p result
+  else
+    puts "Exception when calling SendersApi->patch_sender: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_id** | [**String**](.md)| ID of the sender to get.  Example: &#x60;/v1/senders/bf9ff782-e182-45ac-abea-5bce83ad6670&#x60; | 
+ **sender_request** | [**SenderRequest**](SenderRequest.md)|  | 
+
+### Return type
+
+[**SenderResponse**](SenderResponse.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_senders**
+> SenderResponse post_senders(sender_request)
+
+Creating a sender
+
+Creates a new sender in our system. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::SendersApi.new
+
+
+begin
+  #Creating a sender
+  result = api_instance.post_senders(sender_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("SenderResponse")
+    p result
+  else
+    puts "Exception when calling SendersApi->post_senders: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **sender_request** | [**SenderRequest**](SenderRequest.md)|  | 
+
+### Return type
+
+[**SenderResponse**](SenderResponse.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/Transaction.md

@@ -0,0 +1,22 @@
+# Bitpesa::Transaction
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
+**payin_methods** | [**Array<PayinMethod>**](PayinMethod.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**metadata** | [**Object**](.md) | Additional metadata to store on the transaction. If you widh to store your local transaction ID, you should add it here inside a `sendRef` field, and we will return this value back to you in the daily transaction reports. | [optional] 
+**sender** | [**Sender**](Sender.md) |  | 
+**recipients** | [**Array<Recipient>**](Recipient.md) | The details of where the payment should go. although transactions can support paying out multiple recipients, usually one is provided.  | 
+**traits** | [**TransactionTraits**](TransactionTraits.md) |  | [optional] 
+**state** | [**TransactionState**](TransactionState.md) |  | [optional] 
+**input_amount** | **Float** | The amount that was requested in the input currency | [optional] 
+**payin_reference** | **String** | The reference number that has to be provided in case the transaction is not funded through account balance | [optional] 
+**paid_amount** | **Float** | The amount that was already paid in to the transaction | [optional] 
+**due_amount** | **Float** | The amount needed to be paid in for the transaction to get funded | [optional] 
+**created_at** | **DateTime** | The time the transaction was created | [optional] 
+**expires_at** | **DateTime** | The latest time when the transaction has to be funded, otherwise it will be cancelled | [optional] 
+**id** | **String** |  | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+

data/docs/TransactionBase.md

@@ -0,0 +1,13 @@
+# Bitpesa::TransactionBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
+**payin_methods** | [**Array<PayinMethodBase>**](PayinMethodBase.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**metadata** | **Object** |  | [optional] 
+**sender** | **Object** |  | 
+**recipients** | **Array<Object>** |  | 
+**traits** | [**TransactionTraits**](TransactionTraits.md) |  | [optional] 
+
+

data/docs/TransactionErrorResponse.md

@@ -0,0 +1,21 @@
+# Bitpesa::TransactionErrorResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**input_currency** | **String** | The input currency describes what currency the transaction will be paid in (3-character alpha ISO 4217 currency format). For example if you wish to create an EUR to NGN transaction then input currency should be set to EUR. | 
+**payin_methods** | [**Array<PayinMethodBase>**](PayinMethodBase.md) | Allows setting alternative collections, where funding the transaction is done through alternative means and not via account balance.  For more information please see [Collections from senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation | [optional] 
+**metadata** | **Object** |  | [optional] 
+**sender** | [**SenderErrorResponse**](SenderErrorResponse.md) |  | 
+**recipients** | [**Array<RecipientErrorResponse>**](RecipientErrorResponse.md) |  | 
+**traits** | [**TransactionTraits**](TransactionTraits.md) |  | [optional] 
+**state** | **String** | The state of the transaction, which can be one of the following:  * `initial`: Transaction is created, but not yet ready to receive payments (waiting for Sender to be KYC'd and approved). * `approved`: Transaction is created and the sender is approved. Payment can be received * `pending`: Transaction has received a payin, and it's waiting for the funds to clear. * `received`: Transaction has received the correct payin amount and will start processing the payouts. * `mispaid`: Transaction received funds, but not the requested amount. The transaction will be resized, and will start payout based on the received funds. * `manual`: Some of the payments to the recipients have run into issues. Please check the recipient statuses for more information. * `paid`: Transaction has received correct payins and has performed payouts to all recipients. No further steps required * `canceled`: The transaction has been cancelled. Transactions are cancelled automatically after one hour if there was no funds received. Once transactions are funded they can be cancelled by the API user unless the recipients have been paid out. * `refunded`: The transaction has been cancelled after it has been funded, but the funds have been returned now to the sender either partially or fully. * `exception`: An exception happened during the processing of the transaction. Please contact BitPesa | [optional] 
+**input_amount** | **Float** | The amount that was requested in the input currency | [optional] 
+**payin_reference** | **String** | The reference number that has to be provided in case the transaction is not funded through account balance | [optional] 
+**paid_amount** | **Float** | The amount that was already paid in to the transaction | [optional] 
+**due_amount** | **Float** | The amount needed to be paid in for the transaction to get funded | [optional] 
+**created_at** | **DateTime** | The time the transaction was created | [optional] 
+**expires_at** | **DateTime** | The latest time when the transaction has to be funded, otherwise it will be cancelled | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/TransactionListResponse.md

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