@algolia/client-insights 5.27.0 → 5.28.0

package/dist/node.d.cts

@@ -8,11 +8,11 @@ type EventsResponse = {
     /**
      * Details about the response, such as error messages.
      */
-    message?: string;
+    message?: string | undefined;
     /**
      * The HTTP status code of the response.
      */
-    status?: number;
+    status?: number | undefined;
 };
 
 type AddToCartEvent = 'addToCart';
@@ -30,12 +30,12 @@ type Discount = number | string;
 type Price = number | string;
 
 type ObjectData = {
-    price?: Price;
+    price?: Price | undefined;
     /**
      * Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of `quantity` multiplied with the `price` for each purchased item.
      */
-    quantity?: number;
-    discount?: Discount;
+    quantity?: number | undefined;
+    discount?: Discount | undefined;
 };
 
 /**
@@ -68,33 +68,33 @@ type AddedToCartObjectIDs = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
      */
-    currency?: string;
+    currency?: string | undefined;
     /**
      * 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?: Array<ObjectData>;
+    objectData?: Array<ObjectData> | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
-    value?: Value;
+    timestamp?: number | undefined;
+    value?: Value | undefined;
 };
 
 type ObjectDataAfterSearch = {
     /**
      * Unique identifier for a search query, used to track purchase events with multiple records that originate from different searches.
      */
-    queryID?: string;
-    price?: Price;
+    queryID?: string | undefined;
+    price?: Price | undefined;
     /**
      * Quantity of a product that has been purchased or added to the cart. The total purchase value is the sum of `quantity` multiplied with the `price` for each purchased item.
      */
-    quantity?: number;
-    discount?: Discount;
+    quantity?: number | undefined;
+    discount?: Discount | undefined;
 };
 
 /**
@@ -126,20 +126,20 @@ type AddedToCartObjectIDsAfterSearch = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
      */
-    currency?: string;
+    currency?: string | undefined;
     /**
      * 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?: Array<ObjectDataAfterSearch>;
+    objectData?: Array<ObjectDataAfterSearch> | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
-    value?: Value;
+    timestamp?: number | undefined;
+    value?: Value | undefined;
 };
 
 type ClickEvent = 'click';
@@ -168,11 +168,11 @@ type ClickedFilters = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 /**
@@ -199,11 +199,11 @@ type ClickedObjectIDs = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 /**
@@ -238,11 +238,11 @@ type ClickedObjectIDsAfterSearch = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 type ConvertedFilters = {
@@ -266,11 +266,11 @@ type ConvertedFilters = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 /**
@@ -297,11 +297,11 @@ type ConvertedObjectIDs = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 /**
@@ -332,11 +332,11 @@ type ConvertedObjectIDsAfterSearch = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 type PurchaseEvent = 'purchase';
@@ -366,20 +366,20 @@ type PurchasedObjectIDs = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
      */
-    currency?: string;
+    currency?: string | undefined;
     /**
      * 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?: Array<ObjectData>;
+    objectData?: Array<ObjectData> | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
-    value?: Value;
+    timestamp?: number | undefined;
+    value?: Value | undefined;
 };
 
 /**
@@ -407,11 +407,11 @@ type PurchasedObjectIDsAfterSearch = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
      */
-    currency?: string;
+    currency?: string | undefined;
     /**
      * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
      */
@@ -419,8 +419,8 @@ type PurchasedObjectIDsAfterSearch = {
     /**
      * 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.
      */
-    timestamp?: number;
-    value?: Value;
+    timestamp?: number | undefined;
+    value?: Value | undefined;
 };
 
 type ViewEvent = 'view';
@@ -449,11 +449,11 @@ type ViewedFilters = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 /**
@@ -480,11 +480,11 @@ type ViewedObjectIDs = {
     /**
      * Identifier for authenticated users.  When the user signs in, you can get an identifier from your system and send it as `authenticatedUserToken`. This lets you keep using the `userToken` from before the user signed in, while providing a reliable way to identify users across sessions. 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/).
      */
-    authenticatedUserToken?: string;
+    authenticatedUserToken?: string | undefined;
     /**
      * 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.
      */
-    timestamp?: number;
+    timestamp?: number | undefined;
 };
 
 type EventsItems = ClickedObjectIDsAfterSearch | AddedToCartObjectIDsAfterSearch | PurchasedObjectIDsAfterSearch | ConvertedObjectIDsAfterSearch | ClickedObjectIDs | PurchasedObjectIDs | AddedToCartObjectIDs | ConvertedObjectIDs | ClickedFilters | ConvertedFilters | ViewedObjectIDs | ViewedFilters;
@@ -509,7 +509,7 @@ type CustomDeleteProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customGet` method.
@@ -524,7 +524,7 @@ type CustomGetProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
 };
 /**
  * Properties for the `customPost` method.
@@ -539,11 +539,11 @@ type CustomPostProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `customPut` method.
@@ -558,11 +558,11 @@ type CustomPutProps = {
      */
     parameters?: {
         [key: string]: any;
-    };
+    } | undefined;
     /**
      * Parameters to send with the custom request.
      */
-    body?: Record<string, unknown>;
+    body?: Record<string, unknown> | undefined;
 };
 /**
  * Properties for the `deleteUserToken` method.
@@ -574,11 +574,11 @@ type DeleteUserTokenProps = {
     userToken: string;
 };
 
-declare const apiClientVersion = "5.27.0";
+declare const apiClientVersion = "5.28.0";
 declare const REGIONS: readonly ["de", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
-    region?: Region;
+    region?: Region | undefined;
 };
 declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
     transporter: _algolia_client_common.Transporter;
@@ -604,7 +604,7 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
      * @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: string, version?: string | undefined): void;
     /**
      * Helper method to switch the API key used to authenticate the requests.
      *
@@ -673,11 +673,11 @@ declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption
  * Error.
  */
 type ErrorBase = Record<string, any> & {
-    message?: string;
+    message?: string | undefined;
 };
 
 type InsightsClient = ReturnType<typeof createInsightsClient>;
 
-declare function insightsClient(appId: string, apiKey: string, region?: Region, options?: ClientOptions): InsightsClient;
+declare function insightsClient(appId: string, apiKey: string, region?: Region | undefined, options?: ClientOptions | undefined): InsightsClient;
 
 export { type AddToCartEvent, type AddedToCartObjectIDs, type AddedToCartObjectIDsAfterSearch, type ClickEvent, type ClickedFilters, type ClickedObjectIDs, type ClickedObjectIDsAfterSearch, type ConversionEvent, type ConvertedFilters, type ConvertedObjectIDs, type ConvertedObjectIDsAfterSearch, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteUserTokenProps, type Discount, type ErrorBase, type EventsItems, type EventsResponse, type InsightsClient, type InsightsEvents, type ObjectData, type ObjectDataAfterSearch, type Price, type PurchaseEvent, type PurchasedObjectIDs, type PurchasedObjectIDsAfterSearch, type Region, type RegionOptions, type Value, type ViewEvent, type ViewedFilters, type ViewedObjectIDs, apiClientVersion, insightsClient };