@algolia/client-abtesting 5.0.0-alpha.73 → 5.0.0-alpha.76

package/dist/client-abtesting.cjs.js

@@ -1,12 +1,10 @@
 'use strict';
 
-Object.defineProperty(exports, '__esModule', { value: true });
-
 var clientCommon = require('@algolia/client-common');
 var requesterNodeHttp = require('@algolia/requester-node-http');
 
 // 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.
-const apiClientVersion = '5.0.0-alpha.73';
+const apiClientVersion = '5.0.0-alpha.76';
 const REGIONS = ['de', 'us'];
 function getDefaultHosts(region) {
     const url = !region
@@ -66,9 +64,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+         * Creates an A/B test.
          *
-         * @summary Create a test.
+         * @summary Create an A/B test.
          * @param addABTestsRequest - The addABTestsRequest object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -79,8 +77,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!addABTestsRequest.name) {
                 throw new Error('Parameter `addABTestsRequest.name` is required when calling `addABTests`.');
             }
-            if (!addABTestsRequest.variant) {
-                throw new Error('Parameter `addABTestsRequest.variant` is required when calling `addABTests`.');
+            if (!addABTestsRequest.variants) {
+                throw new Error('Parameter `addABTestsRequest.variants` is required when calling `addABTests`.');
             }
             if (!addABTestsRequest.endAt) {
                 throw new Error('Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.');
@@ -102,8 +100,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
+         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param del.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         del({ path, parameters }, requestOptions) {
@@ -122,11 +120,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a test.
+         * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Delete a test.
+         * @summary Delete an A/B test.
          * @param deleteABTest - The deleteABTest object.
-         * @param deleteABTest.id - The A/B test ID.
+         * @param deleteABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteABTest({ id }, requestOptions) {
@@ -149,8 +147,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
+         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param get.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         get({ path, parameters }, requestOptions) {
@@ -169,11 +167,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns metadata and metrics for an A/B test.
+         * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Get a test.
+         * @summary Get A/B test details.
          * @param getABTest - The getABTest object.
-         * @param getABTest.id - The A/B test ID.
+         * @param getABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getABTest({ id }, requestOptions) {
@@ -192,14 +190,14 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+         * List all A/B tests.
          *
-         * @summary List all tests.
+         * @summary List all A/B tests.
          * @param listABTests - The listABTests object.
          * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param listABTests.limit - Number of records to return. Limit is the size of the page.
-         * @param listABTests.indexPrefix - Filters the returned ab tests by any indices starting with the provided prefix that are assigned to either variant of an ab test.
-         * @param listABTests.indexSuffix - Filters the returned ab tests by any indices ending with the provided suffix that are assigned to either variant of an ab test.
+         * @param listABTests.limit - Number of records to return (page size).
+         * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
+         * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
@@ -231,9 +229,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param post - The post object.
-         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param post.parameters - Query parameters to be applied to the current query.
-         * @param post.body - The parameters to send with the custom request.
+         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param post.parameters - Query parameters to apply to the current query.
+         * @param post.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         post({ path, parameters, body }, requestOptions) {
@@ -257,9 +255,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param put - The put object.
-         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param put.parameters - Query parameters to be applied to the current query.
-         * @param put.body - The parameters to send with the custom request.
+         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param put.parameters - Query parameters to apply to the current query.
+         * @param put.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         put({ path, parameters, body }, requestOptions) {
@@ -279,11 +277,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+         * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Stop a test.
+         * @summary Stop an A/B test.
          * @param stopABTest - The stopABTest object.
-         * @param stopABTest.id - The A/B test ID.
+         * @param stopABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         stopABTest({ id }, requestOptions) {

package/dist/client-abtesting.esm.browser.js

@@ -662,7 +662,7 @@ function createXhrRequester() {
 }
 
 // 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.
-const apiClientVersion = '5.0.0-alpha.73';
+const apiClientVersion = '5.0.0-alpha.76';
 const REGIONS = ['de', 'us'];
 function getDefaultHosts(region) {
     const url = !region
@@ -722,9 +722,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+         * Creates an A/B test.
          *
-         * @summary Create a test.
+         * @summary Create an A/B test.
          * @param addABTestsRequest - The addABTestsRequest object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -735,8 +735,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!addABTestsRequest.name) {
                 throw new Error('Parameter `addABTestsRequest.name` is required when calling `addABTests`.');
             }
-            if (!addABTestsRequest.variant) {
-                throw new Error('Parameter `addABTestsRequest.variant` is required when calling `addABTests`.');
+            if (!addABTestsRequest.variants) {
+                throw new Error('Parameter `addABTestsRequest.variants` is required when calling `addABTests`.');
             }
             if (!addABTestsRequest.endAt) {
                 throw new Error('Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.');
@@ -758,8 +758,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
+         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param del.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         del({ path, parameters }, requestOptions) {
@@ -778,11 +778,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a test.
+         * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Delete a test.
+         * @summary Delete an A/B test.
          * @param deleteABTest - The deleteABTest object.
-         * @param deleteABTest.id - The A/B test ID.
+         * @param deleteABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteABTest({ id }, requestOptions) {
@@ -805,8 +805,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
+         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param get.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         get({ path, parameters }, requestOptions) {
@@ -825,11 +825,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns metadata and metrics for an A/B test.
+         * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Get a test.
+         * @summary Get A/B test details.
          * @param getABTest - The getABTest object.
-         * @param getABTest.id - The A/B test ID.
+         * @param getABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getABTest({ id }, requestOptions) {
@@ -848,14 +848,14 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+         * List all A/B tests.
          *
-         * @summary List all tests.
+         * @summary List all A/B tests.
          * @param listABTests - The listABTests object.
          * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param listABTests.limit - Number of records to return. Limit is the size of the page.
-         * @param listABTests.indexPrefix - Filters the returned ab tests by any indices starting with the provided prefix that are assigned to either variant of an ab test.
-         * @param listABTests.indexSuffix - Filters the returned ab tests by any indices ending with the provided suffix that are assigned to either variant of an ab test.
+         * @param listABTests.limit - Number of records to return (page size).
+         * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
+         * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
@@ -887,9 +887,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param post - The post object.
-         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param post.parameters - Query parameters to be applied to the current query.
-         * @param post.body - The parameters to send with the custom request.
+         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param post.parameters - Query parameters to apply to the current query.
+         * @param post.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         post({ path, parameters, body }, requestOptions) {
@@ -913,9 +913,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param put - The put object.
-         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param put.parameters - Query parameters to be applied to the current query.
-         * @param put.body - The parameters to send with the custom request.
+         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param put.parameters - Query parameters to apply to the current query.
+         * @param put.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         put({ path, parameters, body }, requestOptions) {
@@ -935,11 +935,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+         * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Stop a test.
+         * @summary Stop an A/B test.
          * @param stopABTest - The stopABTest object.
-         * @param stopABTest.id - The A/B test ID.
+         * @param stopABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         stopABTest({ id }, requestOptions) {

package/dist/client-abtesting.esm.node.js

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // 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.
-const apiClientVersion = '5.0.0-alpha.73';
+const apiClientVersion = '5.0.0-alpha.76';
 const REGIONS = ['de', 'us'];
 function getDefaultHosts(region) {
     const url = !region
@@ -62,9 +62,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             transporter.algoliaAgent.add({ segment, version });
         },
         /**
-         * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+         * Creates an A/B test.
          *
-         * @summary Create a test.
+         * @summary Create an A/B test.
          * @param addABTestsRequest - The addABTestsRequest object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -75,8 +75,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!addABTestsRequest.name) {
                 throw new Error('Parameter `addABTestsRequest.name` is required when calling `addABTests`.');
             }
-            if (!addABTestsRequest.variant) {
-                throw new Error('Parameter `addABTestsRequest.variant` is required when calling `addABTests`.');
+            if (!addABTestsRequest.variants) {
+                throw new Error('Parameter `addABTestsRequest.variants` is required when calling `addABTests`.');
             }
             if (!addABTestsRequest.endAt) {
                 throw new Error('Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.');
@@ -98,8 +98,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
+         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param del.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         del({ path, parameters }, requestOptions) {
@@ -118,11 +118,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a test.
+         * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Delete a test.
+         * @summary Delete an A/B test.
          * @param deleteABTest - The deleteABTest object.
-         * @param deleteABTest.id - The A/B test ID.
+         * @param deleteABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         deleteABTest({ id }, requestOptions) {
@@ -145,8 +145,8 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
+         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param get.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         get({ path, parameters }, requestOptions) {
@@ -165,11 +165,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns metadata and metrics for an A/B test.
+         * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Get a test.
+         * @summary Get A/B test details.
          * @param getABTest - The getABTest object.
-         * @param getABTest.id - The A/B test ID.
+         * @param getABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getABTest({ id }, requestOptions) {
@@ -188,14 +188,14 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+         * List all A/B tests.
          *
-         * @summary List all tests.
+         * @summary List all A/B tests.
          * @param listABTests - The listABTests object.
          * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param listABTests.limit - Number of records to return. Limit is the size of the page.
-         * @param listABTests.indexPrefix - Filters the returned ab tests by any indices starting with the provided prefix that are assigned to either variant of an ab test.
-         * @param listABTests.indexSuffix - Filters the returned ab tests by any indices ending with the provided suffix that are assigned to either variant of an ab test.
+         * @param listABTests.limit - Number of records to return (page size).
+         * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
+         * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         listABTests({ offset, limit, indexPrefix, indexSuffix } = {}, requestOptions = undefined) {
@@ -227,9 +227,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param post - The post object.
-         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param post.parameters - Query parameters to be applied to the current query.
-         * @param post.body - The parameters to send with the custom request.
+         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param post.parameters - Query parameters to apply to the current query.
+         * @param post.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         post({ path, parameters, body }, requestOptions) {
@@ -253,9 +253,9 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
          *
          * @summary Send requests to the Algolia REST API.
          * @param put - The put object.
-         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param put.parameters - Query parameters to be applied to the current query.
-         * @param put.body - The parameters to send with the custom request.
+         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param put.parameters - Query parameters to apply to the current query.
+         * @param put.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         put({ path, parameters, body }, requestOptions) {
@@ -275,11 +275,11 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+         * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
          *
-         * @summary Stop a test.
+         * @summary Stop an A/B test.
          * @param stopABTest - The stopABTest object.
-         * @param stopABTest.id - The A/B test ID.
+         * @param stopABTest.id - Unique A/B test ID.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         stopABTest({ id }, requestOptions) {

package/dist/client-abtesting.umd.js

@@ -1,2 +1,2 @@
-/*! client-abtesting.umd.js | 5.0.0-alpha.73 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
-!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-abtesting"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}return{get:(e,t,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{const r=JSON.stringify(e),s=a()[r];return Promise.all([s||t(),void 0!==s])})).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]=t,s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),o(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),o(this,"stackTrace",void 0),this.stackTrace=t}}class u extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",e,"RetryError")}}class l extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),o(this,"status",void 0),this.status=t}}class d extends i{constructor(e,t){super(e,"DeserializationError"),o(this,"response",void 0),this.response=t}}class h extends l{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),o(this,"error",void 0),this.error=r}}function m(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r])}`)).join("&")}(r);let a=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return s.length&&(a+=`?${s}`),a}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:f}){async function g(c,f,g=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,f),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,f.headers),q="GET"===c.method?{...c.data,...f.data}:{},v={...s,...c.queryParameters,...q};if(a.value&&(v["x-algolia-agent"]=a.value),f&&f.queryParameters)for(const e of Object.keys(f.queryParameters))f.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(f.queryParameters[e])?v[e]=f.queryParameters[e].toString():v[e]=f.queryParameters[e];let T=0;const b=async(e,r)=>{const s=e.pop();if(void 0===s)throw new u(function(e){return e.map((e=>p(e)))}(y));let a=f.timeout;void 0===a&&(a=g?o.read:o.write);const q={data:P,headers:w,method:c.method,url:m(s,c.path,v),connectTimeout:r(T,o.connect),responseTimeout:r(T,a)},O=t=>{const r={request:q,response:t,host:s,triesLeft:e.length};return y.push(r),r},A=await i.send(q);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&0==~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(A)){const a=O(A);return A.isTimedOut&&T++,console.log("Retryable failure",p(a)),await t.set(s,n(s,A.isTimedOut?"timed out":"down")),b(e,r)}if(function({status:e}){return 2==~~(e/100)}(A))return function(e){try{return JSON.parse(e.content)}catch(t){throw new d(t.message,e)}}(A);throw O(A),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new h(s.message,t,s.error,r):new l(s.message,t,r)}catch(e){}return new l(e,t,r)}(A,y)},O=e.filter((e=>"readWrite"===e.accept||(g?"read"===e.accept:"write"===e.accept))),A=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return b([...A.hosts].reverse(),A.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return g(e,t,a);const n=()=>g(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return f.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>f.set(o,e)})},requestsCache:c,responsesCache:f}}function g({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const y="5.0.0-alpha.73",P=["de","us"];e.abtestingClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(n&&("string"!=typeof n||!P.includes(n)))throw new Error(`\`region\` must be one of the following: ${P.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(c=a,[{url:c?"analytics.{region}.algolia.com".replace("{region}",c):"analytics.algolia.com",accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:g({algoliaAgents:s,client:"Abtesting",version:y}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},addABTests(e,t){if(!e)throw new Error("Parameter `addABTestsRequest` is required when calling `addABTests`.");if(!e.name)throw new Error("Parameter `addABTestsRequest.name` is required when calling `addABTests`.");if(!e.variant)throw new Error("Parameter `addABTestsRequest.variant` is required when calling `addABTests`.");if(!e.endAt)throw new Error("Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.");const r={method:"POST",path:"/2/abtests",queryParameters:{},headers:{},data:e};return i.request(r,t)},del({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `del`.");const s={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},deleteABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `deleteABTest`.");const r={method:"DELETE",path:"/2/abtests/{id}".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},get({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `get`.");const s={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},getABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `getABTest`.");const r={method:"GET",path:"/2/abtests/{id}".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},listABTests({offset:e,limit:t,indexPrefix:r,indexSuffix:s}={},a=undefined){const n={};void 0!==e&&(n.offset=e.toString()),void 0!==t&&(n.limit=t.toString()),void 0!==r&&(n.indexPrefix=r.toString()),void 0!==s&&(n.indexSuffix=s.toString());const o={method:"GET",path:"/2/abtests",queryParameters:n,headers:{}};return i.request(o,a)},post({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `post`.");const a={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},put({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `put`.");const a={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},stopABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `stopABTest`.");const r={method:"POST",path:"/2/abtests/{id}/stop".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${y}-${e}`}),s()]}),...o})},e.apiClientVersion=y}));
+/*! client-abtesting.umd.js | 5.0.0-alpha.76 | © Algolia, inc. | https://github.com/algolia/algoliasearch-client-javascript */
+!function(e,t){"object"==typeof exports&&"undefined"!=typeof module?t(exports):"function"==typeof define&&define.amd?define(["exports"],t):t((e="undefined"!=typeof globalThis?globalThis:e||self)["@algolia/client-abtesting"]={})}(this,(function(e){"use strict";function t(e){let t;const r=`algolia-client-js-${e.key}`;function s(){return void 0===t&&(t=e.localStorage||window.localStorage),t}function a(){return JSON.parse(s().getItem(r)||"{}")}return{get:(e,t,r={miss:()=>Promise.resolve()})=>Promise.resolve().then((()=>{const r=JSON.stringify(e),s=a()[r];return Promise.all([s||t(),void 0!==s])})).then((([e,t])=>Promise.all([e,t||r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve().then((()=>{const n=a();return n[JSON.stringify(e)]=t,s().setItem(r,JSON.stringify(n)),t})),delete:e=>Promise.resolve().then((()=>{const t=a();delete t[JSON.stringify(e)],s().setItem(r,JSON.stringify(t))})),clear:()=>Promise.resolve().then((()=>{s().removeItem(r)}))}}function r(e){const t=[...e.caches],s=t.shift();return void 0===s?{get:(e,t,r={miss:()=>Promise.resolve()})=>t().then((e=>Promise.all([e,r.miss(e)]))).then((([e])=>e)),set:(e,t)=>Promise.resolve(t),delete:e=>Promise.resolve(),clear:()=>Promise.resolve()}:{get:(e,a,n={miss:()=>Promise.resolve()})=>s.get(e,a,n).catch((()=>r({caches:t}).get(e,a,n))),set:(e,a)=>s.set(e,a).catch((()=>r({caches:t}).set(e,a))),delete:e=>s.delete(e).catch((()=>r({caches:t}).delete(e))),clear:()=>s.clear().catch((()=>r({caches:t}).clear()))}}function s(e={serializable:!0}){let t={};return{get(r,s,a={miss:()=>Promise.resolve()}){const n=JSON.stringify(r);if(n in t)return Promise.resolve(e.serializable?JSON.parse(t[n]):t[n]);const o=s();return o.then((e=>a.miss(e))).then((()=>o))},set:(r,s)=>(t[JSON.stringify(r)]=e.serializable?JSON.stringify(s):s,Promise.resolve(s)),delete:e=>(delete t[JSON.stringify(e)],Promise.resolve()),clear:()=>(t={},Promise.resolve())}}const a=12e4;function n(e,t="up"){const r=Date.now();return{...e,status:t,lastUpdate:r,isUp:function(){return"up"===t||Date.now()-r>a},isTimedOut:function(){return"timed out"===t&&Date.now()-r<=a}}}function o(e,t,r){return(t=function(e){var t=function(e,t){if("object"!=typeof e||null===e)return e;var r=e[Symbol.toPrimitive];if(void 0!==r){var s=r.call(e,t||"default");if("object"!=typeof s)return s;throw new TypeError("@@toPrimitive must return a primitive value.")}return("string"===t?String:Number)(e)}(e,"string");return"symbol"==typeof t?t:String(t)}(t))in e?Object.defineProperty(e,t,{value:r,enumerable:!0,configurable:!0,writable:!0}):e[t]=r,e}class i extends Error{constructor(e,t){super(e),o(this,"name","AlgoliaError"),t&&(this.name=t)}}class c extends i{constructor(e,t,r){super(e,r),o(this,"stackTrace",void 0),this.stackTrace=t}}class u extends c{constructor(e){super("Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.",e,"RetryError")}}class l extends c{constructor(e,t,r,s="ApiError"){super(e,r,s),o(this,"status",void 0),this.status=t}}class d extends i{constructor(e,t){super(e,"DeserializationError"),o(this,"response",void 0),this.response=t}}class h extends l{constructor(e,t,r,s){super(e,t,s,"DetailedApiError"),o(this,"error",void 0),this.error=r}}function m(e,t,r){const s=function(e){const t=e=>"[object Object]"===Object.prototype.toString.call(e)||"[object Array]"===Object.prototype.toString.call(e);return Object.keys(e).map((r=>`${r}=${encodeURIComponent(t(e[r])?JSON.stringify(e[r]):e[r])}`)).join("&")}(r);let a=`${e.protocol}://${e.url}/${"/"===t.charAt(0)?t.substr(1):t}`;return s.length&&(a+=`?${s}`),a}function p(e){const t=e.request.headers["x-algolia-api-key"]?{"x-algolia-api-key":"*****"}:{};return{...e,request:{...e.request,headers:{...e.request.headers,...t}}}}function f({hosts:e,hostsCache:t,baseHeaders:r,baseQueryParameters:s,algoliaAgent:a,timeouts:o,requester:i,requestsCache:c,responsesCache:f}){async function g(c,f,g=!0){const y=[],P=function(e,t){if("GET"===e.method||void 0===e.data&&void 0===t.data)return;const r=Array.isArray(e.data)?e.data:{...e.data,...t.data};return JSON.stringify(r)}(c,f),w=function(e,t,r){const s={Accept:"application/json",...e,...t,...r},a={};return Object.keys(s).forEach((e=>{const t=s[e];a[e.toLowerCase()]=t})),a}(r,c.headers,f.headers),v="GET"===c.method?{...c.data,...f.data}:{},q={...s,...c.queryParameters,...v};if(a.value&&(q["x-algolia-agent"]=a.value),f&&f.queryParameters)for(const e of Object.keys(f.queryParameters))f.queryParameters[e]&&"[object Object]"!==Object.prototype.toString.call(f.queryParameters[e])?q[e]=f.queryParameters[e].toString():q[e]=f.queryParameters[e];let T=0;const b=async(e,r)=>{const s=e.pop();if(void 0===s)throw new u(function(e){return e.map((e=>p(e)))}(y));let a=f.timeout;void 0===a&&(a=g?o.read:o.write);const v={data:P,headers:w,method:c.method,url:m(s,c.path,q),connectTimeout:r(T,o.connect),responseTimeout:r(T,a)},O=t=>{const r={request:v,response:t,host:s,triesLeft:e.length};return y.push(r),r},A=await i.send(v);if(function({isTimedOut:e,status:t}){return e||function({isTimedOut:e,status:t}){return!e&&0==~~t}({isTimedOut:e,status:t})||2!=~~(t/100)&&4!=~~(t/100)}(A)){const a=O(A);return A.isTimedOut&&T++,console.log("Retryable failure",p(a)),await t.set(s,n(s,A.isTimedOut?"timed out":"down")),b(e,r)}if(function({status:e}){return 2==~~(e/100)}(A))return function(e){try{return JSON.parse(e.content)}catch(t){throw new d(t.message,e)}}(A);throw O(A),function({content:e,status:t},r){try{const s=JSON.parse(e);return"error"in s?new h(s.message,t,s.error,r):new l(s.message,t,r)}catch(e){}return new l(e,t,r)}(A,y)},O=e.filter((e=>"readWrite"===e.accept||(g?"read"===e.accept:"write"===e.accept))),A=await async function(e){const r=await Promise.all(e.map((e=>t.get(e,(()=>Promise.resolve(n(e))))))),s=r.filter((e=>e.isUp())),a=r.filter((e=>e.isTimedOut())),o=[...s,...a];return{hosts:o.length>0?o:e,getTimeout:(e,t)=>(0===a.length&&0===e?1:a.length+3+e)*t}}(O);return b([...A.hosts].reverse(),A.getTimeout)}return{hostsCache:t,requester:i,timeouts:o,algoliaAgent:a,baseHeaders:r,baseQueryParameters:s,hosts:e,request:function(e,t={}){const a=e.useReadTransporter||"GET"===e.method;if(!a)return g(e,t,a);const n=()=>g(e,t);if(!0!==(t.cacheable||e.cacheable))return n();const o={request:e,requestOptions:t,transporter:{queryParameters:s,headers:r}};return f.get(o,(()=>c.get(o,(()=>c.set(o,n()).then((e=>Promise.all([c.delete(o),e])),(e=>Promise.all([c.delete(o),Promise.reject(e)]))).then((([e,t])=>t))))),{miss:e=>f.set(o,e)})},requestsCache:c,responsesCache:f}}function g({algoliaAgents:e,client:t,version:r}){const s=function(e){const t={value:`Algolia for JavaScript (${e})`,add(e){const r=`; ${e.segment}${void 0!==e.version?` (${e.version})`:""}`;return-1===t.value.indexOf(r)&&(t.value=`${t.value}${r}`),t}};return t}(r).add({segment:t,version:r});return e.forEach((e=>s.add(e))),s}const y="5.0.0-alpha.76",P=["de","us"];e.abtestingClient=function(e,a,n,o){if(!e||"string"!=typeof e)throw new Error("`appId` is missing.");if(!a||"string"!=typeof a)throw new Error("`apiKey` is missing.");if(n&&("string"!=typeof n||!P.includes(n)))throw new Error(`\`region\` must be one of the following: ${P.join(", ")}`);return function({appId:e,apiKey:t,authMode:r,algoliaAgents:s,region:a,...n}){const o=function(e,t,r="WithinHeaders"){const s={"x-algolia-api-key":t,"x-algolia-application-id":e};return{headers:()=>"WithinHeaders"===r?s:{},queryParameters:()=>"WithinQueryParameters"===r?s:{}}}(e,t,r),i=f({hosts:(c=a,[{url:c?"analytics.{region}.algolia.com".replace("{region}",c):"analytics.algolia.com",accept:"readWrite",protocol:"https"}]),...n,algoliaAgent:g({algoliaAgents:s,client:"Abtesting",version:y}),baseHeaders:{"content-type":"text/plain",...o.headers(),...n.baseHeaders},baseQueryParameters:{...o.queryParameters(),...n.baseQueryParameters}});var c;return{transporter:i,appId:e,clearCache:()=>Promise.all([i.requestsCache.clear(),i.responsesCache.clear()]).then((()=>{})),get _ua(){return i.algoliaAgent.value},addAlgoliaAgent(e,t){i.algoliaAgent.add({segment:e,version:t})},addABTests(e,t){if(!e)throw new Error("Parameter `addABTestsRequest` is required when calling `addABTests`.");if(!e.name)throw new Error("Parameter `addABTestsRequest.name` is required when calling `addABTests`.");if(!e.variants)throw new Error("Parameter `addABTestsRequest.variants` is required when calling `addABTests`.");if(!e.endAt)throw new Error("Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.");const r={method:"POST",path:"/2/abtests",queryParameters:{},headers:{},data:e};return i.request(r,t)},del({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `del`.");const s={method:"DELETE",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},deleteABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `deleteABTest`.");const r={method:"DELETE",path:"/2/abtests/{id}".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},get({path:e,parameters:t},r){if(!e)throw new Error("Parameter `path` is required when calling `get`.");const s={method:"GET",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{}};return i.request(s,r)},getABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `getABTest`.");const r={method:"GET",path:"/2/abtests/{id}".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)},listABTests({offset:e,limit:t,indexPrefix:r,indexSuffix:s}={},a=void 0){const n={};void 0!==e&&(n.offset=e.toString()),void 0!==t&&(n.limit=t.toString()),void 0!==r&&(n.indexPrefix=r.toString()),void 0!==s&&(n.indexSuffix=s.toString());const o={method:"GET",path:"/2/abtests",queryParameters:n,headers:{}};return i.request(o,a)},post({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `post`.");const a={method:"POST",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},put({path:e,parameters:t,body:r},s){if(!e)throw new Error("Parameter `path` is required when calling `put`.");const a={method:"PUT",path:"/1{path}".replace("{path}",e),queryParameters:t||{},headers:{},data:r||{}};return i.request(a,s)},stopABTest({id:e},t){if(!e)throw new Error("Parameter `id` is required when calling `stopABTest`.");const r={method:"POST",path:"/2/abtests/{id}/stop".replace("{id}",encodeURIComponent(e)),queryParameters:{},headers:{}};return i.request(r,t)}}}({appId:e,apiKey:a,region:n,timeouts:{connect:1e3,read:2e3,write:3e4},requester:{send:function(e){return new Promise((t=>{const r=new XMLHttpRequest;r.open(e.method,e.url,!0),Object.keys(e.headers).forEach((t=>r.setRequestHeader(t,e.headers[t])));const s=(e,s)=>setTimeout((()=>{r.abort(),t({status:0,content:s,isTimedOut:!0})}),e),a=s(e.connectTimeout,"Connection timeout");let n;r.onreadystatechange=()=>{r.readyState>r.OPENED&&void 0===n&&(clearTimeout(a),n=s(e.responseTimeout,"Socket timeout"))},r.onerror=()=>{0===r.status&&(clearTimeout(a),clearTimeout(n),t({content:r.responseText||"Network request failed",status:r.status,isTimedOut:!1}))},r.onload=()=>{clearTimeout(a),clearTimeout(n),t({content:r.responseText,status:r.status,isTimedOut:!1})},r.send(e.data)}))}},algoliaAgents:[{segment:"Browser"}],authMode:"WithinQueryParameters",responsesCache:s(),requestsCache:s({serializable:!1}),hostsCache:r({caches:[t({key:`${y}-${e}`}),s()]}),...o})},e.apiClientVersion=y}));

package/dist/model/aBTest.d.ts

@@ -1,27 +1,23 @@
 import type { Variant } from './variant';
 export type ABTest = {
     /**
-     * The A/B test ID.
+     * Unique A/B test ID.
      */
     abTestID: number;
     /**
-     * A/B test significance based on click data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+     * [A/B test significance](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/in-depth/how-ab-test-scores-are-calculated/#statistical-significance-or-chance) based on click data. A value of 0.95 or over is considered to be _significant_.
      */
     clickSignificance: number;
     /**
-     * A/B test significance based on conversion data. Should be > 0.95 to be considered significant (no matter which variant is winning).
+     * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
-    conversionSignificance: number;
+    conversionSignificance: string;
     /**
-     * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
-     */
-    endAt: string;
-    /**
-     * Update date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+     * Update date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     updatedAt: string;
     /**
-     * Creation date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+     * Creation date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     createdAt: string;
     /**
@@ -29,11 +25,11 @@ export type ABTest = {
      */
     name: string;
     /**
-     * Status of the A/B test.
+     * A/B test status.
      */
     status: string;
     /**
-     * List of A/B test variant.
+     * A/B test variants.
      */
     variants: Variant[];
 };

package/dist/model/aBTest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"aBTest.d.ts","sourceRoot":"","sources":["../../model/aBTest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC"}
+{"version":3,"file":"aBTest.d.ts","sourceRoot":"","sources":["../../model/aBTest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC"}

package/dist/model/aBTestResponse.d.ts

@@ -1,14 +1,14 @@
 export type ABTestResponse = {
     /**
-     * The index performing the A/B test.
+     * A/B test index.
      */
     index: string;
     /**
-     * The A/B test ID.
+     * Unique A/B test ID.
      */
     abTestID: number;
     /**
-     * TaskID of the task to wait for.
+     * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the `task` operation and this `taskID`.
      */
     taskID: number;
 };

package/dist/model/abTestsVariant.d.ts

@@ -1,14 +1,14 @@
 export type AbTestsVariant = {
     /**
-     * The index performing the A/B test.
+     * A/B test index.
      */
     index: string;
     /**
-     * The traffic percentage for the A/B test.
+     * A/B test traffic percentage.
      */
     trafficPercentage: number;
     /**
-     * The A/B test description.
+     * A/B test description.
      */
     description?: string;
 };

package/dist/model/addABTestsRequest.d.ts

@@ -5,11 +5,11 @@ export type AddABTestsRequest = {
      */
     name: string;
     /**
-     * List of 2 variants for the A/B test.
+     * A/B test variants.
      */
-    variant: AddABTestsVariant[];
+    variants: AddABTestsVariant[];
     /**
-     * End date for the A/B test expressed as YYYY-MM-DDThh:mm:ssZ.
+     * End date timestamp in [ISO-8601](https://wikipedia.org/wiki/ISO_8601) format.
      */
     endAt: string;
 };

package/dist/model/addABTestsRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"addABTestsRequest.d.ts","sourceRoot":"","sources":["../../model/addABTestsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,iBAAiB,EAAE,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"addABTestsRequest.d.ts","sourceRoot":"","sources":["../../model/addABTestsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}