algolia 3.43.0 → 3.45.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e15a7a80471a7a68cf607c70e21c52f1a0f5d12b3a93888d3865f5bc02a257
-  data.tar.gz: 0c45427919aef09a76d67b2320ad80908268fb5e9d96a6e9f1510c25b8fab6bf
+  metadata.gz: 131af010718e4264c9274e60d2196d44d4b2fc773c50bf2efee519882241834b
+  data.tar.gz: c03e511630bd7fc5eced4798c576ef1b6fb2e77325929e5f38f4e788428e83bb
 SHA512:
-  metadata.gz: 8f2f198904f5afb8bc656d3d6f4eadfb37330db685656144c978443b0614aa5faf64718124200fcde6d19234b18e48aa960b173ab9e5222cb04ccc7d1dd2fed7
-  data.tar.gz: a4971f5c0ffc4fbddba53281df8763082e659a39f67cb53ffc1b5f76898b8269f4e544575727742d8e048ae4dea79d1b2cfc60639550a38d74203d94572099b9
+  metadata.gz: 21d7d96dddef5d1477718c2a29be54b607f2e182779eb7837bc279ce4cf05a3e7209584d99f61f8cf74549c928bbc07855987e70e36143d281fb226fef137dac
+  data.tar.gz: 444596073256d8222b5fde7e3b5172048408c487cb758243775b2c95d5fd0ec6401cff9b6fc2ba815bbcdc6db74a8cd9d9fc8b169eecba0c6d4988aa7e6270b2

data/.github/workflows/issue.yml

@@ -3,9 +3,8 @@ on:
   issues:
     types: [opened]
 
-permissions:
-  issues: write
-  contents: read
+# the sync script only reads the event payload and calls the Jira API with its own token
+permissions: {}
 
 jobs:
   sync:
@@ -13,6 +12,9 @@ jobs:
     steps:
       - name: Create ticket
         uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
+        env:
+          # env indirection so the secret is never materialized into the composed script
+          JIRA_TOKEN: ${{ secrets.JIRA_TOKEN }}
         with:
           script: |
             const action = context.payload.action;
@@ -27,7 +29,7 @@ jobs:
               headers: {
                 'Accept': 'application/json',
                 'Content-Type': 'application/json',
-                'Authorization': `Basic ${{ secrets.JIRA_TOKEN }}`
+                'Authorization': `Basic ${process.env.JIRA_TOKEN}`
               },
               body: JSON.stringify({
                 fields: {

data/.github/workflows/release.yml

@@ -24,6 +24,6 @@ jobs:
           ruby-version: 4.0.6
           bundler-cache: true
 
-      - uses: rubygems/release-gem@052cc82692552de3ef2b81fd670e41d13cba8092 # v1.4.0
+      - uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1
         with:
           await-release: false

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [3.45.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.44.0...3.45.0)
+
+BREAKING CHANGES: this minor version includes breaking changes in the A/B Testing V3 API. See below for more details.
+
+- [c974374aff](https://github.com/algolia/api-clients-automation/commit/c974374aff) feat(ruby): Request-ID and Correlation-ID support ([#6877](https://github.com/algolia/api-clients-automation/pull/6877)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+- [e4a6ab510a](https://github.com/algolia/api-clients-automation/commit/e4a6ab510a) chore(ci): fail CI if a personal access token secret is referenced ([#6919](https://github.com/algolia/api-clients-automation/pull/6919)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+- [085364de00](https://github.com/algolia/api-clients-automation/commit/085364de00) feat(specs): deprecates /2 abtests endpoints ([#6921](https://github.com/algolia/api-clients-automation/pull/6921)) by [@Niamsy](https://github.com/Niamsy/)
+- [32c1aaa192](https://github.com/algolia/api-clients-automation/commit/32c1aaa192) chore(deps): dependencies 2026-08-24 ([#6922](https://github.com/algolia/api-clients-automation/pull/6922)) by [@algolia-api-clients-automation-bot[bot]](https://github.com/apps/algolia-api-clients-automation-bot)
+- [28aa13de2e](https://github.com/algolia/api-clients-automation/commit/28aa13de2e) fix(clients): support guzzlehttp/psr7 v3 ([#6945](https://github.com/algolia/api-clients-automation/pull/6945)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+- [b4c4109163](https://github.com/algolia/api-clients-automation/commit/b4c4109163) fix(specs): flag analytics patterns endpoints with x-beta ([#6954](https://github.com/algolia/api-clients-automation/pull/6954)) by [@cdhawke](https://github.com/cdhawke/)
+- [8317b3a8ef](https://github.com/algolia/api-clients-automation/commit/8317b3a8ef) feat(specs): BREAKING CHANGE – remove migratedAbTestID from abtesting-v3 ([#6883](https://github.com/algolia/api-clients-automation/pull/6883)) by [@cdhawke](https://github.com/cdhawke/)
+- [808f5ebcea](https://github.com/algolia/api-clients-automation/commit/808f5ebcea) fix(ruby): keep millisecond precision when converting timeouts to seconds ([#6946](https://github.com/algolia/api-clients-automation/pull/6946)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+
+## [3.44.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.43.0...3.44.0)
+
+- [c974374aff](https://github.com/algolia/api-clients-automation/commit/c974374aff) feat(ruby): Request-ID and Correlation-ID support ([#6877](https://github.com/algolia/api-clients-automation/pull/6877)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+- [e4a6ab510a](https://github.com/algolia/api-clients-automation/commit/e4a6ab510a) chore(ci): fail CI if a personal access token secret is referenced ([#6919](https://github.com/algolia/api-clients-automation/pull/6919)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+- [085364de00](https://github.com/algolia/api-clients-automation/commit/085364de00) feat(specs): deprecates /2 abtests endpoints ([#6921](https://github.com/algolia/api-clients-automation/pull/6921)) by [@Niamsy](https://github.com/Niamsy/)
+- [32c1aaa192](https://github.com/algolia/api-clients-automation/commit/32c1aaa192) chore(deps): dependencies 2026-08-24 ([#6922](https://github.com/algolia/api-clients-automation/pull/6922)) by [@algolia-api-clients-automation-bot[bot]](https://github.com/apps/algolia-api-clients-automation-bot)
+
 ## [3.43.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.3...3.43.0)
 
 - [3bee6d1dee](https://github.com/algolia/api-clients-automation/commit/3bee6d1dee) chore(ci): pin all GitHub Action refs to commit SHAs (API-475) ([#6819](https://github.com/algolia/api-clients-automation/pull/6819)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)

data/Gemfile.lock

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

data/lib/algolia/api/abtesting_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})
@@ -69,10 +70,11 @@ module Algolia
       self
     end
 
-    # Creates a new A/B test.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests`.  Creates a new A/B test.
     #
     # Required API Key ACLs:
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param add_ab_tests_request [AddABTestsRequest]  (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
@@ -101,7 +103,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Creates a new A/B test.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests`.  Creates a new A/B test.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -305,10 +307,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object")
     end
 
-    # Deletes an A/B test by its ID.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `DELETE /3/abtests/{id}`.  Deletes an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param id [Integer] Unique A/B test identifier. (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
@@ -337,7 +340,7 @@ module Algolia
       @api_client.call_api(:DELETE, path, new_options)
     end
 
-    # Deletes an A/B test by its ID.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `DELETE /3/abtests/{id}`.  Deletes an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -349,10 +352,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTestResponse")
     end
 
-    # Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests/estimate`.  Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
     #
     # Required API Key ACLs:
     #   - analytics
+    # THIS OPERATION IS DEPRECATED
     # @param estimate_ab_test_request [EstimateABTestRequest]  (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
@@ -381,7 +385,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests/estimate`.  Given the traffic percentage and the expected effect size, this endpoint estimates the sample size and duration of an A/B test based on historical traffic.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -393,10 +397,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::EstimateABTestResponse")
     end
 
-    # Retrieves the details for an A/B test by its ID.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `GET /3/abtests/{id}`.  Retrieves the details for an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - analytics
+    # THIS OPERATION IS DEPRECATED
     # @param id [Integer] Unique A/B test identifier. (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
@@ -425,7 +430,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Retrieves the details for an A/B test by its ID.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `GET /3/abtests/{id}`.  Retrieves the details for an A/B test by its ID.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -437,10 +442,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ABTest")
     end
 
-    # Lists all A/B tests you configured for this application.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `GET /3/abtests`.  Lists all A/B tests you configured for this application.
     #
     # Required API Key ACLs:
     #   - analytics
+    # THIS OPERATION IS DEPRECATED
     # @param offset [Integer] Position of the first item to return. (default to 0)
     # @param limit [Integer] Number of items to return. (default to 10)
     # @param index_prefix [String] Index name prefix. Only A/B tests for indices starting with this string are included in the response.
@@ -477,7 +483,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Lists all A/B tests you configured for this application.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `GET /3/abtests`.  Lists all A/B tests you configured for this application.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -492,10 +498,11 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ListABTestsResponse")
     end
 
-    # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests/{id}/stop`.  Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs:
     #   - editSettings
+    # THIS OPERATION IS DEPRECATED
     # @param id [Integer] Unique A/B test identifier. (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
@@ -524,7 +531,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
+    # This endpoint is deprecated. Use the A/B Testing API v3 instead.  Replaced by `POST /3/abtests/{id}/stop`.  Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs:
     #   - editSettings

data/lib/algolia/api/abtesting_v3_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})

data/lib/algolia/api/agent_studio_client.rb

@@ -26,7 +26,8 @@ module Algolia
         config.write_timeout = 25000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, opts = {})

data/lib/algolia/api/analytics_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})
@@ -691,7 +692,7 @@ module Algolia
       )
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required. Use it to discover valid `(domain, kind)` pairs before building the other `/3/patterns/*` queries; two fields are combinable in one query only when their `roots` intersect. Each entry's `requires` lists the ACLs needed when that field is actually used in a query.
+    # Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required. Use it to discover valid `(domain, kind)` pairs before building the other `/3/patterns/*` queries; two fields are combinable in one query only when their `roots` intersect. Each entry's `requires` lists the ACLs needed when that field is actually used in a query.
 
     # @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
@@ -715,7 +716,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required. Use it to discover valid `(domain, kind)` pairs before building the other `/3/patterns/*` queries; two fields are combinable in one query only when their `roots` intersect. Each entry's `requires` lists the ACLs needed when that field is actually used in a query.
+    # Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required. Use it to discover valid `(domain, kind)` pairs before building the other `/3/patterns/*` queries; two fields are combinable in one query only when their `roots` intersect. Each entry's `requires` lists the ACLs needed when that field is actually used in a query.
 
     # @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 [Catalog]
@@ -1798,7 +1799,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetUsersCountResponse")
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Buckets one or more numeric fields into histograms and returns an object keyed by `histogram<Field>`, each mapping a bin label to a count. `distributions` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Buckets one or more numeric fields into histograms and returns an object keyed by `histogram<Field>`, each mapping a bin label to a count. `distributions` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1832,7 +1833,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Buckets one or more numeric fields into histograms and returns an object keyed by `histogram<Field>`, each mapping a bin label to a count. `distributions` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Buckets one or more numeric fields into histograms and returns an object keyed by `histogram<Field>`, each mapping a bin label to a count. `distributions` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1845,7 +1846,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Object>")
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Aggregates the requested `metrics` over the whole period and returns a single object keyed by metric kind. `metrics` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Aggregates the requested `metrics` over the whole period and returns a single object keyed by metric kind. `metrics` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1879,7 +1880,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Aggregates the requested `metrics` over the whole period and returns a single object keyed by metric kind. `metrics` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Aggregates the requested `metrics` over the whole period and returns a single object keyed by metric kind. `metrics` and `parameters` are required; `filters` is optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1892,7 +1893,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash<String, Object>")
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns `rows`, each a flat object of the requested fields. `metrics` and `parameters` are required; `groupBy`, `filters`, and `orderBy` are optional, though `orderBy` is required when `groupBy` is set. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Returns `rows`, each a flat object of the requested fields. `metrics` and `parameters` are required; `groupBy`, `filters`, and `orderBy` are optional, though `orderBy` is required when `groupBy` is set. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1926,7 +1927,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns `rows`, each a flat object of the requested fields. `metrics` and `parameters` are required; `groupBy`, `filters`, and `orderBy` are optional, though `orderBy` is required when `groupBy` is set. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Returns `rows`, each a flat object of the requested fields. `metrics` and `parameters` are required; `groupBy`, `filters`, and `orderBy` are optional, though `orderBy` is required when `groupBy` is set. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1939,7 +1940,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::TableResponse")
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns one time series per `groupBy` combination, each with period `totals` and a per-day metric breakdown. `metrics` and `parameters` are required; `groupBy` and `filters` are optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Returns one time series per `groupBy` combination, each with period `totals` and a per-day metric breakdown. `metrics` and `parameters` are required; `groupBy` and `filters` are optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics
@@ -1973,7 +1974,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # **Beta**: this endpoint is under active development and may change without notice.  Returns one time series per `groupBy` combination, each with period `totals` and a per-day metric breakdown. `metrics` and `parameters` are required; `groupBy` and `filters` are optional. Discover valid field kinds per domain with `/3/patterns/fields`.
+    # Returns one time series per `groupBy` combination, each with period `totals` and a per-day metric breakdown. `metrics` and `parameters` are required; `groupBy` and `filters` are optional. Discover valid field kinds per domain with `/3/patterns/fields`.
     #
     # Required API Key ACLs:
     #   - analytics

data/lib/algolia/api/composition_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: true)
     end
 
     def self.create(app_id, api_key, opts = {})

data/lib/algolia/api/ingestion_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 25000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})

data/lib/algolia/api/insights_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})

data/lib/algolia/api/monitoring_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, opts = {})

data/lib/algolia/api/personalization_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})

data/lib/algolia/api/query_suggestions_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: false)
     end
 
     def self.create(app_id, api_key, region = nil, opts = {})

data/lib/algolia/api/recommend_client.rb

@@ -23,7 +23,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: true)
     end
 
     def self.create(app_id, api_key, opts = {})

data/lib/algolia/api/search_client.rb

@@ -69,7 +69,8 @@ module Algolia
         config.write_timeout = 30000
       end
 
-      @api_client = Algolia::ApiClient.new(config)
+      # Per-client capability; an explicit config.request_id_enabled always wins.
+      @api_client = Algolia::ApiClient.new(config, request_id_support: true)
       @ingestion_transporter = nil
       if config.transformation_options
         @ingestion_transporter = _build_ingestion_transporter(config.transformation_options)
@@ -3412,6 +3413,42 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdateApiKeyResponse")
     end
 
+    # Helper: Derives the request options carrying the Request-ID shared by every request
+    # of one helper invocation. Returns the options untouched when the client does not
+    # support Request-ID or the caller already supplied one through the options (as a
+    # header or an x-algolia-request-id query parameter) or the config headers, which
+    # also makes nested helpers reuse the ID minted by their caller.
+    #
+    # @param request_options [Hash]
+    #
+    # @return [Hash]
+    private def with_request_id(request_options = {})
+      config = api_client.config
+      unless api_client.request_id_enabled? &&
+          !Transport::RequestId.request_id?(request_options[:header_params]) &&
+          !Transport::RequestId.request_id?(config.header_params) &&
+          !Transport::RequestId.request_id_query_param?(request_options[:query_params])
+        return request_options
+      end
+
+      request_options.merge(
+        :header_params => (request_options[:header_params] || {}).merge(
+          Transport::RequestId::HEADER => Transport::RequestId.generate
+        )
+      )
+    end
+
+    # Helper: Drops the caller's timeouts from the given request options, so that the
+    # failure-path cleanup calls run with the client defaults while keeping the other
+    # options, notably the headers carrying the invocation's shared Request-ID.
+    #
+    # @param request_options [Hash]
+    #
+    # @return [Hash]
+    private def without_timeouts(request_options)
+      request_options.reject { |key, _| key == :timeout || key == :connect_timeout }
+    end
+
     # The parent search config MUST NOT leak into the ingestion transporter.
     def _build_ingestion_transporter(transformation_options)
       hosts = if transformation_options.hosts
@@ -3561,6 +3598,10 @@ module Algolia
     )
       assert_ingestion_transporter!
 
+      # The shared Request-ID only covers the search-side calls: the ingestion
+      # push goes to an API that must not receive the header.
+      search_request_options = with_request_id(request_options)
+
       if objects.empty?
         @api_client.logger.warn(
           "replace_all_objects_with_transformation was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
@@ -3581,7 +3622,7 @@ module Algolia
             destination: tmp_index_name,
             scope: scopes
           ),
-          request_options
+          search_request_options
         )
 
         watch_responses = @ingestion_transporter.chunked_push(
@@ -3595,7 +3636,13 @@ module Algolia
           opts
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          copy_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          search_request_options
+        )
 
         copy_operation_response = operation_index(
           index_name,
@@ -3604,10 +3651,16 @@ module Algolia
             destination: tmp_index_name,
             scope: scopes
           ),
-          request_options
+          search_request_options
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          copy_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          search_request_options
+        )
 
         move_operation_response = operation_index(
           tmp_index_name,
@@ -3615,10 +3668,16 @@ module Algolia
             operation: Search::OperationType::MOVE,
             destination: index_name
           ),
-          request_options
+          search_request_options
         )
 
-        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          move_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          search_request_options
+        )
 
         search_watch_responses = watch_responses.map do |wr|
           Search::WatchResponse.build_from_hash(wr.to_hash)
@@ -3630,7 +3689,13 @@ module Algolia
           move_operation_response: move_operation_response
         )
       rescue Exception => e
-        delete_index(tmp_index_name)
+        begin
+          delete_index(tmp_index_name, without_timeouts(search_request_options))
+        rescue StandardError => cleanup_error
+          @api_client.logger.warn(
+            "Failed to delete the temporary index \"#{tmp_index_name}\", please delete it manually: #{cleanup_error}"
+          )
+        end
 
         raise e
       end
@@ -3641,16 +3706,17 @@ module Algolia
     # @param index_name [String] the `index_name` where the operation was performed. (required)
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
     # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
-    # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
+    # @param timeout [Proc] the function to decide how long to wait between retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_task(
       index_name,
       task_id,
       max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
-      timeout = -> (retry_count) { [retry_count * 200, 5000].min },
+      timeout = Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
       request_options = {}
     )
+      request_options = with_request_id(request_options)
       retries = 0
       while retries < max_retries
         res = get_task(index_name, task_id, request_options)
@@ -3672,15 +3738,16 @@ module Algolia
     #
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
     # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
-    # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
+    # @param timeout [Proc] the function to decide how long to wait between retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_app_task(
       task_id,
       max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
-      timeout = -> (retry_count) { [retry_count * 200, 5000].min },
+      timeout = Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
       request_options = {}
     )
+      request_options = with_request_id(request_options)
       retries = 0
       while retries < max_retries
         res = get_app_task(task_id, request_options)
@@ -3703,8 +3770,8 @@ module Algolia
     # @param key [String] the `key` that has been added, deleted or updated.
     # @param operation [String] the `operation` that was done on a `key`.
     # @param api_key [Hash] necessary to know if an `update` operation has been processed, compare fields of the response with it.
-    # @param max_retries [Integer] the maximum number of retries.
-    # @param timeout [Proc] the function to decide how long to wait between retries.
+    # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
+    # @param timeout [Proc] the function to decide how long to wait between retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
     # @return [Http::Response] the last get_api_key response
     def wait_for_api_key(
@@ -3712,9 +3779,10 @@ module Algolia
       operation,
       api_key = Search::ApiKey.new,
       max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
-      timeout = -> (retry_count) { [retry_count * 200, 5000].min },
+      timeout = Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
       request_options = {}
     )
+      request_options = with_request_id(request_options)
       api_key = api_client.object_to_hash(api_key)
 
       retries = 0
@@ -3769,6 +3837,7 @@ module Algolia
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `browse` method.
     # @param block [Proc] the block to execute on each object of the index.
     def browse_objects(index_name, browse_params = Search::BrowseParamsObject.new, request_options = {}, &block)
+      request_options = with_request_id(request_options)
       browse_params = api_client.object_to_hash(browse_params)
 
       browse_params[:hitsPerPage] = 1000 unless browse_params.key?(:hitsPerPage)
@@ -3798,6 +3867,7 @@ module Algolia
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `searchRules` method.
     # @param block [Proc] the block to execute on each rule of the index.
     def browse_rules(index_name, search_rules_params = Search::SearchRulesParams.new, request_options = {}, &block)
+      request_options = with_request_id(request_options)
       search_rules_params = api_client.object_to_hash(search_rules_params)
 
       search_rules_params[:page] ||= 0
@@ -3833,6 +3903,7 @@ module Algolia
       request_options = {},
       &block
     )
+      request_options = with_request_id(request_options)
       search_synonyms_params = api_client.object_to_hash(search_synonyms_params)
 
       search_synonyms_params[:page] ||= 0
@@ -4036,6 +4107,7 @@ module Algolia
       request_options = {},
       chunked_options = nil
     )
+      request_options = with_request_id(request_options)
       opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       responses = []
       objects.each_slice(batch_size) do |chunk|
@@ -4048,7 +4120,13 @@ module Algolia
 
       if wait_for_tasks
         responses.each do |response|
-          wait_for_task(index_name, response.task_id, opts.max_retries)
+          wait_for_task(
+            index_name,
+            response.task_id,
+            opts.max_retries,
+            Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+            request_options
+          )
         end
       end
 
@@ -4074,6 +4152,8 @@ module Algolia
       request_options = {},
       chunked_options = nil
     )
+      request_options = with_request_id(request_options)
+
       if objects.empty?
         @api_client.logger.warn(
           "replace_all_objects was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
@@ -4107,7 +4187,13 @@ module Algolia
           opts
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          copy_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          request_options
+        )
 
         copy_operation_response = operation_index(
           index_name,
@@ -4119,7 +4205,13 @@ module Algolia
           request_options
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          copy_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          request_options
+        )
 
         move_operation_response = operation_index(
           tmp_index_name,
@@ -4130,7 +4222,13 @@ module Algolia
           request_options
         )
 
-        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
+        wait_for_task(
+          tmp_index_name,
+          move_operation_response.task_id,
+          opts.max_retries,
+          Algolia::ChunkedHelperOptions::DEFAULT_TIMEOUT,
+          request_options
+        )
 
         Search::ReplaceAllObjectsResponse.new(
           copy_operation_response: copy_operation_response,
@@ -4138,7 +4236,13 @@ module Algolia
           move_operation_response: move_operation_response
         )
       rescue Exception => e
-        delete_index(tmp_index_name)
+        begin
+          delete_index(tmp_index_name, without_timeouts(request_options))
+        rescue StandardError => cleanup_error
+          @api_client.logger.warn(
+            "Failed to delete the temporary index \"#{tmp_index_name}\", please delete it manually: #{cleanup_error}"
+          )
+        end
 
         raise e
       end

data/lib/algolia/api_client.rb

@@ -13,11 +13,19 @@ module Algolia
 
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config = Configuration.default)
+    # @param request_id_support [true, false] the generated per-client Request-ID capability,
+    #   applied when config.request_id_enabled is nil. Kept on the transport so a shared Configuration is never mutated.
+    def initialize(config = Configuration.default, request_id_support: false)
       @config = config
       @requester = config.requester || Http::HttpRequester.new("net_http_persistent", LoggerHelper.create)
       @logger = (@requester.logger if @requester.respond_to?(:logger)) || LoggerHelper.create
-      @transporter = Transport::Transport.new(config, @requester)
+      @transporter = Transport::Transport.new(config, @requester, request_id_support: request_id_support)
+    end
+
+    # Whether the transport mints Request-ID headers, resolved per request.
+    # @return [true, false]
+    def request_id_enabled?
+      @transporter.request_id_enabled?
     end
 
     def self.default

data/lib/algolia/chunked_helper_options.rb

@@ -3,6 +3,7 @@ module Algolia
   class ChunkedHelperOptions
     DEFAULT_MAX_RETRIES = 100
     DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES = 800
+    DEFAULT_TIMEOUT = -> (retry_count) { [retry_count * 200, 5000].min }
     attr_reader :max_retries
 
     def initialize(max_retries: DEFAULT_MAX_RETRIES)

data/lib/algolia/configuration.rb

@@ -1,5 +1,3 @@
-# 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
   class Configuration
     attr_accessor(
@@ -21,6 +19,14 @@ module Algolia
     # @return [true, false]
     attr_accessor :client_side_validation
 
+    # Whether the transport sends a Request-ID header, minted once per call and
+    # reused across its retry attempts. When nil, each generated client applies its
+    # per-client default (on for the search, recommend and composition APIs, off
+    # elsewhere); an explicit true or false always wins and may be flipped at any
+    # time. A caller-supplied Request-ID is never overwritten.
+    # @return [true, false, nil]
+    attr_accessor :request_id_enabled
+
     def initialize(app_id, api_key, hosts, client_name, opts = {})
       @hosts = hosts
       @app_id = app_id
@@ -33,6 +39,8 @@ module Algolia
       @requester = opts[:requester]
       @transformation_options = opts[:transformation_options]
 
+      @request_id_enabled = opts[:request_id_enabled]
+
       @user_agent = UserAgent.new.add(client_name, VERSION)
 
       if opts[:user_agent_segments]

data/lib/algolia/error.rb

@@ -12,13 +12,20 @@ module Algolia
   class AlgoliaUnreachableHostError < AlgoliaError
     attr_reader :errors
 
-    def initialize(message, errors = [])
+    # The last non-empty Correlation-ID header among the retried attempts, or nil.
+    # Quote it when contacting Algolia support.
+    attr_reader :correlation_id
+
+    def initialize(message, errors = [], correlation_id = nil)
       errors.last&.tap do |last_error|
         message += " Last error for #{last_error[:host]}: #{last_error[:error]}"
       end
 
+      message += " (Correlation-ID: #{correlation_id})" unless correlation_id.nil? || correlation_id.empty?
+
       super(message)
       @errors = errors
+      @correlation_id = correlation_id
     end
   end
 
@@ -29,10 +36,20 @@ module Algolia
   class AlgoliaHttpError < AlgoliaError
     attr_accessor :code, :http_message
 
-    def initialize(code, message)
+    # The Correlation-ID header of the failed response (possibly ""), or nil.
+    # Quote it when contacting Algolia support.
+    attr_reader :correlation_id
+
+    def initialize(code, message, correlation_id = nil)
       self.code = code
       self.http_message = message
-      super("#{code}: #{message}")
+      @correlation_id = correlation_id
+
+      if correlation_id.nil? || correlation_id.empty?
+        super("#{code}: #{message}")
+      else
+        super("#{code}: #{message} (Correlation-ID: #{correlation_id})")
+      end
     end
   end
 end

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

@@ -33,9 +33,6 @@ module Algolia
 
       attr_accessor :configuration
 
-      # Unique migrated A/B test identifier.
-      attr_accessor :migrated_ab_test_id
-
       attr_accessor :decision
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -50,7 +47,6 @@ module Algolia
           :status => :status,
           :variants => :variants,
           :configuration => :configuration,
-          :migrated_ab_test_id => :migratedAbTestID,
           :decision => :decision
         }
       end
@@ -67,7 +63,6 @@ module Algolia
           :status => :"Status",
           :variants => :"Array<Variant>",
           :configuration => :"ABTestConfiguration",
-          :migrated_ab_test_id => :"Integer",
           :decision => :"Decision"
         }
       end
@@ -153,10 +148,6 @@ module Algolia
           self.configuration = attributes[:configuration]
         end
 
-        if attributes.key?(:migrated_ab_test_id)
-          self.migrated_ab_test_id = attributes[:migrated_ab_test_id]
-        end
-
         if attributes.key?(:decision)
           self.decision = attributes[:decision]
         end
@@ -176,7 +167,6 @@ module Algolia
           status == other.status &&
           variants == other.variants &&
           configuration == other.configuration &&
-          migrated_ab_test_id == other.migrated_ab_test_id &&
           decision == other.decision
       end
 
@@ -189,19 +179,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [
-          ab_test_id,
-          updated_at,
-          created_at,
-          end_at,
-          stopped_at,
-          name,
-          status,
-          variants,
-          configuration,
-          migrated_ab_test_id,
-          decision
-        ].hash
+        [ab_test_id, updated_at, created_at, end_at, stopped_at, name, status, variants, configuration, decision].hash
       end
 
       # Builds the object from hash

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

@@ -8,6 +8,9 @@ require "time"
 module Algolia
   module Search
     class Log
+      # Correlation ID of the logged API request, also returned in that request's `Correlation-ID` response header.
+      attr_accessor :cid
+
       # Date and time of the API request, in RFC 3339 format.
       attr_accessor :timestamp
 
@@ -56,6 +59,7 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :cid => :cid,
           :timestamp => :timestamp,
           :method => :method,
           :answer_code => :answer_code,
@@ -77,6 +81,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
+          :cid => :"String",
           :timestamp => :"String",
           :method => :"String",
           :answer_code => :"String",
@@ -122,6 +127,10 @@ module Algolia
           h[k.to_sym] = v
         }
 
+        if attributes.key?(:cid)
+          self.cid = attributes[:cid]
+        end
+
         if attributes.key?(:timestamp)
           self.timestamp = attributes[:timestamp]
         else
@@ -210,6 +219,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
+          cid == other.cid &&
           timestamp == other.timestamp &&
           method == other.method &&
           answer_code == other.answer_code &&
@@ -237,6 +247,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [
+          cid,
           timestamp,
           method,
           answer_code,

data/lib/algolia/transport/http/http_requester.rb

@@ -26,8 +26,8 @@ module Algolia
       #
       def send_request(host, method, path, body, query_params, headers, timeout, connect_timeout)
         connection = connection(host)
-        connection.options.timeout = timeout / 1000
-        connection.options.open_timeout = connect_timeout / 1000
+        connection.options.timeout = timeout / 1000.0
+        connection.options.open_timeout = connect_timeout / 1000.0
         path += handle_query_params(query_params)
 
         @logger.info("Sending #{method.to_s.upcase} request to #{path} with body #{body}") if ENV["ALGOLIA_DEBUG"]

data/lib/algolia/transport/request_id.rb

@@ -0,0 +1,49 @@
+require "securerandom"
+
+module Algolia
+  module Transport
+    # Mints the Request-ID tracing header sent by the clients that support it.
+    module RequestId
+      HEADER = "request-id".freeze
+      CORRELATION_HEADER = "Correlation-ID".freeze
+      QUERY_PARAM = "x-algolia-request-id".freeze
+
+      # Returns a fresh 11-character base62 identifier suitable for the Request-ID header.
+      #
+      # @return [String]
+      #
+      def self.generate
+        SecureRandom.alphanumeric(11)
+      end
+
+      # Whether the given headers already carry a Request-ID entry, whatever its casing
+      # and key type. Header hashes keep the caller's literal casing and may use symbol
+      # keys, so the lookup must not assume a canonical form.
+      #
+      # @param headers [Hash, nil]
+      #
+      # @return [true, false]
+      #
+      def self.request_id?(headers)
+        return false unless headers.respond_to?(:each_pair)
+
+        headers.any? { |k, _| k.to_s.casecmp?(HEADER) }
+      end
+
+      # Whether the given query parameters already carry an x-algolia-request-id
+      # entry, whatever its casing and key type. The server consults the query
+      # parameter only when the header is absent, so minting a header would
+      # override a caller-supplied value sent on that channel.
+      #
+      # @param query_params [Hash, nil]
+      #
+      # @return [true, false]
+      #
+      def self.request_id_query_param?(query_params)
+        return false unless query_params.respond_to?(:each_pair)
+
+        query_params.any? { |k, _| k.to_s.casecmp?(QUERY_PARAM) }
+      end
+    end
+  end
+end

data/lib/algolia/transport/transport.rb

@@ -23,13 +23,25 @@ module Algolia
 
       # @param config [Configuration]
       # @param requester [Object] requester used for sending requests. Uses Algolia::Http::HttpRequester by default
+      # @param request_id_support [true, false] the generated per-client Request-ID capability
       #
-      def initialize(config, requester)
+      def initialize(config, requester, request_id_support: false)
         @config = config
         @requester = requester
+        @request_id_support = request_id_support
         @retry_strategy = RetryStrategy.new(config.hosts)
       end
 
+      # Whether the transport mints Request-ID headers. Resolved per request so a
+      # caller can flip config.request_id_enabled at any time, like every other
+      # Configuration setting; nil falls back to the per-client capability.
+      #
+      # @return [true, false]
+      #
+      def request_id_enabled?
+        @config.request_id_enabled.nil? ? @request_id_support : @config.request_id_enabled
+      end
+
       # @param call_type [Binary] READ or WRITE operation
       # @param method [Symbol] method used for request
       # @param path [String] path of the request
@@ -41,7 +53,23 @@ module Algolia
       def request(call_type, method, path, body, opts = {})
         retry_errors = []
 
+        # The Request-ID is minted once per execution, before the host loop, so that
+        # every retry attempt shares the same value and each subsequent call gets a
+        # fresh one.
+        request_id = mint_request_id(opts)
+
+        # create consumes these two channels from opts on every attempt: snapshot them
+        # so retries keep them. Timeout keys stay consumable, recomputed per host below.
+        header_params = opts[:header_params]
+        query_params = opts[:query_params]
+
+        # The Correlation-ID of the last retried attempt whose response carried a
+        # non-empty one, surfaced on the exhaustion error for support tickets.
+        last_correlation_id = nil
+
         @retry_strategy.get_tryable_hosts(call_type).each do |host|
+          opts[:header_params] ||= header_params
+          opts[:query_params] ||= query_params
           opts[:timeout] ||= get_timeout(call_type)
           opts[:connect_timeout] ||= (@config.connect_timeout || Defaults::CONNECT_TIMEOUT) * (host.retry_count + 1)
 
@@ -50,7 +78,7 @@ module Algolia
           # TODO: what is this merge for ?
           # request_options.query_params.merge!(request_options.data) if method == :GET
 
-          request = build_request(method, path, body, request_options)
+          request = build_request(method, path, body, request_options, request_id)
           response = @requester.send_request(
             host,
             request[:method],
@@ -69,16 +97,20 @@ module Algolia
             network_failure: response.network_failure
           )
           if outcome == FAILURE
+            correlation_id = correlation_id_from(response.headers)
+
             # handle HTML error
             if response.headers["content-type"]&.include?("text/html")
-              raise Algolia::AlgoliaHttpError.new(response.status, response.reason_phrase)
+              raise Algolia::AlgoliaHttpError.new(response.status, response.reason_phrase, correlation_id)
             end
 
             decoded_error = JSON.parse(response.error, :symbolize_names => true)
-            raise Algolia::AlgoliaHttpError.new(response.status, decoded_error[:message])
+            raise Algolia::AlgoliaHttpError.new(response.status, decoded_error[:message], correlation_id)
           end
 
           if outcome == RETRY
+            correlation_id = correlation_id_from(response.headers)
+            last_correlation_id = correlation_id unless correlation_id.nil? || correlation_id.empty?
             retry_errors << {host: host.url, error: response.error}
           else
             return response
@@ -88,29 +120,65 @@ module Algolia
         raise(
           Algolia::AlgoliaUnreachableHostError.new(
             "Unreachable hosts. If the error persists, please visit our help center https://alg.li/support-unreachable-hosts or reach out to the Algolia Support team: https://alg.li/support",
-            retry_errors
+            retry_errors,
+            last_correlation_id
           )
         )
       end
 
       private
 
+      # Returns a fresh Request-ID, or nil when the feature is off for this client
+      # or the caller already supplied one through the request options, the config
+      # default headers, or the x-algolia-request-id query parameter. Caller-supplied
+      # values ride their own channel on every attempt.
+      #
+      # @param opts [Hash]
+      #
+      # @return [String, nil]
+      #
+      def mint_request_id(opts)
+        return nil unless request_id_enabled?
+        return nil if RequestId.request_id?(opts[:header_params])
+        return nil if RequestId.request_id?(@config.header_params)
+        return nil if RequestId.request_id_query_param?(opts[:query_params])
+
+        RequestId.generate
+      end
+
+      # Reads the Correlation-ID header of a failed response case-insensitively: the
+      # headers hash keeps the server's casing and defaults to an empty string on
+      # timeout and network failures. The unrelated X-Algolia-RequestID edge header
+      # must never be read instead.
+      #
+      # @param headers [Hash, String]
+      #
+      # @return [String, nil]
+      #
+      def correlation_id_from(headers)
+        return nil unless headers.respond_to?(:each_pair)
+
+        headers.find { |k, _| k.to_s.casecmp?(RequestId::CORRELATION_HEADER) }&.last
+      end
+
       # Parse the different information and build the request
       #
       # @param [Symbol] method
       # @param [String] path
       # @param [Hash] body
       # @param [RequestOptions] request_options
+      # @param [String, nil] request_id
       #
       # @return [Hash]
       #
-      def build_request(method, path, body, request_options)
+      def build_request(method, path, body, request_options, request_id = nil)
         request = {}
         request[:method] = method.downcase
         request[:path] = path
         request[:body] = build_body(body, request_options)
         request[:query_params] = Algolia::Transport.stringify_query_params(request_options.query_params)
-        request[:header_params] = generate_header_params(body, request_options)
+
+        request[:header_params] = generate_header_params(body, request_options, request_id)
         request[:timeout] = request_options.timeout
         request[:connect_timeout] = request_options.connect_timeout
         request
@@ -129,13 +197,16 @@ module Algolia
 
       # Generates headers from config headers and optional parameters
       #
+      # @param body [String, nil]
       # @param request_options [RequestOptions]
+      # @param request_id [String, nil]
       #
       # @return [Hash] merged headers
       #
-      def generate_header_params(body, request_options)
+      def generate_header_params(body, request_options, request_id = nil)
         header_params = request_options.header_params.transform_keys(&:downcase)
         header_params = @config.header_params.merge(header_params)
+        header_params[RequestId::HEADER] = request_id if request_id
         if request_options.compression_type == "gzip" && body.is_a?(String) && !body.to_s.strip.empty?
           header_params["content-encoding"] = "gzip"
         end

data/lib/algolia/version.rb

@@ -3,5 +3,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.43.0"
+  VERSION = "3.45.0"
 end

data/lib/algolia.rb

@@ -17,6 +17,7 @@ require "algolia/transport/call_type"
 require "algolia/transport/retry_outcome_type"
 require "algolia/transport/stateful_host"
 require "algolia/transport/retry_strategy"
+require "algolia/transport/request_id"
 require "algolia/transport/request_options"
 require "algolia/transport/transport"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.43.0
+  version: 3.45.0
 platform: ruby
 authors:
 - https://alg.li/support
@@ -1010,6 +1010,7 @@ files:
 - lib/algolia/transport/echo_requester.rb
 - lib/algolia/transport/http/http_requester.rb
 - lib/algolia/transport/http/response.rb
+- lib/algolia/transport/request_id.rb
 - lib/algolia/transport/request_options.rb
 - lib/algolia/transport/retry_outcome_type.rb
 - lib/algolia/transport/retry_strategy.rb