hamza-payments-query-sdk 1.0.0

data/lib/payments/models/custom.rb

@@ -0,0 +1,241 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Additional values specific to your order that can be used to create manual
+  # fraud rules.
+  class Custom < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number1
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number2
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number3
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number4
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number5
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number6
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number7
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number8
+
+    # TODO: Write general description for this method
+    # @return [Integer]
+    attr_accessor :number9
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string1
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string2
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string3
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string4
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string5
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string6
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string7
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string8
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :string9
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number1'] = 'number1'
+      @_hash['number2'] = 'number2'
+      @_hash['number3'] = 'number3'
+      @_hash['number4'] = 'number4'
+      @_hash['number5'] = 'number5'
+      @_hash['number6'] = 'number6'
+      @_hash['number7'] = 'number7'
+      @_hash['number8'] = 'number8'
+      @_hash['number9'] = 'number9'
+      @_hash['string1'] = 'string1'
+      @_hash['string2'] = 'string2'
+      @_hash['string3'] = 'string3'
+      @_hash['string4'] = 'string4'
+      @_hash['string5'] = 'string5'
+      @_hash['string6'] = 'string6'
+      @_hash['string7'] = 'string7'
+      @_hash['string8'] = 'string8'
+      @_hash['string9'] = 'string9'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number1
+        number2
+        number3
+        number4
+        number5
+        number6
+        number7
+        number8
+        number9
+        string1
+        string2
+        string3
+        string4
+        string5
+        string6
+        string7
+        string8
+        string9
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number1 = SKIP, number2 = SKIP, number3 = SKIP,
+                   number4 = SKIP, number5 = SKIP, number6 = SKIP,
+                   number7 = SKIP, number8 = SKIP, number9 = SKIP,
+                   string1 = SKIP, string2 = SKIP, string3 = SKIP,
+                   string4 = SKIP, string5 = SKIP, string6 = SKIP,
+                   string7 = SKIP, string8 = SKIP, string9 = SKIP)
+      @number1 = number1 unless number1 == SKIP
+      @number2 = number2 unless number2 == SKIP
+      @number3 = number3 unless number3 == SKIP
+      @number4 = number4 unless number4 == SKIP
+      @number5 = number5 unless number5 == SKIP
+      @number6 = number6 unless number6 == SKIP
+      @number7 = number7 unless number7 == SKIP
+      @number8 = number8 unless number8 == SKIP
+      @number9 = number9 unless number9 == SKIP
+      @string1 = string1 unless string1 == SKIP
+      @string2 = string2 unless string2 == SKIP
+      @string3 = string3 unless string3 == SKIP
+      @string4 = string4 unless string4 == SKIP
+      @string5 = string5 unless string5 == SKIP
+      @string6 = string6 unless string6 == SKIP
+      @string7 = string7 unless string7 == SKIP
+      @string8 = string8 unless string8 == SKIP
+      @string9 = string9 unless string9 == 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.
+      number1 = Number.from_hash(hash['number1']) if hash['number1']
+      number2 = Number.from_hash(hash['number2']) if hash['number2']
+      number3 = Number.from_hash(hash['number3']) if hash['number3']
+      number4 = Number.from_hash(hash['number4']) if hash['number4']
+      number5 = Number.from_hash(hash['number5']) if hash['number5']
+      number6 = Number.from_hash(hash['number6']) if hash['number6']
+      number7 = Number.from_hash(hash['number7']) if hash['number7']
+      number8 = Number.from_hash(hash['number8']) if hash['number8']
+      number9 = Number.from_hash(hash['number9']) if hash['number9']
+      string1 = hash.key?('string1') ? hash['string1'] : SKIP
+      string2 = hash.key?('string2') ? hash['string2'] : SKIP
+      string3 = hash.key?('string3') ? hash['string3'] : SKIP
+      string4 = hash.key?('string4') ? hash['string4'] : SKIP
+      string5 = hash.key?('string5') ? hash['string5'] : SKIP
+      string6 = hash.key?('string6') ? hash['string6'] : SKIP
+      string7 = hash.key?('string7') ? hash['string7'] : SKIP
+      string8 = hash.key?('string8') ? hash['string8'] : SKIP
+      string9 = hash.key?('string9') ? hash['string9'] : SKIP
+
+      # Create object from extracted values.
+      Custom.new(number1,
+                 number2,
+                 number3,
+                 number4,
+                 number5,
+                 number6,
+                 number7,
+                 number8,
+                 number9,
+                 string1,
+                 string2,
+                 string3,
+                 string4,
+                 string5,
+                 string6,
+                 string7,
+                 string8,
+                 string9)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Custom | 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} number1: #{@number1}, number2: #{@number2}, number3: #{@number3}, number4:"\
+      " #{@number4}, number5: #{@number5}, number6: #{@number6}, number7: #{@number7}, number8:"\
+      " #{@number8}, number9: #{@number9}, string1: #{@string1}, string2: #{@string2}, string3:"\
+      " #{@string3}, string4: #{@string4}, string5: #{@string5}, string6: #{@string6}, string7:"\
+      " #{@string7}, string8: #{@string8}, string9: #{@string9}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number1: #{@number1.inspect}, number2: #{@number2.inspect}, number3:"\
+      " #{@number3.inspect}, number4: #{@number4.inspect}, number5: #{@number5.inspect}, number6:"\
+      " #{@number6.inspect}, number7: #{@number7.inspect}, number8: #{@number8.inspect}, number9:"\
+      " #{@number9.inspect}, string1: #{@string1.inspect}, string2: #{@string2.inspect}, string3:"\
+      " #{@string3.inspect}, string4: #{@string4.inspect}, string5: #{@string5.inspect}, string6:"\
+      " #{@string6.inspect}, string7: #{@string7.inspect}, string8: #{@string8.inspect}, string9:"\
+      " #{@string9.inspect}>"
+    end
+  end
+end

data/lib/payments/models/customer.rb

@@ -0,0 +1,146 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Customer Model.
+  class Customer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier used by the ecommerce system for the customer.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Customer's first name.
+    # @return [String]
+    attr_accessor :first_name
+
+    # Customer's last name.
+    # @return [String]
+    attr_accessor :last_name
+
+    # Customer's phone number.
+    # @return [String]
+    attr_accessor :phone
+
+    # Customer's date of birth.
+    # @return [Date]
+    attr_accessor :date_of_birth
+
+    # Customers's email address used for the ecommerce account.
+    # @return [String]
+    attr_accessor :email
+
+    # A unique identifier for your customer's physical location that
+    #             can be used by the issuer in risk analysis. Must be in IPv4 or
+    # IPv6 format.
+    # E.g. 192.0.0.0.
+    # @return [String]
+    attr_accessor :ip_address
+
+    # 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['customer_id'] = 'customerId'
+      @_hash['first_name'] = 'firstName'
+      @_hash['last_name'] = 'lastName'
+      @_hash['phone'] = 'phone'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['email'] = 'email'
+      @_hash['ip_address'] = 'ipAddress'
+      @_hash['document_reference'] = 'documentReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        first_name
+        last_name
+        phone
+        date_of_birth
+        email
+        ip_address
+        document_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_id = SKIP, first_name = SKIP, last_name = SKIP,
+                   phone = SKIP, date_of_birth = SKIP, email = SKIP,
+                   ip_address = SKIP, document_reference = SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @first_name = first_name unless first_name == SKIP
+      @last_name = last_name unless last_name == SKIP
+      @phone = phone unless phone == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @email = email unless email == SKIP
+      @ip_address = ip_address unless ip_address == 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.
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+      first_name = hash.key?('firstName') ? hash['firstName'] : SKIP
+      last_name = hash.key?('lastName') ? hash['lastName'] : SKIP
+      phone = hash.key?('phone') ? hash['phone'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+      ip_address = hash.key?('ipAddress') ? hash['ipAddress'] : SKIP
+      document_reference =
+        hash.key?('documentReference') ? hash['documentReference'] : SKIP
+
+      # Create object from extracted values.
+      Customer.new(customer_id,
+                   first_name,
+                   last_name,
+                   phone,
+                   date_of_birth,
+                   email,
+                   ip_address,
+                   document_reference)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Customer | 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} customer_id: #{@customer_id}, first_name: #{@first_name}, last_name:"\
+      " #{@last_name}, phone: #{@phone}, date_of_birth: #{@date_of_birth}, email: #{@email},"\
+      " ip_address: #{@ip_address}, 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} customer_id: #{@customer_id.inspect}, first_name: #{@first_name.inspect},"\
+      " last_name: #{@last_name.inspect}, phone: #{@phone.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, email: #{@email.inspect}, ip_address: #{@ip_address.inspect},"\
+      " document_reference: #{@document_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/customer_agreement.rb

@@ -0,0 +1,120 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # CustomerAgreement Model.
+  class CustomerAgreement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Type4Enum]
+    attr_accessor :type
+
+    # Set to `first` to store a card or `subsequent` to use a previously stored
+    # card.
+    # @return [StoredCardUsageEnum]
+    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['type'] = 'type'
+      @_hash['stored_card_usage'] = 'storedCardUsage'
+      @_hash['installment_type'] = 'installmentType'
+      @_hash['installment_plan'] = 'installmentPlan'
+      @_hash['scheme_reference'] = 'schemeReference'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        stored_card_usage
+        installment_type
+        installment_plan
+        scheme_reference
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, stored_card_usage = SKIP,
+                   installment_type = SKIP, installment_plan = SKIP,
+                   scheme_reference = SKIP)
+      @type = type unless type == SKIP
+      @stored_card_usage = stored_card_usage unless stored_card_usage == SKIP
+      @installment_type = installment_type unless installment_type == SKIP
+      @installment_plan = installment_plan unless installment_plan == SKIP
+      @scheme_reference = scheme_reference unless scheme_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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      stored_card_usage =
+        hash.key?('storedCardUsage') ? hash['storedCardUsage'] : SKIP
+      installment_type =
+        hash.key?('installmentType') ? hash['installmentType'] : SKIP
+      installment_plan = InstallmentPlan.from_hash(hash['installmentPlan']) if
+        hash['installmentPlan']
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+
+      # Create object from extracted values.
+      CustomerAgreement.new(type,
+                            stored_card_usage,
+                            installment_type,
+                            installment_plan,
+                            scheme_reference)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, 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
+      "<#{class_name} type: #{@type.inspect}, 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

data/lib/payments/models/cvc_not_matched_enum.rb

@@ -0,0 +1,24 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # By default a payment will be `sentForCancellation` if the CVC is
+  # `notMatched`, set `disabled` to continue with `sentForSettlement`.
+  class CvcNotMatchedEnum
+    CVC_NOT_MATCHED_ENUM = [
+      # TODO: Write general description for ENABLED
+      ENABLED = 'enabled'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'disabled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CVC_NOT_MATCHED_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/detail_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Detail.
+  class DetailEnum
+    DETAIL_ENUM = [
+      # TODO: Write general description for ADDRESS
+      ADDRESS = 'address'.freeze,
+
+      # TODO: Write general description for POSTCODE
+      POSTCODE = 'postcode'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      DETAIL_ENUM.include?(value)
+    end
+  end
+end