hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_funds_recipient.rb

@@ -0,0 +1,139 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing details about the recipient of funds, including name
+  # and address information, as well as recipient account details. In many use
+  # cases, the recipient is the same person as the sender (for example if your
+  # customer uses their card to load funds into their own crypto exchange or
+  # investment account). __Although an optional object in the API schema,
+  # `recipient` is required for some regions and use cases.__
+  class PaymentsFundsRecipient < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # An object for the account details of the recipient.
+    # @return [PaymentsRecipientAccount]
+    attr_accessor :account
+
+    # Recipient's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Recipient's middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Recipient's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Sender's address.
+    # @return [PaymentsTransferAddress]
+    attr_accessor :address
+
+    # Recipient's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Recipient's phone number
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Required for domestic processing in some Latin American countries.
+    # @return [String]
+    attr_accessor :document_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account'] = 'account'
+      @_hash['first_name'] = 'firstName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['address'] = 'address'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['document_reference'] = 'documentReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account
+        first_name
+        middle_name
+        last_name
+        address
+        date_of_birth
+        phone_number
+        document_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account = SKIP, first_name = SKIP, middle_name = SKIP,
+                   last_name = SKIP, address = SKIP, date_of_birth = SKIP,
+                   phone_number = SKIP, document_reference = SKIP)
+      @account = account unless account == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @middle_name = middle_name unless middle_name == 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
+      @phone_number = phone_number unless phone_number == SKIP
+      @document_reference = document_reference unless document_reference == 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 = PaymentsRecipientAccount.from_hash(hash['account']) if hash['account']
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      address = PaymentsTransferAddress.from_hash(hash['address']) if hash['address']
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+      document_reference =
+        hash.key?('documentReference') ? hash['documentReference'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsFundsRecipient.new(account,
+                                 first_name,
+                                 middle_name,
+                                 last_name,
+                                 address,
+                                 date_of_birth,
+                                 phone_number,
+                                 document_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account}, first_name: #{@first_name}, middle_name:"\
+      " #{@middle_name}, last_name: #{@last_name}, address: #{@address}, date_of_birth:"\
+      " #{@date_of_birth}, phone_number: #{@phone_number}, document_reference:"\
+      " #{@document_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account: #{@account.inspect}, first_name: #{@first_name.inspect},"\
+      " middle_name: #{@middle_name.inspect}, last_name: #{@last_name.inspect}, address:"\
+      " #{@address.inspect}, date_of_birth: #{@date_of_birth.inspect}, phone_number:"\
+      " #{@phone_number.inspect}, document_reference: #{@document_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_funds_sender.rb

@@ -0,0 +1,120 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing details about the sender of funds, including name and
+  # address information. The sender account is always the card account declared
+  # within `instruction.paymentInstrument`. __Although an optional object in the
+  # API schema, `sender` is required for some regions and use cases.__
+  class PaymentsFundsSender < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Sender's first name. Must be supplied if `lastName` or `middleName` are
+    # provided.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Sender's middle name.
+    # @return [String]
+    attr_accessor :middle_name
+
+    # Sender's last name. Must be supplied if `firstName` or `middleName` are
+    # provided.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Sender's address.
+    # @return [PaymentsTransferAddress]
+    attr_accessor :address
+
+    # Sender's date of birth
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Sender's document reference (e.g. Tax ID). Required for domestic
+    # processing in some Latin American countries.
+    # @return [String]
+    attr_accessor :document_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['first_name'] = 'firstName'
+      @_hash['middle_name'] = 'middleName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['address'] = 'address'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['document_reference'] = 'documentReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        first_name
+        middle_name
+        last_name
+        address
+        date_of_birth
+        document_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(first_name = SKIP, middle_name = SKIP, last_name = SKIP,
+                   address = SKIP, date_of_birth = SKIP,
+                   document_reference = SKIP)
+      @first_name = first_name unless first_name == SKIP
+      @middle_name = middle_name unless middle_name == 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
+      @document_reference = document_reference unless document_reference == 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.
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      middle_name = hash.key?('middleName') ? hash['middleName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      address = PaymentsTransferAddress.from_hash(hash['address']) if hash['address']
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      document_reference =
+        hash.key?('documentReference') ? hash['documentReference'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsFundsSender.new(first_name,
+                              middle_name,
+                              last_name,
+                              address,
+                              date_of_birth,
+                              document_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name}, middle_name: #{@middle_name}, last_name:"\
+      " #{@last_name}, address: #{@address}, date_of_birth: #{@date_of_birth}, document_reference:"\
+      " #{@document_reference}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} first_name: #{@first_name.inspect}, middle_name: #{@middle_name.inspect},"\
+      " last_name: #{@last_name.inspect}, address: #{@address.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, document_reference: #{@document_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_funds_transfer.rb

@@ -0,0 +1,108 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains details of the funds transfer request, which is a money movement
+  # for a reason other than the purchase of goods or services (also known as
+  # Account Funding Transaction (AFT)). Read more on how to set it up under our
+  # [__Account Funding
+  # Transactions__](/products/payments/enable-features/account-funding-transacti
+  # ons) guide.
+  class PaymentsFundsTransfer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specifies the type of the funds transfer. {% admonition type="warning"
+    # name="Note" %} You may only submit the `fundsTransfer.type` values that
+    # relate to the use cases that you have been approved for by the schemes.{%
+    # /admonition %}
+    # @return [Type5Enum]
+    attr_accessor :type
+
+    # Specifies the purpose of the funds transfer. Required for some regions and
+    # use cases (eg crypto).
+    # @return [PurposeEnum]
+    attr_accessor :purpose
+
+    # An object containing details about the recipient of funds, including name
+    # and address information, as well as recipient account details. In many use
+    # cases, the recipient is the same person as the sender (for example if your
+    # customer uses their card to load funds into their own crypto exchange or
+    # investment account). __Although an optional object in the API schema,
+    # `recipient` is required for some regions and use cases.__
+    # @return [PaymentsFundsRecipient]
+    attr_accessor :recipient
+
+    # An object containing details about the sender of funds, including name and
+    # address information. The sender account is always the card account
+    # declared within `instruction.paymentInstrument`. __Although an optional
+    # object in the API schema, `sender` is required for some regions and use
+    # cases.__
+    # @return [PaymentsFundsSender]
+    attr_accessor :sender
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['purpose'] = 'purpose'
+      @_hash['recipient'] = 'recipient'
+      @_hash['sender'] = 'sender'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        purpose
+        recipient
+        sender
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil, purpose = SKIP, recipient = SKIP, sender = SKIP)
+      @type = type
+      @purpose = purpose unless purpose == SKIP
+      @recipient = recipient unless recipient == SKIP
+      @sender = sender unless sender == 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'] : nil
+      purpose = hash.key?('purpose') ? hash['purpose'] : SKIP
+      recipient = PaymentsFundsRecipient.from_hash(hash['recipient']) if hash['recipient']
+      sender = PaymentsFundsSender.from_hash(hash['sender']) if hash['sender']
+
+      # Create object from extracted values.
+      PaymentsFundsTransfer.new(type,
+                                purpose,
+                                recipient,
+                                sender)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, purpose: #{@purpose}, recipient: #{@recipient}, sender:"\
+      " #{@sender}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, purpose: #{@purpose.inspect}, recipient:"\
+      " #{@recipient.inspect}, sender: #{@sender.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_gift_cards_purchase.rb

@@ -0,0 +1,81 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # If the order is being used to purchase a gift card.
+  class PaymentsGiftCardsPurchase < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Value]
+    attr_accessor :total_value
+
+    # The number of gift cards being purchased.
+    # @return [Integer]
+    attr_accessor :quantity
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_value'] = 'totalValue'
+      @_hash['quantity'] = 'quantity'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        total_value
+        quantity
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(total_value = SKIP, quantity = SKIP)
+      @total_value = total_value unless total_value == SKIP
+      @quantity = quantity unless quantity == 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.
+      total_value = Value.from_hash(hash['totalValue']) if hash['totalValue']
+      quantity = Number.from_hash(hash['quantity']) if hash['quantity']
+
+      # Create object from extracted values.
+      PaymentsGiftCardsPurchase.new(total_value,
+                                    quantity)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsGiftCardsPurchase | 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} total_value: #{@total_value}, quantity: #{@quantity}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} total_value: #{@total_value.inspect}, quantity: #{@quantity.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_installment_customer_agreement.rb

@@ -0,0 +1,133 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_customer_agreement'
+
+module Payments
+  # PaymentsInstallmentCustomerAgreement Model.
+  class PaymentsInstallmentCustomerAgreement < PaymentsCustomerAgreement
+    # Set to `first` to store a card or `subsequent` to use a previously stored
+    # card. Mandatory for `merchant` installment type.
+    # @return [StoredCardUsage1Enum]
+    attr_accessor :stored_card_usage
+
+    # 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.
+    # @return [InstallmentTypeEnum]
+    attr_accessor :installment_type
+
+    # Required only for `latinAmerica` installment type. Not allowed for
+    # `merchant` installment type.
+    # @return [InstallmentPlan]
+    attr_accessor :installment_plan
+
+    # Optional field available only for `subsequent` storedCardUsage. Unique
+    # reference provided by card schemes used to link the `first` and
+    # `subsequent` payments. If a Worldpay token was created as part of the
+    # first payment, this value is bundled with the token and does not need to
+    # be provided again. If you manage multiple agreements for a single
+    # cardholder using a token, please use the `schemeReference` returned to
+    # you. This allows you to distinguish and manage each separate agreement
+    # appropriately.
+    # @return [String]
+    attr_accessor :scheme_reference
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['stored_card_usage'] = 'storedCardUsage'
+      @_hash['installment_type'] = 'installmentType'
+      @_hash['installment_plan'] = 'installmentPlan'
+      @_hash['scheme_reference'] = 'schemeReference'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        stored_card_usage
+        installment_plan
+        scheme_reference
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(installment_type = nil, stored_card_usage = SKIP,
+                   installment_plan = SKIP, scheme_reference = SKIP,
+                   type = 'installment')
+      @stored_card_usage = stored_card_usage unless stored_card_usage == SKIP
+      @installment_type = installment_type
+      @installment_plan = installment_plan unless installment_plan == SKIP
+      @scheme_reference = scheme_reference unless scheme_reference == 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.
+      installment_type =
+        hash.key?('installmentType') ? hash['installmentType'] : nil
+      stored_card_usage =
+        hash.key?('storedCardUsage') ? hash['storedCardUsage'] : SKIP
+      installment_plan = InstallmentPlan.from_hash(hash['installmentPlan']) if
+        hash['installmentPlan']
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+      type = hash['type'] ||= 'installment'
+
+      # Create object from extracted values.
+      PaymentsInstallmentCustomerAgreement.new(installment_type,
+                                               stored_card_usage,
+                                               installment_plan,
+                                               scheme_reference,
+                                               type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsInstallmentCustomerAgreement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.installment_type,
+                                     ->(val) { InstallmentTypeEnum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['installmentType'],
+                            ->(val) { InstallmentTypeEnum.validate(val) })
+    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}, stored_card_usage: #{@stored_card_usage},"\
+      " installment_type: #{@installment_type}, installment_plan: #{@installment_plan},"\
+      " scheme_reference: #{@scheme_reference}>"
+    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}, stored_card_usage: #{@stored_card_usage.inspect},"\
+      " installment_type: #{@installment_type.inspect}, installment_plan:"\
+      " #{@installment_plan.inspect}, scheme_reference: #{@scheme_reference.inspect}>"
+    end
+  end
+end