chore: generated code for commit 0f8d4432. [skip ci]

algolia/api-clients-automation@0f8d443

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Kai Welke <[email protected]>
Co-authored-by: shortcuts <[email protected]>

packages/client-insights/model/addedToCartObjectIDs.ts

@@ -10,7 +10,7 @@ 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;
 
@@ -19,22 +19,22 @@ export type AddedToCartObjectIDs = {
   eventSubtype: AddToCartEvent;
 
   /**
-   * The name of an Algolia index.
+   * Index name 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;
 
@@ -49,7 +49,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 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?: number;
 

packages/client-insights/model/addedToCartObjectIDsAfterSearch.ts

@@ -10,7 +10,7 @@ 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;
 
@@ -19,7 +19,7 @@ export type AddedToCartObjectIDsAfterSearch = {
   eventSubtype: AddToCartEvent;
 
   /**
-   * The name of an Algolia index.
+   * Index name to which the event\'s items belong.
    */
   index: string;
 
@@ -29,17 +29,17 @@ 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;
 
@@ -54,7 +54,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 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?: number;
 

packages/client-insights/model/clickedFilters.ts

@@ -7,34 +7,34 @@ 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 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 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?: number;
 };

packages/client-insights/model/clickedObjectIDs.ts

@@ -7,34 +7,34 @@ 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 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 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?: number;
 };

packages/client-insights/model/clickedObjectIDsAfterSearch.ts

@@ -7,24 +7,24 @@ 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 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[];
 
@@ -34,17 +34,17 @@ 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 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?: number;
 };

packages/client-insights/model/clientMethodProps.ts

@@ -69,7 +69,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;
 };

packages/client-insights/model/convertedFilters.ts

@@ -4,34 +4,34 @@ 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 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 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?: number;
 };

packages/client-insights/model/convertedObjectIDs.ts

@@ -7,34 +7,34 @@ 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 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 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?: number;
 };