bitpesa-sdk 0.1.0

data/docs/InlineResponse422Meta.md

@@ -0,0 +1,8 @@
+# BitPesa::InlineResponse422Meta
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** |  | [optional] 
+
+

data/docs/InlineResponse422Object.md

@@ -0,0 +1,8 @@
+# BitPesa::InlineResponse422Object
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**account_name** | **Object** |  | [optional] 
+
+

data/docs/InvalidDebit.md

@@ -0,0 +1,14 @@
+# BitPesa::InvalidDebit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | The amount to be debited from your account. | [optional] 
+**currency** | **String** | The currency of the amount in 3-character alpha ISO 4217 currency format | [optional] 
+**to_type** | **String** | Describes what the debit is funding | [optional] 
+**to_id** | **String** | The ID of the resource the debit is funding | [optional] 
+**usd_amount** | **Float** | The amount in USD | [optional] 
+**metadata** | **Object** | Metadata of account debit | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/InvalidDocument.md

@@ -0,0 +1,17 @@
+# BitPesa::InvalidDocument
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**upload** | **String** | Base64 encoded data uri of an image or pdf file | 
+**upload_file_name** | **String** | Name of the upload | 
+**metadata** | **Object** | Metadata of document | [optional] 
+**upload_content_type** | **String** |  | [optional] 
+**upload_file_size** | **Integer** |  | [optional] 
+**category** | **String** |  | [optional] 
+**side** | **String** | The side of the KYC ID. One of 'front' or 'back' | [optional] 
+**issuing_country** | **String** | Issuing country of ID in 2-character alpha ISO 3166-2 country format | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/InvalidRecipient.md

@@ -0,0 +1,12 @@
+# BitPesa::InvalidRecipient
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**requested_amount** | **Float** | the amount to pay out | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethod**](PayoutMethod.md) |  | 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/InvalidSender.md

@@ -0,0 +1,25 @@
+# BitPesa::InvalidSender
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**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] 
+**last_name** | **String** | Last name of sender (used only with a Personal 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<Document>**](Document.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\"   } ] ``` | [optional] 
+**metadata** | **Object** | Metadata of sender | [optional] 
+**errors** | **Object** | List of invalid fields with associated errors | [optional] 
+
+

data/docs/InvalidWebhook.md

@@ -0,0 +1,11 @@
+# BitPesa::InvalidWebhook
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The URL to receive the webhook | [optional] 
+**events** | **Array<String>** | A list of events to subscribe to | [optional] 
+**metadata** | **Object** |  | [optional] 
+**errors** | **Object** |  | [optional] 
+
+

data/docs/LogsApi.md

@@ -0,0 +1,141 @@
+# Bitpesa::LogsApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_webhook_log**](LogsApi.md#get_webhook_log) | **GET** /logs/{Webhook Log ID} | Fetch an individual webhook log
+[**get_webhook_logs**](LogsApi.md#get_webhook_logs) | **GET** /logs/webhooks | Fetch a list of webhook logs
+
+
+# **get_webhook_log**
+> WebhookLogResponse get_webhook_log(webhook_log_id)
+
+Fetch an individual webhook log
+
+Returns a single webhook log based on the webhook log ID.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::LogsApi.new
+
+
+begin
+  #Fetch an individual webhook log
+  result = api_instance.get_webhook_log(webhook_log_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookLogResponse")
+    p result
+  else
+    puts "Exception when calling LogsApi->get_webhook_log: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_log_id** | [**String**](.md)| ID of the webhook log to retrieve  Example: `/v1/logs/9d1ad631-f34a-4cff-9a7e-2c83e3a556df` | 
+
+### Return type
+
+[**WebhookLogResponse**](WebhookLogResponse.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_webhook_logs**
+> WebhookLogListResponse get_webhook_logs(opts)
+
+Fetch a list of webhook logs
+
+Returns a list of webhook logs. Response includes pagination.
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::LogsApi.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
+  #Fetch a list of webhook logs
+  result = api_instance.get_webhook_logs(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookLogListResponse")
+    p result
+  else
+    puts "Exception when calling LogsApi->get_webhook_logs: #{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
+
+[**WebhookLogListResponse**](WebhookLogListResponse.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/Meta.md

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

data/docs/Meta2.md

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

data/docs/Meta2Pagination.md

@@ -0,0 +1,12 @@
+# Bitpesa::Meta2Pagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | The number of the current page | [optional] 
+**next_page** | **Integer** | The number of the next page. If no next page exists, this will be `null` | [optional] 
+**prev_page** | **Integer** | The number of the previous page. If no previous page exists, this will be `null` | [optional] 
+**total_pages** | **Integer** | The number of pages in the result set | [optional] 
+**total_count** | **Integer** | The total number of results in the set | [optional] 
+
+

data/docs/MetaPagination.md

@@ -0,0 +1,12 @@
+# Bitpesa::MetaPagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | The number of the current page | [optional] 
+**next_page** | **Integer** | The number of the next page. If no next page exists, this will be `null` | [optional] 
+**prev_page** | **Integer** | The number of the previous page. If no previous page exists, this will be `null` | [optional] 
+**total_pages** | **Integer** | The number of pages in the result set | [optional] 
+**total_count** | **Integer** | The total number of results in the set | [optional] 
+
+

data/docs/Object.md

@@ -0,0 +1,9 @@
+# Bitpesa::Object
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Float** | The account balance for the given currency | [optional] 
+**currency** | **String** | The currency of this balance | [optional] 
+
+

data/docs/OppositePaymentMethod.md

@@ -0,0 +1,13 @@
+# Bitpesa::OppositePaymentMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Details currency and type of payment. | [optional] 
+**provider** | **String** | Identifies the payment provider. | [optional] 
+**otc_permitted** | **BOOLEAN** | Are over the counter transactions permitted? | [optional] 
+**details** | **Array<String>** | Fields required to make the payment depending on type. | [optional] 
+**default** | **BOOLEAN** | Is this the default payment method? | [optional] 
+**fields** | **Object** | Details associated with the payment method. | [optional] 
+
+

data/docs/OppositePaymentMethodBase.md

@@ -0,0 +1,13 @@
+# Bitpesa::OppositePaymentMethodBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Details currency and type of payment. | [optional] 
+**provider** | **String** | Identifies the payment provider. | [optional] 
+**otc_permitted** | **BOOLEAN** | Are over the counter transactions permitted? | [optional] 
+**details** | **Array<String>** | Fields required to make the payment depending on type. | [optional] 
+**default** | **BOOLEAN** | Is this the default payment method? | [optional] 
+**fields** | **Object** | Describes what fields are required when sending the payment, and what validations will be enforced on these fields | [optional] 
+
+

data/docs/Pagination.md

@@ -0,0 +1,12 @@
+# Bitpesa::Pagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | The number of the current page | [optional] 
+**next_page** | **Integer** | The number of the next page. If no next page exists, this will be `null` | [optional] 
+**prev_page** | **Integer** | The number of the previous page. If no previous page exists, this will be `null` | [optional] 
+**total_pages** | **Integer** | The number of pages in the result set | [optional] 
+**total_count** | **Integer** | The total number of results in the set | [optional] 
+
+

data/docs/PaginationMeta.md

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

data/docs/PaginationPagination.md

@@ -0,0 +1,12 @@
+# BitPesa::PaginationPagination
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**current_page** | **Integer** | The current page number | [optional] 
+**next_page** | **Integer** | The next page number | [optional] 
+**prev_page** | **Integer** | The previous page number | [optional] 
+**total_pages** | **Integer** | The number of pages in the resultset | [optional] 
+**total_count** | **Integer** | The number of records available in the resultset | [optional] 
+
+

data/docs/PayinMethod.md

@@ -0,0 +1,12 @@
+# Bitpesa::PayinMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN card collection requests - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections  | [optional] 
+**in_details** | [**PayinMethodDetails**](PayinMethodDetails.md) |  | [optional] 
+**out_details** | [**Object**](.md) | This will contain the description on where to pay the funds. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
+**instructions** | [**Object**](.md) | This will contain the instructions on how to pay the funds. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
+**provider** | **String** | Describes which provider to use for collection. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on the valid values | [optional] 
+
+

data/docs/PayinMethodBase.md

@@ -0,0 +1,12 @@
+# Bitpesa::PayinMethodBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN card collection requests - `NGN::Mobile`: NGN card and mobile collection requests - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections - `GBP::Bank`: GBP collections through IBAN - `EUR::Bank`: EUR collections through IBAN - `JPY::Bank`: JPY collections through IBAN  | [optional] 
+**in_details** | [**PayinMethodDetailsBase**](PayinMethodDetailsBase.md) |  | [optional] 
+**out_details** | **Object** | This will contain the description on where to pay the funds. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
+**instructions** | **Object** | This will contain the instructions on how to pay the funds. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on what to expect here. | [optional] 
+**provider** | **String** | Describes which provider to use for collection. Please see the [Collections from Senders](https://github.com/bitpesa/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on the valid values | [optional] 
+
+

data/docs/PayinMethodDetails.md

@@ -0,0 +1,10 @@
+# Bitpesa::PayinMethodDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+**phone_number** | **String** | The phone number where the funds should be collected from | 
+**send_instructions** | **BOOLEAN** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
+
+

data/docs/PayinMethodDetailsBase.md

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

data/docs/PayinMethodDetailsMobile.md

@@ -0,0 +1,9 @@
+# Bitpesa::PayinMethodDetailsMobile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**phone_number** | **String** | The phone number where the funds should be collected from | 
+**send_instructions** | **BOOLEAN** | States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment. | [optional] 
+
+

data/docs/PayinMethodDetailsNGNBank.md

@@ -0,0 +1,8 @@
+# Bitpesa::PayinMethodDetailsNGNBank
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+
+