transferzero-sdk 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65abf7df38463761e657c72743e2d3906ca55b9933ecb0fec06e0213bc965efe
-  data.tar.gz: 71e6bfa8a8ec907e24f2abec488fea17a54512b7d74bd4aac6e10af62d5f985c
+  metadata.gz: c4a72e7a74c3d604cad3367f8f255719bedcb3333f4f41ba40be5eb6a1c8d7ad
+  data.tar.gz: 809532b1efe02d86a2fdac1f09f9f35d56c0895a807c5f5f18fd36d93f0cacf7
 SHA512:
-  metadata.gz: 1d14e138f2cfb1ebebdc156ca10c845f8586ec1784b5b80beef15fe8a7e0b9921dc0b46fcf3072e201e01bd6a1f82d9bfc1a329c82847cd86f3c2c90002d5c94
-  data.tar.gz: a06e60260498ef33c734de0023286ed7363a2c0af064526aef9f92fdfaf83b2bd0c11ed3186e47c572f83675e0d1a8bc5b645e1b4601f22dfe565a890b034a6d
+  metadata.gz: '0078963697208ef7df9e73fec33e087daeb64aa58c3ef709bc1b5c39a1412024053f309778ea8f1c9757d8428f076fc068f25c9e5bf46204b2e4f6918cb35f10'
+  data.tar.gz: 4fbe577cf10a4a77cc27329e44847365d6bd8fe5320dd3b6b70790400c7859f8243ab2241af7cf6c135ee2205ea7b8a0331355ca62417a0c3adb5788f966a58b

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    transferzero-sdk (1.9.0)
+      activesupport (>= 4)
+      json (>= 1.4)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.12.0)
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.17)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.7)
+    crack (0.4.4)
+    diff-lcs (1.4.4)
+    ethon (0.12.0)
+      ffi (>= 1.3.0)
+    ffi (1.13.1)
+    hashdiff (1.0.1)
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    json (2.3.1)
+    method_source (1.0.0)
+    minitest (5.14.2)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.6)
+    rake (12.0.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    sys-uname (1.2.2)
+      ffi (~> 1.1)
+    thread_safe (0.3.6)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ZenTest (~> 4.11, >= 4.11.2)
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  transferzero-sdk!
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -7,7 +7,7 @@ Reference documentation for the TransferZero API V1
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0
-- Package version: 1.9.0
+- Package version: 1.10.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 For more information, please visit:
@@ -31,15 +31,15 @@ gem build transferzero-sdk.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./transferzero-sdk-1.9.0.gem
+gem install ./transferzero-sdk-1.10.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.9.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.10.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'transferzero-sdk', '~> 1.9.0'
+    gem 'transferzero-sdk', '~> 1.10.0'
 
 ### Install from Git
 
@@ -130,6 +130,7 @@ Class | Method | HTTP request | Description
 *TransferZero::RecipientsApi* | [**delete_recipient**](docs/RecipientsApi.md#delete_recipient) | **DELETE** /recipients/{Recipient ID} | Cancelling a recipient
 *TransferZero::RecipientsApi* | [**get_recipients**](docs/RecipientsApi.md#get_recipients) | **GET** /recipients | Getting a list of recipients with filtering
 *TransferZero::RecipientsApi* | [**patch_recipient**](docs/RecipientsApi.md#patch_recipient) | **PATCH** /recipients/{Recipient ID} | Updating a recipient
+*TransferZero::RecipientsApi* | [**proof_of_payments**](docs/RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
 *TransferZero::SendersApi* | [**delete_sender**](docs/SendersApi.md#delete_sender) | **DELETE** /senders/{Sender ID} | Deleting a sender
 *TransferZero::SendersApi* | [**get_sender**](docs/SendersApi.md#get_sender) | **GET** /senders/{Sender ID} | Fetching a sender
 *TransferZero::SendersApi* | [**get_senders**](docs/SendersApi.md#get_senders) | **GET** /senders | Listing senders
@@ -196,6 +197,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PaymentMethodOpposite](docs/PaymentMethodOpposite.md)
  - [TransferZero::PayoutMethod](docs/PayoutMethod.md)
  - [TransferZero::PayoutMethodBankAccountTypeEnum](docs/PayoutMethodBankAccountTypeEnum.md)
+ - [TransferZero::PayoutMethodCashProviderEnum](docs/PayoutMethodCashProviderEnum.md)
  - [TransferZero::PayoutMethodDetails](docs/PayoutMethodDetails.md)
  - [TransferZero::PayoutMethodDetailsBTC](docs/PayoutMethodDetailsBTC.md)
  - [TransferZero::PayoutMethodDetailsBalance](docs/PayoutMethodDetailsBalance.md)
@@ -206,6 +208,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodDetailsMobile](docs/PayoutMethodDetailsMobile.md)
  - [TransferZero::PayoutMethodDetailsNGNBank](docs/PayoutMethodDetailsNGNBank.md)
  - [TransferZero::PayoutMethodDetailsXOFBank](docs/PayoutMethodDetailsXOFBank.md)
+ - [TransferZero::PayoutMethodDetailsXOFCash](docs/PayoutMethodDetailsXOFCash.md)
  - [TransferZero::PayoutMethodDetailsXOFMobile](docs/PayoutMethodDetailsXOFMobile.md)
  - [TransferZero::PayoutMethodDetailsZARBank](docs/PayoutMethodDetailsZARBank.md)
  - [TransferZero::PayoutMethodGenderEnum](docs/PayoutMethodGenderEnum.md)
@@ -216,11 +219,14 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodWebhook](docs/PayoutMethodWebhook.md)
  - [TransferZero::PoliticallyExposedPerson](docs/PoliticallyExposedPerson.md)
+ - [TransferZero::ProofOfPayment](docs/ProofOfPayment.md)
+ - [TransferZero::ProofOfPaymentListResponse](docs/ProofOfPaymentListResponse.md)
  - [TransferZero::Recipient](docs/Recipient.md)
  - [TransferZero::RecipientListResponse](docs/RecipientListResponse.md)
  - [TransferZero::RecipientRequest](docs/RecipientRequest.md)
  - [TransferZero::RecipientResponse](docs/RecipientResponse.md)
  - [TransferZero::RecipientState](docs/RecipientState.md)
+ - [TransferZero::RecipientStateReasonDetails](docs/RecipientStateReasonDetails.md)
  - [TransferZero::RecipientWebhook](docs/RecipientWebhook.md)
  - [TransferZero::Sender](docs/Sender.md)
  - [TransferZero::SenderListResponse](docs/SenderListResponse.md)

data/docs/PayoutMethodCashProviderEnum.md

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

data/docs/PayoutMethodDetails.md

@@ -14,6 +14,9 @@ Name | Type | Description | Notes
 **iban** | **String** |  | 
 **bank_name** | **String** |  | 
 **bank_country** | **String** |  | 
+**identity_card_id** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
 **sort_code** | **String** |  | [optional] 
 **bic** | **String** |  | [optional] 
 **sender_identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
@@ -22,8 +25,6 @@ Name | Type | Description | Notes
 **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] 
 **name** | **String** |  | 
 **address** | **String** |  | 
@@ -48,6 +49,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  iban: null,
                                  bank_name: null,
                                  bank_country: null,
+                                 identity_card_id: null,
+                                 identity_card_type: null,
+                                 cash_provider: null,
                                  sort_code: null,
                                  bic: null,
                                  sender_identity_card_type: null,
@@ -56,8 +60,6 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  sender_country_of_birth: null,
                                  sender_gender: null,
                                  reason: null,
-                                 identity_card_type: null,
-                                 identity_card_id: null,
                                  reference: null,
                                  name: null,
                                  address: null,

data/docs/PayoutMethodDetailsXOFCash.md

@@ -0,0 +1,27 @@
+# TransferZero::PayoutMethodDetailsXOFCash
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**identity_card_id** | **String** |  | [optional] 
+**identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | [optional] 
+**phone_number** | **String** |  | 
+**cash_provider** | [**PayoutMethodCashProviderEnum**](PayoutMethodCashProviderEnum.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsXOFCash.new(first_name: null,
+                                 last_name: null,
+                                 identity_card_id: null,
+                                 identity_card_type: null,
+                                 phone_number: null,
+                                 cash_provider: null)
+```
+
+

data/docs/ProofOfPayment.md

@@ -0,0 +1,23 @@
+# TransferZero::ProofOfPayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | UUID of the uploaded document | [optional] 
+**file_name** | **String** | Name of the uploaded file | [optional] 
+**thumbnail** | **String** | URL to thumbnail image of the uploaded file | [optional] 
+**url** | **String** | URL to uploaded file | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::ProofOfPayment.new(id: null,
+                                 file_name: my_file.jpg,
+                                 thumbnail: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file_thumb.jpg,
+                                 url: https://bitpesa-development.s3.eu-west-1.amazonaws.com/my_file.jpg)
+```
+
+

data/docs/ProofOfPaymentListResponse.md

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

data/docs/Recipient.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **input_usd_amount** | **Float** | Shows how much this payment is worth in USD | [optional] 
 **may_cancel** | **Boolean** | If true it shows that the payment can be cancelled immediately using the DELETE /v1/recipients/{id} endpoint. If false you can still try to cancel it, however it will only gets cancelled once we have confirmation from our partner that the payment has failed. | [optional] 
 **state_reason** | **String** | In case the payment is unsuccessful it holds the error message associated with the last unsuccessful payout. | [optional] 
+**state_reason_details** | [**RecipientStateReasonDetails**](RecipientStateReasonDetails.md) |  | [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] 
@@ -41,6 +42,7 @@ instance = TransferZero::Recipient.new(requested_amount: 750.0,
                                  input_usd_amount: 10,
                                  may_cancel: true,
                                  state_reason: null,
+                                 state_reason_details: null,
                                  state: null,
                                  transaction_id: 97e79719-06e4-4794-aeeb-d2d9415d983a,
                                  transaction_state: null,

data/docs/RecipientStateReasonDetails.md

@@ -0,0 +1,23 @@
+# TransferZero::RecipientStateReasonDetails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**code** | **String** | Status code of failed transaction | [optional] 
+**category** | **String** | Main category of error, it could be paid, unknown, pickupable, temporary_error, recipient_error, sender_error | [optional] 
+**messages** | **Array<String>** | Tiered messages | [optional] 
+**description** | **String** | Public, human readable, detailed error message | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::RecipientStateReasonDetails.new(code: 311,
+                                 category: temporary_error,
+                                 messages: ["Temporary error","Switch Error","Issuer/Switch inoperative"],
+                                 description: The central switch is not accepting transfers at the moment. We will retry the transaction. You can also edit or cancel this transaction.)
+```
+
+

data/docs/RecipientsApi.md

@@ -7,6 +7,7 @@ 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
+[**proof_of_payments**](RecipientsApi.md#proof_of_payments) | **GET** /recipients/{Recipient ID}/proof_of_payments | Returns list of proof of payments
 
 
 # **delete_recipient**
@@ -210,3 +211,64 @@ end
 
 
 
+# **proof_of_payments**
+> ProofOfPaymentListResponse proof_of_payments(recipient_id)
+
+Returns list of proof of payments
+
+Returns a list of uploaded proof of payment files for a transaction recipient
+
+### Example
+```ruby
+# load the gem
+require 'transferzero-sdk'
+
+api_instance = TransferZero::RecipientsApi.new
+
+
+begin
+  #Returns list of proof of payments
+  result = api_instance.proof_of_payments(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("ProofOfPaymentListResponse")
+    p result
+  else
+    puts "Exception when calling RecipientsApi->proof_of_payments: #{e}"
+  end
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **recipient_id** | [**String**](.md)| ID of the recipient for whom the proof of payments will be returned.  Example: `/v1/recipients/9d4d7b73-a94c-4979-ab57-09074fd55d33/proof_of_payments` | 
+
+### Return type
+
+[**ProofOfPaymentListResponse**](ProofOfPaymentListResponse.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/Sender.md

@@ -18,6 +18,7 @@ Name | Type | Description | Notes
 **address_description** | **String** | Description of address | [optional] 
 **identification_number** | **String** | Identification number of document used | [optional] 
 **identification_type** | **String** | Document to be identified. The identification type can be one of the following:  - `DL`: Driving License - `PP`: International Passport - `ID`: National ID - `OT`: Other | [optional] 
+**lang** | **String** | Determines language of the served content. Defaults to English | [optional] 
 **name** | **String** | Name of sender (used only with a Business sender) | [optional] 
 **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] 
@@ -72,6 +73,7 @@ instance = TransferZero::Sender.new(id: bf9ff782-e182-45ac-abea-5bce83ad6670,
                                  address_description: null,
                                  identification_number: AB123456,
                                  identification_type: ID,
+                                 lang: en,
                                  name: null,
                                  first_name: Johnny,
                                  middle_name: Johnny,

data/lib/transferzero-sdk.rb

@@ -61,6 +61,7 @@ require 'transferzero-sdk/models/payment_method_list_response'
 require 'transferzero-sdk/models/payment_method_opposite'
 require 'transferzero-sdk/models/payout_method'
 require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
+require 'transferzero-sdk/models/payout_method_cash_provider_enum'
 require 'transferzero-sdk/models/payout_method_details'
 require 'transferzero-sdk/models/payout_method_details_btc'
 require 'transferzero-sdk/models/payout_method_details_balance'
@@ -71,6 +72,7 @@ require 'transferzero-sdk/models/payout_method_details_mad_cash'
 require 'transferzero-sdk/models/payout_method_details_mobile'
 require 'transferzero-sdk/models/payout_method_details_ngn_bank'
 require 'transferzero-sdk/models/payout_method_details_xof_bank'
+require 'transferzero-sdk/models/payout_method_details_xof_cash'
 require 'transferzero-sdk/models/payout_method_details_xof_mobile'
 require 'transferzero-sdk/models/payout_method_details_zar_bank'
 require 'transferzero-sdk/models/payout_method_gender_enum'
@@ -81,11 +83,14 @@ require 'transferzero-sdk/models/payout_method_request'
 require 'transferzero-sdk/models/payout_method_response'
 require 'transferzero-sdk/models/payout_method_webhook'
 require 'transferzero-sdk/models/politically_exposed_person'
+require 'transferzero-sdk/models/proof_of_payment'
+require 'transferzero-sdk/models/proof_of_payment_list_response'
 require 'transferzero-sdk/models/recipient'
 require 'transferzero-sdk/models/recipient_list_response'
 require 'transferzero-sdk/models/recipient_request'
 require 'transferzero-sdk/models/recipient_response'
 require 'transferzero-sdk/models/recipient_state'
+require 'transferzero-sdk/models/recipient_state_reason_details'
 require 'transferzero-sdk/models/recipient_webhook'
 require 'transferzero-sdk/models/sender'
 require 'transferzero-sdk/models/sender_list_response'