@algolia/client-insights 5.7.0 → 5.8.1

package/dist/node.d.cts

@@ -1,76 +1,6 @@
 import * as _algolia_client_common from '@algolia/client-common';
 import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
 
-/**
- * Properties for the `customDelete` method.
- */
-type CustomDeleteProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customGet` method.
- */
-type CustomGetProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `customPost` method.
- */
-type CustomPostProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `customPut` method.
- */
-type CustomPutProps = {
-    /**
-     * Path of the endpoint, anything after \"/1\" must be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to apply to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * Parameters to send with the custom request.
-     */
-    body?: Record<string, unknown>;
-};
-/**
- * Properties for the `deleteUserToken` method.
- */
-type DeleteUserTokenProps = {
-    /**
-     * User token for which to delete all associated events.
-     */
-    userToken: string;
-};
-
 /**
  * The response of the Insights API.
  */
@@ -130,7 +60,7 @@ type AddedToCartObjectIDs = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -146,7 +76,7 @@ type AddedToCartObjectIDs = {
     /**
      * Extra information about the records involved in a purchase or add-to-cart event.  If specified, it must have the same length as `objectIDs`.
      */
-    objectData?: ObjectData[];
+    objectData?: Array<ObjectData>;
     /**
      * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
      */
@@ -188,7 +118,7 @@ type AddedToCartObjectIDsAfterSearch = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -204,7 +134,7 @@ type AddedToCartObjectIDsAfterSearch = {
     /**
      * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
      */
-    objectData?: ObjectDataAfterSearch[];
+    objectData?: Array<ObjectDataAfterSearch>;
     /**
      * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
      */
@@ -230,7 +160,7 @@ type ClickedFilters = {
     /**
      * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
-    filters: string[];
+    filters: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -261,7 +191,7 @@ type ClickedObjectIDs = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -292,11 +222,11 @@ type ClickedObjectIDsAfterSearch = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Position of the clicked item the search results.  You must provide 1 `position` for each `objectID`.
      */
-    positions: number[];
+    positions: Array<number>;
     /**
      * Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
      */
@@ -328,7 +258,7 @@ type ConvertedFilters = {
     /**
      * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
-    filters: string[];
+    filters: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -359,7 +289,7 @@ type ConvertedObjectIDs = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -390,7 +320,7 @@ type ConvertedObjectIDsAfterSearch = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Unique identifier for a search query.  The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response.
      */
@@ -428,7 +358,7 @@ type PurchasedObjectIDs = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -444,7 +374,7 @@ type PurchasedObjectIDs = {
     /**
      * Extra information about the records involved in a purchase or add-to-cart event.  If specified, it must have the same length as `objectIDs`.
      */
-    objectData?: ObjectData[];
+    objectData?: Array<ObjectData>;
     /**
      * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
      */
@@ -469,7 +399,7 @@ type PurchasedObjectIDsAfterSearch = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -485,7 +415,7 @@ type PurchasedObjectIDsAfterSearch = {
     /**
      * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
      */
-    objectData: ObjectDataAfterSearch[];
+    objectData: Array<ObjectDataAfterSearch>;
     /**
      * Timestamp of the event, measured in milliseconds since the Unix epoch. By default, the Insights API uses the time it receives an event as its timestamp.
      */
@@ -511,7 +441,7 @@ type ViewedFilters = {
     /**
      * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
-    filters: string[];
+    filters: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -542,7 +472,7 @@ type ViewedObjectIDs = {
     /**
      * Object IDs of the records that are part of the event.
      */
-    objectIDs: string[];
+    objectIDs: Array<string>;
     /**
      * Anonymous or pseudonymous user identifier.  Don\'t use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
      */
@@ -557,16 +487,94 @@ type ViewedObjectIDs = {
     timestamp?: number;
 };
 
-type EventsItems = AddedToCartObjectIDs | AddedToCartObjectIDsAfterSearch | ClickedFilters | ClickedObjectIDs | ClickedObjectIDsAfterSearch | ConvertedFilters | ConvertedObjectIDs | ConvertedObjectIDsAfterSearch | PurchasedObjectIDs | PurchasedObjectIDsAfterSearch | ViewedFilters | ViewedObjectIDs;
+type EventsItems = ClickedObjectIDsAfterSearch | AddedToCartObjectIDsAfterSearch | PurchasedObjectIDsAfterSearch | ConvertedObjectIDsAfterSearch | ClickedObjectIDs | PurchasedObjectIDs | AddedToCartObjectIDs | ConvertedObjectIDs | ClickedFilters | ConvertedFilters | ViewedObjectIDs | ViewedFilters;
 
 type InsightsEvents = {
     /**
      * Click and conversion events.  **All** events must be valid, otherwise the API returns an error.
      */
-    events: EventsItems[];
+    events: Array<EventsItems>;
+};
+
+/**
+ * Properties for the `customDelete` method.
+ */
+type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Properties for the `customGet` method.
+ */
+type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+};
+/**
+ * Properties for the `customPost` method.
+ */
+type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: {
+        [key: string]: any;
+    };
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `deleteUserToken` method.
+ */
+type DeleteUserTokenProps = {
+    /**
+     * User token for which to delete all associated events.
+     */
+    userToken: string;
 };
 
-declare const apiClientVersion = "5.7.0";
+declare const apiClientVersion = "5.8.1";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -603,7 +611,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     }): void;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customDelete - The customDelete object.
      * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -612,7 +619,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customGet - The customGet object.
      * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customGet.parameters - Query parameters to apply to the current query.
@@ -621,7 +627,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPost - The customPost object.
      * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPost.parameters - Query parameters to apply to the current query.
@@ -631,7 +636,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
-     *
      * @param customPut - The customPut object.
      * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
      * @param customPut.parameters - Query parameters to apply to the current query.
@@ -641,7 +645,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
     /**
      * Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API.
-     *
      * @param deleteUserToken - The deleteUserToken object.
      * @param deleteUserToken.userToken - User token for which to delete all associated events.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -649,7 +652,6 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
     deleteUserToken({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<void>;
     /**
      * Sends a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbsp;MB.
-     *
      * @param insightsEvents - The insightsEvents object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */