hamza-payments-query-sdk 1.0.0

data/lib/payments/models/applepay_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
+  # ApplepayPaymentsInstruction Model.
+  class ApplepayPaymentsInstruction < 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 = 'applepay', 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'] ||= 'applepay'
+      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.
+      ApplepayPaymentsInstruction.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 [ApplepayPaymentsInstruction | 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/authentication.rb

@@ -0,0 +1,161 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Object that contains authentication related information.
+  class Authentication < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The version of 3DS used to process the transaction.
+    # @return [String]
+    attr_accessor :version
+
+    # The version of 3DS used to process the transaction.
+    # @return [String]
+    attr_accessor :type
+
+    # The version of 3DS used to process the transaction.
+    # @return [String]
+    attr_accessor :authentication_value
+
+    # Electronic Commerce Indicator (ECI). Indicates the outcome of the 3DS
+    # authentication.
+    # @return [String]
+    attr_accessor :eci
+
+    # A transaction identifier.
+    # @return [String]
+    attr_accessor :transaction_id
+
+    # A transaction identifier.
+    # @return [Integer]
+    attr_accessor :cryptogram_algorithm
+
+    # A transaction identifier.
+    # @return [String]
+    attr_accessor :challenge_preference
+
+    # A transaction identifier.
+    # @return [String]
+    attr_accessor :authentication_flow
+
+    # A transaction identifier.
+    # @return [String]
+    attr_accessor :network_score
+
+    # A transaction identifier.
+    # @return [String]
+    attr_accessor :brand
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['version'] = 'version'
+      @_hash['type'] = 'type'
+      @_hash['authentication_value'] = 'authenticationValue'
+      @_hash['eci'] = 'eci'
+      @_hash['transaction_id'] = 'transactionId'
+      @_hash['cryptogram_algorithm'] = 'cryptogramAlgorithm'
+      @_hash['challenge_preference'] = 'challengePreference'
+      @_hash['authentication_flow'] = 'authenticationFlow'
+      @_hash['network_score'] = 'networkScore'
+      @_hash['brand'] = 'brand'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        version
+        type
+        authentication_value
+        eci
+        transaction_id
+        cryptogram_algorithm
+        challenge_preference
+        authentication_flow
+        network_score
+        brand
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(version = SKIP, type = SKIP, authentication_value = SKIP,
+                   eci = SKIP, transaction_id = SKIP,
+                   cryptogram_algorithm = SKIP, challenge_preference = SKIP,
+                   authentication_flow = SKIP, network_score = SKIP,
+                   brand = SKIP)
+      @version = version unless version == SKIP
+      @type = type unless type == SKIP
+      @authentication_value = authentication_value unless authentication_value == SKIP
+      @eci = eci unless eci == SKIP
+      @transaction_id = transaction_id unless transaction_id == SKIP
+      @cryptogram_algorithm = cryptogram_algorithm unless cryptogram_algorithm == SKIP
+      @challenge_preference = challenge_preference unless challenge_preference == SKIP
+      @authentication_flow = authentication_flow unless authentication_flow == SKIP
+      @network_score = network_score unless network_score == SKIP
+      @brand = brand unless 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.
+      version = hash.key?('version') ? hash['version'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      authentication_value =
+        hash.key?('authenticationValue') ? hash['authenticationValue'] : SKIP
+      eci = hash.key?('eci') ? hash['eci'] : SKIP
+      transaction_id = hash.key?('transactionId') ? hash['transactionId'] : SKIP
+      cryptogram_algorithm = Number.from_hash(hash['cryptogramAlgorithm']) if
+        hash['cryptogramAlgorithm']
+      challenge_preference =
+        hash.key?('challengePreference') ? hash['challengePreference'] : SKIP
+      authentication_flow =
+        hash.key?('authenticationFlow') ? hash['authenticationFlow'] : SKIP
+      network_score = hash.key?('networkScore') ? hash['networkScore'] : SKIP
+      brand = hash.key?('brand') ? hash['brand'] : SKIP
+
+      # Create object from extracted values.
+      Authentication.new(version,
+                         type,
+                         authentication_value,
+                         eci,
+                         transaction_id,
+                         cryptogram_algorithm,
+                         challenge_preference,
+                         authentication_flow,
+                         network_score,
+                         brand)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version}, type: #{@type}, authentication_value:"\
+      " #{@authentication_value}, eci: #{@eci}, transaction_id: #{@transaction_id},"\
+      " cryptogram_algorithm: #{@cryptogram_algorithm}, challenge_preference:"\
+      " #{@challenge_preference}, authentication_flow: #{@authentication_flow}, network_score:"\
+      " #{@network_score}, brand: #{@brand}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} version: #{@version.inspect}, type: #{@type.inspect}, authentication_value:"\
+      " #{@authentication_value.inspect}, eci: #{@eci.inspect}, transaction_id:"\
+      " #{@transaction_id.inspect}, cryptogram_algorithm: #{@cryptogram_algorithm.inspect},"\
+      " challenge_preference: #{@challenge_preference.inspect}, authentication_flow:"\
+      " #{@authentication_flow.inspect}, network_score: #{@network_score.inspect}, brand:"\
+      " #{@brand.inspect}>"
+    end
+  end
+end

data/lib/payments/models/authorization_action_list.rb

@@ -0,0 +1,90 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # AuthorizationActionList Model.
+  class AuthorizationActionList < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Cancel the payment. See [details](../payments-lifecycle/cancel)
+    # @return [PaymentsActionCancel]
+    attr_accessor :cancel_payment
+
+    # Fully settle the payment. See [details](../payments-lifecycle/settle)
+    # @return [PaymentsActionSettle]
+    attr_accessor :settle_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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['cancel_payment'] = 'cancelPayment'
+      @_hash['settle_payment'] = 'settlePayment'
+      @_hash['partially_settle_payment'] = 'partiallySettlePayment'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        cancel_payment
+        settle_payment
+        partially_settle_payment
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(cancel_payment = SKIP, settle_payment = SKIP,
+                   partially_settle_payment = SKIP)
+      @cancel_payment = cancel_payment unless cancel_payment == SKIP
+      @settle_payment = settle_payment unless settle_payment == SKIP
+      @partially_settle_payment = partially_settle_payment unless partially_settle_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']
+      settle_payment = PaymentsActionSettle.from_hash(hash['settlePayment']) if
+        hash['settlePayment']
+      if hash['partiallySettlePayment']
+        partially_settle_payment = PaymentsActionPartialSettle.from_hash(hash['partiallySettlePayment'])
+      end
+
+      # Create object from extracted values.
+      AuthorizationActionList.new(cancel_payment,
+                                  settle_payment,
+                                  partially_settle_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}, settle_payment: #{@settle_payment},"\
+      " partially_settle_payment: #{@partially_settle_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}, settle_payment:"\
+      " #{@settle_payment.inspect}, partially_settle_payment:"\
+      " #{@partially_settle_payment.inspect}>"
+    end
+  end
+end

data/lib/payments/models/authorization_failed.rb

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

data/lib/payments/models/authorization_refused.rb

@@ -0,0 +1,124 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # AuthorizationRefused Model.
+  class AuthorizationRefused < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your authorization request was refused by the card issuer.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Outcome of the event. For every requested event there can be a successful
+    # or refused event outcome.
+    # @return [Outcome17Enum]
+    attr_accessor :outcome
+
+    # The response code, used to identify the refusal reason.
+    # @return [String]
+    attr_accessor :code
+
+    # The description of the refusal reason.
+    # @return [String]
+    attr_accessor :description
+
+    # 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['outcome'] = 'outcome'
+      @_hash['code'] = 'code'
+      @_hash['description'] = 'description'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        outcome
+        code
+        description
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, outcome = SKIP, code = SKIP,
+                   description = SKIP, command_id = SKIP)
+      @event_name = 'authorizationRefused'
+      @timestamp = timestamp unless timestamp == SKIP
+      @outcome = outcome unless outcome == SKIP
+      @code = code unless code == SKIP
+      @description = description unless description == 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
+      outcome = hash.key?('outcome') ? hash['outcome'] : SKIP
+      code = hash.key?('code') ? hash['code'] : SKIP
+      description = hash.key?('description') ? hash['description'] : SKIP
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationRefused.new(timestamp,
+                               outcome,
+                               code,
+                               description,
+                               command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthorizationRefused | 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}, outcome: #{@outcome},"\
+      " code: #{@code}, description: #{@description}, 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},"\
+      " outcome: #{@outcome.inspect}, code: #{@code.inspect}, description:"\
+      " #{@description.inspect}, command_id: #{@command_id.inspect}>"
+    end
+  end
+end