transferzero-sdk 1.16.0 → 1.19.0

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

@@ -15,28 +15,40 @@ require 'date'
 module TransferZero
 # This describes the specific details on how the funds should be collected from the sender.
 class PayinMethod
-  # Describes how the payment should be requested from the user.  Possible values: - `NGN::Bank`: NGN bank and card collection requests - `NGN::Mobile`: NGN mobile collections - `GHS::Mobile`: GHS mobile collections - `TZS::Mobile`: TZS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections 
+  # Describes how the payment should be requested from the sender.  Possible values: - `GHS::Mobile`: GHS mobile collections - `UGX::Mobile`: UGX mobile collections - `EUR::Bank`: EUR IBAN collections - `GBP::Bank`: GBP IBAN collections 
   attr_accessor :type
 
+  attr_accessor :ux_flow
+
   attr_accessor :in_details
 
+  attr_accessor :id
+
+  attr_accessor :state
+
+  attr_accessor :state_reason_details
+
   # This will contain the description on where to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here.
   attr_accessor :out_details
 
   # This will contain the instructions on how to pay the funds. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on what to expect here.
   attr_accessor :instructions
 
-  # Describes which provider to use for collection. Please see the [Collections Details](https://docs.transferzero.com/docs/collection-details) in the API documentation on the valid values
-  attr_accessor :provider
+  # The fields that have some problems and don't pass validation
+  attr_accessor :errors
 
   # Attribute mapping from ruby-style variable name to JSON key.
   def self.attribute_map
     {
       :'type' => :'type',
+      :'ux_flow' => :'ux_flow',
       :'in_details' => :'in_details',
+      :'id' => :'id',
+      :'state' => :'state',
+      :'state_reason_details' => :'state_reason_details',
       :'out_details' => :'out_details',
       :'instructions' => :'instructions',
-      :'provider' => :'provider'
+      :'errors' => :'errors'
     }
   end
 
@@ -44,10 +56,14 @@ class PayinMethod
   def self.openapi_types
     {
       :'type' => :'String',
+      :'ux_flow' => :'PayinMethodUxFlow',
       :'in_details' => :'PayinMethodDetails',
+      :'id' => :'String',
+      :'state' => :'PayinMethodState',
+      :'state_reason_details' => :'StateReasonDetails',
       :'out_details' => :'Object',
       :'instructions' => :'Object',
-      :'provider' => :'String'
+      :'errors' => :'Hash<String, Array<ValidationErrorDescription>>'
     }
   end
 
@@ -70,10 +86,26 @@ class PayinMethod
       self.type = attributes[:'type']
     end
 
+    if attributes.key?(:'ux_flow')
+      self.ux_flow = attributes[:'ux_flow']
+    end
+
     if attributes.key?(:'in_details')
       self.in_details = attributes[:'in_details']
     end
 
+    if attributes.key?(:'id')
+      self.id = attributes[:'id']
+    end
+
+    if attributes.key?(:'state')
+      self.state = attributes[:'state']
+    end
+
+    if attributes.key?(:'state_reason_details')
+      self.state_reason_details = attributes[:'state_reason_details']
+    end
+
     if attributes.key?(:'out_details')
       self.out_details = attributes[:'out_details']
     end
@@ -82,8 +114,10 @@ class PayinMethod
       self.instructions = attributes[:'instructions']
     end
 
-    if attributes.key?(:'provider')
-      self.provider = attributes[:'provider']
+    if attributes.key?(:'errors')
+      if (value = attributes[:'errors']).is_a?(Hash)
+        self.errors = value
+      end
     end
   end
 
@@ -106,10 +140,14 @@ class PayinMethod
     return true if self.equal?(o)
     self.class == o.class &&
         type == o.type &&
+        ux_flow == o.ux_flow &&
         in_details == o.in_details &&
+        id == o.id &&
+        state == o.state &&
+        state_reason_details == o.state_reason_details &&
         out_details == o.out_details &&
         instructions == o.instructions &&
-        provider == o.provider
+        errors == o.errors
   end
 
   # @see the `==` method
@@ -121,7 +159,7 @@ class PayinMethod
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [type, in_details, out_details, instructions, provider].hash
+    [type, ux_flow, in_details, id, state, state_reason_details, out_details, instructions, errors].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -15,17 +15,16 @@ require 'date'
 module TransferZero
 # Fields needed by the payment processor. Depends on the chose payin type.  See the appropriate model details for more info:  - `NGN::Bank`: see [`PayinMethodDetailsNGNBank`](#model-PayinMethodDetailsNGNBank) - `GHS::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile) - `UGX::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile) - `TZS::Mobile`: see [`PayinMethodDetailsMobile`](#model-PayinMethodDetailsMobile)  Note that some payin processors don't require additional input, these include `paga` through `NGN::Mobile`, `lhv` through `EUR::Bank` and `GBP::Bank`. Some providers like `providus` also have all of their fields set as optional, so you might not want to set any values. To use these providers please set this value to `{}` (an empty hash) 
 class PayinMethodDetails
-  # The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both.
+  # The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both.
   attr_accessor :payment_method
 
-  # This is where the user should be redirected back when the payment has been finished
+  # This is where the sender should be redirected back when the payment has been finished
   attr_accessor :redirect_url
 
   # The phone number where the funds should be collected from
   attr_accessor :phone_number
 
-  # States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment.
-  attr_accessor :send_instructions
+  attr_accessor :mobile_provider
 
   # Please make sure the refund_address is a valid BTC address belonging to the sender, as that is going to be used in case the transaction has to be refunded.
   attr_accessor :refund_address
@@ -36,7 +35,7 @@ class PayinMethodDetails
       :'payment_method' => :'payment_method',
       :'redirect_url' => :'redirect_url',
       :'phone_number' => :'phone_number',
-      :'send_instructions' => :'send_instructions',
+      :'mobile_provider' => :'mobile_provider',
       :'refund_address' => :'refund_address'
     }
   end
@@ -47,7 +46,7 @@ class PayinMethodDetails
       :'payment_method' => :'String',
       :'redirect_url' => :'String',
       :'phone_number' => :'String',
-      :'send_instructions' => :'Boolean',
+      :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
       :'refund_address' => :'String'
     }
   end
@@ -88,8 +87,8 @@ class PayinMethodDetails
       self.phone_number = attributes[:'phone_number']
     end
 
-    if attributes.key?(:'send_instructions')
-      self.send_instructions = attributes[:'send_instructions']
+    if attributes.key?(:'mobile_provider')
+      self.mobile_provider = attributes[:'mobile_provider']
     end
 
     if attributes.key?(:'refund_address')
@@ -101,17 +100,12 @@ class PayinMethodDetails
   # @return Array for valid properties with the reasons
   def list_invalid_properties
     invalid_properties = Array.new
-    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 @phone_number.nil?
     _one_of_found = false
     openapi_one_of.each do |_class|
       _one_of = TransferZero.const_get(_class).build_from_hash(self.to_hash)
@@ -139,7 +133,7 @@ class PayinMethodDetails
         payment_method == o.payment_method &&
         redirect_url == o.redirect_url &&
         phone_number == o.phone_number &&
-        send_instructions == o.send_instructions &&
+        mobile_provider == o.mobile_provider &&
         refund_address == o.refund_address
   end
 
@@ -152,7 +146,7 @@ class PayinMethodDetails
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [payment_method, redirect_url, phone_number, send_instructions, refund_address].hash
+    [payment_method, redirect_url, phone_number, mobile_provider, refund_address].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -13,19 +13,18 @@ OpenAPI Generator version: 4.0.0-beta3
 require 'date'
 
 module TransferZero
-# ```JSON \"details\": {   \"phone_number\": \"+2569999999\",   \"send_instructions\": true } ```
+# ```JSON \"details\": {   \"phone_number\": \"+2569999999\", } ```
 class PayinMethodDetailsMobile
   # The phone number where the funds should be collected from
   attr_accessor :phone_number
 
-  # States whether to send out the instructions to the phone number on how to pay the funds or not. This shuold always be set to true, otherwise the sender might not receive a prompt for payment.
-  attr_accessor :send_instructions
+  attr_accessor :mobile_provider
 
   # Attribute mapping from ruby-style variable name to JSON key.
   def self.attribute_map
     {
       :'phone_number' => :'phone_number',
-      :'send_instructions' => :'send_instructions'
+      :'mobile_provider' => :'mobile_provider'
     }
   end
 
@@ -33,7 +32,7 @@ class PayinMethodDetailsMobile
   def self.openapi_types
     {
       :'phone_number' => :'String',
-      :'send_instructions' => :'Boolean'
+      :'mobile_provider' => :'PayoutMethodMobileProviderEnum'
     }
   end
 
@@ -56,8 +55,8 @@ class PayinMethodDetailsMobile
       self.phone_number = attributes[:'phone_number']
     end
 
-    if attributes.key?(:'send_instructions')
-      self.send_instructions = attributes[:'send_instructions']
+    if attributes.key?(:'mobile_provider')
+      self.mobile_provider = attributes[:'mobile_provider']
     end
   end
 
@@ -65,17 +64,12 @@ class PayinMethodDetailsMobile
   # @return Array for valid properties with the reasons
   def list_invalid_properties
     invalid_properties = Array.new
-    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 @phone_number.nil?
     true
   end
 
@@ -85,7 +79,7 @@ class PayinMethodDetailsMobile
     return true if self.equal?(o)
     self.class == o.class &&
         phone_number == o.phone_number &&
-        send_instructions == o.send_instructions
+        mobile_provider == o.mobile_provider
   end
 
   # @see the `==` method
@@ -97,7 +91,7 @@ class PayinMethodDetailsMobile
   # Calculates hash code according to all attributes.
   # @return [Integer] Hash code
   def hash
-    [phone_number, send_instructions].hash
+    [phone_number, mobile_provider].hash
   end
 
 require 'active_support/core_ext/hash'

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

@@ -15,10 +15,10 @@ require 'date'
 module TransferZero
 # ```JSON   \"details\": {     \"redirect_url\": \"http://redirect.back.to\"   } ```
 class PayinMethodDetailsNGNBank
-  # The payment method which the user will use to make the payments. Options are `bank`, `card` or you can leave empty to support both.
+  # The payment method which the sender will use to make the payments. Options are `bank`, `card` or you can leave empty to support both.
   attr_accessor :payment_method
 
-  # This is where the user should be redirected back when the payment has been finished
+  # This is where the sender should be redirected back when the payment has been finished
   attr_accessor :redirect_url
 
   # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -0,0 +1,202 @@
+=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 PayinMethodResponse
+  attr_accessor :object
+
+  # Attribute mapping from ruby-style variable name to JSON key.
+  def self.attribute_map
+    {
+      :'object' => :'object'
+    }
+  end
+
+  # Attribute type mapping.
+  def self.openapi_types
+    {
+      :'object' => :'PayinMethod'
+    }
+  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::PayinMethodResponse` 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::PayinMethodResponse`. 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?(:'object')
+      self.object = attributes[:'object']
+    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
+    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?
+    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 &&
+        object == o.object
+  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
+    [object].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

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

@@ -0,0 +1,39 @@
+=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 PayinMethodState
+  
+  INCOMPLETE = "incomplete".freeze
+  INITIAL = "initial".freeze
+  PENDING = "pending".freeze
+  SUCCESS = "success".freeze
+  PROCESSING = "processing".freeze
+  ERROR = "error".freeze
+  MISPAID = "mispaid".freeze
+  CANCELED = "canceled".freeze
+  REFUNDED = "refunded".freeze
+  EXCEPTION = "exception".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 = PayinMethodState.constants.select { |c| PayinMethodState::const_get(c) == value }
+    raise "Invalid ENUM value #{value} for class #PayinMethodState" if constantValues.empty? && !value.empty?
+    value
+  end
+end
+
+end

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

@@ -0,0 +1,31 @@
+=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 PayinMethodUxFlow
+  
+  USSD_POPUP = "ussd_popup".freeze
+  BANK_TRANSFER = "bank_transfer".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 = PayinMethodUxFlow.constants.select { |c| PayinMethodUxFlow::const_get(c) == value }
+    raise "Invalid ENUM value #{value} for class #PayinMethodUxFlow" if constantValues.empty? && !value.empty?
+    value
+  end
+end
+
+end

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. - `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. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money 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. - `USD::Bank` - for USD account payments. *** Currently Nigeria only and in Beta phase *** - `USD::Cash` - for USD cash remittance payments. *** Currently Nigeria only and in Beta phase *** - `KES::Bank` - for Kenyan bank account payments. - `KES::Mobile` - for Kenyan mobile money payments. - `XAF::Mobile` - for mobile money payments to Cameroon. - `GNF::Mobile` - for mobile money payments to Guinea.  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