algolia 3.12.2 → 3.12.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9587292eea66992a8194853185d742bade5bf36d1b82a1d30f7679dcdc6a3202
-  data.tar.gz: 6e4893f686553a07dc27741601d6eb1f0378bac14c29d2bd2038eadd9b7af5e6
+  metadata.gz: 3c0c935157ea336a265d218b742c182b0241745ec5d1bc18a368a12b8e14100d
+  data.tar.gz: e5d9c28396d5942d6a1d43e7028166f6455785d85eaff6aa3ef0a639793ddfce
 SHA512:
-  metadata.gz: 9575fb9325e0305c6f8a620663ada098de0d0d0ce46a2da2746f86f66b1abb52f0a11dc8f379ae8d70f40481d1fe3959bbc205f9a68570320f3ad3043923eb8c
-  data.tar.gz: ce3b12d4aa657ad2d76c01cace6dd397aaa9a2b4b471ed019f328de705a5b2f3ff5d8ede1cdecd2d915a331db2e3595dee9dcc9d57079c179f03f3ef20166a64
+  metadata.gz: bcd428c3ed3b16be111ba38f5e23fe27b5d474a3ad0cbe2003f800e2d7ab0cdd251cfd8ea00d40d79ca6b42362164e5dddef7b6eba9428c66d2185e7bd278253
+  data.tar.gz: 664dcf03d3faa22256529ebd1c62807340d0d50b79c89420a2ea800f50b52942b86a69828bf703dc6251e60143a13f8ccc334d84f6efc77b0dbc08244912b417

data/.github/workflows/issue.yml

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

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.12.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.12.2...3.12.3)
+
+- [92bd911848](https://github.com/algolia/api-clients-automation/commit/92bd911848) chore(scripts): point jira issues to another epic ([#4505](https://github.com/algolia/api-clients-automation/pull/4505)) by [@millotp](https://github.com/millotp/)
+- [b8918494d0](https://github.com/algolia/api-clients-automation/commit/b8918494d0) chore(deps): dependencies 2025-03-03 ([#4511](https://github.com/algolia/api-clients-automation/pull/4511)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [97d2722bc9](https://github.com/algolia/api-clients-automation/commit/97d2722bc9) fix(specs): Increase optionalWords visibility in docs ([#4559](https://github.com/algolia/api-clients-automation/pull/4559)) by [@gazconroy](https://github.com/gazconroy/)
+
 ## [3.12.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.12.1...3.12.2)
 
 - [ecd6bc4fed](https://github.com/algolia/api-clients-automation/commit/ecd6bc4fed) chore(deps): dependencies 2025-02-17 ([#4459](https://github.com/algolia/api-clients-automation/pull/4459)) by [@algolia-bot](https://github.com/algolia-bot/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.12.2)
+    algolia (3.12.3)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
@@ -11,7 +11,7 @@ GEM
   remote: https://rubygems.org/
   specs:
     base64 (0.2.0)
-    connection_pool (2.4.1)
+    connection_pool (2.5.0)
     faraday (2.12.2)
       faraday-net_http (>= 2.0, < 3.5)
       json
@@ -21,14 +21,14 @@ GEM
     faraday-net_http_persistent (2.3.0)
       faraday (~> 2.5)
       net-http-persistent (>= 4.0.4, < 5)
-    json (2.9.0)
-    logger (1.6.2)
+    json (2.10.1)
+    logger (1.6.6)
     net-http (0.6.0)
       uri
     net-http-persistent (4.0.5)
       connection_pool (~> 2.2)
     rake (13.2.1)
-    uri (1.0.2)
+    uri (1.0.3)
 
 PLATFORMS
   aarch64-linux

data/lib/algolia/api/abtesting_client.rb

@@ -113,7 +113,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTestResponse")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -145,7 +145,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -156,7 +156,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -188,7 +188,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -199,7 +199,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -232,7 +232,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -244,7 +244,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -277,7 +277,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/analytics_client.rb

@@ -69,7 +69,7 @@ module Algolia
       self
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -101,7 +101,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -112,7 +112,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -144,7 +144,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -155,7 +155,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -188,7 +188,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -200,7 +200,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -233,7 +233,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/ingestion_client.rb

@@ -342,7 +342,7 @@ module Algolia
       )
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -374,7 +374,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -385,7 +385,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -417,7 +417,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -428,7 +428,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -461,7 +461,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -473,7 +473,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -506,7 +506,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/insights_client.rb

@@ -69,7 +69,7 @@ module Algolia
       self
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -101,7 +101,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -112,7 +112,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -144,7 +144,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -155,7 +155,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -188,7 +188,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -200,7 +200,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -233,7 +233,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/monitoring_client.rb

@@ -42,7 +42,7 @@ module Algolia
       self
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -74,7 +74,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -85,7 +85,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -117,7 +117,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -128,7 +128,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -161,7 +161,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -173,7 +173,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -206,7 +206,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/personalization_client.rb

@@ -69,7 +69,7 @@ module Algolia
       self
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -101,7 +101,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -112,7 +112,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -144,7 +144,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -155,7 +155,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -188,7 +188,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -200,7 +200,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -233,7 +233,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/query_suggestions_client.rb

@@ -113,7 +113,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "QuerySuggestions::BaseResponse")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -145,7 +145,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -156,7 +156,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -188,7 +188,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -199,7 +199,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -232,7 +232,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -244,7 +244,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -277,7 +277,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/recommend_client.rb

@@ -107,7 +107,7 @@ module Algolia
       )
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -139,7 +139,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -150,7 +150,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -182,7 +182,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -193,7 +193,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -226,7 +226,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -238,7 +238,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -271,7 +271,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

data/lib/algolia/api/search_client.rb

@@ -598,7 +598,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -630,7 +630,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -641,7 +641,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -673,7 +673,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -684,7 +684,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -717,7 +717,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -729,7 +729,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.
@@ -762,7 +762,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # This method allow you to send requests to the Algolia REST API.
+    # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required)
     # @param parameters [Hash<String, Object>] Query parameters to apply to the current query.

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

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Recommend
+    # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
     module OptionalWords
       class << self
       # List of class defined in oneOf (OpenAPI v3)

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

@@ -7,6 +7,7 @@ require "time"
 
 module Algolia
   module Search
+    # Words that should be considered optional when found in the query.  By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher.  For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records:  - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:   results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).   For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.  For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
     module OptionalWords
       class << self
       # List of class defined in oneOf (OpenAPI v3)

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.12.2"
+  VERSION = "3.12.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.12.2
+  version: 3.12.3
 platform: ruby
 authors:
 - https://alg.li/support
 bindir: bin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday