algolia 3.29.0 → 3.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcde7ae71c32fa6e073950147008629bff66d7ecbf6b12a444eb77940b2554ee
-  data.tar.gz: f56588ae532e018f7a7b98ce88cef47b68d99eef0c5fe1652eca50823ac36d1a
+  metadata.gz: 698d0bf438f61272bc29420b92a6e6d3d7284810c99a915d58b7b28e6ef64061
+  data.tar.gz: a59ba07ae58c007bbf2c832b400cce0cca4e89fa3cdf9f80965d1b4eb93e3ddb
 SHA512:
-  metadata.gz: 1d1a35d5c6b0b0d0496ea9602fe3d7b8b7d451bfbb01c76403dbb8247910d99e7080ab5e4d0df11b20c38a5a9fbf8215d3669ba8a1a935c9ba9e807ed02e1daa
-  data.tar.gz: '0812ca5adb24357e0dfa5d48be4ef7f5e206b3ecd105bba4dd2c1cb8cc456b7b346677f793b0e8cef4e2defacf1ba949b4dc32dc473ef7a5860c997c56a540c1'
+  metadata.gz: d196cc67966b88bd8ea0de06a9d4b4a8ebb54722d1716fd421de078eb64c8410475dc32fbaf67b1c50ae402e94923f59d15cdfd84fcc8e9c079283c06b81dfa9
+  data.tar.gz: 37fba20279d136c60e354072e8ecd05e2e079f9253579eba8b054b5feff8e3bd10722583aa888e0a49842a8cfa8354a53f13588dd78433524a7f5c6f16e199a3

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.30.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.29.0...3.30.0)
+
+- [d9b21b4b1](https://github.com/algolia/api-clients-automation/commit/d9b21b4b1) feat(specs): add `renderingContent` query parameter in Composition API main injection ([#5549](https://github.com/algolia/api-clients-automation/pull/5549)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [1eee2a5f7](https://github.com/algolia/api-clients-automation/commit/1eee2a5f7) fix(specs): add ACL to missing endpoints ([#5529](https://github.com/algolia/api-clients-automation/pull/5529)) by [@millotp](https://github.com/millotp/)
+- [38ae444d7](https://github.com/algolia/api-clients-automation/commit/38ae444d7) feat(specs): add specific documentation for `facets` query parameter in Composition API ([#5477](https://github.com/algolia/api-clients-automation/pull/5477)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+
 ## [3.29.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.28.1...3.29.0)
 
 - [7f9de7cd9](https://github.com/algolia/api-clients-automation/commit/7f9de7cd9) fix(specs): ingestion small fix + added source input descriptions ([#5515](https://github.com/algolia/api-clients-automation/pull/5515)) by [@sbellone](https://github.com/sbellone/)

data/Gemfile.lock

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

data/lib/algolia/api/ingestion_client.rb

@@ -220,7 +220,11 @@ module Algolia
     end
 
     # Creates a new task.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreate] Request body for creating a task. (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
@@ -250,7 +254,11 @@ module Algolia
     end
 
     # Creates a new task.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreate] Request body for creating a task. (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 [TaskCreateResponse]
@@ -260,7 +268,11 @@ module Algolia
     end
 
     # Creates a new task using the v1 endpoint, please use `createTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_create [TaskCreateV1] Request body for creating a task. (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)
@@ -291,7 +303,11 @@ module Algolia
     end
 
     # Creates a new task using the v1 endpoint, please use `createTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_create [TaskCreateV1] Request body for creating a task. (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 [TaskCreateResponse]
@@ -301,7 +317,11 @@ module Algolia
     end
 
     # Creates a new transformation.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_create [TransformationCreate] Request body for creating a transformation. (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
@@ -331,7 +351,11 @@ module Algolia
     end
 
     # Creates a new transformation.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_create [TransformationCreate] Request body for creating a transformation. (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 [TransformationCreateResponse]
@@ -670,7 +694,11 @@ module Algolia
     end
 
     # Deletes a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (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
@@ -700,7 +728,11 @@ module Algolia
     end
 
     # Deletes a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (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 [DeleteResponse]
@@ -710,7 +742,11 @@ module Algolia
     end
 
     # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (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)
@@ -741,7 +777,11 @@ module Algolia
     end
 
     # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (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 [DeleteResponse]
@@ -751,7 +791,11 @@ module Algolia
     end
 
     # Deletes a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (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
@@ -784,7 +828,11 @@ module Algolia
     end
 
     # Deletes a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (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 [DeleteResponse]
@@ -2277,7 +2325,11 @@ module Algolia
     end
 
     # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_replace [TaskReplace]  (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)
@@ -2312,7 +2364,11 @@ module Algolia
     end
 
     # Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_replace [TaskReplace]  (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)
@@ -3104,7 +3160,11 @@ module Algolia
     end
 
     # Partially updates a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (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)
@@ -3139,7 +3199,11 @@ module Algolia
     end
 
     # Partially updates a task by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdate]  (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)
@@ -3150,7 +3214,11 @@ module Algolia
     end
 
     # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # THIS OPERATION IS DEPRECATED
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdateV1]  (required)
@@ -3186,7 +3254,11 @@ module Algolia
     end
 
     # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param task_update [TaskUpdateV1]  (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)
@@ -3197,7 +3269,11 @@ module Algolia
     end
 
     # Updates a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param transformation_create [TransformationCreate]  (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)
@@ -3235,7 +3311,11 @@ module Algolia
     end
 
     # Updates a transformation by its ID.
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
     # @param transformation_id [String] Unique identifier of a transformation. (required)
     # @param transformation_create [TransformationCreate]  (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)

data/lib/algolia/api/search_client.rb

@@ -268,7 +268,9 @@ module Algolia
     end
 
     # Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param batch_write_params [BatchWriteParams]  (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)
@@ -303,7 +305,9 @@ module Algolia
     end
 
     # Adds, updates, or deletes records in one index with a single API request.  Batching index updates reduces latency and increases data integrity.  - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param index_name [String] Name of the index on which to perform the operation. (required)
     # @param batch_write_params [BatchWriteParams]  (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)
@@ -1134,7 +1138,9 @@ module Algolia
     end
 
     # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param key [String] API key. (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
@@ -1164,7 +1170,9 @@ module Algolia
     end
 
     # Gets the permissions and restrictions of an API key.  When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`.
-
+    #
+    # Required API Key ACLs:
+    #   - search
     # @param key [String] API key. (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 [GetApiKeyResponse]
@@ -1976,7 +1984,9 @@ module Algolia
     end
 
     # Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param batch_params [BatchParams]  (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
@@ -2006,7 +2016,9 @@ module Algolia
     end
 
     # Adds, updates, or deletes records in multiple indices with a single API request.  - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.  This operation is subject to [indexing rate limits](https://support.algolia.com/hc/articles/4406975251089-Is-there-a-rate-limit-for-indexing-on-Algolia).
-
+    #
+    # Required API Key ACLs:
+    #   - addObject
     # @param batch_params [BatchParams]  (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 [MultipleBatchResponse]

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

@@ -141,7 +141,7 @@ module Algolia
       # Whether faceting should be applied after deduplication with `distinct` This leads to accurate facet counts when using faceting in combination with `distinct`. It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
       attr_accessor :faceting_after_distinct
 
-      # 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 `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
+      # 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
 
       # Number of hits per page.
@@ -150,6 +150,8 @@ module Algolia
       # Maximum number of facet values to return for each facet.
       attr_accessor :max_values_per_facet
 
+      attr_accessor :rendering_content
+
       # Order in which to retrieve facet values - `count`.   Facet values are retrieved by decreasing count.   The count is the number of matching records containing this facet value - `alpha`.   Retrieve facet values alphabetically This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`). For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js).
       attr_accessor :sort_facet_values_by
 
@@ -210,6 +212,7 @@ module Algolia
           :facets => :facets,
           :hits_per_page => :hitsPerPage,
           :max_values_per_facet => :maxValuesPerFacet,
+          :rendering_content => :renderingContent,
           :sort_facet_values_by => :sortFacetValuesBy,
           :sum_or_filters_scores => :sumOrFiltersScores
         }
@@ -269,6 +272,7 @@ module Algolia
           :facets => :"Array<String>",
           :hits_per_page => :"Integer",
           :max_values_per_facet => :"Integer",
+          :rendering_content => :"RenderingContent",
           :sort_facet_values_by => :"String",
           :sum_or_filters_scores => :"Boolean"
         }
@@ -543,6 +547,10 @@ module Algolia
           self.max_values_per_facet = attributes[:max_values_per_facet]
         end
 
+        if attributes.key?(:rendering_content)
+          self.rendering_content = attributes[:rendering_content]
+        end
+
         if attributes.key?(:sort_facet_values_by)
           self.sort_facet_values_by = attributes[:sort_facet_values_by]
         end
@@ -608,6 +616,7 @@ module Algolia
           facets == other.facets &&
           hits_per_page == other.hits_per_page &&
           max_values_per_facet == other.max_values_per_facet &&
+          rendering_content == other.rendering_content &&
           sort_facet_values_by == other.sort_facet_values_by &&
           sum_or_filters_scores == other.sum_or_filters_scores
       end
@@ -673,6 +682,7 @@ module Algolia
           facets,
           hits_per_page,
           max_values_per_facet,
+          rendering_content,
           sort_facet_values_by,
           sum_or_filters_scores
         ].hash

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

@@ -23,11 +23,11 @@ module Algolia
       # 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
 
-      # 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 `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
-      attr_accessor :facets
-
       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
+
       attr_accessor :optional_filters
 
       attr_accessor :numeric_filters
@@ -94,8 +94,8 @@ module Algolia
           :page => :page,
           :get_ranking_info => :getRankingInfo,
           :relevancy_strictness => :relevancyStrictness,
-          :facets => :facets,
           :facet_filters => :facetFilters,
+          :facets => :facets,
           :optional_filters => :optionalFilters,
           :numeric_filters => :numericFilters,
           :hits_per_page => :hitsPerPage,
@@ -128,8 +128,8 @@ module Algolia
           :page => :"Integer",
           :get_ranking_info => :"Boolean",
           :relevancy_strictness => :"Integer",
-          :facets => :"Array<String>",
           :facet_filters => :"FacetFilters",
+          :facets => :"Array<String>",
           :optional_filters => :"OptionalFilters",
           :numeric_filters => :"NumericFilters",
           :hits_per_page => :"Integer",
@@ -203,16 +203,16 @@ module Algolia
           self.relevancy_strictness = attributes[:relevancy_strictness]
         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?(:facet_filters)
-          self.facet_filters = attributes[:facet_filters]
-        end
-
         if attributes.key?(:optional_filters)
           self.optional_filters = attributes[:optional_filters]
         end
@@ -320,8 +320,8 @@ module Algolia
           page == other.page &&
           get_ranking_info == other.get_ranking_info &&
           relevancy_strictness == other.relevancy_strictness &&
-          facets == other.facets &&
           facet_filters == other.facet_filters &&
+          facets == other.facets &&
           optional_filters == other.optional_filters &&
           numeric_filters == other.numeric_filters &&
           hits_per_page == other.hits_per_page &&
@@ -360,8 +360,8 @@ module Algolia
           page,
           get_ranking_info,
           relevancy_strictness,
-          facets,
           facet_filters,
+          facets,
           optional_filters,
           numeric_filters,
           hits_per_page,

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.29.0"
+  VERSION = "3.30.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.29.0
+  version: 3.30.0
 platform: ruby
 authors:
 - https://alg.li/support