bitpesa-sdk 0.1.0

data/docs/ValidDebit.md

@@ -0,0 +1,16 @@
+# BitPesa::ValidDebit
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**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] 
+**running_balance** | **Float** | The account running balance | [optional] 
+**created_at** | **String** | Specifies when the account debit was created | [optional] 
+**metadata** | **Object** | Metadata of account debit | [optional] 
+
+

data/docs/ValidationErrorDescription.md

@@ -0,0 +1,8 @@
+# Bitpesa::ValidationErrorDescription
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | **String** | Describes what the problem is with the field | [optional] 
+
+

data/docs/Webhook.md

@@ -0,0 +1,10 @@
+# Bitpesa::Webhook
+
+## 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** | [**Object**](.md) | The returned object | 
+
+

data/docs/WebhookBase.md

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

data/docs/WebhookDefinition.md

@@ -0,0 +1,12 @@
+# Bitpesa::WebhookDefinition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | The URL to receive the webhook | 
+**events** | **Array<String>** | A list of events to subscribe to | 
+**metadata** | [**Object**](.md) |  | [optional] 
+**id** | **String** | The ID of the webhook | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+

data/docs/WebhookDefinitionBase.md

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

data/docs/WebhookDefinitionErrorResponse.md

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

data/docs/WebhookDefinitionEventListResponse.md

@@ -0,0 +1,8 @@
+# Bitpesa::WebhookDefinitionEventListResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | **Array<String>** |  | [optional] 
+
+

data/docs/WebhookDefinitionListResponse.md

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

data/docs/WebhookDefinitionRequest.md

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

data/docs/WebhookDefinitionResponse.md

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

data/docs/WebhookDefinitionValidResponse.md

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

data/docs/WebhookErrorResponse.md

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

data/docs/WebhookLog.md

@@ -0,0 +1,13 @@
+# Bitpesa::WebhookLog
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the webhook log | [optional] 
+**message** | **String** | Message detailing webhook event | [optional] 
+**metadata** | [**WebhookLogMetadata**](WebhookLogMetadata.md) |  | [optional] 
+**created_at** | **String** | Date and time of response | [optional] 
+**parent_id** | **String** |  | [optional] 
+**parent_type** | **String** |  | [optional] 
+
+

data/docs/WebhookLogBase.md

@@ -0,0 +1,13 @@
+# Bitpesa::WebhookLogBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | ID of the webhook log | [optional] 
+**message** | **String** | Message detailing webhook event | [optional] 
+**metadata** | [**WebhookLogBaseMetadata**](WebhookLogBaseMetadata.md) |  | [optional] 
+**created_at** | **String** | Date and time of response | [optional] 
+**parent_id** | **String** |  | [optional] 
+**parent_type** | **String** |  | [optional] 
+
+

data/docs/WebhookLogBaseMetadata.md

@@ -0,0 +1,17 @@
+# Bitpesa::WebhookLogBaseMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**params** | [**WebhookLogBaseMetadataParams**](WebhookLogBaseMetadataParams.md) |  | [optional] 
+**event** | **String** | Specific event that triggered the webhook | [optional] 
+**instance_id** | **String** | Instance ID of the webhook event | [optional] 
+**instance_type** | **String** | Type of instance event | [optional] 
+**attempt_id** | **String** | Attempt ID | [optional] 
+**tries** | **Integer** | Number of tries at the point webhook was triggered | [optional] 
+**request** | [**WebhookLogBaseMetadataRequest**](WebhookLogBaseMetadataRequest.md) |  | [optional] 
+**response** | [**WebhookLogBaseMetadataResponse**](WebhookLogBaseMetadataResponse.md) |  | [optional] 
+**app_id** | **String** | ID of app on which webhook event was triggered | [optional] 
+**api_key_id** | **String** | ID of API key in use at point of webhook event | [optional] 
+
+

data/docs/WebhookLogBaseMetadataParams.md

@@ -0,0 +1,8 @@
+# Bitpesa::WebhookLogBaseMetadataParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **Object** |  | [optional] 
+
+

data/docs/WebhookLogBaseMetadataRequest.md

@@ -0,0 +1,10 @@
+# Bitpesa::WebhookLogBaseMetadataRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**headers** | **Object** |  | [optional] 
+**body** | **String** | The body that was sent in the webhook | [optional] 
+**url** | **String** | Webhook URL | [optional] 
+
+

data/docs/WebhookLogBaseMetadataResponse.md

@@ -0,0 +1,10 @@
+# Bitpesa::WebhookLogBaseMetadataResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Full body of response | [optional] 
+**headers** | **Object** | Headers delivered with webhook response | [optional] 
+**status** | **String** | Status of response | [optional] 
+
+

data/docs/WebhookLogListResponse.md

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

data/docs/WebhookLogMetadata.md

@@ -0,0 +1,17 @@
+# Bitpesa::WebhookLogMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**params** | [**WebhookDefinition**](WebhookDefinition.md) |  | [optional] 
+**event** | **String** | Specific event that triggered the webhook | [optional] 
+**instance_id** | **String** | Instance ID of the webhook event | [optional] 
+**instance_type** | **String** | Type of instance event | [optional] 
+**attempt_id** | **String** | Attempt ID | [optional] 
+**tries** | **Integer** | Number of tries at the point webhook was triggered | [optional] 
+**request** | [**WebhookLogMetadataRequest**](WebhookLogMetadataRequest.md) |  | [optional] 
+**response** | [**WebhookLogMetadataResponse**](WebhookLogMetadataResponse.md) |  | [optional] 
+**app_id** | **String** | ID of app on which webhook event was triggered | [optional] 
+**api_key_id** | **String** | ID of API key in use at point of webhook event | [optional] 
+
+

data/docs/WebhookLogMetadataParams.md

@@ -0,0 +1,8 @@
+# Bitpesa::WebhookLogMetadataParams
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**webhook** | **Object** |  | [optional] 
+
+

data/docs/WebhookLogMetadataRequest.md

@@ -0,0 +1,10 @@
+# Bitpesa::WebhookLogMetadataRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**headers** | **Hash<String, String>** |  | [optional] 
+**body** | **String** | The body that was sent in the webhook | [optional] 
+**url** | **String** | Webhook URL | [optional] 
+
+

data/docs/WebhookLogMetadataResponse.md

@@ -0,0 +1,10 @@
+# Bitpesa::WebhookLogMetadataResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**body** | **String** | Full body of response | [optional] 
+**headers** | **Hash<String, String>** | Headers delivered with webhook response | [optional] 
+**status** | **String** | Status of response | [optional] 
+
+

data/docs/WebhookLogResponse.md

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

data/docs/WebhookRequest.md

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

data/docs/WebhookValidResponse.md

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

data/docs/WebhooksApi.md

@@ -0,0 +1,319 @@
+# Bitpesa::WebhooksApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /webhooks/{Webhook ID} | Unsubscribing from a webhook
+[**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /webhooks/{Webhook ID} | Find a webhook's details
+[**get_webhook_events**](WebhooksApi.md#get_webhook_events) | **GET** /webhooks/events | Find possible webhook events
+[**get_webhooks**](WebhooksApi.md#get_webhooks) | **GET** /webhooks | Listing webhooks
+[**post_webhooks**](WebhooksApi.md#post_webhooks) | **POST** /webhooks | Creating a webhook
+
+
+# **delete_webhook**
+> WebhookDefinitionResponse delete_webhook(webhook_id)
+
+Unsubscribing from a webhook
+
+Unsubscribes from a webhook specified
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::WebhooksApi.new
+
+
+begin
+  #Unsubscribing from a webhook
+  result = api_instance.delete_webhook(webhook_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->delete_webhook: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | **String**| The ID of webhook to cancel.  Example: `/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33` | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.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**
+> WebhookDefinitionResponse get_webhook(webhook_id)
+
+Find a webhook's details
+
+Look up a webhook's details with its ID
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::WebhooksApi.new
+
+
+begin
+  #Find a webhook's details
+  result = api_instance.get_webhook(webhook_id)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhook: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_id** | [**String**](.md)| The ID of the Webhook to look up  Example: &#x60;/v1/webhooks/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60; | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.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_events**
+> WebhookDefinitionEventListResponse get_webhook_events
+
+Find possible webhook events
+
+Fetching possible webhook events
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::WebhooksApi.new
+
+begin
+  #Find possible webhook events
+  result = api_instance.get_webhook_events
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionEventListResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhook_events: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WebhookDefinitionEventListResponse**](WebhookDefinitionEventListResponse.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_webhooks**
+> WebhookDefinitionListResponse get_webhooks(opts)
+
+Listing webhooks
+
+Get a list of created webhooks
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::WebhooksApi.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)
+}
+
+begin
+  #Listing webhooks
+  result = api_instance.get_webhooks(opts)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionListResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->get_webhooks: #{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] 
+
+### Return type
+
+[**WebhookDefinitionListResponse**](WebhookDefinitionListResponse.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
+
+
+
+# **post_webhooks**
+> WebhookDefinitionResponse post_webhooks(webhook_definition_request)
+
+Creating a webhook
+
+Creates a new webhook, subscribing the provided endpoint to the specified event(s) 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::WebhooksApi.new
+
+
+begin
+  #Creating a webhook
+  result = api_instance.post_webhooks(webhook_definition_request)
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("WebhookDefinitionResponse")
+    p result
+  else
+    puts "Exception when calling WebhooksApi->post_webhooks: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **webhook_definition_request** | [**WebhookDefinitionRequest**](WebhookDefinitionRequest.md)|  | 
+
+### Return type
+
+[**WebhookDefinitionResponse**](WebhookDefinitionResponse.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
+
+
+