hamza-payments-query-sdk 1.0.0

data/lib/payments/models/cancel_response.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CancelResponse Model.
+  class CancelResponse < 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['outcome'] = 'outcome'
+      @_hash['links'] = '_links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        outcome
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(outcome = SKIP, links = SKIP)
+      @outcome = outcome unless outcome == 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.
+      outcome = hash.key?('outcome') ? hash['outcome'] : SKIP
+      links = PaymentsLink.from_hash(hash['_links']) if hash['_links']
+
+      # Create object from extracted values.
+      CancelResponse.new(outcome,
+                         links)
+    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}>"
+    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}>"
+    end
+  end
+end

data/lib/payments/models/cancellation.rb

@@ -0,0 +1,88 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Configuration for when a payment is `sentForCancellation` automatically.
+  class Cancellation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # By default a payment will be `sentForCancellation` if the CVC is
+    # `notMatched`, set `disabled` to continue with `sentForSettlement`.
+    # @return [CvcNotMatchedEnum]
+    attr_accessor :cvc_not_matched
+
+    # By default a payment will be `sentForCancellation` if the `address` or
+    # `postcode` AVS is `notMatched`, set `disabled` to continue with
+    # `sentForSettlement`.
+    # @return [AvsNotMatchedEnum]
+    attr_accessor :avs_not_matched
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cvc_not_matched'] = 'cvcNotMatched'
+      @_hash['avs_not_matched'] = 'avsNotMatched'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cvc_not_matched
+        avs_not_matched
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cvc_not_matched = SKIP, avs_not_matched = SKIP)
+      @cvc_not_matched = cvc_not_matched unless cvc_not_matched == SKIP
+      @avs_not_matched = avs_not_matched unless avs_not_matched == 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.
+      cvc_not_matched =
+        hash.key?('cvcNotMatched') ? hash['cvcNotMatched'] : SKIP
+      avs_not_matched =
+        hash.key?('avsNotMatched') ? hash['avsNotMatched'] : SKIP
+
+      # Create object from extracted values.
+      Cancellation.new(cvc_not_matched,
+                       avs_not_matched)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Cancellation | 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} cvc_not_matched: #{@cvc_not_matched}, avs_not_matched:"\
+      " #{@avs_not_matched}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} cvc_not_matched: #{@cvc_not_matched.inspect}, avs_not_matched:"\
+      " #{@avs_not_matched.inspect}>"
+    end
+  end
+end

data/lib/payments/models/cancellation_failed.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CancellationFailed Model.
+  class CancellationFailed < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your cancellation request failed.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'cancellationFailed'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      CancellationFailed.new(timestamp,
+                             command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CancellationFailed | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/cancellation_request_submitted.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CancellationRequestSubmitted Model.
+  class CancellationRequestSubmitted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your cancellation request was successfully sent for processing.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'cancellationRequestSubmitted'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      CancellationRequestSubmitted.new(timestamp,
+                                       command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CancellationRequestSubmitted | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/cancellation_requested.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CancellationRequested Model.
+  class CancellationRequested < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Worldpay has received your cancellation request.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'cancellationRequested'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      CancellationRequested.new(timestamp,
+                                command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CancellationRequested | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/cancellation_timed_out.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CancellationTimedOut Model.
+  class CancellationTimedOut < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your cancellation request timed out.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'cancellationTimedOut'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      CancellationTimedOut.new(timestamp,
+                               command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [CancellationTimedOut | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/card.rb

@@ -0,0 +1,159 @@
+# 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 Card < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object that contains information about the card number.
+    # @return [Number]
+    attr_accessor :number
+
+    # Whether the card is classed as a consumer card or a card for commercial
+    # use.
+    # @return [CategoryEnum]
+    attr_accessor :category
+
+    # The [ISO 3166-1 Alpha-2
+    # format](/products/reference/supported-countries-currencies#iso-country-cod
+    # es) country code that the card was issued in. May return `N/A` where the
+    # country is unknown.
+    # @return [String]
+    attr_accessor :country_code
+
+    # 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
+
+    # The name of the card issuer.
+    # @return [String]
+    attr_accessor :issuer_name
+
+    # 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
+
+    # The payment account reference (PAR) is a non-financial reference that
+    # uniquely identifies the underlying cardholder account. This allows you to
+    # correlate payments made from the same account with differing instruments
+    # (e.g. `card/plain` and `card/wallet+applepay`), where the same account
+    # funds the transaction. A PAR cannot be used to initiate a payment.
+    # @return [String]
+    attr_accessor :payment_account_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['category'] = 'category'
+      @_hash['country_code'] = 'countryCode'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['issuer_name'] = 'issuerName'
+      @_hash['funding_type'] = 'fundingType'
+      @_hash['brand'] = 'brand'
+      @_hash['payment_account_reference'] = 'paymentAccountReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        category
+        country_code
+        expiry_date
+        issuer_name
+        funding_type
+        brand
+        payment_account_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, category = SKIP, country_code = SKIP,
+                   expiry_date = SKIP, issuer_name = SKIP, funding_type = SKIP,
+                   brand = SKIP, payment_account_reference = SKIP)
+      @number = number unless number == SKIP
+      @category = category unless category == SKIP
+      @country_code = country_code unless country_code == SKIP
+      @expiry_date = expiry_date unless expiry_date == SKIP
+      @issuer_name = issuer_name unless issuer_name == SKIP
+      @funding_type = funding_type unless funding_type == SKIP
+      @brand = brand unless brand == SKIP
+      unless payment_account_reference == SKIP
+        @payment_account_reference =
+          payment_account_reference
+      end
+    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']
+      category = hash.key?('category') ? hash['category'] : SKIP
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : SKIP
+      expiry_date = ExpiryDate1.from_hash(hash['expiryDate']) if hash['expiryDate']
+      issuer_name = hash.key?('issuerName') ? hash['issuerName'] : SKIP
+      funding_type = hash.key?('fundingType') ? hash['fundingType'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+      payment_account_reference =
+        hash.key?('paymentAccountReference') ? hash['paymentAccountReference'] : SKIP
+
+      # Create object from extracted values.
+      Card.new(number,
+               category,
+               country_code,
+               expiry_date,
+               issuer_name,
+               funding_type,
+               brand,
+               payment_account_reference)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Card | 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}, category: #{@category}, country_code: #{@country_code},"\
+      " expiry_date: #{@expiry_date}, issuer_name: #{@issuer_name}, funding_type:"\
+      " #{@funding_type}, brand: #{@brand}, payment_account_reference:"\
+      " #{@payment_account_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, category: #{@category.inspect}, country_code:"\
+      " #{@country_code.inspect}, expiry_date: #{@expiry_date.inspect}, issuer_name:"\
+      " #{@issuer_name.inspect}, funding_type: #{@funding_type.inspect}, brand: #{@brand.inspect},"\
+      " payment_account_reference: #{@payment_account_reference.inspect}>"
+    end
+  end
+end