algolia 3.33.0 → 3.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '038b9815e3e19a8df7af2d45f9479a21a50ec39fd9126a9faa6257cfce01a9d7'
-  data.tar.gz: 40c503e65285a2ba1b6d65d95cfc63a1969eba47df7c7e94b156f7d83633f981
+  metadata.gz: 8189a4e0cfb23cab2ef3d512f074ea026e2a1bd034fb76edad6258cd8670f5f7
+  data.tar.gz: e6c801ad5cd7a3ee902cccd82fbb76196be67baff93da35c5812ce67147f92a5
 SHA512:
-  metadata.gz: 5fe1da3a8c32637095019905d0efa909e9efb92c68029e9981a2dfc27d97c588c7ee958817c3afe7edaf84aa7007dc4a0c2635e4f23620d6c9e473a9544ec4e3
-  data.tar.gz: 7f2497efdd53881975f361874a3a3de1790025b4e4e54bf4222a1f06fb539ee6fdfb80477e904ed0806958ae0b2b5adb39239b754737fb5cf077a96318b281ac
+  metadata.gz: efae6679ac62a8194a5df95e09989fb706d139b79b3550305f31ef82664002c50b28a5b8fa86736f01157f2c88148e60624ead81634c6226e2a57abc2a5c266f
+  data.tar.gz: 979c0aecb5b39fd70e07261d049e707650d2ca764f615f72a360357fa70d1218642f0d46168d7f5601fb233460e5b30958f54369d7f2083147da1d86e514f144

data/.github/workflows/do-not-edit-this-repository.yml

@@ -14,7 +14,7 @@ jobs:
     name: Close PR
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Close PR
         env:

data/.github/workflows/issue.yml

@@ -36,16 +36,11 @@ jobs:
                     id: '10001'
                   },
                   parent: {
-                    key: 'DI-3523'
+                    key: 'API-1'
                   },
                   project: {
-                    id: '10118'
+                    id: '11316'
                   },
-                  components: [
-                    {
-                      id: '10872'
-                    }
-                  ],
                   summary: `[GH-ISSUE] ${title}`
                 },
                 update: {}

data/.github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       id-token: write
       contents: write
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Install Ruby
         uses: ruby/setup-ruby@v1

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## [3.34.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.34.0...3.34.1)
+
+- [54606b3b2](https://github.com/algolia/api-clients-automation/commit/54606b3b2) refactor(specs): extract `results` field in a dedicated directory ([#5739](https://github.com/algolia/api-clients-automation/pull/5739)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [3296a5033](https://github.com/algolia/api-clients-automation/commit/3296a5033) chore(deps): dependencies 2025-11-24 ([#5653](https://github.com/algolia/api-clients-automation/pull/5653)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [5dabdc540](https://github.com/algolia/api-clients-automation/commit/5dabdc540) refactor(specs): re-organise response for Composition API ([#5744](https://github.com/algolia/api-clients-automation/pull/5744)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [3d86676b0](https://github.com/algolia/api-clients-automation/commit/3d86676b0) fix(specs): update list with NLU permissions ([#5769](https://github.com/algolia/api-clients-automation/pull/5769)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+
+## [3.34.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.33.0...3.34.0)
+
+- [5335918a5](https://github.com/algolia/api-clients-automation/commit/5335918a5) chore(scripts): update the jira action ([#5678](https://github.com/algolia/api-clients-automation/pull/5678)) by [@millotp](https://github.com/millotp/)
+- [d6bde0f0c](https://github.com/algolia/api-clients-automation/commit/d6bde0f0c) chore(scripts): remove component from jira ticket ([#5680](https://github.com/algolia/api-clients-automation/pull/5680)) by [@millotp](https://github.com/millotp/)
+- [fe6e82c11](https://github.com/algolia/api-clients-automation/commit/fe6e82c11) feat(specs): add sortBy query param and sortingStrategy ([#5686](https://github.com/algolia/api-clients-automation/pull/5686)) by [@ben-kalmus](https://github.com/ben-kalmus/)
+- [cccfa9c86](https://github.com/algolia/api-clients-automation/commit/cccfa9c86) feat(specs): add `sortBy` trigger on Composition Rules ([#5707](https://github.com/algolia/api-clients-automation/pull/5707)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [260d8102c](https://github.com/algolia/api-clients-automation/commit/260d8102c) docs(abtests): Added documentation for featureFilters configuration i… ([#5688](https://github.com/algolia/api-clients-automation/pull/5688)) by [@samykettani](https://github.com/samykettani/)
+
 ## [3.33.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.32.0...3.33.0)
 
 - [6a48ef151a](https://github.com/algolia/api-clients-automation/commit/6a48ef151a) feat(specs): allow `enablePersonalization` query parameter at run time for Composition API ([#5651](https://github.com/algolia/api-clients-automation/pull/5651)) by [@ClaraMuller](https://github.com/ClaraMuller/)

data/Gemfile.lock

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

data/lib/algolia/api/composition_client.rb

@@ -947,5 +947,61 @@ module Algolia
       )
     end
 
+    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to create a new sorting strategy mapping or replace the currently configured one. The provided sorting indices MUST be associated indices or replicas of the main targeted index.  WARNING: This endpoint cannot validate if the sort index is related to the composition's main index.   Validation will fail at runtime if the index you updated is not related!  The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param request_body [Hash<String, String>]  (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def update_sorting_strategy_composition_with_http_info(composition_id, request_body, request_options = {})
+      # verify the required parameter 'composition_id' is set
+      if @api_client.config.client_side_validation && composition_id.nil?
+        raise(
+          ArgumentError,
+          "Parameter `composition_id` is required when calling `update_sorting_strategy_composition`."
+        )
+      end
+      # verify the required parameter 'request_body' is set
+      if @api_client.config.client_side_validation && request_body.nil?
+        raise ArgumentError, "Parameter `request_body` is required when calling `update_sorting_strategy_composition`."
+      end
+
+      path = "/1/compositions/{compositionID}/sortingStrategy".sub(
+        "{" + "compositionID" + "}",
+        Transport.encode_uri(composition_id.to_s)
+      )
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(request_body)
+
+      new_options = request_options.merge(
+        :operation => :"CompositionClient.update_sorting_strategy_composition",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint allows you to create a new sorting strategy mapping or replace the currently configured one. The provided sorting indices MUST be associated indices or replicas of the main targeted index.  WARNING: This endpoint cannot validate if the sort index is related to the composition's main index.   Validation will fail at runtime if the index you updated is not related!  The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.
+    #
+    # Required API Key ACLs:
+    #   - editSettings
+    # @param composition_id [String] Unique Composition ObjectID. (required)
+    # @param request_body [Hash<String, String>]  (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [TaskIDResponse]
+    def update_sorting_strategy_composition(composition_id, request_body, request_options = {})
+      response = update_sorting_strategy_composition_with_http_info(composition_id, request_body, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Composition::TaskIDResponse")
+    end
+
   end
 end

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

@@ -9,6 +9,8 @@ module Algolia
   module Abtesting
     # A/B test configuration.
     class ABTestConfiguration
+      attr_accessor :feature_filters
+
       attr_accessor :outliers
 
       attr_accessor :empty_search
@@ -18,6 +20,7 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :feature_filters => :featureFilters,
           :outliers => :outliers,
           :empty_search => :emptySearch,
           :minimum_detectable_effect => :minimumDetectableEffect
@@ -27,6 +30,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
+          :feature_filters => :"FeatureFilters",
           :outliers => :"Outliers",
           :empty_search => :"EmptySearch",
           :minimum_detectable_effect => :"MinimumDetectableEffect"
@@ -63,6 +67,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
+        if attributes.key?(:feature_filters)
+          self.feature_filters = attributes[:feature_filters]
+        end
+
         if attributes.key?(:outliers)
           self.outliers = attributes[:outliers]
         end
@@ -81,6 +89,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
+          feature_filters == other.feature_filters &&
           outliers == other.outliers &&
           empty_search == other.empty_search &&
           minimum_detectable_effect == other.minimum_detectable_effect
@@ -95,7 +104,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [outliers, empty_search, minimum_detectable_effect].hash
+        [feature_filters, outliers, empty_search, minimum_detectable_effect].hash
       end
 
       # Builds the object from hash

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

@@ -9,6 +9,8 @@ module Algolia
   module Abtesting
     # A/B test configuration for estimating the sample size and duration using minimum detectable effect.
     class EstimateConfiguration
+      attr_accessor :feature_filters
+
       attr_accessor :outliers
 
       attr_accessor :empty_search
@@ -18,6 +20,7 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :feature_filters => :featureFilters,
           :outliers => :outliers,
           :empty_search => :emptySearch,
           :minimum_detectable_effect => :minimumDetectableEffect
@@ -27,6 +30,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
+          :feature_filters => :"FeatureFilters",
           :outliers => :"Outliers",
           :empty_search => :"EmptySearch",
           :minimum_detectable_effect => :"MinimumDetectableEffect"
@@ -63,6 +67,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
+        if attributes.key?(:feature_filters)
+          self.feature_filters = attributes[:feature_filters]
+        end
+
         if attributes.key?(:outliers)
           self.outliers = attributes[:outliers]
         end
@@ -83,6 +91,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
+          feature_filters == other.feature_filters &&
           outliers == other.outliers &&
           empty_search == other.empty_search &&
           minimum_detectable_effect == other.minimum_detectable_effect
@@ -97,7 +106,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [outliers, empty_search, minimum_detectable_effect].hash
+        [feature_filters, outliers, empty_search, minimum_detectable_effect].hash
       end
 
       # Builds the object from hash

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

@@ -0,0 +1,228 @@
+# 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 Abtesting
+    # Configuration of feature-based filters applied to the A/B test population.
+    class FeatureFilters
+      # Whether to apply Dynamic Re-Ranking feature filters.
+      attr_accessor :dynamic_re_ranking
+
+      # Whether to apply AI Personalization feature filters.
+      attr_accessor :ai_perso
+
+      # Whether to apply Multi-Signal Re-Ranking feature filters.
+      attr_accessor :multi_signal_ranking
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :dynamic_re_ranking => :dynamicReRanking,
+          :ai_perso => :aiPerso,
+          :multi_signal_ranking => :multiSignalRanking
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :dynamic_re_ranking => :"Boolean",
+          :ai_perso => :"Boolean",
+          :multi_signal_ranking => :"Boolean"
+        }
+      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::FeatureFilters` 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::FeatureFilters`. 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?(:dynamic_re_ranking)
+          self.dynamic_re_ranking = attributes[:dynamic_re_ranking]
+        end
+
+        if attributes.key?(:ai_perso)
+          self.ai_perso = attributes[:ai_perso]
+        end
+
+        if attributes.key?(:multi_signal_ranking)
+          self.multi_signal_ranking = attributes[:multi_signal_ranking]
+        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 &&
+          dynamic_re_ranking == other.dynamic_re_ranking &&
+          ai_perso == other.ai_perso &&
+          multi_signal_ranking == other.multi_signal_ranking
+      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
+        [dynamic_re_ranking, ai_perso, multi_signal_ranking].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::Abtesting.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/models/composition/composition.rb

@@ -19,13 +19,17 @@ module Algolia
 
       attr_accessor :behavior
 
+      # A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition. Each key is the label your frontend sends at runtime (for example, \"Price (asc)\"), and each value is the name of the index that should be queried when that label is selected.  When a request includes a \"sortBy\" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced with the sorting strategy index it is mapped to.  Up to 20 sorting strategies can be defined.
+      attr_accessor :sorting_strategy
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :algolia_object_id => :objectID,
           :name => :name,
           :description => :description,
-          :behavior => :behavior
+          :behavior => :behavior,
+          :sorting_strategy => :sortingStrategy
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
           :algolia_object_id => :"String",
           :name => :"String",
           :description => :"String",
-          :behavior => :"CompositionBehavior"
+          :behavior => :"CompositionBehavior",
+          :sorting_strategy => :"Hash<String, String>"
         }
       end
 
@@ -90,6 +95,12 @@ module Algolia
         else
           self.behavior = nil
         end
+
+        if attributes.key?(:sorting_strategy)
+          if (value = attributes[:sorting_strategy]).is_a?(Hash)
+            self.sorting_strategy = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -100,7 +111,8 @@ module Algolia
           algolia_object_id == other.algolia_object_id &&
           name == other.name &&
           description == other.description &&
-          behavior == other.behavior
+          behavior == other.behavior &&
+          sorting_strategy == other.sorting_strategy
       end
 
       # @see the `==` method
@@ -112,7 +124,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [algolia_object_id, name, description, behavior].hash
+        [algolia_object_id, name, description, behavior, sorting_strategy].hash
       end
 
       # Builds the object from hash

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class CompositionRunAppliedRules
-      # Unique record identifier.
+      # The objectID of the applied composition rule on this query.
       attr_accessor :algolia_object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class CompositionRunSearchResponse
-      # Unique record identifier.
+      # The objectID of the composition which generated this result set.
       attr_accessor :algolia_object_id
 
       attr_accessor :applied_rules

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

@@ -19,13 +19,17 @@ module Algolia
       # Filters that trigger the rule.  You can add add filters using the syntax `facet:value` so that the rule is triggered, when the specific filter is selected. You can use `filters` on its own or combine it with the `pattern` parameter.
       attr_accessor :filters
 
+      # Sort criteria that trigger the rule.  You can trigger composition rules based on the selected sorting strategy set by the parameter `sortBy`. The rule will trigger if the value passed to `sortBy` matches the one defined in the condition.
+      attr_accessor :sort_by
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :pattern => :pattern,
           :anchoring => :anchoring,
           :context => :context,
-          :filters => :filters
+          :filters => :filters,
+          :sort_by => :sortBy
         }
       end
 
@@ -35,7 +39,8 @@ module Algolia
           :pattern => :"String",
           :anchoring => :"Anchoring",
           :context => :"String",
-          :filters => :"String"
+          :filters => :"String",
+          :sort_by => :"String"
         }
       end
 
@@ -84,6 +89,10 @@ module Algolia
         if attributes.key?(:filters)
           self.filters = attributes[:filters]
         end
+
+        if attributes.key?(:sort_by)
+          self.sort_by = attributes[:sort_by]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -94,7 +103,8 @@ module Algolia
           pattern == other.pattern &&
           anchoring == other.anchoring &&
           context == other.context &&
-          filters == other.filters
+          filters == other.filters &&
+          sort_by == other.sort_by
       end
 
       # @see the `==` method
@@ -106,7 +116,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [pattern, anchoring, context, filters].hash
+        [pattern, anchoring, context, filters, sort_by].hash
       end
 
       # Builds the object from hash

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

@@ -77,15 +77,18 @@ module Algolia
       # Search query.
       attr_accessor :query
 
-      # 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
-
       # 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
 
+      # 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
+
       # Assigns a rule context to the run query [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
       attr_accessor :rule_contexts
 
+      # Indicates which sorting strategy to apply for the request. The value must match one of the labels defined in the \"sortingStrategy\" mapping. For example, \"Price (asc)\", see Upsert Composition. At runtime, this label is used to look up the corresponding index or replica configured in \"sortingStrategy\", and the query is executed using that index instead of main's.  In addition to \"sortingStrategy\", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on \"sortBy\", see Composition Rules.  If no value is provided or an invalid value, no sorting strategy is applied.
+      attr_accessor :sort_by
+
       # Unique pseudonymous or anonymous user identifier.  This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken).
       attr_accessor :user_token
 
@@ -117,9 +120,10 @@ module Algolia
           :optional_filters => :optionalFilters,
           :page => :page,
           :query => :query,
-          :relevancy_strictness => :relevancyStrictness,
           :query_languages => :queryLanguages,
+          :relevancy_strictness => :relevancyStrictness,
           :rule_contexts => :ruleContexts,
+          :sort_by => :sortBy,
           :user_token => :userToken
         }
       end
@@ -152,9 +156,10 @@ module Algolia
           :optional_filters => :"OptionalFilters",
           :page => :"Integer",
           :query => :"String",
-          :relevancy_strictness => :"Integer",
           :query_languages => :"Array<SupportedLanguage>",
+          :relevancy_strictness => :"Integer",
           :rule_contexts => :"Array<String>",
+          :sort_by => :"String",
           :user_token => :"String"
         }
       end
@@ -298,22 +303,26 @@ module Algolia
           self.query = attributes[:query]
         end
 
-        if attributes.key?(:relevancy_strictness)
-          self.relevancy_strictness = attributes[:relevancy_strictness]
-        end
-
         if attributes.key?(:query_languages)
           if (value = attributes[:query_languages]).is_a?(Array)
             self.query_languages = value
           end
         end
 
+        if attributes.key?(:relevancy_strictness)
+          self.relevancy_strictness = attributes[:relevancy_strictness]
+        end
+
         if attributes.key?(:rule_contexts)
           if (value = attributes[:rule_contexts]).is_a?(Array)
             self.rule_contexts = value
           end
         end
 
+        if attributes.key?(:sort_by)
+          self.sort_by = attributes[:sort_by]
+        end
+
         if attributes.key?(:user_token)
           self.user_token = attributes[:user_token]
         end
@@ -349,9 +358,10 @@ module Algolia
           optional_filters == other.optional_filters &&
           page == other.page &&
           query == other.query &&
-          relevancy_strictness == other.relevancy_strictness &&
           query_languages == other.query_languages &&
+          relevancy_strictness == other.relevancy_strictness &&
           rule_contexts == other.rule_contexts &&
+          sort_by == other.sort_by &&
           user_token == other.user_token
       end
 
@@ -390,9 +400,10 @@ module Algolia
           optional_filters,
           page,
           query,
-          relevancy_strictness,
           query_languages,
+          relevancy_strictness,
           rule_contexts,
+          sort_by,
           user_token
         ].hash
       end

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

@@ -8,7 +8,7 @@ require "time"
 module Algolia
   module Composition
     class ResultsInjectedItemAppliedRulesInfoResponse
-      # Unique record identifier.
+      # The objectID of the applied index level rule on this injected group.
       attr_accessor :algolia_object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -8,6 +8,7 @@ require "time"
 module Algolia
   module Composition
     class ResultsInjectedItemInfoResponse
+      # The key of the injected group.
       attr_accessor :key
 
       attr_accessor :applied_rules

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

@@ -83,8 +83,11 @@ module Algolia
       # Whether automatic events collection is enabled for the application.
       attr_accessor :_automatic_insights
 
-      # Page of search results to retrieve.
-      attr_accessor :page
+      # Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+      attr_accessor :hits
+
+      # Number of hits returned per page.
+      attr_accessor :hits_per_page
 
       # Number of results (hits).
       attr_accessor :nb_hits
@@ -92,18 +95,15 @@ module Algolia
       # Number of pages of results.
       attr_accessor :nb_pages
 
-      # Number of hits per page.
-      attr_accessor :hits_per_page
-
-      # Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
-      attr_accessor :hits
-
-      # Search query.
-      attr_accessor :query
+      # The current page of the results.
+      attr_accessor :page
 
       # URL-encoded string of all search parameters.
       attr_accessor :params
 
+      # The search query string.
+      attr_accessor :query
+
       attr_accessor :compositions
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -135,13 +135,13 @@ module Algolia
           :user_data => :userData,
           :query_id => :queryID,
           :_automatic_insights => :_automaticInsights,
-          :page => :page,
+          :hits => :hits,
+          :hits_per_page => :hitsPerPage,
           :nb_hits => :nbHits,
           :nb_pages => :nbPages,
-          :hits_per_page => :hitsPerPage,
-          :hits => :hits,
-          :query => :query,
+          :page => :page,
           :params => :params,
+          :query => :query,
           :compositions => :compositions
         }
       end
@@ -175,13 +175,13 @@ module Algolia
           :user_data => :"Object",
           :query_id => :"String",
           :_automatic_insights => :"Boolean",
-          :page => :"Integer",
+          :hits => :"Array<Hit>",
+          :hits_per_page => :"Integer",
           :nb_hits => :"Integer",
           :nb_pages => :"Integer",
-          :hits_per_page => :"Integer",
-          :hits => :"Array<Hit>",
-          :query => :"String",
+          :page => :"Integer",
           :params => :"String",
+          :query => :"String",
           :compositions => :"Hash<String, ResultsCompositionInfoResponse>"
         }
       end
@@ -200,8 +200,7 @@ module Algolia
         [
           :"BaseSearchResponse",
           :"ResultsCompositionsResponse",
-          :"SearchHits",
-          :"SearchPagination"
+          :"SearchFields"
         ]
       end
 
@@ -338,10 +337,18 @@ module Algolia
           self._automatic_insights = attributes[:_automatic_insights]
         end
 
-        if attributes.key?(:page)
-          self.page = attributes[:page]
+        if attributes.key?(:hits)
+          if (value = attributes[:hits]).is_a?(Array)
+            self.hits = value
+          end
         else
-          self.page = nil
+          self.hits = nil
+        end
+
+        if attributes.key?(:hits_per_page)
+          self.hits_per_page = attributes[:hits_per_page]
+        else
+          self.hits_per_page = nil
         end
 
         if attributes.key?(:nb_hits)
@@ -356,18 +363,16 @@ module Algolia
           self.nb_pages = nil
         end
 
-        if attributes.key?(:hits_per_page)
-          self.hits_per_page = attributes[:hits_per_page]
+        if attributes.key?(:page)
+          self.page = attributes[:page]
         else
-          self.hits_per_page = nil
+          self.page = nil
         end
 
-        if attributes.key?(:hits)
-          if (value = attributes[:hits]).is_a?(Array)
-            self.hits = value
-          end
+        if attributes.key?(:params)
+          self.params = attributes[:params]
         else
-          self.hits = nil
+          self.params = nil
         end
 
         if attributes.key?(:query)
@@ -376,12 +381,6 @@ module Algolia
           self.query = nil
         end
 
-        if attributes.key?(:params)
-          self.params = attributes[:params]
-        else
-          self.params = nil
-        end
-
         if attributes.key?(:compositions)
           if (value = attributes[:compositions]).is_a?(Hash)
             self.compositions = value
@@ -422,13 +421,13 @@ module Algolia
           user_data == other.user_data &&
           query_id == other.query_id &&
           _automatic_insights == other._automatic_insights &&
-          page == other.page &&
+          hits == other.hits &&
+          hits_per_page == other.hits_per_page &&
           nb_hits == other.nb_hits &&
           nb_pages == other.nb_pages &&
-          hits_per_page == other.hits_per_page &&
-          hits == other.hits &&
-          query == other.query &&
+          page == other.page &&
           params == other.params &&
+          query == other.query &&
           compositions == other.compositions
       end
 
@@ -468,13 +467,13 @@ module Algolia
           user_data,
           query_id,
           _automatic_insights,
-          page,
+          hits,
+          hits_per_page,
           nb_hits,
           nb_pages,
-          hits_per_page,
-          hits,
-          query,
+          page,
           params,
+          query,
           compositions
         ].hash
       end

data/lib/algolia/models/search/acl.rb

@@ -23,6 +23,14 @@ module Algolia
       SEE_UNRETRIEVABLE_ATTRIBUTES = "seeUnretrievableAttributes".freeze
       SETTINGS = "settings".freeze
       USAGE = "usage".freeze
+      NLU_WRITE_PROJECT = "nluWriteProject".freeze
+      NLU_READ_PROJECT = "nluReadProject".freeze
+      NLU_WRITE_ENTITY = "nluWriteEntity".freeze
+      NLU_READ_ENTITY = "nluReadEntity".freeze
+      NLU_WRITE_INTENT = "nluWriteIntent".freeze
+      NLU_READ_INTENT = "nluReadIntent".freeze
+      NLU_PREDICTION = "nluPrediction".freeze
+      NLU_READ_ANSWERS = "nluReadAnswers".freeze
 
       def self.all_vars
         @all_vars ||= [
@@ -40,7 +48,15 @@ module Algolia
           SEARCH,
           SEE_UNRETRIEVABLE_ATTRIBUTES,
           SETTINGS,
-          USAGE
+          USAGE,
+          NLU_WRITE_PROJECT,
+          NLU_READ_PROJECT,
+          NLU_WRITE_ENTITY,
+          NLU_READ_ENTITY,
+          NLU_WRITE_INTENT,
+          NLU_READ_INTENT,
+          NLU_PREDICTION,
+          NLU_READ_ANSWERS
         ].freeze
       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.33.0"
+  VERSION = "3.34.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.33.0
+  version: 3.34.1
 platform: ruby
 authors:
 - https://alg.li/support
@@ -191,6 +191,7 @@ files:
 - lib/algolia/models/abtesting/estimate_ab_test_request.rb
 - lib/algolia/models/abtesting/estimate_ab_test_response.rb
 - lib/algolia/models/abtesting/estimate_configuration.rb
+- lib/algolia/models/abtesting/feature_filters.rb
 - lib/algolia/models/abtesting/filter_effects.rb
 - lib/algolia/models/abtesting/list_ab_tests_response.rb
 - lib/algolia/models/abtesting/minimum_detectable_effect.rb