algolia 3.0.0.alpha.14 → 3.0.0.alpha.15

data/lib/algolia/models/analytics/top_searches_response.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopSearchesResponse
-      # Top searches with their hits count.
+      # Most popular searches and their number of search results (hits).
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Analytics
     class TopSearchesResponseWithAnalytics
-      # Top searches with their hits count and analytics.
+      # Most popular searches and their associated click and conversion metrics.
       attr_accessor :searches
 
       # Attribute mapping from ruby-style variable name to JSON key.

data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb

@@ -0,0 +1,201 @@
+# 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 TopSearchesResponseWithRevenueAnalytics
+      # Most popular searches, including their click and revenue metrics.
+      attr_accessor :searches
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :searches => :searches
+        }
+      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
+        {
+          :searches => :'Array<TopSearchWithRevenueAnalytics>'
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # Initializes the object
+      # @param [Hash] attributes Model attributes in the form of hash
+      def initialize(attributes = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::TopSearchesResponseWithRevenueAnalytics` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::TopSearchesResponseWithRevenueAnalytics`. 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
+        end
+
+        if attributes.key?(:searches)
+          if (value = attributes[:searches]).is_a?(Array)
+            self.searches = value
+          end
+        else
+          self.searches = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          searches == other.searches
+      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
+        [searches].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
+        else # model
+          # 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

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # 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.
 
 module Algolia
-  VERSION = '3.0.0.alpha.14'.freeze
+  VERSION = '3.0.0.alpha.15'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.0.0.alpha.14
+  version: 3.0.0.alpha.15
 platform: ruby
 authors:
 - Algolia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-19 00:00:00.000000000 Z
+date: 2024-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -146,7 +146,7 @@ files:
 - lib/algolia/models/abtesting/ab_tests_variant_search_params.rb
 - lib/algolia/models/abtesting/add_ab_tests_request.rb
 - lib/algolia/models/abtesting/add_ab_tests_variant.rb
-- lib/algolia/models/abtesting/currencies_value.rb
+- lib/algolia/models/abtesting/currency.rb
 - lib/algolia/models/abtesting/custom_search_params.rb
 - lib/algolia/models/abtesting/error_base.rb
 - lib/algolia/models/abtesting/filter_effects.rb
@@ -154,18 +154,31 @@ files:
 - lib/algolia/models/abtesting/filter_effects_outliers.rb
 - lib/algolia/models/abtesting/list_ab_tests_response.rb
 - lib/algolia/models/abtesting/variant.rb
-- lib/algolia/models/analytics/average_click_event.rb
-- lib/algolia/models/analytics/click_position.rb
-- lib/algolia/models/analytics/click_through_rate_event.rb
-- lib/algolia/models/analytics/conversion_rate_event.rb
+- lib/algolia/models/analytics/click_positions_inner.rb
+- lib/algolia/models/analytics/currencies_value.rb
+- lib/algolia/models/analytics/daily_add_to_cart_rates.rb
+- lib/algolia/models/analytics/daily_average_clicks.rb
+- lib/algolia/models/analytics/daily_click_through_rates.rb
+- lib/algolia/models/analytics/daily_conversion_rates.rb
+- lib/algolia/models/analytics/daily_no_click_rates.rb
+- lib/algolia/models/analytics/daily_no_results_rates.rb
+- lib/algolia/models/analytics/daily_purchase_rates.rb
+- lib/algolia/models/analytics/daily_revenue.rb
+- lib/algolia/models/analytics/daily_searches.rb
+- lib/algolia/models/analytics/daily_searches_no_clicks.rb
+- lib/algolia/models/analytics/daily_searches_no_results.rb
+- lib/algolia/models/analytics/daily_users.rb
 - lib/algolia/models/analytics/direction.rb
 - lib/algolia/models/analytics/error_base.rb
+- lib/algolia/models/analytics/get_add_to_cart_rate_response.rb
 - lib/algolia/models/analytics/get_average_click_position_response.rb
 - lib/algolia/models/analytics/get_click_positions_response.rb
 - lib/algolia/models/analytics/get_click_through_rate_response.rb
-- lib/algolia/models/analytics/get_conversation_rate_response.rb
+- lib/algolia/models/analytics/get_conversion_rate_response.rb
 - lib/algolia/models/analytics/get_no_click_rate_response.rb
 - lib/algolia/models/analytics/get_no_results_rate_response.rb
+- lib/algolia/models/analytics/get_purchase_rate_response.rb
+- lib/algolia/models/analytics/get_revenue.rb
 - lib/algolia/models/analytics/get_searches_count_response.rb
 - lib/algolia/models/analytics/get_searches_no_clicks_response.rb
 - lib/algolia/models/analytics/get_searches_no_results_response.rb
@@ -181,22 +194,21 @@ files:
 - lib/algolia/models/analytics/get_top_hits_response.rb
 - lib/algolia/models/analytics/get_top_searches_response.rb
 - lib/algolia/models/analytics/get_users_count_response.rb
-- lib/algolia/models/analytics/no_click_rate_event.rb
-- lib/algolia/models/analytics/no_results_rate_event.rb
+- lib/algolia/models/analytics/operator.rb
 - lib/algolia/models/analytics/order_by.rb
-- lib/algolia/models/analytics/search_event.rb
-- lib/algolia/models/analytics/search_no_click_event.rb
-- lib/algolia/models/analytics/search_no_result_event.rb
 - lib/algolia/models/analytics/top_country.rb
 - lib/algolia/models/analytics/top_hit.rb
 - lib/algolia/models/analytics/top_hit_with_analytics.rb
+- lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_hits_response.rb
 - lib/algolia/models/analytics/top_hits_response_with_analytics.rb
+- lib/algolia/models/analytics/top_hits_response_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_search.rb
 - lib/algolia/models/analytics/top_search_with_analytics.rb
+- lib/algolia/models/analytics/top_search_with_revenue_analytics.rb
 - lib/algolia/models/analytics/top_searches_response.rb
 - lib/algolia/models/analytics/top_searches_response_with_analytics.rb
-- lib/algolia/models/analytics/user_with_date.rb
+- lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb
 - lib/algolia/models/ingestion/action_type.rb
 - lib/algolia/models/ingestion/auth_algolia.rb
 - lib/algolia/models/ingestion/auth_algolia_partial.rb