hamza-payments-query-sdk 1.0.0

data/lib/payments/models/settle_action_list.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # SettleActionList Model.
+  class SettleActionList < 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.
+      SettleActionList.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/settle_response.rb

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

data/lib/payments/models/settlement.rb

@@ -0,0 +1,88 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Automatically settle a payment following authorization. If any of the
+  # AVS/CVC response riskFactors are marked as `notMatched` the payment will be
+  # `sentForCancellation` automatically. Read more on how to set it up under our
+  # [__Auto Settlement__](/products/payments/enable-features/auto-settlement)
+  # guide.
+  class Settlement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :auto
+
+    # Configuration for when a payment is `sentForCancellation` automatically.
+    # @return [Cancellation]
+    attr_accessor :cancel_on
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['auto'] = 'auto'
+      @_hash['cancel_on'] = 'cancelOn'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancel_on
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(auto = nil, cancel_on = SKIP)
+      @auto = auto
+      @cancel_on = cancel_on unless cancel_on == 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.
+      auto = hash.key?('auto') ? hash['auto'] : nil
+      cancel_on = Cancellation.from_hash(hash['cancelOn']) if hash['cancelOn']
+
+      # Create object from extracted values.
+      Settlement.new(auto,
+                     cancel_on)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Settlement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.auto,
+                                     ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['auto'],
+                            ->(val) { val.instance_of? TrueClass or val.instance_of? FalseClass })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto: #{@auto}, cancel_on: #{@cancel_on}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} auto: #{@auto.inspect}, cancel_on: #{@cancel_on.inspect}>"
+    end
+  end
+end

data/lib/payments/models/settlement_failed.rb

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

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

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

data/lib/payments/models/settlement_timed_out.rb

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