hamza-payments-query-sdk 1.0.0

data/lib/payments/models/purpose_enum.rb

@@ -0,0 +1,78 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Specifies the purpose of the funds transfer. Required for some regions and
+  # use cases (eg crypto).
+  class PurposeEnum
+    PURPOSE_ENUM = [
+      # TODO: Write general description for BUSINESSTOBUSINESS
+      BUSINESSTOBUSINESS = 'businessToBusiness'.freeze,
+
+      # TODO: Write general description for CREDITCARDREPAYMENT
+      CREDITCARDREPAYMENT = 'creditCardRepayment'.freeze,
+
+      # TODO: Write general description for CRYPTO
+      CRYPTO = 'crypto'.freeze,
+
+      # TODO: Write general description for CROWDLENDING
+      CROWDLENDING = 'crowdLending'.freeze,
+
+      # TODO: Write general description for DEBITCARD
+      DEBITCARD = 'debitCard'.freeze,
+
+      # TODO: Write general description for EDUCATION
+      EDUCATION = 'education'.freeze,
+
+      # TODO: Write general description for EMERGENCY
+      EMERGENCY = 'emergency'.freeze,
+
+      # TODO: Write general description for FAMILYSUPPORT
+      FAMILYSUPPORT = 'familySupport'.freeze,
+
+      # TODO: Write general description for GIFT
+      GIFT = 'gift'.freeze,
+
+      # TODO: Write general description for GIFTCARD
+      GIFTCARD = 'giftCard'.freeze,
+
+      # TODO: Write general description for GAMING
+      GAMING = 'gaming'.freeze,
+
+      # TODO: Write general description for HIGHRISKSECURITIES
+      HIGHRISKSECURITIES = 'highRiskSecurities'.freeze,
+
+      # TODO: Write general description for LIQUIDASSETS
+      LIQUIDASSETS = 'liquidAssets'.freeze,
+
+      # TODO: Write general description for MEDICAL
+      MEDICAL = 'medical'.freeze,
+
+      # TODO: Write general description for PAYROLL
+      PAYROLL = 'payroll'.freeze,
+
+      # TODO: Write general description for PREPAIDCARD
+      PREPAIDCARD = 'prepaidCard'.freeze,
+
+      # TODO: Write general description for SALARY
+      SALARY = 'salary'.freeze,
+
+      # TODO: Write general description for SAVINGS
+      SAVINGS = 'savings'.freeze,
+
+      # TODO: Write general description for TRAVEL
+      TRAVEL = 'travel'.freeze,
+
+      # TODO: Write general description for OTHER
+      OTHER = 'other'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      PURPOSE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/query_action_list.rb

@@ -0,0 +1,114 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # QueryActionList Model.
+  class QueryActionList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cancel the payment. See [details](../payments-lifecycle/cancel)
+    # @return [PaymentsActionCancel]
+    attr_accessor :cancel_payment
+
+    # Partially settle the payment. See
+    # [details](../payments-lifecycle/partialsettle) including what to add in
+    # the request body.
+    # @return [PaymentsActionPartialSettle]
+    attr_accessor :partially_settle_payment
+
+    # Fully settle the payment. See [details](../payments-lifecycle/settle)
+    # @return [PaymentsActionSettle]
+    attr_accessor :settle_payment
+
+    # 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['cancel_payment'] = 'cancelPayment'
+      @_hash['partially_settle_payment'] = 'partiallySettlePayment'
+      @_hash['settle_payment'] = 'settlePayment'
+      @_hash['refund_payment'] = 'refundPayment'
+      @_hash['partially_refund_payment'] = 'partiallyRefundPayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancel_payment
+        partially_settle_payment
+        settle_payment
+        refund_payment
+        partially_refund_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cancel_payment = SKIP, partially_settle_payment = SKIP,
+                   settle_payment = SKIP, refund_payment = SKIP,
+                   partially_refund_payment = SKIP)
+      @cancel_payment = cancel_payment unless cancel_payment == SKIP
+      @partially_settle_payment = partially_settle_payment unless partially_settle_payment == SKIP
+      @settle_payment = settle_payment unless settle_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.
+      cancel_payment = PaymentsActionCancel.from_hash(hash['cancelPayment']) if
+        hash['cancelPayment']
+      if hash['partiallySettlePayment']
+        partially_settle_payment = PaymentsActionPartialSettle.from_hash(hash['partiallySettlePayment'])
+      end
+      settle_payment = PaymentsActionSettle.from_hash(hash['settlePayment']) if
+        hash['settlePayment']
+      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.
+      QueryActionList.new(cancel_payment,
+                          partially_settle_payment,
+                          settle_payment,
+                          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} cancel_payment: #{@cancel_payment}, partially_settle_payment:"\
+      " #{@partially_settle_payment}, settle_payment: #{@settle_payment}, 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} cancel_payment: #{@cancel_payment.inspect}, partially_settle_payment:"\
+      " #{@partially_settle_payment.inspect}, settle_payment: #{@settle_payment.inspect},"\
+      " refund_payment: #{@refund_payment.inspect}, partially_refund_payment:"\
+      " #{@partially_refund_payment.inspect}>"
+    end
+  end
+end

data/lib/payments/models/query_events_response.rb

@@ -0,0 +1,71 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # QueryEventsResponse Model.
+  class QueryEventsResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :last_event
+
+    # TODO: Write general description for this method
+    # @return [QueryActionList]
+    attr_accessor :actions
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last_event'] = 'lastEvent'
+      @_hash['actions'] = '_actions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_event
+        actions
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last_event = SKIP, actions = SKIP)
+      @last_event = last_event unless last_event == 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.
+      last_event = hash.key?('lastEvent') ? hash['lastEvent'] : SKIP
+      actions = QueryActionList.from_hash(hash['_actions']) if hash['_actions']
+
+      # Create object from extracted values.
+      QueryEventsResponse.new(last_event,
+                              actions)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last_event: #{@last_event}, actions: #{@actions}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} last_event: #{@last_event.inspect}, actions: #{@actions.inspect}>"
+    end
+  end
+end

data/lib/payments/models/reason_enum.rb

@@ -0,0 +1,50 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The reason returned by the card issuer.
+  class ReasonEnum
+    REASON_ENUM = [
+      # TODO: Write general description for ISSUERHONORED
+      ISSUERHONORED = 'issuerHonored'.freeze,
+
+      # TODO: Write general description for MERCHANTINITIATEDTRANSACTION
+      MERCHANTINITIATEDTRANSACTION = 'merchantInitiatedTransaction'.freeze,
+
+      # TODO: Write general description for ONELEGOUT
+      ONELEGOUT = 'oneLegOut'.freeze,
+
+      # TODO: Write general description for MOTO
+      MOTO = 'moto'.freeze,
+
+      # TODO: Write general description for CONTACTLESS
+      CONTACTLESS = 'contactless'.freeze,
+
+      # TODO: Write general description for ISSUERREJECTED
+      ISSUERREJECTED = 'issuerRejected'.freeze,
+
+      # TODO: Write general description for HIGHRISK
+      HIGHRISK = 'highRisk'.freeze,
+
+      # TODO: Write general description for INVALID
+      INVALID = 'invalid'.freeze,
+
+      # TODO: Write general description for UNSUPPORTEDSCHEME
+      UNSUPPORTEDSCHEME = 'unsupportedScheme'.freeze,
+
+      # TODO: Write general description for UNSUPPORTEDACQUIRER
+      UNSUPPORTEDACQUIRER = 'unsupportedAcquirer'.freeze,
+
+      # TODO: Write general description for UNKNOWN
+      UNKNOWN = 'unknown'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      REASON_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/refund_failed.rb

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

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

@@ -0,0 +1,124 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # RefundRequested Model.
+  class RefundRequested < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Worldpay has received your refund 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 [Type8Enum]
+    attr_accessor :type
+
+    # Your refund reference
+    # @return [String]
+    attr_accessor :refund_reference
+
+    # An object that contains the amount and currency requested for refund.
+    # @return [Value2]
+    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['refund_reference'] = 'refundReference'
+      @_hash['value'] = 'value'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        type
+        refund_reference
+        value
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, type = SKIP, refund_reference = SKIP,
+                   value = SKIP, command_id = SKIP)
+      @event_name = 'refundRequested'
+      @timestamp = timestamp unless timestamp == SKIP
+      @type = type unless type == SKIP
+      @refund_reference = refund_reference unless refund_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
+      refund_reference =
+        hash.key?('refundReference') ? hash['refundReference'] : SKIP
+      value = Value2.from_hash(hash['value']) if hash['value']
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      RefundRequested.new(timestamp,
+                          type,
+                          refund_reference,
+                          value,
+                          command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [RefundRequested | 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},"\
+      " refund_reference: #{@refund_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}, refund_reference: #{@refund_reference.inspect}, value:"\
+      " #{@value.inspect}, command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/refund_response.rb

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