hamza-payments-query-sdk 1.0.0

data/lib/payments/models/updated_payment_instrument.rb

@@ -0,0 +1,159 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details of the updated payment instrument.
+  class UpdatedPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Returned if the payment instrument was swapped for a network token.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :applied_network_token
+
+    # Returned if the payment instrument was swapped for a network token.
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # Details on the type of payment instrument update.
+    # @return [AccountUpdaterMessageEnum]
+    attr_accessor :account_updater_message
+
+    # Details on the type of payment instrument update.
+    # @return [String]
+    attr_accessor :card_number
+
+    # The updated card BIN (Bank Identification Number).
+    # @return [String]
+    attr_accessor :card_bin
+
+    # The four digits of the updated card. Some characters may be obfuscated
+    # with a * if the PAN length is less than 16 characters.
+    # @return [String]
+    attr_accessor :last_four
+
+    # Contains your customer's card or token expiry date.
+    # @return [ExpiryDate]
+    attr_accessor :expiry_date
+
+    # The brand of the updated card. In rare circumstances a card may be
+    # reissued under a different brand.
+    # @return [String]
+    attr_accessor :card_brand
+
+    # How the card is funded.
+    # @return [String]
+    attr_accessor :funding_type
+
+    # How the card is funded.
+    # @return [String]
+    attr_accessor :country_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['applied_network_token'] = 'appliedNetworkToken'
+      @_hash['type'] = 'type'
+      @_hash['account_updater_message'] = 'accountUpdaterMessage'
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['card_bin'] = 'cardBin'
+      @_hash['last_four'] = 'lastFour'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['card_brand'] = 'cardBrand'
+      @_hash['funding_type'] = 'fundingType'
+      @_hash['country_code'] = 'countryCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        applied_network_token
+        type
+        account_updater_message
+        card_number
+        card_bin
+        last_four
+        expiry_date
+        card_brand
+        funding_type
+        country_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(applied_network_token = SKIP, type = SKIP,
+                   account_updater_message = SKIP, card_number = SKIP,
+                   card_bin = SKIP, last_four = SKIP, expiry_date = SKIP,
+                   card_brand = SKIP, funding_type = SKIP, country_code = SKIP)
+      @applied_network_token = applied_network_token unless applied_network_token == SKIP
+      @type = type unless type == SKIP
+      @account_updater_message = account_updater_message unless account_updater_message == SKIP
+      @card_number = card_number unless card_number == SKIP
+      @card_bin = card_bin unless card_bin == SKIP
+      @last_four = last_four unless last_four == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @card_brand = card_brand unless card_brand == SKIP
+      @funding_type = funding_type unless funding_type == SKIP
+      @country_code = country_code unless country_code == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      applied_network_token =
+        hash.key?('appliedNetworkToken') ? hash['appliedNetworkToken'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      account_updater_message =
+        hash.key?('accountUpdaterMessage') ? hash['accountUpdaterMessage'] : SKIP
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      card_bin = hash.key?('cardBin') ? hash['cardBin'] : SKIP
+      last_four = hash.key?('lastFour') ? hash['lastFour'] : SKIP
+      expiry_date = ExpiryDate.from_hash(hash['expiryDate']) if hash['expiryDate']
+      card_brand = hash.key?('cardBrand') ? hash['cardBrand'] : SKIP
+      funding_type = hash.key?('fundingType') ? hash['fundingType'] : SKIP
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+
+      # Create object from extracted values.
+      UpdatedPaymentInstrument.new(applied_network_token,
+                                   type,
+                                   account_updater_message,
+                                   card_number,
+                                   card_bin,
+                                   last_four,
+                                   expiry_date,
+                                   card_brand,
+                                   funding_type,
+                                   country_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} applied_network_token: #{@applied_network_token}, type: #{@type},"\
+      " account_updater_message: #{@account_updater_message}, card_number: #{@card_number},"\
+      " card_bin: #{@card_bin}, last_four: #{@last_four}, expiry_date: #{@expiry_date},"\
+      " card_brand: #{@card_brand}, funding_type: #{@funding_type}, country_code:"\
+      " #{@country_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} applied_network_token: #{@applied_network_token.inspect}, type:"\
+      " #{@type.inspect}, account_updater_message: #{@account_updater_message.inspect},"\
+      " card_number: #{@card_number.inspect}, card_bin: #{@card_bin.inspect}, last_four:"\
+      " #{@last_four.inspect}, expiry_date: #{@expiry_date.inspect}, card_brand:"\
+      " #{@card_brand.inspect}, funding_type: #{@funding_type.inspect}, country_code:"\
+      " #{@country_code.inspect}>"
+    end
+  end
+end

data/lib/payments/models/updated_payment_instrument1.rb

@@ -0,0 +1,93 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The payment instrument supplied in the authorization request.
+  class UpdatedPaymentInstrument1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of payment instrument supplied in the authorization request.
+    # @return [Type10Enum]
+    attr_accessor :type
+
+    # An object that contains information about the card used.
+    # @return [Card1]
+    attr_accessor :card
+
+    # Details on the type of payment instrument update.
+    # @return [AccountUpdaterMessage1Enum]
+    attr_accessor :account_updater_message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['card'] = 'card'
+      @_hash['account_updater_message'] = 'accountUpdaterMessage'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        card
+        account_updater_message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, card = SKIP, account_updater_message = SKIP)
+      @type = type unless type == SKIP
+      @card = card unless card == SKIP
+      @account_updater_message = account_updater_message unless account_updater_message == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      card = Card1.from_hash(hash['card']) if hash['card']
+      account_updater_message =
+        hash.key?('accountUpdaterMessage') ? hash['accountUpdaterMessage'] : SKIP
+
+      # Create object from extracted values.
+      UpdatedPaymentInstrument1.new(type,
+                                    card,
+                                    account_updater_message)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [UpdatedPaymentInstrument1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, card: #{@card}, account_updater_message:"\
+      " #{@account_updater_message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, card: #{@card.inspect}, account_updater_message:"\
+      " #{@account_updater_message.inspect}>"
+    end
+  end
+end

data/lib/payments/models/user_type_enum.rb

@@ -0,0 +1,35 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # UserType.
+  class UserTypeEnum
+    USER_TYPE_ENUM = [
+      # TODO: Write general description for GUESTUSER
+      GUESTUSER = 'guestUser'.freeze,
+
+      # TODO: Write general description for REGISTEREDUSER
+      REGISTEREDUSER = 'registeredUser'.freeze,
+
+      # TODO: Write general description for FEDERATEDACCOUNT
+      FEDERATEDACCOUNT = 'federatedAccount'.freeze,
+
+      # TODO: Write general description for ISSUERCREDENTIALS
+      ISSUERCREDENTIALS = 'issuerCredentials'.freeze,
+
+      # TODO: Write general description for THIRDPARTYAUTHENTICATION
+      THIRDPARTYAUTHENTICATION = 'thirdPartyAuthentication'.freeze,
+
+      # TODO: Write general description for FIDOAUTHENTICATOR
+      FIDOAUTHENTICATOR = 'fidoAuthenticator'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      USER_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/value.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Value Model.
+  class Value < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The three character currency code. See list of <a
+    # href="/products/reference/supported-countries-currencies#iso-currency-code
+    # s">supported currencies</a>
+    # @return [String]
+    attr_accessor :currency
+
+    # The payment amount. Implied decimal. For example, 250 GBP = £2.50
+    # When set to `0` will perform a card verification instead of a payment as
+    # part of a new `customerAgreement`.
+    # @return [Integer]
+    attr_accessor :amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['currency'] = 'currency'
+      @_hash['amount'] = 'amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(currency = nil, amount = nil)
+      @currency = currency
+      @amount = amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      amount = Number.from_hash(hash['amount']) if hash['amount']
+
+      # Create object from extracted values.
+      Value.new(currency,
+                amount)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Value | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.currency,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.amount,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['currency'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['amount'],
+                                ->(val) { val.instance_of? Integer })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency}, amount: #{@amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} currency: #{@currency.inspect}, amount: #{@amount.inspect}>"
+    end
+  end
+end

data/lib/payments/models/value1.rb

@@ -0,0 +1,91 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains the amount and currency requested for settlement.
+  class Value1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is a whole number including the currency exponent (e.g. GBP has an
+    # exponent of 2, so for £2.50 supply:`250`).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The 3 digit currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Number.from_hash(hash['amount']) if hash['amount']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+
+      # Create object from extracted values.
+      Value1.new(amount,
+                 currency)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Value1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/payments/models/value2.rb

@@ -0,0 +1,91 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains the amount and currency requested for refund.
+  class Value2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is a whole number including the currency exponent (e.g. GBP has an
+    # exponent of 2, so for £2.50 supply:`250`).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The 3 digit currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Number.from_hash(hash['amount']) if hash['amount']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+
+      # Create object from extracted values.
+      Value2.new(amount,
+                 currency)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Value2 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/payments/models/value3.rb

@@ -0,0 +1,91 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains the amount and currency requested for reversal.
+  class Value3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is a whole number including the currency exponent (e.g. GBP has an
+    # exponent of 2, so for £2.50 supply:`250`).
+    # @return [Integer]
+    attr_accessor :amount
+
+    # The 3 digit currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil)
+      @amount = amount
+      @currency = currency
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      amount = Number.from_hash(hash['amount']) if hash['amount']
+      currency = hash.key?('currency') ? hash['currency'] : nil
+
+      # Create object from extracted values.
+      Value3.new(amount,
+                 currency)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Value3 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.amount,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.currency,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['amount'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['currency'],
+                                ->(val) { val.instance_of? String })
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end