transferzero-sdk 1.23.3 → 1.23.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8b16341760775c846e90177ddb2b389ac125b077e42a28821f8c2dbb3c92554f
-  data.tar.gz: 178bc1e86f4d7cf410ad8a0cd86b719513abe28d4e8f158f7de520c813df2fa5
+  metadata.gz: 371671ea6f73262096beb1b8357f2923179a76c8c2a71ce68529ec57aa3fc2bd
+  data.tar.gz: 2c51ec76ac620606182ec4df940e750be3df07b29f8bca373b7dcfa65820ef59
 SHA512:
-  metadata.gz: a595fcfe1fe8bfa61955d84dce5fc890f640e153817b6b2c19e06cb85479add01d0d77ebf9a59b98922cdba01c574c2a55e1066226a13a3aabb7ecd3c3da6176
-  data.tar.gz: 7ef163c7f63c75d478effda86c60ee8f15c5ae4aab27e85622d66b04c7c16e6d0b14d5091aec089307be7073c80ce57611cd69a3597942f0c31df4b327247218
+  metadata.gz: ff558d11ac7d0ca020a38e5e96a6bc7b3286c369871b70f7103b5c457890c8da051c42cf1c1bbdc57d2b658f1326597333797c90582c7f0f45021f9eba6e7b3c
+  data.tar.gz: d948b5633191d8bb7a7478f21a5a2659e6c1a254a62a32e7b2dbd64a07d781d6e32592384dec5be26f81a7d07760f6cc7501c2b404ae11beb7212bdcff94c41d

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.23.3
+- Package version: 1.23.5
 - 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.23.3.gem
+gem install ./transferzero-sdk-1.23.5.gem
 ```
-(for development, run `gem install --dev ./transferzero-sdk-1.23.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./transferzero-sdk-1.23.5.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.23.3'
+    gem 'transferzero-sdk', '~> 1.23.5'
 
 ### Install from Git
 
@@ -234,6 +234,7 @@ Class | Method | HTTP request | Description
  - [TransferZero::PayoutMethodListResponse](docs/PayoutMethodListResponse.md)
  - [TransferZero::PayoutMethodMobileProviderEnum](docs/PayoutMethodMobileProviderEnum.md)
  - [TransferZero::PayoutMethodNatureOfBusinessEnum](docs/PayoutMethodNatureOfBusinessEnum.md)
+ - [TransferZero::PayoutMethodPixKeyTypeEnum](docs/PayoutMethodPixKeyTypeEnum.md)
  - [TransferZero::PayoutMethodRequest](docs/PayoutMethodRequest.md)
  - [TransferZero::PayoutMethodResponse](docs/PayoutMethodResponse.md)
  - [TransferZero::PayoutMethodTransferReasonEnum](docs/PayoutMethodTransferReasonEnum.md)

data/docs/AccountValidationRequest.md

@@ -7,7 +7,7 @@ Name | Type | Description | Notes
 **bank_account** | **String** | Account Number to query | [optional] 
 **bank_code** | **String** | Bank Code to query - same codes are used as for creating the transactions | [optional] 
 **iban** | **String** | IBAN to query - BBAN format for XOF bank accounts | [optional] 
-**phone_number** | **String** | Phone number to query | [optional] 
+**phone_number** | **String** | Phone number to query in E.164 format | [optional] 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | [optional] 
 **country** | **String** | Country of account in 2-character alpha ISO 3166-2 country format | 
 **currency** | **String** | The currency the bank account is in | 

data/docs/PayinMethodDetails.md

@@ -19,7 +19,7 @@ require 'TransferZero'
 
 instance = TransferZero::PayinMethodDetails.new(payment_method: null,
                                  redirect_url: null,
-                                 phone_number: +2569999999,
+                                 phone_number: +256129999999,
                                  mobile_provider: null,
                                  country: null,
                                  otp: null,

data/docs/PayinMethodDetailsMobile.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'TransferZero'
 
-instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +2569999999,
+instance = TransferZero::PayinMethodDetailsMobile.new(phone_number: +256129999999,
                                  mobile_provider: null,
                                  country: null,
                                  otp: null)

data/docs/PayoutMethodDetails.md

@@ -8,7 +8,7 @@ Name | Type | Description | Notes
 **last_name** | **String** |  | 
 **bank_code** | **String** |  | 
 **bank_account** | **String** |  | 
-**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | [optional] 
 **phone_number** | **String** |  | 
 **mobile_provider** | [**PayoutMethodMobileProviderEnum**](PayoutMethodMobileProviderEnum.md) |  | 
 **country** | [**PayoutMethodCountryEnum**](PayoutMethodCountryEnum.md) |  | 
@@ -40,8 +40,10 @@ Name | Type | Description | Notes
 **registration_number** | **String** |  | [optional] 
 **nature_of_business** | [**PayoutMethodNatureOfBusinessEnum**](PayoutMethodNatureOfBusinessEnum.md) |  | [optional] 
 **legal_entity_type** | [**PayoutMethodLegalEntityTypeEnum**](PayoutMethodLegalEntityTypeEnum.md) |  | [optional] 
-**branch_code** | **String** |  | 
+**branch_code** | **String** |  | [optional] 
 **swift_code** | **String** |  | 
+**pix_key_type** | [**PayoutMethodPixKeyTypeEnum**](PayoutMethodPixKeyTypeEnum.md) |  | [optional] 
+**pix_key_value** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -85,7 +87,9 @@ instance = TransferZero::PayoutMethodDetails.new(first_name: null,
                                  nature_of_business: null,
                                  legal_entity_type: null,
                                  branch_code: null,
-                                 swift_code: null)
+                                 swift_code: null,
+                                 pix_key_type: null,
+                                 pix_key_value: null)
 ```
 
 

data/docs/PayoutMethodDetailsBRLBank.md

@@ -7,10 +7,12 @@ Name | Type | Description | Notes
 **first_name** | **String** |  | 
 **last_name** | **String** |  | 
 **phone_number** | **String** |  | [optional] 
-**bank_code** | **String** |  | 
-**branch_code** | **String** |  | 
-**bank_account** | **String** |  | 
-**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | 
+**bank_code** | **String** |  | [optional] 
+**branch_code** | **String** |  | [optional] 
+**bank_account** | **String** |  | [optional] 
+**bank_account_type** | [**PayoutMethodBankAccountTypeEnum**](PayoutMethodBankAccountTypeEnum.md) |  | [optional] 
+**pix_key_type** | [**PayoutMethodPixKeyTypeEnum**](PayoutMethodPixKeyTypeEnum.md) |  | [optional] 
+**pix_key_value** | **String** |  | [optional] 
 **identity_card_type** | [**PayoutMethodIdentityCardTypeEnum**](PayoutMethodIdentityCardTypeEnum.md) |  | 
 **identity_card_id** | **String** |  | 
 **transfer_reason** | [**PayoutMethodTransferReasonEnum**](PayoutMethodTransferReasonEnum.md) |  | 
@@ -27,6 +29,8 @@ instance = TransferZero::PayoutMethodDetailsBRLBank.new(first_name: null,
                                  branch_code: null,
                                  bank_account: null,
                                  bank_account_type: null,
+                                 pix_key_type: null,
+                                 pix_key_value: null,
                                  identity_card_type: null,
                                  identity_card_id: null,
                                  transfer_reason: null)

data/docs/PayoutMethodPixKeyTypeEnum.md

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

data/docs/Sender.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **street** | **String** | Sender's street | 
 **postal_code** | **String** | Zip code of sender | 
 **city** | **String** | Sender's city | 
-**phone_country** | **String** | Phone 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 | [optional] 
 **phone_number** | **String** | Phone number of sender (without country callcode) | [optional] 
 **email** | **String** | Email of sender | 
 **ip** | **String** | IP of sender | 

data/lib/transferzero-sdk/api_client.rb

@@ -36,7 +36,7 @@ module TransferZero
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "TransferZero-SDK/Ruby/1.23.3"
+      @user_agent = "TransferZero-SDK/Ruby/1.23.5"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/transferzero-sdk/models/account_validation_request.rb

@@ -23,7 +23,7 @@ class AccountValidationRequest
   # IBAN to query - BBAN format for XOF bank accounts
   attr_accessor :iban
 
-  # Phone number to query
+  # Phone number to query in E.164 format
   attr_accessor :phone_number
 
   attr_accessor :mobile_provider

data/lib/transferzero-sdk/models/payin_method_details_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"phone_number\": \"+2569999999\", } ```
+# ```JSON \"details\": {   \"phone_number\": \"+256129999999\", } ```
 class PayinMethodDetailsMobile
   # The phone number where the funds should be collected from
   attr_accessor :phone_number

data/lib/transferzero-sdk/models/payout_method_details.rb

@@ -90,6 +90,10 @@ class PayoutMethodDetails
 
   attr_accessor :swift_code
 
+  attr_accessor :pix_key_type
+
+  attr_accessor :pix_key_value
+
   # Attribute mapping from ruby-style variable name to JSON key.
   def self.attribute_map
     {
@@ -130,7 +134,9 @@ class PayoutMethodDetails
       :'nature_of_business' => :'nature_of_business',
       :'legal_entity_type' => :'legal_entity_type',
       :'branch_code' => :'branch_code',
-      :'swift_code' => :'swift_code'
+      :'swift_code' => :'swift_code',
+      :'pix_key_type' => :'pix_key_type',
+      :'pix_key_value' => :'pix_key_value'
     }
   end
 
@@ -174,7 +180,9 @@ class PayoutMethodDetails
       :'nature_of_business' => :'PayoutMethodNatureOfBusinessEnum',
       :'legal_entity_type' => :'PayoutMethodLegalEntityTypeEnum',
       :'branch_code' => :'String',
-      :'swift_code' => :'String'
+      :'swift_code' => :'String',
+      :'pix_key_type' => :'PayoutMethodPixKeyTypeEnum',
+      :'pix_key_value' => :'String'
     }
   end
 
@@ -371,6 +379,14 @@ class PayoutMethodDetails
     if attributes.key?(:'swift_code')
       self.swift_code = attributes[:'swift_code']
     end
+
+    if attributes.key?(:'pix_key_type')
+      self.pix_key_type = attributes[:'pix_key_type']
+    end
+
+    if attributes.key?(:'pix_key_value')
+      self.pix_key_value = attributes[:'pix_key_value']
+    end
   end
 
   # Show invalid properties with the reasons. Usually used together with valid?
@@ -393,10 +409,6 @@ class PayoutMethodDetails
       invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.')
     end
 
-    if @bank_account_type.nil?
-      invalid_properties.push('invalid value for "bank_account_type", bank_account_type cannot be nil.')
-    end
-
     if @phone_number.nil?
       invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
     end
@@ -461,10 +473,6 @@ class PayoutMethodDetails
       invalid_properties.push('invalid value for "city", city cannot be nil.')
     end
 
-    if @branch_code.nil?
-      invalid_properties.push('invalid value for "branch_code", branch_code cannot be nil.')
-    end
-
     if @swift_code.nil?
       invalid_properties.push('invalid value for "swift_code", swift_code cannot be nil.')
     end
@@ -479,7 +487,6 @@ class PayoutMethodDetails
     return false if @last_name.nil?
     return false if @bank_code.nil?
     return false if @bank_account.nil?
-    return false if @bank_account_type.nil?
     return false if @phone_number.nil?
     return false if @mobile_provider.nil?
     return false if @country.nil?
@@ -496,7 +503,6 @@ class PayoutMethodDetails
     return false if @street.nil?
     return false if @postal_code.nil?
     return false if @city.nil?
-    return false if @branch_code.nil?
     return false if @swift_code.nil?
     _one_of_found = false
     openapi_one_of.each do |_class|
@@ -559,7 +565,9 @@ class PayoutMethodDetails
         nature_of_business == o.nature_of_business &&
         legal_entity_type == o.legal_entity_type &&
         branch_code == o.branch_code &&
-        swift_code == o.swift_code
+        swift_code == o.swift_code &&
+        pix_key_type == o.pix_key_type &&
+        pix_key_value == o.pix_key_value
   end
 
   # @see the `==` method
@@ -571,7 +579,7 @@ class PayoutMethodDetails
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, country, transfer_reason, iban, bank_name, bank_country, cash_provider, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference, name, address, street, postal_code, city, email, transfer_reason_code, contact_first_name, contact_last_name, registration_number, nature_of_business, legal_entity_type, branch_code, swift_code].hash
+    [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, country, transfer_reason, iban, bank_name, bank_country, cash_provider, sort_code, bic, sender_identity_card_type, sender_identity_card_id, sender_city_of_birth, sender_country_of_birth, sender_gender, reason, identity_card_type, identity_card_id, reference, name, address, street, postal_code, city, email, transfer_reason_code, contact_first_name, contact_last_name, registration_number, nature_of_business, legal_entity_type, branch_code, swift_code, pix_key_type, pix_key_value].hash
   end
 
 require 'active_support/core_ext/hash'

data/lib/transferzero-sdk/models/payout_method_details_brl_bank.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON   \"details\": {     \"first_name\": \"First\",     \"last_name\": \"Last\",     \"phone_number\": \"+552112345678\",     \"bank_code\": \"104\",     \"branch_code\": \"00001\",     \"bank_account\": \"0009795493\",     \"bank_account_type\": \"10\",     \"identity_card_type\": \"ID\",     \"identity_card_id\": \"01234567890\",     \"transfer_reason\": \"personal_account\"   } ```  See [BRL Bank](https://docs.transferzero.com/docs/payout-details/#brlbank) documentation for the bank_code and transfer_reason lists
+# PIX Payment: ```JSON   \"details\": {     \"first_name\": \"First\",     \"last_name\": \"Last\",     \"phone_number\": \"+552112345678\", // E.164 international format     \"pix_key_type\": \"email\",     \"pix_key_value\": \"person@example.com\",     \"identity_card_type\": \"ID\",     \"identity_card_id\": \"01234567890\",     \"transfer_reason\": \"personal_account\"   } ```  TED Payment: ```JSON   \"details\": {     \"first_name\": \"First\",     \"last_name\": \"Last\",     \"phone_number\": \"+552112345678\", // E.164 international format     \"bank_code\": \"104\",     \"branch_code\": \"00001\",     \"bank_account\": \"0009795493\",     \"bank_account_type\": \"10\",     \"identity_card_type\": \"ID\",     \"identity_card_id\": \"01234567890\",     \"transfer_reason\": \"personal_account\"   } ```  See [BRL Bank](https://docs.transferzero.com/docs/payout-details/#brlbank) documentation for the bank_code and transfer_reason lists
 class PayoutMethodDetailsBRLBank
   attr_accessor :first_name
 
@@ -29,6 +29,10 @@ class PayoutMethodDetailsBRLBank
 
   attr_accessor :bank_account_type
 
+  attr_accessor :pix_key_type
+
+  attr_accessor :pix_key_value
+
   attr_accessor :identity_card_type
 
   attr_accessor :identity_card_id
@@ -45,6 +49,8 @@ class PayoutMethodDetailsBRLBank
       :'branch_code' => :'branch_code',
       :'bank_account' => :'bank_account',
       :'bank_account_type' => :'bank_account_type',
+      :'pix_key_type' => :'pix_key_type',
+      :'pix_key_value' => :'pix_key_value',
       :'identity_card_type' => :'identity_card_type',
       :'identity_card_id' => :'identity_card_id',
       :'transfer_reason' => :'transfer_reason'
@@ -61,6 +67,8 @@ class PayoutMethodDetailsBRLBank
       :'branch_code' => :'String',
       :'bank_account' => :'String',
       :'bank_account_type' => :'PayoutMethodBankAccountTypeEnum',
+      :'pix_key_type' => :'PayoutMethodPixKeyTypeEnum',
+      :'pix_key_value' => :'String',
       :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
       :'identity_card_id' => :'String',
       :'transfer_reason' => :'PayoutMethodTransferReasonEnum'
@@ -110,6 +118,14 @@ class PayoutMethodDetailsBRLBank
       self.bank_account_type = attributes[:'bank_account_type']
     end
 
+    if attributes.key?(:'pix_key_type')
+      self.pix_key_type = attributes[:'pix_key_type']
+    end
+
+    if attributes.key?(:'pix_key_value')
+      self.pix_key_value = attributes[:'pix_key_value']
+    end
+
     if attributes.key?(:'identity_card_type')
       self.identity_card_type = attributes[:'identity_card_type']
     end
@@ -135,22 +151,6 @@ class PayoutMethodDetailsBRLBank
       invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
     end
 
-    if @bank_code.nil?
-      invalid_properties.push('invalid value for "bank_code", bank_code cannot be nil.')
-    end
-
-    if @branch_code.nil?
-      invalid_properties.push('invalid value for "branch_code", branch_code cannot be nil.')
-    end
-
-    if @bank_account.nil?
-      invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.')
-    end
-
-    if @bank_account_type.nil?
-      invalid_properties.push('invalid value for "bank_account_type", bank_account_type cannot be nil.')
-    end
-
     if @identity_card_type.nil?
       invalid_properties.push('invalid value for "identity_card_type", identity_card_type cannot be nil.')
     end
@@ -171,10 +171,6 @@ class PayoutMethodDetailsBRLBank
   def valid?
     return false if @first_name.nil?
     return false if @last_name.nil?
-    return false if @bank_code.nil?
-    return false if @branch_code.nil?
-    return false if @bank_account.nil?
-    return false if @bank_account_type.nil?
     return false if @identity_card_type.nil?
     return false if @identity_card_id.nil?
     return false if @transfer_reason.nil?
@@ -193,6 +189,8 @@ class PayoutMethodDetailsBRLBank
         branch_code == o.branch_code &&
         bank_account == o.bank_account &&
         bank_account_type == o.bank_account_type &&
+        pix_key_type == o.pix_key_type &&
+        pix_key_value == o.pix_key_value &&
         identity_card_type == o.identity_card_type &&
         identity_card_id == o.identity_card_id &&
         transfer_reason == o.transfer_reason
@@ -207,7 +205,7 @@ class PayoutMethodDetailsBRLBank
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [first_name, last_name, phone_number, bank_code, branch_code, bank_account, bank_account_type, identity_card_type, identity_card_id, transfer_reason].hash
+    [first_name, last_name, phone_number, bank_code, branch_code, bank_account, bank_account_type, pix_key_type, pix_key_value, identity_card_type, identity_card_id, transfer_reason].hash
   end
 
 require 'active_support/core_ext/hash'

data/lib/transferzero-sdk/models/payout_method_details_ghs_cash.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"0322023144\" } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+233322023144\" } ```
 class PayoutMethodDetailsGHSCash
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_gnf_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"444044436\", // local or international Guinea format   \"mobile_provider\": \"mtn\" } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+224444044436\", // E.164 international format   \"mobile_provider\": \"mtn\" } ```
 class PayoutMethodDetailsGNFMobile
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_kes_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON   \"details\": {     \"first_name\": \"First\",     \"last_name\": \"Last\",     \"street\": \"Main Street\",     \"phone_number\": \"+254997853134\",     \"mobile_provider\": \"mpesa\",     \"transfer_reason\": \"personal_account\", // New transfer reason field     \"identity_card_type\": \"ID\",     \"identity_card_id\": \"AB12345678\"   } ```  See [KES Mobile](https://docs.transferzero.com/docs/payout-details/#kesmobile) documentation for transfer_reason lists
+# ```JSON   \"details\": {     \"first_name\": \"First\",     \"last_name\": \"Last\",     \"street\": \"Main Street\",     \"phone_number\": \"+254997853134\", // E.164 international format     \"mobile_provider\": \"mpesa\",     \"transfer_reason\": \"personal_account\", // New transfer reason field     \"identity_card_type\": \"ID\",     \"identity_card_id\": \"AB12345678\"   } ```  See [KES Mobile](https://docs.transferzero.com/docs/payout-details/#kesmobile) documentation for transfer_reason lists
 class PayoutMethodDetailsKESMobile
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_mad_cash.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"212537718685\"     # Mandatory; International format preferred   \"sender_identity_card_type\" => \"O\",     # Mandatory; Values: \"O\": Other, \"PP\": Passport, \"ID\": National ID   \"sender_identity_card_id\" => 'AB12345678',     # Mandatory   \"sender_city_of_birth\" => \"London\",     # Optional   \"sender_country_of_birth\" => \"GB\",     # Optional; ISO 2-letter format   \"sender_gender\" => \"M\",     # Optional; Values: \"M\": Male, \"F\": Female   \"reason\" => \"Remittance payment\",     # Optional; Default value is 'Remittance payment'   \"identity_card_type\" => \"ID\",     # Optional; Values: \"PP\": Passport, \"ID\": National ID   \"identity_card_id\" => 'AB12345678'     # Optional } ```  Please note when sending MAD::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt -  ```JSON {   (...)   \"state\":\"pending\",   \"metadata\": {     \"payment_reference\":\"9M5GJRJUBCY\"   },   (...) } ```  The reference can also be provided optionally for MAD::Cash, but if you want to use this functionality please contact us for more details.
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+212537718685\"     # Mandatory; E.164 international format   \"sender_identity_card_type\" => \"O\",     # Mandatory; Values: \"O\": Other, \"PP\": Passport, \"ID\": National ID   \"sender_identity_card_id\" => 'AB12345678',     # Mandatory   \"sender_city_of_birth\" => \"London\",     # Optional   \"sender_country_of_birth\" => \"GB\",     # Optional; ISO 2-letter format   \"sender_gender\" => \"M\",     # Optional; Values: \"M\": Male, \"F\": Female   \"reason\" => \"Remittance payment\",     # Optional; Default value is 'Remittance payment'   \"identity_card_type\" => \"ID\",     # Optional; Values: \"PP\": Passport, \"ID\": National ID   \"identity_card_id\" => 'AB12345678'     # Optional } ```  Please note when sending MAD::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt -  ```JSON {   (...)   \"state\":\"pending\",   \"metadata\": {     \"payment_reference\":\"9M5GJRJUBCY\"   },   (...) } ```  The reference can also be provided optionally for MAD::Cash, but if you want to use this functionality please contact us for more details.
 class PayoutMethodDetailsMADCash
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"7087661234\" // local or international format } ```  Please note when sending XOF::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt -  ```JSON {   (...)   \"state\":\"pending\",   \"metadata\": {     \"payment_reference\":\"9M5GJRJUBCY\"   },   (...) } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+221708766123\" // E.164 international format } ```  Please note when sending XOF::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt -  ```JSON {   (...)   \"state\":\"pending\",   \"metadata\": {     \"payment_reference\":\"9M5GJRJUBCY\"   },   (...) } ```
 class PayoutMethodDetailsMobile
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_usd_bank.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON   \"details\": {     \"first_name\": \"Jane\",     \"last_name\": \"Doe\",     \"phone_number\": \"+2341234567\",     \"bank_code\": \"057\",     \"bank_account\": \"1234567890\",     \"country\": \"NG\"   } ``` See [USD Bank](https://docs.transferzero.com/docs/payout-details/#usdbank) documentation for the bank_code and country lists
+# ```JSON   \"details\": {     \"first_name\": \"Jane\",     \"last_name\": \"Doe\",     \"phone_number\": \"+2341234567\", // E.164 international format     \"bank_code\": \"057\",     \"bank_account\": \"1234567890\",     \"country\": \"NG\"   } ``` See [USD Bank](https://docs.transferzero.com/docs/payout-details/#usdbank) documentation for the bank_code and country lists
 class PayoutMethodDetailsUSDBank
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_usd_cash.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON   \"details\": {     \"first_name\": \"Jane\",     \"last_name\": \"Doe\",     \"phone_number\": \"+2341234567\",     \"country\": \"NG\"   } ``` See [USD Cash](https://docs.transferzero.com/docs/payout-details/#usdcash) documentation for the country list
+# ```JSON   \"details\": {     \"first_name\": \"Jane\",     \"last_name\": \"Doe\",     \"phone_number\": \"+2341234567\", // E.164 international format     \"country\": \"NG\"   } ``` See [USD Cash](https://docs.transferzero.com/docs/payout-details/#usdcash) documentation for the country list
 class PayoutMethodDetailsUSDCash
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_xaf_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"674044436\", // local or international cameroon format   \"mobile_provider\": \"orange\", // or mtn\"   \"country\" // Optional; Values: \"CM\" } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+237674044436\", // E.164 international format   \"mobile_provider\": \"orange\", // or mtn\"   \"country\" // Optional; Values: \"CM\" } ```
 class PayoutMethodDetailsXAFMobile
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_xof_cash.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"221774044436\", // local or international format   \"cash_provider\": \"wizall\" // Mandatory; Values: \"wizall\";   \"country\": \"SN\" // Optional; Values: \"CI\", \"ML\" or \"SN\"; Default value is \"SN\"; } ```  Please note all senders trying to create Wizall cash pickup requests must have `identity_type` and `identity_number` present. The fields above are generally considered optional for senders for other payment corridors. If you wish to use an existing sender who has some of these fields missing you can provide them alongside the `id` or `external_id` field in the sender details. For example -  ```JSON {   \"transaction\": {       \"sender\": {         \"external_id\": \"<id of sender>\",         \"identity_type\": \"ID\",         \"identity_number\": \"AB12345678\",         (...)       },       (...)     } } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+221774044436\", // E.164 international format   \"cash_provider\": \"wizall\" // Mandatory; Values: \"wizall\";   \"country\": \"SN\" // Optional; Values: \"CI\", \"ML\" or \"SN\"; Default value is \"SN\"; } ```  Please note all senders trying to create Wizall cash pickup requests must have `identity_type` and `identity_number` present. The fields above are generally considered optional for senders for other payment corridors. If you wish to use an existing sender who has some of these fields missing you can provide them alongside the `id` or `external_id` field in the sender details. For example -  ```JSON {   \"transaction\": {       \"sender\": {         \"external_id\": \"<id of sender>\",         \"identity_type\": \"ID\",         \"identity_number\": \"AB12345678\",         (...)       },       (...)     } } ```
 class PayoutMethodDetailsXOFCash
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_xof_mobile.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"774044436\", // local or international Senegalese or Ivory Coast format   \"mobile_provider\": \"orange\", // \"orange\", \"tigo\", \"emoney\", \"free\" or \"wave\" for Senegal; \"orange\", \"mtn\" or \"moov\" for Ivory Coast; \"orange\" or \"mobicash\" for Burkina Faso and Mali   \"country\" // Optional; Values: \"SN\" for Senegal; \"CI\" for Ivory Coast; \"ML\" for Mali; \"BF\" for Burkina Faso; Default value is \"SN\"   \"transfer_reason\": \"personal_account\" // mandatory for Mali payouts, optional otherwise } ```
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"+221708766123\", // E.164 international format   \"mobile_provider\": \"orange\", // \"orange\", \"tigo\", \"emoney\", \"free\" or \"wave\" for Senegal; \"orange\", \"mtn\" or \"moov\" for Ivory Coast; \"orange\" or \"mobicash\" for Burkina Faso and Mali   \"country\" // Optional; Values: \"SN\" for Senegal; \"CI\" for Ivory Coast; \"ML\" for Mali; \"BF\" for Burkina Faso; Default value is \"SN\"   \"transfer_reason\": \"personal_account\" // mandatory for Mali payouts, optional otherwise } ```
 class PayoutMethodDetailsXOFMobile
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_details_zar_bank.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON   \"details\": {     \"first_name\": \"First\", //  Mandatory for personal payouts;     \"last_name\": \"Last\", //  Mandatory for personal payouts;     \"name\" \"First Ltd\", // Mandatory for business payouts;     \"contact_first_name\" \"Business\", // Mandatory for business payouts;     \"contact_last_name\" \"Contact\", // Mandatory for business payouts;     \"street\": \"Main Street\",     \"postal_code\": \"AB0001\",     \"city\": \"Cape Town\",     \"email\": \"recipient@email.com\",     \"bank_name\" 'Bank Zero', // Optional     \"bank_code\": \"334810\",     \"bank_account\": \"12345678\",     \"phone_number\": \"+27119785313\",     \"transfer_reason\": \"personal_account\", // New transfer reason field     \"legal_entity_type\": \"sole_proprietorship\", // Optional; Default value is \"person\"; Mandatory for business payouts;     \"nature_of_business\": \"mining\", // Optional for business payouts;     \"registration_number\": \"17364BGC\" // Optional for business payouts;   } ```  See [ZAR Bank](https://docs.transferzero.com/docs/payout-details/#zarbank) documentation for the bank_code and transfer_reason lists
+# ```JSON   \"details\": {     \"first_name\": \"First\", //  Mandatory for personal payouts;     \"last_name\": \"Last\", //  Mandatory for personal payouts;     \"name\" \"First Ltd\", // Mandatory for business payouts;     \"contact_first_name\" \"Business\", // Mandatory for business payouts;     \"contact_last_name\" \"Contact\", // Mandatory for business payouts;     \"street\": \"Main Street\",     \"postal_code\": \"AB0001\",     \"city\": \"Cape Town\",     \"email\": \"recipient@email.com\",     \"bank_name\" 'Bank Zero', // Optional     \"bank_code\": \"334810\",     \"bank_account\": \"12345678\",     \"phone_number\": \"+27119785313\", // E.164 international format     \"transfer_reason\": \"personal_account\", // New transfer reason field     \"legal_entity_type\": \"sole_proprietorship\", // Optional; Default value is \"person\"; Mandatory for business payouts;     \"nature_of_business\": \"mining\", // Optional for business payouts;     \"registration_number\": \"17364BGC\" // Optional for business payouts;   } ```  See [ZAR Bank](https://docs.transferzero.com/docs/payout-details/#zarbank) documentation for the bank_code and transfer_reason lists
 class PayoutMethodDetailsZARBank
   attr_accessor :first_name
 

data/lib/transferzero-sdk/models/payout_method_pix_key_type_enum.rb

@@ -0,0 +1,34 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'date'
+
+module TransferZero
+class PayoutMethodPixKeyTypeEnum
+  
+  CPF = "cpf".freeze
+  CNPJ = "cnpj".freeze
+  PHONE = "phone".freeze
+  EMAIL = "email".freeze
+  EVP = "evp".freeze
+
+  # Builds the enum from string
+  # @param [String] The enum value in the form of the string
+  # @return [String] The enum value
+  def build_from_hash(value)
+    constantValues = PayoutMethodPixKeyTypeEnum.constants.select { |c| PayoutMethodPixKeyTypeEnum::const_get(c) == value }
+    raise "Invalid ENUM value #{value} for class #PayoutMethodPixKeyTypeEnum" if constantValues.empty? && !value.empty?
+    value
+  end
+end
+
+end

data/lib/transferzero-sdk/models/sender.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# This contains the details of the sender. The first time a specific sender is used the full details should be provided. Once a sender is created and is used, the next time you MUST only send the ID of the sender. This is so we can match the same sender across multiple transactions for KYC and audit purposes.  Personal Sender Example: ```json {   // name   \"first_name\": \"Jane\",   \"last_name\": \"Doe\",    // address   \"country\": \"US\",   \"city\": \"New York\",   \"street\": \"20 W 34th St\",   \"postal_code\": \"10001\",   \"address_description\": \"\",    // DOB   \"birth_date\": \"1974-12-24\",    // Contact Details; You can usually use your company's contact details here   \"phone_country\": \"US\",   \"phone_number\": \"5555551234\",   \"email\": \"info@transferzero.com\",    // ID of the sender in your system   \"external_id\": \"Sender:US:234523\",    // these fields are mandatory, but you can usually leave them with the following default values:   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": {} } ```  Business Sender Example:  ```json {   \"type\": \"business\",   \"name\": \"Company name\",    // Country of Incorporation   \"country\": \"US\",    // Trading address of the company   \"trading_country\": \"US\",   \"city\": \"New York\",   \"street\": \"20 W 34th St\",   \"postal_code\": \"10001\",   \"address_description\": \"\",    // Company Details   \"legal_entity_type\": \"privately_owned_company\",   \"registration_date\": \"2012-01-25\",   \"registration_number\": \"VAT1234567\",   \"nature_of_business\": \"retail_trade\",    // Contact Details   \"phone_country\": \"US\",   \"phone_number\": \"5555551234\",   \"email\": \"example@home.org\",    // ID of the sender in your system   \"external_id\": \"Sender:Business:US:234523\",    // these fields are mandatory, but you can usually leave them with the following default values:   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": {} } ```  [Sender in the API documentation](https://docs.transferzero.com/docs/transaction-flow/#sender)
+# This contains the details of the sender. The first time a specific sender is used the full details should be provided. Once a sender is created and is used, the next time you MUST only send the ID of the sender. This is so we can match the same sender across multiple transactions for KYC and audit purposes.  Personal Sender Example: ```json {   // name   \"first_name\": \"Jane\",   \"last_name\": \"Doe\",    // address   \"country\": \"US\",   \"city\": \"New York\",   \"street\": \"20 W 34th St\",   \"postal_code\": \"10001\",   \"address_description\": \"\",    // DOB   \"birth_date\": \"1974-12-24\",    // Contact Details; You can usually use your company's contact details here   \"phone_number\": \"+15555551234\",   \"email\": \"info@transferzero.com\",    // ID of the sender in your system   \"external_id\": \"Sender:US:234523\",    // these fields are mandatory, but you can usually leave them with the following default values:   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": {} } ```  Business Sender Example:  ```json {   \"type\": \"business\",   \"name\": \"Company name\",    // Country of Incorporation   \"country\": \"US\",    // Trading address of the company   \"trading_country\": \"US\",   \"city\": \"New York\",   \"street\": \"20 W 34th St\",   \"postal_code\": \"10001\",   \"address_description\": \"\",    // Company Details   \"legal_entity_type\": \"privately_owned_company\",   \"registration_date\": \"2012-01-25\",   \"registration_number\": \"VAT1234567\",   \"nature_of_business\": \"retail_trade\",    // Contact Details   \"phone_number\": \"+15555551234\",   \"email\": \"example@home.org\",    // ID of the sender in your system   \"external_id\": \"Sender:Business:US:234523\",    // these fields are mandatory, but you can usually leave them with the following default values:   \"documents\": [ ],   \"ip\": \"127.0.0.1\",   \"metadata\": {} } ```  [Sender in the API documentation](https://docs.transferzero.com/docs/transaction-flow/#sender)
 class Sender
   attr_accessor :id
 
@@ -649,10 +649,6 @@ class Sender
       invalid_properties.push('invalid value for "city", city cannot be nil.')
     end
 
-    if @phone_country.nil?
-      invalid_properties.push('invalid value for "phone_country", phone_country cannot be nil.')
-    end
-
     if @email.nil?
       invalid_properties.push('invalid value for "email", email cannot be nil.')
     end
@@ -677,7 +673,6 @@ class Sender
     return false if @street.nil?
     return false if @postal_code.nil?
     return false if @city.nil?
-    return false if @phone_country.nil?
     return false if @email.nil?
     return false if @ip.nil?
     identification_type_validator = EnumAttributeValidator.new('String', ["DL", "PP", "ID", "OT"])

data/lib/transferzero-sdk/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.0.0-beta3
 =end
 
 module TransferZero
-  VERSION = '1.23.3'
+  VERSION = '1.23.5'
 end

data/lib/transferzero-sdk.rb

@@ -94,6 +94,7 @@ require 'transferzero-sdk/models/payout_method_legal_entity_type_enum'
 require 'transferzero-sdk/models/payout_method_list_response'
 require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
 require 'transferzero-sdk/models/payout_method_nature_of_business_enum'
+require 'transferzero-sdk/models/payout_method_pix_key_type_enum'
 require 'transferzero-sdk/models/payout_method_request'
 require 'transferzero-sdk/models/payout_method_response'
 require 'transferzero-sdk/models/payout_method_transfer_reason_enum'

data/spec/models/payout_method_pix_key_type_enum_spec.rb

@@ -0,0 +1,35 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TransferZero::PayoutMethodPixKeyTypeEnum
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayoutMethodPixKeyTypeEnum' do
+  before do
+    # run before each test
+    @instance = TransferZero::PayoutMethodPixKeyTypeEnum.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayoutMethodPixKeyTypeEnum' do
+    it 'should create an instance of PayoutMethodPixKeyTypeEnum' do
+      expect(@instance).to be_instance_of(TransferZero::PayoutMethodPixKeyTypeEnum)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transferzero-sdk
 version: !ruby/object:Gem::Version
-  version: 1.23.3
+  version: 1.23.5
 platform: ruby
 authors:
 - TransferZero
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-21 00:00:00.000000000 Z
+date: 2023-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -182,6 +182,7 @@ files:
 - docs/PayoutMethodListResponse.md
 - docs/PayoutMethodMobileProviderEnum.md
 - docs/PayoutMethodNatureOfBusinessEnum.md
+- docs/PayoutMethodPixKeyTypeEnum.md
 - docs/PayoutMethodRequest.md
 - docs/PayoutMethodResponse.md
 - docs/PayoutMethodTransferReasonEnum.md
@@ -329,6 +330,7 @@ files:
 - lib/transferzero-sdk/models/payout_method_list_response.rb
 - lib/transferzero-sdk/models/payout_method_mobile_provider_enum.rb
 - lib/transferzero-sdk/models/payout_method_nature_of_business_enum.rb
+- lib/transferzero-sdk/models/payout_method_pix_key_type_enum.rb
 - lib/transferzero-sdk/models/payout_method_request.rb
 - lib/transferzero-sdk/models/payout_method_response.rb
 - lib/transferzero-sdk/models/payout_method_transfer_reason_enum.rb
@@ -466,6 +468,7 @@ files:
 - spec/models/payout_method_list_response_spec.rb
 - spec/models/payout_method_mobile_provider_enum_spec.rb
 - spec/models/payout_method_nature_of_business_enum_spec.rb
+- spec/models/payout_method_pix_key_type_enum_spec.rb
 - spec/models/payout_method_request_spec.rb
 - spec/models/payout_method_response_spec.rb
 - spec/models/payout_method_spec.rb
@@ -522,6 +525,7 @@ files:
 - transferzero-sdk-1.21.0.gem
 - transferzero-sdk-1.22.0.gem
 - transferzero-sdk-1.23.0.gem
+- transferzero-sdk-1.23.3.gem
 - transferzero-sdk.gemspec
 homepage: https://github.com/transferzero/transferzero-sdk-ruby
 licenses:
@@ -646,6 +650,7 @@ test_files:
 - spec/models/payout_method_details_spec.rb
 - spec/models/recipient_response_spec.rb
 - spec/models/recipient_list_response_spec.rb
+- spec/models/payout_method_pix_key_type_enum_spec.rb
 - spec/models/account_response_spec.rb
 - spec/models/recipient_request_spec.rb
 - spec/models/recipient_state_reason_details_spec.rb