algolia 3.42.2 → 3.43.0

data/lib/algolia/models/insights/clicked_object_ids_after_search.rb

@@ -23,7 +23,7 @@ module Algolia
       # Position of the clicked item the search results.  You must provide 1 `position` for each `objectID`.
       attr_accessor :positions
 
-      # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
+      # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. For agentic analytics events, the query ID may be prefixed with `message_` followed by any printable string.
       attr_accessor :query_id
 
       # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).

data/lib/algolia/models/insights/converted_object_ids_after_search.rb

@@ -20,7 +20,7 @@ module Algolia
       # Object IDs of the records that are part of the event.
       attr_accessor :object_ids
 
-      # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
+      # Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. For agentic analytics events, the query ID may be prefixed with `message_` followed by any printable string.
       attr_accessor :query_id
 
       # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).

data/lib/algolia/models/insights/events_items.rb

@@ -20,6 +20,7 @@ module Algolia
             :"ConvertedFilters",
             :"ConvertedObjectIDs",
             :"ConvertedObjectIDsAfterSearch",
+            :"Instantsearch",
             :"PurchasedObjectIDs",
             :"PurchasedObjectIDsAfterSearch",
             :"ViewedFilters",

data/lib/algolia/models/insights/instantsearch.rb

@@ -0,0 +1,269 @@
+# frozen_string_literal: true
+
+# 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 Insights
+    class Instantsearch
+      # Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+      attr_accessor :event_name
+
+      attr_accessor :event_type
+
+      # Anonymous or pseudonymous user identifier.  Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
+      attr_accessor :user_token
+
+      # Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
+      attr_accessor :authenticated_user_token
+
+      # Timestamp of the event, measured in milliseconds since the Unix epoch. Must be no older than 30 days. If not provided, we use the time at which the request was received.
+      attr_accessor :timestamp
+
+      # Unique identifier for an agent session. Used to correlate instantsearch events with a specific agent interaction.
+      attr_accessor :agent_id
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :event_name => :eventName,
+          :event_type => :eventType,
+          :user_token => :userToken,
+          :authenticated_user_token => :authenticatedUserToken,
+          :timestamp => :timestamp,
+          :agent_id => :agentID
+        }
+      end
+
+      # Returns the keys that uniquely identify this oneOf variant when present
+      def self.discriminator_attributes
+        [
+          :eventType
+        ]
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :event_name => :"String",
+          :event_type => :"InstantsearchEvent",
+          :user_token => :"String",
+          :authenticated_user_token => :"String",
+          :timestamp => :"Integer",
+          :agent_id => :"String"
+        }
+      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 = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::Instantsearch` 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::Instantsearch`. 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?(:event_name)
+          self.event_name = attributes[:event_name]
+        else
+          self.event_name = nil
+        end
+
+        if attributes.key?(:event_type)
+          self.event_type = attributes[:event_type]
+        else
+          self.event_type = nil
+        end
+
+        if attributes.key?(:user_token)
+          self.user_token = attributes[:user_token]
+        else
+          self.user_token = nil
+        end
+
+        if attributes.key?(:authenticated_user_token)
+          self.authenticated_user_token = attributes[:authenticated_user_token]
+        end
+
+        if attributes.key?(:timestamp)
+          self.timestamp = attributes[:timestamp]
+        end
+
+        if attributes.key?(:agent_id)
+          self.agent_id = attributes[:agent_id]
+        end
+      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 &&
+          event_name == other.event_name &&
+          event_type == other.event_type &&
+          user_token == other.user_token &&
+          authenticated_user_token == other.authenticated_user_token &&
+          timestamp == other.timestamp &&
+          agent_id == other.agent_id
+      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
+        [event_name, event_type, user_token, authenticated_user_token, timestamp, agent_id].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::Insights.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.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/models/insights/instantsearch_event.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# 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 Insights
+    class InstantsearchEvent
+      INSTANTSEARCH = "instantsearch".freeze
+
+      def self.all_vars
+        @all_vars ||= [INSTANTSEARCH].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if InstantsearchEvent.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #InstantsearchEvent"
+      end
+    end
+  end
+end

data/lib/algolia/models/recommend/facet_filters.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+# 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 Recommend
+    # Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
+    module FacetFilters
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"Array<FacetFilters>",
+            :"String"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::Recommend.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
+              else
+                # maybe it's an enum, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/recommend/fallback_params.rb

@@ -242,6 +242,8 @@ module Algolia
 
       attr_accessor :re_ranking_apply_filter
 
+      attr_accessor :facet_filters
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -327,7 +329,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
           :rendering_content => :renderingContent,
           :enable_re_ranking => :enableReRanking,
-          :re_ranking_apply_filter => :reRankingApplyFilter
+          :re_ranking_apply_filter => :reRankingApplyFilter,
+          :facet_filters => :facetFilters
         }
       end
 
@@ -416,7 +419,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
           :rendering_content => :"RenderingContent",
           :enable_re_ranking => :"Boolean",
-          :re_ranking_apply_filter => :"ReRankingApplyFilter"
+          :re_ranking_apply_filter => :"ReRankingApplyFilter",
+          :facet_filters => :"FacetFilters"
         }
       end
 
@@ -849,6 +853,10 @@ module Algolia
         if attributes.key?(:re_ranking_apply_filter)
           self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter]
         end
+
+        if attributes.key?(:facet_filters)
+          self.facet_filters = attributes[:facet_filters]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -938,7 +946,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
           rendering_content == other.rendering_content &&
           enable_re_ranking == other.enable_re_ranking &&
-          re_ranking_apply_filter == other.re_ranking_apply_filter
+          re_ranking_apply_filter == other.re_ranking_apply_filter &&
+          facet_filters == other.facet_filters
       end
 
       # @see the `==` method
@@ -1033,7 +1042,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity,
           rendering_content,
           enable_re_ranking,
-          re_ranking_apply_filter
+          re_ranking_apply_filter,
+          facet_filters
         ].hash
       end
 

data/lib/algolia/version.rb

@@ -3,5 +3,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.42.2"
+  VERSION = "3.43.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.42.2
+  version: 3.43.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -157,6 +157,7 @@ files:
 - lib/algolia/models/abtesting-v3/add_ab_tests_request.rb
 - lib/algolia/models/abtesting-v3/add_ab_tests_variant.rb
 - lib/algolia/models/abtesting-v3/create_metric.rb
+- lib/algolia/models/abtesting-v3/decision.rb
 - lib/algolia/models/abtesting-v3/direction.rb
 - lib/algolia/models/abtesting-v3/effect_metric.rb
 - lib/algolia/models/abtesting-v3/empty_search_filter.rb
@@ -325,6 +326,9 @@ files:
 - lib/algolia/models/agent-studio/user_message_v5.rb
 - lib/algolia/models/agent-studio/validation_error.rb
 - lib/algolia/models/agent-studio/vote_enum.rb
+- lib/algolia/models/analytics/bin_edge.rb
+- lib/algolia/models/analytics/catalog.rb
+- lib/algolia/models/analytics/catalog_entry.rb
 - lib/algolia/models/analytics/click_position.rb
 - lib/algolia/models/analytics/currency_code.rb
 - lib/algolia/models/analytics/daily_add_to_cart_rates.rb
@@ -340,7 +344,12 @@ files:
 - 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/distribution_definition.rb
+- lib/algolia/models/analytics/distribution_payload.rb
+- lib/algolia/models/analytics/domain_catalog.rb
 - lib/algolia/models/analytics/error_base.rb
+- lib/algolia/models/analytics/field_reference.rb
+- lib/algolia/models/analytics/filter_definition.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
@@ -367,6 +376,18 @@ files:
 - lib/algolia/models/analytics/get_users_count_response.rb
 - lib/algolia/models/analytics/operator.rb
 - lib/algolia/models/analytics/order_by.rb
+- lib/algolia/models/analytics/order_definition.rb
+- lib/algolia/models/analytics/order_direction.rb
+- lib/algolia/models/analytics/parameter_definition.rb
+- lib/algolia/models/analytics/parameter_reference.rb
+- lib/algolia/models/analytics/parameter_value.rb
+- lib/algolia/models/analytics/scalar_payload.rb
+- lib/algolia/models/analytics/series.rb
+- lib/algolia/models/analytics/series_date.rb
+- lib/algolia/models/analytics/table_payload.rb
+- lib/algolia/models/analytics/table_response.rb
+- lib/algolia/models/analytics/timeseries_payload.rb
+- lib/algolia/models/analytics/timeseries_response.rb
 - lib/algolia/models/analytics/top_country.rb
 - lib/algolia/models/analytics/top_hit.rb
 - lib/algolia/models/analytics/top_hit_with_analytics.rb
@@ -665,6 +686,8 @@ files:
 - lib/algolia/models/insights/events_items.rb
 - lib/algolia/models/insights/events_response.rb
 - lib/algolia/models/insights/insights_events.rb
+- lib/algolia/models/insights/instantsearch.rb
+- lib/algolia/models/insights/instantsearch_event.rb
 - lib/algolia/models/insights/object_data.rb
 - lib/algolia/models/insights/object_data_after_search.rb
 - lib/algolia/models/insights/price.rb
@@ -734,6 +757,7 @@ files:
 - lib/algolia/models/recommend/error_base.rb
 - lib/algolia/models/recommend/exact_on_single_word_query.rb
 - lib/algolia/models/recommend/exhaustive.rb
+- lib/algolia/models/recommend/facet_filters.rb
 - lib/algolia/models/recommend/facet_ordering.rb
 - lib/algolia/models/recommend/facet_stats.rb
 - lib/algolia/models/recommend/fallback_params.rb
@@ -1014,7 +1038,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A simple Ruby client for the algolia.com REST API
 test_files: []