hamza-payments-query-sdk 1.0.0

data/lib/payments/models/transaction_history.rb

@@ -0,0 +1,127 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Object containing details of the last transaction.
+  class TransactionHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Number of transactions (successful or abandoned) for this cardholder
+    # account within the last 24 hours.
+    # @return [Integer]
+    attr_accessor :attempts_last_day
+
+    # Number of transactions (successful or abandoned) for this cardholder
+    # account within the last year.
+    # @return [Integer]
+    attr_accessor :attempts_last_year
+
+    # Number of purchases with this customer account during the previous six
+    # months.
+    # @return [Integer]
+    attr_accessor :completed_last_six_months
+
+    # Number of attempts to add a card in the last 24hrs.
+    # @return [Integer]
+    attr_accessor :add_cards_last_day
+
+    # When the shipping address used for the transaction was first used.
+    # @return [String]
+    attr_accessor :shipping_address_first_used_at
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['attempts_last_day'] = 'attemptsLastDay'
+      @_hash['attempts_last_year'] = 'attemptsLastYear'
+      @_hash['completed_last_six_months'] = 'completedLastSixMonths'
+      @_hash['add_cards_last_day'] = 'addCardsLastDay'
+      @_hash['shipping_address_first_used_at'] = 'shippingAddressFirstUsedAt'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        attempts_last_day
+        attempts_last_year
+        completed_last_six_months
+        add_cards_last_day
+        shipping_address_first_used_at
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(attempts_last_day = SKIP, attempts_last_year = SKIP,
+                   completed_last_six_months = SKIP, add_cards_last_day = SKIP,
+                   shipping_address_first_used_at = SKIP)
+      @attempts_last_day = attempts_last_day unless attempts_last_day == SKIP
+      @attempts_last_year = attempts_last_year unless attempts_last_year == SKIP
+      unless completed_last_six_months == SKIP
+        @completed_last_six_months =
+          completed_last_six_months
+      end
+      @add_cards_last_day = add_cards_last_day unless add_cards_last_day == SKIP
+      unless shipping_address_first_used_at == SKIP
+        @shipping_address_first_used_at =
+          shipping_address_first_used_at
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      attempts_last_day = Number.from_hash(hash['attemptsLastDay']) if hash['attemptsLastDay']
+      attempts_last_year = Number.from_hash(hash['attemptsLastYear']) if hash['attemptsLastYear']
+      completed_last_six_months = Number.from_hash(hash['completedLastSixMonths']) if
+        hash['completedLastSixMonths']
+      add_cards_last_day = Number.from_hash(hash['addCardsLastDay']) if hash['addCardsLastDay']
+      shipping_address_first_used_at =
+        hash.key?('shippingAddressFirstUsedAt') ? hash['shippingAddressFirstUsedAt'] : SKIP
+
+      # Create object from extracted values.
+      TransactionHistory.new(attempts_last_day,
+                             attempts_last_year,
+                             completed_last_six_months,
+                             add_cards_last_day,
+                             shipping_address_first_used_at)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [TransactionHistory | 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} attempts_last_day: #{@attempts_last_day}, attempts_last_year:"\
+      " #{@attempts_last_year}, completed_last_six_months: #{@completed_last_six_months},"\
+      " add_cards_last_day: #{@add_cards_last_day}, shipping_address_first_used_at:"\
+      " #{@shipping_address_first_used_at}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} attempts_last_day: #{@attempts_last_day.inspect}, attempts_last_year:"\
+      " #{@attempts_last_year.inspect}, completed_last_six_months:"\
+      " #{@completed_last_six_months.inspect}, add_cards_last_day: #{@add_cards_last_day.inspect},"\
+      " shipping_address_first_used_at: #{@shipping_address_first_used_at.inspect}>"
+    end
+  end
+end

data/lib/payments/models/transaction_type1_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains transaction type.
+  class TransactionType1Enum
+    TRANSACTION_TYPE1_ENUM = [
+      # TODO: Write general description for ONETIME
+      ONETIME = 'oneTime'.freeze,
+
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'cardOnFile'.freeze,
+
+      # TODO: Write general description for RECURRING
+      RECURRING = 'recurring'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_TYPE1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/transaction_type_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The transaction type of the payment.
+  class TransactionTypeEnum
+    TRANSACTION_TYPE_ENUM = [
+      # TODO: Write general description for ONETIME
+      ONETIME = 'oneTime'.freeze,
+
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'cardOnFile'.freeze,
+
+      # TODO: Write general description for RECURRING
+      RECURRING = 'recurring'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TRANSACTION_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type10_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The type of payment instrument supplied in the authorization request.
+  class Type10Enum
+    TYPE10_ENUM = [
+      # TODO: Write general description for ENUM_CARDNETWORKTOKEN
+      ENUM_CARDNETWORKTOKEN = 'card/networkToken'.freeze,
+
+      # TODO: Write general description for ENUM_CARDPLAINMASKED
+      ENUM_CARDPLAINMASKED = 'card/plain+masked'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE10_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type12_enum.rb

@@ -0,0 +1,35 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains information about the payment type.
+  class Type12Enum
+    TYPE12_ENUM = [
+      # TODO: Write general description for ENUM_CARDPLAIN
+      ENUM_CARDPLAIN = 'card/plain'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORK
+      ENUM_CARDNETWORK = 'card/network'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKEN
+      ENUM_CARDNETWORKTOKEN = 'card/networkToken'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKENAPPLEPAY
+      ENUM_CARDNETWORKTOKENAPPLEPAY = 'card/networkToken+applepay'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKENGOOGLEPAY
+      ENUM_CARDNETWORKTOKENGOOGLEPAY = 'card/networkToken+googlepay'.freeze,
+
+      # TODO: Write general description for ENUM_CARDPLAINMASKED
+      ENUM_CARDPLAINMASKED = 'card/plain+masked'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE12_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type1_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Type1.
+  class Type1Enum
+    TYPE1_ENUM = [
+      # TODO: Write general description for AVS
+      AVS = 'avs'.freeze,
+
+      # TODO: Write general description for CVC
+      CVC = 'cvc'.freeze,
+
+      # TODO: Write general description for RISKPROFILE
+      RISKPROFILE = 'riskProfile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type2_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The type of applied exemption.
+  class Type2Enum
+    TYPE2_ENUM = [
+      # TODO: Write general description for LOWRISK
+      LOWRISK = 'lowRisk'.freeze,
+
+      # TODO: Write general description for LOWVALUE
+      LOWVALUE = 'lowValue'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE2_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type3_enum.rb

@@ -0,0 +1,20 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The type of instrument.
+  class Type3Enum
+    TYPE3_ENUM = [
+      # TODO: Write general description for PLAIN
+      PLAIN = 'plain'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE3_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type4_enum.rb

@@ -0,0 +1,20 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # type4.
+  class Type4Enum
+    TYPE4_ENUM = [
+      # TODO: Write general description for CARDONFILE
+      CARDONFILE = 'cardOnFile'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE4_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type5_enum.rb

@@ -0,0 +1,41 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Specifies the type of the funds transfer. {% admonition type="warning"
+  # name="Note" %} You may only submit the `fundsTransfer.type` values that
+  # relate to the use cases that you have been approved for by the schemes.{%
+  # /admonition %}
+  class Type5Enum
+    TYPE5_ENUM = [
+      # TODO: Write general description for ACCOUNTTOACCOUNT
+      ACCOUNTTOACCOUNT = 'accountToAccount'.freeze,
+
+      # TODO: Write general description for CASH
+      CASH = 'cash'.freeze,
+
+      # TODO: Write general description for DISBURSEMENT
+      DISBURSEMENT = 'disbursement'.freeze,
+
+      # TODO: Write general description for PERSONTOPERSON
+      PERSONTOPERSON = 'personToPerson'.freeze,
+
+      # TODO: Write general description for PURCHASE
+      PURCHASE = 'purchase'.freeze,
+
+      # TODO: Write general description for TOPUP
+      TOPUP = 'topUp'.freeze,
+
+      # TODO: Write general description for WALLETLOAD
+      WALLETLOAD = 'walletLoad'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE5_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type6_enum.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Type6.
+  class Type6Enum
+    TYPE6_ENUM = [
+      # TODO: Write general description for WALLET
+      WALLET = 'wallet'.freeze,
+
+      # TODO: Write general description for STOREDVALUEWALLET
+      STOREDVALUEWALLET = 'storedValueWallet'.freeze,
+
+      # TODO: Write general description for STAGEDDIGITALWALLET
+      STAGEDDIGITALWALLET = 'stagedDigitalWallet'.freeze,
+
+      # TODO: Write general description for MERCHANTWALLET
+      MERCHANTWALLET = 'merchantWallet'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE6_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type7_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Type7.
+  class Type7Enum
+    TYPE7_ENUM = [
+      # TODO: Write general description for FULLSETTLEMENT
+      FULLSETTLEMENT = 'fullSettlement'.freeze,
+
+      # TODO: Write general description for PARTIALSETTLEMENT
+      PARTIALSETTLEMENT = 'partialSettlement'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE7_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type8_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Type8.
+  class Type8Enum
+    TYPE8_ENUM = [
+      # TODO: Write general description for FULLREFUND
+      FULLREFUND = 'fullRefund'.freeze,
+
+      # TODO: Write general description for PARTIALREFUND
+      PARTIALREFUND = 'partialRefund'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE8_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type9_enum.rb

@@ -0,0 +1,35 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The type of payment instrument supplied in the authorization request.
+  class Type9Enum
+    TYPE9_ENUM = [
+      # TODO: Write general description for ENUM_CARDPLAIN
+      ENUM_CARDPLAIN = 'card/plain'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORK
+      ENUM_CARDNETWORK = 'card/network'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKEN
+      ENUM_CARDNETWORKTOKEN = 'card/networkToken'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKENAPPLEPAY
+      ENUM_CARDNETWORKTOKENAPPLEPAY = 'card/networkToken+applepay'.freeze,
+
+      # TODO: Write general description for ENUM_CARDNETWORKTOKENGOOGLEPAY
+      ENUM_CARDNETWORKTOKENGOOGLEPAY = 'card/networkToken+googlepay'.freeze,
+
+      # TODO: Write general description for ENUM_CARDPLAINMASKED
+      ENUM_CARDPLAINMASKED = 'card/plain+masked'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE9_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/type_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Type.
+  class TypeEnum
+    TYPE_ENUM = [
+      # TODO: Write general description for ENUM_CARDPLAIN
+      ENUM_CARDPLAIN = 'card/plain'.freeze,
+
+      # TODO: Write general description for ENUM_CARDPLAINMASKED
+      ENUM_CARDPLAINMASKED = 'card/plain+masked'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/unsuccessful_authentication_response.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # UnsuccessfulAuthenticationResponse Model.
+  class UnsuccessfulAuthenticationResponse < DeviceDataResponse201
+    # Object that contains authentication related information.
+    # @return [Authentication]
+    attr_accessor :authentication
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authentication'] = 'authentication'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        authentication
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(authentication = SKIP, outcome = '3dsAuthenticationFailed',
+                   transaction_reference = SKIP)
+      @authentication = authentication unless authentication == SKIP
+
+      # Call the constructor of the base class
+      super(outcome,
+            transaction_reference)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      authentication = Authentication.from_hash(hash['authentication']) if hash['authentication']
+      outcome = hash['outcome'] ||= '3dsAuthenticationFailed'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      UnsuccessfulAuthenticationResponse.new(authentication,
+                                             outcome,
+                                             transaction_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, authentication: #{@authentication}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, authentication: #{@authentication.inspect}>"
+    end
+  end
+end