algolia 3.47.0 → 3.49.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ecdb659fe529673e571a60a4bbe13dc73c9c6fbe53c950a5c44802f4add29d9
-  data.tar.gz: af9ded4069bb54fa19eb779c543f50bb9d8a42a93bcec851503d9c3bafa93909
+  metadata.gz: 8d89992331694b650c757bd4300a1c50a90456fc1c18a0a55ca9825673ceff8b
+  data.tar.gz: 417b1fa6e11081c252b36df230b726c6a54a8265c74e93e346d72fcdd91626d8
 SHA512:
-  metadata.gz: 7cbe0d52f1d866d286860249008f8ecfadad93149f241f3e199ea25d2636330e9ce84682e0f181d7036b7f55d28af1cdd5f6c937ce2bbd9ac8afdddc98ae5655
-  data.tar.gz: c2aa1c1e557a956ec9e9e1a5bec99d47999bd0c1738c317caf58edd653431cbbca0ae7c4443938c43c131b9c9e2fe16d4d0e78b5306231125ec31b276d1ddab3
+  metadata.gz: 64c7feb78aa763216cbe7ba3a7fbc69a6bafb69cbf43605ab5cc1a20df73c3323399e0785088e28019328e2ac05ff15117ba6134e1960c97972b00105eec45f5
+  data.tar.gz: ab26fc8819a6a604bd830175411b6df40dc82ef3c331c85e42a0ad669236890b333bbe0d85dc013d1664f29012c916550c83834d3250262b8f813cddb5250b56

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [3.49.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.48.0...3.49.0)
+
+- [e6933da012](https://github.com/algolia/api-clients-automation/commit/e6933da012) fix(specs): clarify maxHitsPerQuery is a per-page limit ([#7210](https://github.com/algolia/api-clients-automation/pull/7210)) by [@kai687](https://github.com/kai687/)
+- [0a3cbbb29b](https://github.com/algolia/api-clients-automation/commit/0a3cbbb29b) feat(specs): add per-feed params to Composition run request ([#7199](https://github.com/algolia/api-clients-automation/pull/7199)) by [@ben-kalmus](https://github.com/ben-kalmus/)
+- [8456d9eb14](https://github.com/algolia/api-clients-automation/commit/8456d9eb14) feat(specs): support `algoliaDefined` ordering in external sources ([#7212](https://github.com/algolia/api-clients-automation/pull/7212)) by [@aiordache](https://github.com/aiordache/)
+- [575c3ab5c6](https://github.com/algolia/api-clients-automation/commit/575c3ab5c6) fix(ci): move macOS jobs off the retired macos-14 runner label ([#7224](https://github.com/algolia/api-clients-automation/pull/7224)) by [@Fluf22](https://github.com/Fluf22/)
+- [3e85edd42f](https://github.com/algolia/api-clients-automation/commit/3e85edd42f) docs(specs): describe the analytics no click rate per query ([#7225](https://github.com/algolia/api-clients-automation/pull/7225)) by [@leonardogavaudan](https://github.com/leonardogavaudan/)
+
+## [3.48.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.47.0...3.48.0)
+
+- [e6933da012](https://github.com/algolia/api-clients-automation/commit/e6933da012) fix(specs): clarify maxHitsPerQuery is a per-page limit ([#7210](https://github.com/algolia/api-clients-automation/pull/7210)) by [@kai687](https://github.com/kai687/)
+- [0a3cbbb29b](https://github.com/algolia/api-clients-automation/commit/0a3cbbb29b) feat(specs): add per-feed params to Composition run request ([#7199](https://github.com/algolia/api-clients-automation/pull/7199)) by [@ben-kalmus](https://github.com/ben-kalmus/)
+- [8456d9eb14](https://github.com/algolia/api-clients-automation/commit/8456d9eb14) feat(specs): support `algoliaDefined` ordering in external sources ([#7212](https://github.com/algolia/api-clients-automation/pull/7212)) by [@aiordache](https://github.com/aiordache/)
+
 ## [3.47.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.46.1...3.47.0)
 
 - [e6d5471f15](https://github.com/algolia/api-clients-automation/commit/e6d5471f15) fix(scripts): avoid swift CTS deadlock when running in docker ([#7146](https://github.com/algolia/api-clients-automation/pull/7146)) by [@Fluf22](https://github.com/Fluf22/)

data/Gemfile.lock

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

data/lib/algolia/api/analytics_client.rb

@@ -573,7 +573,7 @@ module Algolia
       )
     end
 
-    # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks.  By default, the analyzed period includes the last eight days including the current day.
+    # Retrieves the fraction of searches whose query didn't lead to any click within a time range, including a daily breakdown. Only tracked searches with at least one result are counted. A search counts as a search without clicks only when no search for the same query got a click in the time range, so the rate for a whole time range is usually lower than its daily rates. It also returns the number of these searches and of searches without clicks.  By default, the analyzed period includes the last eight days including the current day.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -616,7 +616,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. It also returns the number of tracked searches and tracked searches without clicks.  By default, the analyzed period includes the last eight days including the current day.
+    # Retrieves the fraction of searches whose query didn't lead to any click within a time range, including a daily breakdown. Only tracked searches with at least one result are counted. A search counts as a search without clicks only when no search for the same query got a click in the time range, so the rate for a whole time range is usually lower than its daily rates. It also returns the number of these searches and of searches without clicks.  By default, the analyzed period includes the last eight days including the current day.
     #
     # Required API Key ACLs:
     #   - analytics

data/lib/algolia/api/composition_client.rb

@@ -1024,7 +1024,7 @@ module Algolia
       )
     end
 
-    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. The provided sorting indices must be associated indices or replicas of the main targeted index.  This endpoint can't validate whether the sort index is related to the composition's main index. Validation fails at runtime if the index you updated isn't 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.
+    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. This endpoint only validates that the sorting indices exist. At runtime, the API ignores a sorting index that is unrelated to the targeted indices. The response reports it in the `errors` field.  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
@@ -1074,7 +1074,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. The provided sorting indices must be associated indices or replicas of the main targeted index.  This endpoint can't validate whether the sort index is related to the composition's main index. Validation fails at runtime if the index you updated isn't 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.
+    # Updates the \"sortingStrategy\" field of an existing composition. This endpoint lets you create a new sorting strategy mapping or replace the configured one. This endpoint only validates that the sorting indices exist. At runtime, the API ignores a sorting index that is unrelated to the targeted indices. The response reports it in the `errors` field.  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

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

@@ -8,13 +8,13 @@ require "time"
 module Algolia
   module Analytics
     class DailyNoClickRates
-      # No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
+      # No click rate: calculated as the number of tracked searches with results whose query didn't get any click in the time range, divided by the number of tracked searches with results.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :count
 
-      # Number of times this search was returned as a result without any click.
+      # Number of tracked searches with results whose query didn't get any click in the time range.
       attr_accessor :no_click_count
 
       # Date in the format YYYY-MM-DD.

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

@@ -8,13 +8,13 @@ require "time"
 module Algolia
   module Analytics
     class GetNoClickRateResponse
-      # No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
+      # No click rate: calculated as the number of tracked searches with results whose query didn't get any click in the time range, divided by the number of tracked searches with results.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :count
 
-      # Number of times this search was returned as a result without any click.
+      # Number of tracked searches with results whose query didn't get any click in the time range.
       attr_accessor :no_click_count
 
       # Daily no click rates.

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

@@ -19,7 +19,7 @@ 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.
+      # A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. When the composition is run, the API ignores a sorting index that is unrelated to the targeted indices. The response reports it in the `errors` field. 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.

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

@@ -8,11 +8,12 @@ require "time"
 module Algolia
   module Composition
     class ExternalOrdering
+      ALGOLIA_DEFINED = "algoliaDefined".freeze
       DEFAULT = "default".freeze
       USER_DEFINED = "userDefined".freeze
 
       def self.all_vars
-        @all_vars ||= [DEFAULT, USER_DEFINED].freeze
+        @all_vars ||= [ALGOLIA_DEFINED, DEFAULT, USER_DEFINED].freeze
       end
 
       # Builds the enum from string

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

@@ -0,0 +1,504 @@
+# 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
+    # Parameters for a single feed. These match the root `params` minus `injectedItems`, `getRankingInfo`, and `enableABTest`.
+    class FeedParams
+      # Whether this search will be included in Analytics.
+      attr_accessor :analytics
+
+      # Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
+      attr_accessor :analytics_tags
+
+      # Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.  Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
+      attr_accessor :around_lat_lng
+
+      # Whether to obtain the coordinates from the request's IP address.
+      attr_accessor :around_lat_lng_via_ip
+
+      attr_accessor :around_radius
+
+      attr_accessor :around_precision
+
+      # Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started).
+      attr_accessor :click_analytics
+
+      # Whether to enable Personalization.
+      attr_accessor :enable_personalization
+
+      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking). This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+      attr_accessor :enable_re_ranking
+
+      # Whether to enable composition rules.
+      attr_accessor :enable_rules
+
+      attr_accessor :facet_filters
+
+      # Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. To retrieve disjunctive facets lists, annotate any facets with the `disjunctive` modifier. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts) and [disjunctive faceting for Smart Groups](https://www.algolia.com/doc/guides/managing-results/compositions/search-based-groups#facets-including-disjunctive-faceting).
+      attr_accessor :facets
+
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
+      attr_accessor :filters
+
+      # Number of hits per page.
+      attr_accessor :hits_per_page
+
+      attr_accessor :inside_bounding_box
+
+      # 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
+
+      # Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
+      attr_accessor :minimum_around_radius
+
+      # 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`.
+      attr_accessor :natural_languages
+
+      attr_accessor :numeric_filters
+
+      attr_accessor :optional_filters
+
+      # Page of search results to retrieve.
+      attr_accessor :page
+
+      # Search query.
+      attr_accessor :query
+
+      # 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, place the CJK language **first**. **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/#standard-and-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/#assign-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.  For `multifeed` compositions, every feed inherits the root \"sortBy\" unless the feed sets its own \"sortBy\" in `feeds.<id>.params`. An empty string disables sorting for that feed. The response reports an invalid value in the `errors` field. This includes a value whose index is unrelated to the feed's indices. Composition Rules still match on the root \"sortBy\".
+      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
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :analytics => :analytics,
+          :analytics_tags => :analyticsTags,
+          :around_lat_lng => :aroundLatLng,
+          :around_lat_lng_via_ip => :aroundLatLngViaIP,
+          :around_radius => :aroundRadius,
+          :around_precision => :aroundPrecision,
+          :click_analytics => :clickAnalytics,
+          :enable_personalization => :enablePersonalization,
+          :enable_re_ranking => :enableReRanking,
+          :enable_rules => :enableRules,
+          :facet_filters => :facetFilters,
+          :facets => :facets,
+          :filters => :filters,
+          :hits_per_page => :hitsPerPage,
+          :inside_bounding_box => :insideBoundingBox,
+          :inside_polygon => :insidePolygon,
+          :minimum_around_radius => :minimumAroundRadius,
+          :natural_languages => :naturalLanguages,
+          :numeric_filters => :numericFilters,
+          :optional_filters => :optionalFilters,
+          :page => :page,
+          :query => :query,
+          :query_languages => :queryLanguages,
+          :relevancy_strictness => :relevancyStrictness,
+          :rule_contexts => :ruleContexts,
+          :sort_by => :sortBy,
+          :user_token => :userToken
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :analytics => :"Boolean",
+          :analytics_tags => :"Array<String>",
+          :around_lat_lng => :"String",
+          :around_lat_lng_via_ip => :"Boolean",
+          :around_radius => :"AroundRadius",
+          :around_precision => :"AroundPrecision",
+          :click_analytics => :"Boolean",
+          :enable_personalization => :"Boolean",
+          :enable_re_ranking => :"Boolean",
+          :enable_rules => :"Boolean",
+          :facet_filters => :"FacetFilters",
+          :facets => :"Array<String>",
+          :filters => :"String",
+          :hits_per_page => :"Integer",
+          :inside_bounding_box => :"InsideBoundingBox",
+          :inside_polygon => :"Array<Array<Float>>",
+          :minimum_around_radius => :"Integer",
+          :natural_languages => :"Array<SupportedLanguage>",
+          :numeric_filters => :"NumericFilters",
+          :optional_filters => :"OptionalFilters",
+          :page => :"Integer",
+          :query => :"String",
+          :query_languages => :"Array<SupportedLanguage>",
+          :relevancy_strictness => :"Integer",
+          :rule_contexts => :"Array<String>",
+          :sort_by => :"String",
+          :user_token => :"String"
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new(
+          [
+            :inside_bounding_box
+          ]
+        )
+      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::FeedParams` 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::FeedParams`. 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?(:analytics)
+          self.analytics = attributes[:analytics]
+        end
+
+        if attributes.key?(:analytics_tags)
+          if (value = attributes[:analytics_tags]).is_a?(Array)
+            self.analytics_tags = value
+          end
+        end
+
+        if attributes.key?(:around_lat_lng)
+          self.around_lat_lng = attributes[:around_lat_lng]
+        end
+
+        if attributes.key?(:around_lat_lng_via_ip)
+          self.around_lat_lng_via_ip = attributes[:around_lat_lng_via_ip]
+        end
+
+        if attributes.key?(:around_radius)
+          self.around_radius = attributes[:around_radius]
+        end
+
+        if attributes.key?(:around_precision)
+          self.around_precision = attributes[:around_precision]
+        end
+
+        if attributes.key?(:click_analytics)
+          self.click_analytics = attributes[:click_analytics]
+        end
+
+        if attributes.key?(:enable_personalization)
+          self.enable_personalization = attributes[:enable_personalization]
+        end
+
+        if attributes.key?(:enable_re_ranking)
+          self.enable_re_ranking = attributes[:enable_re_ranking]
+        end
+
+        if attributes.key?(:enable_rules)
+          self.enable_rules = attributes[:enable_rules]
+        end
+
+        if attributes.key?(:facet_filters)
+          self.facet_filters = attributes[:facet_filters]
+        end
+
+        if attributes.key?(:facets)
+          if (value = attributes[:facets]).is_a?(Array)
+            self.facets = value
+          end
+        end
+
+        if attributes.key?(:filters)
+          self.filters = attributes[:filters]
+        end
+
+        if attributes.key?(:hits_per_page)
+          self.hits_per_page = attributes[:hits_per_page]
+        end
+
+        if attributes.key?(:inside_bounding_box)
+          self.inside_bounding_box = attributes[:inside_bounding_box]
+        end
+
+        if attributes.key?(:inside_polygon)
+          if (value = attributes[:inside_polygon]).is_a?(Array)
+            self.inside_polygon = value
+          end
+        end
+
+        if attributes.key?(:minimum_around_radius)
+          self.minimum_around_radius = attributes[:minimum_around_radius]
+        end
+
+        if attributes.key?(:natural_languages)
+          if (value = attributes[:natural_languages]).is_a?(Array)
+            self.natural_languages = value
+          end
+        end
+
+        if attributes.key?(:numeric_filters)
+          self.numeric_filters = attributes[:numeric_filters]
+        end
+
+        if attributes.key?(:optional_filters)
+          self.optional_filters = attributes[:optional_filters]
+        end
+
+        if attributes.key?(:page)
+          self.page = attributes[:page]
+        end
+
+        if attributes.key?(:query)
+          self.query = attributes[:query]
+        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
+      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 &&
+          analytics == other.analytics &&
+          analytics_tags == other.analytics_tags &&
+          around_lat_lng == other.around_lat_lng &&
+          around_lat_lng_via_ip == other.around_lat_lng_via_ip &&
+          around_radius == other.around_radius &&
+          around_precision == other.around_precision &&
+          click_analytics == other.click_analytics &&
+          enable_personalization == other.enable_personalization &&
+          enable_re_ranking == other.enable_re_ranking &&
+          enable_rules == other.enable_rules &&
+          facet_filters == other.facet_filters &&
+          facets == other.facets &&
+          filters == other.filters &&
+          hits_per_page == other.hits_per_page &&
+          inside_bounding_box == other.inside_bounding_box &&
+          inside_polygon == other.inside_polygon &&
+          minimum_around_radius == other.minimum_around_radius &&
+          natural_languages == other.natural_languages &&
+          numeric_filters == other.numeric_filters &&
+          optional_filters == other.optional_filters &&
+          page == other.page &&
+          query == other.query &&
+          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
+
+      # @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
+        [
+          analytics,
+          analytics_tags,
+          around_lat_lng,
+          around_lat_lng_via_ip,
+          around_radius,
+          around_precision,
+          click_analytics,
+          enable_personalization,
+          enable_re_ranking,
+          enable_rules,
+          facet_filters,
+          facets,
+          filters,
+          hits_per_page,
+          inside_bounding_box,
+          inside_polygon,
+          minimum_around_radius,
+          natural_languages,
+          numeric_filters,
+          optional_filters,
+          page,
+          query,
+          query_languages,
+          relevancy_strictness,
+          rule_contexts,
+          sort_by,
+          user_token
+        ].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::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
+
+        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/composition/feed_request.rb

@@ -0,0 +1,206 @@
+# 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
+    class FeedRequest
+      attr_accessor :params
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :params => :params
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :params => :"FeedParams"
+        }
+      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::FeedRequest` 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::FeedRequest`. 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?(:params)
+          self.params = attributes[:params]
+        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 &&
+          params == other.params
+      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
+        [params].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::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
+
+        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/composition/params.rb

@@ -86,7 +86,7 @@ module Algolia
       # 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/#assign-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.
+      # 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.  For `multifeed` compositions, every feed inherits the root \"sortBy\" unless the feed sets its own \"sortBy\" in `feeds.<id>.params`. An empty string disables sorting for that feed. The response reports an invalid value in the `errors` field. This includes a value whose index is unrelated to the feed's indices. Composition Rules still match on the root \"sortBy\".
       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).

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

@@ -15,12 +15,16 @@ module Algolia
 
       attr_accessor :external_provider
 
+      # Per-feed parameters for `multifeed` compositions. Each key is a feed ID.  Feed `params` take precedence over the root `params`. A feed inherits every root key it doesn't set. A feed value replaces the root value instead of combining with it. This applies to every key, including `filters`, `facetFilters`, `optionalFilters`, and `analyticsTags`. For example, `filters` must repeat the common values. An empty value such as `filters: \"\"` discards the root value.  The API validates feed `params` like the root `params`. An unsupported parameter returns a 400 error.  A feed ID may not exist in the composition (for example, because a rule removed it). The response reports it in the `errors` field but request still succeeds.  Rules match once per request, against the root `params` only.
+      attr_accessor :feeds
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :params => :params,
           :feeds_order => :feedsOrder,
-          :external_provider => :externalProvider
+          :external_provider => :externalProvider,
+          :feeds => :feeds
         }
       end
 
@@ -29,7 +33,8 @@ module Algolia
         {
           :params => :"Params",
           :feeds_order => :"Array<String>",
-          :external_provider => :"ExternalProvider"
+          :external_provider => :"ExternalProvider",
+          :feeds => :"Hash<String, FeedRequest>"
         }
       end
 
@@ -76,6 +81,12 @@ module Algolia
         if attributes.key?(:external_provider)
           self.external_provider = attributes[:external_provider]
         end
+
+        if attributes.key?(:feeds)
+          if (value = attributes[:feeds]).is_a?(Hash)
+            self.feeds = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -85,7 +96,8 @@ module Algolia
         self.class == other.class &&
           params == other.params &&
           feeds_order == other.feeds_order &&
-          external_provider == other.external_provider
+          external_provider == other.external_provider &&
+          feeds == other.feeds
       end
 
       # @see the `==` method
@@ -97,7 +109,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [params, feeds_order, external_provider].hash
+        [params, feeds_order, external_provider, feeds].hash
       end
 
       # Builds the object from hash

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

@@ -18,7 +18,7 @@ module Algolia
       # Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
       attr_accessor :indexes
 
-      # Maximum number of results this API key can retrieve in one query. By default, there's no limit.
+      # Maximum number of hits this API key can retrieve per page.  If you set this to 0, the maximum allowed value (1,000) applies. If you also set `hitsPerPage` on the index, the engine uses the lower of the two values.
       attr_accessor :max_hits_per_query
 
       # Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there's no limit.

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

@@ -23,7 +23,7 @@ module Algolia
       # Index names or patterns that this API key can access. By default, an API key can access all indices in the same application.  You can use leading and trailing wildcard characters (`*`):  - `dev_*` matches all indices starting with \"dev_\". - `*_dev` matches all indices ending with \"_dev\". - `*_products_*` matches all indices containing \"_products_\".
       attr_accessor :indexes
 
-      # Maximum number of results this API key can retrieve in one query. By default, there's no limit.
+      # Maximum number of hits this API key can retrieve per page.  If you set this to 0, the maximum allowed value (1,000) applies. If you also set `hitsPerPage` on the index, the engine uses the lower of the two values.
       attr_accessor :max_hits_per_query
 
       # Maximum number of API requests allowed per IP address or [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken) per hour.  If this limit is reached, the API returns an error with status code `429`. By default, there's no limit.

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.47.0"
+  VERSION = "3.49.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.47.0
+  version: 3.49.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -499,6 +499,8 @@ files:
 - lib/algolia/models/composition/facet_ordering.rb
 - lib/algolia/models/composition/facet_stats.rb
 - lib/algolia/models/composition/feed_injection.rb
+- lib/algolia/models/composition/feed_params.rb
+- lib/algolia/models/composition/feed_request.rb
 - lib/algolia/models/composition/get_task_response.rb
 - lib/algolia/models/composition/highlight_result.rb
 - lib/algolia/models/composition/highlight_result_option.rb