algoliasearch 5.0.2 → 5.1.1

package/README.md

@@ -14,7 +14,7 @@
 </p>
 
 <p align="center">
-  <a href="https://www.algolia.com/doc/api-client/getting-started/install/javascript/" target="_blank">Documentation</a>  •
+  <a href="https://www.algolia.com/doc/libraries/javascript/" target="_blank">Documentation</a>  •
   <a href="https://www.algolia.com/doc/guides/building-search-ui/what-is-instantsearch/js/" target="_blank">InstantSearch</a>  •
   <a href="https://discourse.algolia.com" target="_blank">Community Forum</a>  •
   <a href="http://stackoverflow.com/questions/tagged/algolia" target="_blank">Stack Overflow</a>  •
@@ -63,7 +63,7 @@ import { liteClient } from 'algoliasearch/lite';
 const client = liteClient('YOUR_APP_ID', 'YOUR_API_KEY');
 ```
 
-For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/api-client/getting-started/install/javascript/)**.
+For full documentation, visit the **[Algolia JavaScript API Client](https://www.algolia.com/doc/libraries/javascript/)**.
 
 ## ❓ Troubleshooting
 

package/dist/algoliasearch/builds/browser.d.ts

@@ -8,7 +8,7 @@ import type { Region as PersonalizationRegion } from '@algolia/client-personaliz
 import type { RecommendClient } from '@algolia/recommend';
 import type { InitClientOptions, InitClientRegion } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.2";
+export declare const apiClientVersion = "5.1.1";
 /**
  * The client type.
  */
@@ -29,17 +29,17 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
     browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceAllObjectsResponse").ReplaceAllObjectsResponse>;
     searchForHits<T>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
         results: Array<import("@algolia/client-search/model/searchResponse").SearchResponse<T>>;
     }>;
     searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
         results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
     }>;
-    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceAllObjectsResponse").ReplaceAllObjectsResponse>;
     addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
     addOrUpdateObject({ indexName, objectID, body }: import("@algolia/client-search/model/clientMethodProps").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
     appendSource(source: import("@algolia/client-search/model/source").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;

package/dist/algoliasearch/builds/node.d.ts

@@ -8,7 +8,7 @@ import type { Region as PersonalizationRegion } from '@algolia/client-personaliz
 import type { RecommendClient } from '@algolia/recommend';
 import type { InitClientOptions, InitClientRegion, GenerateSecuredApiKeyOptions, GetSecuredApiKeyRemainingValidityOptions } from './models';
 export * from './models';
-export declare const apiClientVersion = "5.0.2";
+export declare const apiClientVersion = "5.1.1";
 /**
  * The client type.
  */
@@ -46,17 +46,17 @@ export declare function algoliasearch(appId: string, apiKey: string, options?: C
     browseObjects<T>({ indexName, browseParams, ...browseObjectsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>> & import("@algolia/client-search/model/clientMethodProps").BrowseProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/browseResponse").BrowseResponse<T>>;
     browseRules({ indexName, searchRulesParams, ...browseRulesOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse> & import("@algolia/client-search/model/clientMethodProps").SearchRulesProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchRulesResponse").SearchRulesResponse>;
     browseSynonyms({ indexName, searchSynonymsParams, ...browseSynonymsOptions }: import("@algolia/client-search/model/clientMethodProps").BrowseOptions<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse> & import("@algolia/client-search/model/clientMethodProps").SearchSynonymsProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/searchSynonymsResponse").SearchSynonymsResponse>;
+    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
+    replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceAllObjectsResponse").ReplaceAllObjectsResponse>;
     searchForHits<T>(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
         results: Array<import("@algolia/client-search/model/searchResponse").SearchResponse<T>>;
     }>;
     searchForFacets(searchMethodParams: import("@algolia/client-search/model/clientMethodProps").LegacySearchMethodProps | import("@algolia/client-search/model/searchMethodParams").SearchMethodParams, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<{
         results: import("@algolia/client-search/model/searchForFacetValuesResponse").SearchForFacetValuesResponse[];
     }>;
-    chunkedBatch({ indexName, objects, action, waitForTasks, batchSize, }: import("@algolia/client-search/model/clientMethodProps").ChunkedBatchOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    saveObjects({ indexName, objects }: import("@algolia/client-search/model/clientMethodProps").SaveObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    deleteObjects({ indexName, objectIDs }: import("@algolia/client-search/model/clientMethodProps").DeleteObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    partialUpdateObjects({ indexName, objects, createIfNotExists }: import("@algolia/client-search/model/clientMethodProps").PartialUpdateObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/batchResponse").BatchResponse[]>;
-    replaceAllObjects({ indexName, objects, batchSize }: import("@algolia/client-search/model/clientMethodProps").ReplaceAllObjectsOptions, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/replaceAllObjectsResponse").ReplaceAllObjectsResponse>;
     addApiKey(apiKey: import("@algolia/client-search/model/apiKey").ApiKey, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/addApiKeyResponse").AddApiKeyResponse>;
     addOrUpdateObject({ indexName, objectID, body }: import("@algolia/client-search/model/clientMethodProps").AddOrUpdateObjectProps, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/updatedAtWithObjectIdResponse").UpdatedAtWithObjectIdResponse>;
     appendSource(source: import("@algolia/client-search/model/source").Source, requestOptions?: import("@algolia/client-common").RequestOptions): Promise<import("@algolia/client-search/model/createdAtResponse").CreatedAtResponse>;

package/dist/algoliasearch.cjs

@@ -5,7 +5,7 @@ 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 = '5.0.2';
+const apiClientVersion$5 = '5.1.1';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$4(region) {
     const url = !region
@@ -281,6 +281,43 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Schedule an A/B test to be started at a later time.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        scheduleABTest(scheduleABTestsRequest, requestOptions) {
+            if (!scheduleABTestsRequest) {
+                throw new Error('Parameter `scheduleABTestsRequest` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.name) {
+                throw new Error('Parameter `scheduleABTestsRequest.name` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.variants) {
+                throw new Error('Parameter `scheduleABTestsRequest.variants` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.scheduledAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.scheduledAt` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.endAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.endAt` is required when calling `scheduleABTest`.');
+            }
+            const requestPath = '/2/abtests/schedule';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: scheduleABTestsRequest,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
          *
@@ -310,7 +347,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$4 = '5.0.2';
+const apiClientVersion$4 = '5.1.1';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -1365,7 +1402,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$3 = '5.0.2';
+const apiClientVersion$3 = '5.1.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$2(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1626,7 +1663,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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$2 = '5.0.2';
+const apiClientVersion$2 = '5.1.1';
 function getDefaultHosts$1(appId) {
     return [
         {
@@ -1904,28 +1941,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 ...browseSynonymsOptions,
             });
         },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `hits`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForHits(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `facets`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForFacets(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2052,6 +2067,28 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             });
             return { copyOperationResponse, batchResponses, moveOperationResponse };
         },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `hits`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForHits(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `facets`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForFacets(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
         /**
          * Creates a new API key with specific permissions and restrictions.
          *
@@ -2514,7 +2551,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
+         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - deleteIndex.
@@ -3367,7 +3404,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
+         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - addObject.
@@ -3900,7 +3937,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // 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$1 = '5.0.2';
+const apiClientVersion$1 = '5.1.1';
 function getDefaultHosts(appId) {
     return [
         {

package/dist/algoliasearch.esm.browser.js

@@ -675,7 +675,7 @@ const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
 // 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 = '5.0.2';
+const apiClientVersion$5 = '5.1.1';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$4(region) {
     const url = !region
@@ -951,6 +951,43 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Schedule an A/B test to be started at a later time.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        scheduleABTest(scheduleABTestsRequest, requestOptions) {
+            if (!scheduleABTestsRequest) {
+                throw new Error('Parameter `scheduleABTestsRequest` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.name) {
+                throw new Error('Parameter `scheduleABTestsRequest.name` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.variants) {
+                throw new Error('Parameter `scheduleABTestsRequest.variants` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.scheduledAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.scheduledAt` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.endAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.endAt` is required when calling `scheduleABTest`.');
+            }
+            const requestPath = '/2/abtests/schedule';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: scheduleABTestsRequest,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
          *
@@ -980,7 +1017,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$4 = '5.0.2';
+const apiClientVersion$4 = '5.1.1';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -2035,7 +2072,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$3 = '5.0.2';
+const apiClientVersion$3 = '5.1.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$2(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -2296,7 +2333,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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$2 = '5.0.2';
+const apiClientVersion$2 = '5.1.1';
 function getDefaultHosts$1(appId) {
     return [
         {
@@ -2574,28 +2611,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 ...browseSynonymsOptions,
             });
         },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `hits`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForHits(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `facets`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForFacets(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2722,6 +2737,28 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             });
             return { copyOperationResponse, batchResponses, moveOperationResponse };
         },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `hits`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForHits(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `facets`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForFacets(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
         /**
          * Creates a new API key with specific permissions and restrictions.
          *
@@ -3184,7 +3221,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
+         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - deleteIndex.
@@ -4037,7 +4074,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
+         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - addObject.
@@ -4570,7 +4607,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // 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$1 = '5.0.2';
+const apiClientVersion$1 = '5.1.1';
 function getDefaultHosts(appId) {
     return [
         {

package/dist/algoliasearch.esm.node.js

@@ -3,7 +3,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
 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 = '5.0.2';
+const apiClientVersion$5 = '5.1.1';
 const REGIONS$2 = ['de', 'us'];
 function getDefaultHosts$4(region) {
     const url = !region
@@ -279,6 +279,43 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Schedule an A/B test to be started at a later time.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param scheduleABTestsRequest - The scheduleABTestsRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        scheduleABTest(scheduleABTestsRequest, requestOptions) {
+            if (!scheduleABTestsRequest) {
+                throw new Error('Parameter `scheduleABTestsRequest` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.name) {
+                throw new Error('Parameter `scheduleABTestsRequest.name` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.variants) {
+                throw new Error('Parameter `scheduleABTestsRequest.variants` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.scheduledAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.scheduledAt` is required when calling `scheduleABTest`.');
+            }
+            if (!scheduleABTestsRequest.endAt) {
+                throw new Error('Parameter `scheduleABTestsRequest.endAt` is required when calling `scheduleABTest`.');
+            }
+            const requestPath = '/2/abtests/schedule';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: scheduleABTestsRequest,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Stops an A/B test by its ID.  You can\'t restart stopped A/B tests.
          *
@@ -308,7 +345,7 @@ function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$4 = '5.0.2';
+const apiClientVersion$4 = '5.1.1';
 const REGIONS$1 = ['de', 'us'];
 function getDefaultHosts$3(region) {
     const url = !region
@@ -1363,7 +1400,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // 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$3 = '5.0.2';
+const apiClientVersion$3 = '5.1.1';
 const REGIONS = ['eu', 'us'];
 function getDefaultHosts$2(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
@@ -1624,7 +1661,7 @@ function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption,
 }
 
 // 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$2 = '5.0.2';
+const apiClientVersion$2 = '5.1.1';
 function getDefaultHosts$1(appId) {
     return [
         {
@@ -1902,28 +1939,6 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 ...browseSynonymsOptions,
             });
         },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `hits`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForHits(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
-        /**
-         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
-         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
-         *
-         * @summary Search multiple indices for `facets`.
-         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        searchForFacets(searchMethodParams, requestOptions) {
-            return this.search(searchMethodParams, requestOptions);
-        },
         /**
          * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
          *
@@ -2050,6 +2065,28 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             });
             return { copyOperationResponse, batchResponses, moveOperationResponse };
         },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia records (hits) and not facets.
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `hits` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `hits`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForHits(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
+        /**
+         * Helper: calls the `search` method but with certainty that we will only request Algolia facets and not records (hits).
+         * Disclaimer: We don't assert that the parameters you pass to this method only contains `facets` requests to prevent impacting search performances, this helper is purely for typing purposes.
+         *
+         * @summary Search multiple indices for `facets`.
+         * @param searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForFacets(searchMethodParams, requestOptions) {
+            return this.search(searchMethodParams, requestOptions);
+        },
         /**
          * Creates a new API key with specific permissions and restrictions.
          *
@@ -2512,7 +2549,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).
+         * This operation doesn\'t accept empty queries or filters.  It\'s more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - deleteIndex.
@@ -3365,7 +3402,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
+         * Adds a record to an index or replace it.  - If the record doesn\'t have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn\'t exist, a new record is added to your index. - If you add a record to an index that doesn\'t exist yet, a new index is created.  To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).
          *
          * Required API Key ACLs:
          * - addObject.
@@ -3898,7 +3935,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
 }
 
 // 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$1 = '5.0.2';
+const apiClientVersion$1 = '5.1.1';
 function getDefaultHosts(appId) {
     return [
         {