hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_unscheduled_customer_agreement.rb

@@ -0,0 +1,87 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_customer_agreement'
+
+module Payments
+  # PaymentsUnscheduledCustomerAgreement Model.
+  class PaymentsUnscheduledCustomerAgreement < PaymentsCustomerAgreement
+    # Unique reference provided by card schemes used to link the `first` and
+    # `subsequent` payments. This value is bundled with the Worldpay token if
+    # created as part of the `first` payment and therefore not required here as
+    # well. If you manage multiple agreements for a single cardholder using a
+    # token, please use the `schemeReference` returned to you. This allows you
+    # to distinguish and manage each separate agreement appropriately.
+    # @return [String]
+    attr_accessor :scheme_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_reference'] = 'schemeReference'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        scheme_reference
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(scheme_reference = SKIP, type = 'unscheduled')
+      @scheme_reference = scheme_reference unless scheme_reference == 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.
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+      type = hash['type'] ||= 'unscheduled'
+
+      # Create object from extracted values.
+      PaymentsUnscheduledCustomerAgreement.new(scheme_reference,
+                                               type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsUnscheduledCustomerAgreement | 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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, scheme_reference: #{@scheme_reference}>"
+    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}, scheme_reference: #{@scheme_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_wallet_account.rb

@@ -0,0 +1,70 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_recipient_account'
+
+module Payments
+  # PaymentsWalletAccount Model.
+  class PaymentsWalletAccount < PaymentsRecipientAccount
+    # A reference identifying the destination wallet.
+    # @return [String]
+    attr_accessor :wallet_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['wallet_reference'] = 'walletReference'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(wallet_reference = nil, type = 'merchantWallet')
+      @wallet_reference = wallet_reference
+
+      # 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.
+      wallet_reference =
+        hash.key?('walletReference') ? hash['walletReference'] : nil
+      type = hash['type'] ||= 'merchantWallet'
+
+      # Create object from extracted values.
+      PaymentsWalletAccount.new(wallet_reference,
+                                type)
+    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}, wallet_reference: #{@wallet_reference}>"
+    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}, wallet_reference: #{@wallet_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/placement_enum.rb

@@ -0,0 +1,21 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Indicates whether the exemption has been placed in a payment authorization
+  # request or 3DS authentication request.
+  class PlacementEnum
+    PLACEMENT_ENUM = [
+      # TODO: Write general description for AUTHORIZATION
+      AUTHORIZATION = 'authorization'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PLACEMENT_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/pq_querybydaterange200_response.rb

@@ -0,0 +1,68 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PqQuerybydaterange200Response Model.
+  class PqQuerybydaterange200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # links to the pages.
+    # @return [Links1]
+    attr_accessor :links
+
+    # links to the pages.
+    # @return [Embedded]
+    attr_accessor :embedded
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['links'] = '_links'
+      @_hash['embedded'] = '_embedded'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(links = nil, embedded = nil)
+      @links = links
+      @embedded = embedded
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      links = Links1.from_hash(hash['_links']) if hash['_links']
+      embedded = Embedded.from_hash(hash['_embedded']) if hash['_embedded']
+
+      # Create object from extracted values.
+      PqQuerybydaterange200Response.new(links,
+                                        embedded)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links}, embedded: #{@embedded}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links.inspect}, embedded: #{@embedded.inspect}>"
+    end
+  end
+end

data/lib/payments/models/pq_querybypaymentid200_response.rb

@@ -0,0 +1,230 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PqQuerybypaymentid200Response Model.
+  class PqQuerybypaymentid200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment initial authorization time.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single payment. Generated at
+    # authorization, and maintained through successive payment actions.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # A unique reference generated by you, used to identify a payment throughout
+    # its lifecycle.
+    # @return [String]
+    attr_accessor :transaction_reference
+
+    # The text that appears on your customer's statement. Used to identify the
+    # merchant.
+    # @return [Narrative1]
+    attr_accessor :narrative
+
+    # The transaction type of the payment.
+    # @return [TransactionTypeEnum]
+    attr_accessor :transaction_type
+
+    # The authorization type of the payment.
+    # @return [AuthorizationTypeEnum]
+    attr_accessor :authorization_type
+
+    # Merchant entity name.
+    # @return [String]
+    attr_accessor :entity
+
+    # The last event received for the payment
+    # @return [LastEventEnum]
+    attr_accessor :last_event
+
+    # An object containing information returned by the card scheme.
+    # @return [Scheme]
+    attr_accessor :scheme
+
+    # An object containing information returned by the issuer.
+    # @return [Issuer1]
+    attr_accessor :issuer
+
+    # The payment instrument supplied in the authorization request.
+    # @return [PaymentInstrument4]
+    attr_accessor :payment_instrument
+
+    # The payment instrument supplied in the authorization request.
+    # @return [UpdatedPaymentInstrument1]
+    attr_accessor :updated_payment_instrument
+
+    # An object that contains payment amount and currency.
+    # @return [Value4]
+    attr_accessor :value
+
+    # An array that contains the history of events of a payment.
+    # @return [Array[Object]]
+    attr_accessor :events
+
+    # Self link and next action links.
+    # @return [Links]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['payment_id'] = 'paymentId'
+      @_hash['transaction_reference'] = 'transactionReference'
+      @_hash['narrative'] = 'narrative'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['authorization_type'] = 'authorizationType'
+      @_hash['entity'] = 'entity'
+      @_hash['last_event'] = 'lastEvent'
+      @_hash['scheme'] = 'scheme'
+      @_hash['issuer'] = 'issuer'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['updated_payment_instrument'] = 'updatedPaymentInstrument'
+      @_hash['value'] = 'value'
+      @_hash['events'] = 'events'
+      @_hash['links'] = '_links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        payment_id
+        transaction_reference
+        narrative
+        transaction_type
+        authorization_type
+        entity
+        last_event
+        scheme
+        issuer
+        payment_instrument
+        updated_payment_instrument
+        value
+        events
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, payment_id = SKIP,
+                   transaction_reference = SKIP, narrative = SKIP,
+                   transaction_type = SKIP, authorization_type = SKIP,
+                   entity = SKIP, last_event = SKIP, scheme = SKIP,
+                   issuer = SKIP, payment_instrument = SKIP,
+                   updated_payment_instrument = SKIP, value = SKIP,
+                   events = SKIP, links = SKIP)
+      @timestamp = timestamp unless timestamp == SKIP
+      @payment_id = payment_id unless payment_id == SKIP
+      @transaction_reference = transaction_reference unless transaction_reference == SKIP
+      @narrative = narrative unless narrative == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @authorization_type = authorization_type unless authorization_type == SKIP
+      @entity = entity unless entity == SKIP
+      @last_event = last_event unless last_event == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      unless updated_payment_instrument == SKIP
+        @updated_payment_instrument =
+          updated_payment_instrument
+      end
+      @value = value unless value == SKIP
+      @events = events unless events == SKIP
+      @links = links unless links == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      payment_id = hash.key?('paymentId') ? hash['paymentId'] : SKIP
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+      narrative = Narrative1.from_hash(hash['narrative']) if hash['narrative']
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      authorization_type =
+        hash.key?('authorizationType') ? hash['authorizationType'] : SKIP
+      entity = hash.key?('entity') ? hash['entity'] : SKIP
+      last_event = hash.key?('lastEvent') ? hash['lastEvent'] : SKIP
+      scheme = Scheme.from_hash(hash['scheme']) if hash['scheme']
+      issuer = Issuer1.from_hash(hash['issuer']) if hash['issuer']
+      payment_instrument = PaymentInstrument4.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      if hash['updatedPaymentInstrument']
+        updated_payment_instrument = UpdatedPaymentInstrument1.from_hash(hash['updatedPaymentInstrument'])
+      end
+      value = Value4.from_hash(hash['value']) if hash['value']
+      events = hash.key?('events') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PqQuerybypaymentid200ResponseEvents), hash['events']
+      ) : SKIP
+      links = Links.from_hash(hash['_links']) if hash['_links']
+
+      # Create object from extracted values.
+      PqQuerybypaymentid200Response.new(timestamp,
+                                        payment_id,
+                                        transaction_reference,
+                                        narrative,
+                                        transaction_type,
+                                        authorization_type,
+                                        entity,
+                                        last_event,
+                                        scheme,
+                                        issuer,
+                                        payment_instrument,
+                                        updated_payment_instrument,
+                                        value,
+                                        events,
+                                        links)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PqQuerybypaymentid200Response | 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} timestamp: #{@timestamp}, payment_id: #{@payment_id},"\
+      " transaction_reference: #{@transaction_reference}, narrative: #{@narrative},"\
+      " transaction_type: #{@transaction_type}, authorization_type: #{@authorization_type},"\
+      " entity: #{@entity}, last_event: #{@last_event}, scheme: #{@scheme}, issuer: #{@issuer},"\
+      " payment_instrument: #{@payment_instrument}, updated_payment_instrument:"\
+      " #{@updated_payment_instrument}, value: #{@value}, events: #{@events}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} timestamp: #{@timestamp.inspect}, payment_id: #{@payment_id.inspect},"\
+      " transaction_reference: #{@transaction_reference.inspect}, narrative:"\
+      " #{@narrative.inspect}, transaction_type: #{@transaction_type.inspect}, authorization_type:"\
+      " #{@authorization_type.inspect}, entity: #{@entity.inspect}, last_event:"\
+      " #{@last_event.inspect}, scheme: #{@scheme.inspect}, issuer: #{@issuer.inspect},"\
+      " payment_instrument: #{@payment_instrument.inspect}, updated_payment_instrument:"\
+      " #{@updated_payment_instrument.inspect}, value: #{@value.inspect}, events:"\
+      " #{@events.inspect}, links: #{@links.inspect}>"
+    end
+  end
+end

data/lib/payments/models/pq_queryhistoricalpayments200_response.rb

@@ -0,0 +1,72 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PqQueryhistoricalpayments200Response Model.
+  class PqQueryhistoricalpayments200Response < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Self link and next action links.The Next action links are dependent on the
+    # lastEvent, refer to 'query for historical payments Response' section for
+    # more details.
+    # @return [Links3]
+    attr_accessor :links
+
+    # Self link and next action links.The Next action links are dependent on the
+    # lastEvent, refer to 'query for historical payments Response' section for
+    # more details.
+    # @return [Embedded1]
+    attr_accessor :embedded
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['links'] = '_links'
+      @_hash['embedded'] = '_embedded'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(links = nil, embedded = nil)
+      @links = links
+      @embedded = embedded
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      links = Links3.from_hash(hash['_links']) if hash['_links']
+      embedded = Embedded1.from_hash(hash['_embedded']) if hash['_embedded']
+
+      # Create object from extracted values.
+      PqQueryhistoricalpayments200Response.new(links,
+                                               embedded)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links}, embedded: #{@embedded}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links.inspect}, embedded: #{@embedded.inspect}>"
+    end
+  end
+end

data/lib/payments/models/preference_enum.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Set a preference for how the Issuer decides on a 3DS challenge.
+  class PreferenceEnum
+    PREFERENCE_ENUM = [
+      # TODO: Write general description for NOPREFERENCE
+      NOPREFERENCE = 'noPreference'.freeze,
+
+      # TODO: Write general description for NOCHALLENGEREQUESTED
+      NOCHALLENGEREQUESTED = 'noChallengeRequested'.freeze,
+
+      # TODO: Write general description for CHALLENGEREQUESTED
+      CHALLENGEREQUESTED = 'challengeRequested'.freeze,
+
+      # TODO: Write general description for CHALLENGEMANDATED
+      CHALLENGEMANDATED = 'challengeMandated'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREFERENCE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/preferred_card_brand_enum.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Specifies your customer's preferred card brand to be used for the
+  # transaction using a co-badged card.
+  class PreferredCardBrandEnum
+    PREFERRED_CARD_BRAND_ENUM = [
+      # TODO: Write general description for VISA
+      VISA = 'visa'.freeze,
+
+      # TODO: Write general description for MASTERCARD
+      MASTERCARD = 'mastercard'.freeze,
+
+      # TODO: Write general description for MAESTRO
+      MAESTRO = 'maestro'.freeze,
+
+      # TODO: Write general description for AMEX
+      AMEX = 'amex'.freeze,
+
+      # TODO: Write general description for CARTESBANCAIRES
+      CARTESBANCAIRES = 'cartesBancaires'.freeze,
+
+      # TODO: Write general description for DINERS
+      DINERS = 'diners'.freeze,
+
+      # TODO: Write general description for DANKORT
+      DANKORT = 'dankort'.freeze,
+
+      # TODO: Write general description for JCB
+      JCB = 'jcb'.freeze,
+
+      # TODO: Write general description for DISCOVER
+      DISCOVER = 'discover'.freeze,
+
+      # TODO: Write general description for ELO
+      ELO = 'elo'.freeze,
+
+      # TODO: Write general description for EFTPOSAU
+      EFTPOSAU = 'eftposAU'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PREFERRED_CARD_BRAND_ENUM.include?(value)
+    end
+  end
+end