hamza-payments-query-sdk 1.0.0

data/lib/payments/models/embedded1.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Embedded1 Model.
+  class Embedded1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Array of payments.
+    # @return [Array[Payment1]]
+    attr_accessor :payments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payments'] = 'payments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payments
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payments = SKIP)
+      @payments = payments unless payments == 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.
+      # Parameter is an array, so we need to iterate through it
+      payments = nil
+      unless hash['payments'].nil?
+        payments = []
+        hash['payments'].each do |structure|
+          payments << (Payment1.from_hash(structure) if structure)
+        end
+      end
+
+      payments = SKIP unless hash.key?('payments')
+
+      # Create object from extracted values.
+      Embedded1.new(payments)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payments: #{@payments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} payments: #{@payments.inspect}>"
+    end
+  end
+end

data/lib/payments/models/error.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # All Failed events return error object with name and message.
+  class Error < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Example values are,
+    # @return [NameEnum]
+    attr_accessor :name
+
+    # Example values are,
+    # @return [MessageEnum]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, message = SKIP)
+      @name = name unless name == SKIP
+      @message = message unless 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      Error.new(name,
+                message)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Error | 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} name: #{@name}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, message: #{@message.inspect}>"
+    end
+  end
+end

data/lib/payments/models/exemption.rb

@@ -0,0 +1,106 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object used to request or specify an SCA Exemption.  Read more on how to
+  # set it up under our [__SCA
+  # Exemptions__](/products/payments/enable-features/sca-exemptions) guide.
+  class Exemption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Ask for an SCA exemption recommendation directly from Worldpay
+    # (integrated) or use a 3rd party TRA solution.<br>__Note:__ Only type
+    # `integrated` is supported for now.
+    # @return [String]
+    attr_reader :type
+
+    # Specify which transactions to request SCA Exemptions for.
+    # @return [String]
+    attr_reader :mode
+
+    # Indicates whether the exemption requested from Worldpay can return a
+    # placement of authorization (payment) and/or authentication
+    # (3DS).<br>__Note:__ Only exemptions in authorization are supported for
+    # now.
+    # @return [String]
+    attr_reader :capability
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['mode'] = 'mode'
+      @_hash['capability'] = 'capability'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize
+      @type = 'integrated'
+      @mode = 'always'
+      @capability = 'authorizationOnly'
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+
+
+      # Create object from extracted values.
+      Exemption.new
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Exemption | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.mode,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.capability,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['mode'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['capability'],
+                                ->(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} type: #{@type}, mode: #{@mode}, capability: #{@capability}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, mode: #{@mode.inspect}, capability:"\
+      " #{@capability.inspect}>"
+    end
+  end
+end

data/lib/payments/models/expiry_date.rb

@@ -0,0 +1,90 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains your customer's card or token expiry date.
+  class ExpiryDate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :year
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :month
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['year'] = 'year'
+      @_hash['month'] = 'month'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(year = nil, month = nil)
+      @year = year
+      @month = month
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      year = Number.from_hash(hash['year']) if hash['year']
+      month = Number.from_hash(hash['month']) if hash['month']
+
+      # Create object from extracted values.
+      ExpiryDate.new(year,
+                     month)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExpiryDate | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.year,
+                                ->(val) { val.instance_of? Integer }) and
+            APIHelper.valid_type?(value.month,
+                                  ->(val) { val.instance_of? Integer })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['year'],
+                              ->(val) { val.instance_of? Integer }) and
+          APIHelper.valid_type?(value['month'],
+                                ->(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} year: #{@year}, month: #{@month}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} year: #{@year.inspect}, month: #{@month.inspect}>"
+    end
+  end
+end

data/lib/payments/models/expiry_date1.rb

@@ -0,0 +1,84 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The expiry date of the card or network token (where the supplied
+  # paymentInstrument was `card/wallet+applepay`, `card/wallet+googlepay`,
+  # `card/networkToken`, `card/networkToken+applepay` or
+  # `card/networkToken+googlepay`).
+  class ExpiryDate1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :month
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['month'] = 'month'
+      @_hash['year'] = 'year'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        month
+        year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(month = SKIP, year = SKIP)
+      @month = month unless month == SKIP
+      @year = year unless year == 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.
+      month = Number.from_hash(hash['month']) if hash['month']
+      year = Number.from_hash(hash['year']) if hash['year']
+
+      # Create object from extracted values.
+      ExpiryDate1.new(month,
+                      year)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ExpiryDate1 | 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} month: #{@month}, year: #{@year}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} month: #{@month.inspect}, year: #{@year.inspect}>"
+    end
+  end
+end

data/lib/payments/models/fraud.rb

@@ -0,0 +1,73 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Details of the outcome of the Fraud assessment
+  class Fraud < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # outcome of the fraud assessment. `highRisk` outcomes stop the transaction
+    # before payment.
+    # @return [Outcome6Enum]
+    attr_accessor :outcome
+
+    # The score calculated by the fraud assessment, set score thresholds are
+    # used to define lowRisk, highRisk and review outcomes
+    # @return [Float]
+    attr_accessor :score
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outcome'] = 'outcome'
+      @_hash['score'] = 'score'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outcome
+        score
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outcome = SKIP, score = SKIP)
+      @outcome = outcome unless outcome == SKIP
+      @score = score unless score == 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.
+      outcome = hash.key?('outcome') ? hash['outcome'] : SKIP
+      score = hash.key?('score') ? hash['score'] : SKIP
+
+      # Create object from extracted values.
+      Fraud.new(outcome,
+                score)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome}, score: #{@score}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome.inspect}, score: #{@score.inspect}>"
+    end
+  end
+end

data/lib/payments/models/fraud_high_risk_response.rb

@@ -0,0 +1,88 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_response202'
+
+module Payments
+  # FraudHighRiskResponse Model.
+  class FraudHighRiskResponse < PaymentsResponse202
+    # Percentage assessment score for the transaction. Higher the value the
+    # greater the assessed risk. The outcome value is based on the thresholds
+    # configured using this score.
+    # @return [Float]
+    attr_accessor :score
+
+    # Short description of the reason for the outcome. A reason can be returned
+    # for any 'outcome', even lowRisk.
+    # @return [Array[String]]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['score'] = 'score'
+      @_hash['reason'] = 'reason'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        score
+        reason
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(score = SKIP, reason = SKIP, outcome = 'fraudHighRisk',
+                   transaction_reference = SKIP)
+      @score = score unless score == SKIP
+      @reason = reason unless reason == 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.
+      score = hash.key?('score') ? hash['score'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      outcome = hash['outcome'] ||= 'fraudHighRisk'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      FraudHighRiskResponse.new(score,
+                                reason,
+                                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}, score: #{@score}, reason: #{@reason}>"
+    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}, score: #{@score.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/payments/models/funding_type_enum.rb

@@ -0,0 +1,32 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # How the card is funded.
+  class FundingTypeEnum
+    FUNDING_TYPE_ENUM = [
+      # TODO: Write general description for CREDIT
+      CREDIT = 'credit'.freeze,
+
+      # TODO: Write general description for DEBIT
+      DEBIT = 'debit'.freeze,
+
+      # TODO: Write general description for PREPAID
+      PREPAID = 'prepaid'.freeze,
+
+      # TODO: Write general description for CHARGECARD
+      CHARGECARD = 'chargeCard'.freeze,
+
+      # TODO: Write general description for DEFERREDDEBIT
+      DEFERREDDEBIT = 'deferredDebit'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      FUNDING_TYPE_ENUM.include?(value)
+    end
+  end
+end