algoliasearch 5.0.0-beta.3 → 5.0.0-beta.5

package/dist/algoliasearch.esm.node.js

@@ -3,9 +3,9 @@ import { createAuth, createTransporter, getAlgoliaAgent, createIterablePromise,
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion$4 = '5.0.0-beta.3';
+const apiClientVersion$5 = '5.0.0-beta.5';
 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);
@@ -15,12 +15,12 @@ function getDefaultHosts$3(region) {
 function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: getDefaultHosts$3(regionOption),
+        hosts: getDefaultHosts$4(regionOption),
         ...options,
         algoliaAgent: getAlgoliaAgent({
             algoliaAgents,
             client: 'Abtesting',
-            version: apiClientVersion$4,
+            version: apiClientVersion$5,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -308,9 +308,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.3';
+const apiClientVersion$4 = '5.0.0-beta.5';
 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);
@@ -320,12 +320,12 @@ function getDefaultHosts$2(region) {
 function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: getDefaultHosts$2(regionOption),
+        hosts: getDefaultHosts$3(regionOption),
         ...options,
         algoliaAgent: getAlgoliaAgent({
             algoliaAgents,
             client: 'Analytics',
-            version: apiClientVersion$3,
+            version: apiClientVersion$4,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1363,9 +1363,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.3';
+const apiClientVersion$3 = '5.0.0-beta.5';
 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' }];
 }
@@ -1373,12 +1373,12 @@ function getDefaultHosts$1(region) {
 function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
     const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: getDefaultHosts$1(regionOption),
+        hosts: getDefaultHosts$2(regionOption),
         ...options,
         algoliaAgent: getAlgoliaAgent({
             algoliaAgents,
             client: 'Personalization',
-            version: apiClientVersion$2,
+            version: apiClientVersion$3,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1624,8 +1624,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.3';
-function getDefaultHosts(appId) {
+const apiClientVersion$2 = '5.0.0-beta.5';
+function getDefaultHosts$1(appId) {
     return [
         {
             url: `${appId}-dsn.algolia.net`,
@@ -1659,12 +1659,12 @@ function getDefaultHosts(appId) {
 function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
     const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: getDefaultHosts(appIdOption),
+        hosts: getDefaultHosts$1(appIdOption),
         ...options,
         algoliaAgent: getAlgoliaAgent({
             algoliaAgents,
             client: 'Search',
-            version: apiClientVersion$1,
+            version: apiClientVersion$2,
         }),
         baseHeaders: {
             'content-type': 'text/plain',
@@ -1951,6 +1951,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         },
         /**
          * 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.
@@ -1962,7 +1963,7 @@ function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode
         async replaceAllObjects({ indexName, objects, batchSize }, requestOptions) {
             const randomSuffix = Math.random().toString(36).substring(7);
             const tmpIndexName = `${indexName}_tmp_${randomSuffix}`;
-            const copyOperationResponse = await this.operationIndex({
+            let copyOperationResponse = await this.operationIndex({
                 indexName,
                 operationIndexParams: {
                     operation: 'copy',
@@ -1970,17 +1971,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 };
@@ -3833,7 +3846,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.5';
+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$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') {
@@ -3857,6 +4232,13 @@ function algoliasearch(appId, apiKey, options) {
         hostsCache: createMemoryCache(),
         ...options,
     };
+    function initRecommend(initOptions = {}) {
+        return createRecommendClient({
+            ...commonOptions,
+            ...initOptions.options,
+            ...initOptions,
+        });
+    }
     function initAnalytics(initOptions = {}) {
         if (initOptions.region &&
             (typeof initOptions.region !== 'string' ||
@@ -3902,9 +4284,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`.
          *
@@ -3914,7 +4297,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 = 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 = serializeQueryParameters(mergedRestrictions);
             return Buffer.from(createHmac('sha256', parentApiKey)
                 .update(queryParameters)
                 .digest('hex') + queryParameters).toString('base64');