@algolia/recommend 5.0.0-alpha.99 → 5.0.0-beta.2

package/dist/model/trendingItems.d.ts

@@ -0,0 +1,15 @@
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+export type TrendingItems = {
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=trendingItems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/trendingItemsModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trending items model.
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
  */
 export type TrendingItemsModel = 'trending-items';
 //# sourceMappingURL=trendingItemsModel.d.ts.map

package/dist/model/trendingItemsQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
-export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
+import type { TrendingItems } from './trendingItems';
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
 //# sourceMappingURL=trendingItemsQuery.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC"}
+{"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,aAAa,CAAC"}

package/dist/model/typoTolerance.d.ts

@@ -1,6 +1,6 @@
 import type { TypoToleranceEnum } from './typoToleranceEnum';
 /**
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
+ * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
  */
 export type TypoTolerance = TypoToleranceEnum | boolean;
 //# sourceMappingURL=typoTolerance.d.ts.map

package/dist/model/typoToleranceEnum.d.ts

@@ -1,2 +1,5 @@
+/**
+ * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
+ */
 export type TypoToleranceEnum = 'min' | 'strict';
 //# sourceMappingURL=typoToleranceEnum.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
+{"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/model/value.d.ts

@@ -1,7 +1,7 @@
 import type { SortRemainingBy } from './sortRemainingBy';
 export type Value = {
     /**
-     * Pinned order of facet lists.
+     * Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
      */
     order?: string[];
     sortRemainingBy?: SortRemainingBy;

package/dist/recommend.cjs

@@ -4,7 +4,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.0.0-alpha.99';
+const apiClientVersion = '5.0.0-beta.2';
 function getDefaultHosts(appId) {
     return [
         {
@@ -89,7 +89,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -99,7 +98,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -113,7 +112,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -123,7 +121,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -137,7 +135,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -148,7 +145,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -163,7 +160,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -174,7 +170,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -187,13 +183,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Deletes a Recommend rule from a recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
          *
-         * @summary Delete a Recommend rule.
          * @param deleteRecommendRule - The deleteRecommendRule object.
-         * @param deleteRecommendRule.indexName - Index on which to perform the request.
-         * @param deleteRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param deleteRecommendRule.objectID - Unique record (object) identifier.
+         * @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) {
@@ -221,13 +219,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+         *
+         * Required API Key ACLs:
+         * - settings.
          *
-         * @summary Get a Recommend rule.
          * @param getRecommendRule - The getRecommendRule object.
-         * @param getRecommendRule.indexName - Index on which to perform the request.
-         * @param getRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param getRecommendRule.objectID - Unique record (object) identifier.
+         * @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) {
@@ -255,13 +255,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+         * 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.
          *
-         * @summary Get a Recommend task\'s status.
          * @param getRecommendStatus - The getRecommendStatus object.
-         * @param getRecommendStatus.indexName - Index on which to perform the request.
-         * @param getRecommendStatus.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param getRecommendStatus.taskID - Unique identifier of a task. Numeric value (up to 64bits).
+         * @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) {
@@ -289,9 +291,11 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+         * Retrieves recommendations from selected AI models.
+         *
+         * Required API Key ACLs:
+         * - search.
          *
-         * @summary Get recommendations and trending items.
          * @param getRecommendationsParams - The getRecommendationsParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -317,12 +321,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - settings.
          *
-         * @summary List Recommend rules.
          * @param searchRecommendRules - The searchRecommendRules object.
-         * @param searchRecommendRules.indexName - Index on which to perform the request.
-         * @param searchRecommendRules.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @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.
          */
@@ -353,6 +359,7 @@ function createRecommendClient({ 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function recommendClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');
@@ -360,21 +367,23 @@ function recommendClient(appId, apiKey, options) {
     if (!apiKey || typeof apiKey !== 'string') {
         throw new Error('`apiKey` is missing.');
     }
-    return createRecommendClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
-            write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: requesterNodeHttp.createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: clientCommon.createNullCache(),
-        requestsCache: clientCommon.createNullCache(),
-        hostsCache: clientCommon.createMemoryCache(),
-        ...options,
-    });
+    return {
+        ...createRecommendClient({
+            appId,
+            apiKey,
+            timeouts: {
+                connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
+                write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: requesterNodeHttp.createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: clientCommon.createNullCache(),
+            requestsCache: clientCommon.createNullCache(),
+            hostsCache: clientCommon.createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 exports.apiClientVersion = apiClientVersion;

package/dist/recommend.esm.browser.js

@@ -207,7 +207,7 @@ function _toPrimitive(t, r) {
 }
 function _toPropertyKey(t) {
   var i = _toPrimitive(t, "string");
-  return "symbol" == typeof i ? i : String(i);
+  return "symbol" == typeof i ? i : i + "";
 }
 function _defineProperty(obj, key, value) {
   key = _toPropertyKey(key);
@@ -281,7 +281,7 @@ function shuffle(array) {
 }
 function serializeUrl(host, path, queryParameters) {
   const queryParametersAsString = serializeQueryParameters(queryParameters);
-  let url = `${host.protocol}://${host.url}/${path.charAt(0) === '/' ? path.substr(1) : path}`;
+  let url = `${host.protocol}://${host.url}${host.port ? `:${host.port}` : ''}/${path.charAt(0) === '/' ? path.substring(1) : path}`;
   if (queryParametersAsString.length) {
     url += `?${queryParametersAsString}`;
   }
@@ -289,7 +289,7 @@ function serializeUrl(host, path, queryParameters) {
 }
 function serializeQueryParameters(parameters) {
   const isObjectOrArray = value => Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
-  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key])}`).join('&');
+  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key]).replaceAll('+', '%20')}`).join('&');
 }
 function serializeData(request, requestOptions) {
   if (request.method === 'GET' || request.data === undefined && requestOptions.data === undefined) {
@@ -460,16 +460,13 @@ function createTransporter({
       if (host === undefined) {
         throw new RetryError(stackTraceWithoutCredentials(stackTrace));
       }
-      let responseTimeout = requestOptions.timeout;
-      if (responseTimeout === undefined) {
-        responseTimeout = isRead ? timeouts.read : timeouts.write;
-      }
+      let responseTimeout = isRead ? requestOptions.timeouts?.read || timeouts.read : requestOptions.timeouts?.write || timeouts.write;
       const payload = {
         data,
         headers,
         method: request.method,
         url: serializeUrl(host, request.path, queryParameters),
-        connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
+        connectTimeout: getTimeout(timeoutsCount, requestOptions.timeouts?.connect || timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
       /**
@@ -697,7 +694,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.99';
+const apiClientVersion = '5.0.0-beta.2';
 function getDefaultHosts(appId) {
     return [
         {
@@ -782,7 +779,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -792,7 +788,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -806,7 +802,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -816,7 +811,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -830,7 +825,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -841,7 +835,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -856,7 +850,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary 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.
@@ -867,7 +860,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -880,13 +873,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Deletes a Recommend rule from a recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - editSettings.
          *
-         * @summary Delete a Recommend rule.
          * @param deleteRecommendRule - The deleteRecommendRule object.
-         * @param deleteRecommendRule.indexName - Index on which to perform the request.
-         * @param deleteRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param deleteRecommendRule.objectID - Unique record (object) identifier.
+         * @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) {
@@ -914,13 +909,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
+         *
+         * Required API Key ACLs:
+         * - settings.
          *
-         * @summary Get a Recommend rule.
          * @param getRecommendRule - The getRecommendRule object.
-         * @param getRecommendRule.indexName - Index on which to perform the request.
-         * @param getRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param getRecommendRule.objectID - Unique record (object) identifier.
+         * @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) {
@@ -948,13 +945,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
+         * 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.
          *
-         * @summary Get a Recommend task\'s status.
          * @param getRecommendStatus - The getRecommendStatus object.
-         * @param getRecommendStatus.indexName - Index on which to perform the request.
-         * @param getRecommendStatus.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
-         * @param getRecommendStatus.taskID - Unique identifier of a task. Numeric value (up to 64bits).
+         * @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) {
@@ -982,9 +981,11 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns results from either recommendation or trending models:    - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models   - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
+         * Retrieves recommendations from selected AI models.
+         *
+         * Required API Key ACLs:
+         * - search.
          *
-         * @summary Get recommendations and trending items.
          * @param getRecommendationsParams - The getRecommendationsParams object.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -1010,12 +1011,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         * Searches for Recommend rules.  Use an empty query to list all rules for this recommendation scenario.
+         *
+         * Required API Key ACLs:
+         * - settings.
          *
-         * @summary List Recommend rules.
          * @param searchRecommendRules - The searchRecommendRules object.
-         * @param searchRecommendRules.indexName - Index on which to perform the request.
-         * @param searchRecommendRules.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
+         * @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.
          */
@@ -1046,6 +1049,7 @@ function createRecommendClient({ 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.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function recommendClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');