algolia 3.23.0 → 3.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fff1502a30fce45ad42d7166299524a573e06053f830fa1f18651e541e4dbdb
-  data.tar.gz: 76b07e570220ca1cb5afd4ce7c82d103f83cc40dbb0a52aeccfdfa341689d4bf
+  metadata.gz: 98922e2955f34bbd0985980254a793abbf9d850500ca599bb873cc8527ace278
+  data.tar.gz: ffc863df89f0187c6d44fe1528e5d5bed7d1c1aa5b8249b9820a8849eab79579
 SHA512:
-  metadata.gz: c423ef6ca5a1b550eb3f54668e42df002f9e4355e0db592274814e21ea1670660c24a64cce4352580877cd0ace43d623aba790efaacec671e4a5ac3ee9abdb83
-  data.tar.gz: 017a0a4378f8d441486bc6fc9a94b254a0a02d692362bf89c063e4f3f4df1f8e00bf3a4aa4080307477f8444a1760a2d55d65335b8786c2cc80356390f85355d
+  metadata.gz: f68ad7647ec8f2b8b07322bf3cd93e561c8f320d22f710885720a5b7d3af911316a37ffbe939632794a7c48a200d5e1a64a3b355be732394a98873424e04f8f5
+  data.tar.gz: d520b06148c6b2229d38f1c4c9e2d94e6f5138e19b776e47b55b7eceaf43325262c815ffc54ce15efb44fae83adbdddcf70e169ecc7f917a63422590a9ba6dd6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.24.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.23.0...3.24.0)
+
+- [48672036c1](https://github.com/algolia/api-clients-automation/commit/48672036c1) refactor(specs): mutualise code between Search API & Comp API for search query parameters ([#5125](https://github.com/algolia/api-clients-automation/pull/5125)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [99f8174c7d](https://github.com/algolia/api-clients-automation/commit/99f8174c7d) feat(specs): add fields for metadata in composition injectedItems ([#5241](https://github.com/algolia/api-clients-automation/pull/5241)) by [@gavinwade12](https://github.com/gavinwade12/)
+- [ff178d8118](https://github.com/algolia/api-clients-automation/commit/ff178d8118) feat(specs): abtests stopped at ([#5275](https://github.com/algolia/api-clients-automation/pull/5275)) by [@stevenMevans](https://github.com/stevenMevans/)
+
 ## [3.23.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.22.1...3.23.0)
 
 - [050aacef17](https://github.com/algolia/api-clients-automation/commit/050aacef17) chore(deps): dependencies 2025-07-28 ([#5161](https://github.com/algolia/api-clients-automation/pull/5161)) by [@algolia-bot](https://github.com/algolia-bot/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.23.0)
+    algolia (3.24.0)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/models/abtesting/ab_test.rb

@@ -30,6 +30,9 @@ module Algolia
       # End date and time of the A/B test, in RFC 3339 format.
       attr_accessor :end_at
 
+      # Date and time when the A/B test was stopped, in RFC 3339 format.
+      attr_accessor :stopped_at
+
       # A/B test name.
       attr_accessor :name
 
@@ -52,6 +55,7 @@ module Algolia
           :updated_at => :updatedAt,
           :created_at => :createdAt,
           :end_at => :endAt,
+          :stopped_at => :stoppedAt,
           :name => :name,
           :status => :status,
           :variants => :variants,
@@ -71,6 +75,7 @@ module Algolia
           :updated_at => :"String",
           :created_at => :"String",
           :end_at => :"String",
+          :stopped_at => :"String",
           :name => :"String",
           :status => :"Status",
           :variants => :"Array<Variant>",
@@ -86,7 +91,8 @@ module Algolia
             :conversion_significance,
             :add_to_cart_significance,
             :purchase_significance,
-            :revenue_significance
+            :revenue_significance,
+            :stopped_at
           ]
         )
       end
@@ -157,6 +163,10 @@ module Algolia
           self.end_at = nil
         end
 
+        if attributes.key?(:stopped_at)
+          self.stopped_at = attributes[:stopped_at]
+        end
+
         if attributes.key?(:name)
           self.name = attributes[:name]
         else
@@ -196,6 +206,7 @@ module Algolia
           updated_at == other.updated_at &&
           created_at == other.created_at &&
           end_at == other.end_at &&
+          stopped_at == other.stopped_at &&
           name == other.name &&
           status == other.status &&
           variants == other.variants &&
@@ -221,6 +232,7 @@ module Algolia
           updated_at,
           created_at,
           end_at,
+          stopped_at,
           name,
           status,
           variants,

data/lib/algolia/models/abtesting-v3/ab_test.rb

@@ -20,6 +20,9 @@ module Algolia
       # End date and time of the A/B test, in RFC 3339 format.
       attr_accessor :end_at
 
+      # Date and time when the A/B test was stopped, in RFC 3339 format.
+      attr_accessor :stopped_at
+
       # A/B test name.
       attr_accessor :name
 
@@ -40,6 +43,7 @@ module Algolia
           :updated_at => :updatedAt,
           :created_at => :createdAt,
           :end_at => :endAt,
+          :stopped_at => :stoppedAt,
           :name => :name,
           :status => :status,
           :variants => :variants,
@@ -55,6 +59,7 @@ module Algolia
           :updated_at => :"String",
           :created_at => :"String",
           :end_at => :"String",
+          :stopped_at => :"String",
           :name => :"String",
           :status => :"Status",
           :variants => :"Array<Variant>",
@@ -66,7 +71,9 @@ module Algolia
       # List of attributes with nullable: true
       def self.openapi_nullable
         Set.new(
-          []
+          [
+            :stopped_at
+          ]
         )
       end
 
@@ -114,6 +121,10 @@ module Algolia
           self.end_at = nil
         end
 
+        if attributes.key?(:stopped_at)
+          self.stopped_at = attributes[:stopped_at]
+        end
+
         if attributes.key?(:name)
           self.name = attributes[:name]
         else
@@ -152,6 +163,7 @@ module Algolia
           updated_at == other.updated_at &&
           created_at == other.created_at &&
           end_at == other.end_at &&
+          stopped_at == other.stopped_at &&
           name == other.name &&
           status == other.status &&
           variants == other.variants &&
@@ -168,7 +180,18 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [ab_test_id, updated_at, created_at, end_at, name, status, variants, configuration, migrated_ab_test_id].hash
+        [
+          ab_test_id,
+          updated_at,
+          created_at,
+          end_at,
+          stopped_at,
+          name,
+          status,
+          variants,
+          configuration,
+          migrated_ab_test_id
+        ].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/composition/hit.rb

@@ -22,6 +22,8 @@ module Algolia
 
       attr_accessor :_distinct_seq_id
 
+      attr_accessor :_extra
+
       attr_accessor :additional_properties
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -31,7 +33,8 @@ module Algolia
           :_highlight_result => :_highlightResult,
           :_snippet_result => :_snippetResult,
           :_ranking_info => :_rankingInfo,
-          :_distinct_seq_id => :_distinctSeqID
+          :_distinct_seq_id => :_distinctSeqID,
+          :_extra => :_extra
         }
       end
 
@@ -42,7 +45,8 @@ module Algolia
           :_highlight_result => :"Hash<String, HighlightResult>",
           :_snippet_result => :"Hash<String, SnippetResult>",
           :_ranking_info => :"HitRankingInfo",
-          :_distinct_seq_id => :"Integer"
+          :_distinct_seq_id => :"Integer",
+          :_extra => :"HitMetadata"
         }
       end
 
@@ -86,6 +90,10 @@ module Algolia
           self._distinct_seq_id = attributes[:_distinct_seq_id]
         end
 
+        if attributes.key?(:_extra)
+          self._extra = attributes[:_extra]
+        end
+
         # add extra attribute to additional_properties
         self.additional_properties ||= {}
         self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
@@ -100,7 +108,8 @@ module Algolia
           _highlight_result == other._highlight_result &&
           _snippet_result == other._snippet_result &&
           _ranking_info == other._ranking_info &&
-          _distinct_seq_id == other._distinct_seq_id
+          _distinct_seq_id == other._distinct_seq_id &&
+          _extra == other._extra
       end
 
       # @see the `==` method
@@ -112,7 +121,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id].hash
+        [algolia_object_id, _highlight_result, _snippet_result, _ranking_info, _distinct_seq_id, _extra].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/composition/hit_metadata.rb

@@ -0,0 +1,210 @@
+# 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 Composition
+    # An object that contains the extra key-value pairs provided in the injectedItem definition.
+    class HitMetadata
+      # The key of the injectedItem that inserted this metadata.
+      attr_accessor :_injected_item_key
+
+      attr_accessor :additional_properties
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :_injected_item_key => :_injectedItemKey
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :_injected_item_key => :"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::HitMetadata` initialize method"
+          )
+        end
+
+        if attributes.key?(:_injected_item_key)
+          self._injected_item_key = attributes[:_injected_item_key]
+        end
+
+        # add extra attribute to additional_properties
+        self.additional_properties ||= {}
+        self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
+      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 &&
+          _injected_item_key == other._injected_item_key
+      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
+        [_injected_item_key].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
+
+        # add extra attribute to transformed_hash
+        transformed_hash.merge!(attributes.reject { |k, _| attribute_map.key?(k.to_sym) })
+        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::Composition.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
+
+        # also add attributes from additional_properties to hash
+        self.additional_properties&.each_pair do |k, v|
+          hash[k.to_sym] = _to_hash(v)
+        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/models/composition/params.rb

@@ -20,6 +20,7 @@ module Algolia
       # Whether the run response should include detailed ranking information.
       attr_accessor :get_ranking_info
 
+      # Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
       attr_accessor :relevancy_strictness
 
       attr_accessor :facet_filters
@@ -49,7 +50,7 @@ module Algolia
       # Coordinates of a polygon in which to search.  Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
       attr_accessor :inside_polygon
 
-      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first** **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
       attr_accessor :query_languages
 
       # ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches) - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.