@algolia/client-analytics 5.0.0-alpha.53 → 5.0.0-alpha.55

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

@@ -368,16 +368,16 @@ function createTransporter({
     return {
       hosts: compatibleHostsAvailable,
       getTimeout(timeoutsCount, baseTimeout) {
-        /**
-         * Imagine that you have 4 hosts, if timeouts will increase
-         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
-         *
-         * Note that, the very next request, we start from the previous timeout.
-         *
-         *  5 (timed out) > 6 (timed out) > 7 ...
-         *
-         * This strategy may need to be reviewed, but is the strategy on the our
-         * current v3 version.
+        /**
+         * Imagine that you have 4 hosts, if timeouts will increase
+         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
+         *
+         * Note that, the very next request, we start from the previous timeout.
+         *
+         *  5 (timed out) > 6 (timed out) > 7 ...
+         *
+         * This strategy may need to be reviewed, but is the strategy on the our
+         * current v3 version.
          */
         const timeoutMultiplier = hostsTimedOut.length === 0 && timeoutsCount === 0 ? 1 : hostsTimedOut.length + 3 + timeoutsCount;
         return timeoutMultiplier * baseTimeout;
@@ -386,8 +386,8 @@ function createTransporter({
   }
   async function retryableRequest(request, requestOptions, isRead = true) {
     const stackTrace = [];
-    /**
-     * First we prepare the payload that do not depend from hosts.
+    /**
+     * First we prepare the payload that do not depend from hosts.
      */
     const data = serializeData(request, requestOptions);
     const headers = serializeHeaders(baseHeaders, request.headers, requestOptions.headers);
@@ -418,8 +418,8 @@ function createTransporter({
     }
     let timeoutsCount = 0;
     const retry = async (retryableHosts, getTimeout) => {
-      /**
-       * We iterate on each host, until there is no host left.
+      /**
+       * We iterate on each host, until there is no host left.
        */
       const host = retryableHosts.pop();
       if (host === undefined) {
@@ -437,10 +437,10 @@ function createTransporter({
         connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
-      /**
-       * The stackFrame is pushed to the stackTrace so we
-       * can have information about onRetry and onFailure
-       * decisions.
+      /**
+       * The stackFrame is pushed to the stackTrace so we
+       * can have information about onRetry and onFailure
+       * decisions.
        */
       const pushToStackTrace = response => {
         const stackFrame = {
@@ -459,17 +459,17 @@ function createTransporter({
         if (response.isTimedOut) {
           timeoutsCount++;
         }
-        /**
-         * Failures are individually sent to the logger, allowing
-         * the end user to debug / store stack frames even
-         * when a retry error does not happen.
+        /**
+         * Failures are individually sent to the logger, allowing
+         * the end user to debug / store stack frames even
+         * when a retry error does not happen.
          */
         // eslint-disable-next-line no-console -- this will be fixed by exposing a `logger` to the transporter
         console.log('Retryable failure', stackFrameWithoutCredentials(stackFrame));
-        /**
-         * We also store the state of the host in failure cases. If the host, is
-         * down it will remain down for the next 2 minutes. In a timeout situation,
-         * this host will be added end of the list of hosts on the next request.
+        /**
+         * We also store the state of the host in failure cases. If the host, is
+         * down it will remain down for the next 2 minutes. In a timeout situation,
+         * this host will be added end of the list of hosts on the next request.
          */
         await hostsCache.set(host, createStatefulHost(host, response.isTimedOut ? 'timed out' : 'down'));
         return retry(retryableHosts, getTimeout);
@@ -480,56 +480,56 @@ function createTransporter({
       pushToStackTrace(response);
       throw deserializeFailure(response, stackTrace);
     };
-    /**
-     * Finally, for each retryable host perform request until we got a non
-     * retryable response. Some notes here:
-     *
-     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
-     * 2. We also get from the retryable options a timeout multiplier that is tailored
-     * for the current context.
+    /**
+     * Finally, for each retryable host perform request until we got a non
+     * retryable response. Some notes here:
+     *
+     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
+     * 2. We also get from the retryable options a timeout multiplier that is tailored
+     * for the current context.
      */
     const compatibleHosts = hosts.filter(host => host.accept === 'readWrite' || (isRead ? host.accept === 'read' : host.accept === 'write'));
     const options = await createRetryableOptions(compatibleHosts);
     return retry([...options.hosts].reverse(), options.getTimeout);
   }
   function createRequest(request, requestOptions = {}) {
-    /**
-     * A read request is either a `GET` request, or a request that we make
-     * via the `read` transporter (e.g. `search`).
+    /**
+     * A read request is either a `GET` request, or a request that we make
+     * via the `read` transporter (e.g. `search`).
      */
     const isRead = request.useReadTransporter || request.method === 'GET';
     if (!isRead) {
-      /**
-       * On write requests, no cache mechanisms are applied, and we
-       * proxy the request immediately to the requester.
+      /**
+       * On write requests, no cache mechanisms are applied, and we
+       * proxy the request immediately to the requester.
        */
       return retryableRequest(request, requestOptions, isRead);
     }
     const createRetryableRequest = () => {
-      /**
-       * Then, we prepare a function factory that contains the construction of
-       * the retryable request. At this point, we may *not* perform the actual
-       * request. But we want to have the function factory ready.
+      /**
+       * Then, we prepare a function factory that contains the construction of
+       * the retryable request. At this point, we may *not* perform the actual
+       * request. But we want to have the function factory ready.
        */
       return retryableRequest(request, requestOptions);
     };
-    /**
-     * Once we have the function factory ready, we need to determine of the
-     * request is "cacheable" - should be cached. Note that, once again,
-     * the user can force this option.
+    /**
+     * Once we have the function factory ready, we need to determine of the
+     * request is "cacheable" - should be cached. Note that, once again,
+     * the user can force this option.
      */
     const cacheable = requestOptions.cacheable || request.cacheable;
-    /**
-     * If is not "cacheable", we immediately trigger the retryable request, no
-     * need to check cache implementations.
+    /**
+     * If is not "cacheable", we immediately trigger the retryable request, no
+     * need to check cache implementations.
      */
     if (cacheable !== true) {
       return createRetryableRequest();
     }
-    /**
-     * If the request is "cacheable", we need to first compute the key to ask
-     * the cache implementations if this request is on progress or if the
-     * response already exists on the cache.
+    /**
+     * If the request is "cacheable", we need to first compute the key to ask
+     * the cache implementations if this request is on progress or if the
+     * response already exists on the cache.
      */
     const key = {
       request,
@@ -539,27 +539,27 @@ function createTransporter({
         headers: baseHeaders
       }
     };
-    /**
-     * With the computed key, we first ask the responses cache
-     * implementation if this request was been resolved before.
+    /**
+     * With the computed key, we first ask the responses cache
+     * implementation if this request was been resolved before.
      */
     return responsesCache.get(key, () => {
-      /**
-       * If the request has never resolved before, we actually ask if there
-       * is a current request with the same key on progress.
+      /**
+       * If the request has never resolved before, we actually ask if there
+       * is a current request with the same key on progress.
        */
       return requestsCache.get(key, () =>
-      /**
-       * Finally, if there is no request in progress with the same key,
-       * this `createRetryableRequest()` will actually trigger the
-       * retryable request.
+      /**
+       * Finally, if there is no request in progress with the same key,
+       * this `createRetryableRequest()` will actually trigger the
+       * retryable request.
        */
       requestsCache.set(key, createRetryableRequest()).then(response => Promise.all([requestsCache.delete(key), response]), err => Promise.all([requestsCache.delete(key), Promise.reject(err)])).then(([_, response]) => response));
     }, {
-      /**
-       * Of course, once we get this response back from the server, we
-       * tell response cache to actually store the received response
-       * to be used later.
+      /**
+       * Of course, once we get this response back from the server, we
+       * tell response cache to actually store the received response
+       * to be used later.
        */
       miss: response => responsesCache.set(key, response)
     });
@@ -609,988 +609,988 @@ const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
 const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
 const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
 
-function createXhrRequester() {
-    function send(request) {
-        return new Promise((resolve) => {
-            const baseRequester = new XMLHttpRequest();
-            baseRequester.open(request.method, request.url, true);
-            Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
-            const createTimeout = (timeout, content) => {
-                return setTimeout(() => {
-                    baseRequester.abort();
-                    resolve({
-                        status: 0,
-                        content,
-                        isTimedOut: true,
-                    });
-                }, timeout);
-            };
-            const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
-            let responseTimeout;
-            baseRequester.onreadystatechange = () => {
-                if (baseRequester.readyState > baseRequester.OPENED &&
-                    responseTimeout === undefined) {
-                    clearTimeout(connectTimeout);
-                    responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
-                }
-            };
-            baseRequester.onerror = () => {
-                // istanbul ignore next
-                if (baseRequester.status === 0) {
-                    clearTimeout(connectTimeout);
-                    clearTimeout(responseTimeout);
-                    resolve({
-                        content: baseRequester.responseText || 'Network request failed',
-                        status: baseRequester.status,
-                        isTimedOut: false,
-                    });
-                }
-            };
-            baseRequester.onload = () => {
-                clearTimeout(connectTimeout);
-                clearTimeout(responseTimeout);
-                resolve({
-                    content: baseRequester.responseText,
-                    status: baseRequester.status,
-                    isTimedOut: false,
-                });
-            };
-            baseRequester.send(request.data);
-        });
-    }
-    return { send };
+function createXhrRequester() {
+    function send(request) {
+        return new Promise((resolve) => {
+            const baseRequester = new XMLHttpRequest();
+            baseRequester.open(request.method, request.url, true);
+            Object.keys(request.headers).forEach((key) => baseRequester.setRequestHeader(key, request.headers[key]));
+            const createTimeout = (timeout, content) => {
+                return setTimeout(() => {
+                    baseRequester.abort();
+                    resolve({
+                        status: 0,
+                        content,
+                        isTimedOut: true,
+                    });
+                }, timeout);
+            };
+            const connectTimeout = createTimeout(request.connectTimeout, 'Connection timeout');
+            let responseTimeout;
+            baseRequester.onreadystatechange = () => {
+                if (baseRequester.readyState > baseRequester.OPENED &&
+                    responseTimeout === undefined) {
+                    clearTimeout(connectTimeout);
+                    responseTimeout = createTimeout(request.responseTimeout, 'Socket timeout');
+                }
+            };
+            baseRequester.onerror = () => {
+                // istanbul ignore next
+                if (baseRequester.status === 0) {
+                    clearTimeout(connectTimeout);
+                    clearTimeout(responseTimeout);
+                    resolve({
+                        content: baseRequester.responseText || 'Network request failed',
+                        status: baseRequester.status,
+                        isTimedOut: false,
+                    });
+                }
+            };
+            baseRequester.onload = () => {
+                clearTimeout(connectTimeout);
+                clearTimeout(responseTimeout);
+                resolve({
+                    content: baseRequester.responseText,
+                    status: baseRequester.status,
+                    isTimedOut: false,
+                });
+            };
+            baseRequester.send(request.data);
+        });
+    }
+    return { send };
 }
 
-// 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.53';
-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.55';
+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);
+        },
+    };
 }
 
-// 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_BROWSER,
-            read: DEFAULT_READ_TIMEOUT_BROWSER,
-            write: DEFAULT_WRITE_TIMEOUT_BROWSER,
-        },
-        requester: createXhrRequester(),
-        algoliaAgents: [{ segment: 'Browser' }],
-        authMode: 'WithinQueryParameters',
-        responsesCache: createMemoryCache(),
-        requestsCache: createMemoryCache({ serializable: false }),
-        hostsCache: createFallbackableCache({
-            caches: [
-                createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
-                createMemoryCache(),
-            ],
-        }),
-        ...options,
-    });
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+function 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_BROWSER,
+            read: DEFAULT_READ_TIMEOUT_BROWSER,
+            write: DEFAULT_WRITE_TIMEOUT_BROWSER,
+        },
+        requester: createXhrRequester(),
+        algoliaAgents: [{ segment: 'Browser' }],
+        authMode: 'WithinQueryParameters',
+        responsesCache: createMemoryCache(),
+        requestsCache: createMemoryCache({ serializable: false }),
+        hostsCache: createFallbackableCache({
+            caches: [
+                createBrowserLocalStorageCache({ key: `${apiClientVersion}-${appId}` }),
+                createMemoryCache(),
+            ],
+        }),
+        ...options,
+    });
 }
 
 export { analyticsClient, apiClientVersion };