@algolia/client-insights 5.0.0-alpha.99 → 5.0.0-beta.10

package/dist/model/addedToCartObjectIDs.d.ts

@@ -7,25 +7,25 @@ import type { Value } from './value';
  */
 export type AddedToCartObjectIDs = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     eventSubtype: AddToCartEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
@@ -37,7 +37,7 @@ export type AddedToCartObjectIDs = {
      */
     objectData?: ObjectData[];
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;

package/dist/model/addedToCartObjectIDsAfterSearch.d.ts

@@ -7,13 +7,13 @@ import type { Value } from './value';
  */
 export type AddedToCartObjectIDsAfterSearch = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     eventSubtype: AddToCartEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
@@ -21,15 +21,15 @@ export type AddedToCartObjectIDsAfterSearch = {
      */
     queryID: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
@@ -41,7 +41,7 @@ export type AddedToCartObjectIDsAfterSearch = {
      */
     objectData?: ObjectDataAfterSearch[];
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;

package/dist/model/clickedFilters.d.ts

@@ -4,28 +4,28 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedFilters = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ClickEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+     * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
     filters: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/clickedObjectIDs.d.ts

@@ -4,28 +4,28 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedObjectIDs = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ClickEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/clickedObjectIDsAfterSearch.d.ts

@@ -4,20 +4,20 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedObjectIDsAfterSearch = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ClickEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * The position of the clicked item the search results.  The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.
+     * Position of the clicked item the search results.  You must provide 1 `position` for each `objectID`.
      */
     positions: number[];
     /**
@@ -25,15 +25,15 @@ export type ClickedObjectIDsAfterSearch = {
      */
     queryID: string;
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/clientMethodProps.d.ts

@@ -63,7 +63,7 @@ export type CustomPutProps = {
  */
 export type DeleteUserTokenProps = {
     /**
-     * The user token for which to delete all associated events.
+     * User token for which to delete all associated events.
      */
     userToken: string;
 };

package/dist/model/convertedFilters.d.ts

@@ -1,28 +1,28 @@
 import type { ConversionEvent } from './conversionEvent';
 export type ConvertedFilters = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+     * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
     filters: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/convertedObjectIDs.d.ts

@@ -4,28 +4,28 @@ import type { ConversionEvent } from './conversionEvent';
  */
 export type ConvertedObjectIDs = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/convertedObjectIDsAfterSearch.d.ts

@@ -4,16 +4,16 @@ import type { ConversionEvent } from './conversionEvent';
  */
 export type ConvertedObjectIDsAfterSearch = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
@@ -21,15 +21,15 @@ export type ConvertedObjectIDsAfterSearch = {
      */
     queryID: string;
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/discount.d.ts

@@ -1,5 +1,5 @@
 /**
- * The absolute value of the discount for this product, in units of `currency`.
+ * Absolute value of the discount for this product, in units of `currency`.
  */
 export type Discount = number | string;
 //# sourceMappingURL=discount.d.ts.map

package/dist/model/insightsEvents.d.ts

@@ -1,7 +1,7 @@
 import type { EventsItems } from './eventsItems';
 export type InsightsEvents = {
     /**
-     * List of click and conversion events.  An event is an object representing a user interaction. Events have attributes that describe the interaction, such as an event name, a type, or a user token.  **All** events must be valid, otherwise the API returns an error.
+     * Click and conversion events.  **All** events must be valid, otherwise the API returns an error.
      */
     events: EventsItems[];
 };

package/dist/model/objectData.d.ts

@@ -3,7 +3,7 @@ import type { Price } from './price';
 export type ObjectData = {
     price?: Price;
     /**
-     * The quantity of a product that has been purchased or added to the cart. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
+     * 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;

package/dist/model/objectDataAfterSearch.d.ts

@@ -7,7 +7,7 @@ export type ObjectDataAfterSearch = {
     queryID?: string;
     price?: Price;
     /**
-     * The quantity of a product that has been purchased or added to the cart. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
+     * 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;

package/dist/model/price.d.ts

@@ -1,5 +1,5 @@
 /**
- * The total price of a product, including any discounts, in units of `currency`.
+ * Total price of a product, including any discounts, in units of `currency`.
  */
 export type Price = number | string;
 //# sourceMappingURL=price.d.ts.map

package/dist/model/purchasedObjectIDs.d.ts

@@ -7,25 +7,25 @@ import type { Value } from './value';
  */
 export type PurchasedObjectIDs = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     eventSubtype: PurchaseEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
@@ -37,7 +37,7 @@ export type PurchasedObjectIDs = {
      */
     objectData?: ObjectData[];
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;

package/dist/model/purchasedObjectIDsAfterSearch.d.ts

@@ -7,25 +7,25 @@ import type { Value } from './value';
  */
 export type PurchasedObjectIDsAfterSearch = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ConversionEvent;
     eventSubtype: PurchaseEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
@@ -35,9 +35,9 @@ export 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: ObjectDataAfterSearch[];
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;

package/dist/model/purchasedObjectIDsAfterSearch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"purchasedObjectIDsAfterSearch.d.ts","sourceRoot":"","sources":["../../model/purchasedObjectIDsAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B,YAAY,EAAE,aAAa,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}
+{"version":3,"file":"purchasedObjectIDsAfterSearch.d.ts","sourceRoot":"","sources":["../../model/purchasedObjectIDsAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B,YAAY,EAAE,aAAa,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,qBAAqB,EAAE,CAAC;IAEpC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}

package/dist/model/viewedFilters.d.ts

@@ -4,28 +4,28 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedFilters = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ViewEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+     * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
      */
     filters: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };

package/dist/model/viewedObjectIDs.d.ts

@@ -4,28 +4,28 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedObjectIDs = {
     /**
-     * The name of the event, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
+     * Event name, up to 64 ASCII characters.  Consider naming events consistently—for example, by adopting Segment\'s [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework.
      */
     eventName: string;
     eventType: ViewEvent;
     /**
-     * The name of an Algolia index.
+     * Index name (case-sensitive) to which the event\'s items belong.
      */
     index: string;
     /**
-     * The object IDs of the records that are part of the event.
+     * Object IDs of the records that are part of the event.
      */
     objectIDs: string[];
     /**
-     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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/).
      */
     userToken: string;
     /**
-     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     * 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;
     /**
-     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     * 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;
 };