# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.

require "date"
require "time"

module Algolia
  module Analytics
    class TopSearchWithRevenueAnalytics
      # Search query.
      attr_accessor :search

      # Number of searches.
      attr_accessor :count

      # Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
      attr_accessor :click_through_rate

      # Average position of a clicked search result in the list of search results. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
      attr_accessor :average_click_position

      # List of positions in the search results and clicks associated with this search.
      attr_accessor :click_positions

      # Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
      attr_accessor :conversion_rate

      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
      attr_accessor :tracked_search_count

      # Number of clicks associated with this search.
      attr_accessor :click_count

      # Number of conversions from this search.
      attr_accessor :conversion_count

      # Number of results (hits).
      attr_accessor :nb_hits

      # Revenue associated with this search, broken-down by currencies.
      attr_accessor :currencies

      # Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
      attr_accessor :add_to_cart_rate

      # Number of add-to-cart events from this search.
      attr_accessor :add_to_cart_count

      # Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn't receive any search requests with `clickAnalytics` set to true.
      attr_accessor :purchase_rate

      # Number of purchase events from this search.
      attr_accessor :purchase_count

      # Attribute mapping from ruby-style variable name to JSON key.
      def self.attribute_map
        {
          :search => :search,
          :count => :count,
          :click_through_rate => :clickThroughRate,
          :average_click_position => :averageClickPosition,
          :click_positions => :clickPositions,
          :conversion_rate => :conversionRate,
          :tracked_search_count => :trackedSearchCount,
          :click_count => :clickCount,
          :conversion_count => :conversionCount,
          :nb_hits => :nbHits,
          :currencies => :currencies,
          :add_to_cart_rate => :addToCartRate,
          :add_to_cart_count => :addToCartCount,
          :purchase_rate => :purchaseRate,
          :purchase_count => :purchaseCount
        }
      end

      # Returns all the JSON keys this model knows about
      def self.acceptable_attributes
        attribute_map.values
      end

      # Attribute type mapping.
      def self.types_mapping
        {
          :search => :"String",
          :count => :"Integer",
          :click_through_rate => :"Float",
          :average_click_position => :"Float",
          :click_positions => :"Array<ClickPositionsInner>",
          :conversion_rate => :"Float",
          :tracked_search_count => :"Integer",
          :click_count => :"Integer",
          :conversion_count => :"Integer",
          :nb_hits => :"Integer",
          :currencies => :"Hash<String, CurrenciesValue>",
          :add_to_cart_rate => :"Float",
          :add_to_cart_count => :"Integer",
          :purchase_rate => :"Float",
          :purchase_count => :"Integer"
        }
      end

      # List of attributes with nullable: true
      def self.openapi_nullable
        Set.new(
          [
            :click_through_rate,
            :average_click_position,
            :conversion_rate,
            :add_to_cart_rate,
            :purchase_rate
          ]
        )
      end

      # Initializes the object
      # @param [Hash] attributes Model attributes in the form of hash
      def initialize(attributes = {})
        if (!attributes.is_a?(Hash))
          raise(
            ArgumentError,
            "The input argument (attributes) must be a hash in `Algolia::TopSearchWithRevenueAnalytics` initialize method"
          )
        end

        # check to see if the attribute exists and convert string to symbol for hash key
        attributes = attributes.each_with_object({}) { |(k, v), h|
          if (!self.class.attribute_map.key?(k.to_sym))
            raise(
              ArgumentError,
              "`#{k}` is not a valid attribute in `Algolia::TopSearchWithRevenueAnalytics`. Please check the name to make sure it's valid. List of attributes: " +
                self.class.attribute_map.keys.inspect
            )
          end

          h[k.to_sym] = v
        }

        if attributes.key?(:search)
          self.search = attributes[:search]
        else
          self.search = nil
        end

        if attributes.key?(:count)
          self.count = attributes[:count]
        else
          self.count = nil
        end

        if attributes.key?(:click_through_rate)
          self.click_through_rate = attributes[:click_through_rate]
        else
          self.click_through_rate = nil
        end

        if attributes.key?(:average_click_position)
          self.average_click_position = attributes[:average_click_position]
        else
          self.average_click_position = nil
        end

        if attributes.key?(:click_positions)
          if (value = attributes[:click_positions]).is_a?(Array)
            self.click_positions = value
          end
        else
          self.click_positions = nil
        end

        if attributes.key?(:conversion_rate)
          self.conversion_rate = attributes[:conversion_rate]
        else
          self.conversion_rate = nil
        end

        if attributes.key?(:tracked_search_count)
          self.tracked_search_count = attributes[:tracked_search_count]
        else
          self.tracked_search_count = nil
        end

        if attributes.key?(:click_count)
          self.click_count = attributes[:click_count]
        else
          self.click_count = nil
        end

        if attributes.key?(:conversion_count)
          self.conversion_count = attributes[:conversion_count]
        else
          self.conversion_count = nil
        end

        if attributes.key?(:nb_hits)
          self.nb_hits = attributes[:nb_hits]
        else
          self.nb_hits = nil
        end

        if attributes.key?(:currencies)
          if (value = attributes[:currencies]).is_a?(Hash)
            self.currencies = value
          end
        else
          self.currencies = nil
        end

        if attributes.key?(:add_to_cart_rate)
          self.add_to_cart_rate = attributes[:add_to_cart_rate]
        else
          self.add_to_cart_rate = nil
        end

        if attributes.key?(:add_to_cart_count)
          self.add_to_cart_count = attributes[:add_to_cart_count]
        else
          self.add_to_cart_count = nil
        end

        if attributes.key?(:purchase_rate)
          self.purchase_rate = attributes[:purchase_rate]
        else
          self.purchase_rate = nil
        end

        if attributes.key?(:purchase_count)
          self.purchase_count = attributes[:purchase_count]
        else
          self.purchase_count = nil
        end
      end

      # Custom attribute writer method with validation
      # @param [Object] click_through_rate Value to be assigned
      def click_through_rate=(click_through_rate)
        if !click_through_rate.nil? && click_through_rate > 1
          raise ArgumentError, "invalid value for \"click_through_rate\", must be smaller than or equal to 1."
        end

        if !click_through_rate.nil? && click_through_rate < 0
          raise ArgumentError, "invalid value for \"click_through_rate\", must be greater than or equal to 0."
        end

        @click_through_rate = click_through_rate
      end

      # Custom attribute writer method with validation
      # @param [Object] average_click_position Value to be assigned
      def average_click_position=(average_click_position)
        if !average_click_position.nil? && average_click_position < 1
          raise ArgumentError, "invalid value for \"average_click_position\", must be greater than or equal to 1."
        end

        @average_click_position = average_click_position
      end

      # Custom attribute writer method with validation
      # @param [Object] click_positions Value to be assigned
      def click_positions=(click_positions)
        if click_positions.nil?
          raise ArgumentError, "click_positions cannot be nil"
        end

        if click_positions.length > 12
          raise(
            ArgumentError,
            "invalid value for \"click_positions\", number of items must be less than or equal to 12."
          )
        end

        if click_positions.length < 12
          raise(
            ArgumentError,
            "invalid value for \"click_positions\", number of items must be greater than or equal to 12."
          )
        end

        @click_positions = click_positions
      end

      # Custom attribute writer method with validation
      # @param [Object] conversion_rate Value to be assigned
      def conversion_rate=(conversion_rate)
        if !conversion_rate.nil? && conversion_rate > 1
          raise ArgumentError, "invalid value for \"conversion_rate\", must be smaller than or equal to 1."
        end

        if !conversion_rate.nil? && conversion_rate < 0
          raise ArgumentError, "invalid value for \"conversion_rate\", must be greater than or equal to 0."
        end

        @conversion_rate = conversion_rate
      end

      # Custom attribute writer method with validation
      # @param [Object] click_count Value to be assigned
      def click_count=(click_count)
        if click_count.nil?
          raise ArgumentError, "click_count cannot be nil"
        end

        if click_count < 0
          raise ArgumentError, "invalid value for \"click_count\", must be greater than or equal to 0."
        end

        @click_count = click_count
      end

      # Custom attribute writer method with validation
      # @param [Object] conversion_count Value to be assigned
      def conversion_count=(conversion_count)
        if conversion_count.nil?
          raise ArgumentError, "conversion_count cannot be nil"
        end

        if conversion_count < 0
          raise ArgumentError, "invalid value for \"conversion_count\", must be greater than or equal to 0."
        end

        @conversion_count = conversion_count
      end

      # Custom attribute writer method with validation
      # @param [Object] add_to_cart_rate Value to be assigned
      def add_to_cart_rate=(add_to_cart_rate)
        if !add_to_cart_rate.nil? && add_to_cart_rate > 1
          raise ArgumentError, "invalid value for \"add_to_cart_rate\", must be smaller than or equal to 1."
        end

        if !add_to_cart_rate.nil? && add_to_cart_rate < 0
          raise ArgumentError, "invalid value for \"add_to_cart_rate\", must be greater than or equal to 0."
        end

        @add_to_cart_rate = add_to_cart_rate
      end

      # Custom attribute writer method with validation
      # @param [Object] add_to_cart_count Value to be assigned
      def add_to_cart_count=(add_to_cart_count)
        if add_to_cart_count.nil?
          raise ArgumentError, "add_to_cart_count cannot be nil"
        end

        if add_to_cart_count < 0
          raise ArgumentError, "invalid value for \"add_to_cart_count\", must be greater than or equal to 0."
        end

        @add_to_cart_count = add_to_cart_count
      end

      # Custom attribute writer method with validation
      # @param [Object] purchase_rate Value to be assigned
      def purchase_rate=(purchase_rate)
        if !purchase_rate.nil? && purchase_rate > 1
          raise ArgumentError, "invalid value for \"purchase_rate\", must be smaller than or equal to 1."
        end

        if !purchase_rate.nil? && purchase_rate < 0
          raise ArgumentError, "invalid value for \"purchase_rate\", must be greater than or equal to 0."
        end

        @purchase_rate = purchase_rate
      end

      # Checks equality by comparing each attribute.
      # @param [Object] Object to be compared
      def ==(other)
        return true if self.equal?(other)
        self.class == other.class &&
          search == other.search &&
          count == other.count &&
          click_through_rate == other.click_through_rate &&
          average_click_position == other.average_click_position &&
          click_positions == other.click_positions &&
          conversion_rate == other.conversion_rate &&
          tracked_search_count == other.tracked_search_count &&
          click_count == other.click_count &&
          conversion_count == other.conversion_count &&
          nb_hits == other.nb_hits &&
          currencies == other.currencies &&
          add_to_cart_rate == other.add_to_cart_rate &&
          add_to_cart_count == other.add_to_cart_count &&
          purchase_rate == other.purchase_rate &&
          purchase_count == other.purchase_count
      end

      # @see the `==` method
      # @param [Object] Object to be compared
      def eql?(other)
        self == other
      end

      # Calculates hash code according to all attributes.
      # @return [Integer] Hash code
      def hash
        [
          search,
          count,
          click_through_rate,
          average_click_position,
          click_positions,
          conversion_rate,
          tracked_search_count,
          click_count,
          conversion_count,
          nb_hits,
          currencies,
          add_to_cart_rate,
          add_to_cart_count,
          purchase_rate,
          purchase_count
        ].hash
      end

      # Builds the object from hash
      # @param [Hash] attributes Model attributes in the form of hash
      # @return [Object] Returns the model itself
      def self.build_from_hash(attributes)
        return nil unless attributes.is_a?(Hash)
        attributes = attributes.transform_keys(&:to_sym)
        transformed_hash = {}
        types_mapping.each_pair do |key, type|
          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
            transformed_hash[key.to_sym] = nil
          elsif type =~ /\AArray<(.*)>/i
            # check to ensure the input is an array given that the attribute
            # is documented as an array but the input is not
            if attributes[attribute_map[key]].is_a?(Array)
              transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
                _deserialize(::Regexp.last_match(1), v)
              }
            end
          elsif !attributes[attribute_map[key]].nil?
            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
          end
        end

        new(transformed_hash)
      end

      # Deserializes the data based on type
      # @param string type Data type
      # @param string value Value to be deserialized
      # @return [Object] Deserialized data
      def self._deserialize(type, value)
        case type.to_sym
        when :Time
          Time.parse(value)
        when :Date
          Date.parse(value)
        when :String
          value.to_s
        when :Integer
          value.to_i
        when :Float
          value.to_f
        when :Boolean
          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
            true
          else
            false
          end

        when :Object
          # generic object (usually a Hash), return directly
          value
        when /\AArray<(?<inner_type>.+)>\z/
          inner_type = Regexp.last_match[:inner_type]
          value.map { |v| _deserialize(inner_type, v) }
        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
          k_type = Regexp.last_match[:k_type]
          v_type = Regexp.last_match[:v_type]
          {}.tap do |hash|
            value.each do |k, v|
              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
            end
          end
          # model
        else
          # models (e.g. Pet) or oneOf
          klass = Algolia::Analytics.const_get(type)
          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
            .build_from_hash(value)
        end
      end

      # Returns the string representation of the object
      # @return [String] String presentation of the object
      def to_s
        to_hash.to_s
      end

      # to_body is an alias to to_hash (backward compatibility)
      # @return [Hash] Returns the object in the form of hash
      def to_body
        to_hash
      end

      def to_json(*_args)
        to_hash.to_json
      end

      # Returns the object in the form of hash
      # @return [Hash] Returns the object in the form of hash
      def to_hash
        hash = {}
        self.class.attribute_map.each_pair do |attr, param|
          value = send(attr)
          if value.nil?
            is_nullable = self.class.openapi_nullable.include?(attr)
            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
          end

          hash[param] = _to_hash(value)
        end

        hash
      end

      # Outputs non-array value in the form of hash
      # For object, use to_hash. Otherwise, just return the value
      # @param [Object] value Any valid value
      # @return [Hash] Returns the value in the form of hash
      def _to_hash(value)
        if value.is_a?(Array)
          value.compact.map { |v| _to_hash(v) }
        elsif value.is_a?(Hash)
          {}.tap do |hash|
            value.each { |k, v| hash[k] = _to_hash(v) }
          end
        elsif value.respond_to?(:to_hash)
          value.to_hash
        else
          value
        end
      end

    end

  end
end