@algolia/client-analytics 5.0.0-alpha.99 → 5.0.0-beta.1

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

@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
 import { createHttpRequester } from '@algolia/requester-node-http';
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '5.0.0-alpha.99';
+const apiClientVersion = '5.0.0-beta.1';
 const REGIONS = ['de', 'us'];
 function getDefaultHosts(region) {
     const url = !region
@@ -64,7 +64,6 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customDelete - The customDelete object.
          * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -74,7 +73,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -88,7 +87,6 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customGet - The customGet object.
          * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customGet.parameters - Query parameters to apply to the current query.
@@ -98,7 +96,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -112,7 +110,6 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPost - The customPost object.
          * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPost.parameters - Query parameters to apply to the current query.
@@ -123,7 +120,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPost`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -138,7 +135,6 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
          * @param customPut - The customPut object.
          * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
          * @param customPut.parameters - Query parameters to apply to the current query.
@@ -149,7 +145,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (!path) {
                 throw new Error('Parameter `path` is required when calling `customPut`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -162,14 +158,56 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the average click position for the complete time range and for individual days. > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+         * 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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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.
          *
-         * @summary Get average click position.
          * @param getAverageClickPosition - The getAverageClickPosition object.
-         * @param getAverageClickPosition.index - Index name to target.
-         * @param getAverageClickPosition.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getAverageClickPosition.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getAverageClickPosition.index - Index name.
+         * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -200,14 +238,16 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Show the number of clicks events and their associated position in the search results.  > **Note**: If all `positions` have a `clickCount` of `0` or `null`, it means Algolia didn\'t receive any click events for tracked searches. A _tracked_ search is a search request where the `clickAnalytics` parameter is `true`.
+         * 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.
          *
-         * @summary Get click positions.
          * @param getClickPositions - The getClickPositions object.
-         * @param getClickPositions.index - Index name to target.
-         * @param getClickPositions.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickPositions.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getClickPositions.index - Index name.
+         * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -238,14 +278,16 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns a [click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+         * 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.
          *
-         * @summary Get click-through rate (CTR).
          * @param getClickThroughRate - The getClickThroughRate object.
-         * @param getClickThroughRate.index - Index name to target.
-         * @param getClickThroughRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getClickThroughRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getClickThroughRate.index - Index name.
+         * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -276,19 +318,21 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return a [conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
-         *
-         * @summary Get conversion rate (CR).
-         * @param getConversationRate - The getConversationRate object.
-         * @param getConversationRate.index - Index name to target.
-         * @param getConversationRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getConversationRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getConversationRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * 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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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.
          */
-        getConversationRate({ index, startDate, endDate, tags }, requestOptions) {
+        getConversionRate({ index, startDate, endDate, tags }, requestOptions) {
             if (!index) {
-                throw new Error('Parameter `index` is required when calling `getConversationRate`.');
+                throw new Error('Parameter `index` is required when calling `getConversionRate`.');
             }
             const requestPath = '/2/conversions/conversionRate';
             const headers = {};
@@ -314,14 +358,16 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the rate at which searches don\'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.
+         * 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.
          *
-         * @summary Get no click rate.
          * @param getNoClickRate - The getNoClickRate object.
-         * @param getNoClickRate.index - Index name to target.
-         * @param getNoClickRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoClickRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getNoClickRate.index - Index name.
+         * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -352,14 +398,16 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the rate at which searches didn\'t return any results.
+         * 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.
          *
-         * @summary Get no results rate.
          * @param getNoResultsRate - The getNoResultsRate object.
-         * @param getNoResultsRate.index - Index name to target.
-         * @param getNoResultsRate.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getNoResultsRate.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getNoResultsRate.index - Index name.
+         * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -390,14 +438,96 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the number of searches within a time range.
+         * 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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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.
          *
-         * @summary Get number of searches.
          * @param getSearchesCount - The getSearchesCount object.
-         * @param getSearchesCount.index - Index name to target.
-         * @param getSearchesCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getSearchesCount.index - Index name.
+         * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -428,16 +558,18 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular of the last 1,000 searches that didn\'t lead to any clicks.
+         * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
+         *
+         * Required API Key ACLs:
+         * - analytics.
          *
-         * @summary Get top searches with no clicks.
          * @param getSearchesNoClicks - The getSearchesNoClicks object.
-         * @param getSearchesNoClicks.index - Index name to target.
-         * @param getSearchesNoClicks.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoClicks.limit - Number of records to return (page size).
-         * @param getSearchesNoClicks.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getSearchesNoClicks.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getSearchesNoClicks.index - Index name.
+         * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -474,16 +606,18 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular of the latest 1,000 searches that didn\'t return any results.
+         * Retrieves the most popular searches that didn\'t return any results.
+         *
+         * Required API Key ACLs:
+         * - analytics.
          *
-         * @summary Get top searches with no results.
          * @param getSearchesNoResults - The getSearchesNoResults object.
-         * @param getSearchesNoResults.index - Index name to target.
-         * @param getSearchesNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getSearchesNoResults.limit - Number of records to return (page size).
-         * @param getSearchesNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getSearchesNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getSearchesNoResults.index - Index name.
+         * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -520,11 +654,13 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the latest update time of the Analytics API for an index. If the index has been recently created or no search has been performed yet, `updatedAt` will be `null`. > **Note**: The Analytics API is updated every 5 minutes.
+         * 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.
          *
-         * @summary Get Analytics API status.
          * @param getStatus - The getStatus object.
-         * @param getStatus.index - Index name to target.
+         * @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) {
@@ -546,16 +682,18 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns top countries. Limited to the 1,000 most frequent ones.
+         * Retrieves the countries with the most searches to your index.
+         *
+         * Required API Key ACLs:
+         * - analytics.
          *
-         * @summary Get top countries.
          * @param getTopCountries - The getTopCountries object.
-         * @param getTopCountries.index - Index name to target.
-         * @param getTopCountries.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopCountries.limit - Number of records to return (page size).
-         * @param getTopCountries.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopCountries.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getTopCountries.index - Index name.
+         * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -592,17 +730,19 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular [filterable attributes](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/) in the 1,000 most recently used filters.
+         * 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.
          *
-         * @summary Get top filterable attributes.
          * @param getTopFilterAttributes - The getTopFilterAttributes object.
-         * @param getTopFilterAttributes.index - Index name to target.
-         * @param getTopFilterAttributes.search - User query.
-         * @param getTopFilterAttributes.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterAttributes.limit - Number of records to return (page size).
-         * @param getTopFilterAttributes.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopFilterAttributes.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getTopFilterAttributes.index - Index name.
+         * @param getTopFilterAttributes.search - Search query.
+         * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -642,18 +782,20 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular filter values for an attribute in the 1,000 most recently used filters.
+         * 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.
          *
-         * @summary Get top filter values for an attribute.
          * @param getTopFilterForAttribute - The getTopFilterForAttribute object.
          * @param getTopFilterForAttribute.attribute - Attribute name.
-         * @param getTopFilterForAttribute.index - Index name to target.
-         * @param getTopFilterForAttribute.search - User query.
-         * @param getTopFilterForAttribute.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFilterForAttribute.limit - Number of records to return (page size).
-         * @param getTopFilterForAttribute.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopFilterForAttribute.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getTopFilterForAttribute.index - Index name.
+         * @param getTopFilterForAttribute.search - Search query.
+         * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -696,17 +838,19 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns top filters for filter-enabled searches that don\'t return results. Limited to the 1,000 most recently used filters.
+         * 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.
          *
-         * @summary Get top filters for a no result search.
          * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
-         * @param getTopFiltersNoResults.index - Index name to target.
-         * @param getTopFiltersNoResults.search - User query.
-         * @param getTopFiltersNoResults.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopFiltersNoResults.limit - Number of records to return (page size).
-         * @param getTopFiltersNoResults.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopFiltersNoResults.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getTopFiltersNoResults.index - Index name.
+         * @param getTopFiltersNoResults.search - Search query.
+         * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -746,21 +890,24 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the most popular clicked results in the last 1,000 searches.
+         * Retrieves the object IDs of the most frequent search results.
+         *
+         * Required API Key ACLs:
+         * - analytics.
          *
-         * @summary Get top hits.
          * @param getTopHits - The getTopHits object.
-         * @param getTopHits.index - Index name to target.
-         * @param getTopHits.search - User query.
-         * @param getTopHits.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-         * @param getTopHits.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopHits.limit - Number of records to return (page size).
-         * @param getTopHits.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopHits.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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, startDate, endDate, limit, offset, tags, }, requestOptions) {
+        getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags, }, requestOptions) {
             if (!index) {
                 throw new Error('Parameter `index` is required when calling `getTopHits`.');
             }
@@ -776,6 +923,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (clickAnalytics !== undefined) {
                 queryParameters.clickAnalytics = clickAnalytics.toString();
             }
+            if (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.toString();
+            }
             if (startDate !== undefined) {
                 queryParameters.startDate = startDate.toString();
             }
@@ -800,22 +950,25 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Returns the most popular of the latest 1,000 searches. For each search, also returns the number of hits.
+         * Returns the most popular search terms.
+         *
+         * Required API Key ACLs:
+         * - analytics.
          *
-         * @summary Get top searches.
          * @param getTopSearches - The getTopSearches object.
-         * @param getTopSearches.index - Index name to target.
-         * @param getTopSearches.clickAnalytics - Whether to include [click and conversion](https://www.algolia.com/doc/guides/sending-events/getting-started/) rates for a search.
-         * @param getTopSearches.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getTopSearches.orderBy - Reorder the results.
+         * @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 of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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 records to return (page size).
-         * @param getTopSearches.offset - Position of the starting record. Used for paging. 0 is the first record.
-         * @param getTopSearches.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @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, startDate, endDate, orderBy, direction, limit, offset, tags, }, 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`.');
             }
@@ -828,6 +981,9 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             if (clickAnalytics !== undefined) {
                 queryParameters.clickAnalytics = clickAnalytics.toString();
             }
+            if (revenueAnalytics !== undefined) {
+                queryParameters.revenueAnalytics = revenueAnalytics.toString();
+            }
             if (startDate !== undefined) {
                 queryParameters.startDate = startDate.toString();
             }
@@ -858,14 +1014,16 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
             return transporter.request(request, requestOptions);
         },
         /**
-         * Return the count of unique users.
+         * 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.
          *
-         * @summary Get user count.
          * @param getUsersCount - The getUsersCount object.
-         * @param getUsersCount.index - Index name to target.
-         * @param getUsersCount.startDate - Start date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.endDate - End date (a string in the format `YYYY-MM-DD`) of the period to analyze.
-         * @param getUsersCount.tags - Filter analytics on the [`analyticsTags`](https://www.algolia.com/doc/api-reference/api-parameters/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 must be URL-encoded.
+         * @param getUsersCount.index - Index name.
+         * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
+         * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
+         * @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) {
@@ -899,6 +1057,7 @@ function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authM
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// 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.');
@@ -909,22 +1068,24 @@ function analyticsClient(appId, apiKey, region, options) {
     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,
-    });
+    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 };