hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_instruction.rb

@@ -0,0 +1,309 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains all information related to the payment and API
+  # configurations.
+  class PaymentsInstruction < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :method
+
+    # TODO: Write general description for this method
+    # @return [PaymentInstrument7]
+    attr_accessor :payment_instrument
+
+    # The text that appears on your customer's statement. Used to identify the
+    # merchant.
+    # @return [Narrative]
+    attr_accessor :narrative
+
+    # Use this object if you want to create a token after the payment. Can only
+    # be used with paymentInstrument.type: card/plain & checkout.
+    # @return [TokenCreation]
+    attr_accessor :token_creation
+
+    # Use this object if you want to create a token after the payment. Can only
+    # be used with paymentInstrument.type: card/plain & checkout.
+    # @return [Value]
+    attr_accessor :value
+
+    # A flag which identifies a payment as being for the purpose of repaying a
+    # debt.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :debt_repayment
+
+    # Fraud assessment to detect potential fraud and prevent the transaction
+    # from proceeding.
+    # Read more on how to set it up under our [__Fraud
+    # Assessment__](/products/payments/enable-features/fraud-assessment) guide.
+    # @return [PaymentsFraud]
+    attr_accessor :fraud
+
+    # An object containing 3DS authentication preferences.
+    # Read more on how to set it up under our [__3DS
+    # Authentication__](/products/payments/enable-features/3ds-authentication)
+    # guide.
+    # @return [PaymentsThreeDS]
+    attr_accessor :three_ds
+
+    # An object used to request or specify an SCA Exemption. 
+    # Read more on how to set it up under our [__SCA
+    # Exemptions__](/products/payments/enable-features/sca-exemptions) guide.
+    # @return [Exemption]
+    attr_accessor :exemption
+
+    # 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.
+    # @return [Settlement]
+    attr_accessor :settlement
+
+    # 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.
+    # @return [Customer]
+    attr_accessor :customer
+
+    # 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.
+    # @return [Shipping]
+    attr_accessor :shipping
+
+    # 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.
+    # @return [CustomerAgreement]
+    attr_accessor :customer_agreement
+
+    # An object containing information about the recipient of financial
+    # services. Required for MCC 6012 transactions in the Visa Europe region.
+    # The recipient may or may not be the cardholder.
+    # Read more on how to set it up under our [__Financial
+    # Services__](/products/payments/enable-features/financial-services-mcc6012-
+    # mcc6051) guide.
+    # @return [PaymentsRecipient]
+    attr_accessor :recipient
+
+    # An attribute that identifies a bill payment paid by providers on behalf of
+    # consumers. If you are registered with Visa as a Consumer of the Bill
+    # Payment Service (CBPS), you must set this to `true` for any payments
+    # associated with the CBPS.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :consumer_bill_payment
+
+    # Allows you to request a real-time account update (Visa cards only) when
+    # using a previously stored card. You can only use this on subsequent card
+    # requests.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_account_updater
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['applepay'] = ApplepayPaymentsInstruction
+        @_discriminators['card'] = CardPaymentsInstruction
+        @_discriminators['googlepay'] = GooglepayPaymentsInstruction
+      end
+      @_discriminators
+    end
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['method'] = 'method'
+      @_hash['payment_instrument'] = 'paymentInstrument'
+      @_hash['narrative'] = 'narrative'
+      @_hash['token_creation'] = 'tokenCreation'
+      @_hash['value'] = 'value'
+      @_hash['debt_repayment'] = 'debtRepayment'
+      @_hash['fraud'] = 'fraud'
+      @_hash['three_ds'] = 'threeDS'
+      @_hash['exemption'] = 'exemption'
+      @_hash['settlement'] = 'settlement'
+      @_hash['customer'] = 'customer'
+      @_hash['shipping'] = 'shipping'
+      @_hash['customer_agreement'] = 'customerAgreement'
+      @_hash['recipient'] = 'recipient'
+      @_hash['consumer_bill_payment'] = 'consumerBillPayment'
+      @_hash['request_account_updater'] = 'requestAccountUpdater'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+        token_creation
+        debt_repayment
+        fraud
+        three_ds
+        exemption
+        settlement
+        customer
+        shipping
+        customer_agreement
+        recipient
+        consumer_bill_payment
+        request_account_updater
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(payment_instrument = nil, narrative = nil, value = nil,
+                   method = 'PaymentsInstruction', 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)
+      @method = method unless method == SKIP
+      @payment_instrument = payment_instrument
+      @narrative = narrative
+      @token_creation = token_creation unless token_creation == SKIP
+      @value = value
+      @debt_repayment = debt_repayment unless debt_repayment == SKIP
+      @fraud = fraud unless fraud == SKIP
+      @three_ds = three_ds unless three_ds == SKIP
+      @exemption = exemption unless exemption == SKIP
+      @settlement = settlement unless settlement == SKIP
+      @customer = customer unless customer == SKIP
+      @shipping = shipping unless shipping == SKIP
+      @customer_agreement = customer_agreement unless customer_agreement == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @consumer_bill_payment = consumer_bill_payment unless consumer_bill_payment == SKIP
+      @request_account_updater = request_account_updater unless request_account_updater == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Delegate unboxing to another function if a discriminator
+      # value for a child class is present.
+      unboxer = discriminators[hash['method']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # 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'] ||= 'PaymentsInstruction'
+      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.
+      PaymentsInstruction.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 [PaymentsInstruction | 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
+
+      # Delegate validation to another function if a discriminator
+      # value for a child class is present.
+      validator = discriminators[value['method']]
+      return validator.send(:validate, value) if validator
+
+      (
+        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
+      "<#{class_name} method: #{@method}, payment_instrument: #{@payment_instrument}, narrative:"\
+      " #{@narrative}, token_creation: #{@token_creation}, value: #{@value}, debt_repayment:"\
+      " #{@debt_repayment}, fraud: #{@fraud}, three_ds: #{@three_ds}, exemption: #{@exemption},"\
+      " settlement: #{@settlement}, customer: #{@customer}, shipping: #{@shipping},"\
+      " customer_agreement: #{@customer_agreement}, recipient: #{@recipient},"\
+      " consumer_bill_payment: #{@consumer_bill_payment}, request_account_updater:"\
+      " #{@request_account_updater}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} method: #{@method.inspect}, payment_instrument:"\
+      " #{@payment_instrument.inspect}, narrative: #{@narrative.inspect}, token_creation:"\
+      " #{@token_creation.inspect}, value: #{@value.inspect}, debt_repayment:"\
+      " #{@debt_repayment.inspect}, fraud: #{@fraud.inspect}, three_ds: #{@three_ds.inspect},"\
+      " exemption: #{@exemption.inspect}, settlement: #{@settlement.inspect}, customer:"\
+      " #{@customer.inspect}, shipping: #{@shipping.inspect}, customer_agreement:"\
+      " #{@customer_agreement.inspect}, recipient: #{@recipient.inspect}, consumer_bill_payment:"\
+      " #{@consumer_bill_payment.inspect}, request_account_updater:"\
+      " #{@request_account_updater.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_link.rb

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

data/lib/payments/models/payments_network_token_payment_instrument.rb

@@ -0,0 +1,126 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'card_payment_instrument'
+
+module Payments
+  # PaymentsNetworkTokenPaymentInstrument Model.
+  class PaymentsNetworkTokenPaymentInstrument < CardPaymentInstrument
+    # The network token number.
+    # @return [String]
+    attr_accessor :token_number
+
+    # The name as shown on the card.
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # The single-use cryptogram provisioned for this payment. Required for all
+    # Customer Initiated Transactions (CITs). <br><br> __Note:__ If the
+    # `cryptogram` and `eci` are not provided, the Payments API will
+    # __automatically__ attempt to provision them. This will only be successful
+    # for Network Tokens created via Worldpay. For Network Tokens created via
+    # other gateways you must provide these.
+    # @return [String]
+    attr_accessor :cryptogram
+
+    # Electronic Commerce Indicator.
+    # @return [String]
+    attr_accessor :eci
+
+    # Contains your customer's card or token expiry date.
+    # @return [ExpiryDate]
+    attr_accessor :expiry_date
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['token_number'] = 'tokenNumber'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['cryptogram'] = 'cryptogram'
+      @_hash['eci'] = 'eci'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        card_holder_name
+        cryptogram
+        eci
+        billing_address
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(token_number = nil, expiry_date = nil,
+                   card_holder_name = SKIP, cryptogram = SKIP, eci = SKIP,
+                   billing_address = SKIP, type = 'networkToken')
+      @token_number = token_number
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @cryptogram = cryptogram unless cryptogram == SKIP
+      @eci = eci unless eci == SKIP
+      @expiry_date = expiry_date
+      @billing_address = billing_address unless billing_address == SKIP
+
+      # Call the constructor of the base class
+      super(type)
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      token_number = hash.key?('tokenNumber') ? hash['tokenNumber'] : nil
+      expiry_date = ExpiryDate.from_hash(hash['expiryDate']) if hash['expiryDate']
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      cryptogram = hash.key?('cryptogram') ? hash['cryptogram'] : SKIP
+      eci = hash.key?('eci') ? hash['eci'] : SKIP
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+      type = hash['type'] ||= 'networkToken'
+
+      # Create object from extracted values.
+      PaymentsNetworkTokenPaymentInstrument.new(token_number,
+                                                expiry_date,
+                                                card_holder_name,
+                                                cryptogram,
+                                                eci,
+                                                billing_address,
+                                                type)
+    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}, token_number: #{@token_number}, card_holder_name:"\
+      " #{@card_holder_name}, cryptogram: #{@cryptogram}, eci: #{@eci}, expiry_date:"\
+      " #{@expiry_date}, billing_address: #{@billing_address}>"
+    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}, token_number: #{@token_number.inspect}, card_holder_name:"\
+      " #{@card_holder_name.inspect}, cryptogram: #{@cryptogram.inspect}, eci: #{@eci.inspect},"\
+      " expiry_date: #{@expiry_date.inspect}, billing_address: #{@billing_address.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_partial_refund_request.rb

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

data/lib/payments/models/payments_partial_settle.rb

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