transferzero-sdk 1.0.0

data/docs/Recipient.md

@@ -0,0 +1,55 @@
+# TransferZero::Recipient
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**requested_amount** | **Float** | the amount that should be paid to the recipient. This can be in any currency, usually either the input or the output currency. If the value here is not the output currency we will calculate how much the recipient is going to get using the exchange rates active when the transaction was created. | 
+**requested_currency** | **String** | the currency of the amount in 3-character alpha ISO 4217 currency format | 
+**payout_method** | [**PayoutMethod**](PayoutMethod.md) |  | 
+**metadata** | [**Object**](.md) | Additional metadata that can be added to a recipient. These values will be returned on request | [optional] 
+**created_at** | **DateTime** | Date and time that the recipient was created. | [optional] 
+**editable** | **Boolean** | Shows whether the recipient can be edited using the PATCH /v1/recipients/{id} endpoint or not | [optional] 
+**input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
+**may_cancel** | **Boolean** | Shows whether the payment can be cancelled using the DELETE /v1/recipients/{id} endpoint or not. The payment can not be cancelled if the payout is pending. | [optional] 
+**state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state** | [**RecipientState**](RecipientState.md) |  | [optional] 
+**transaction_id** | **String** | The ID of the transaction that is related to this recipient | [optional] 
+**transaction_state** | [**TransactionState**](TransactionState.md) |  | [optional] 
+**exchange_rate** | **Float** | The exchange rate used in this payment | [optional] 
+**fee_fractional** | **Float** | The fee for this payment in fractional units (for example cents for USD transactions) | [optional] 
+**input_amount** | **Float** | The amount that had to be paid in for this payment to proceed | [optional] 
+**input_currency** | **String** | The currency this payment was paid in | [optional] 
+**output_amount** | **Float** | The amount that will be paid to the recipient | [optional] 
+**output_currency** | **String** | The currency the payment will be delivered in | [optional] 
+**id** | **String** |  | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Recipient.new(requested_amount: 750.0,
+                                 requested_currency: NGN,
+                                 payout_method: null,
+                                 metadata: {},
+                                 created_at: null,
+                                 editable: null,
+                                 input_usd_amount: 10,
+                                 may_cancel: null,
+                                 state_reason: null,
+                                 state: null,
+                                 transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
+                                 transaction_state: null,
+                                 exchange_rate: 1000,
+                                 fee_fractional: 100,
+                                 input_amount: 10,
+                                 input_currency: USD,
+                                 output_amount: 10000,
+                                 output_currency: NGN,
+                                 id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+```
+
+

data/docs/RecipientListResponse.md

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

data/docs/RecipientRequest.md

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

data/docs/RecipientResponse.md

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

data/docs/RecipientState.md

@@ -0,0 +1,16 @@
+# TransferZero::RecipientState
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::RecipientState.new()
+```
+
+

data/docs/RecipientWebhook.md

@@ -0,0 +1,21 @@
+# TransferZero::RecipientWebhook
+
+## 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** | [**Recipient**](Recipient.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::RecipientWebhook.new(webhook: b2f574ff-7efe-4579-9f16-fcb9097e5ab6,
+                                 event: transaction.paid,
+                                 object: null)
+```
+
+

data/docs/RecipientsApi.md

@@ -0,0 +1,212 @@
+# TransferZero::RecipientsApi
+
+All URIs are relative to *https://api-sandbox.transferzero.com/v1*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_recipient**](RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
+[**get_recipients**](RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
+[**patch_recipient**](RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+
+
+# **delete_recipient**
+> RecipientResponse delete_recipient(recipient_id)
+
+Cancelling a recipient
+
+Cancels the payment to the recipient specified in the URL path.  Please note only recipients where the `may_cancel` attribute is true can be cancelled.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::RecipientsApi.new
+
+
+begin
+  #Cancelling a recipient
+  result = api_instance.delete_recipient(recipient_id)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->delete_recipient: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of recipient to cancel.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33` | 
+
+### Return type
+
+[**RecipientResponse**](RecipientResponse.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_recipients**
+> RecipientListResponse get_recipients(opts)
+
+Getting a list of recipients with filtering
+
+Fetches details of all recipients.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::RecipientsApi.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`
+  amount_from: 'amount_from_example' # String | Minimum amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
+  amount_to: 'amount_to_example' # String | Max amount to filter recipients by amount range.  Allows filtering results by the specified `amount` range. When using this filter, the `currency` should also be specified.  Example: `/v1/recipients?currency=NGN&amount_from=83.76672339&amount_to=83.76672339`
+  state: ['state_example'] # Array<String> | Allows filtering results by `state` of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: `/v1/recipients?state[]=error&state[]=initial`
+  currency: ['currency_example'] # Array<String> | Allows filtering results by `input_currency`.  Additionally required when filtering by an amount range Example: `/v1/recipients?currency[]=KES&currency[]=NGN`
+}
+
+begin
+  #Getting a list of recipients with filtering
+  result = api_instance.get_recipients(opts)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientListResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->get_recipients: #{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] 
+ **amount_from** | **String**| Minimum amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
+ **amount_to** | **String**| Max amount to filter recipients by amount range.  Allows filtering results by the specified &#x60;amount&#x60; range. When using this filter, the &#x60;currency&#x60; should also be specified.  Example: &#x60;/v1/recipients?currency&#x3D;NGN&amp;amount_from&#x3D;83.76672339&amp;amount_to&#x3D;83.76672339&#x60; | [optional] 
+ **state** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;state&#x60; of recipient. See [API Documentation - Recipient state](https://github.com/transferzero/api-documentation/blob/master/transaction-flow.md#state-1) for possible states.  Example: &#x60;/v1/recipients?state[]&#x3D;error&amp;state[]&#x3D;initial&#x60; | [optional] 
+ **currency** | [**Array&lt;String&gt;**](String.md)| Allows filtering results by &#x60;input_currency&#x60;.  Additionally required when filtering by an amount range Example: &#x60;/v1/recipients?currency[]&#x3D;KES&amp;currency[]&#x3D;NGN&#x60; | [optional] 
+
+### Return type
+
+[**RecipientListResponse**](RecipientListResponse.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
+
+
+
+# **patch_recipient**
+> RecipientResponse patch_recipient(recipient_idrecipient_request)
+
+Updating a recipient
+
+Updates the recipient specified in the URL path.  Please note that only recipients where the `editable` field is true can be modified. Once the recipient is modified any subsequent payout tries will be sent to the updated details.
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::RecipientsApi.new
+
+
+begin
+  #Updating a recipient
+  result = api_instance.patch_recipient(recipient_idrecipient_request)
+  p result
+rescue TransferZero::ApiError => e
+  if e.validation_error
+    puts "WARN: Validation error occured when calling the endpoint"
+    result = e.response_object("RecipientResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->patch_recipient: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of recipient to update.  Example: &#x60;/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33&#x60; | 
+ **recipient_request** | [**RecipientRequest**](RecipientRequest.md)|  | 
+
+### Return type
+
+[**RecipientResponse**](RecipientResponse.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**: application/json
+ - **Accept**: application/json
+
+
+

data/docs/Sender.md

@@ -0,0 +1,67 @@
+# TransferZero::Sender
+
+## 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<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\"   } ] ``` | 
+**metadata** | [**Object**](.md) | 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] 
+**state** | [**SenderState**](SenderState.md) |  | [optional] 
+**id** | **String** |  | [optional] 
+**external_id** | **String** | Optional ID that is supplied by partner linking it to the partner's own Sender ID. Note: if present we will validate whether the sent ID is a duplicate in our system or not. | [optional] 
+**errors** | **Hash<String, Array<ValidationErrorDescription>>** | The fields that have some problems and don't pass validation | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::Sender.new(type: person,
+                                 country: NG,
+                                 phone_country: NG,
+                                 phone_number: 752403639,
+                                 email: example@home.org,
+                                 first_name: Johnny,
+                                 middle_name: Johnny,
+                                 last_name: English,
+                                 occupation: Accountant,
+                                 nationality: NG,
+                                 onboarding_status: null,
+                                 address: null,
+                                 description: null,
+                                 name: null,
+                                 city: Kampala,
+                                 street: Fake Street,
+                                 address_description: null,
+                                 postal_code: 798983,
+                                 birth_date: null,
+                                 ip: 127.0.0.1,
+                                 documents: [{"id":"b6648ba3-1c7b-4f59-8580-684899c84a07"}],
+                                 metadata: {},
+                                 state: null,
+                                 id: bf9ff782-e182-45ac-abea-5bce83ad6670,
+                                 external_id: 806ec63a-a5a7-43cc-9d75-1ee74fbcc026,
+                                 errors: {"phone_number":[{"error":"invalid"}],"documents":[{"error":"blank"}]})
+```
+
+

data/docs/SenderListResponse.md

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