chore: generated code for commit 7c5ba328. [skip ci]

algolia/api-clients-automation@7c5ba32

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: shortcuts <vannicattec@gmail.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Co-authored-by: Morgan Leroi <morgan.leroi@gmail.com>

packages/client-insights/model/addedToCartObjectIDs.ts

@@ -3,13 +3,14 @@
 import type { AddToCartEvent } from './addToCartEvent';
 import type { ConversionEvent } from './conversionEvent';
 import type { ObjectData } from './objectData';
+import type { Value } from './value';
 
 /**
  * Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event.  To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event.
  */
 export type AddedToCartObjectIDs = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
@@ -18,37 +19,39 @@ export type AddedToCartObjectIDs = {
   eventSubtype: AddToCartEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * The object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * Extra information about the records involved in the event—for example, to add price and quantities of purchased products.  If provided, must be the same length as `objectIDs`.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  objectData?: ObjectData[];
+  userToken: string;
 
   /**
-   * If you include pricing information in the `objectData` parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  currency?: string;
+  authenticatedUserToken?: string;
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
    */
-  userToken: string;
+  currency?: string;
 
   /**
-   * Time 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.
+   * Extra information about the records involved in a purchase or add-to-cart event.  If specified, it must have the same length as `objectIDs`.
    */
-  timestamp?: number;
+  objectData?: ObjectData[];
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
+
+  value?: Value;
 };

packages/client-insights/model/addedToCartObjectIDsAfterSearch.ts

@@ -3,13 +3,14 @@
 import type { AddToCartEvent } from './addToCartEvent';
 import type { ConversionEvent } from './conversionEvent';
 import type { ObjectDataAfterSearch } from './objectDataAfterSearch';
+import type { Value } from './value';
 
 /**
  * Use this event to track when users add items to their shopping cart after a previous Algolia request. If you\'re building your category pages with Algolia, you\'ll also use this event.
  */
 export type AddedToCartObjectIDsAfterSearch = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
@@ -18,7 +19,7 @@ export type AddedToCartObjectIDsAfterSearch = {
   eventSubtype: AddToCartEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
@@ -28,32 +29,34 @@ export type AddedToCartObjectIDsAfterSearch = {
   queryID: string;
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * The object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * Extra information about the records involved in the event—for example, to add price and quantities of purchased products.  If provided, must be the same length as `objectIDs`.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  objectData?: ObjectDataAfterSearch[];
+  userToken: string;
 
   /**
-   * If you include pricing information in the `objectData` parameter, you must also specify the currency as ISO-4217 currency code, such as USD or EUR.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  currency?: string;
+  authenticatedUserToken?: string;
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
    */
-  userToken: string;
+  currency?: string;
 
   /**
-   * Time 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.
+   * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
    */
-  timestamp?: number;
+  objectData?: ObjectDataAfterSearch[];
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
+
+  value?: Value;
 };

packages/client-insights/model/clickedFilters.ts

@@ -7,14 +7,14 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedFilters = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
   eventType: ClickEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
@@ -24,17 +24,17 @@ export type ClickedFilters = {
   filters: string[];
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
   userToken: string;
 
   /**
-   * Time 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.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  timestamp?: number;
+  authenticatedUserToken?: string;
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
 };

packages/client-insights/model/clickedObjectIDs.ts

@@ -7,29 +7,34 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedObjectIDs = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
   eventType: ClickEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * The object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
   userToken: string;
 
   /**
-   * Time 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.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  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?: number;
 };

packages/client-insights/model/clickedObjectIDsAfterSearch.ts

@@ -7,24 +7,24 @@ import type { ClickEvent } from './clickEvent';
  */
 export type ClickedObjectIDsAfterSearch = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
   eventType: ClickEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * The object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * Position of the clicked objects in the search results.  The first search result has a position of 1 (not 0). You must provide 1 `position` for each `objectID`.
+   * 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`.
    */
   positions: number[];
 
@@ -34,17 +34,17 @@ export type ClickedObjectIDsAfterSearch = {
   queryID: string;
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
   userToken: string;
 
   /**
-   * Time 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.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  timestamp?: number;
+  authenticatedUserToken?: string;
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
 };

packages/client-insights/model/clientMethodProps.ts

@@ -63,3 +63,13 @@ export type CustomPutProps = {
    */
   body?: Record<string, any>;
 };
+
+/**
+ * Properties for the `deleteUserToken` method.
+ */
+export type DeleteUserTokenProps = {
+  /**
+   * The user token for which to delete all associated events.
+   */
+  userToken: string;
+};

packages/client-insights/model/convertedFilters.ts

@@ -4,14 +4,14 @@ import type { ConversionEvent } from './conversionEvent';
 
 export type ConvertedFilters = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
   eventType: ConversionEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
@@ -21,17 +21,17 @@ export type ConvertedFilters = {
   filters: string[];
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
   userToken: string;
 
   /**
-   * Time 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.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  timestamp?: number;
+  authenticatedUserToken?: string;
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
 };

packages/client-insights/model/convertedObjectIDs.ts

@@ -7,34 +7,34 @@ import type { ConversionEvent } from './conversionEvent';
  */
 export type ConvertedObjectIDs = {
   /**
-   * Can contain 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.
+   * 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.
    */
   eventName: string;
 
   eventType: ConversionEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * The object IDs of the records that are part of the event.
    */
   objectIDs: string[];
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
   userToken: string;
 
   /**
-   * Time 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.
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  timestamp?: number;
+  authenticatedUserToken?: string;
 
   /**
-   * User token for authenticated users.
+   * 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.
    */
-  authenticatedUserToken?: string;
+  timestamp?: number;
 };