algoliasearch 5.0.0-beta.1 → 5.0.0-beta.10

package/dist/algoliasearch.cjs

@@ -5,9 +5,9 @@ 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$4 = '5.0.0-beta.1';
+const apiClientVersion$5 = '5.0.0-beta.10';
 const REGIONS$2 = ['de', 'us'];
-function getDefaultHosts$3(region) {
+function getDefaultHosts$4(region) {
     const url = !region
         ? 'analytics.algolia.com'
         : 'analytics.{region}.algolia.com'.replace('{region}', region);
@@ -17,12 +17,12 @@ function getDefaultHosts$3(region) {
 function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts$3(regionOption),
+        hosts: getDefaultHosts$4(regionOption),
         ...options,
         algoliaAgent: clientCommon.getAlgoliaAgent({
             algoliaAgents,
             client: 'Abtesting',
-            version: apiClientVersion$4,
+            version: apiClientVersion$5,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -310,9 +310,9 @@ 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$3 = '5.0.0-beta.1';
+const apiClientVersion$4 = '5.0.0-beta.10';
 const REGIONS$1 = ['de', 'us'];
-function getDefaultHosts$2(region) {
+function getDefaultHosts$3(region) {
     const url = !region
         ? 'analytics.algolia.com'
         : 'analytics.{region}.algolia.com'.replace('{region}', region);
@@ -322,12 +322,12 @@ function getDefaultHosts$2(region) {
 function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts$2(regionOption),
+        hosts: getDefaultHosts$3(regionOption),
         ...options,
         algoliaAgent: clientCommon.getAlgoliaAgent({
             algoliaAgents,
             client: 'Analytics',
-            version: apiClientVersion$3,
+            version: apiClientVersion$4,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1365,9 +1365,9 @@ 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$2 = '5.0.0-beta.1';
+const apiClientVersion$3 = '5.0.0-beta.10';
 const REGIONS = ['eu', 'us'];
-function getDefaultHosts$1(region) {
+function getDefaultHosts$2(region) {
     const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
     return [{ url, accept: 'readWrite', protocol: 'https' }];
 }
@@ -1375,12 +1375,12 @@ function getDefaultHosts$1(region) {
 function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts$1(regionOption),
+        hosts: getDefaultHosts$2(regionOption),
         ...options,
         algoliaAgent: clientCommon.getAlgoliaAgent({
             algoliaAgents,
             client: 'Personalization',
-            version: apiClientVersion$2,
+            version: apiClientVersion$3,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1626,8 +1626,8 @@ 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$1 = '5.0.0-beta.1';
-function getDefaultHosts(appId) {
+const apiClientVersion$2 = '5.0.0-beta.10';
+function getDefaultHosts$1(appId) {
     return [
         {
             url: `${appId}-dsn.algolia.net`,
@@ -1661,12 +1661,12 @@ function getDefaultHosts(appId) {
 function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
     const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = clientCommon.createTransporter({
-        hosts: getDefaultHosts(appIdOption),
+        hosts: getDefaultHosts$1(appIdOption),
         ...options,
         algoliaAgent: clientCommon.getAlgoliaAgent({
             algoliaAgents,
             client: 'Search',
-            version: apiClientVersion$1,
+            version: apiClientVersion$2,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1732,6 +1732,29 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                 timeout: () => timeout(retryCount),
             });
         },
+        /**
+         * Helper: Wait for an application-level task to complete for a given `taskID`.
+         *
+         * @summary Helper method that waits for a task to be published (completed).
+         * @param waitForAppTaskOptions - The `waitForTaskOptions` object.
+         * @param waitForAppTaskOptions.taskID - The `taskID` returned in the method response.
+         * @param waitForAppTaskOptions.maxRetries - The maximum number of retries. 50 by default.
+         * @param waitForAppTaskOptions.timeout - The function to decide how long to wait between retries.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+         */
+        waitForAppTask({ taskID, maxRetries = 50, timeout = (retryCount) => Math.min(retryCount * 200, 5000), }, requestOptions) {
+            let retryCount = 0;
+            return clientCommon.createIterablePromise({
+                func: () => this.getAppTask({ taskID }, requestOptions),
+                validate: (response) => response.status === 'published',
+                aggregator: () => (retryCount += 1),
+                error: {
+                    validate: () => retryCount >= maxRetries,
+                    message: () => `The maximum number of retries exceeded. (${retryCount}/${maxRetries})`,
+                },
+                timeout: () => timeout(retryCount),
+            });
+        },
         /**
          * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
          *
@@ -1913,9 +1936,10 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         async chunkedBatch({ indexName, objects, action = 'addObject', waitForTasks, batchSize = 1000, }, requestOptions) {
             let requests = [];
             const responses = [];
-            for (const [i, obj] of objects.entries()) {
+            const objectEntries = objects.entries();
+            for (const [i, obj] of objectEntries) {
                 requests.push({ action, body: obj });
-                if (i % batchSize === 0) {
+                if (requests.length === batchSize || i === objects.length - 1) {
                     responses.push(await this.batch({ indexName, batchWriteParams: { requests } }, requestOptions));
                     requests = [];
                 }
@@ -1927,20 +1951,68 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             }
             return responses;
         },
+        /**
+         * Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+         *
+         * @summary Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+         * @param saveObjects - The `saveObjects` object.
+         * @param saveObjects.indexName - The `indexName` to save `objects` in.
+         * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
+         */
+        async saveObjects({ indexName, objects }, requestOptions) {
+            return await this.chunkedBatch({ indexName, objects, action: 'addObject' }, requestOptions);
+        },
+        /**
+         * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
+         *
+         * @summary Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
+         * @param deleteObjects - The `deleteObjects` object.
+         * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
+         * @param deleteObjects.objectIDs - The objectIDs to delete.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
+         */
+        async deleteObjects({ indexName, objectIDs }, requestOptions) {
+            return await this.chunkedBatch({
+                indexName,
+                objects: objectIDs.map((objectID) => ({ objectID })),
+                action: 'deleteObject',
+            }, requestOptions);
+        },
+        /**
+         * Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+         *
+         * @summary Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+         * @param partialUpdateObjects - The `partialUpdateObjects` object.
+         * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
+         * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
+         * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+         */
+        async partialUpdateObjects({ indexName, objects, createIfNotExists }, requestOptions) {
+            return await this.chunkedBatch({
+                indexName,
+                objects,
+                action: createIfNotExists
+                    ? 'partialUpdateObject'
+                    : 'partialUpdateObjectNoCreate',
+            }, requestOptions);
+        },
         /**
          * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
+         * See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
          *
          * @summary Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
          * @param replaceAllObjects - The `replaceAllObjects` object.
          * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
          * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
-         * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
-         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+         * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
          */
         async replaceAllObjects({ indexName, objects, batchSize }, requestOptions) {
-            const randomSuffix = Math.random().toString(36).substring(7);
+            const randomSuffix = Math.floor(Math.random() * 1000000) + 100000;
             const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
-            const copyOperationResponse = await this.operationIndex({
+            let copyOperationResponse = await this.operationIndex({
                 indexName,
                 operationIndexParams: {
                     operation: 'copy',
@@ -1948,17 +2020,29 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
                     scope: ['settings', 'rules', 'synonyms'],
                 },
             }, requestOptions);
+            const batchResponses = await this.chunkedBatch({ indexName: tmpIndexName, objects, waitForTasks: true, batchSize }, requestOptions);
             await this.waitForTask({
+                indexName: tmpIndexName,
+                taskID: copyOperationResponse.taskID,
+            });
+            copyOperationResponse = await this.operationIndex({
                 indexName,
+                operationIndexParams: {
+                    operation: 'copy',
+                    destination: tmpIndexName,
+                    scope: ['settings', 'rules', 'synonyms'],
+                },
+            }, requestOptions);
+            await this.waitForTask({
+                indexName: tmpIndexName,
                 taskID: copyOperationResponse.taskID,
             });
-            const batchResponses = await this.chunkedBatch({ indexName: tmpIndexName, objects, waitForTasks: true, batchSize }, requestOptions);
             const moveOperationResponse = await this.operationIndex({
                 indexName: tmpIndexName,
                 operationIndexParams: { operation: 'move', destination: indexName },
             }, requestOptions);
             await this.waitForTask({
-                indexName,
+                indexName: tmpIndexName,
                 taskID: moveOperationResponse.taskID,
             });
             return { copyOperationResponse, batchResponses, moveOperationResponse };
@@ -2194,7 +2278,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.
+         * Retrieves records from an index, up to 1,000 per request.  While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices.  - The Analytics API doesn\'t collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There\'s no ranking for: typo-tolerance, number of matched words, proximity, geo distance.  Browse requests automatically apply these settings:  - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` is evaluated to `true`)  If you send these parameters with your browse requests, they\'ll be ignored.
          *
          * Required API Key ACLs:
          * - browse.
@@ -2627,6 +2711,31 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             };
             return transporter.request(request, requestOptions);
         },
+        /**
+         * Checks the status of a given application task.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param getAppTask - The getAppTask object.
+         * @param getAppTask.taskID - Unique task identifier.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getAppTask({ taskID }, requestOptions) {
+            if (!taskID) {
+                throw new Error('Parameter `taskID` is required when calling `getAppTask`.');
+            }
+            const requestPath = '/1/task/{taskID}'.replace('{taskID}', encodeURIComponent(taskID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
         /**
          * Lists supported languages with their supported dictionary types and number of custom entries.
          *
@@ -3101,7 +3210,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
             return transporter.request(request, requestOptions);
         },
         /**
-         * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
+         * Copies or moves (renames) an index within the same Algolia application.  - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn\'t exist yet, it\'ll be created.  **Copy**  - Copying a source index that doesn\'t exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can\'t copy the `enableReRanking`, `mode`, and `replicas` settings. - You can\'t copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/)  **Move**  - Moving a source index that doesn\'t exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name.   To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).
          *
          * Required API Key ACLs:
          * - addObject.
@@ -3786,7 +3895,369 @@ 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 = apiClientVersion$1;
+const apiClientVersion$1 = '5.0.0-beta.10';
+function getDefaultHosts(appId) {
+    return [
+        {
+            url: `${appId}-dsn.algolia.net`,
+            accept: 'read',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}.algolia.net`,
+            accept: 'write',
+            protocol: 'https',
+        },
+    ].concat(clientCommon.shuffle([
+        {
+            url: `${appId}-1.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-2.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}-3.algolianet.com`,
+            accept: 'readWrite',
+            protocol: 'https',
+        },
+    ]));
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
+    const auth = clientCommon.createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = clientCommon.createTransporter({
+        hosts: getDefaultHosts(appIdOption),
+        ...options,
+        algoliaAgent: clientCommon.getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Recommend',
+            version: apiClientVersion$1,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return transporter.algoliaAgent.value;
+        },
+        /**
+         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+         *
+         * @param segment - The algolia agent (user-agent) segment to add.
+         * @param version - The version of the agent.
+         */
+        addAlgoliaAgent(segment, version) {
+            transporter.algoliaAgent.add({ segment, version });
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customDelete - The customDelete object.
+         * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customDelete.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.
+         */
+        customDelete({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customDelete`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customGet - The customGet object.
+         * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customGet.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.
+         */
+        customGet({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customGet`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPost - The customPost object.
+         * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPost.parameters - Query parameters to apply to the current query.
+         * @param customPost.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.
+         */
+        customPost({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPost`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPut - The customPut object.
+         * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPut.parameters - Query parameters to apply to the current query.
+         * @param customPut.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.
+         */
+        customPut({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPut`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Deletes a Recommend rule from a recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param deleteRecommendRule - The deleteRecommendRule object.
+         * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
+         * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param deleteRecommendRule.objectID - Unique record identifier.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteRecommendRule({ indexName, model, objectID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteRecommendRule`.');
+            }
+            if (!model) {
+                throw new Error('Parameter `model` is required when calling `deleteRecommendRule`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `deleteRecommendRule`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{model}', encodeURIComponent(model))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+         *
+         * Required API Key ACLs:
+         * - settings.
+         *
+         * @param getRecommendRule - The getRecommendRule object.
+         * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
+         * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param getRecommendRule.objectID - Unique record identifier.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRecommendRule({ indexName, model, objectID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getRecommendRule`.');
+            }
+            if (!model) {
+                throw new Error('Parameter `model` is required when calling `getRecommendRule`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `getRecommendRule`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{model}/recommend/rules/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{model}', encodeURIComponent(model))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Checks the status of a given task.  Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
+         *
+         * @param getRecommendStatus - The getRecommendStatus object.
+         * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
+         * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param getRecommendStatus.taskID - Unique task identifier.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRecommendStatus({ indexName, model, taskID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getRecommendStatus`.');
+            }
+            if (!model) {
+                throw new Error('Parameter `model` is required when calling `getRecommendStatus`.');
+            }
+            if (!taskID) {
+                throw new Error('Parameter `taskID` is required when calling `getRecommendStatus`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{model}/task/{taskID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{model}', encodeURIComponent(model))
+                .replace('{taskID}', encodeURIComponent(taskID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves recommendations from selected AI models.
+         *
+         * Required API Key ACLs:
+         * - search.
+         *
+         * @param getRecommendationsParams - The getRecommendationsParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRecommendations(getRecommendationsParams, requestOptions) {
+            if (getRecommendationsParams && Array.isArray(getRecommendationsParams)) {
+                const newSignatureRequest = {
+                    requests: getRecommendationsParams,
+                };
+                // eslint-disable-next-line no-param-reassign
+                getRecommendationsParams = newSignatureRequest;
+            }
+            if (!getRecommendationsParams) {
+                throw new Error('Parameter `getRecommendationsParams` is required when calling `getRecommendations`.');
+            }
+            if (!getRecommendationsParams.requests) {
+                throw new Error('Parameter `getRecommendationsParams.requests` is required when calling `getRecommendations`.');
+            }
+            const requestPath = '/1/indexes/*/recommendations';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: getRecommendationsParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - settings.
+         *
+         * @param searchRecommendRules - The searchRecommendRules object.
+         * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
+         * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchRecommendRules({ indexName, model, searchRecommendRulesParams, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `searchRecommendRules`.');
+            }
+            if (!model) {
+                throw new Error('Parameter `model` is required when calling `searchRecommendRules`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{model}/recommend/rules/search'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{model}', encodeURIComponent(model));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchRecommendRulesParams ? searchRecommendRulesParams : {},
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
+}
+
+// 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 = apiClientVersion$2;
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function algoliasearch(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
@@ -3810,6 +4281,13 @@ function algoliasearch(appId, apiKey, options) {
         hostsCache: clientCommon.createMemoryCache(),
         ...options,
     };
+    function initRecommend(initOptions = {}) {
+        return createRecommendClient({
+            ...commonOptions,
+            ...initOptions.options,
+            ...initOptions,
+        });
+    }
     function initAnalytics(initOptions = {}) {
         if (initOptions.region &&
             (typeof initOptions.region !== 'string' ||
@@ -3855,9 +4333,10 @@ function algoliasearch(appId, apiKey, options) {
         get _ua() {
             return this.transporter.algoliaAgent.value;
         },
+        initAbtesting,
         initAnalytics,
         initPersonalization,
-        initAbtesting,
+        initRecommend,
         /**
          * Helper: Generates a secured API key based on the given `parentApiKey` and given `restrictions`.
          *
@@ -3867,7 +4346,23 @@ function algoliasearch(appId, apiKey, options) {
          * @param generateSecuredApiKey.restrictions - A set of properties defining the restrictions of the secured API key.
          */
         generateSecuredApiKey({ parentApiKey, restrictions = {}, }) {
-            const queryParameters = clientCommon.serializeQueryParameters(restrictions);
+            let mergedRestrictions = restrictions;
+            if (restrictions.searchParams) {
+                // merge searchParams with the root restrictions
+                mergedRestrictions = {
+                    ...restrictions,
+                    ...restrictions.searchParams,
+                };
+                delete mergedRestrictions.searchParams;
+            }
+            mergedRestrictions = Object.keys(mergedRestrictions)
+                .sort()
+                .reduce((acc, key) => {
+                // eslint-disable-next-line no-param-reassign
+                acc[key] = mergedRestrictions[key];
+                return acc;
+            }, {});
+            const queryParameters = clientCommon.serializeQueryParameters(mergedRestrictions);
             return Buffer.from(crypto.createHmac('sha256', parentApiKey)
                 .update(queryParameters)
                 .digest('hex') + queryParameters).toString('base64');