hamza-payments-query-sdk 1.0.0

data/lib/payments/models/narrative1.rb

@@ -0,0 +1,87 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The text that appears on your customer's statement. Used to identify the
+  # merchant.
+  class Narrative1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The first line of the narrative which appears on your customer's statement
+    # (24 characters max. If character is not supported it is replaced with a
+    # space).
+    # @return [String]
+    attr_accessor :line1
+
+    # Additional details about the payment e.g. order number, telephone number.
+    # @return [String]
+    attr_accessor :line2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1 = nil, line2 = SKIP)
+      @line1 = line1
+      @line2 = line2 unless line2 == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : nil
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+
+      # Create object from extracted values.
+      Narrative1.new(line1,
+                     line2)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Narrative1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.line1,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['line1'],
+                            ->(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} line1: #{@line1}, line2: #{@line2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}>"
+    end
+  end
+end

data/lib/payments/models/narrative2.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains identification and further details of the merchant.
+  class Narrative2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # First line of text that appears on your customer's statement.
+    # @return [String]
+    attr_accessor :line1
+
+    # Second line of text that appears on your customer's statement.
+    # @return [String]
+    attr_accessor :line2
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['line1'] = 'line1'
+      @_hash['line2'] = 'line2'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        line1
+        line2
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(line1 = SKIP, line2 = SKIP)
+      @line1 = line1 unless line1 == SKIP
+      @line2 = line2 unless line2 == 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.
+      line1 = hash.key?('line1') ? hash['line1'] : SKIP
+      line2 = hash.key?('line2') ? hash['line2'] : SKIP
+
+      # Create object from extracted values.
+      Narrative2.new(line1,
+                     line2)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1}, line2: #{@line2}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} line1: #{@line1.inspect}, line2: #{@line2.inspect}>"
+    end
+  end
+end

data/lib/payments/models/number.rb

@@ -0,0 +1,85 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains information about the card number.
+  class Number < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The card BIN (Bank Identification Number) is the first 6 or 8 digits of
+    # the card number, and can be used to identify the card issuer, the card
+    # brand(s) (eg Visa, Cartes Bancaires), and the country. Card BINs are used
+    # to route transactions, check card capabilities, and in fraud assessments.
+    # @return [String]
+    attr_accessor :card_bin
+
+    # The last four digits of the card. Some characters may be obfuscated with a
+    # `*` if the PAN length is less than 16 characters.
+    # @return [String]
+    attr_accessor :last4_digits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_bin'] = 'cardBin'
+      @_hash['last4_digits'] = 'last4Digits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_bin
+        last4_digits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_bin = SKIP, last4_digits = SKIP)
+      @card_bin = card_bin unless card_bin == SKIP
+      @last4_digits = last4_digits unless last4_digits == 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.
+      card_bin = hash.key?('cardBin') ? hash['cardBin'] : SKIP
+      last4_digits = hash.key?('last4Digits') ? hash['last4Digits'] : SKIP
+
+      # Create object from extracted values.
+      Number.new(card_bin,
+                 last4_digits)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Number | 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} card_bin: #{@card_bin}, last4_digits: #{@last4_digits}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_bin: #{@card_bin.inspect}, last4_digits: #{@last4_digits.inspect}>"
+    end
+  end
+end

data/lib/payments/models/number3.rb

@@ -0,0 +1,62 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains information about the card number.
+  class Number3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # last4Digits of the card number used.
+    # @return [String]
+    attr_accessor :last4_digits
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last4_digits'] = 'last4Digits'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last4_digits
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last4_digits = SKIP)
+      @last4_digits = last4_digits unless last4_digits == 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.
+      last4_digits = hash.key?('last4Digits') ? hash['last4Digits'] : SKIP
+
+      # Create object from extracted values.
+      Number3.new(last4_digits)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last4_digits: #{@last4_digits}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last4_digits: #{@last4_digits.inspect}>"
+    end
+  end
+end

data/lib/payments/models/outcome16_enum.rb

@@ -0,0 +1,21 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Outcome of the event. For every requested event there can be a successful or
+  # refused event outcome.
+  class Outcome16Enum
+    OUTCOME16_ENUM = [
+      # TODO: Write general description for AUTHORIZED
+      AUTHORIZED = 'authorized'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTCOME16_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/outcome17_enum.rb

@@ -0,0 +1,21 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Outcome of the event. For every requested event there can be a successful or
+  # refused event outcome.
+  class Outcome17Enum
+    OUTCOME17_ENUM = [
+      # TODO: Write general description for REFUSED
+      REFUSED = 'refused'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTCOME17_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/outcome6_enum.rb

@@ -0,0 +1,42 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # outcome of the fraud assessment. `highRisk` outcomes stop the transaction
+  # before payment.
+  class Outcome6Enum
+    OUTCOME6_ENUM = [
+      # TODO: Write general description for LOWRISK
+      LOWRISK = 'lowRisk'.freeze,
+
+      # TODO: Write general description for HIGHRISK
+      HIGHRISK = 'highRisk'.freeze,
+
+      # TODO: Write general description for REVIEW
+      REVIEW = 'review'.freeze,
+
+      # TODO: Write general description for ERROR
+      ERROR = 'error'.freeze,
+
+      # TODO: Write general description for ENUM_LOWRISKSILENTMODE
+      ENUM_LOWRISKSILENTMODE = 'lowRisk(silentMode)'.freeze,
+
+      # TODO: Write general description for ENUM_HIGHRISKSILENTMODE
+      ENUM_HIGHRISKSILENTMODE = 'highRisk(silentMode)'.freeze,
+
+      # TODO: Write general description for ENUM_REVIEWSILENTMODE
+      ENUM_REVIEWSILENTMODE = 'review(silentMode)'.freeze,
+
+      # TODO: Write general description for ENUM_ERRORSILENTMODE
+      ENUM_ERRORSILENTMODE = 'error(silentMode)'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTCOME6_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/outcome7_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # If the request was authenticated successfully or an authentication outage
+  # exemption was applied in authorization. See details on [Authentication
+  # Outage](/products/payments/enable-features/3ds-authentication#how-to-enable-
+  # authentication-outage-exemptions)
+  class Outcome7Enum
+    OUTCOME7_ENUM = [
+      # TODO: Write general description for AUTHENTICATED
+      AUTHENTICATED = 'authenticated'.freeze,
+
+      # TODO: Write general description for AUTHENTICATIONOUTAGE
+      AUTHENTICATIONOUTAGE = 'authenticationOutage'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTCOME7_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/outcome_enum.rb

@@ -0,0 +1,50 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Outcome.
+  class OutcomeEnum
+    OUTCOME_ENUM = [
+      # TODO: Write general description for ENUM_3DSDEVICEDATAREQUIRED
+      ENUM_3DSDEVICEDATAREQUIRED = '3dsDeviceDataRequired'.freeze,
+
+      # TODO: Write general description for AUTHORIZED
+      AUTHORIZED = 'authorized'.freeze,
+
+      # TODO: Write general description for ENUM_3DSCHALLENGED
+      ENUM_3DSCHALLENGED = '3dsChallenged'.freeze,
+
+      # TODO: Write general description for SENTFORSETTLEMENT
+      SENTFORSETTLEMENT = 'sentForSettlement'.freeze,
+
+      # TODO: Write general description for SENTFORCANCELLATION
+      SENTFORCANCELLATION = 'sentForCancellation'.freeze,
+
+      # TODO: Write general description for REFUSED
+      REFUSED = 'refused'.freeze,
+
+      # TODO: Write general description for ENUM_3DSAUTHENTICATIONFAILED
+      ENUM_3DSAUTHENTICATIONFAILED = '3dsAuthenticationFailed'.freeze,
+
+      # TODO: Write general description for ENUM_3DSUNAVAILABLE
+      ENUM_3DSUNAVAILABLE = '3dsUnavailable'.freeze,
+
+      # TODO: Write general description for FRAUDHIGHRISK
+      FRAUDHIGHRISK = 'fraudHighRisk'.freeze,
+
+      # TODO: Write general description for SENTFORREFUND
+      SENTFORREFUND = 'sentForRefund'.freeze,
+
+      # TODO: Write general description for SENTFORPARTIALREFUND
+      SENTFORPARTIALREFUND = 'sentForPartialRefund'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      OUTCOME_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/partial_refund_action_list.rb

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

data/lib/payments/models/partial_refund_response.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PartialRefundResponse Model.
+  class PartialRefundResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [OutcomeEnum]
+    attr_accessor :outcome
+
+    # Return details about the status of the payment
+    # @return [PaymentsLink]
+    attr_accessor :links
+
+    # Return details about the status of the payment
+    # @return [PartialRefundActionList]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outcome'] = 'outcome'
+      @_hash['links'] = '_links'
+      @_hash['actions'] = '_actions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outcome
+        links
+        actions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outcome = SKIP, links = SKIP, actions = SKIP)
+      @outcome = outcome unless outcome == SKIP
+      @links = links unless links == SKIP
+      @actions = actions unless actions == 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
+      links = PaymentsLink.from_hash(hash['_links']) if hash['_links']
+      actions = PartialRefundActionList.from_hash(hash['_actions']) if hash['_actions']
+
+      # Create object from extracted values.
+      PartialRefundResponse.new(outcome,
+                                links,
+                                actions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome}, links: #{@links}, actions: #{@actions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} outcome: #{@outcome.inspect}, links: #{@links.inspect}, actions:"\
+      " #{@actions.inspect}>"
+    end
+  end
+end