transferzero-sdk 1.0.0

data/docs/FieldValidation.md

@@ -0,0 +1,21 @@
+# TransferZero::FieldValidation
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**presence** | **Boolean** | Describes whether the field is mandatory or not | [optional] 
+**inclusion** | [**FieldSelectValidation**](FieldSelectValidation.md) |  | [optional] 
+**format** | [**Object**](.md) | Contains the regex to use to validate the input field | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::FieldValidation.new(presence: null,
+                                 inclusion: null,
+                                 format: {"with":"(?-mix:\\A\\d+\\z)"})
+```
+
+

data/docs/LogsApi.md

@@ -0,0 +1,141 @@
+# TransferZero::LogsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/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 'transferzero-sdk'
+
+api_instance = TransferZero::LogsApi.new
+
+
+begin
+  #Fetch an individual webhook log
+  result = api_instance.get_webhook_log(webhook_log_id)
+  p result
+rescue TransferZero::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 TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/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 'transferzero-sdk'
+
+api_instance = TransferZero::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 TransferZero::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 TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/Pagination.md

@@ -0,0 +1,25 @@
+# TransferZero::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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Pagination.new(current_page: 2,
+                                 next_page: 3,
+                                 prev_page: 1,
+                                 total_pages: 5,
+                                 total_count: 45)
+```
+
+

data/docs/PaginationMeta.md

@@ -0,0 +1,17 @@
+# TransferZero::PaginationMeta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**pagination** | [**Pagination**](Pagination.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PaginationMeta.new(pagination: null)
+```
+
+

data/docs/PayinMethod.md

@@ -0,0 +1,25 @@
+# TransferZero::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/transferzero/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/transferzero/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/transferzero/api-documentation/blob/master/additional-features.md#collections-from-senders) in the API documentation on the valid values | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethod.new(type: NGN::Bank,
+                                 in_details: null,
+                                 out_details: null,
+                                 instructions: null,
+                                 provider: null)
+```
+
+

data/docs/PayinMethodDetails.md

@@ -0,0 +1,21 @@
+# TransferZero::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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodDetails.new(redirect_url: null,
+                                 phone_number: +2569999999,
+                                 send_instructions: null)
+```
+
+

data/docs/PayinMethodDetailsMobile.md

@@ -0,0 +1,19 @@
+# TransferZero::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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
+                                 send_instructions: null)
+```
+
+

data/docs/PayinMethodDetailsNGNBank.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodDetailsNGNBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**redirect_url** | **String** | This is where the user should be redirected back when the payment has been finished | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodDetailsNGNBank.new(redirect_url: null)
+```
+
+

data/docs/PayinMethodRequest.md

@@ -0,0 +1,17 @@
+# TransferZero::PayinMethodRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payin_method** | [**PayinMethod**](PayinMethod.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayinMethodRequest.new(payin_method: null)
+```
+
+

data/docs/PaymentMethod.md

@@ -0,0 +1,27 @@
+# TransferZero::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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PaymentMethod.new(type: NGN::Bank,
+                                 provider: Interswitch,
+                                 otc_permitted: null,
+                                 details: ["email","first_name","last_name","address"],
+                                 default: null,
+                                 fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}})
+```
+
+

data/docs/PaymentMethodListResponse.md

@@ -0,0 +1,17 @@
+# TransferZero::PaymentMethodListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Array<PaymentMethodOpposite>**](PaymentMethodOpposite.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PaymentMethodListResponse.new(object: null)
+```
+
+

data/docs/PaymentMethodOpposite.md

@@ -0,0 +1,29 @@
+# TransferZero::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] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PaymentMethodOpposite.new(type: NGN::Bank,
+                                 provider: Interswitch,
+                                 otc_permitted: null,
+                                 details: ["email","first_name","last_name","address"],
+                                 default: null,
+                                 fields: {"email":{"type":"input","validations":{"inclusion":{"in":{"NI":"National Id","PP":"Passport"},"allow_blank":true}}}},
+                                 opposites: null)
+```
+
+

data/docs/PaymentMethodsApi.md

@@ -0,0 +1,124 @@
+# TransferZero::PaymentMethodsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/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 'transferzero-sdk'
+
+api_instance = TransferZero::PaymentMethodsApi.new
+
+begin
+  #This method returns possible payin methods.
+  result = api_instance.payment_methods_in
+  p result
+rescue TransferZero::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 TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/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 'transferzero-sdk'
+
+api_instance = TransferZero::PaymentMethodsApi.new
+
+begin
+  #This method returns possible payout methods.
+  result = api_instance.payment_methods_out
+  p result
+rescue TransferZero::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 TransferZero object when setting it up:
+
+```ruby
+
+TransferZero.configure do |config|
+  config.api_key = '<key'
+  config.api_secret = '<secret>'
+  config.host = 'https://api-sandbox.transferzero.com/v1'
+end
+
+```
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+