hamza-payments-query-sdk 1.0.0

data/lib/payments/models/links1.rb

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

data/lib/payments/models/links2.rb

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

data/lib/payments/models/links3.rb

@@ -0,0 +1,97 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # 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.
+  class Links3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Self link to the page.
+    # @return [Self1]
+    attr_accessor :mself
+
+    # Next action links.
+    # @return [PaymentsCancel]
+    attr_accessor :payments_cancel
+
+    # Next action links.
+    # @return [PaymentsSettle]
+    attr_accessor :payments_settle
+
+    # Next action links.
+    # @return [PaymentsPartialSettle]
+    attr_accessor :payments_partial_settle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mself'] = 'self'
+      @_hash['payments_cancel'] = 'payments:cancel'
+      @_hash['payments_settle'] = 'payments:settle'
+      @_hash['payments_partial_settle'] = 'payments:partialSettle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payments_cancel
+        payments_settle
+        payments_partial_settle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mself = nil, payments_cancel = SKIP, payments_settle = SKIP,
+                   payments_partial_settle = SKIP)
+      @mself = mself
+      @payments_cancel = payments_cancel unless payments_cancel == SKIP
+      @payments_settle = payments_settle unless payments_settle == SKIP
+      @payments_partial_settle = payments_partial_settle unless payments_partial_settle == 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.
+      mself = Self1.from_hash(hash['self']) if hash['self']
+      payments_cancel = PaymentsCancel.from_hash(hash['payments:cancel']) if
+        hash['payments:cancel']
+      payments_settle = PaymentsSettle.from_hash(hash['payments:settle']) if
+        hash['payments:settle']
+      payments_partial_settle = PaymentsPartialSettle.from_hash(hash['payments:partialSettle']) if
+        hash['payments:partialSettle']
+
+      # Create object from extracted values.
+      Links3.new(mself,
+                 payments_cancel,
+                 payments_settle,
+                 payments_partial_settle)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mself: #{@mself}, payments_cancel: #{@payments_cancel}, payments_settle:"\
+      " #{@payments_settle}, payments_partial_settle: #{@payments_partial_settle}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mself: #{@mself.inspect}, payments_cancel: #{@payments_cancel.inspect},"\
+      " payments_settle: #{@payments_settle.inspect}, payments_partial_settle:"\
+      " #{@payments_partial_settle.inspect}>"
+    end
+  end
+end

data/lib/payments/models/merchant.rb

@@ -0,0 +1,88 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains information about the merchant.
+  class Merchant < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Used to route the request in Access Worldpay, created as part of
+    # on-boarding.
+    # @return [String]
+    attr_accessor :entity
+
+    # You can apply a merchant category code (mcc) to an individual request. You
+    # can only provide an mcc if we have enabled the dynamic mcc feature during
+    # boarding. If enabled but not provided, merchant.mcc defaults to a
+    # configured value.
+    # @return [String]
+    attr_accessor :mcc
+
+    # An object containing Payment Facilitator information. This information is
+    # required for every authorization [__only if you are a Payment
+    # Facilitator__](/products/payments/enable-features/payment-facilitator)
+    # @return [PaymentsPaymentFacilitator]
+    attr_accessor :payment_facilitator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['entity'] = 'entity'
+      @_hash['mcc'] = 'mcc'
+      @_hash['payment_facilitator'] = 'paymentFacilitator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        mcc
+        payment_facilitator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(entity = nil, mcc = SKIP, payment_facilitator = SKIP)
+      @entity = entity
+      @mcc = mcc unless mcc == SKIP
+      @payment_facilitator = payment_facilitator unless payment_facilitator == 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.
+      entity = hash.key?('entity') ? hash['entity'] : nil
+      mcc = hash.key?('mcc') ? hash['mcc'] : SKIP
+      payment_facilitator = PaymentsPaymentFacilitator.from_hash(hash['paymentFacilitator']) if
+        hash['paymentFacilitator']
+
+      # Create object from extracted values.
+      Merchant.new(entity,
+                   mcc,
+                   payment_facilitator)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} entity: #{@entity}, mcc: #{@mcc}, payment_facilitator:"\
+      " #{@payment_facilitator}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} entity: #{@entity.inspect}, mcc: #{@mcc.inspect}, payment_facilitator:"\
+      " #{@payment_facilitator.inspect}>"
+    end
+  end
+end

data/lib/payments/models/message_enum.rb

@@ -0,0 +1,34 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Example values are,
+  class MessageEnum
+    MESSAGE_ENUM = [
+      # TODO: Write general description for ENUM_PAYMENT_FAILED_TO_BE_AUTHORIZED
+      ENUM_PAYMENT_FAILED_TO_BE_AUTHORIZED = 'Payment failed to be authorized'.freeze,
+
+      # TODO: Write general description for ENUM_TOKEN_IS_UNRECOGNIZED
+      ENUM_TOKEN_IS_UNRECOGNIZED = 'Token is unrecognized'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_THE_TRANSACTION_REFERENCE_IS_A_DUPLICATE
+      ENUM_THE_TRANSACTION_REFERENCE_IS_A_DUPLICATE = 'The transaction reference is a duplicate'.freeze,
+
+      # TODO: Write general description for
+      # ENUM_THE_TRANSACTION_HAS_ALREADY_BEEN_PROCESSED
+      ENUM_THE_TRANSACTION_HAS_ALREADY_BEEN_PROCESSED = 'The transaction has already been processed'.freeze,
+
+      # TODO: Write general description for ENUM_CURRENCY_NOT_SUPPORTED
+      ENUM_CURRENCY_NOT_SUPPORTED = 'Currency not supported'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MESSAGE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/method_enum.rb

@@ -0,0 +1,38 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The shipping method used.
+  class MethodEnum
+    METHOD_ENUM = [
+      # TODO: Write general description for BILLINGADDRESS
+      BILLINGADDRESS = 'billingAddress'.freeze,
+
+      # TODO: Write general description for VERIFIEDADDRESS
+      VERIFIEDADDRESS = 'verifiedAddress'.freeze,
+
+      # TODO: Write general description for OTHERADDRESS
+      OTHERADDRESS = 'otherAddress'.freeze,
+
+      # TODO: Write general description for STORE
+      STORE = 'store'.freeze,
+
+      # TODO: Write general description for DIGITAL
+      DIGITAL = 'digital'.freeze,
+
+      # TODO: Write general description for UNSHIPPEDTICKETS
+      UNSHIPPEDTICKETS = 'unshippedTickets'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      METHOD_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/mnext.rb

@@ -0,0 +1,62 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Next page link if the response contains more pages.
+  class Next < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Second 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.
+      Next.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/mself.rb

@@ -0,0 +1,62 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Self Model.
+  class Self < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @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.
+      Self.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/name_enum.rb

@@ -0,0 +1,51 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Example values are,
+  class NameEnum
+    NAME_ENUM = [
+      # TODO: Write general description for INTERNALERROROCCURRED
+      INTERNALERROROCCURRED = 'internalErrorOccurred'.freeze,
+
+      # TODO: Write general description for TRANSACTIONREFERENCEISADUPLICATE
+      TRANSACTIONREFERENCEISADUPLICATE = 'transactionReferenceIsADuplicate'.freeze,
+
+      # TODO: Write general description for TRANSACTIONHASALREADYBEENPROCESSED
+      TRANSACTIONHASALREADYBEENPROCESSED = 'transactionHasAlreadyBeenProcessed'.freeze,
+
+      # TODO: Write general description for CHANNELISNOTSUPPORTED
+      CHANNELISNOTSUPPORTED = 'channelIsNotSupported'.freeze,
+
+      # TODO: Write general description for CURRENCYISNOTSUPPORTED
+      CURRENCYISNOTSUPPORTED = 'currencyIsNotSupported'.freeze,
+
+      # TODO: Write general description for PAYMENTINSTRUMENTISNOTSUPPORTED
+      PAYMENTINSTRUMENTISNOTSUPPORTED = 'paymentInstrumentIsNotSupported'.freeze,
+
+      # TODO: Write general description for FIELDHASINVALIDVALUE
+      FIELDHASINVALIDVALUE = 'fieldHasInvalidValue'.freeze,
+
+      # TODO: Write general description for FIELDISEMPTY
+      FIELDISEMPTY = 'fieldIsEmpty'.freeze,
+
+      # TODO: Write general description for CARDNUMBERISNOTRECOGNIZED
+      CARDNUMBERISNOTRECOGNIZED = 'cardNumberIsNotRecognized'.freeze,
+
+      # TODO: Write general description for
+      # UNDERLYINGPAYMENTINSTRUMENTHASEXPIRED
+      UNDERLYINGPAYMENTINSTRUMENTHASEXPIRED = 'underlyingPaymentInstrumentHasExpired'.freeze,
+
+      # TODO: Write general description for ENTITYISNOTCONFIGURED
+      ENTITYISNOTCONFIGURED = 'entityIsNotConfigured'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      NAME_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/narrative.rb

@@ -0,0 +1,86 @@
+# 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 Narrative < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # line1 is used to provide basic details about the merchant.
+    # @return [String]
+    attr_accessor :line1
+
+    # line2 is used for additional context about the payment or merchant. E.g.
+    # Order number or Merchant phone 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.
+      Narrative.new(line1,
+                    line2)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Narrative | 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