transferzero-sdk 1.6.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d5893020d507b8a392d04e04d4dc4af5098e459d430d89f253245e70cdc188
-  data.tar.gz: 7dbbcaa2a8eff3d52bd2d2fcadcd93e3bd9adf42a75be0846009457e81ec31ca
+  metadata.gz: c4a72e7a74c3d604cad3367f8f255719bedcb3333f4f41ba40be5eb6a1c8d7ad
+  data.tar.gz: 809532b1efe02d86a2fdac1f09f9f35d56c0895a807c5f5f18fd36d93f0cacf7
 SHA512:
-  metadata.gz: 576a248ecae25fef80bc23b7e5fb61d3a68116ababe69751041870371a9cb89e4e7703ef6c9a3b79989c83eabcc18889f68c0ddd8f3ef26d3615beb5cba33bf9
-  data.tar.gz: 5a0d7d0381cf92e9928c9715a19d19bdad73e773c7af978e268143f0ad3e478005c20787aad199cd0719f6edcc4ea4a0d91053929df10e5312ba2d5b11f6e0b1
+  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.6.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.6.0.gem
+gem install ./transferzero-sdk-1.10.0.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.6.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.6.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,16 +197,20 @@ 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)
+ - [TransferZero::PayoutMethodDetailsGBPBank](docs/PayoutMethodDetailsGBPBank.md)
  - [TransferZero::PayoutMethodDetailsGHSBank](docs/PayoutMethodDetailsGHSBank.md)
  - [TransferZero::PayoutMethodDetailsIBAN](docs/PayoutMethodDetailsIBAN.md)
  - [TransferZero::PayoutMethodDetailsMADCash](docs/PayoutMethodDetailsMADCash.md)
  - [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)
  - [TransferZero::PayoutMethodIdentityCardTypeEnum](docs/PayoutMethodIdentityCardTypeEnum.md)
  - [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
@@ -214,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/Currency.md

@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 
 ## Code Sample
@@ -28,7 +27,6 @@ instance = TransferZero::Currency.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null)
 ```
 

data/docs/CurrencyExchange.md

@@ -12,7 +12,6 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 **opposites** | [**Array<CurrencyOpposite>**](CurrencyOpposite.md) | Lists the currencies where you can exchange from this one | [optional] 
 
@@ -29,7 +28,6 @@ instance = TransferZero::CurrencyExchange.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null,
                                  opposites: null)
 ```

data/docs/CurrencyOpposite.md

@@ -12,10 +12,10 @@ Name | Type | Description | Notes
 **primary** | **Boolean** | Is this a primary currency? | [optional] 
 **min** | **String** | The minimum amount allowed in a transaction | [optional] 
 **max** | **String** | The maximum amount allowed in a transaction | [optional] 
-**margin** | **String** | The margin set for transactions in this currency | [optional] 
 **usd_equivalent** | **String** | The equivalent of the currency to 1 USD | [optional] 
 **rate** | **Float** | The rate of this particular currency with the base one | [optional] 
 **mtm_rate** | **Float** | Mark to market rate of this particular currency against the base one with the margin factored in | [optional] 
+**margin** | **String** | The margin set for transactions of this particular currency with the base one | [optional] 
 
 ## Code Sample
 
@@ -30,10 +30,10 @@ instance = TransferZero::CurrencyOpposite.new(code: NGN,
                                  primary: true,
                                  min: 100,
                                  max: 50000000,
-                                 margin: null,
                                  usd_equivalent: null,
                                  rate: null,
-                                 mtm_rate: null)
+                                 mtm_rate: null,
+                                 margin: null)
 ```
 
 

data/docs/Document.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **upload** | **String** | Base64 encoded data uri of an image/pdf file or a fully qualified url | 
+**url** | **String** | URL of the document location | [optional] 
 **upload_file_name** | **String** | Name of the upload | 
 **metadata** | [**Object**](.md) | Metadata of document | [optional] 
 **upload_content_type** | **String** |  | [optional] 
@@ -22,6 +23,7 @@ Name | Type | Description | Notes
 require 'TransferZero'
 
 instance = TransferZero::Document.new(upload: data:image/png;base64,iVBORw0KGg...lFTkSuQmCC,
+                                 url: https://bitpesa-documents.amazonaws.com/document.pdf,
                                  upload_file_name: example.png,
                                  metadata: {},
                                  upload_content_type: image/png,

data/docs/PayoutMethod.md

@@ -4,7 +4,7 @@
 
 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. - `XOF::Bank` - for Senegalese bank account payments. *** Currently in Beta phase *** - `XOF::Cash` - for Senegalese cash remittance 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://docs.transferzero.com/docs/additional-features/#collections-from-senders) for more info on how to collect money into internal balance  | [optional] 
+**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. - `XOF::Bank` - for Senegalese bank account payments. - `XOF::Cash` - for Senegalese cash remittance payments. - `MAD::Cash` - for Moroccan cash remittance payments. - `EUR::Bank` - for IBAN bank transfers in EUR. - `GBP::Bank` - for IBAN bank and FP accounts transfers in GBP. - `ZAR::Bank` - for South Africa bank account payments.  You can also send funds to the internal balance using `CCY::Balance`, where `CCY` is the appropriate currency. See [Collection from senders](https://docs.transferzero.com/docs/additional-features/#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] 

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,10 @@ 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) |  | 
 **sender_identity_card_id** | **String** |  | 
@@ -21,11 +25,14 @@ 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** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**transfer_reason_code** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -42,6 +49,10 @@ 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,
                                  sender_identity_card_id: null,
@@ -49,11 +60,14 @@ 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)
+                                 address: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 transfer_reason_code: null)
 ```
 
 

data/docs/PayoutMethodDetailsGBPBank.md

@@ -0,0 +1,29 @@
+# TransferZero::PayoutMethodDetailsGBPBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
+**bank_account** | **String** |  | [optional] 
+**sort_code** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**bic** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsGBPBank.new(first_name: null,
+                                 last_name: null,
+                                 bank_name: null,
+                                 bank_account: null,
+                                 sort_code: null,
+                                 iban: null,
+                                 bic: null)
+```
+
+

data/docs/PayoutMethodDetailsIBAN.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
-**bank_name** | **String** |  | 
+**bank_name** | **String** |  | [optional] 
 **iban** | **String** |  | 
 **bic** | **String** |  | [optional] 
 

data/docs/PayoutMethodDetailsMobile.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | 
+**mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'TransferZero'
 
 instance = TransferZero::PayoutMethodDetailsMobile.new(first_name: null,
                                  last_name: null,
-                                 phone_number: null)
+                                 phone_number: null,
+                                 mobile_provider: 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/PayoutMethodDetailsZARBank.md

@@ -0,0 +1,35 @@
+# TransferZero::PayoutMethodDetailsZARBank
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+**street** | **String** |  | 
+**postal_code** | **String** |  | 
+**city** | **String** |  | 
+**email** | **String** |  | [optional] 
+**bank_code** | **String** |  | 
+**bank_account** | **String** |  | 
+**phone_number** | **String** |  | 
+**transfer_reason_code** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'TransferZero'
+
+instance = TransferZero::PayoutMethodDetailsZARBank.new(first_name: null,
+                                 last_name: null,
+                                 street: null,
+                                 postal_code: null,
+                                 city: null,
+                                 email: null,
+                                 bank_code: null,
+                                 bank_account: null,
+                                 phone_number: null,
+                                 transfer_reason_code: null)
+```
+
+