algolia 3.45.0 → 3.46.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 131af010718e4264c9274e60d2196d44d4b2fc773c50bf2efee519882241834b
-  data.tar.gz: c03e511630bd7fc5eced4798c576ef1b6fb2e77325929e5f38f4e788428e83bb
+  metadata.gz: 328e8475c7136afd5c3ecb2e096a3c7cbeeaccc7fe1f00e46ef1f0d761ba5371
+  data.tar.gz: 6191e28670fce3448e29aa71b1d348ff9fa033e726101e5e7d67a024bd9592e6
 SHA512:
-  metadata.gz: 21d7d96dddef5d1477718c2a29be54b607f2e182779eb7837bc279ce4cf05a3e7209584d99f61f8cf74549c928bbc07855987e70e36143d281fb226fef137dac
-  data.tar.gz: 444596073256d8222b5fde7e3b5172048408c487cb758243775b2c95d5fd0ec6401cff9b6fc2ba815bbcdc6db74a8cd9d9fc8b169eecba0c6d4988aa7e6270b2
+  metadata.gz: 164520f8480480fd77846475b8fbe0c71d61b9180564f132835ef7d9a7ca471ab82f6737ca354f7bba0d0c4a4b8fcab5149874c5b8fd4a26bef7fb6aba14e26f
+  data.tar.gz: 9e4c5bfd50ce5ec2e98efe1a7fbe55316ff640e542035871085bb92903bbd89d55f8ade740a4ae8a470ee066c102a6c5589fe2fbde8e12610548969075627c6b

data/.github/workflows/release.yml

@@ -19,9 +19,9 @@ jobs:
       - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
 
       - name: Install Ruby
-        uses: ruby/setup-ruby@95ef2b042f9d7a56d8268cba8559e2842e2ad01b # v1.321.0
+        uses: ruby/setup-ruby@651ff0d62c5c79bed6d53ec518387aae20e72c1a # v1.329.0
         with:
-          ruby-version: 4.0.6
+          ruby-version: 4.0.7
           bundler-cache: true
 
       - uses: rubygems/release-gem@7f9650160c1a4e7989fdc9855807bdbd421d8b6b # v1.4.1

data/AGENTS.md

@@ -122,18 +122,6 @@ response['hits']     # Works
 response.hits        # Works if using model objects
 ```
 
-### Block Syntax
-
-```ruby
-# Use do..end for multi-line, braces for single-line
-client.search { |r| r.query = 'test' }
-
-client.search do |params|
-  params.query = 'test'
-  params.hits_per_page = 10
-end
-```
-
 ### Error Handling
 
 ```ruby
@@ -148,18 +136,6 @@ rescue Algolia::ApiError => e
 end
 ```
 
-### Nil Safety
-
-```ruby
-# Use safe navigation
-result&.hits&.first&.object_id
-
-# Or explicit checks
-if result && result.hits && result.hits.any?
-  result.hits.first.object_id
-end
-```
-
 ### Deprecated Operations
 
 Some operations in `ingestion_client.rb` and `search_client.rb` are deprecated. Check method documentation before use.

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## [3.46.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.46.0...3.46.1)
+
+- [f2854eb518](https://github.com/algolia/api-clients-automation/commit/f2854eb518) chore(ci): bump ruby/setup-ruby to v1.329.0 to support Ruby 4.0.7 ([#7142](https://github.com/algolia/api-clients-automation/pull/7142)) by [@Fluf22](https://github.com/Fluf22/)
+
+## [3.46.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.45.0...3.46.0)
+
+BREAKING CHANGES: this minor version includes breaking changes (A/B Testing V3 API, Agent Studio API). See below for more details.
+
+- [ba46df188a](https://github.com/algolia/api-clients-automation/commit/ba46df188a) feat(clients): wait and retry on 429 with Retry-After ([#7062](https://github.com/algolia/api-clients-automation/pull/7062)) by [@MarioAlexandruDan](https://github.com/MarioAlexandruDan/)
+- [41ed59956a](https://github.com/algolia/api-clients-automation/commit/41ed59956a) fix(specs): clarify when _extra and _injectedItemKey are present on hits ([#7031](https://github.com/algolia/api-clients-automation/pull/7031)) by [@charlottetaylor-oss](https://github.com/charlottetaylor-oss/)
+- [987444f36d](https://github.com/algolia/api-clients-automation/commit/987444f36d) fix(specs): clarify addItemKey description in injectedItem metadata ([#7029](https://github.com/algolia/api-clients-automation/pull/7029)) by [@charlottetaylor-oss](https://github.com/charlottetaylor-oss/)
+- [f6a0478eec](https://github.com/algolia/api-clients-automation/commit/f6a0478eec) docs(specs): update analytics catalog entitlement example ([#7028](https://github.com/algolia/api-clients-automation/pull/7028)) by [@cdhawke](https://github.com/cdhawke/)
+- [5da059b7ae](https://github.com/algolia/api-clients-automation/commit/5da059b7ae) feat(specs): add A/B test settings endpoints to abtesting-v3 ([#6786](https://github.com/algolia/api-clients-automation/pull/6786)) by [@stevenMevans](https://github.com/stevenMevans/)
+- [f89fe94db5](https://github.com/algolia/api-clients-automation/commit/f89fe94db5) fix(clients): send request bodies with Content-Length instead of chunked encoding ([#7069](https://github.com/algolia/api-clients-automation/pull/7069)) by [@Fluf22](https://github.com/Fluf22/)
+- [461575c4a4](https://github.com/algolia/api-clients-automation/commit/461575c4a4) feat(specs): add A/B testing hypothesis ([#6829](https://github.com/algolia/api-clients-automation/pull/6829)) by [@leonardogavaudan](https://github.com/leonardogavaudan/)
+- [b58c40832b](https://github.com/algolia/api-clients-automation/commit/b58c40832b) fix(specs): BREAKING CHANGE - make AB test pValue optional ([#7066](https://github.com/algolia/api-clients-automation/pull/7066)) by [@stevenMevans](https://github.com/stevenMevans/)
+  - `pValue` is now optional in the A/B test models. Update code that reads it as a required value.
+- [4cab83c8b1](https://github.com/algolia/api-clients-automation/commit/4cab83c8b1) feat(specs): add `externalProvider` source for CompAPI client ([#7073](https://github.com/algolia/api-clients-automation/pull/7073)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [b6cd822bfb](https://github.com/algolia/api-clients-automation/commit/b6cd822bfb) feat(specs): add resultCard to renderingContent widgets ([#7084](https://github.com/algolia/api-clients-automation/pull/7084)) by [@FabienMotte](https://github.com/FabienMotte/)
+- [63c591d078](https://github.com/algolia/api-clients-automation/commit/63c591d078) refactor(specs): extract source object from behaviour object ([#7074](https://github.com/algolia/api-clients-automation/pull/7074)) by [@ClaraMuller](https://github.com/ClaraMuller/)
+- [2ae63dbdfc](https://github.com/algolia/api-clients-automation/commit/2ae63dbdfc) docs: improve AGENTS.md agent context ([#7085](https://github.com/algolia/api-clients-automation/pull/7085)) by [@Fluf22](https://github.com/Fluf22/)
+- [07c1b2ea15](https://github.com/algolia/api-clients-automation/commit/07c1b2ea15) fix(specs): BREAKING CHANGE – sync agent-studio OpenAPI from conversational-ai ([#6967](https://github.com/algolia/api-clients-automation/pull/6967)) by [@algolia-api-clients-automation-bot[bot]](https://github.com/apps/algolia-api-clients-automation-bot)
+  - The Agent Studio specs were updated to match the API behaviour, which may require updating your implementation:
+  - `createAgentCompletion`: the body type changed from `AgentCompletionRequest` to `AgentCompletionRequestUnion`.
+  - `createAgent`, `updateAgent`, `getAgent`: tool config models were renamed or merged (`AlgoliaDisplayResultsToolConfig` is now `AlgoliaGroupedResultsToolConfig`, `AlgoliaRecommendToolConfigInput`/`Output` are now `AlgoliaRecommendToolConfig`, `ToolConfig` is now `ToolConfigOrBooleanUnion`).
+  - The memory request models `MessagesUnionAgentConsolidateRequest`, `MessagesUnionAgentMemorizeRequest` and `MessagesUnionAgentPonderRequest` were removed.
+- [a41727d2e1](https://github.com/algolia/api-clients-automation/commit/a41727d2e1) chore(deps): dependencies 2026-09-21 ([#7068](https://github.com/algolia/api-clients-automation/pull/7068)) by [@algolia-api-clients-automation-bot[bot]](https://github.com/apps/algolia-api-clients-automation-bot)
+- [9a6faf38f6](https://github.com/algolia/api-clients-automation/commit/9a6faf38f6) fix(specs): correct links to Algolia docs ([#7134](https://github.com/algolia/api-clients-automation/pull/7134)) by [@kai687](https://github.com/kai687/)
+- [329efbae3b](https://github.com/algolia/api-clients-automation/commit/329efbae3b) fix(specs): update allowed value for externalProvider source ordering field ([#7131](https://github.com/algolia/api-clients-automation/pull/7131)) by [@aiordache](https://github.com/aiordache/)
+
 ## [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.

data/Gemfile.lock

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

data/lib/algolia/api/abtesting_v3_client.rb

@@ -114,6 +114,61 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTestResponse")
     end
 
+    # Applies the captured settings of the given variant to the control index.  The settings must first be captured with the `saveVariantSettings` operation. To revert previously applied settings on the control index, use this operation with the control variant (variant 1).  Settings can be applied up to 14 days after the A/B test ends, and reverted up to 15 days after. Later requests return `400`.  Each set of captured settings can only be applied once, and settings that were reverted can't be applied again. Both cases return `400`.  The control index must not be in use by an active A/B test. Otherwise, the request returns `422`.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    #   - editSettings
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param variant_id [Integer] One-based index of the A/B test variant. The control is variant 1. (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def apply_variant_settings_with_http_info(id, variant_id, request_options = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `apply_variant_settings`."
+      end
+      # verify the required parameter 'variant_id' is set
+      if @api_client.config.client_side_validation && variant_id.nil?
+        raise ArgumentError, "Parameter `variant_id` is required when calling `apply_variant_settings`."
+      end
+
+      path = "/3/abtests/{id}/settings/{variantId}/apply".sub("{" + "id" + "}", Transport.encode_uri(id.to_s)).sub(
+        "{" + "variantId" + "}",
+        Transport.encode_uri(variant_id.to_s)
+      )
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.apply_variant_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Applies the captured settings of the given variant to the control index.  The settings must first be captured with the `saveVariantSettings` operation. To revert previously applied settings on the control index, use this operation with the control variant (variant 1).  Settings can be applied up to 14 days after the A/B test ends, and reverted up to 15 days after. Later requests return `400`.  Each set of captured settings can only be applied once, and settings that were reverted can't be applied again. Both cases return `400`.  The control index must not be in use by an active A/B test. Otherwise, the request returns `422`.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    #   - editSettings
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param variant_id [Integer] One-based index of the A/B test variant. The control is variant 1. (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 [nil]
+    def apply_variant_settings(id, variant_id, request_options = {})
+      apply_variant_settings_with_http_info(id, variant_id, request_options)
+      nil
+    end
+
     # This method lets you send requests to the Algolia REST API.
 
     # @param path [String] Path of the endpoint, for example `1/newFeature`. (required)
@@ -402,9 +457,10 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param id [Integer] Unique A/B test identifier. (required)
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def get_ab_test_with_http_info(id, request_options = {})
+    def get_ab_test_with_http_info(id, methods = nil, request_options = {})
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
         raise ArgumentError, "Parameter `id` is required when calling `get_ab_test`."
@@ -412,6 +468,7 @@ module Algolia
 
       path = "/3/abtests/{id}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
       query_params = {}
+      query_params[:methods] = @api_client.build_collection_param(methods, :csv) unless methods.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
@@ -434,13 +491,61 @@ module Algolia
     # Required API Key ACLs:
     #   - analytics
     # @param id [Integer] Unique A/B test identifier. (required)
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @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 [ABTest]
-    def get_ab_test(id, request_options = {})
-      response = get_ab_test_with_http_info(id, request_options)
+    def get_ab_test(id, methods = nil, request_options = {})
+      response = get_ab_test_with_http_info(id, methods, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ABTest")
     end
 
+    # Retrieves the settings captured for each variant of an A/B test, and whether another active A/B test is using the control index.  Settings are captured by the `saveVariantSettings` operation. The response includes an entry for the control (variant 1) alongside the captured variant, so the control's original configuration can be restored later.  Returns `404` if the A/B test doesn't exist or no settings have been captured for it.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @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
+    def get_ab_test_settings_with_http_info(id, request_options = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `get_ab_test_settings`."
+      end
+
+      path = "/3/abtests/{id}/settings".sub("{" + "id" + "}", Transport.encode_uri(id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.get_ab_test_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # Retrieves the settings captured for each variant of an A/B test, and whether another active A/B test is using the control index.  Settings are captured by the `saveVariantSettings` operation. The response includes an entry for the control (variant 1) alongside the captured variant, so the control's original configuration can be restored later.  Returns `404` if the A/B test doesn't exist or no settings have been captured for it.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    # @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 [ABTestSettingsResponse]
+    def get_ab_test_settings(id, request_options = {})
+      response = get_ab_test_settings_with_http_info(id, request_options)
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "AbtestingV3::ABTestSettingsResponse"
+      )
+    end
+
     # Retrieves timeseries for an A/B test by its ID.
     #
     # Required API Key ACLs:
@@ -449,9 +554,17 @@ module Algolia
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def get_timeseries_with_http_info(id, start_date = nil, end_date = nil, metric = nil, request_options = {})
+    def get_timeseries_with_http_info(
+      id,
+      start_date = nil,
+      end_date = nil,
+      metric = nil,
+      methods = nil,
+      request_options = {}
+    )
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
         raise ArgumentError, "Parameter `id` is required when calling `get_timeseries`."
@@ -462,6 +575,7 @@ module Algolia
       query_params[:startDate] = start_date unless start_date.nil?
       query_params[:endDate] = end_date unless end_date.nil?
       query_params[:metric] = @api_client.build_collection_param(metric, :multi) unless metric.nil?
+      query_params[:methods] = @api_client.build_collection_param(methods, :csv) unless methods.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
@@ -487,10 +601,11 @@ module Algolia
     # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format.
     # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format.
     # @param metric [Array<MetricName>] List of metrics to retrieve. If not specified, all metrics are returned.
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @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 [Timeseries]
-    def get_timeseries(id, start_date = nil, end_date = nil, metric = nil, request_options = {})
-      response = get_timeseries_with_http_info(id, start_date, end_date, metric, request_options)
+    def get_timeseries(id, start_date = nil, end_date = nil, metric = nil, methods = nil, request_options = {})
+      response = get_timeseries_with_http_info(id, start_date, end_date, metric, methods, request_options)
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::Timeseries")
     end
 
@@ -503,6 +618,7 @@ module Algolia
     # @param index_prefix [String] Index name prefix. Only A/B tests for indices starting with this string are included in the response.
     # @param index_suffix [String] Index name suffix. Only A/B tests for indices ending with this string are included in the response.
     # @param direction [Direction] Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
     def list_ab_tests_with_http_info(
@@ -511,6 +627,7 @@ module Algolia
       index_prefix = nil,
       index_suffix = nil,
       direction = nil,
+      methods = nil,
       request_options = {}
     )
       path = "/3/abtests"
@@ -520,6 +637,7 @@ module Algolia
       query_params[:indexPrefix] = index_prefix unless index_prefix.nil?
       query_params[:indexSuffix] = index_suffix unless index_suffix.nil?
       query_params[:direction] = direction unless direction.nil?
+      query_params[:methods] = @api_client.build_collection_param(methods, :csv) unless methods.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
@@ -546,6 +664,7 @@ module Algolia
     # @param index_prefix [String] Index name prefix. Only A/B tests for indices starting with this string are included in the response.
     # @param index_suffix [String] Index name suffix. Only A/B tests for indices ending with this string are included in the response.
     # @param direction [Direction] Sort order for A/B tests by start date. Use 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.
+    # @param methods [Array<AnalysisMethod>] Statistical analysis results to include, as a comma-separated list. When omitted, each test uses its configured method, or `frequentist` if no method is configured. Request both methods to include both sets of available results. This doesn't change the test configuration or compute missing results. Duplicate values aren't allowed.
     # @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 [ListABTestsResponse]
     def list_ab_tests(
@@ -554,12 +673,82 @@ module Algolia
       index_prefix = nil,
       index_suffix = nil,
       direction = nil,
+      methods = nil,
       request_options = {}
     )
-      response = list_ab_tests_with_http_info(offset, limit, index_prefix, index_suffix, direction, request_options)
+      response = list_ab_tests_with_http_info(
+        offset,
+        limit,
+        index_prefix,
+        index_suffix,
+        direction,
+        methods,
+        request_options
+      )
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "AbtestingV3::ListABTestsResponse")
     end
 
+    # Captures the settings of the given variant and of the control, then stops the A/B test.  The captured settings can later be applied to the control index with the `applyVariantSettings` operation, and read back with the `getABTestSettings` operation.  The A/B test must have reached 80% of its planned duration. Earlier requests return `400`.  Settings can only be captured once per A/B test. A second request returns `409`.  `synonyms` and `enableRules` are not captured, so applying the captured settings never changes them on the control index.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    #   - editSettings
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param variant_id [Integer] One-based index of the A/B test variant. The control is variant 1. (required)
+    # @param save_settings_request [SaveSettingsRequest]  (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def save_variant_settings_with_http_info(id, variant_id, save_settings_request, request_options = {})
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        raise ArgumentError, "Parameter `id` is required when calling `save_variant_settings`."
+      end
+      # verify the required parameter 'variant_id' is set
+      if @api_client.config.client_side_validation && variant_id.nil?
+        raise ArgumentError, "Parameter `variant_id` is required when calling `save_variant_settings`."
+      end
+      # verify the required parameter 'save_settings_request' is set
+      if @api_client.config.client_side_validation && save_settings_request.nil?
+        raise ArgumentError, "Parameter `save_settings_request` is required when calling `save_variant_settings`."
+      end
+
+      path = "/3/abtests/{id}/settings/{variantId}".sub("{" + "id" + "}", Transport.encode_uri(id.to_s)).sub(
+        "{" + "variantId" + "}",
+        Transport.encode_uri(variant_id.to_s)
+      )
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(save_settings_request)
+
+      new_options = request_options.merge(
+        :operation => :"AbtestingV3Client.save_variant_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Captures the settings of the given variant and of the control, then stops the A/B test.  The captured settings can later be applied to the control index with the `applyVariantSettings` operation, and read back with the `getABTestSettings` operation.  The A/B test must have reached 80% of its planned duration. Earlier requests return `400`.  Settings can only be captured once per A/B test. A second request returns `409`.  `synonyms` and `enableRules` are not captured, so applying the captured settings never changes them on the control index.
+    #
+    # Required API Key ACLs:
+    #   - analytics
+    #   - editSettings
+    # @param id [Integer] Unique A/B test identifier. (required)
+    # @param variant_id [Integer] One-based index of the A/B test variant. The control is variant 1. (required)
+    # @param save_settings_request [SaveSettingsRequest]  (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 [nil]
+    def save_variant_settings(id, variant_id, save_settings_request, request_options = {})
+      save_variant_settings_with_http_info(id, variant_id, save_settings_request, request_options)
+      nil
+    end
+
     # Stops an A/B test by its ID.  You can't restart stopped A/B tests.
     #
     # Required API Key ACLs: