bitpesa-sdk 0.1.0

data/docs/PayinMethodRequest.md

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

data/docs/PayinMethodType.md

@@ -0,0 +1,8 @@
+# Bitpesa::PayinMethodType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of Payin Method. Contains where the money is from as well as the currency. | [optional] 
+
+

data/docs/PayinMethodTypeBase.md

@@ -0,0 +1,8 @@
+# Bitpesa::PayinMethodTypeBase
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** | Type of Payin Method. Contains where the money is from as well as the currency. | [optional] 
+
+

data/docs/PaymentMethod.md

@@ -0,0 +1,13 @@
+# Bitpesa::PaymentMethod
+
+## 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** | Boolean revealing whether this is the default payout method. Only present on payout methods | [optional] 
+**fields** | [**Hash<String, FieldDescription>**](FieldDescription.md) | The fields needed for payments with this payment method with details on validation requirements | [optional] 
+
+

data/docs/PaymentMethodBase.md

@@ -0,0 +1,15 @@
+# Bitpesa::PaymentMethodBase
+
+## 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] 
+**is_main_provider** | **BOOLEAN** | Boolean revealing whether this is the main provider (Only used for payment methods IN) | [optional] 
+**default** | **BOOLEAN** | Boolean revealing whether this is the default payment method (Only used for payment methods IN) | [optional] 
+**fields** | **Object** | The fields needed for payments with this payment method | [optional] 
+**opposites** | [**Array<OppositePaymentMethodBase>**](OppositePaymentMethodBase.md) | Permitted payment methods for current type. | [optional] 
+
+

data/docs/PaymentMethodListResponse.md

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

data/docs/PaymentMethodOpposite.md

@@ -0,0 +1,14 @@
+# Bitpesa::PaymentMethodOpposite
+
+## 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** | Boolean revealing whether this is the default payout method. Only present on payout methods | [optional] 
+**fields** | [**Hash<String, FieldDescription>**](FieldDescription.md) | The fields needed for payments with this payment method with details on validation requirements | [optional] 
+**opposites** | [**Array<PaymentMethod>**](PaymentMethod.md) | List of all providers that can be used in conjunction with the main provider | [optional] 
+
+

data/docs/PaymentMethodsApi.md

@@ -0,0 +1,124 @@
+# Bitpesa::PaymentMethodsApi
+
+All URIs are relative to *https://api-sandbox.bitpesa.co/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**payment_methods_in**](PaymentMethodsApi.md#payment_methods_in) | **GET** /info/payment_methods/in | This method returns possible payin methods.
+[**payment_methods_out**](PaymentMethodsApi.md#payment_methods_out) | **GET** /info/payment_methods/out | This method returns possible payout methods.
+
+
+# **payment_methods_in**
+> PaymentMethodListResponse payment_methods_in
+
+This method returns possible payin methods.
+
+Fetching possible payin methods. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PaymentMethodsApi.new
+
+begin
+  #This method returns possible payin methods.
+  result = api_instance.payment_methods_in
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PaymentMethodListResponse")
+    p result
+  else
+    puts "Exception when calling PaymentMethodsApi->payment_methods_in: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PaymentMethodListResponse**](PaymentMethodListResponse.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
+
+
+
+# **payment_methods_out**
+> PaymentMethodListResponse payment_methods_out
+
+This method returns possible payout methods.
+
+Fetching possible payout methods. 
+
+### Example
+```ruby
+# load the gem
+require 'bitpesa-sdk'
+
+api_instance = Bitpesa::PaymentMethodsApi.new
+
+begin
+  #This method returns possible payout methods.
+  result = api_instance.payment_methods_out
+  p result
+rescue Bitpesa::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("PaymentMethodListResponse")
+    p result
+  else
+    puts "Exception when calling PaymentMethodsApi->payment_methods_out: #{e}"
+  end
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PaymentMethodListResponse**](PaymentMethodListResponse.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/PayoutMethod.md

@@ -0,0 +1,13 @@
+# Bitpesa::PayoutMethod
+
+## 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** | [**PayoutMethodDetails**](PayoutMethodDetails.md) |  | [optional] 
+**metadata** | [**Object**](.md) | Metadata of payout method. You can store any kind of information in this field. | [optional] 
+**id** | **String** |  | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+**fields** | [**Hash<String, FieldDescription>**](FieldDescription.md) | The fields needed for payments with this payment method with details on validation requirements | [optional] 
+
+

data/docs/PayoutMethodBankAccountTypeEnum.md

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

data/docs/PayoutMethodBase.md

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

data/docs/PayoutMethodDetails.md

@@ -0,0 +1,26 @@
+# Bitpesa::PayoutMethodDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+**bank_name** | **String** |  | 
+**iban** | **String** |  | 
+**bic** | **String** |  | [optional] 
+**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
+**sender_identity_card_id** | **String** |  | 
+**sender_city_of_birth** | **String** |  | 
+**sender_country_of_birth** | **String** |  | 
+**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) |  | 
+**reason** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**identity_card_id** | **String** |  | [optional] 
+**reference** | **String** |  | [optional] 
+
+

data/docs/PayoutMethodDetailsBalance.md

@@ -0,0 +1,8 @@
+# Bitpesa::PayoutMethodDetailsBalance
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reference** | **String** |  | [optional] 
+
+

data/docs/PayoutMethodDetailsBase.md

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

data/docs/PayoutMethodDetailsGHSBank.md

@@ -0,0 +1,11 @@
+# Bitpesa::PayoutMethodDetailsGHSBank
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+
+

data/docs/PayoutMethodDetailsIBAN.md

@@ -0,0 +1,12 @@
+# Bitpesa::PayoutMethodDetailsIBAN
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_name** | **String** |  | 
+**iban** | **String** |  | 
+**bic** | **String** |  | [optional] 
+
+

data/docs/PayoutMethodDetailsMADCash.md

@@ -0,0 +1,18 @@
+# Bitpesa::PayoutMethodDetailsMADCash
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+**sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
+**sender_identity_card_id** | **String** |  | 
+**sender_city_of_birth** | **String** |  | 
+**sender_country_of_birth** | **String** |  | 
+**sender_gender** | [**PayoutMethodGenderEnum**](PayoutMethodGenderEnum.md) |  | 
+**reason** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**identity_card_id** | **String** |  | [optional] 
+
+

data/docs/PayoutMethodDetailsMobile.md

@@ -0,0 +1,10 @@
+# Bitpesa::PayoutMethodDetailsMobile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+
+

data/docs/PayoutMethodDetailsNGNBank.md

@@ -0,0 +1,12 @@
+# Bitpesa::PayoutMethodDetailsNGNBank
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+
+

data/docs/PayoutMethodDetailsXOFMobile.md

@@ -0,0 +1,11 @@
+# Bitpesa::PayoutMethodDetailsXOFMobile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
+
+

data/docs/PayoutMethodErrorResponse.md

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

data/docs/PayoutMethodGenderEnum.md

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

data/docs/PayoutMethodIdentityCardTypeEnum.md

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

data/docs/PayoutMethodListResponse.md

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

data/docs/PayoutMethodMobileProviderEnum.md

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

data/docs/PayoutMethodRequest.md

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