hamza-payments-query-sdk 1.0.0

data/lib/payments/models/refund_timed_out.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # RefundTimedOut Model.
+  class RefundTimedOut < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your refund 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 = 'refundTimedOut'
+      @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.
+      RefundTimedOut.new(timestamp,
+                         command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundTimedOut | 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/result_enum.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The result of the exemption placement request.
+  class ResultEnum
+    RESULT_ENUM = [
+      # TODO: Write general description for HONORED
+      HONORED = 'honored'.freeze,
+
+      # TODO: Write general description for OUTOFSCOPE
+      OUTOFSCOPE = 'outOfScope'.freeze,
+
+      # TODO: Write general description for REJECTED
+      REJECTED = 'rejected'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RESULT_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/reversal_failed.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ReversalFailed Model.
+  class ReversalFailed < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your reversal 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 = 'reversalFailed'
+      @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.
+      ReversalFailed.new(timestamp,
+                         command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReversalFailed | 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/reversal_request_submitted.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ReversalRequestSubmitted Model.
+  class ReversalRequestSubmitted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your reversal 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 = 'reversalRequestSubmitted'
+      @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.
+      ReversalRequestSubmitted.new(timestamp,
+                                   command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReversalRequestSubmitted | 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/reversal_requested.rb

@@ -0,0 +1,103 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ReversalRequested Model.
+  class ReversalRequested < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Worldpay has received your reversal request.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # An object that contains the amount and currency requested for reversal.
+    # @return [Value3]
+    attr_accessor :value
+
+    # 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['value'] = 'value'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        value
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, value = SKIP, command_id = SKIP)
+      @event_name = 'reversalRequested'
+      @timestamp = timestamp unless timestamp == SKIP
+      @value = value unless value == 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
+      value = Value3.from_hash(hash['value']) if hash['value']
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      ReversalRequested.new(timestamp,
+                            value,
+                            command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReversalRequested | 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}, value: #{@value},"\
+      " 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},"\
+      " value: #{@value.inspect}, command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/reversal_timed_out.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # ReversalTimedOut Model.
+  class ReversalTimedOut < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your reversal 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 = 'reversalTimedOut'
+      @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.
+      ReversalTimedOut.new(timestamp,
+                           command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [ReversalTimedOut | 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/risk_enum.rb

@@ -0,0 +1,29 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Risk.
+  class RiskEnum
+    RISK_ENUM = [
+      # TODO: Write general description for NOTCHECKED
+      NOTCHECKED = 'notChecked'.freeze,
+
+      # TODO: Write general description for NOTMATCHED
+      NOTMATCHED = 'notMatched'.freeze,
+
+      # TODO: Write general description for NOTSUPPLIED
+      NOTSUPPLIED = 'notSupplied'.freeze,
+
+      # TODO: Write general description for VERIFICATIONFAILED
+      VERIFICATIONFAILED = 'verificationFailed'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      RISK_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/risk_factor.rb

@@ -0,0 +1,82 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Any risk factors which have been identified for the authorization. This
+  # section will not appear if no risks are identified.
+  class RiskFactor < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [RiskEnum]
+    attr_accessor :risk
+
+    # TODO: Write general description for this method
+    # @return [DetailEnum]
+    attr_accessor :detail
+
+    # TODO: Write general description for this method
+    # @return [Type1Enum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['risk'] = 'risk'
+      @_hash['detail'] = 'detail'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        risk
+        detail
+        type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(risk = SKIP, detail = SKIP, type = SKIP)
+      @risk = risk unless risk == SKIP
+      @detail = detail unless detail == SKIP
+      @type = type unless type == 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.
+      risk = hash.key?('risk') ? hash['risk'] : SKIP
+      detail = hash.key?('detail') ? hash['detail'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+
+      # Create object from extracted values.
+      RiskFactor.new(risk,
+                     detail,
+                     type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} risk: #{@risk}, detail: #{@detail}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} risk: #{@risk.inspect}, detail: #{@detail.inspect}, type:"\
+      " #{@type.inspect}>"
+    end
+  end
+end

data/lib/payments/models/routing.rb

@@ -0,0 +1,74 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing specific routing preferences.
+  class Routing < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies your customer's preferred card brand to be used for the
+    # transaction using a co-badged card.
+    # @return [PreferredCardBrandEnum]
+    attr_accessor :preferred_card_brand
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['preferred_card_brand'] = 'preferredCardBrand'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        preferred_card_brand
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(preferred_card_brand = SKIP)
+      @preferred_card_brand = preferred_card_brand unless preferred_card_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.
+      preferred_card_brand =
+        hash.key?('preferredCardBrand') ? hash['preferredCardBrand'] : SKIP
+
+      # Create object from extracted values.
+      Routing.new(preferred_card_brand)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Routing | 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} preferred_card_brand: #{@preferred_card_brand}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} preferred_card_brand: #{@preferred_card_brand.inspect}>"
+    end
+  end
+end