hamza-payments-query-sdk 1.0.0

data/lib/payments/models/self2.rb

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

data/lib/payments/models/self3.rb

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

data/lib/payments/models/sent_for_cancellation_response.rb

@@ -0,0 +1,185 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # SentForCancellationResponse Model.
+  class SentForCancellationResponse < 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
+
+    # 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 = 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
+      ]
+      (_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, outcome = 'sentForCancellation',
+                   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
+
+      # 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']
+      outcome = hash['outcome'] ||= 'sentForCancellation'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      SentForCancellationResponse.new(payment_instrument,
+                                      updated_payment_instrument,
+                                      issuer,
+                                      risk_factors,
+                                      fraud,
+                                      three_ds,
+                                      exemption,
+                                      scheme_reference,
+                                      token,
+                                      links,
+                                      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}>"
+    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}>"
+    end
+  end
+end

data/lib/payments/models/sent_for_settlement_action_list.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # SentForSettlementActionList Model.
+  class SentForSettlementActionList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Fully refund the payment. See [details](../payments-lifecycle/refund)
+    # @return [PaymentsActionRefund]
+    attr_accessor :refund_payment
+
+    # 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['refund_payment'] = 'refundPayment'
+      @_hash['partially_refund_payment'] = 'partiallyRefundPayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        refund_payment
+        partially_refund_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(refund_payment = SKIP, partially_refund_payment = SKIP)
+      @refund_payment = refund_payment unless 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.
+      refund_payment = PaymentsActionRefund.from_hash(hash['refundPayment']) if
+        hash['refundPayment']
+      if hash['partiallyRefundPayment']
+        partially_refund_payment = PaymentsActionPartialRefund.from_hash(hash['partiallyRefundPayment'])
+      end
+
+      # Create object from extracted values.
+      SentForSettlementActionList.new(refund_payment,
+                                      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} refund_payment: #{@refund_payment}, 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} refund_payment: #{@refund_payment.inspect}, partially_refund_payment:"\
+      " #{@partially_refund_payment.inspect}>"
+    end
+  end
+end

data/lib/payments/models/sent_for_settlement_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
+  # SentForSettlementResponse Model.
+  class SentForSettlementResponse < 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 [SentForSettlementActionList]
+    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 = 'sentForSettlement', 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 = SentForSettlementActionList.from_hash(hash['_actions']) if hash['_actions']
+      outcome = hash['outcome'] ||= 'sentForSettlement'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      SentForSettlementResponse.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/session_payment_instrument.rb

@@ -0,0 +1,119 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_payment_instrument'
+
+module Payments
+  # SessionPaymentInstrument Model.
+  class SessionPaymentInstrument < PaymentsPaymentInstrument
+    # An http address that contains your Checkout session providing the card
+    # details.
+    # @return [String]
+    attr_accessor :session_href
+
+    # The name on your customer's card. Required if  instruction.tokenCreation
+    # is present. However we recommend that you supply this to improve
+    # authentication rates.
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # An object containing specific routing preferences.
+    # @return [Routing]
+    attr_accessor :routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['session_href'] = 'sessionHref'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['routing'] = 'routing'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        card_holder_name
+        billing_address
+        routing
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(session_href = nil, card_holder_name = SKIP,
+                   billing_address = SKIP, routing = SKIP, type = 'checkout')
+      @session_href = session_href
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @routing = routing unless routing == SKIP
+
+      # Call the constructor of the base class
+      super(type)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      session_href = hash.key?('sessionHref') ? hash['sessionHref'] : nil
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+      routing = Routing.from_hash(hash['routing']) if hash['routing']
+      type = hash['type'] ||= 'checkout'
+
+      # Create object from extracted values.
+      SessionPaymentInstrument.new(session_href,
+                                   card_holder_name,
+                                   billing_address,
+                                   routing,
+                                   type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [SessionPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.session_href,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['sessionHref'],
+                            ->(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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, session_href: #{@session_href}, card_holder_name:"\
+      " #{@card_holder_name}, billing_address: #{@billing_address}, routing: #{@routing}>"
+    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}, session_href: #{@session_href.inspect}, card_holder_name:"\
+      " #{@card_holder_name.inspect}, billing_address: #{@billing_address.inspect}, routing:"\
+      " #{@routing.inspect}>"
+    end
+  end
+end