hamza-payments-query-sdk 1.0.0

data/lib/payments/models/payments_card_plain_payment_instrument.rb

@@ -0,0 +1,149 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+require_relative 'payments_payment_instrument'
+
+module Payments
+  # PaymentsCardPlainPaymentInstrument Model.
+  class PaymentsCardPlainPaymentInstrument < PaymentsPaymentInstrument
+    # Customer's card number.
+    # @return [String]
+    attr_accessor :card_number
+
+    # The name on your customer's card. Required if  instruction.tokenCreation
+    # is present. However we recommend that you supply this to improve
+    # authentication rates.
+    # @return [String]
+    attr_accessor :card_holder_name
+
+    # Contains your customer's card or token expiry date.
+    # @return [ExpiryDate]
+    attr_accessor :expiry_date
+
+    # CVC is a unique set of 3 or 4 numbers on the back of the card. Our API
+    # checks to see if the CVC supplied matches the CVC held by the issuing
+    # bank.
+    # @return [String]
+    attr_accessor :cvc
+
+    # Contains the billing address information.
+    # @return [BillingAddress]
+    attr_accessor :billing_address
+
+    # An object containing specific routing preferences.
+    # @return [Routing]
+    attr_accessor :routing
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['card_holder_name'] = 'cardHolderName'
+      @_hash['expiry_date'] = 'expiryDate'
+      @_hash['cvc'] = 'cvc'
+      @_hash['billing_address'] = 'billingAddress'
+      @_hash['routing'] = 'routing'
+      @_hash = super().merge(@_hash)
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      _arr = %w[
+        card_holder_name
+        cvc
+        billing_address
+        routing
+      ]
+      (_arr << super()).flatten!
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      _arr = []
+      (_arr << super()).flatten!
+    end
+
+    def initialize(card_number = nil, expiry_date = nil,
+                   card_holder_name = SKIP, cvc = SKIP, billing_address = SKIP,
+                   routing = SKIP, type = 'plain')
+      @card_number = card_number
+      @card_holder_name = card_holder_name unless card_holder_name == SKIP
+      @expiry_date = expiry_date
+      @cvc = cvc unless cvc == SKIP
+      @billing_address = billing_address unless billing_address == SKIP
+      @routing = routing unless routing == 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.
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : nil
+      expiry_date = ExpiryDate.from_hash(hash['expiryDate']) if hash['expiryDate']
+      card_holder_name =
+        hash.key?('cardHolderName') ? hash['cardHolderName'] : SKIP
+      cvc = hash.key?('cvc') ? hash['cvc'] : SKIP
+      billing_address = BillingAddress.from_hash(hash['billingAddress']) if hash['billingAddress']
+      routing = Routing.from_hash(hash['routing']) if hash['routing']
+      type = hash['type'] ||= 'plain'
+
+      # Create object from extracted values.
+      PaymentsCardPlainPaymentInstrument.new(card_number,
+                                             expiry_date,
+                                             card_holder_name,
+                                             cvc,
+                                             billing_address,
+                                             routing,
+                                             type)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsCardPlainPaymentInstrument | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.card_number,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.expiry_date,
+                                  ->(val) { ExpiryDate.validate(val) },
+                                  is_model_hash: true)
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['cardNumber'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['expiryDate'],
+                                ->(val) { ExpiryDate.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
+      super_string = super().sub(/^<[^ ]+ /, '').sub(/>$/, '')
+      "<#{class_name} #{super_string}, card_number: #{@card_number}, card_holder_name:"\
+      " #{@card_holder_name}, expiry_date: #{@expiry_date}, cvc: #{@cvc}, billing_address:"\
+      " #{@billing_address}, routing: #{@routing}>"
+    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}, card_number: #{@card_number.inspect}, card_holder_name:"\
+      " #{@card_holder_name.inspect}, expiry_date: #{@expiry_date.inspect}, cvc: #{@cvc.inspect},"\
+      " billing_address: #{@billing_address.inspect}, routing: #{@routing.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_customer_agreement.rb

@@ -0,0 +1,79 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains specific customer agreements for the transaction.
+  class PaymentsCustomerAgreement < 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['cardOnFile'] = PaymentsCardOnFileCustomerAgreement
+        @_discriminators['installment'] = PaymentsInstallmentCustomerAgreement
+        @_discriminators['subscription'] = PaymentsSubscriptionCustomerAgreement
+        @_discriminators['unscheduled'] = PaymentsUnscheduledCustomerAgreement
+      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 = 'PaymentsCustomerAgreement')
+      @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'] ||= 'PaymentsCustomerAgreement'
+
+      # Create object from extracted values.
+      PaymentsCustomerAgreement.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_email_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
+  # PaymentsEmailAccount Model.
+  class PaymentsEmailAccount < PaymentsRecipientAccount
+    # Recipient's email address.
+    # @return [String]
+    attr_accessor :email_address
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['email_address'] = 'emailAddress'
+      @_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(email_address = nil, type = 'email')
+      @email_address = email_address
+
+      # 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.
+      email_address = hash.key?('emailAddress') ? hash['emailAddress'] : nil
+      type = hash['type'] ||= 'email'
+
+      # Create object from extracted values.
+      PaymentsEmailAccount.new(email_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}, email_address: #{@email_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}, email_address: #{@email_address.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_events.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 PaymentsEvents < 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.
+      PaymentsEvents.new(href)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsEvents | 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

data/lib/payments/models/payments_exemption.rb

@@ -0,0 +1,102 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object containing information about the exemption.
+  class PaymentsExemption < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Was an exemption returned by Worldpay's TRA assessment.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :granted
+
+    # Indicates whether the exemption has been placed in a payment authorization
+    # request or 3DS authentication request.
+    # @return [PlacementEnum]
+    attr_accessor :placement
+
+    # The type of applied exemption.
+    # @return [Type2Enum]
+    attr_accessor :type
+
+    # The result of the exemption placement request.
+    # @return [ResultEnum]
+    attr_accessor :result
+
+    # The reason returned by the card issuer.
+    # @return [ReasonEnum]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['granted'] = 'granted'
+      @_hash['placement'] = 'placement'
+      @_hash['type'] = 'type'
+      @_hash['result'] = 'result'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        granted
+        placement
+        type
+        result
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(granted = SKIP, placement = SKIP, type = SKIP, result = SKIP,
+                   reason = SKIP)
+      @granted = granted unless granted == SKIP
+      @placement = placement unless placement == SKIP
+      @type = type unless type == SKIP
+      @result = result unless result == SKIP
+      @reason = reason unless reason == 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.
+      granted = hash.key?('granted') ? hash['granted'] : SKIP
+      placement = hash.key?('placement') ? hash['placement'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      result = hash.key?('result') ? hash['result'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      PaymentsExemption.new(granted,
+                            placement,
+                            type,
+                            result,
+                            reason)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} granted: #{@granted}, placement: #{@placement}, type: #{@type}, result:"\
+      " #{@result}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} granted: #{@granted.inspect}, placement: #{@placement.inspect}, type:"\
+      " #{@type.inspect}, result: #{@result.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/payments/models/payments_fraud.rb

@@ -0,0 +1,107 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # 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.
+  class PaymentsFraud < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Enable a FraudSight risk assessment
+    # @return [String]
+    attr_reader :type
+
+    # Perform the Fraud assessment but do not act on the outcome.
+    #             Normally used for the initial launch while the data model is
+    # maturing.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :silent_mode
+
+    # Device fingerprint provided by Threatmetrix.
+    # @return [String]
+    attr_accessor :tmx_session_id
+
+    # Additional values specific to your order that can be used to create manual
+    # fraud rules.
+    # @return [Custom]
+    attr_accessor :custom
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['silent_mode'] = 'silentMode'
+      @_hash['tmx_session_id'] = 'tmxSessionId'
+      @_hash['custom'] = 'custom'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        silent_mode
+        tmx_session_id
+        custom
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(silent_mode = false, tmx_session_id = SKIP, custom = SKIP)
+      @type = 'fraudSight'
+      @silent_mode = silent_mode unless silent_mode == SKIP
+      @tmx_session_id = tmx_session_id unless tmx_session_id == SKIP
+      @custom = custom unless custom == 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.
+      silent_mode = hash['silentMode'] ||= false
+      tmx_session_id = hash.key?('tmxSessionId') ? hash['tmxSessionId'] : SKIP
+      custom = Custom.from_hash(hash['custom']) if hash['custom']
+
+      # Create object from extracted values.
+      PaymentsFraud.new(silent_mode,
+                        tmx_session_id,
+                        custom)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [PaymentsFraud | 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 })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['type'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, silent_mode: #{@silent_mode}, tmx_session_id:"\
+      " #{@tmx_session_id}, custom: #{@custom}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, silent_mode: #{@silent_mode.inspect},"\
+      " tmx_session_id: #{@tmx_session_id.inspect}, custom: #{@custom.inspect}>"
+    end
+  end
+end