@algolia/client-analytics 5.2.4 → 5.3.0

package/dist/src/{analyticsClient.d.ts → analyticsClient.js}

@@ -1,51 +1,75 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, GetAddToCartRateProps, GetAverageClickPositionProps, GetClickPositionsProps, GetClickThroughRateProps, GetConversionRateProps, GetNoClickRateProps, GetNoResultsRateProps, GetPurchaseRateProps, GetRevenueProps, GetSearchesCountProps, GetSearchesNoClicksProps, GetSearchesNoResultsProps, GetStatusProps, GetTopCountriesProps, GetTopFilterAttributesProps, GetTopFilterForAttributeProps, GetTopFiltersNoResultsProps, GetTopHitsProps, GetTopSearchesProps, GetUsersCountProps } from '../model/clientMethodProps';
-import type { GetAddToCartRateResponse } from '../model/getAddToCartRateResponse';
-import type { GetAverageClickPositionResponse } from '../model/getAverageClickPositionResponse';
-import type { GetClickPositionsResponse } from '../model/getClickPositionsResponse';
-import type { GetClickThroughRateResponse } from '../model/getClickThroughRateResponse';
-import type { GetConversionRateResponse } from '../model/getConversionRateResponse';
-import type { GetNoClickRateResponse } from '../model/getNoClickRateResponse';
-import type { GetNoResultsRateResponse } from '../model/getNoResultsRateResponse';
-import type { GetPurchaseRateResponse } from '../model/getPurchaseRateResponse';
-import type { GetRevenue } from '../model/getRevenue';
-import type { GetSearchesCountResponse } from '../model/getSearchesCountResponse';
-import type { GetSearchesNoClicksResponse } from '../model/getSearchesNoClicksResponse';
-import type { GetSearchesNoResultsResponse } from '../model/getSearchesNoResultsResponse';
-import type { GetStatusResponse } from '../model/getStatusResponse';
-import type { GetTopCountriesResponse } from '../model/getTopCountriesResponse';
-import type { GetTopFilterAttributesResponse } from '../model/getTopFilterAttributesResponse';
-import type { GetTopFilterForAttributeResponse } from '../model/getTopFilterForAttributeResponse';
-import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoResultsResponse';
-import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
-import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
-import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
-export declare const apiClientVersion = "5.2.4";
-export declare const REGIONS: readonly ["de", "us"];
-export type Region = (typeof REGIONS)[number];
-export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
-    region?: Region;
-}): {
-    transporter: import("@algolia/client-common").Transporter;
+// src/analyticsClient.ts
+import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
+var apiClientVersion = "5.3.0";
+var 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" }];
+}
+function createAnalyticsClient({
+  appId: appIdOption,
+  apiKey: apiKeyOption,
+  authMode,
+  algoliaAgents,
+  region: regionOption,
+  ...options
+}) {
+  const auth = createAuth(appIdOption, apiKeyOption, authMode);
+  return {
+    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
+      }
+    }),
     /**
      * The `appId` currently in use.
      */
-    appId: string;
+    appId: appIdOption,
     /**
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
-    clearCache(): Promise<void>;
+    clearCache() {
+      return Promise.all([this.transporter.requestsCache.clear(), this.transporter.responsesCache.clear()]).then(
+        () => void 0
+      );
+    },
     /**
      * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
      */
-    readonly _ua: string;
+    get _ua() {
+      return this.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: string, version?: string): void;
+    addAlgoliaAgent(segment, version) {
+      this.transporter.algoliaAgent.add({ segment, version });
+    },
+    /**
+     * Helper method to switch the API key used to authenticate the requests.
+     *
+     * @param params - Method params.
+     * @param params.apiKey - The new API Key to use.
+     */
+    setClientApiKey({ apiKey }) {
+      this.transporter.baseHeaders["x-algolia-api-key"] = apiKey;
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -54,7 +78,21 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    customDelete({ path, parameters }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customDelete`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "DELETE",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -63,7 +101,21 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    customGet({ path, parameters }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customGet`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -73,7 +125,22 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    customPost({ path, parameters, body }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPost`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
@@ -83,7 +150,22 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
+    customPut({ path, parameters, body }, requestOptions) {
+      if (!path) {
+        throw new Error("Parameter `path` is required when calling `customPut`.");
+      }
+      const requestPath = "/{path}".replace("{path}", path);
+      const headers = {};
+      const queryParameters = parameters ? parameters : {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: body ? body : {}
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the add-to-cart rate for all of your searches with at least one add-to-cart event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -97,7 +179,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getAddToCartRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAddToCartRate({ index, startDate, endDate, tags }: GetAddToCartRateProps, requestOptions?: RequestOptions): Promise<GetAddToCartRateResponse>;
+    getAddToCartRate({ index, startDate, endDate, tags }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getAddToCartRate`.");
+      }
+      const requestPath = "/2/conversions/addToCartRate";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the average click position of your search results, including a daily breakdown.  The average click position is the average of all clicked search results\' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day.
      *
@@ -111,7 +219,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getAverageClickPosition.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getAverageClickPosition({ index, startDate, endDate, tags }: GetAverageClickPositionProps, requestOptions?: RequestOptions): Promise<GetAverageClickPositionResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the positions in the search results and their associated number of clicks.  This lets you check how many clicks the first, second, or tenth search results receive.
      *
@@ -125,7 +259,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getClickPositions.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getClickPositions({ index, startDate, endDate, tags }: GetClickPositionsProps, requestOptions?: RequestOptions): Promise<GetClickPositionsResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the click-through rate for all of your searches with at least one click event, including a daily breakdown  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -139,7 +299,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getClickThroughRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getClickThroughRate({ index, startDate, endDate, tags }: GetClickThroughRateProps, requestOptions?: RequestOptions): Promise<GetClickThroughRateResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the conversion rate for all of your searches with at least one conversion event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -153,7 +339,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getConversionRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getConversionRate({ index, startDate, endDate, tags }: GetConversionRateProps, requestOptions?: RequestOptions): Promise<GetConversionRateResponse>;
+    getConversionRate({ index, startDate, endDate, tags }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getConversionRate`.");
+      }
+      const requestPath = "/2/conversions/conversionRate";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the fraction of searches that didn\'t lead to any click within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -167,7 +379,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getNoClickRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getNoClickRate({ index, startDate, endDate, tags }: GetNoClickRateProps, requestOptions?: RequestOptions): Promise<GetNoClickRateResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -181,7 +419,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getNoResultsRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getNoResultsRate({ index, startDate, endDate, tags }: GetNoResultsRateProps, requestOptions?: RequestOptions): Promise<GetNoResultsRateResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the purchase rate for all of your searches with at least one purchase event, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -195,7 +459,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getPurchaseRate.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getPurchaseRate({ index, startDate, endDate, tags }: GetPurchaseRateProps, requestOptions?: RequestOptions): Promise<GetPurchaseRateResponse>;
+    getPurchaseRate({ index, startDate, endDate, tags }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getPurchaseRate`.");
+      }
+      const requestPath = "/2/conversions/purchaseRate";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves revenue-related metrics, such as the total revenue or the average order value.  To retrieve revenue-related metrics, sent purchase events. By default, the analyzed period includes the last eight days including the current day.
      *
@@ -209,7 +499,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getRevenue.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getRevenue({ index, startDate, endDate, tags }: GetRevenueProps, requestOptions?: RequestOptions): Promise<GetRevenue>;
+    getRevenue({ index, startDate, endDate, tags }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getRevenue`.");
+      }
+      const requestPath = "/2/conversions/revenue";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the number of searches within a time range, including a daily breakdown.  By default, the analyzed period includes the last eight days including the current day.
      *
@@ -223,7 +539,33 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getSearchesCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSearchesCount({ index, startDate, endDate, tags }: GetSearchesCountProps, requestOptions?: RequestOptions): Promise<GetSearchesCountResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the most popular searches that didn\'t lead to any clicks, from the 1,000 most frequent searches.
      *
@@ -239,7 +581,39 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getSearchesNoClicks.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSearchesNoClicks({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoClicksProps, requestOptions?: RequestOptions): Promise<GetSearchesNoClicksResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the most popular searches that didn\'t return any results.
      *
@@ -255,7 +629,39 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getSearchesNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getSearchesNoResults({ index, startDate, endDate, limit, offset, tags }: GetSearchesNoResultsProps, requestOptions?: RequestOptions): Promise<GetSearchesNoResultsResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the time when the Analytics data for the specified index was last updated.  The Analytics data is updated every 5 minutes.
      *
@@ -266,7 +672,24 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getStatus.index - Index name.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getStatus({ index }: GetStatusProps, requestOptions?: RequestOptions): Promise<GetStatusResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the countries with the most searches to your index.
      *
@@ -282,7 +705,39 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopCountries.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopCountries({ index, startDate, endDate, limit, offset, tags }: GetTopCountriesProps, requestOptions?: RequestOptions): Promise<GetTopCountriesResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the most frequently used filter attributes.  These are attributes of your records that you included in the `attributesForFaceting` setting.
      *
@@ -299,7 +754,42 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFilterAttributes.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopFilterAttributes({ index, search, startDate, endDate, limit, offset, tags }: GetTopFilterAttributesProps, requestOptions?: RequestOptions): Promise<GetTopFilterAttributesResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (search !== void 0) {
+        queryParameters.search = search.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the most frequent filter (facet) values for a filter attribute.  These are attributes of your records that you included in the `attributesForFaceting` setting.
      *
@@ -317,7 +807,45 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopFilterForAttribute({ attribute, index, search, startDate, endDate, limit, offset, tags }: GetTopFilterForAttributeProps, requestOptions?: RequestOptions): Promise<GetTopFilterForAttributeResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (search !== void 0) {
+        queryParameters.search = search.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the most frequently used filters for a search that didn\'t return any results.  To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
      *
@@ -334,7 +862,42 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopFiltersNoResults({ index, search, startDate, endDate, limit, offset, tags }: GetTopFiltersNoResultsProps, requestOptions?: RequestOptions): Promise<GetTopFiltersNoResultsResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (search !== void 0) {
+        queryParameters.search = search.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the object IDs of the most frequent search results.
      *
@@ -353,7 +916,48 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopHits.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }: GetTopHitsProps, requestOptions?: RequestOptions): Promise<GetTopHitsResponse>;
+    getTopHits({ index, search, clickAnalytics, revenueAnalytics, startDate, endDate, limit, offset, tags }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getTopHits`.");
+      }
+      const requestPath = "/2/hits";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (search !== void 0) {
+        queryParameters.search = search.toString();
+      }
+      if (clickAnalytics !== void 0) {
+        queryParameters.clickAnalytics = clickAnalytics.toString();
+      }
+      if (revenueAnalytics !== void 0) {
+        queryParameters.revenueAnalytics = revenueAnalytics.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Returns the most popular search terms.
      *
@@ -373,7 +977,62 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getTopSearches.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getTopSearches({ index, clickAnalytics, revenueAnalytics, startDate, endDate, orderBy, direction, limit, offset, tags, }: GetTopSearchesProps, requestOptions?: RequestOptions): Promise<GetTopSearchesResponse>;
+    getTopSearches({
+      index,
+      clickAnalytics,
+      revenueAnalytics,
+      startDate,
+      endDate,
+      orderBy,
+      direction,
+      limit,
+      offset,
+      tags
+    }, requestOptions) {
+      if (!index) {
+        throw new Error("Parameter `index` is required when calling `getTopSearches`.");
+      }
+      const requestPath = "/2/searches";
+      const headers = {};
+      const queryParameters = {};
+      if (index !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (clickAnalytics !== void 0) {
+        queryParameters.clickAnalytics = clickAnalytics.toString();
+      }
+      if (revenueAnalytics !== void 0) {
+        queryParameters.revenueAnalytics = revenueAnalytics.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (orderBy !== void 0) {
+        queryParameters.orderBy = orderBy.toString();
+      }
+      if (direction !== void 0) {
+        queryParameters.direction = direction.toString();
+      }
+      if (limit !== void 0) {
+        queryParameters.limit = limit.toString();
+      }
+      if (offset !== void 0) {
+        queryParameters.offset = offset.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    },
     /**
      * Retrieves the number of unique users within a time range, including a daily breakdown.  Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number.  By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day.
      *
@@ -387,6 +1046,38 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
      * @param getUsersCount.tags - Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    getUsersCount({ index, startDate, endDate, tags }: GetUsersCountProps, requestOptions?: RequestOptions): Promise<GetUsersCountResponse>;
+    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 !== void 0) {
+        queryParameters.index = index.toString();
+      }
+      if (startDate !== void 0) {
+        queryParameters.startDate = startDate.toString();
+      }
+      if (endDate !== void 0) {
+        queryParameters.endDate = endDate.toString();
+      }
+      if (tags !== void 0) {
+        queryParameters.tags = tags.toString();
+      }
+      const request = {
+        method: "GET",
+        path: requestPath,
+        queryParameters,
+        headers
+      };
+      return this.transporter.request(request, requestOptions);
+    }
+  };
+}
+export {
+  REGIONS,
+  apiClientVersion,
+  createAnalyticsClient
 };
-//# sourceMappingURL=analyticsClient.d.ts.map
+//# sourceMappingURL=analyticsClient.js.map