@algolia/client-analytics 5.2.5 → 5.3.0

package/dist/src/analyticsClient.js

@@ -1,6 +1,6 @@
 // src/analyticsClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "5.2.5";
+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);
@@ -15,26 +15,25 @@ function createAnalyticsClient({
   ...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,
+    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.
      */
@@ -43,13 +42,15 @@ function createAnalyticsClient({
      * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
      */
     clearCache() {
-      return Promise.all([transporter.requestsCache.clear(), transporter.responsesCache.clear()]).then(() => void 0);
+      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.
      */
     get _ua() {
-      return transporter.algoliaAgent.value;
+      return this.transporter.algoliaAgent.value;
     },
     /**
      * Adds a `segment` to the `x-algolia-agent` sent with every requests.
@@ -58,7 +59,16 @@ function createAnalyticsClient({
      * @param version - The version of the agent.
      */
     addAlgoliaAgent(segment, version) {
-      transporter.algoliaAgent.add({ 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.
@@ -81,7 +91,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -104,7 +114,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -129,7 +139,7 @@ function createAnalyticsClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * This method allow you to send requests to the Algolia REST API.
@@ -154,7 +164,7 @@ function createAnalyticsClient({
         headers,
         data: body ? body : {}
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -194,7 +204,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -234,7 +244,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -274,7 +284,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -314,7 +324,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -354,7 +364,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -394,7 +404,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -434,7 +444,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -474,7 +484,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -514,7 +524,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -554,7 +564,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -602,7 +612,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves the most popular searches that didn\'t return any results.
@@ -650,7 +660,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -678,7 +688,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves the countries with the most searches to your index.
@@ -726,7 +736,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -778,7 +788,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -834,7 +844,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -886,7 +896,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Retrieves the object IDs of the most frequent search results.
@@ -946,7 +956,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     },
     /**
      * Returns the most popular search terms.
@@ -1021,7 +1031,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      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.
@@ -1061,7 +1071,7 @@ function createAnalyticsClient({
         queryParameters,
         headers
       };
-      return transporter.request(request, requestOptions);
+      return this.transporter.request(request, requestOptions);
     }
   };
 }