hamza-payments-query-sdk 1.0.0

data/lib/payments/models/googlepay_payments_instruction.rb

@@ -0,0 +1,151 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_instruction'
+
+module Payments
+  # GooglepayPaymentsInstruction Model.
+  class GooglepayPaymentsInstruction < PaymentsInstruction
+
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(payment_instrument = nil, narrative = nil, value = nil,
+                   method = 'googlepay', token_creation = SKIP,
+                   debt_repayment = SKIP, fraud = SKIP, three_ds = SKIP,
+                   exemption = SKIP, settlement = SKIP, customer = SKIP,
+                   shipping = SKIP, customer_agreement = SKIP, recipient = SKIP,
+                   consumer_bill_payment = SKIP, request_account_updater = SKIP)
+
+
+      # Call the constructor of the base class
+      super(payment_instrument,
+            narrative,
+            value,
+            method,
+            token_creation,
+            debt_repayment,
+            fraud,
+            three_ds,
+            exemption,
+            settlement,
+            customer,
+            shipping,
+            customer_agreement,
+            recipient,
+            consumer_bill_payment,
+            request_account_updater)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      payment_instrument = hash.key?('paymentInstrument') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument), hash['paymentInstrument']
+      ) : nil
+      narrative = Narrative.from_hash(hash['narrative']) if hash['narrative']
+      value = Value.from_hash(hash['value']) if hash['value']
+      method = hash['method'] ||= 'googlepay'
+      token_creation = TokenCreation.from_hash(hash['tokenCreation']) if hash['tokenCreation']
+      debt_repayment = hash.key?('debtRepayment') ? hash['debtRepayment'] : SKIP
+      fraud = PaymentsFraud.from_hash(hash['fraud']) if hash['fraud']
+      three_ds = PaymentsThreeDS.from_hash(hash['threeDS']) if hash['threeDS']
+      exemption = Exemption.from_hash(hash['exemption']) if hash['exemption']
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+      customer = Customer.from_hash(hash['customer']) if hash['customer']
+      shipping = Shipping.from_hash(hash['shipping']) if hash['shipping']
+      customer_agreement = hash.key?('customerAgreement') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:PaymentsInstructionCustomerAgreement), hash['customerAgreement']
+      ) : SKIP
+      recipient = PaymentsRecipient.from_hash(hash['recipient']) if hash['recipient']
+      consumer_bill_payment =
+        hash.key?('consumerBillPayment') ? hash['consumerBillPayment'] : SKIP
+      request_account_updater =
+        hash.key?('requestAccountUpdater') ? hash['requestAccountUpdater'] : SKIP
+
+      # Create object from extracted values.
+      GooglepayPaymentsInstruction.new(payment_instrument,
+                                       narrative,
+                                       value,
+                                       method,
+                                       token_creation,
+                                       debt_repayment,
+                                       fraud,
+                                       three_ds,
+                                       exemption,
+                                       settlement,
+                                       customer,
+                                       shipping,
+                                       customer_agreement,
+                                       recipient,
+                                       consumer_bill_payment,
+                                       request_account_updater)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [GooglepayPaymentsInstruction | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument)
+                         .validate(value.payment_instrument) and
+            APIHelper.valid_type?(value.narrative,
+                                  ->(val) { Narrative.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.value,
+                                  ->(val) { Value.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        UnionTypeLookUp.get(:PaymentsInstructionPaymentInstrument)
+                       .validate(value['paymentInstrument']) and
+          APIHelper.valid_type?(value['narrative'],
+                                ->(val) { Narrative.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['value'],
+                                ->(val) { Value.validate(val) },
+                                is_model_hash: true)
+      )
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      super_string = super().inspect.sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}>"
+    end
+  end
+end

data/lib/payments/models/identifier_type_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # IdentifierType.
+  class IdentifierTypeEnum
+    IDENTIFIER_TYPE_ENUM = [
+      # TODO: Write general description for IBAN
+      IBAN = 'iban'.freeze,
+
+      # TODO: Write general description for SWIFT
+      SWIFT = 'swift'.freeze,
+
+      # TODO: Write general description for ROUTINGNUMBER
+      ROUTINGNUMBER = 'routingNumber'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      IDENTIFIER_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/installment_plan.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Required only for `latinAmerica` installment type. Not allowed for
+  # `merchant` installment type.
+  class InstallmentPlan < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Number of installments that the requested amount should be broken into.
+    # @return [Integer]
+    attr_accessor :number_of_installments
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number_of_installments'] = 'numberOfInstallments'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number_of_installments = nil)
+      @number_of_installments = number_of_installments
+    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_of_installments = Number.from_hash(hash['numberOfInstallments']) if
+        hash['numberOfInstallments']
+
+      # Create object from extracted values.
+      InstallmentPlan.new(number_of_installments)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [InstallmentPlan | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.number_of_installments,
+                                     ->(val) { val.instance_of? Integer })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['numberOfInstallments'],
+                            ->(val) { val.instance_of? Integer })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number_of_installments: #{@number_of_installments}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number_of_installments: #{@number_of_installments.inspect}>"
+    end
+  end
+end

data/lib/payments/models/installment_type_enum.rb

@@ -0,0 +1,26 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Defines the type of installments service.  Read more on how to set up
+  # [__Latin America
+  # Installments__](/products/payments/enable-features/latam-installments) under
+  # our guide.
+  class InstallmentTypeEnum
+    INSTALLMENT_TYPE_ENUM = [
+      # TODO: Write general description for MERCHANT
+      MERCHANT = 'merchant'.freeze,
+
+      # TODO: Write general description for LATINAMERICA
+      LATINAMERICA = 'latinAmerica'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      INSTALLMENT_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/issuer.rb

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

data/lib/payments/models/issuer1.rb

@@ -0,0 +1,76 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing information returned by the issuer.
+  class Issuer1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # A code returned by the card issuer for a successful authorization. Used in
+    # reconciliation and dispute management.
+    # @return [String]
+    attr_accessor :authorization_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['authorization_code'] = 'authorizationCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(authorization_code = nil)
+      @authorization_code = authorization_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      authorization_code =
+        hash.key?('authorizationCode') ? hash['authorizationCode'] : nil
+
+      # Create object from extracted values.
+      Issuer1.new(authorization_code)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Issuer1 | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.authorization_code,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['authorizationCode'],
+                            ->(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} authorization_code: #{@authorization_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} authorization_code: #{@authorization_code.inspect}>"
+    end
+  end
+end

data/lib/payments/models/issuer_response_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # If the issuer decides to challenge the customer or proceed (frictionless)
+  class IssuerResponseEnum
+    ISSUER_RESPONSE_ENUM = [
+      # TODO: Write general description for FRICTIONLESS
+      FRICTIONLESS = 'frictionless'.freeze,
+
+      # TODO: Write general description for CHALLENGED
+      CHALLENGED = 'challenged'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ISSUER_RESPONSE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/last_event_enum.rb

@@ -0,0 +1,95 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The last event received for the payment
+  class LastEventEnum
+    LAST_EVENT_ENUM = [
+      # TODO: Write general description for AUTHORIZATIONREQUESTED
+      AUTHORIZATIONREQUESTED = 'authorizationRequested'.freeze,
+
+      # TODO: Write general description for AUTHORIZATIONSUCCEEDED
+      AUTHORIZATIONSUCCEEDED = 'authorizationSucceeded'.freeze,
+
+      # TODO: Write general description for AUTHORIZATIONREFUSED
+      AUTHORIZATIONREFUSED = 'authorizationRefused'.freeze,
+
+      # TODO: Write general description for AUTHORIZATIONFAILED
+      AUTHORIZATIONFAILED = 'authorizationFailed'.freeze,
+
+      # TODO: Write general description for AUTHORIZATIONTIMEDOUT
+      AUTHORIZATIONTIMEDOUT = 'authorizationTimedOut'.freeze,
+
+      # TODO: Write general description for SALEREQUESTED
+      SALEREQUESTED = 'saleRequested'.freeze,
+
+      # TODO: Write general description for SALESUCCEEDED
+      SALESUCCEEDED = 'saleSucceeded'.freeze,
+
+      # TODO: Write general description for SALEREFUSED
+      SALEREFUSED = 'saleRefused'.freeze,
+
+      # TODO: Write general description for SALEFAILED
+      SALEFAILED = 'saleFailed'.freeze,
+
+      # TODO: Write general description for SALETIMEDOUT
+      SALETIMEDOUT = 'saleTimedOut'.freeze,
+
+      # TODO: Write general description for SETTLEMENTREQUESTED
+      SETTLEMENTREQUESTED = 'settlementRequested'.freeze,
+
+      # TODO: Write general description for SETTLEMENTREQUESTSUBMITTED
+      SETTLEMENTREQUESTSUBMITTED = 'settlementRequestSubmitted'.freeze,
+
+      # TODO: Write general description for SETTLEMENTFAILED
+      SETTLEMENTFAILED = 'settlementFailed'.freeze,
+
+      # TODO: Write general description for SETTLEMENTTIMEDOUT
+      SETTLEMENTTIMEDOUT = 'settlementTimedOut'.freeze,
+
+      # TODO: Write general description for REFUNDREQUESTED
+      REFUNDREQUESTED = 'refundRequested'.freeze,
+
+      # TODO: Write general description for REFUNDREQUESTSUBMITTED
+      REFUNDREQUESTSUBMITTED = 'refundRequestSubmitted'.freeze,
+
+      # TODO: Write general description for REFUNDFAILED
+      REFUNDFAILED = 'refundFailed'.freeze,
+
+      # TODO: Write general description for REFUNDTIMEDOUT
+      REFUNDTIMEDOUT = 'refundTimedOut'.freeze,
+
+      # TODO: Write general description for CANCELLATIONREQUESTED
+      CANCELLATIONREQUESTED = 'cancellationRequested'.freeze,
+
+      # TODO: Write general description for CANCELLATIONREQUESTSUBMITTED
+      CANCELLATIONREQUESTSUBMITTED = 'cancellationRequestSubmitted'.freeze,
+
+      # TODO: Write general description for CANCELLATIONFAILED
+      CANCELLATIONFAILED = 'cancellationFailed'.freeze,
+
+      # TODO: Write general description for CANCELLATIONTIMEDOUT
+      CANCELLATIONTIMEDOUT = 'cancellationTimedOut'.freeze,
+
+      # TODO: Write general description for REVERSALREQUESTED
+      REVERSALREQUESTED = 'reversalRequested'.freeze,
+
+      # TODO: Write general description for REVERSALREQUESTSUBMITTED
+      REVERSALREQUESTSUBMITTED = 'reversalRequestSubmitted'.freeze,
+
+      # TODO: Write general description for REVERSALFAILED
+      REVERSALFAILED = 'reversalFailed'.freeze,
+
+      # TODO: Write general description for REVERSALTIMEDOUT
+      REVERSALTIMEDOUT = 'reversalTimedOut'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      LAST_EVENT_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/links.rb

@@ -0,0 +1,123 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Self link and next action links.
+  class Links < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Self link to the page.
+    # @return [Self1]
+    attr_accessor :mself
+
+    # Next action links.
+    # @return [PaymentsCancel]
+    attr_accessor :payments_cancel
+
+    # Next action links.
+    # @return [PaymentsEvents]
+    attr_accessor :payments_events
+
+    # Next action links.
+    # @return [PaymentsSettle]
+    attr_accessor :payments_settle
+
+    # Next action links.
+    # @return [PaymentsPartialSettle]
+    attr_accessor :payments_partial_settle
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mself'] = 'self'
+      @_hash['payments_cancel'] = 'payments:cancel'
+      @_hash['payments_events'] = 'payments:events'
+      @_hash['payments_settle'] = 'payments:settle'
+      @_hash['payments_partial_settle'] = 'payments:partialSettle'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        payments_cancel
+        payments_events
+        payments_settle
+        payments_partial_settle
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mself = nil, payments_cancel = SKIP, payments_events = SKIP,
+                   payments_settle = SKIP, payments_partial_settle = SKIP)
+      @mself = mself
+      @payments_cancel = payments_cancel unless payments_cancel == SKIP
+      @payments_events = payments_events unless payments_events == SKIP
+      @payments_settle = payments_settle unless payments_settle == SKIP
+      @payments_partial_settle = payments_partial_settle unless payments_partial_settle == 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.
+      mself = Self1.from_hash(hash['self']) if hash['self']
+      payments_cancel = PaymentsCancel.from_hash(hash['payments:cancel']) if
+        hash['payments:cancel']
+      payments_events = PaymentsEvents.from_hash(hash['payments:events']) if
+        hash['payments:events']
+      payments_settle = PaymentsSettle.from_hash(hash['payments:settle']) if
+        hash['payments:settle']
+      payments_partial_settle = PaymentsPartialSettle.from_hash(hash['payments:partialSettle']) if
+        hash['payments:partialSettle']
+
+      # Create object from extracted values.
+      Links.new(mself,
+                payments_cancel,
+                payments_events,
+                payments_settle,
+                payments_partial_settle)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Links | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.mself,
+                                     ->(val) { Self1.validate(val) },
+                                     is_model_hash: true)
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['self'],
+                            ->(val) { Self1.validate(val) },
+                            is_model_hash: true)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mself: #{@mself}, payments_cancel: #{@payments_cancel}, payments_events:"\
+      " #{@payments_events}, payments_settle: #{@payments_settle}, payments_partial_settle:"\
+      " #{@payments_partial_settle}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mself: #{@mself.inspect}, payments_cancel: #{@payments_cancel.inspect},"\
+      " payments_events: #{@payments_events.inspect}, payments_settle:"\
+      " #{@payments_settle.inspect}, payments_partial_settle:"\
+      " #{@payments_partial_settle.inspect}>"
+    end
+  end
+end