hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_partial_settle_request.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentsPartialSettleRequest Model.
+  class PaymentsPartialSettleRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :reference
+
+    # The sequence number and total number of expected partial settlement
+    # requests for the payment.
+    # @return [PaymentsSequence]
+    attr_accessor :sequence
+
+    # The sequence number and total number of expected partial settlement
+    # requests for the payment.
+    # @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['sequence'] = 'sequence'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        sequence
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference = nil, value = nil, sequence = SKIP)
+      @reference = reference
+      @sequence = sequence unless sequence == SKIP
+      @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']
+      sequence = PaymentsSequence.from_hash(hash['sequence']) if hash['sequence']
+
+      # Create object from extracted values.
+      PaymentsPartialSettleRequest.new(reference,
+                                       value,
+                                       sequence)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference: #{@reference}, sequence: #{@sequence}, 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}, sequence: #{@sequence.inspect}, value:"\
+      " #{@value.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_payment_facilitator.rb

@@ -0,0 +1,88 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing Payment Facilitator information. This information is
+  # required for every authorization [__only if you are a Payment
+  # Facilitator__](/products/payments/enable-features/payment-facilitator)
+  class PaymentsPaymentFacilitator < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your payment facilitator ID received from Mastercard, Visa and Amex.
+    # @return [String]
+    attr_accessor :scheme_id
+
+    # Independent Sales Organization (ISO) ID provided by Mastercard.
+    # @return [String]
+    attr_accessor :independent_sales_organization_id
+
+    # Your sub-merchant's details.
+    # @return [PaymentsSubMerchant]
+    attr_accessor :sub_merchant
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scheme_id'] = 'schemeId'
+      @_hash['independent_sales_organization_id'] =
+        'independentSalesOrganizationId'
+      @_hash['sub_merchant'] = 'subMerchant'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        independent_sales_organization_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scheme_id = nil, sub_merchant = nil,
+                   independent_sales_organization_id = SKIP)
+      @scheme_id = scheme_id
+      unless independent_sales_organization_id == SKIP
+        @independent_sales_organization_id =
+          independent_sales_organization_id
+      end
+      @sub_merchant = sub_merchant
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      scheme_id = hash.key?('schemeId') ? hash['schemeId'] : nil
+      sub_merchant = PaymentsSubMerchant.from_hash(hash['subMerchant']) if hash['subMerchant']
+      independent_sales_organization_id =
+        hash.key?('independentSalesOrganizationId') ? hash['independentSalesOrganizationId'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsPaymentFacilitator.new(scheme_id,
+                                     sub_merchant,
+                                     independent_sales_organization_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_id: #{@scheme_id}, independent_sales_organization_id:"\
+      " #{@independent_sales_organization_id}, sub_merchant: #{@sub_merchant}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scheme_id: #{@scheme_id.inspect}, independent_sales_organization_id:"\
+      " #{@independent_sales_organization_id.inspect}, sub_merchant: #{@sub_merchant.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_payment_instrument.rb

@@ -0,0 +1,78 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # PaymentsPaymentInstrument Model.
+  class PaymentsPaymentInstrument < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['plain'] = PaymentsCardPlainPaymentInstrument
+        @_discriminators['checkout'] = SessionPaymentInstrument
+        @_discriminators['token'] = TokenPaymentInstrument
+      end
+      @_discriminators
+    end
+
+    # 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 = 'PaymentsPaymentInstrument')
+      @type = type unless type == 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['type']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      type = hash['type'] ||= 'PaymentsPaymentInstrument'
+
+      # Create object from extracted values.
+      PaymentsPaymentInstrument.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/payments_phone_account.rb

@@ -0,0 +1,69 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_recipient_account'
+
+module Payments
+  # PaymentsPhoneAccount Model.
+  class PaymentsPhoneAccount < PaymentsRecipientAccount
+    # Recipient's phone number.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['phone_number'] = 'phoneNumber'
+      @_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(phone_number = nil, type = 'phone')
+      @phone_number = phone_number
+
+      # 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.
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : nil
+      type = hash['type'] ||= 'phone'
+
+      # Create object from extracted values.
+      PaymentsPhoneAccount.new(phone_number,
+                               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}, phone_number: #{@phone_number}>"
+    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}, phone_number: #{@phone_number.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_recipient.rb

@@ -0,0 +1,110 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # 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-mc
+  # c6051) guide.
+  class PaymentsRecipient < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The account number of the recipient. Either a bank account number or a
+    # partial card number.
+    # @return [String]
+    attr_accessor :account_reference
+
+    # The last name of the recipient.
+    # @return [String]
+    attr_accessor :last_name
+
+    # The last name of the recipient.
+    # @return [PaymentsRecipientAddress]
+    attr_accessor :address
+
+    # Recipient's date of birth.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_reference'] = 'accountReference'
+      @_hash['last_name'] = 'lastName'
+      @_hash['address'] = 'address'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_reference
+        last_name
+        address
+        date_of_birth
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_reference = SKIP, last_name = SKIP, address = SKIP,
+                   date_of_birth = SKIP)
+      @account_reference = account_reference unless account_reference == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @address = address unless address == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == 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.
+      account_reference =
+        hash.key?('accountReference') ? hash['accountReference'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      address = PaymentsRecipientAddress.from_hash(hash['address']) if hash['address']
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsRecipient.new(account_reference,
+                            last_name,
+                            address,
+                            date_of_birth)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsRecipient | 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} account_reference: #{@account_reference}, last_name: #{@last_name},"\
+      " address: #{@address}, date_of_birth: #{@date_of_birth}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_reference: #{@account_reference.inspect}, last_name:"\
+      " #{@last_name.inspect}, address: #{@address.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_recipient_account.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object for the account details of the recipient.
+  class PaymentsRecipientAccount < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :type
+
+    # Discriminators mapping.
+    def self.discriminators
+      if @_discriminators.nil?
+        @_discriminators = {}
+        @_discriminators['bankAccount'] = PaymentsBankAccount
+        @_discriminators['card'] = PaymentsCardAccount
+        @_discriminators['email'] = PaymentsEmailAccount
+        @_discriminators['phone'] = PaymentsPhoneAccount
+        @_discriminators['socialNetwork'] = PaymentsSocialNetworkAccount
+        @_discriminators['merchantWallet'] = PaymentsWalletAccount
+      end
+      @_discriminators
+    end
+
+    # 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 = 'PaymentsRecipientAccount')
+      @type = type unless type == 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['type']]
+      return unboxer.send(:from_hash, hash) if unboxer
+
+      # Extract variables from the hash.
+      type = hash['type'] ||= 'PaymentsRecipientAccount'
+
+      # Create object from extracted values.
+      PaymentsRecipientAccount.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/payments_recipient_address.rb

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

data/lib/payments/models/payments_response.rb

@@ -0,0 +1,69 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'device_data_response201'
+
+module Payments
+  # PaymentsResponse Model.
+  class PaymentsResponse < DeviceDataResponse201
+
+
+    # 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(outcome = '3dsUnavailable', transaction_reference = SKIP)
+
+
+      # Call the constructor of the base class
+      super(outcome,
+            transaction_reference)
+    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['outcome'] ||= '3dsUnavailable'
+      transaction_reference =
+        hash.key?('transactionReference') ? hash['transactionReference'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsResponse.new(outcome,
+                           transaction_reference)
+    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