hamza-payments-query-sdk 1.0.0

data/lib/payments/models/partial_settle_action_list.rb

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

data/lib/payments/models/partial_settle_response.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PartialSettleResponse Model.
+  class PartialSettleResponse < 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 [PartialSettleActionList]
+    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 = PartialSettleActionList.from_hash(hash['_actions']) if hash['_actions']
+
+      # Create object from extracted values.
+      PartialSettleResponse.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/payment.rb

@@ -0,0 +1,192 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Payment Model.
+  class Payment < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Payment initial authorization time.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single payment. Generated at
+    # authorization, and maintained through successive payment actions.
+    # @return [String]
+    attr_accessor :payment_id
+
+    # A unique reference generated by you, used to identify a payment throughout
+    # its lifecycle.
+    # @return [String]
+    attr_accessor :transaction_reference
+
+    # An object that contains identification and further details of the
+    # merchant.
+    # @return [Narrative2]
+    attr_accessor :narrative
+
+    # An object that contains transaction type.
+    # @return [TransactionType1Enum]
+    attr_accessor :transaction_type
+
+    # An object that contains authorization type.
+    # @return [AuthorizationType1Enum]
+    attr_accessor :authorization_type
+
+    # Merchant entity name.
+    # @return [String]
+    attr_accessor :entity
+
+    # The last event received for the payment
+    # @return [LastEventEnum]
+    attr_accessor :last_event
+
+    # An object containing information returned by the card scheme.
+    # @return [Scheme]
+    attr_accessor :scheme
+
+    # An object containing information returned by the issuer.
+    # @return [Issuer1]
+    attr_accessor :issuer
+
+    # The payment instrument supplied in the authorization request.
+    # @return [PaymentInstrument4]
+    attr_accessor :payment_instrument
+
+    # An object that contains payment amount and currency.
+    # @return [Value4]
+    attr_accessor :value
+
+    # link to retrieveByPaymentId.
+    # @return [Links2]
+    attr_accessor :links
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['payment_id'] = 'paymentId'
+      @_hash['transaction_reference'] = 'transactionReference'
+      @_hash['narrative'] = 'narrative'
+      @_hash['transaction_type'] = 'transactionType'
+      @_hash['authorization_type'] = 'authorizationType'
+      @_hash['entity'] = 'entity'
+      @_hash['last_event'] = 'lastEvent'
+      @_hash['scheme'] = 'scheme'
+      @_hash['issuer'] = 'issuer'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['value'] = 'value'
+      @_hash['links'] = '_links'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        payment_id
+        transaction_reference
+        narrative
+        transaction_type
+        authorization_type
+        entity
+        last_event
+        scheme
+        issuer
+        payment_instrument
+        value
+        links
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, payment_id = SKIP,
+                   transaction_reference = SKIP, narrative = SKIP,
+                   transaction_type = SKIP, authorization_type = SKIP,
+                   entity = SKIP, last_event = SKIP, scheme = SKIP,
+                   issuer = SKIP, payment_instrument = SKIP, value = SKIP,
+                   links = SKIP)
+      @timestamp = timestamp unless timestamp == SKIP
+      @payment_id = payment_id unless payment_id == SKIP
+      @transaction_reference = transaction_reference unless transaction_reference == SKIP
+      @narrative = narrative unless narrative == SKIP
+      @transaction_type = transaction_type unless transaction_type == SKIP
+      @authorization_type = authorization_type unless authorization_type == SKIP
+      @entity = entity unless entity == SKIP
+      @last_event = last_event unless last_event == SKIP
+      @scheme = scheme unless scheme == SKIP
+      @issuer = issuer unless issuer == SKIP
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      @value = value unless value == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      payment_id = hash.key?('paymentId') ? hash['paymentId'] : SKIP
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+      narrative = Narrative2.from_hash(hash['narrative']) if hash['narrative']
+      transaction_type =
+        hash.key?('transactionType') ? hash['transactionType'] : SKIP
+      authorization_type =
+        hash.key?('authorizationType') ? hash['authorizationType'] : SKIP
+      entity = hash.key?('entity') ? hash['entity'] : SKIP
+      last_event = hash.key?('lastEvent') ? hash['lastEvent'] : SKIP
+      scheme = Scheme.from_hash(hash['scheme']) if hash['scheme']
+      issuer = Issuer1.from_hash(hash['issuer']) if hash['issuer']
+      payment_instrument = PaymentInstrument4.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      value = Value4.from_hash(hash['value']) if hash['value']
+      links = Links2.from_hash(hash['_links']) if hash['_links']
+
+      # Create object from extracted values.
+      Payment.new(timestamp,
+                  payment_id,
+                  transaction_reference,
+                  narrative,
+                  transaction_type,
+                  authorization_type,
+                  entity,
+                  last_event,
+                  scheme,
+                  issuer,
+                  payment_instrument,
+                  value,
+                  links)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} timestamp: #{@timestamp}, payment_id: #{@payment_id},"\
+      " transaction_reference: #{@transaction_reference}, narrative: #{@narrative},"\
+      " transaction_type: #{@transaction_type}, authorization_type: #{@authorization_type},"\
+      " entity: #{@entity}, last_event: #{@last_event}, scheme: #{@scheme}, issuer: #{@issuer},"\
+      " payment_instrument: #{@payment_instrument}, value: #{@value}, links: #{@links}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} timestamp: #{@timestamp.inspect}, payment_id: #{@payment_id.inspect},"\
+      " transaction_reference: #{@transaction_reference.inspect}, narrative:"\
+      " #{@narrative.inspect}, transaction_type: #{@transaction_type.inspect}, authorization_type:"\
+      " #{@authorization_type.inspect}, entity: #{@entity.inspect}, last_event:"\
+      " #{@last_event.inspect}, scheme: #{@scheme.inspect}, issuer: #{@issuer.inspect},"\
+      " payment_instrument: #{@payment_instrument.inspect}, value: #{@value.inspect}, links:"\
+      " #{@links.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payment1.rb

@@ -0,0 +1,86 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Payment1 Model.
+  class Payment1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The last event of a payment. Possible event values
+    # are:<ul><li>`Authorized`</li><li>`Refused`</li><li>`Sent for
+    # Cancellation`</li><li>`Sent for Refund`</li><li>`Sent for
+    # Settlement`</li><li>`Unknown`</li></ul>
+    # @return [String]
+    attr_accessor :last_event
+
+    # An object that contains information about the payment type.
+    # @return [PaymentInstrument6]
+    attr_accessor :payment_instrument
+
+    # An object that contains payment amount and currency.
+    # @return [Value4]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['last_event'] = 'lastEvent'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        last_event
+        payment_instrument
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(last_event = SKIP, payment_instrument = SKIP, value = SKIP)
+      @last_event = last_event unless last_event == SKIP
+      @payment_instrument = payment_instrument unless payment_instrument == SKIP
+      @value = value unless value == 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
+      payment_instrument = PaymentInstrument6.from_hash(hash['paymentInstrument']) if
+        hash['paymentInstrument']
+      value = Value4.from_hash(hash['value']) if hash['value']
+
+      # Create object from extracted values.
+      Payment1.new(last_event,
+                   payment_instrument,
+                   value)
+    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}, payment_instrument: #{@payment_instrument},"\
+      " value: #{@value}>"
+    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}, payment_instrument:"\
+      " #{@payment_instrument.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payment_instrument.rb

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

data/lib/payments/models/payment_instrument4.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The payment instrument supplied in the authorization request.
+  class PaymentInstrument4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The type of payment instrument supplied in the authorization request.
+    # @return [Type9Enum]
+    attr_accessor :type
+
+    # An object that contains information about the card used.
+    # @return [Card]
+    attr_accessor :card
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['card'] = 'card'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        card
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, card = SKIP)
+      @type = type unless type == SKIP
+      @card = card unless card == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      card = Card.from_hash(hash['card']) if hash['card']
+
+      # Create object from extracted values.
+      PaymentInstrument4.new(type,
+                             card)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentInstrument4 | 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} type: #{@type}, card: #{@card}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, card: #{@card.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payment_instrument6.rb

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