@algolia/abtesting 1.25.0 → 1.26.0

package/README.md

@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
 ### With a package manager
 
 ```bash
-yarn add @algolia/abtesting@1.25.0
+yarn add @algolia/abtesting@1.26.0
 # or
-npm install @algolia/abtesting@1.25.0
+npm install @algolia/abtesting@1.26.0
 # or
-pnpm add @algolia/abtesting@1.25.0
+pnpm add @algolia/abtesting@1.26.0
 ```
 
 ### Without a package manager
@@ -52,7 +52,7 @@ pnpm add @algolia/abtesting@1.25.0
 Add the following JavaScript snippet to the <head> of your website:
 
 ```html
-<script src="https://cdn.jsdelivr.net/npm/@algolia/abtesting@1.25.0/dist/builds/browser.umd.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@algolia/abtesting@1.26.0/dist/builds/browser.umd.js"></script>
 ```
 
 ### Usage

package/dist/browser.d.ts

@@ -1,6 +1,11 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, AlgoliaHttpResponse, ClientOptions } from '@algolia/client-common';
 
+/**
+ * A/B test statistical analysis method. When omitted, new A/B tests use `bayesian`. They use `frequentist` instead only if no primary metric that supports Bayesian analysis is available. The selected method is saved in the A/B test configuration. Older A/B tests, created before methods were saved, may have no method in their configuration. These tests use `frequentist`.
+ */
+type AnalysisMethod = 'bayesian' | 'frequentist';
+
 /**
  * Multiple-testing correction method applied when evaluating metric significance.
  */
@@ -34,7 +39,7 @@ type MetricsFilter = {
 type EffectMetric = 'addToCartRate' | 'clickThroughRate' | 'conversionRate' | 'purchaseRate' | 'noResultsRate';
 
 /**
- * Configuration for the smallest difference between test variants you want to detect.
+ * Configuration for the smallest difference between test variants you want to detect, used to estimate the required sample size.
  */
 type MinimumDetectableEffect = {
     /**
@@ -44,6 +49,11 @@ type MinimumDetectableEffect = {
     metric: EffectMetric;
 };
 
+/**
+ * Primary metric for Bayesian analysis. Required when `method` is `bayesian`. When `method` is omitted and the test defaults to `bayesian`, the default primary metric is `conversion_rate`, or the first metric in `metrics` that supports Bayesian analysis if `metrics` doesn\'t include conversion rate. If the request includes a non-empty `metrics` list, this metric must be in that list. Revenue per search requires access to revenue analytics.
+ */
+type PrimaryMetric = 'add_to_cart_rate' | 'click_through_rate' | 'conversion_rate' | 'purchase_rate' | 'revenue_per_search';
+
 /**
  * A/B test configuration.
  */
@@ -54,6 +64,8 @@ type ABTestConfiguration = {
      */
     filters?: Array<MetricsFilter> | undefined;
     errorCorrection?: ErrorCorrectionType | undefined;
+    method?: AnalysisMethod | undefined;
+    primaryMetric?: PrimaryMetric | undefined;
 };
 
 /**
@@ -75,12 +87,43 @@ type Decision = {
  */
 type Status = 'active' | 'stopped' | 'expired' | 'failed';
 
+/**
+ * Whether this variant metric\'s result is trustworthy yet. This doesn\'t mean the A/B test has ended, and it doesn\'t declare a winning variant.  - `enough`. Enough evidence has accumulated to trust this metric\'s result for this variant. - `not_enough`. Evidence was computed but hasn\'t reached the threshold yet. - `collecting`. Evidence is still accumulating, so it\'s too early to report a verdict. - `no_data`. No usable data for this variant metric, and none is expected for it. - `unavailable`. Evidence can\'t be computed for this variant metric\'s comparison.
+ */
+type EvidenceStatus = 'enough' | 'not_enough' | 'collecting' | 'no_data' | 'unavailable';
+
+/**
+ * Evidence status for this variant metric\'s comparison with the control. Only present when the API has an evidence status for the comparison. Omitted when evidence isn\'t applicable or no status exists.
+ */
+type MetricEvidence = {
+    status: EvidenceStatus;
+};
+
+/**
+ * Bayesian inference results for this variant metric. Omitted when Bayesian results aren\'t requested or no Bayesian result is available for this metric. Individual inference fields can be omitted when their values aren\'t available.
+ */
+type BayesianMetricResult = {
+    /**
+     * Probability that this variant is better than the control.
+     */
+    probabilityToBeBetter?: number | undefined;
+    /**
+     * Lower bound of the 95% credible interval for the relative effect (variant/control minus 1).
+     */
+    relativeEffectCILow?: number | undefined;
+    /**
+     * Upper bound of the 95% credible interval for the relative effect (variant/control minus 1).
+     */
+    relativeEffectCIHigh?: number | undefined;
+    evidence?: MetricEvidence | undefined;
+};
+
 /**
  * Metric specific metadata.
  */
 type MetricMetadata = {
     /**
-     * Only present in case the metric is \'revenue\'. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
+     * Only present for `revenue` metrics. It is the amount exceeding the 95th percentile of global revenue transactions involved in the AB Test. This amount is not considered when calculating statistical significance. It is tied to a per revenue-currency pair contrary to other global filter effects (such as outliers and empty search count).
      */
     winsorizedValue?: number | undefined;
     /**
@@ -90,11 +133,17 @@ type MetricMetadata = {
 };
 
 type MetricResult = {
+    /**
+     * Metric name. Revenue per search results use `revenue_per_search`.
+     */
     name: string;
     /**
      * Date and time when the metric was last updated, in RFC 3339 format.
      */
     updatedAt: string;
+    /**
+     * Metric value. For `revenue_per_search`, this is the winsorized mean revenue per search in the specified currency.
+     */
     value: number;
     /**
      * The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).
@@ -105,11 +154,11 @@ type MetricResult = {
      */
     valueCILow?: number | undefined;
     /**
-     * PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.
+     * P-value for this variant compared to the control. Omitted when no p-value is available for this metric.
      */
-    pValue: number;
+    pValue?: number | undefined;
     /**
-     * Dimension defined during test creation.
+     * Dimension defined during test creation. For revenue metrics, including `revenue_per_search`, this is the currency.
      */
     dimension?: string | undefined;
     metadata?: MetricMetadata | undefined;
@@ -121,6 +170,7 @@ type MetricResult = {
      * Whether the pValue is significant or not based on the critical value and the error correction algorithm used.
      */
     significant?: boolean | undefined;
+    bayesian?: BayesianMetricResult | undefined;
 };
 
 /**
@@ -219,6 +269,10 @@ type ABTest = {
      * A/B test name.
      */
     name: string;
+    /**
+     * Expected outcome of the A/B test.
+     */
+    hypothesis: string;
     status: Status;
     /**
      * A/B test variants.  The first variant is your _control_ index, typically your production index. All of the additional variants are indexes with changed settings that you want to test against the control.
@@ -243,6 +297,72 @@ type ABTestResponse = {
     taskID: number;
 };
 
+/**
+ * Feature-specific settings captured for a variant.
+ */
+type FeatureSettings = {
+    /**
+     * Name of the feature the settings belong to.
+     */
+    name: string;
+    /**
+     * Feature settings payload. The shape depends on the feature.
+     */
+    settings: any | null;
+};
+
+/**
+ * Settings captured for one A/B test variant.
+ */
+type VariantSettings = {
+    /**
+     * One-based index of the variant within the A/B test. The control is variant 1.
+     */
+    variantId: number;
+    /**
+     * Whether the variant\'s settings have been applied to the control index.
+     */
+    applied: boolean;
+    /**
+     * Feature-specific settings captured for the variant.
+     */
+    featuresSettings?: Array<FeatureSettings> | undefined;
+    /**
+     * Index settings captured for the variant.
+     */
+    indexSettings?: Record<string, unknown> | undefined;
+    /**
+     * Date and time when the variant\'s settings were applied to the control index, in RFC 3339 format.
+     */
+    applyTimestamp?: string | undefined;
+    /**
+     * Date and time when the applied settings were reverted on the control index, in RFC 3339 format.
+     */
+    revertTimestamp?: string | undefined;
+    /**
+     * Date and time when the variant\'s settings were captured, in RFC 3339 format.
+     */
+    declaredTimestamp?: string | undefined;
+    /**
+     * Date and time when the captured settings expired, in RFC 3339 format.
+     */
+    expiredTimestamp?: string | undefined;
+};
+
+/**
+ * Captured settings of an A/B test.
+ */
+type ABTestSettingsResponse = {
+    /**
+     * Captured settings for each variant of the A/B test.
+     */
+    abtestSettings: Array<VariantSettings>;
+    /**
+     * Whether another active A/B test is using the control index.
+     */
+    controlIndexInUse: boolean;
+};
+
 type AbTestsVariant = {
     /**
      * Index name of the A/B test variant (case-sensitive).
@@ -288,6 +408,10 @@ type AddABTestsRequest = {
      * A/B test name.
      */
     name: string;
+    /**
+     * Expected outcome of the A/B test.
+     */
+    hypothesis?: string | undefined;
     /**
      * A/B test variants.
      */
@@ -379,8 +503,31 @@ type Timeseries = {
  */
 type Direction = 'asc' | 'desc';
 
-type MetricName = 'search_count' | 'tracked_search_count' | 'user_count' | 'tracked_user_count' | 'no_result_count' | 'add_to_cart_count' | 'purchase_count' | 'clicked_search_count' | 'converted_search_count' | 'click_through_rate' | 'conversion_rate' | 'add_to_cart_rate' | 'purchase_rate' | 'average_click_position' | 'revenue';
+type MetricName = 'search_count' | 'tracked_search_count' | 'user_count' | 'tracked_user_count' | 'no_result_count' | 'tracked_no_result_count' | 'add_to_cart_count' | 'purchase_count' | 'clicked_search_count' | 'converted_search_count' | 'click_through_rate' | 'conversion_rate' | 'add_to_cart_rate' | 'purchase_rate' | 'average_click_position' | 'revenue' | 'revenue_per_search' | 'average_order_value';
 
+/**
+ * Options for capturing a variant\'s settings.
+ */
+type SaveSettingsRequest = {
+    /**
+     * Whether to also capture the variant\'s index settings and feature-specific settings. This must be true for A/B tests whose variants use different indices so that the captured variant settings can later be applied.
+     */
+    saveFeaturesSettings?: boolean | undefined;
+};
+
+/**
+ * Properties for the `applyVariantSettings` method.
+ */
+type ApplyVariantSettingsProps = {
+    /**
+     * Unique A/B test identifier.
+     */
+    id: number;
+    /**
+     * One-based index of the A/B test variant. The control is variant 1.
+     */
+    variantId: number;
+};
 /**
  * Properties for the `customDelete` method.
  */
@@ -466,6 +613,19 @@ type GetABTestProps = {
      * Unique A/B test identifier.
      */
     id: number;
+    /**
+     * 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.
+     */
+    methods?: Array<AnalysisMethod> | undefined;
+};
+/**
+ * Properties for the `getABTestSettings` method.
+ */
+type GetABTestSettingsProps = {
+    /**
+     * Unique A/B test identifier.
+     */
+    id: number;
 };
 /**
  * Properties for the `getTimeseries` method.
@@ -487,6 +647,10 @@ type GetTimeseriesProps = {
      * List of metrics to retrieve. If not specified, all metrics are returned.
      */
     metric?: Array<MetricName> | undefined;
+    /**
+     * 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.
+     */
+    methods?: Array<AnalysisMethod> | undefined;
 };
 /**
  * Properties for the `listABTests` method.
@@ -512,6 +676,24 @@ type ListABTestsProps = {
      * 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.
      */
     direction?: Direction | undefined;
+    /**
+     * 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.
+     */
+    methods?: Array<AnalysisMethod> | undefined;
+};
+/**
+ * Properties for the `saveVariantSettings` method.
+ */
+type SaveVariantSettingsProps = {
+    /**
+     * Unique A/B test identifier.
+     */
+    id: number;
+    /**
+     * One-based index of the A/B test variant. The control is variant 1.
+     */
+    variantId: number;
+    saveSettingsRequest: SaveSettingsRequest;
 };
 /**
  * Properties for the `stopABTest` method.
@@ -523,7 +705,7 @@ type StopABTestProps = {
     id: number;
 };
 
-declare const apiClientVersion = "1.25.0";
+declare const apiClientVersion = "1.26.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -584,6 +766,33 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      * @see addABTests for the plain version.
      */
     addABTestsWithHTTPInfo(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
+    /**
+     * 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 applyVariantSettings - The applyVariantSettings object.
+     * @param applyVariantSettings.id - Unique A/B test identifier.
+     * @param applyVariantSettings.variantId - One-based index of the A/B test variant. The control is variant 1.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    applyVariantSettings({ id, variantId }: ApplyVariantSettingsProps, requestOptions?: RequestOptions): Promise<void>;
+    /**
+     * 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`.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - analytics
+     *  - editSettings
+     * @param applyVariantSettings - The applyVariantSettings object.
+     * @param applyVariantSettings.id - Unique A/B test identifier.
+     * @param applyVariantSettings.variantId - One-based index of the A/B test variant. The control is variant 1.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see applyVariantSettings for the plain version.
+     */
+    applyVariantSettingsWithHTTPInfo({ id, variantId }: ApplyVariantSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<void>>;
     /**
      * This method lets you send requests to the Algolia REST API.
      * @param customDelete - The customDelete object.
@@ -715,9 +924,10 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      *  - analytics
      * @param getABTest - The getABTest object.
      * @param getABTest.id - Unique A/B test identifier.
+     * @param getABTest.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
+    getABTest({ id, methods }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
     /**
      * Retrieves the details for an A/B test by its ID.
      *
@@ -727,10 +937,34 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      *  - analytics
      * @param getABTest - The getABTest object.
      * @param getABTest.id - Unique A/B test identifier.
+     * @param getABTest.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @see getABTest for the plain version.
      */
-    getABTestWithHTTPInfo({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTest>>;
+    getABTestWithHTTPInfo({ id, methods }: GetABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTest>>;
+    /**
+     * 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 getABTestSettings - The getABTestSettings object.
+     * @param getABTestSettings.id - Unique A/B test identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getABTestSettings({ id }: GetABTestSettingsProps, requestOptions?: RequestOptions): Promise<ABTestSettingsResponse>;
+    /**
+     * 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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - analytics
+     * @param getABTestSettings - The getABTestSettings object.
+     * @param getABTestSettings.id - Unique A/B test identifier.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see getABTestSettings for the plain version.
+     */
+    getABTestSettingsWithHTTPInfo({ id }: GetABTestSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestSettingsResponse>>;
     /**
      * Retrieves timeseries for an A/B test by its ID.
      *
@@ -741,9 +975,10 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      * @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
+     * @param getTimeseries.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTimeseries({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<Timeseries>;
+    getTimeseries({ id, startDate, endDate, metric, methods }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<Timeseries>;
     /**
      * Retrieves timeseries for an A/B test by its ID.
      *
@@ -756,10 +991,11 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      * @param getTimeseries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
      * @param getTimeseries.metric - List of metrics to retrieve. If not specified, all metrics are returned.
+     * @param getTimeseries.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @see getTimeseries for the plain version.
      */
-    getTimeseriesWithHTTPInfo({ id, startDate, endDate, metric }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Timeseries>>;
+    getTimeseriesWithHTTPInfo({ id, startDate, endDate, metric, methods }: GetTimeseriesProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<Timeseries>>;
     /**
      * Lists all A/B tests you configured for this application.
      *
@@ -771,9 +1007,10 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
      * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
      * @param listABTests.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 listABTests.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listABTests({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
+    listABTests({ offset, limit, indexPrefix, indexSuffix, direction, methods }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
     /**
      * Lists all A/B tests you configured for this application.
      *
@@ -787,10 +1024,40 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
      * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
      * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
      * @param listABTests.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 listABTests.methods - 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 requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      * @see listABTests for the plain version.
      */
-    listABTestsWithHTTPInfo({ offset, limit, indexPrefix, indexSuffix, direction }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListABTestsResponse>>;
+    listABTestsWithHTTPInfo({ offset, limit, indexPrefix, indexSuffix, direction, methods }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<AlgoliaHttpResponse<ListABTestsResponse>>;
+    /**
+     * 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 saveVariantSettings - The saveVariantSettings object.
+     * @param saveVariantSettings.id - Unique A/B test identifier.
+     * @param saveVariantSettings.variantId - One-based index of the A/B test variant. The control is variant 1.
+     * @param saveVariantSettings.saveSettingsRequest - The saveSettingsRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    saveVariantSettings({ id, variantId, saveSettingsRequest }: SaveVariantSettingsProps, requestOptions?: RequestOptions): Promise<void>;
+    /**
+     * 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.
+     *
+     * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
+     *
+     * Required API Key ACLs:
+     *  - analytics
+     *  - editSettings
+     * @param saveVariantSettings - The saveVariantSettings object.
+     * @param saveVariantSettings.id - Unique A/B test identifier.
+     * @param saveVariantSettings.variantId - One-based index of the A/B test variant. The control is variant 1.
+     * @param saveVariantSettings.saveSettingsRequest - The saveSettingsRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     * @see saveVariantSettings for the plain version.
+     */
+    saveVariantSettingsWithHTTPInfo({ id, variantId, saveSettingsRequest }: SaveVariantSettingsProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<void>>;
     /**
      * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
      *
@@ -816,6 +1083,17 @@ declare function createAbtestingV3Client({ appId: appIdOption, apiKey: apiKeyOpt
     stopABTestWithHTTPInfo({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<AlgoliaHttpResponse<ABTestResponse>>;
 };
 
+type ConflictResponse = {
+    /**
+     * Status code.
+     */
+    status: number;
+    /**
+     * Response message.
+     */
+    message: string;
+};
+
 /**
  * Error.
  */
@@ -826,4 +1104,4 @@ type ErrorBase = Record<string, any> & {
 declare function abtestingV3Client(appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined): AbtestingV3Client;
 type AbtestingV3Client = ReturnType<typeof createAbtestingV3Client>;
 
-export { type ABTest, type ABTestConfiguration, type ABTestResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type Decision, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type FilterEffects, type GetABTestProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type Region, type RegionOptions, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, abtestingV3Client, apiClientVersion };
+export { type ABTest, type ABTestConfiguration, type ABTestResponse, type ABTestSettingsResponse, type AbTestsVariant, type AbTestsVariantSearchParams, type AbtestingV3Client, type AddABTestsRequest, type AddABTestsVariant, type AnalysisMethod, type ApplyVariantSettingsProps, type BayesianMetricResult, type ConflictResponse, type CreateMetric, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type CustomSearchParams, type Decision, type DeleteABTestProps, type Direction, type EffectMetric, type EmptySearchFilter, type ErrorBase, type ErrorCorrectionType, type EstimateABTestRequest, type EstimateABTestResponse, type EstimateConfiguration, type EvidenceStatus, type FeatureSettings, type FilterEffects, type GetABTestProps, type GetABTestSettingsProps, type GetTimeseriesProps, type ListABTestsProps, type ListABTestsResponse, type MetricDate, type MetricEvidence, type MetricMetadata, type MetricName, type MetricResult, type MetricsFilter, type MinimumDetectableEffect, type OutliersFilter, type PrimaryMetric, type Region, type RegionOptions, type SaveSettingsRequest, type SaveVariantSettingsProps, type Status, type StopABTestProps, type Timeseries, type TimeseriesVariant, type Variant, type VariantMetadata, type VariantSettings, abtestingV3Client, apiClientVersion };