@algolia/client-analytics 5.0.0-alpha.11 → 5.0.0-alpha.110

package/dist/client-analytics.esm.node.js

@@ -1,930 +1,1091 @@
 import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT_NODE, DEFAULT_READ_TIMEOUT_NODE, DEFAULT_WRITE_TIMEOUT_NODE, createNullCache, createMemoryCache } from '@algolia/client-common';
 import { createHttpRequester } from '@algolia/requester-node-http';
 
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-const apiClientVersion = '5.0.0-alpha.11';
-const REGIONS = ['de', 'us'];
-function getDefaultHosts(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(regionOption),
-        ...options,
-        algoliaAgent: getAlgoliaAgent({
-            algoliaAgents,
-            client: 'Analytics',
-            version: apiClientVersion,
-        }),
-        baseHeaders: {
-            'content-type': 'text/plain',
-            ...auth.headers(),
-            ...options.baseHeaders,
-        },
-        baseQueryParameters: {
-            ...auth.queryParameters(),
-            ...options.baseQueryParameters,
-        },
-    });
-    return {
-        transporter,
-        /**
-         * The `appId` currently in use.
-         */
-        appId: appIdOption,
-        /**
-         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
-         */
-        clearCache() {
-            return Promise.all([
-                transporter.requestsCache.clear(),
-                transporter.responsesCache.clear(),
-            ]).then(() => undefined);
-        },
-        /**
-         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
-         */
-        get _ua() {
-            return transporter.algoliaAgent.value;
-        },
-        /**
-         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
-         *
-         * @param segment - The algolia agent (user-agent) segment to add.
-         * @param version - The version of the agent.
-         */
-        addAlgoliaAgent(segment, version) {
-            transporter.algoliaAgent.add({ segment, version });
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param del - The del object.
-         * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param del.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        del({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'DELETE',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-         * @param get.parameters - Query parameters to be applied to the current query.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        get({ path, parameters }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * Returns 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);
-        },
-    };
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+const apiClientVersion = '5.0.0-alpha.110';
+const REGIONS = ['de', 'us'];
+function getDefaultHosts(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(regionOption),
+        ...options,
+        algoliaAgent: getAlgoliaAgent({
+            algoliaAgents,
+            client: 'Analytics',
+            version: apiClientVersion,
+        }),
+        baseHeaders: {
+            'content-type': 'text/plain',
+            ...auth.headers(),
+            ...options.baseHeaders,
+        },
+        baseQueryParameters: {
+            ...auth.queryParameters(),
+            ...options.baseQueryParameters,
+        },
+    });
+    return {
+        transporter,
+        /**
+         * The `appId` currently in use.
+         */
+        appId: appIdOption,
+        /**
+         * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+         */
+        clearCache() {
+            return Promise.all([
+                transporter.requestsCache.clear(),
+                transporter.responsesCache.clear(),
+            ]).then(() => undefined);
+        },
+        /**
+         * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+         */
+        get _ua() {
+            return transporter.algoliaAgent.value;
+        },
+        /**
+         * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+         *
+         * @param segment - The algolia agent (user-agent) segment to add.
+         * @param version - The version of the agent.
+         */
+        addAlgoliaAgent(segment, version) {
+            transporter.algoliaAgent.add({ segment, version });
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customDelete - The customDelete object.
+         * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customDelete.parameters - Query parameters to apply to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customDelete({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customDelete`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'DELETE',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customGet - The customGet object.
+         * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customGet.parameters - Query parameters to apply to the current query.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customGet({ path, parameters }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customGet`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'GET',
+                path: requestPath,
+                queryParameters,
+                headers,
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPost - The customPost object.
+         * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPost.parameters - Query parameters to apply to the current query.
+         * @param customPost.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPost({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPost`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPut - The customPut object.
+         * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPut.parameters - Query parameters to apply to the current query.
+         * @param customPut.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPut({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPut`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getAddToCartRate - The getAddToCartRate object.
+         * @param getAddToCartRate.index - Index name.
+         * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAddToCartRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getAddToCartRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getAddToCartRate`.');
+            }
+            const requestPath = '/2/conversions/addToCartRate';
+            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);
+        },
+        /**
+         * Retrieves the average click position of your search results, including a daily breakdown.  The average click position is the average of all clicked search results\' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getAverageClickPosition - The getAverageClickPosition object.
+         * @param getAverageClickPosition.index - Index name.
+         * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getAverageClickPosition.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the positions in the search results and their associated number of clicks.  This lets you check how many clicks the first, second, or tenth search results receive.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getClickPositions - The getClickPositions object.
+         * @param getClickPositions.index - Index name.
+         * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickPositions.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getClickThroughRate - The getClickThroughRate object.
+         * @param getClickThroughRate.index - Index name.
+         * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getClickThroughRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getConversionRate - The getConversionRate object.
+         * @param getConversionRate.index - Index name.
+         * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getConversionRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getConversionRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getConversionRate`.');
+            }
+            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);
+        },
+        /**
+         * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getNoClickRate - The getNoClickRate object.
+         * @param getNoClickRate.index - Index name.
+         * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoClickRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getNoResultsRate - The getNoResultsRate object.
+         * @param getNoResultsRate.index - Index name.
+         * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getNoResultsRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getPurchaseRate - The getPurchaseRate object.
+         * @param getPurchaseRate.index - Index name.
+         * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getPurchaseRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getPurchaseRate({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getPurchaseRate`.');
+            }
+            const requestPath = '/2/conversions/purchaseRate';
+            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);
+        },
+        /**
+         * Retrieves revenue-related metrics, such as the total revenue or the average order value.  To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getRevenue - The getRevenue object.
+         * @param getRevenue.index - Index name.
+         * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getRevenue.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getRevenue({ index, startDate, endDate, tags }, requestOptions) {
+            if (!index) {
+                throw new Error('Parameter `index` is required when calling `getRevenue`.');
+            }
+            const requestPath = '/2/conversions/revenue';
+            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);
+        },
+        /**
+         * Retrieves the number of searches within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getSearchesCount - The getSearchesCount object.
+         * @param getSearchesCount.index - Index name.
+         * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getSearchesNoClicks - The getSearchesNoClicks object.
+         * @param getSearchesNoClicks.index - Index name.
+         * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoClicks.limit - Number of items to return.
+         * @param getSearchesNoClicks.offset - Position of the first item to return.
+         * @param getSearchesNoClicks.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the most popular searches that didn\'t return any results.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getSearchesNoResults - The getSearchesNoResults object.
+         * @param getSearchesNoResults.index - Index name.
+         * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getSearchesNoResults.limit - Number of items to return.
+         * @param getSearchesNoResults.offset - Position of the first item to return.
+         * @param getSearchesNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the time when the Analytics data for the specified index was last updated.  The Analytics data is updated every 5 minutes.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getStatus - The getStatus object.
+         * @param getStatus.index - Index name.
+         * @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);
+        },
+        /**
+         * Retrieves the countries with the most searches to your index.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopCountries - The getTopCountries object.
+         * @param getTopCountries.index - Index name.
+         * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopCountries.limit - Number of items to return.
+         * @param getTopCountries.offset - Position of the first item to return.
+         * @param getTopCountries.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopFilterAttributes - The getTopFilterAttributes object.
+         * @param getTopFilterAttributes.index - Index name.
+         * @param getTopFilterAttributes.search - Search query.
+         * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterAttributes.limit - Number of items to return.
+         * @param getTopFilterAttributes.offset - Position of the first item to return.
+         * @param getTopFilterAttributes.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the most frequent filter (facet) values for a filter attribute.  These are attributes of your records that you included in the `attributesForFaceting` setting.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
+         * @param getTopFilterForAttribute.attribute - Attribute name.
+         * @param getTopFilterForAttribute.index - Index name.
+         * @param getTopFilterForAttribute.search - Search query.
+         * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFilterForAttribute.limit - Number of items to return.
+         * @param getTopFilterForAttribute.offset - Position of the first item to return.
+         * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the most frequently used filters for a search that didn\'t return any results.  To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
+         * @param getTopFiltersNoResults.index - Index name.
+         * @param getTopFiltersNoResults.search - Search query.
+         * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopFiltersNoResults.limit - Number of items to return.
+         * @param getTopFiltersNoResults.offset - Position of the first item to return.
+         * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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);
+        },
+        /**
+         * Retrieves the object IDs of the most frequent search results.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopHits - The getTopHits object.
+         * @param getTopHits.index - Index name.
+         * @param getTopHits.search - Search query.
+         * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+         * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+         * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopHits.limit - Number of items to return.
+         * @param getTopHits.offset - Position of the first item to return.
+         * @param getTopHits.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopHits({ index, search, clickAnalytics, revenueAnalytics, 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 (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.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 most popular search terms.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getTopSearches - The getTopSearches object.
+         * @param getTopSearches.index - Index name.
+         * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
+         * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+         * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getTopSearches.orderBy - Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+         * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
+         * @param getTopSearches.limit - Number of items to return.
+         * @param getTopSearches.offset - Position of the first item to return.
+         * @param getTopSearches.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        getTopSearches({ index, clickAnalytics, revenueAnalytics, 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 (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.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);
+        },
+        /**
+         * Retrieves the number of unique users within a time range, including a daily breakdown.  Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.  By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.
+         *
+         * Required API Key ACLs:
+         * - analytics.
+         *
+         * @param getUsersCount - The getUsersCount object.
+         * @param getUsersCount.index - Index name.
+         * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
+         * @param getUsersCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+         * @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 file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
-function analyticsClient(appId, apiKey, region, options) {
-    if (!appId || typeof appId !== 'string') {
-        throw new Error('`appId` is missing.');
-    }
-    if (!apiKey || typeof apiKey !== 'string') {
-        throw new Error('`apiKey` is missing.');
-    }
-    if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
-        throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
-    }
-    return createAnalyticsClient({
-        appId,
-        apiKey,
-        region,
-        timeouts: {
-            connect: DEFAULT_CONNECT_TIMEOUT_NODE,
-            read: DEFAULT_READ_TIMEOUT_NODE,
-            write: DEFAULT_WRITE_TIMEOUT_NODE,
-        },
-        requester: createHttpRequester(),
-        algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
-        responsesCache: createNullCache(),
-        requestsCache: createNullCache(),
-        hostsCache: createMemoryCache(),
-        ...options,
-    });
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+function analyticsClient(appId, apiKey, region, options) {
+    if (!appId || typeof appId !== 'string') {
+        throw new Error('`appId` is missing.');
+    }
+    if (!apiKey || typeof apiKey !== 'string') {
+        throw new Error('`apiKey` is missing.');
+    }
+    if (region && (typeof region !== 'string' || !REGIONS.includes(region))) {
+        throw new Error(`\`region\` must be one of the following: ${REGIONS.join(', ')}`);
+    }
+    return {
+        ...createAnalyticsClient({
+            appId,
+            apiKey,
+            region,
+            timeouts: {
+                connect: DEFAULT_CONNECT_TIMEOUT_NODE,
+                read: DEFAULT_READ_TIMEOUT_NODE,
+                write: DEFAULT_WRITE_TIMEOUT_NODE,
+            },
+            requester: createHttpRequester(),
+            algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
+            responsesCache: createNullCache(),
+            requestsCache: createNullCache(),
+            hostsCache: createMemoryCache(),
+            ...options,
+        }),
+    };
 }
 
 export { analyticsClient, apiClientVersion };