hamza-payments-query-sdk 1.0.0

data/lib/payments/models/authorization_requested.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # AuthorizationRequested Model.
+  class AuthorizationRequested < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Worldpay has received your authorization request.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'authorizationRequested'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationRequested.new(timestamp,
+                                 command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthorizationRequested | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/authorization_succeeded.rb

@@ -0,0 +1,104 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # AuthorizationSucceeded Model.
+  class AuthorizationSucceeded < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your authorization request was successfully approved by the card issuer.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Outcome of the event. For every requested event there can be a successful
+    # or refused event outcome.
+    # @return [Outcome16Enum]
+    attr_accessor :outcome
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['outcome'] = 'outcome'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        outcome
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, outcome = SKIP, command_id = SKIP)
+      @event_name = 'authorizationSucceeded'
+      @timestamp = timestamp unless timestamp == SKIP
+      @outcome = outcome unless outcome == SKIP
+      @command_id = command_id unless command_id == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      outcome = hash.key?('outcome') ? hash['outcome'] : SKIP
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationSucceeded.new(timestamp,
+                                 outcome,
+                                 command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthorizationSucceeded | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, outcome: #{@outcome},"\
+      " command_id: #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " outcome: #{@outcome.inspect}, command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/authorization_timed_out.rb

@@ -0,0 +1,94 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # AuthorizationTimedOut Model.
+  class AuthorizationTimedOut < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your authorization request timed out.
+    # @return [String]
+    attr_reader :event_name
+
+    # The ISO 8601 date-time at which the event was created.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Unique identifier generated by us for a single instance of an interaction
+    # (command) with the Worldpay API.
+    # @return [String]
+    attr_accessor :command_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['event_name'] = 'eventName'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['command_id'] = 'commandId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        timestamp
+        command_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(timestamp = SKIP, command_id = SKIP)
+      @event_name = 'authorizationTimedOut'
+      @timestamp = timestamp unless timestamp == SKIP
+      @command_id = command_id unless command_id == 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.
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+      command_id = hash.key?('commandId') ? hash['commandId'] : SKIP
+
+      # Create object from extracted values.
+      AuthorizationTimedOut.new(timestamp,
+                                command_id)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [AuthorizationTimedOut | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.event_name,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['eventName'],
+                            ->(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} event_name: #{@event_name}, timestamp: #{@timestamp}, command_id:"\
+      " #{@command_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} event_name: #{@event_name.inspect}, timestamp: #{@timestamp.inspect},"\
+      " command_id: #{@command_id.inspect}>"
+    end
+  end
+end

data/lib/payments/models/authorization_type1_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # An object that contains authorization type.
+  class AuthorizationType1Enum
+    AUTHORIZATION_TYPE1_ENUM = [
+      # TODO: Write general description for AUTHORIZATION
+      AUTHORIZATION = 'authorization'.freeze,
+
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTHORIZATION_TYPE1_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/authorization_type_enum.rb

@@ -0,0 +1,23 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The authorization type of the payment.
+  class AuthorizationTypeEnum
+    AUTHORIZATION_TYPE_ENUM = [
+      # TODO: Write general description for AUTHORIZATION
+      AUTHORIZATION = 'authorization'.freeze,
+
+      # TODO: Write general description for SALE
+      SALE = 'sale'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      AUTHORIZATION_TYPE_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/avs_not_matched_enum.rb

@@ -0,0 +1,25 @@
+# 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 `address` or
+  # `postcode` AVS is `notMatched`, set `disabled` to continue with
+  # `sentForSettlement`.
+  class AvsNotMatchedEnum
+    AVS_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?
+
+      AVS_NOT_MATCHED_ENUM.include?(value)
+    end
+  end
+end

data/lib/payments/models/base_model.rb

@@ -0,0 +1,110 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Base model.
+  # rubocop:disable all
+  class BaseModel < CoreLibrary::BaseModel
+    # Returns a Hash representation of the current object.
+    def to_hash
+      # validating the model being serialized
+      self.class.validate(self) if self.class.respond_to?(:validate)
+
+      hash = {}
+      instance_variables.each do |name|
+        value = instance_variable_get(name)
+        name = name[1..]
+        if name == 'additional_properties'
+          additional_properties = process_additional_properties(value, self.class.names)
+          hash.merge!(additional_properties)
+        else
+          key = self.class.names.key?(name) ? self.class.names[name] : name
+          optional_fields = self.class.optionals
+          nullable_fields = self.class.nullables
+          if value.nil?
+            next unless nullable_fields.include?(name)
+
+            if !optional_fields.include?(name) && !nullable_fields.include?(name)
+              raise ArgumentError,
+                    "`#{name}` cannot be nil in `#{self.class}`. Please specify a valid value."
+            end
+          end
+
+          hash[key] = nil
+          unless value.nil?
+            if respond_to?("to_custom_#{name}")
+              if (value.instance_of? Array) || (value.instance_of? Hash)
+                params = [hash, key]
+                hash[key] = send("to_custom_#{name}", *params)
+              else
+                hash[key] = send("to_custom_#{name}")
+              end
+            elsif respond_to?("to_union_type_#{name}")
+              hash[key] = send("to_union_type_#{name}")
+            elsif value.instance_of? Array
+              hash[key] = value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+            elsif value.instance_of? Hash
+              hash[key] = {}
+              value.each do |k, v|
+                hash[key][k] = v.is_a?(BaseModel) ? v.to_hash : v
+              end
+            else
+              hash[key] = value.is_a?(BaseModel) ? value.to_hash : value
+            end
+          end
+        end
+      end
+      hash
+    end
+
+    # Processes additional properties, ensuring no conflicts with existing properties.
+    def process_additional_properties(additional_properties, existing_prop_names)
+      hash = {}
+      additional_properties.each do |name, value|
+        check_for_conflict(name, existing_prop_names)
+
+        hash[name] = if value.is_a?(Array)
+                       process_array(value)
+                     elsif value.is_a?(Hash)
+                       process_hash(value)
+                     else
+                       process_basic_value(value)
+                     end
+      end
+      hash
+    end
+
+    # Checks if an additional property conflicts with a model's existing property.
+    def check_for_conflict(name, existing_prop_names)
+      return unless existing_prop_names.key?(name)
+
+      raise ArgumentError, "An additional property key, '#{name}' conflicts with one of the model's properties"
+    end
+
+    # Processes an array of values, recursively calling `to_hash` on BaseModel objects.
+    def process_array(value)
+      value.map { |v| v.is_a?(BaseModel) ? v.to_hash : v }
+    end
+
+    # Processes a hash of values, recursively calling `to_hash` on BaseModel objects.
+    def process_hash(value)
+      value.transform_values do |v|
+        v.is_a?(BaseModel) ? v.to_hash : v
+      end
+    end
+
+    # Processes a basic value (non-array, non-hash).
+    def process_basic_value(value)
+      value.is_a?(BaseModel) ? value.to_hash : value
+    end
+
+    # Returns a JSON representation of the curent object.
+    def to_json(options = {})
+      hash = to_hash
+      hash.to_json(options)
+    end
+  end
+  # rubocop:enable all
+end

data/lib/payments/models/billing_address.rb

@@ -0,0 +1,147 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # Contains the billing address information.
+  class BillingAddress < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address line 1
+    # @return [String]
+    attr_accessor :address1
+
+    # Address line 2
+    # @return [String]
+    attr_accessor :address2
+
+    # Address line 3
+    # @return [String]
+    attr_accessor :address3
+
+    # Required for all countries except the following:            * IE
+    # @return [String]
+    attr_accessor :postal_code
+
+    # Address City
+    # @return [String]
+    attr_accessor :city
+
+    # Address State
+    # @return [String]
+    attr_accessor :state
+
+    # Must be provided 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['address3'] = 'address3'
+      @_hash['postal_code'] = 'postalCode'
+      @_hash['city'] = 'city'
+      @_hash['state'] = 'state'
+      @_hash['country_code'] = 'countryCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        address2
+        address3
+        postal_code
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(address1 = nil, city = nil, country_code = nil,
+                   address2 = SKIP, address3 = SKIP, postal_code = SKIP,
+                   state = SKIP)
+      @address1 = address1
+      @address2 = address2 unless address2 == SKIP
+      @address3 = address3 unless address3 == SKIP
+      @postal_code = postal_code unless postal_code == SKIP
+      @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.
+      address1 = hash.key?('address1') ? hash['address1'] : nil
+      city = hash.key?('city') ? hash['city'] : nil
+      country_code = hash.key?('countryCode') ? hash['countryCode'] : nil
+      address2 = hash.key?('address2') ? hash['address2'] : SKIP
+      address3 = hash.key?('address3') ? hash['address3'] : SKIP
+      postal_code = hash.key?('postalCode') ? hash['postalCode'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Create object from extracted values.
+      BillingAddress.new(address1,
+                         city,
+                         country_code,
+                         address2,
+                         address3,
+                         postal_code,
+                         state)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [BillingAddress | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return (
+          APIHelper.valid_type?(value.address1,
+                                ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.city,
+                                  ->(val) { val.instance_of? String }) and
+            APIHelper.valid_type?(value.country_code,
+                                  ->(val) { val.instance_of? String })
+        )
+      end
+
+      return false unless value.instance_of? Hash
+
+      (
+        APIHelper.valid_type?(value['address1'],
+                              ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['city'],
+                                ->(val) { val.instance_of? String }) and
+          APIHelper.valid_type?(value['countryCode'],
+                                ->(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} address1: #{@address1}, address2: #{@address2}, address3: #{@address3},"\
+      " postal_code: #{@postal_code}, 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} address1: #{@address1.inspect}, address2: #{@address2.inspect}, address3:"\
+      " #{@address3.inspect}, postal_code: #{@postal_code.inspect}, city: #{@city.inspect}, state:"\
+      " #{@state.inspect}, country_code: #{@country_code.inspect}>"
+    end
+  end
+end

data/lib/payments/models/browser_color_depth_enum.rb

@@ -0,0 +1,41 @@
+# payments
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module Payments
+  # The color depth of your customers browser
+  class BrowserColorDepthEnum
+    BROWSER_COLOR_DEPTH_ENUM = [
+      # TODO: Write general description for ENUM_1
+      ENUM_1 = '1'.freeze,
+
+      # TODO: Write general description for ENUM_4
+      ENUM_4 = '4'.freeze,
+
+      # TODO: Write general description for ENUM_8
+      ENUM_8 = '8'.freeze,
+
+      # TODO: Write general description for ENUM_15
+      ENUM_15 = '15'.freeze,
+
+      # TODO: Write general description for ENUM_16
+      ENUM_16 = '16'.freeze,
+
+      # TODO: Write general description for ENUM_24
+      ENUM_24 = '24'.freeze,
+
+      # TODO: Write general description for ENUM_32
+      ENUM_32 = '32'.freeze,
+
+      # TODO: Write general description for ENUM_48
+      ENUM_48 = '48'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      BROWSER_COLOR_DEPTH_ENUM.include?(value)
+    end
+  end
+end