hamza-payments-query-sdk 1.0.0

data/lib/payments/models/card1.rb

@@ -0,0 +1,106 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains information about the card used.
+  class Card1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object that contains information about the card number.
+    # @return [Number]
+    attr_accessor :number
+
+    # 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`).
+    # @return [ExpiryDate1]
+    attr_accessor :expiry_date
+
+    # How the card is funded.
+    # @return [FundingTypeEnum]
+    attr_accessor :funding_type
+
+    # The card brand that the transaction was processed with. Sometimes referred
+    # to as the network or scheme.
+    # @return [String]
+    attr_accessor :brand
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['funding_type'] = 'fundingType'
+      @_hash['brand'] = 'brand'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        expiry_date
+        funding_type
+        brand
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, expiry_date = SKIP, funding_type = SKIP,
+                   brand = SKIP)
+      @number = number unless number == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @funding_type = funding_type unless funding_type == SKIP
+      @brand = brand unless brand == 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.
+      number = Number.from_hash(hash['number']) if hash['number']
+      expiry_date = ExpiryDate1.from_hash(hash['expiryDate']) if hash['expiryDate']
+      funding_type = hash.key?('fundingType') ? hash['fundingType'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+
+      # Create object from extracted values.
+      Card1.new(number,
+                expiry_date,
+                funding_type,
+                brand)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Card1 | 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} number: #{@number}, expiry_date: #{@expiry_date}, funding_type:"\
+      " #{@funding_type}, brand: #{@brand}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, expiry_date: #{@expiry_date.inspect},"\
+      " funding_type: #{@funding_type.inspect}, brand: #{@brand.inspect}>"
+    end
+  end
+end

data/lib/payments/models/card3.rb

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

data/lib/payments/models/card_authorized_payment_response.rb

@@ -0,0 +1,195 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # CardAuthorizedPaymentResponse Model.
+  class CardAuthorizedPaymentResponse < DeviceDataResponse201
+    # TODO: Write general description for this method
+    # @return [PaymentsResponsePaymentInstrument]
+    attr_accessor :payment_instrument
+
+    # Details of the updated payment instrument.
+    # @return [UpdatedPaymentInstrument]
+    attr_accessor :updated_payment_instrument
+
+    # An object containing information returned by the issuer.
+    # @return [Issuer]
+    attr_accessor :issuer
+
+    # Any risk factors which have been identified for the authorization. This
+    # section will not appear if no risks are identified.
+    # @return [Array[RiskFactor]]
+    attr_accessor :risk_factors
+
+    # Details of the outcome of the Fraud assessment
+    # @return [Fraud]
+    attr_accessor :fraud
+
+    # Details of the outcome of the 3DS authentication
+    # @return [Verification]
+    attr_accessor :three_ds
+
+    # An object containing information about the exemption.
+    # @return [PaymentsExemption]
+    attr_accessor :exemption
+
+    # An object containing information returned by the scheme.
+    # @return [String]
+    attr_accessor :scheme_reference
+
+    # Details of the token created
+    # @return [Token]
+    attr_accessor :token
+
+    # Return details about the status of the payment
+    # @return [PaymentsLink]
+    attr_accessor :links
+
+    # Return details about the status of the payment
+    # @return [AuthorizationActionList]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['updated_payment_instrument'] = 'updatedPaymentInstrument'
+      @_hash['issuer'] = 'issuer'
+      @_hash['risk_factors'] = 'riskFactors'
+      @_hash['fraud'] = 'fraud'
+      @_hash['three_ds'] = 'threeDS'
+      @_hash['exemption'] = 'exemption'
+      @_hash['scheme_reference'] = 'schemeReference'
+      @_hash['token'] = 'token'
+      @_hash['links'] = '_links'
+      @_hash['actions'] = '_actions'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        payment_instrument
+        updated_payment_instrument
+        issuer
+        risk_factors
+        fraud
+        three_ds
+        exemption
+        scheme_reference
+        token
+        links
+        actions
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(payment_instrument = SKIP, updated_payment_instrument = SKIP,
+                   issuer = SKIP, risk_factors = SKIP, fraud = SKIP,
+                   three_ds = SKIP, exemption = SKIP, scheme_reference = SKIP,
+                   token = SKIP, links = SKIP, actions = SKIP,
+                   outcome = 'authorized', transaction_reference = SKIP)
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      unless updated_payment_instrument == SKIP
+        @updated_payment_instrument =
+          updated_payment_instrument
+      end
+      @issuer = issuer unless issuer == SKIP
+      @risk_factors = risk_factors unless risk_factors == SKIP
+      @fraud = fraud unless fraud == SKIP
+      @three_ds = three_ds unless three_ds == SKIP
+      @exemption = exemption unless exemption == SKIP
+      @scheme_reference = scheme_reference unless scheme_reference == SKIP
+      @token = token unless token == SKIP
+      @links = links unless links == SKIP
+      @actions = actions unless actions == 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.
+      payment_instrument = PaymentsResponsePaymentInstrument.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      if hash['updatedPaymentInstrument']
+        updated_payment_instrument = UpdatedPaymentInstrument.from_hash(hash['updatedPaymentInstrument'])
+      end
+      issuer = Issuer.from_hash(hash['issuer']) if hash['issuer']
+      # Parameter is an array, so we need to iterate through it
+      risk_factors = nil
+      unless hash['riskFactors'].nil?
+        risk_factors = []
+        hash['riskFactors'].each do |structure|
+          risk_factors << (RiskFactor.from_hash(structure) if structure)
+        end
+      end
+
+      risk_factors = SKIP unless hash.key?('riskFactors')
+      fraud = Fraud.from_hash(hash['fraud']) if hash['fraud']
+      three_ds = Verification.from_hash(hash['threeDS']) if hash['threeDS']
+      exemption = PaymentsExemption.from_hash(hash['exemption']) if hash['exemption']
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+      token = Token.from_hash(hash['token']) if hash['token']
+      links = PaymentsLink.from_hash(hash['_links']) if hash['_links']
+      actions = AuthorizationActionList.from_hash(hash['_actions']) if hash['_actions']
+      outcome = hash['outcome'] ||= 'authorized'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      CardAuthorizedPaymentResponse.new(payment_instrument,
+                                        updated_payment_instrument,
+                                        issuer,
+                                        risk_factors,
+                                        fraud,
+                                        three_ds,
+                                        exemption,
+                                        scheme_reference,
+                                        token,
+                                        links,
+                                        actions,
+                                        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}, payment_instrument: #{@payment_instrument},"\
+      " updated_payment_instrument: #{@updated_payment_instrument}, issuer: #{@issuer},"\
+      " risk_factors: #{@risk_factors}, fraud: #{@fraud}, three_ds: #{@three_ds}, exemption:"\
+      " #{@exemption}, scheme_reference: #{@scheme_reference}, token: #{@token}, links: #{@links},"\
+      " actions: #{@actions}>"
+    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}, payment_instrument: #{@payment_instrument.inspect},"\
+      " updated_payment_instrument: #{@updated_payment_instrument.inspect}, issuer:"\
+      " #{@issuer.inspect}, risk_factors: #{@risk_factors.inspect}, fraud: #{@fraud.inspect},"\
+      " three_ds: #{@three_ds.inspect}, exemption: #{@exemption.inspect}, scheme_reference:"\
+      " #{@scheme_reference.inspect}, token: #{@token.inspect}, links: #{@links.inspect}, actions:"\
+      " #{@actions.inspect}>"
+    end
+  end
+end

data/lib/payments/models/card_payment_instrument.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CardPaymentInstrument Model.
+  class CardPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['networkToken'] = PaymentsNetworkTokenPaymentInstrument
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = 'CardPaymentInstrument')
+      @type = type unless type == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['type']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      type = hash['type'] ||= 'CardPaymentInstrument'
+
+      # Create object from extracted values.
+      CardPaymentInstrument.new(type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/payments/models/card_payments_instruction.rb

@@ -0,0 +1,164 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_instruction'
+
+module Payments
+  # CardPaymentsInstruction Model.
+  class CardPaymentsInstruction < PaymentsInstruction
+    # Contains details of the funds transfer request, which is a money movement
+    # for a reason other than the purchase of goods or services (also known as
+    # Account Funding Transaction (AFT)).
+    # Read more on how to set it up under our [__Account Funding
+    # Transactions__](/products/payments/enable-features/account-funding-transac
+    # tions) guide.
+    # @return [PaymentsFundsTransfer]
+    attr_accessor :funds_transfer
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['funds_transfer'] = 'fundsTransfer'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        funds_transfer
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(payment_instrument = nil, narrative = nil, value = nil,
+                   funds_transfer = SKIP, method = 'card',
+                   token_creation = SKIP, debt_repayment = SKIP, fraud = SKIP,
+                   three_ds = SKIP, exemption = SKIP, settlement = SKIP,
+                   customer = SKIP, shipping = SKIP, customer_agreement = SKIP,
+                   recipient = SKIP, consumer_bill_payment = SKIP,
+                   request_account_updater = SKIP)
+      @funds_transfer = funds_transfer unless funds_transfer == SKIP
+
+      # Call the constructor of the base class
+      super(payment_instrument,
+            narrative,
+            value,
+            method,
+            token_creation,
+            debt_repayment,
+            fraud,
+            three_ds,
+            exemption,
+            settlement,
+            customer,
+            shipping,
+            customer_agreement,
+            recipient,
+            consumer_bill_payment,
+            request_account_updater)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_instrument = hash.key?('paymentInstrument') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument), hash['paymentInstrument']
+      ) : nil
+      narrative = Narrative.from_hash(hash['narrative']) if hash['narrative']
+      value = Value.from_hash(hash['value']) if hash['value']
+      funds_transfer = PaymentsFundsTransfer.from_hash(hash['fundsTransfer']) if
+        hash['fundsTransfer']
+      method = hash['method'] ||= 'card'
+      token_creation = TokenCreation.from_hash(hash['tokenCreation']) if hash['tokenCreation']
+      debt_repayment = hash.key?('debtRepayment') ? hash['debtRepayment'] : SKIP
+      fraud = PaymentsFraud.from_hash(hash['fraud']) if hash['fraud']
+      three_ds = PaymentsThreeDS.from_hash(hash['threeDS']) if hash['threeDS']
+      exemption = Exemption.from_hash(hash['exemption']) if hash['exemption']
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+      shipping = Shipping.from_hash(hash['shipping']) if hash['shipping']
+      customer_agreement = hash.key?('customerAgreement') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentsInstructionCustomerAgreement), hash['customerAgreement']
+      ) : SKIP
+      recipient = PaymentsRecipient.from_hash(hash['recipient']) if hash['recipient']
+      consumer_bill_payment =
+        hash.key?('consumerBillPayment') ? hash['consumerBillPayment'] : SKIP
+      request_account_updater =
+        hash.key?('requestAccountUpdater') ? hash['requestAccountUpdater'] : SKIP
+
+      # Create object from extracted values.
+      CardPaymentsInstruction.new(payment_instrument,
+                                  narrative,
+                                  value,
+                                  funds_transfer,
+                                  method,
+                                  token_creation,
+                                  debt_repayment,
+                                  fraud,
+                                  three_ds,
+                                  exemption,
+                                  settlement,
+                                  customer,
+                                  shipping,
+                                  customer_agreement,
+                                  recipient,
+                                  consumer_bill_payment,
+                                  request_account_updater)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CardPaymentsInstruction | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument)
+                         .validate(value.payment_instrument) and
+            APIHelper.valid_type?(value.narrative,
+                                  ->(val) { Narrative.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { Value.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument)
+                       .validate(value['paymentInstrument']) and
+          APIHelper.valid_type?(value['narrative'],
+                                ->(val) { Narrative.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { Value.validate(val) },
+                                is_model_hash: true)
+      )
+    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}, funds_transfer: #{@funds_transfer}>"
+    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}, funds_transfer: #{@funds_transfer.inspect}>"
+    end
+  end
+end

data/lib/payments/models/category_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Whether the card is classed as a consumer card or a card for commercial use.
+  class CategoryEnum
+    CATEGORY_ENUM = [
+      # TODO: Write general description for COMMERCIAL
+      COMMERCIAL = 'commercial'.freeze,
+
+      # TODO: Write general description for CONSUMER
+      CONSUMER = 'consumer'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CATEGORY_ENUM.include?(value)
+    end
+  end
+end