transferzero-sdk 1.11.0 → 1.14.1

data/lib/transferzero-sdk/api/transactions_api.rb

@@ -204,6 +204,7 @@ module TransferZero
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
     # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+    # @option opts [String] :transactions_type Allows filtering results by `transactions_type`.  Example: `/v1/transactions?transactions_type=automated`
     # @return [TransactionListResponse]
     def get_transactions(opts = {})
       data, _status_code, _headers = get_transactions_with_http_info(opts)
@@ -217,11 +218,15 @@ module TransferZero
     # @option opts [Integer] :per The number of results to load per page (defaults to 10)
     # @option opts [String] :external_id Allows filtering results by `external_id`.  Example: `/v1/senders?external_id=26ec8517-2f0d-48c0-b74f-0bccb9ab3a87`
     # @option opts [String] :sender_id Allows filtering results by `sender_id`.  Example: `/v1/transactions?sender_id=b41d3cb7-6c54-4245-85fc-8e30690eb0f7`
+    # @option opts [String] :transactions_type Allows filtering results by `transactions_type`.  Example: `/v1/transactions?transactions_type=automated`
     # @return [Array<(TransactionListResponse, Fixnum, Hash)>] TransactionListResponse data, response status code and response headers
     def get_transactions_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: TransactionsApi.get_transactions ...'
       end
+      if @api_client.config.client_side_validation && opts[:'transactions_type'] && !['automated', 'manual'].include?(opts[:'transactions_type'])
+        fail ArgumentError, 'invalid value for "transactions_type", must be one of automated, manual'
+      end
       # resource path
       local_var_path = '/transactions'
 
@@ -231,6 +236,7 @@ module TransferZero
       query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
       query_params[:'external_id'] = opts[:'external_id'] if !opts[:'external_id'].nil?
       query_params[:'sender_id'] = opts[:'sender_id'] if !opts[:'sender_id'].nil?
+      query_params[:'transactions_type'] = opts[:'transactions_type'] if !opts[:'transactions_type'].nil?
 
       # header parameters
       header_params = {}

data/lib/transferzero-sdk/api_client.rb

@@ -35,7 +35,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.11.0"
+      @user_agent = "TransferZero-SDK/Ruby/1.14.1"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

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

@@ -23,6 +23,8 @@ class AccountValidationRequest
   # Phone number to query
   attr_accessor :phone_number
 
+  attr_accessor :mobile_provider
+
   # Country of account in 2-character alpha ISO 3166-2 country format
   attr_accessor :country
 
@@ -60,6 +62,7 @@ class AccountValidationRequest
       :'bank_account' => :'bank_account',
       :'bank_code' => :'bank_code',
       :'phone_number' => :'phone_number',
+      :'mobile_provider' => :'mobile_provider',
       :'country' => :'country',
       :'currency' => :'currency',
       :'method' => :'method'
@@ -72,6 +75,7 @@ class AccountValidationRequest
       :'bank_account' => :'String',
       :'bank_code' => :'String',
       :'phone_number' => :'String',
+      :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
       :'country' => :'String',
       :'currency' => :'String',
       :'method' => :'String'
@@ -105,6 +109,10 @@ class AccountValidationRequest
       self.phone_number = attributes[:'phone_number']
     end
 
+    if attributes.key?(:'mobile_provider')
+      self.mobile_provider = attributes[:'mobile_provider']
+    end
+
     if attributes.key?(:'country')
       self.country = attributes[:'country']
     end
@@ -190,6 +198,7 @@ class AccountValidationRequest
         bank_account == o.bank_account &&
         bank_code == o.bank_code &&
         phone_number == o.phone_number &&
+        mobile_provider == o.mobile_provider &&
         country == o.country &&
         currency == o.currency &&
         method == o.method
@@ -204,7 +213,7 @@ class AccountValidationRequest
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [bank_account, bank_code, phone_number, country, currency, method].hash
+    [bank_account, bank_code, phone_number, mobile_provider, country, currency, method].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -15,7 +15,7 @@ require 'date'
 module TransferZero
 # This describes the specific details on how the payment has to be routed to the recipient.
 class PayoutMethod
-  # 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 
+  # 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. - `GHS::Cash` - for Ghanaian cash remittance payments. - `UGX::Mobile` - for Ugandan mobile money payments. - `TZS::Mobile` - for Tanzanian mobile money payments. - `XOF::Mobile` - for mobile money payments to West-Africa. - `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 
   attr_accessor :type
 
   attr_accessor :details

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

@@ -0,0 +1,43 @@
+=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 PayoutMethodCountryEnum
+  
+  CI = "CI".freeze
+  ML = "ML".freeze
+  SN = "SN".freeze
+  NG = "NG".freeze
+  MA = "MA".freeze
+  TZ = "TZ".freeze
+  GH = "GH".freeze
+  UG = "UG".freeze
+  KE = "KE".freeze
+  NJ = "NJ".freeze
+  EU = "EU".freeze
+  GB = "GB".freeze
+  ZA = "ZA".freeze
+  EG = "EG".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 = PayoutMethodCountryEnum.constants.select { |c| PayoutMethodCountryEnum::const_get(c) == value }
+    raise "Invalid ENUM value #{value} for class #PayoutMethodCountryEnum" if constantValues.empty? && !value.empty?
+    value
+  end
+end
+
+end

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

@@ -28,6 +28,8 @@ class PayoutMethodDetails
 
   attr_accessor :mobile_provider
 
+  attr_accessor :country
+
   attr_accessor :iban
 
   attr_accessor :bank_name
@@ -72,6 +74,16 @@ class PayoutMethodDetails
 
   attr_accessor :transfer_reason_code
 
+  attr_accessor :contact_first_name
+
+  attr_accessor :contact_last_name
+
+  attr_accessor :registration_number
+
+  attr_accessor :nature_of_business
+
+  attr_accessor :legal_entity_type
+
   # Attribute mapping from ruby-style variable name to JSON key.
   def self.attribute_map
     {
@@ -82,6 +94,7 @@ class PayoutMethodDetails
       :'bank_account_type' => :'bank_account_type',
       :'phone_number' => :'phone_number',
       :'mobile_provider' => :'mobile_provider',
+      :'country' => :'country',
       :'iban' => :'iban',
       :'bank_name' => :'bank_name',
       :'bank_country' => :'bank_country',
@@ -103,7 +116,12 @@ class PayoutMethodDetails
       :'postal_code' => :'postal_code',
       :'city' => :'city',
       :'email' => :'email',
-      :'transfer_reason_code' => :'transfer_reason_code'
+      :'transfer_reason_code' => :'transfer_reason_code',
+      :'contact_first_name' => :'contact_first_name',
+      :'contact_last_name' => :'contact_last_name',
+      :'registration_number' => :'registration_number',
+      :'nature_of_business' => :'nature_of_business',
+      :'legal_entity_type' => :'legal_entity_type'
     }
   end
 
@@ -117,6 +135,7 @@ class PayoutMethodDetails
       :'bank_account_type' => :'PayoutMethodBankAccountTypeEnum',
       :'phone_number' => :'String',
       :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
+      :'country' => :'PayoutMethodCountryEnum',
       :'iban' => :'String',
       :'bank_name' => :'String',
       :'bank_country' => :'String',
@@ -138,7 +157,12 @@ class PayoutMethodDetails
       :'postal_code' => :'String',
       :'city' => :'String',
       :'email' => :'String',
-      :'transfer_reason_code' => :'String'
+      :'transfer_reason_code' => :'String',
+      :'contact_first_name' => :'String',
+      :'contact_last_name' => :'String',
+      :'registration_number' => :'String',
+      :'nature_of_business' => :'PayoutMethodNatureOfBusinessEnum',
+      :'legal_entity_type' => :'PayoutMethodLegalEntityTypeEnum'
     }
   end
 
@@ -149,6 +173,7 @@ class PayoutMethodDetails
     :'PayoutMethodDetailsBalance',
     :'PayoutMethodDetailsGBPBank',
     :'PayoutMethodDetailsGHSBank',
+    :'PayoutMethodDetailsGHSCash',
     :'PayoutMethodDetailsIBAN',
     :'PayoutMethodDetailsMADCash',
     :'PayoutMethodDetailsMobile',
@@ -203,6 +228,10 @@ class PayoutMethodDetails
       self.mobile_provider = attributes[:'mobile_provider']
     end
 
+    if attributes.key?(:'country')
+      self.country = attributes[:'country']
+    end
+
     if attributes.key?(:'iban')
       self.iban = attributes[:'iban']
     end
@@ -290,6 +319,26 @@ class PayoutMethodDetails
     if attributes.key?(:'transfer_reason_code')
       self.transfer_reason_code = attributes[:'transfer_reason_code']
     end
+
+    if attributes.key?(:'contact_first_name')
+      self.contact_first_name = attributes[:'contact_first_name']
+    end
+
+    if attributes.key?(:'contact_last_name')
+      self.contact_last_name = attributes[:'contact_last_name']
+    end
+
+    if attributes.key?(:'registration_number')
+      self.registration_number = attributes[:'registration_number']
+    end
+
+    if attributes.key?(:'nature_of_business')
+      self.nature_of_business = attributes[:'nature_of_business']
+    end
+
+    if attributes.key?(:'legal_entity_type')
+      self.legal_entity_type = attributes[:'legal_entity_type']
+    end
   end
 
   # Show invalid properties with the reasons. Usually used together with valid?
@@ -340,18 +389,6 @@ class PayoutMethodDetails
       invalid_properties.push('invalid value for "sender_identity_card_id", sender_identity_card_id cannot be nil.')
     end
 
-    if @sender_city_of_birth.nil?
-      invalid_properties.push('invalid value for "sender_city_of_birth", sender_city_of_birth cannot be nil.')
-    end
-
-    if @sender_country_of_birth.nil?
-      invalid_properties.push('invalid value for "sender_country_of_birth", sender_country_of_birth cannot be nil.')
-    end
-
-    if @sender_gender.nil?
-      invalid_properties.push('invalid value for "sender_gender", sender_gender cannot be nil.')
-    end
-
     if @name.nil?
       invalid_properties.push('invalid value for "name", name cannot be nil.')
     end
@@ -389,9 +426,6 @@ class PayoutMethodDetails
     return false if @bank_country.nil?
     return false if @sender_identity_card_type.nil?
     return false if @sender_identity_card_id.nil?
-    return false if @sender_city_of_birth.nil?
-    return false if @sender_country_of_birth.nil?
-    return false if @sender_gender.nil?
     return false if @name.nil?
     return false if @address.nil?
     return false if @street.nil?
@@ -428,6 +462,7 @@ class PayoutMethodDetails
         bank_account_type == o.bank_account_type &&
         phone_number == o.phone_number &&
         mobile_provider == o.mobile_provider &&
+        country == o.country &&
         iban == o.iban &&
         bank_name == o.bank_name &&
         bank_country == o.bank_country &&
@@ -449,7 +484,12 @@ class PayoutMethodDetails
         postal_code == o.postal_code &&
         city == o.city &&
         email == o.email &&
-        transfer_reason_code == o.transfer_reason_code
+        transfer_reason_code == o.transfer_reason_code &&
+        contact_first_name == o.contact_first_name &&
+        contact_last_name == o.contact_last_name &&
+        registration_number == o.registration_number &&
+        nature_of_business == o.nature_of_business &&
+        legal_entity_type == o.legal_entity_type
   end
 
   # @see the `==` method
@@ -461,7 +501,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, 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].hash
+    [first_name, last_name, bank_code, bank_account, bank_account_type, phone_number, mobile_provider, country, 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].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -0,0 +1,236 @@
+=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
+# ```JSON \"details\": {   \"first_name\": \"First\",   \"last_name\": \"Last\",   \"phone_number\": \"0322023144\" } ```
+class PayoutMethodDetailsGHSCash
+  attr_accessor :first_name
+
+  attr_accessor :last_name
+
+  attr_accessor :phone_number
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'first_name' => :'first_name',
+      :'last_name' => :'last_name',
+      :'phone_number' => :'phone_number'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'first_name' => :'String',
+      :'last_name' => :'String',
+      :'phone_number' => :'String'
+    }
+  end
+
+  # Initializes the object
+  # @param [Hash] attributes Model attributes in the form of hash
+  def initialize(attributes = {})
+    if (!attributes.is_a?(Hash))
+      fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::PayoutMethodDetailsGHSCash` initialize method"
+    end
+
+    # check to see if the attribute exists and convert string to symbol for hash key
+    attributes = attributes.each_with_object({}) { |(k, v), h|
+      if (!self.class.attribute_map.key?(k.to_sym))
+        fail ArgumentError, "`#{k}` is not a valid attribute in `TransferZero::PayoutMethodDetailsGHSCash`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+      end
+      h[k.to_sym] = v
+    }
+
+    if attributes.key?(:'first_name')
+      self.first_name = attributes[:'first_name']
+    end
+
+    if attributes.key?(:'last_name')
+      self.last_name = attributes[:'last_name']
+    end
+
+    if attributes.key?(:'phone_number')
+      self.phone_number = attributes[:'phone_number']
+    end
+  end
+
+  # Show invalid properties with the reasons. Usually used together with valid?
+  # @return Array for valid properties with the reasons
+  def list_invalid_properties
+    invalid_properties = Array.new
+    if @first_name.nil?
+      invalid_properties.push('invalid value for "first_name", first_name cannot be nil.')
+    end
+
+    if @last_name.nil?
+      invalid_properties.push('invalid value for "last_name", last_name cannot be nil.')
+    end
+
+    if @phone_number.nil?
+      invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+    end
+
+    invalid_properties
+  end
+
+  # Check to see if the all the properties in the model are valid
+  # @return true if the model is valid
+  def valid?
+    return false if @first_name.nil?
+    return false if @last_name.nil?
+    return false if @phone_number.nil?
+    true
+  end
+
+  # Checks equality by comparing each attribute.
+  # @param [Object] Object to be compared
+  def ==(o)
+    return true if self.equal?(o)
+    self.class == o.class &&
+        first_name == o.first_name &&
+        last_name == o.last_name &&
+        phone_number == o.phone_number
+  end
+
+  # @see the `==` method
+  # @param [Object] Object to be compared
+  def eql?(o)
+    self == o
+  end
+
+  # Calculates hash code according to all attributes.
+  # @return [Integer] Hash code
+  def hash
+    [first_name, last_name, phone_number].hash
+  end
+
+require 'active_support/core_ext/hash'
+require 'active_support/hash_with_indifferent_access.rb'
+# Builds the object from hash
+# @param [Hash] attributes Model attributes in the form of hash
+# @return [Object] Returns the model itself
+def build_from_hash(attributes)
+  return nil unless attributes.is_a?(Hash)
+  self.class.openapi_types.each_pair do |key, type|
+    if type =~ /\AArray<(.*)>/i
+      # check to ensure the input is an array given that the the attribute
+      # is documented as an array but the input is not
+      if attributes[self.class.attribute_map[key]].is_a?(Array)
+        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+      end
+    elsif !attributes[self.class.attribute_map[key]].nil?
+      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+    end # or else data not found in attributes(hash), not an issue as the data can be optional
+  end
+
+  self
+end
+
+# Deserializes the data based on type
+# @param string type Data type
+# @param string value Value to be deserialized
+# @return [Object] Deserialized data
+def _deserialize(type, value)
+  case type.to_sym
+  when :DateTime
+    DateTime.parse(value)
+  when :Date
+    Date.parse(value)
+  when :String
+    value.to_s
+  when :Integer
+    value.to_i
+  when :Float
+    value.to_f
+  when :Boolean
+    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+      true
+    else
+      false
+    end
+  when :Object
+    # generic object (usually a Hash), return directly
+    value
+  when /\AArray<(?<inner_type>.+)>\z/
+    inner_type = Regexp.last_match[:inner_type]
+    value.map { |v| _deserialize(inner_type, v) }
+  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+    k_type = Regexp.last_match[:k_type]
+    v_type = Regexp.last_match[:v_type]
+    {}.tap do |hash|
+      value.each do |k, v|
+        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+      end
+    end
+  else # model
+    temp_model = TransferZero.const_get(type).new
+    temp_model.build_from_hash(value)
+  end
+end
+
+# Returns the string representation of the object
+# @return [String] String presentation of the object
+def to_s
+  to_hash.to_s
+end
+
+# to_body is an alias to to_hash (backward compatibility)
+# @return [Hash] Returns the object in the form of hash
+def to_body
+  to_hash
+end
+
+# Returns the object in the form of hash
+# @return [Hash] Returns the object in the form of hash
+def to_hash
+  hash = {}
+  self.class.attribute_map.each_pair do |attr, param|
+    value = self.send(attr)
+    next if value.nil?
+    hash[param] = _to_hash(value)
+  end
+  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
+end
+
+def [](key)
+  to_hash[key]
+end
+
+def dig(*args)
+  to_hash.dig(*args)
+end
+
+# Outputs non-array value in the form of hash
+# For object, use to_hash. Otherwise, just return the value
+# @param [Object] value Any valid value
+# @return [Hash] Returns the value in the form of hash
+def _to_hash(value)
+  if value.is_a?(Array)
+    value.compact.map { |v| _to_hash(v) }
+  elsif value.is_a?(Hash)
+    {}.tap do |hash|
+      value.each { |k, v| hash[k] = _to_hash(v) }
+    end
+  elsif value.respond_to? :to_hash
+    value.to_hash
+  else
+    value
+  end
+end
+
+end
+
+end