@algolia/recommend 5.0.0-alpha.8 → 5.0.0-alpha.81

package/dist/recommend.esm.node.js

@@ -1,243 +1,378 @@
 import { createAuth, createTransporter, getAlgoliaAgent, shuffle, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion = '5.0.0-alpha.8';
-function getDefaultHosts(appId) {
-    return [
-        {
-            url: `${appId}-dsn.algolia.net`,
-            accept: 'read',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}.algolia.net`,
-            accept: 'write',
-            protocol: 'https',
-        },
-    ].concat(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 = createAuth(appIdOption, apiKeyOption, authMode);
-    const transporter = createTransporter({
-        hosts: getDefaultHosts(appIdOption),
-        ...options,
-        algoliaAgent: getAlgoliaAgent({
-            algoliaAgents,
-            client: 'Recommend',
-            version: apiClientVersion,
-        }),
-        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.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        del({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
-            }
-            const requestPath = '/1{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.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        get({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * Returns recommendations or trending results, for a specific model and `objectID`.
-         *
-         * @summary Get results.
-         * @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) {
-                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);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param post - The post object.
-         * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param post.parameters - Query parameters to be applied to the current query.
-         * @param post.body - The parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        post({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `post`.');
-            }
-            const requestPath = '/1{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.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param put - The put object.
-         * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param put.parameters - Query parameters to be applied to the current query.
-         * @param put.body - The parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        put({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `put`.');
-            }
-            const requestPath = '/1{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);
-        },
-    };
+// 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.81';
+function getDefaultHosts(appId) {
+    return [
+        {
+            url: `${appId}-dsn.algolia.net`,
+            accept: 'read',
+            protocol: 'https',
+        },
+        {
+            url: `${appId}.algolia.net`,
+            accept: 'write',
+            protocol: 'https',
+        },
+    ].concat(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 = createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = createTransporter({
+        hosts: getDefaultHosts(appIdOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Recommend',
+            version: apiClientVersion,
+        }),
+        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.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param del - The del object.
+         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param del.parameters - Query parameters to apply to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        del({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `del`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         *
+         * @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 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);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param get - The get object.
+         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param get.parameters - Query parameters to apply to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        get({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `get`.');
+            }
+            const requestPath = '/1{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         *
+         * @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 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);
+        },
+        /**
+         * 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.
+         *
+         * @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 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);
+        },
+        /**
+         * 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).
+         *
+         * @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.
+         */
+        getRecommendations(getRecommendationsParams, requestOptions) {
+            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);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param post - The post object.
+         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param post.parameters - Query parameters to apply to the current query.
+         * @param post.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        post({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `post`.');
+            }
+            const requestPath = '/1{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.
+         *
+         * @summary Send requests to the Algolia REST API.
+         * @param put - The put object.
+         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param put.parameters - Query parameters to apply to the current query.
+         * @param put.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        put({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `put`.');
+            }
+            const requestPath = '/1{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);
+        },
+        /**
+         * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
+         *
+         * @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.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);
+        },
+    };
 }
 
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-function recommendClient(appId, apiKey, options) {
-    if (!appId || typeof appId !== 'string') {
-        throw new Error('`appId` is missing.');
-    }
-    if (!apiKey || typeof apiKey !== 'string') {
-        throw new Error('`apiKey` is missing.');
-    }
-    return createRecommendClient({
-        appId,
-        apiKey,
-        timeouts: {
-            connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: DEFAULT_READ_TIMEOUT_NODE,
-            write: DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: createNullCache(),
-        requestsCache: createNullCache(),
-        hostsCache: createMemoryCache(),
-        ...options,
-    });
+// 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.
+function recommendClient(appId, apiKey, options) {
+    if (!appId || typeof appId !== 'string') {
+        throw new Error('`appId` is missing.');
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+        throw new Error('`apiKey` is missing.');
+    }
+    return createRecommendClient({
+        appId,
+        apiKey,
+        timeouts: {
+            connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+            read: DEFAULT_READ_TIMEOUT_NODE,
+            write: DEFAULT_WRITE_TIMEOUT_NODE,
+        },
+        requester: createHttpRequester(),
+        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+        responsesCache: createNullCache(),
+        requestsCache: createNullCache(),
+        hostsCache: createMemoryCache(),
+        ...options,
+    });
 }
 
 export { apiClientVersion, recommendClient };