algoliasearch 4.14.2 → 5.0.0-alpha.3

package/dist/algoliasearch.esm.node.js

@@ -0,0 +1,3331 @@
+import { createAuth, createTransporter, getAlgoliaAgent, createRetryablePromise, 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$4 = '5.0.0-alpha.3';
+const REGIONS$2 = ['de', 'us'];
+function getDefaultHosts$3(region) {
+    const url = !region
+        ? 'analytics.algolia.com'
+        : 'analytics.{region}.algolia.com'.replace('{region}', region);
+    return [{ url, accept: 'readWrite', protocol: 'https' }];
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
+    const auth = createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = createTransporter({
+        hosts: getDefaultHosts$3(regionOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Abtesting',
+            version: apiClientVersion$4,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * 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 });
+        },
+        /**
+         * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
+         *
+         * @summary Create a test.
+         * @param addABTestsRequest - The addABTestsRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        addABTests(addABTestsRequest, requestOptions) {
+            if (!addABTestsRequest) {
+                throw new Error('Parameter `addABTestsRequest` is required when calling `addABTests`.');
+            }
+            if (!addABTestsRequest.name) {
+                throw new Error('Parameter `addABTestsRequest.name` is required when calling `addABTests`.');
+            }
+            if (!addABTestsRequest.variant) {
+                throw new Error('Parameter `addABTestsRequest.variant` is required when calling `addABTests`.');
+            }
+            if (!addABTestsRequest.endAt) {
+                throw new Error('Parameter `addABTestsRequest.endAt` is required when calling `addABTests`.');
+            }
+            const requestPath = '/2/abtests';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: addABTestsRequest,
+            };
+            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 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);
+        },
+        /**
+         * Delete a test.
+         *
+         * @summary Delete a test.
+         * @param deleteABTest - The deleteABTest object.
+         * @param deleteABTest.id - The A/B test ID.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteABTest({ id }, requestOptions) {
+            if (!id) {
+                throw new Error('Parameter `id` is required when calling `deleteABTest`.');
+            }
+            const requestPath = '/2/abtests/{id}'.replace('{id}', encodeURIComponent(id));
+            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 - 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 metadata and metrics for an A/B test.
+         *
+         * @summary Get a test.
+         * @param getABTest - The getABTest object.
+         * @param getABTest.id - The A/B test ID.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getABTest({ id }, requestOptions) {
+            if (!id) {
+                throw new Error('Parameter `id` is required when calling `getABTest`.');
+            }
+            const requestPath = '/2/abtests/{id}'.replace('{id}', encodeURIComponent(id));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
+         *
+         * @summary List all tests.
+         * @param listABTests - The listABTests object.
+         * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param listABTests.limit - Number of records to return. Limit is the size of the page.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        listABTests({ offset, limit }, requestOptions) {
+            const requestPath = '/2/abtests';
+            const headers = {};
+            const queryParameters = {};
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            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.
+         *
+         * @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);
+        },
+        /**
+         * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
+         *
+         * @summary Stop a test.
+         * @param stopABTest - The stopABTest object.
+         * @param stopABTest.id - The A/B test ID.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        stopABTest({ id }, requestOptions) {
+            if (!id) {
+                throw new Error('Parameter `id` is required when calling `stopABTest`.');
+            }
+            const requestPath = '/2/abtests/{id}/stop'.replace('{id}', encodeURIComponent(id));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
+}
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion$3 = '5.0.0-alpha.3';
+const REGIONS$1 = ['de', 'us'];
+function getDefaultHosts$2(region) {
+    const url = !region
+        ? 'analytics.algolia.com'
+        : 'analytics.{region}.algolia.com'.replace('{region}', region);
+    return [{ url, accept: 'readWrite', protocol: 'https' }];
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
+    const auth = createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = createTransporter({
+        hosts: getDefaultHosts$2(regionOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Analytics',
+            version: apiClientVersion$3,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * 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 the average click position. The endpoint returns a value for the complete given time range, as well as a value per day.
+         *
+         * @summary Get average click position.
+         * @param getAverageClickPosition - The getAverageClickPosition object.
+         * @param getAverageClickPosition.index - The index name to target.
+         * @param getAverageClickPosition.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getAverageClickPosition.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getAverageClickPosition.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getAverageClickPosition({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getAverageClickPosition`.');
+            }
+            const requestPath = '/2/clicks/averageClickPosition';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the distribution of clicks per range of positions.  If the groups all have a count of 0, it means Algolia didn’t receive any click events for the queries with the clickAnalytics search parameter set to true. The count is 0 until Algolia receives at least one click event.
+         *
+         * @summary Get clicks per positions.
+         * @param getClickPositions - The getClickPositions object.
+         * @param getClickPositions.index - The index name to target.
+         * @param getClickPositions.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getClickPositions.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getClickPositions.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getClickPositions({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getClickPositions`.');
+            }
+            const requestPath = '/2/clicks/positions';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns a click-through rate (CTR). The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of clicks and searches used to compute the rates.
+         *
+         * @summary Get click-through rate (CTR).
+         * @param getClickThroughRate - The getClickThroughRate object.
+         * @param getClickThroughRate.index - The index name to target.
+         * @param getClickThroughRate.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getClickThroughRate.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getClickThroughRate.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getClickThroughRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getClickThroughRate`.');
+            }
+            const requestPath = '/2/clicks/clickThroughRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns a conversion rate (CR). The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of conversion and searches used to compute the rates.
+         *
+         * @summary Get conversion rate (CR).
+         * @param getConversationRate - The getConversationRate object.
+         * @param getConversationRate.index - The index name to target.
+         * @param getConversationRate.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getConversationRate.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getConversationRate.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getConversationRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getConversationRate`.');
+            }
+            const requestPath = '/2/conversions/conversionRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the rate at which searches didn\'t lead to any clicks. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without clicks.
+         *
+         * @summary Get no click rate.
+         * @param getNoClickRate - The getNoClickRate object.
+         * @param getNoClickRate.index - The index name to target.
+         * @param getNoClickRate.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getNoClickRate.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getNoClickRate.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getNoClickRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getNoClickRate`.');
+            }
+            const requestPath = '/2/searches/noClickRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the rate at which searches didn\'t return any results. The endpoint returns a value for the complete given time range, as well as a value per day. It also returns the count of searches and searches without results used to compute the rates.
+         *
+         * @summary Get no results rate.
+         * @param getNoResultsRate - The getNoResultsRate object.
+         * @param getNoResultsRate.index - The index name to target.
+         * @param getNoResultsRate.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getNoResultsRate.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getNoResultsRate.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getNoResultsRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getNoResultsRate`.');
+            }
+            const requestPath = '/2/searches/noResultRate';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the number of searches across the given time range. The endpoint returns a value for the complete given time range, as well as a value per day.
+         *
+         * @summary Get searches count.
+         * @param getSearchesCount - The getSearchesCount object.
+         * @param getSearchesCount.index - The index name to target.
+         * @param getSearchesCount.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesCount.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesCount.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSearchesCount({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getSearchesCount`.');
+            }
+            const requestPath = '/2/searches/count';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top searches that didn\'t lead to any clicks. Limited to the 1000 most frequent ones. For each search, also returns the average number of found hits.
+         *
+         * @summary Get top searches with no clicks.
+         * @param getSearchesNoClicks - The getSearchesNoClicks object.
+         * @param getSearchesNoClicks.index - The index name to target.
+         * @param getSearchesNoClicks.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesNoClicks.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesNoClicks.limit - Number of records to return. Limit is the size of the page.
+         * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getSearchesNoClicks.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getSearchesNoClicks`.');
+            }
+            const requestPath = '/2/searches/noClicks';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top searches that didn\'t return any results. Limited to the 1000 most frequent ones.
+         *
+         * @summary Get top searches with no results.
+         * @param getSearchesNoResults - The getSearchesNoResults object.
+         * @param getSearchesNoResults.index - The index name to target.
+         * @param getSearchesNoResults.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesNoResults.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getSearchesNoResults.limit - Number of records to return. Limit is the size of the page.
+         * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getSearchesNoResults.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSearchesNoResults({ index, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getSearchesNoResults`.');
+            }
+            const requestPath = '/2/searches/noResults';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the latest update time of the analytics API for a given index. If the index has been recently created and/or no search has been performed yet the updated time will be null.
+         *
+         * @summary Get Analytics API status.
+         * @param getStatus - The getStatus object.
+         * @param getStatus.index - The index name to target.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getStatus({ index }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getStatus`.');
+            }
+            const requestPath = '/2/status';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top countries. Limited to the 1000 most frequent ones.
+         *
+         * @summary Get top countries.
+         * @param getTopCountries - The getTopCountries object.
+         * @param getTopCountries.index - The index name to target.
+         * @param getTopCountries.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopCountries.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopCountries.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopCountries.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopCountries({ index, startDate, endDate, limit, offset, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopCountries`.');
+            }
+            const requestPath = '/2/countries';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top filter attributes. Limited to the 1000 most used filters.
+         *
+         * @summary Get top filter attributes.
+         * @param getTopFilterAttributes - The getTopFilterAttributes object.
+         * @param getTopFilterAttributes.index - The index name to target.
+         * @param getTopFilterAttributes.search - The query term to search for. Must match the exact user input.
+         * @param getTopFilterAttributes.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFilterAttributes.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFilterAttributes.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFilterAttributes.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopFilterAttributes`.');
+            }
+            const requestPath = '/2/filters';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (search !== undefined) {
+                queryParameters.search = search.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top filters for the given attribute. Limited to the 1000 most used filters.
+         *
+         * @summary Get top filters for the an attribute.
+         * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
+         * @param getTopFilterForAttribute.attribute - The exact name of the attribute.
+         * @param getTopFilterForAttribute.index - The index name to target.
+         * @param getTopFilterForAttribute.search - The query term to search for. Must match the exact user input.
+         * @param getTopFilterForAttribute.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFilterForAttribute.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFilterForAttribute.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFilterForAttribute.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!attribute) {
+                throw new Error('Parameter `attribute` is required when calling `getTopFilterForAttribute`.');
+            }
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopFilterForAttribute`.');
+            }
+            const requestPath = '/2/filters/{attribute}'.replace('{attribute}', encodeURIComponent(attribute));
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (search !== undefined) {
+                queryParameters.search = search.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top filters with no results. Limited to the 1000 most used filters.
+         *
+         * @summary Get top filters for a no result search.
+         * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
+         * @param getTopFiltersNoResults.index - The index name to target.
+         * @param getTopFiltersNoResults.search - The query term to search for. Must match the exact user input.
+         * @param getTopFiltersNoResults.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFiltersNoResults.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopFiltersNoResults.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopFiltersNoResults.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopFiltersNoResults`.');
+            }
+            const requestPath = '/2/filters/noResults';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (search !== undefined) {
+                queryParameters.search = search.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top hits. Limited to the 1000 most frequent ones.
+         *
+         * @summary Get top hits.
+         * @param getTopHits - The getTopHits object.
+         * @param getTopHits.index - The index name to target.
+         * @param getTopHits.search - The query term to search for. Must match the exact user input.
+         * @param getTopHits.clickAnalytics - Whether to include the click-through and conversion rates for a search.
+         * @param getTopHits.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopHits.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopHits.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopHits.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopHits({ index, search, clickAnalytics, startDate, endDate, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopHits`.');
+            }
+            const requestPath = '/2/hits';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (search !== undefined) {
+                queryParameters.search = search.toString();
+            }
+            if (clickAnalytics !== undefined) {
+                queryParameters.clickAnalytics = clickAnalytics.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns top searches. Limited to the 1000 most frequent ones. For each search, also returns the average number of hits returned.
+         *
+         * @summary Get top searches.
+         * @param getTopSearches - The getTopSearches object.
+         * @param getTopSearches.index - The index name to target.
+         * @param getTopSearches.clickAnalytics - Whether to include the click-through and conversion rates for a search.
+         * @param getTopSearches.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopSearches.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getTopSearches.orderBy - Reorder the results.
+         * @param getTopSearches.direction - The sorting of the result.
+         * @param getTopSearches.limit - Number of records to return. Limit is the size of the page.
+         * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
+         * @param getTopSearches.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopSearches({ index, clickAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getTopSearches`.');
+            }
+            const requestPath = '/2/searches';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (clickAnalytics !== undefined) {
+                queryParameters.clickAnalytics = clickAnalytics.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (orderBy !== undefined) {
+                queryParameters.orderBy = orderBy.toString();
+            }
+            if (direction !== undefined) {
+                queryParameters.direction = direction.toString();
+            }
+            if (limit !== undefined) {
+                queryParameters.limit = limit.toString();
+            }
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the distinct count of users across the given time range. The endpoint returns a value for the complete given time range, as well as a value per day.
+         *
+         * @summary Get users count.
+         * @param getUsersCount - The getUsersCount object.
+         * @param getUsersCount.index - The index name to target.
+         * @param getUsersCount.startDate - The lower bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getUsersCount.endDate - The upper bound timestamp (a date, a string like \"2006-01-02\") of the period to analyze.
+         * @param getUsersCount.tags - Filter metrics on the provided tags. Each tag must correspond to an analyticsTags set at search time. Multiple tags can be combined with the operators OR and AND. If a tag contains characters like spaces or parentheses, it should be URL encoded.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getUsersCount({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getUsersCount`.');
+            }
+            const requestPath = '/2/users/count';
+            const headers = {};
+            const queryParameters = {};
+            if (index !== undefined) {
+                queryParameters.index = index.toString();
+            }
+            if (startDate !== undefined) {
+                queryParameters.startDate = startDate.toString();
+            }
+            if (endDate !== undefined) {
+                queryParameters.endDate = endDate.toString();
+            }
+            if (tags !== undefined) {
+                queryParameters.tags = tags.toString();
+            }
+            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.
+         *
+         * @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);
+        },
+    };
+}
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion$2 = '5.0.0-alpha.3';
+const REGIONS = ['eu', 'us'];
+function getDefaultHosts$1(region) {
+    const url = 'personalization.{region}.algolia.com'.replace('{region}', region);
+    return [{ url, accept: 'readWrite', protocol: 'https' }];
+}
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }) {
+    const auth = createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = createTransporter({
+        hosts: getDefaultHosts$1(regionOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Personalization',
+            version: apiClientVersion$2,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * 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);
+        },
+        /**
+         * Delete the user profile and all its associated data.  Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile.  It might take a couple hours for the deletion request to be fully processed.
+         *
+         * @summary Delete a user profile.
+         * @param deleteUserProfile - The deleteUserProfile object.
+         * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteUserProfile({ userToken }, requestOptions) {
+            if (!userToken) {
+                throw new Error('Parameter `userToken` is required when calling `deleteUserProfile`.');
+            }
+            const requestPath = '/1/profiles/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
+            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 - 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);
+        },
+        /**
+         * The strategy contains information on the events and facets that impact user profiles and personalized search results.
+         *
+         * @summary Get the current strategy.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getPersonalizationStrategy(requestOptions) {
+            const requestPath = '/1/strategies/personalization';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Get the user profile built from Personalization strategy.  The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
+         *
+         * @summary Get a user profile.
+         * @param getUserTokenProfile - The getUserTokenProfile object.
+         * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getUserTokenProfile({ userToken }, requestOptions) {
+            if (!userToken) {
+                throw new Error('Parameter `userToken` is required when calling `getUserTokenProfile`.');
+            }
+            const requestPath = '/1/profiles/personalization/{userToken}'.replace('{userToken}', encodeURIComponent(userToken));
+            const headers = {};
+            const queryParameters = {};
+            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.
+         *
+         * @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);
+        },
+        /**
+         * A strategy defines the events and facets that impact user profiles and personalized search results.
+         *
+         * @summary Set a new strategy.
+         * @param personalizationStrategyParams - The personalizationStrategyParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        setPersonalizationStrategy(personalizationStrategyParams, requestOptions) {
+            if (!personalizationStrategyParams) {
+                throw new Error('Parameter `personalizationStrategyParams` is required when calling `setPersonalizationStrategy`.');
+            }
+            if (!personalizationStrategyParams.eventScoring) {
+                throw new Error('Parameter `personalizationStrategyParams.eventScoring` is required when calling `setPersonalizationStrategy`.');
+            }
+            if (!personalizationStrategyParams.facetScoring) {
+                throw new Error('Parameter `personalizationStrategyParams.facetScoring` is required when calling `setPersonalizationStrategy`.');
+            }
+            if (!personalizationStrategyParams.personalizationImpact) {
+                throw new Error('Parameter `personalizationStrategyParams.personalizationImpact` is required when calling `setPersonalizationStrategy`.');
+            }
+            const requestPath = '/1/strategies/personalization';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: personalizationStrategyParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
+}
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion$1 = '5.0.0-alpha.3';
+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 createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
+    const auth = createAuth(appIdOption, apiKeyOption, authMode);
+    const transporter = createTransporter({
+        hosts: getDefaultHosts(appIdOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Search',
+            version: apiClientVersion$1,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * 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 });
+        },
+        /**
+         * Helper: Wait for a task to complete with `indexName` and `taskID`.
+         *
+         * @summary Wait for a task to complete.
+         * @param waitForTaskOptions - The waitForTaskOptions object.
+         * @param waitForTaskOptions.indexName - The `indexName` where the operation was performed.
+         * @param waitForTaskOptions.taskID - The `taskID` returned in the method response.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+         */
+        waitForTask({ indexName, taskID, ...createRetryablePromiseOptions }, requestOptions) {
+            return createRetryablePromise({
+                ...createRetryablePromiseOptions,
+                func: () => this.getTask({ indexName, taskID }, requestOptions),
+                validate: (response) => response.status === 'published',
+            });
+        },
+        /**
+         * Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
+         *
+         * @summary Wait for an API key task to be processed.
+         * @param waitForApiKeyOptions - The waitForApiKeyOptions object.
+         * @param waitForApiKeyOptions.operation - The `operation` that was done on a `key`.
+         * @param waitForApiKeyOptions.key - The `key` that has been added, deleted or updated.
+         * @param waitForApiKeyOptions.apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.
+         * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getApikey` method and merged with the transporter requestOptions.
+         */
+        waitForApiKey({ operation, key, apiKey, ...createRetryablePromiseOptions }, requestOptions) {
+            if (operation === 'update') {
+                if (!apiKey) {
+                    throw new Error('`apiKey` is required when waiting for an `update` operation.');
+                }
+                return createRetryablePromise({
+                    ...createRetryablePromiseOptions,
+                    func: () => this.getApiKey({ key }, requestOptions),
+                    validate: (response) => {
+                        for (const field of Object.keys(apiKey)) {
+                            if (Array.isArray(apiKey[field])) {
+                                if (apiKey[field].length !== response[field].length ||
+                                    apiKey[field].some((value, index) => value !== response[field][index])) {
+                                    return false;
+                                }
+                            }
+                            else if (response[field] !== apiKey[field]) {
+                                return false;
+                            }
+                        }
+                        return true;
+                    },
+                });
+            }
+            return createRetryablePromise({
+                ...createRetryablePromiseOptions,
+                func: () => this.getApiKey({ key }, requestOptions).catch((error) => error),
+                validate: (error) => operation === 'add' ? error.status !== 404 : error.status === 404,
+            });
+        },
+        /**
+         * Add a new API Key with specific permissions/restrictions.
+         *
+         * @summary Create an API key.
+         * @param apiKey - The apiKey object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        addApiKey(apiKey, requestOptions) {
+            if (!apiKey) {
+                throw new Error('Parameter `apiKey` is required when calling `addApiKey`.');
+            }
+            if (!apiKey.acl) {
+                throw new Error('Parameter `apiKey.acl` is required when calling `addApiKey`.');
+            }
+            const requestPath = '/1/keys';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: apiKey,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Add or replace an object with a given object ID. If the object does not exist, it will be created. If it already exists, it will be replaced.
+         *
+         * @summary Add or replace an object.
+         * @param addOrUpdateObject - The addOrUpdateObject object.
+         * @param addOrUpdateObject.indexName - The index in which to perform the request.
+         * @param addOrUpdateObject.objectID - Unique identifier of an object.
+         * @param addOrUpdateObject.body - The Algolia object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        addOrUpdateObject({ indexName, objectID, body }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `addOrUpdateObject`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `addOrUpdateObject`.');
+            }
+            if (!body) {
+                throw new Error('Parameter `body` is required when calling `addOrUpdateObject`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Add a single source to the list of allowed sources.
+         *
+         * @summary Add a single source.
+         * @param source - The source to add.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        appendSource(source, requestOptions) {
+            if (!source) {
+                throw new Error('Parameter `source` is required when calling `appendSource`.');
+            }
+            const requestPath = '/1/security/sources/append';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: source,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Assign or Move a userID to a cluster. The time it takes to migrate (move) a user is proportional to the amount of data linked to the userID. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userID is directly usable.
+         *
+         * @summary Assign or Move userID.
+         * @param assignUserId - The assignUserId object.
+         * @param assignUserId.xAlgoliaUserID - UserID to assign.
+         * @param assignUserId.assignUserIdParams - The assignUserIdParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        assignUserId({ xAlgoliaUserID, assignUserIdParams }, requestOptions) {
+            if (!xAlgoliaUserID) {
+                throw new Error('Parameter `xAlgoliaUserID` is required when calling `assignUserId`.');
+            }
+            if (!assignUserIdParams) {
+                throw new Error('Parameter `assignUserIdParams` is required when calling `assignUserId`.');
+            }
+            if (!assignUserIdParams.cluster) {
+                throw new Error('Parameter `assignUserIdParams.cluster` is required when calling `assignUserId`.');
+            }
+            const requestPath = '/1/clusters/mapping';
+            const headers = {};
+            const queryParameters = {};
+            if (xAlgoliaUserID !== undefined) {
+                headers['X-Algolia-User-ID'] = xAlgoliaUserID.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: assignUserIdParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform multiple write operations targeting one index, in a single API call.
+         *
+         * @summary Batch operations to one index.
+         * @param batch - The batch object.
+         * @param batch.indexName - The index in which to perform the request.
+         * @param batch.batchWriteParams - The batchWriteParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        batch({ indexName, batchWriteParams }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `batch`.');
+            }
+            if (!batchWriteParams) {
+                throw new Error('Parameter `batchWriteParams` is required when calling `batch`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/batch'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: batchWriteParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Assign multiple userIDs to a cluster. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.
+         *
+         * @summary Batch assign userIDs.
+         * @param batchAssignUserIds - The batchAssignUserIds object.
+         * @param batchAssignUserIds.xAlgoliaUserID - UserID to assign.
+         * @param batchAssignUserIds.batchAssignUserIdsParams - The batchAssignUserIdsParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        batchAssignUserIds({ xAlgoliaUserID, batchAssignUserIdsParams }, requestOptions) {
+            if (!xAlgoliaUserID) {
+                throw new Error('Parameter `xAlgoliaUserID` is required when calling `batchAssignUserIds`.');
+            }
+            if (!batchAssignUserIdsParams) {
+                throw new Error('Parameter `batchAssignUserIdsParams` is required when calling `batchAssignUserIds`.');
+            }
+            if (!batchAssignUserIdsParams.cluster) {
+                throw new Error('Parameter `batchAssignUserIdsParams.cluster` is required when calling `batchAssignUserIds`.');
+            }
+            if (!batchAssignUserIdsParams.users) {
+                throw new Error('Parameter `batchAssignUserIdsParams.users` is required when calling `batchAssignUserIds`.');
+            }
+            const requestPath = '/1/clusters/mapping/batch';
+            const headers = {};
+            const queryParameters = {};
+            if (xAlgoliaUserID !== undefined) {
+                headers['X-Algolia-User-ID'] = xAlgoliaUserID.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: batchAssignUserIdsParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Send a batch of dictionary entries.
+         *
+         * @summary Batch dictionary entries.
+         * @param batchDictionaryEntries - The batchDictionaryEntries object.
+         * @param batchDictionaryEntries.dictionaryName - The dictionary to search in.
+         * @param batchDictionaryEntries.batchDictionaryEntriesParams - The batchDictionaryEntriesParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        batchDictionaryEntries({ dictionaryName, batchDictionaryEntriesParams, }, requestOptions) {
+            if (!dictionaryName) {
+                throw new Error('Parameter `dictionaryName` is required when calling `batchDictionaryEntries`.');
+            }
+            if (!batchDictionaryEntriesParams) {
+                throw new Error('Parameter `batchDictionaryEntriesParams` is required when calling `batchDictionaryEntries`.');
+            }
+            if (!batchDictionaryEntriesParams.requests) {
+                throw new Error('Parameter `batchDictionaryEntriesParams.requests` is required when calling `batchDictionaryEntries`.');
+            }
+            const requestPath = '/1/dictionaries/{dictionaryName}/batch'.replace('{dictionaryName}', encodeURIComponent(dictionaryName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: batchDictionaryEntriesParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allows you to retrieve all index content. It can retrieve up to 1,000 records per call and supports full text search and filters. For performance reasons, some features are not supported, including `distinct`, sorting by `typos`, `words` or `geo distance`. When there is more content to be browsed, the response contains a cursor field. This cursor has to be passed to the subsequent call to browse in order to get the next page of results. When the end of the index has been reached, the cursor field is absent from the response.
+         *
+         * @summary Retrieve all index content.
+         * @param browse - The browse object.
+         * @param browse.indexName - The index in which to perform the request.
+         * @param browse.browseRequest - The browseRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        browse({ indexName, browseRequest }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `browse`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/browse'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: browseRequest ? browseRequest : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Remove all synonyms from an index.
+         *
+         * @summary Clear all synonyms.
+         * @param clearAllSynonyms - The clearAllSynonyms object.
+         * @param clearAllSynonyms.indexName - The index in which to perform the request.
+         * @param clearAllSynonyms.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        clearAllSynonyms({ indexName, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `clearAllSynonyms`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete an index\'s content, but leave settings and index-specific API keys untouched.
+         *
+         * @summary Clear all objects from an index.
+         * @param clearObjects - The clearObjects object.
+         * @param clearObjects.indexName - The index in which to perform the request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        clearObjects({ indexName }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `clearObjects`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete all Rules in the index.
+         *
+         * @summary Clear Rules.
+         * @param clearRules - The clearRules object.
+         * @param clearRules.indexName - The index in which to perform the request.
+         * @param clearRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        clearRules({ indexName, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `clearRules`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/clear'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'POST',
+                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 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);
+        },
+        /**
+         * Delete an existing API Key.
+         *
+         * @summary Delete an API key.
+         * @param deleteApiKey - The deleteApiKey object.
+         * @param deleteApiKey.key - API Key string.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteApiKey({ key }, requestOptions) {
+            if (!key) {
+                throw new Error('Parameter `key` is required when calling `deleteApiKey`.');
+            }
+            const requestPath = '/1/keys/{key}'.replace('{key}', encodeURIComponent(key));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Remove all objects matching a filter (including geo filters). This method enables you to delete one or more objects based on filters (numeric, facet, tag or geo queries). It doesn\'t accept empty filters or a query.
+         *
+         * @summary Delete all records matching the query.
+         * @param deleteBy - The deleteBy object.
+         * @param deleteBy.indexName - The index in which to perform the request.
+         * @param deleteBy.searchParams - The searchParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteBy({ indexName, searchParams }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteBy`.');
+            }
+            if (!searchParams) {
+                throw new Error('Parameter `searchParams` is required when calling `deleteBy`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/deleteByQuery'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete an existing index.
+         *
+         * @summary Delete index.
+         * @param deleteIndex - The deleteIndex object.
+         * @param deleteIndex.indexName - The index in which to perform the request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteIndex({ indexName }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteIndex`.');
+            }
+            const requestPath = '/1/indexes/{indexName}'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete an existing object.
+         *
+         * @summary Delete an object.
+         * @param deleteObject - The deleteObject object.
+         * @param deleteObject.indexName - The index in which to perform the request.
+         * @param deleteObject.objectID - Unique identifier of an object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteObject({ indexName, objectID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteObject`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `deleteObject`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete the Rule with the specified objectID.
+         *
+         * @summary Delete a rule.
+         * @param deleteRule - The deleteRule object.
+         * @param deleteRule.indexName - The index in which to perform the request.
+         * @param deleteRule.objectID - Unique identifier of an object.
+         * @param deleteRule.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteRule({ indexName, objectID, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteRule`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `deleteRule`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Remove a single source from the list of allowed sources.
+         *
+         * @summary Remove a single source.
+         * @param deleteSource - The deleteSource object.
+         * @param deleteSource.source - The IP range of the source.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteSource({ source }, requestOptions) {
+            if (!source) {
+                throw new Error('Parameter `source` is required when calling `deleteSource`.');
+            }
+            const requestPath = '/1/security/sources/{source}'.replace('{source}', encodeURIComponent(source));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Delete a single synonyms set, identified by the given objectID.
+         *
+         * @summary Delete synonym.
+         * @param deleteSynonym - The deleteSynonym object.
+         * @param deleteSynonym.indexName - The index in which to perform the request.
+         * @param deleteSynonym.objectID - Unique identifier of an object.
+         * @param deleteSynonym.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        deleteSynonym({ indexName, objectID, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `deleteSynonym`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `deleteSynonym`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            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);
+        },
+        /**
+         * Get the permissions of an API key.
+         *
+         * @summary Get an API key.
+         * @param getApiKey - The getApiKey object.
+         * @param getApiKey.key - API Key string.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getApiKey({ key }, requestOptions) {
+            if (!key) {
+                throw new Error('Parameter `key` is required when calling `getApiKey`.');
+            }
+            const requestPath = '/1/keys/{key}'.replace('{key}', encodeURIComponent(key));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List dictionaries supported per language.
+         *
+         * @summary List available languages.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getDictionaryLanguages(requestOptions) {
+            const requestPath = '/1/dictionaries/*/languages';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieve dictionaries settings. The API stores languages whose standard entries are disabled. Fetch settings does not return false values.
+         *
+         * @summary Retrieve dictionaries settings.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getDictionarySettings(requestOptions) {
+            const requestPath = '/1/dictionaries/*/settings';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Return the latest log entries.
+         *
+         * @summary Return the latest log entries.
+         * @param getLogs - The getLogs object.
+         * @param getLogs.offset - First entry to retrieve (zero-based). Log entries are sorted by decreasing date, therefore 0 designates the most recent log entry.
+         * @param getLogs.length - Maximum number of entries to retrieve. The maximum allowed value is 1000.
+         * @param getLogs.indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved across all indices.
+         * @param getLogs.type - Type of log entries to retrieve. When omitted, all log entries are retrieved.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getLogs({ offset, length, indexName, type }, requestOptions) {
+            const requestPath = '/1/logs';
+            const headers = {};
+            const queryParameters = {};
+            if (offset !== undefined) {
+                queryParameters.offset = offset.toString();
+            }
+            if (length !== undefined) {
+                queryParameters.length = length.toString();
+            }
+            if (indexName !== undefined) {
+                queryParameters.indexName = indexName.toString();
+            }
+            if (type !== undefined) {
+                queryParameters.type = type.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieve one object from the index.
+         *
+         * @summary Retrieve an object.
+         * @param getObject - The getObject object.
+         * @param getObject.indexName - The index in which to perform the request.
+         * @param getObject.objectID - Unique identifier of an object.
+         * @param getObject.attributesToRetrieve - List of attributes to retrieve. If not specified, all retrievable attributes are returned.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getObject({ indexName, objectID, attributesToRetrieve }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getObject`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `getObject`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (attributesToRetrieve !== undefined) {
+                queryParameters.attributesToRetrieve = attributesToRetrieve.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieve one or more objects, potentially from different indices, in a single API call.
+         *
+         * @summary Retrieve one or more objects.
+         * @param getObjectsParams - The Algolia object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getObjects(getObjectsParams, requestOptions) {
+            if (!getObjectsParams) {
+                throw new Error('Parameter `getObjectsParams` is required when calling `getObjects`.');
+            }
+            const requestPath = '/1/indexes/*/objects';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: getObjectsParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieve the Rule with the specified objectID.
+         *
+         * @summary Get a rule.
+         * @param getRule - The getRule object.
+         * @param getRule.indexName - The index in which to perform the request.
+         * @param getRule.objectID - Unique identifier of an object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRule({ indexName, objectID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getRule`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `getRule`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieve settings of an index.
+         *
+         * @summary Retrieve settings of an index.
+         * @param getSettings - The getSettings object.
+         * @param getSettings.indexName - The index in which to perform the request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSettings({ indexName }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getSettings`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/settings'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List all allowed sources.
+         *
+         * @summary List all allowed sources.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSources(requestOptions) {
+            const requestPath = '/1/security/sources';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Fetch a synonym object identified by its objectID.
+         *
+         * @summary Get synonym.
+         * @param getSynonym - The getSynonym object.
+         * @param getSynonym.indexName - The index in which to perform the request.
+         * @param getSynonym.objectID - Unique identifier of an object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getSynonym({ indexName, objectID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getSynonym`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `getSynonym`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Check the current status of a given task.
+         *
+         * @summary Check the status of a task.
+         * @param getTask - The getTask object.
+         * @param getTask.indexName - The index in which to perform the request.
+         * @param getTask.taskID - Unique identifier of an task. Numeric value (up to 64bits).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTask({ indexName, taskID }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `getTask`.');
+            }
+            if (!taskID) {
+                throw new Error('Parameter `taskID` is required when calling `getTask`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/task/{taskID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{taskID}', encodeURIComponent(taskID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Get the top 10 userIDs with the highest number of records per cluster. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following array of userIDs and clusters.
+         *
+         * @summary Get top userID.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopUserIds(requestOptions) {
+            const requestPath = '/1/clusters/mapping/top';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Returns the userID data stored in the mapping. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userID data.
+         *
+         * @summary Get userID.
+         * @param getUserId - The getUserId object.
+         * @param getUserId.userID - UserID to assign.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getUserId({ userID }, requestOptions) {
+            if (!userID) {
+                throw new Error('Parameter `userID` is required when calling `getUserId`.');
+            }
+            const requestPath = '/1/clusters/mapping/{userID}'.replace('{userID}', encodeURIComponent(userID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Get the status of your clusters\' migrations or user creations. Creating a large batch of users or migrating your multi-cluster may take quite some time. This method lets you retrieve the status of the migration, so you can know when it\'s done. Upon success, the response is 200 OK. A successful response indicates that the operation has been taken into account, and the userIDs are directly usable.
+         *
+         * @summary Get migration status.
+         * @param hasPendingMappings - The hasPendingMappings object.
+         * @param hasPendingMappings.getClusters - If the clusters pending mapping state should be on the response.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        hasPendingMappings({ getClusters }, requestOptions) {
+            const requestPath = '/1/clusters/mapping/pending';
+            const headers = {};
+            const queryParameters = {};
+            if (getClusters !== undefined) {
+                queryParameters.getClusters = getClusters.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List API keys, along with their associated rights.
+         *
+         * @summary List API Keys.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        listApiKeys(requestOptions) {
+            const requestPath = '/1/keys';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List the clusters available in a multi-clusters setup for a single appID. Upon success, the response is 200 OK and contains the following clusters.
+         *
+         * @summary List clusters.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        listClusters(requestOptions) {
+            const requestPath = '/1/clusters';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List existing indexes from an application.
+         *
+         * @summary List existing indexes.
+         * @param listIndices - The listIndices object.
+         * @param listIndices.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        listIndices({ page }, requestOptions) {
+            const requestPath = '/1/indexes';
+            const headers = {};
+            const queryParameters = {};
+            if (page !== undefined) {
+                queryParameters.page = page.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * List the userIDs assigned to a multi-clusters appID. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds to propagate to the different clusters. Upon success, the response is 200 OK and contains the following userIDs data.
+         *
+         * @summary List userIDs.
+         * @param listUserIds - The listUserIds object.
+         * @param listUserIds.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+         * @param listUserIds.hitsPerPage - Maximum number of objects to retrieve.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        listUserIds({ page, hitsPerPage }, requestOptions) {
+            const requestPath = '/1/clusters/mapping';
+            const headers = {};
+            const queryParameters = {};
+            if (page !== undefined) {
+                queryParameters.page = page.toString();
+            }
+            if (hitsPerPage !== undefined) {
+                queryParameters.hitsPerPage = hitsPerPage.toString();
+            }
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform multiple write operations, potentially targeting multiple indices, in a single API call.
+         *
+         * @summary Batch operations to many indices.
+         * @param batchParams - The batchParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        multipleBatch(batchParams, requestOptions) {
+            if (!batchParams) {
+                throw new Error('Parameter `batchParams` is required when calling `multipleBatch`.');
+            }
+            const requestPath = '/1/indexes/*/batch';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: batchParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Performs a copy or a move operation on a index.
+         *
+         * @summary Copy/move index.
+         * @param operationIndex - The operationIndex object.
+         * @param operationIndex.indexName - The index in which to perform the request.
+         * @param operationIndex.operationIndexParams - The operationIndexParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        operationIndex({ indexName, operationIndexParams }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `operationIndex`.');
+            }
+            if (!operationIndexParams) {
+                throw new Error('Parameter `operationIndexParams` is required when calling `operationIndex`.');
+            }
+            if (!operationIndexParams.operation) {
+                throw new Error('Parameter `operationIndexParams.operation` is required when calling `operationIndex`.');
+            }
+            if (!operationIndexParams.destination) {
+                throw new Error('Parameter `operationIndexParams.destination` is required when calling `operationIndex`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/operation'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: operationIndexParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Update one or more attributes of an existing object. This method lets you update only a part of an existing object, either by adding new attributes or updating existing ones. You can partially update several objects in a single method call. If the index targeted by this operation doesn\'t exist yet, it\'s automatically created.
+         *
+         * @summary Partially update an object.
+         * @param partialUpdateObject - The partialUpdateObject object.
+         * @param partialUpdateObject.indexName - The index in which to perform the request.
+         * @param partialUpdateObject.objectID - Unique identifier of an object.
+         * @param partialUpdateObject.attributeOrBuiltInOperation - List of attributes to update.
+         * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        partialUpdateObject({ indexName, objectID, attributeOrBuiltInOperation, createIfNotExists, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `partialUpdateObject`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `partialUpdateObject`.');
+            }
+            if (!attributeOrBuiltInOperation) {
+                throw new Error('Parameter `attributeOrBuiltInOperation` is required when calling `partialUpdateObject`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/{objectID}/partial'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (createIfNotExists !== undefined) {
+                queryParameters.createIfNotExists = createIfNotExists.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: attributeOrBuiltInOperation,
+            };
+            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);
+        },
+        /**
+         * Remove a userID and its associated data from the multi-clusters. Upon success, the response is 200 OK and a task is created to remove the userID data and mapping.
+         *
+         * @summary Remove userID.
+         * @param removeUserId - The removeUserId object.
+         * @param removeUserId.userID - UserID to assign.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        removeUserId({ userID }, requestOptions) {
+            if (!userID) {
+                throw new Error('Parameter `userID` is required when calling `removeUserId`.');
+            }
+            const requestPath = '/1/clusters/mapping/{userID}'.replace('{userID}', encodeURIComponent(userID));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Replace all allowed sources.
+         *
+         * @summary Replace all allowed sources.
+         * @param replaceSources - The replaceSources object.
+         * @param replaceSources.source - The sources to allow.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        replaceSources({ source }, requestOptions) {
+            if (!source) {
+                throw new Error('Parameter `source` is required when calling `replaceSources`.');
+            }
+            const requestPath = '/1/security/sources';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: source,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Restore a deleted API key, along with its associated rights.
+         *
+         * @summary Restore an API key.
+         * @param restoreApiKey - The restoreApiKey object.
+         * @param restoreApiKey.key - API Key string.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        restoreApiKey({ key }, requestOptions) {
+            if (!key) {
+                throw new Error('Parameter `key` is required when calling `restoreApiKey`.');
+            }
+            const requestPath = '/1/keys/{key}/restore'.replace('{key}', encodeURIComponent(key));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Add an object to the index, automatically assigning it an object ID.
+         *
+         * @summary Add an object to the index.
+         * @param saveObject - The saveObject object.
+         * @param saveObject.indexName - The index in which to perform the request.
+         * @param saveObject.body - The Algolia record.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        saveObject({ indexName, body }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `saveObject`.');
+            }
+            if (!body) {
+                throw new Error('Parameter `body` is required when calling `saveObject`.');
+            }
+            const requestPath = '/1/indexes/{indexName}'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Create or update the Rule with the specified objectID.
+         *
+         * @summary Save/Update a rule.
+         * @param saveRule - The saveRule object.
+         * @param saveRule.indexName - The index in which to perform the request.
+         * @param saveRule.objectID - Unique identifier of an object.
+         * @param saveRule.rule - The rule object.
+         * @param saveRule.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        saveRule({ indexName, objectID, rule, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `saveRule`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `saveRule`.');
+            }
+            if (!rule) {
+                throw new Error('Parameter `rule` is required when calling `saveRule`.');
+            }
+            if (!rule.objectID) {
+                throw new Error('Parameter `rule.objectID` is required when calling `saveRule`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: rule,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Create/update multiple rules objects at once.
+         *
+         * @summary Save a batch of rules.
+         * @param saveRules - The saveRules object.
+         * @param saveRules.indexName - The index in which to perform the request.
+         * @param saveRules.rule - The rule object.
+         * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        saveRules({ indexName, rule, forwardToReplicas, clearExistingRules, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `saveRules`.');
+            }
+            if (!rule) {
+                throw new Error('Parameter `rule` is required when calling `saveRules`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/batch'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            if (clearExistingRules !== undefined) {
+                queryParameters.clearExistingRules = clearExistingRules.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: rule,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Create a new synonym object or update the existing synonym object with the given object ID.
+         *
+         * @summary Save synonym.
+         * @param saveSynonym - The saveSynonym object.
+         * @param saveSynonym.indexName - The index in which to perform the request.
+         * @param saveSynonym.objectID - Unique identifier of an object.
+         * @param saveSynonym.synonymHit - The synonymHit object.
+         * @param saveSynonym.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        saveSynonym({ indexName, objectID, synonymHit, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `saveSynonym`.');
+            }
+            if (!objectID) {
+                throw new Error('Parameter `objectID` is required when calling `saveSynonym`.');
+            }
+            if (!synonymHit) {
+                throw new Error('Parameter `synonymHit` is required when calling `saveSynonym`.');
+            }
+            if (!synonymHit.objectID) {
+                throw new Error('Parameter `synonymHit.objectID` is required when calling `saveSynonym`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/{objectID}'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{objectID}', encodeURIComponent(objectID));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: synonymHit,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Create/update multiple synonym objects at once, potentially replacing the entire list of synonyms if replaceExistingSynonyms is true.
+         *
+         * @summary Save a batch of synonyms.
+         * @param saveSynonyms - The saveSynonyms object.
+         * @param saveSynonyms.indexName - The index in which to perform the request.
+         * @param saveSynonyms.synonymHit - The synonymHit object.
+         * @param saveSynonyms.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param saveSynonyms.replaceExistingSynonyms - Replace all synonyms of the index with the ones sent with this request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        saveSynonyms({ indexName, synonymHit, forwardToReplicas, replaceExistingSynonyms, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `saveSynonyms`.');
+            }
+            if (!synonymHit) {
+                throw new Error('Parameter `synonymHit` is required when calling `saveSynonyms`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/batch'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            if (replaceExistingSynonyms !== undefined) {
+                queryParameters.replaceExistingSynonyms =
+                    replaceExistingSynonyms.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: synonymHit,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform a search operation targeting one or many indices.
+         *
+         * @summary Search multiple indices.
+         * @param searchMethodParams - The `search` requests and strategy.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        search(searchMethodParams, requestOptions) {
+            if (searchMethodParams && Array.isArray(searchMethodParams)) {
+                const newSignatureRequest = {
+                    requests: searchMethodParams.map(({ params, ...legacyRequest }) => {
+                        if (legacyRequest.type === 'facet') {
+                            return {
+                                ...legacyRequest,
+                                ...params,
+                                type: 'facet',
+                            };
+                        }
+                        return {
+                            ...legacyRequest,
+                            ...params,
+                            facet: undefined,
+                            maxFacetHits: undefined,
+                            facetQuery: undefined,
+                        };
+                    }),
+                };
+                // eslint-disable-next-line no-param-reassign
+                searchMethodParams = newSignatureRequest;
+            }
+            if (!searchMethodParams) {
+                throw new Error('Parameter `searchMethodParams` is required when calling `search`.');
+            }
+            if (!searchMethodParams.requests) {
+                throw new Error('Parameter `searchMethodParams.requests` is required when calling `search`.');
+            }
+            const requestPath = '/1/indexes/*/queries';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchMethodParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Search the dictionary entries.
+         *
+         * @summary Search a dictionary entries.
+         * @param searchDictionaryEntries - The searchDictionaryEntries object.
+         * @param searchDictionaryEntries.dictionaryName - The dictionary to search in.
+         * @param searchDictionaryEntries.searchDictionaryEntriesParams - The searchDictionaryEntriesParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchDictionaryEntries({ dictionaryName, searchDictionaryEntriesParams, }, requestOptions) {
+            if (!dictionaryName) {
+                throw new Error('Parameter `dictionaryName` is required when calling `searchDictionaryEntries`.');
+            }
+            if (!searchDictionaryEntriesParams) {
+                throw new Error('Parameter `searchDictionaryEntriesParams` is required when calling `searchDictionaryEntries`.');
+            }
+            if (!searchDictionaryEntriesParams.query) {
+                throw new Error('Parameter `searchDictionaryEntriesParams.query` is required when calling `searchDictionaryEntries`.');
+            }
+            const requestPath = '/1/dictionaries/{dictionaryName}/search'.replace('{dictionaryName}', encodeURIComponent(dictionaryName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchDictionaryEntriesParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Search for values of a given facet, optionally restricting the returned values to those contained in objects matching other search criteria.
+         *
+         * @summary Search for values of a given facet.
+         * @param searchForFacetValues - The searchForFacetValues object.
+         * @param searchForFacetValues.indexName - The index in which to perform the request.
+         * @param searchForFacetValues.facetName - The facet name.
+         * @param searchForFacetValues.searchForFacetValuesRequest - The searchForFacetValuesRequest object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchForFacetValues({ indexName, facetName, searchForFacetValuesRequest, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `searchForFacetValues`.');
+            }
+            if (!facetName) {
+                throw new Error('Parameter `facetName` is required when calling `searchForFacetValues`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/facets/{facetName}/query'
+                .replace('{indexName}', encodeURIComponent(indexName))
+                .replace('{facetName}', encodeURIComponent(facetName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchForFacetValuesRequest ? searchForFacetValuesRequest : {},
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Search for rules matching various criteria.
+         *
+         * @summary Search for rules.
+         * @param searchRules - The searchRules object.
+         * @param searchRules.indexName - The index in which to perform the request.
+         * @param searchRules.searchRulesParams - The searchRulesParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchRules({ indexName, searchRulesParams }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `searchRules`.');
+            }
+            if (!searchRulesParams) {
+                throw new Error('Parameter `searchRulesParams` is required when calling `searchRules`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/rules/search'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchRulesParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Perform a search operation targeting one specific index.
+         *
+         * @summary Search in a single index.
+         * @param searchSingleIndex - The searchSingleIndex object.
+         * @param searchSingleIndex.indexName - The index in which to perform the request.
+         * @param searchSingleIndex.searchParams - The searchParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchSingleIndex({ indexName, searchParams }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `searchSingleIndex`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/query'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchParams ? searchParams : {},
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Search or browse all synonyms, optionally filtering them by type.
+         *
+         * @summary Search synonyms.
+         * @param searchSynonyms - The searchSynonyms object.
+         * @param searchSynonyms.indexName - The index in which to perform the request.
+         * @param searchSynonyms.type - Only search for specific types of synonyms.
+         * @param searchSynonyms.page - Requested page (zero-based). When specified, will retrieve a specific page; the page size is implicitly set to 100. When null, will retrieve all indices (no pagination).
+         * @param searchSynonyms.hitsPerPage - Maximum number of objects to retrieve.
+         * @param searchSynonyms.searchSynonymsParams - The body of the the `searchSynonyms` method.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchSynonyms({ indexName, type, page, hitsPerPage, searchSynonymsParams, }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `searchSynonyms`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/synonyms/search'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (type !== undefined) {
+                queryParameters.type = type.toString();
+            }
+            if (page !== undefined) {
+                queryParameters.page = page.toString();
+            }
+            if (hitsPerPage !== undefined) {
+                queryParameters.hitsPerPage = hitsPerPage.toString();
+            }
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchSynonymsParams ? searchSynonymsParams : {},
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Search for userIDs. The data returned will usually be a few seconds behind real time, because userID usage may take up to a few seconds propagate to the different clusters. To keep updates moving quickly, the index of userIDs isn\'t built synchronously with the mapping. Instead, the index is built once every 12h, at the same time as the update of userID usage. For example, when you perform a modification like adding or moving a userID, the search will report an outdated value until the next rebuild of the mapping, which takes place every 12h. Upon success, the response is 200 OK and contains the following userIDs data.
+         *
+         * @summary Search userID.
+         * @param searchUserIdsParams - The searchUserIdsParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        searchUserIds(searchUserIdsParams, requestOptions) {
+            if (!searchUserIdsParams) {
+                throw new Error('Parameter `searchUserIdsParams` is required when calling `searchUserIds`.');
+            }
+            if (!searchUserIdsParams.query) {
+                throw new Error('Parameter `searchUserIdsParams.query` is required when calling `searchUserIds`.');
+            }
+            const requestPath = '/1/clusters/mapping/search';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: searchUserIdsParams,
+                useReadTransporter: true,
+                cacheable: true,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Set dictionaries settings.
+         *
+         * @summary Set dictionaries settings.
+         * @param dictionarySettingsParams - The dictionarySettingsParams object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        setDictionarySettings(dictionarySettingsParams, requestOptions) {
+            if (!dictionarySettingsParams) {
+                throw new Error('Parameter `dictionarySettingsParams` is required when calling `setDictionarySettings`.');
+            }
+            if (!dictionarySettingsParams.disableStandardEntries) {
+                throw new Error('Parameter `dictionarySettingsParams.disableStandardEntries` is required when calling `setDictionarySettings`.');
+            }
+            const requestPath = '/1/dictionaries/*/settings';
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: dictionarySettingsParams,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Update settings of an index. Only specified settings are overridden; unspecified settings are left unchanged. Specifying null for a setting resets it to its default value.
+         *
+         * @summary Update settings of an index.
+         * @param setSettings - The setSettings object.
+         * @param setSettings.indexName - The index in which to perform the request.
+         * @param setSettings.indexSettings - The indexSettings object.
+         * @param setSettings.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        setSettings({ indexName, indexSettings, forwardToReplicas }, requestOptions) {
+            if (!indexName) {
+                throw new Error('Parameter `indexName` is required when calling `setSettings`.');
+            }
+            if (!indexSettings) {
+                throw new Error('Parameter `indexSettings` is required when calling `setSettings`.');
+            }
+            const requestPath = '/1/indexes/{indexName}/settings'.replace('{indexName}', encodeURIComponent(indexName));
+            const headers = {};
+            const queryParameters = {};
+            if (forwardToReplicas !== undefined) {
+                queryParameters.forwardToReplicas = forwardToReplicas.toString();
+            }
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: indexSettings,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Replace every permission of an existing API key.
+         *
+         * @summary Update an API key.
+         * @param updateApiKey - The updateApiKey object.
+         * @param updateApiKey.key - API Key string.
+         * @param updateApiKey.apiKey - The apiKey object.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        updateApiKey({ key, apiKey }, requestOptions) {
+            if (!key) {
+                throw new Error('Parameter `key` is required when calling `updateApiKey`.');
+            }
+            if (!apiKey) {
+                throw new Error('Parameter `apiKey` is required when calling `updateApiKey`.');
+            }
+            if (!apiKey.acl) {
+                throw new Error('Parameter `apiKey.acl` is required when calling `updateApiKey`.');
+            }
+            const requestPath = '/1/keys/{key}'.replace('{key}', encodeURIComponent(key));
+            const headers = {};
+            const queryParameters = {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: apiKey,
+            };
+            return transporter.request(request, requestOptions);
+        },
+    };
+}
+
+// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+const apiClientVersion = apiClientVersion$1;
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function algoliasearch(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.');
+    }
+    const commonOptions = {
+        apiKey,
+        appId,
+        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,
+    };
+    function initAnalytics(initOptions = {}) {
+        if (initOptions.region &&
+            (typeof initOptions.region !== 'string' ||
+                !REGIONS$1.includes(initOptions.region))) {
+            throw new Error(`\`region\` must be one of the following: ${REGIONS$1.join(', ')}`);
+        }
+        return createAnalyticsClient({
+            ...commonOptions,
+            ...initOptions.options,
+            ...initOptions,
+        });
+    }
+    function initAbtesting(initOptions = {}) {
+        if (initOptions.region &&
+            (typeof initOptions.region !== 'string' ||
+                !REGIONS$2.includes(initOptions.region))) {
+            throw new Error(`\`region\` must be one of the following: ${REGIONS$2.join(', ')}`);
+        }
+        return createAbtestingClient({
+            ...commonOptions,
+            ...initOptions.options,
+            ...initOptions,
+        });
+    }
+    function initPersonalization(initOptions) {
+        if (!initOptions.region) {
+            throw new Error('`region` is missing.');
+        }
+        if (initOptions.region &&
+            (typeof initOptions.region !== 'string' ||
+                !REGIONS.includes(initOptions.region))) {
+            throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+        }
+        return createPersonalizationClient({
+            ...commonOptions,
+            ...initOptions.options,
+            ...initOptions,
+        });
+    }
+    return {
+        ...createSearchClient(commonOptions),
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return this.transporter.algoliaAgent.value;
+        },
+        initAnalytics,
+        initPersonalization,
+        initAbtesting,
+    };
+}
+
+export { algoliasearch, apiClientVersion };