hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_sub_merchant.rb

@@ -0,0 +1,108 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Your sub-merchant's details.
+  class PaymentsSubMerchant < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The name of your subMerchant's company.
+    # @return [String]
+    attr_accessor :name
+
+    # Unique merchant reference.
+    # @return [String]
+    attr_accessor :reference
+
+    # Contains the subMerchant address information.
+    # @return [PaymentsSubMerchantAddress]
+    attr_accessor :address
+
+    # Phone number of your subMerchant's company.
+    # @return [String]
+    attr_accessor :phone_number
+
+    # Tax Reference of your subMerchant's company.
+    # @return [String]
+    attr_accessor :tax_reference
+
+    # Email address of your subMerchant's company.
+    # @return [String]
+    attr_accessor :email
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['reference'] = 'reference'
+      @_hash['address'] = 'address'
+      @_hash['phone_number'] = 'phoneNumber'
+      @_hash['tax_reference'] = 'taxReference'
+      @_hash['email'] = 'email'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        phone_number
+        tax_reference
+        email
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = nil, reference = nil, address = nil,
+                   phone_number = SKIP, tax_reference = SKIP, email = SKIP)
+      @name = name
+      @reference = reference
+      @address = address
+      @phone_number = phone_number unless phone_number == SKIP
+      @tax_reference = tax_reference unless tax_reference == SKIP
+      @email = email unless email == 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.
+      name = hash.key?('name') ? hash['name'] : nil
+      reference = hash.key?('reference') ? hash['reference'] : nil
+      address = PaymentsSubMerchantAddress.from_hash(hash['address']) if hash['address']
+      phone_number = hash.key?('phoneNumber') ? hash['phoneNumber'] : SKIP
+      tax_reference = hash.key?('taxReference') ? hash['taxReference'] : SKIP
+      email = hash.key?('email') ? hash['email'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsSubMerchant.new(name,
+                              reference,
+                              address,
+                              phone_number,
+                              tax_reference,
+                              email)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, reference: #{@reference}, address: #{@address},"\
+      " phone_number: #{@phone_number}, tax_reference: #{@tax_reference}, email: #{@email}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, reference: #{@reference.inspect}, address:"\
+      " #{@address.inspect}, phone_number: #{@phone_number.inspect}, tax_reference:"\
+      " #{@tax_reference.inspect}, email: #{@email.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_sub_merchant_address.rb

@@ -0,0 +1,99 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains the subMerchant address information.
+  class PaymentsSubMerchantAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Post code/Zip code of your subMerchant's company.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Street name of your subMerchant's company.
+    # @return [String]
+    attr_accessor :street
+
+    # City of your subMerchant's company.
+    # @return [String]
+    attr_accessor :city
+
+    # State of your subMerchant's company.
+    # @return [String]
+    attr_accessor :state
+
+    # Country code of your subMerchant's company in [ISO 3166-1 Alpha-2
+    # format](/products/reference/supported-countries-currencies#iso-country-cod
+    # es).
+    # @return [String]
+    attr_accessor :country_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['street'] = 'street'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'countryCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(postal_code = nil, street = nil, city = nil,
+                   country_code = nil, state = SKIP)
+      @postal_code = postal_code
+      @street = street
+      @city = city
+      @state = state unless state == SKIP
+      @country_code = country_code
+    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'] : nil
+      street = hash.key?('street') ? hash['street'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : nil
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsSubMerchantAddress.new(postal_code,
+                                     street,
+                                     city,
+                                     country_code,
+                                     state)
+    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}, street: #{@street}, city: #{@city}, state:"\
+      " #{@state}, country_code: #{@country_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}, street: #{@street.inspect}, city:"\
+      " #{@city.inspect}, state: #{@state.inspect}, country_code: #{@country_code.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_subscription_customer_agreement.rb

@@ -0,0 +1,106 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_customer_agreement'
+
+module Payments
+  # PaymentsSubscriptionCustomerAgreement Model.
+  class PaymentsSubscriptionCustomerAgreement < PaymentsCustomerAgreement
+    # Set to `first` to store a card or `subsequent` to use a previously stored
+    # card.
+    # @return [StoredCardUsageEnum]
+    attr_accessor :stored_card_usage
+
+    # 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['scheme_reference'] = 'schemeReference'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        scheme_reference
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(stored_card_usage = nil, scheme_reference = SKIP,
+                   type = 'subscription')
+      @stored_card_usage = stored_card_usage
+      @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.
+      stored_card_usage =
+        hash.key?('storedCardUsage') ? hash['storedCardUsage'] : nil
+      scheme_reference =
+        hash.key?('schemeReference') ? hash['schemeReference'] : SKIP
+      type = hash['type'] ||= 'subscription'
+
+      # Create object from extracted values.
+      PaymentsSubscriptionCustomerAgreement.new(stored_card_usage,
+                                                scheme_reference,
+                                                type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsSubscriptionCustomerAgreement | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.stored_card_usage,
+                                     ->(val) { StoredCardUsageEnum.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['storedCardUsage'],
+                            ->(val) { StoredCardUsageEnum.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},"\
+      " 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},"\
+      " scheme_reference: #{@scheme_reference.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_three_ds.rb

@@ -0,0 +1,217 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # 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.
+  class PaymentsThreeDS < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_reader :mode
+
+    # An object containing 3DS challenge preferences and configuration.
+    # @return [Challenge]
+    attr_accessor :challenge
+
+    # An object containing device data for 3DS & Fraud assessment.
+    # @return [DeviceData]
+    attr_accessor :device_data
+
+    # Attempt authorization (without liability shift) using an authentication
+    # outage exemption in the event of a 3DS network failure. Even with this
+    # boolean set it is not currently part of default merchant setup. See [how
+    # to enable authentication outage
+    # exemptions](/products/payments/enable-features/3ds-authentication#how-to-e
+    # nable-authentication-outage-exemptions)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :exemption_on_outage
+
+    # Has the account been flagged for suspicious activity.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :previous_suspicious_activity
+
+    # Has the account been flagged for suspicious activity.
+    # @return [UserTypeEnum]
+    attr_accessor :user_type
+
+    # Customer account history.
+    # @return [AccountHistory]
+    attr_accessor :account_history
+
+    # Repeat of a previous order.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :reorder
+
+    # Expected date that a pre-ordered purchase will be available.
+    # @return [String]
+    attr_accessor :pre_order_date
+
+    # Object containing details of the last transaction.
+    # @return [TransactionHistory]
+    attr_accessor :transaction_history
+
+    # If the order is being used to purchase a gift card.
+    # @return [PaymentsGiftCardsPurchase]
+    attr_accessor :gift_cards_purchase
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['mode'] = 'mode'
+      @_hash['challenge'] = 'challenge'
+      @_hash['device_data'] = 'deviceData'
+      @_hash['exemption_on_outage'] = 'exemptionOnOutage'
+      @_hash['previous_suspicious_activity'] = 'previousSuspiciousActivity'
+      @_hash['user_type'] = 'userType'
+      @_hash['account_history'] = 'accountHistory'
+      @_hash['reorder'] = 'reorder'
+      @_hash['pre_order_date'] = 'preOrderDate'
+      @_hash['transaction_history'] = 'transactionHistory'
+      @_hash['gift_cards_purchase'] = 'giftCardsPurchase'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        exemption_on_outage
+        previous_suspicious_activity
+        user_type
+        account_history
+        reorder
+        pre_order_date
+        transaction_history
+        gift_cards_purchase
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(challenge = nil, device_data = nil,
+                   exemption_on_outage = false,
+                   previous_suspicious_activity = SKIP, user_type = SKIP,
+                   account_history = SKIP, reorder = SKIP,
+                   pre_order_date = SKIP, transaction_history = SKIP,
+                   gift_cards_purchase = SKIP)
+      @type = 'integrated'
+      @mode = 'always'
+      @challenge = challenge
+      @device_data = device_data
+      @exemption_on_outage = exemption_on_outage unless exemption_on_outage == SKIP
+      unless previous_suspicious_activity == SKIP
+        @previous_suspicious_activity =
+          previous_suspicious_activity
+      end
+      @user_type = user_type unless user_type == SKIP
+      @account_history = account_history unless account_history == SKIP
+      @reorder = reorder unless reorder == SKIP
+      @pre_order_date = pre_order_date unless pre_order_date == SKIP
+      @transaction_history = transaction_history unless transaction_history == SKIP
+      @gift_cards_purchase = gift_cards_purchase unless gift_cards_purchase == 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.
+      challenge = Challenge.from_hash(hash['challenge']) if hash['challenge']
+      device_data = DeviceData.from_hash(hash['deviceData']) if hash['deviceData']
+      exemption_on_outage = hash['exemptionOnOutage'] ||= false
+      previous_suspicious_activity =
+        hash.key?('previousSuspiciousActivity') ? hash['previousSuspiciousActivity'] : SKIP
+      user_type = hash.key?('userType') ? hash['userType'] : SKIP
+      account_history = AccountHistory.from_hash(hash['accountHistory']) if hash['accountHistory']
+      reorder = hash.key?('reorder') ? hash['reorder'] : SKIP
+      pre_order_date = hash.key?('preOrderDate') ? hash['preOrderDate'] : SKIP
+      transaction_history = TransactionHistory.from_hash(hash['transactionHistory']) if
+        hash['transactionHistory']
+      gift_cards_purchase = PaymentsGiftCardsPurchase.from_hash(hash['giftCardsPurchase']) if
+        hash['giftCardsPurchase']
+
+      # Create object from extracted values.
+      PaymentsThreeDS.new(challenge,
+                          device_data,
+                          exemption_on_outage,
+                          previous_suspicious_activity,
+                          user_type,
+                          account_history,
+                          reorder,
+                          pre_order_date,
+                          transaction_history,
+                          gift_cards_purchase)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsThreeDS | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.type,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.mode,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.challenge,
+                                  ->(val) { Challenge.validate(val) },
+                                  is_model_hash: true) and
+            APIHelper.valid_type?(value.device_data,
+                                  ->(val) { DeviceData.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['type'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['mode'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['challenge'],
+                                ->(val) { Challenge.validate(val) },
+                                is_model_hash: true) and
+          APIHelper.valid_type?(value['deviceData'],
+                                ->(val) { DeviceData.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} type: #{@type}, mode: #{@mode}, challenge: #{@challenge}, device_data:"\
+      " #{@device_data}, exemption_on_outage: #{@exemption_on_outage},"\
+      " previous_suspicious_activity: #{@previous_suspicious_activity}, user_type: #{@user_type},"\
+      " account_history: #{@account_history}, reorder: #{@reorder}, pre_order_date:"\
+      " #{@pre_order_date}, transaction_history: #{@transaction_history}, gift_cards_purchase:"\
+      " #{@gift_cards_purchase}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, mode: #{@mode.inspect}, challenge:"\
+      " #{@challenge.inspect}, device_data: #{@device_data.inspect}, exemption_on_outage:"\
+      " #{@exemption_on_outage.inspect}, previous_suspicious_activity:"\
+      " #{@previous_suspicious_activity.inspect}, user_type: #{@user_type.inspect},"\
+      " account_history: #{@account_history.inspect}, reorder: #{@reorder.inspect},"\
+      " pre_order_date: #{@pre_order_date.inspect}, transaction_history:"\
+      " #{@transaction_history.inspect}, gift_cards_purchase: #{@gift_cards_purchase.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_transfer_address.rb

@@ -0,0 +1,112 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Sender's address.
+  class PaymentsTransferAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Must be supplied if `city` is provided.
+    # @return [String]
+    attr_accessor :address1
+
+    # Must be supplied if `city` is provided.
+    # @return [String]
+    attr_accessor :address2
+
+    # Must be supplied if `address1` is provided.
+    # @return [String]
+    attr_accessor :city
+
+    # Must be supplied if `address1` is provided.
+    # @return [String]
+    attr_accessor :postal_code
+
+    # 1-3 alphanumeric characters and spaces.
+    # @return [String]
+    attr_accessor :state
+
+    # Country code in [ISO 3166-1 Alpha-2
+    # format](/products/reference/supported-countries-currencies#iso-country-cod
+    # es).
+    # @return [String]
+    attr_accessor :country_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['address1'] = 'address1'
+      @_hash['address2'] = 'address2'
+      @_hash['city'] = 'city'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'countryCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address1
+        address2
+        city
+        postal_code
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country_code = nil, address1 = SKIP, address2 = SKIP,
+                   city = SKIP, postal_code = SKIP, state = SKIP)
+      @address1 = address1 unless address1 == SKIP
+      @address2 = address2 unless address2 == SKIP
+      @city = city unless city == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @state = state unless state == SKIP
+      @country_code = country_code
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : nil
+      address1 = hash.key?('address1') ? hash['address1'] : SKIP
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      city = hash.key?('city') ? hash['city'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsTransferAddress.new(country_code,
+                                  address1,
+                                  address2,
+                                  city,
+                                  postal_code,
+                                  state)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address1: #{@address1}, address2: #{@address2}, city: #{@city},"\
+      " postal_code: #{@postal_code}, state: #{@state}, country_code: #{@country_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} address1: #{@address1.inspect}, address2: #{@address2.inspect}, city:"\
+      " #{@city.inspect}, postal_code: #{@postal_code.inspect}, state: #{@state.inspect},"\
+      " country_code: #{@country_code.inspect}>"
+    end
+  end
+end