@algolia/client-insights 5.9.0 → 5.10.0-beta.1

package/model/addedToCartObjectIDsAfterSearch.ts

@@ -1,62 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-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 = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: 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.
-   */
-  queryID: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
-   */
-  currency?: string;
-
-  /**
-   * 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>;
-
-  /**
-   * 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/model/clickEvent.ts

@@ -1,3 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type ClickEvent = 'click';

package/model/clickedFilters.ts

@@ -1,40 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ClickEvent } from './clickEvent';
-
-/**
- * Use this event to track when users click facet filters in your user interface.
- */
-export type ClickedFilters = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/clickedObjectIDs.ts

@@ -1,40 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ClickEvent } from './clickEvent';
-
-/**
- * Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event.
- */
-export type ClickedObjectIDs = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/clickedObjectIDsAfterSearch.ts

@@ -1,50 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ClickEvent } from './clickEvent';
-
-/**
- * Click event after an Algolia request.  Use this event to track when users click items in the search results. If you\'re building your category pages with Algolia, you\'ll also use this event.
- */
-export type ClickedObjectIDsAfterSearch = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  objectIDs: Array<string>;
-
-  /**
-   * Position of the clicked item the search results.  You must provide 1 `position` for each `objectID`.
-   */
-  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.
-   */
-  queryID: 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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/clientMethodProps.ts

@@ -1,75 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Properties for the `customDelete` method.
- */
-export 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.
- */
-export 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.
- */
-export 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.
- */
-export 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.
- */
-export type DeleteUserTokenProps = {
-  /**
-   * User token for which to delete all associated events.
-   */
-  userToken: string;
-};

package/model/conversionEvent.ts

@@ -1,3 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type ConversionEvent = 'conversion';

package/model/convertedFilters.ts

@@ -1,37 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ConversionEvent } from './conversionEvent';
-
-export type ConvertedFilters = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Applied facet filters.  Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/convertedObjectIDs.ts

@@ -1,40 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ConversionEvent } from './conversionEvent';
-
-/**
- * Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event.  To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event.
- */
-export type ConvertedObjectIDs = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/convertedObjectIDsAfterSearch.ts

@@ -1,45 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ConversionEvent } from './conversionEvent';
-
-/**
- * Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart.  If you\'re building your category pages with Algolia, you\'ll also use this event.
- */
-export type ConvertedObjectIDsAfterSearch = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  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.
-   */
-  queryID: 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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * 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/model/discount.ts

@@ -1,6 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Absolute value of the discount for this product, in units of `currency`.
- */
-export type Discount = number | string;

package/model/errorBase.ts

@@ -1,8 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Error.
- */
-export type ErrorBase = Record<string, any> & {
-  message?: string;
-};

package/model/eventsItems.ts

@@ -1,30 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { AddedToCartObjectIDs } from './addedToCartObjectIDs';
-import type { AddedToCartObjectIDsAfterSearch } from './addedToCartObjectIDsAfterSearch';
-import type { ClickedFilters } from './clickedFilters';
-import type { ClickedObjectIDs } from './clickedObjectIDs';
-import type { ClickedObjectIDsAfterSearch } from './clickedObjectIDsAfterSearch';
-import type { ConvertedFilters } from './convertedFilters';
-import type { ConvertedObjectIDs } from './convertedObjectIDs';
-import type { ConvertedObjectIDsAfterSearch } from './convertedObjectIDsAfterSearch';
-
-import type { PurchasedObjectIDs } from './purchasedObjectIDs';
-import type { PurchasedObjectIDsAfterSearch } from './purchasedObjectIDsAfterSearch';
-
-import type { ViewedFilters } from './viewedFilters';
-import type { ViewedObjectIDs } from './viewedObjectIDs';
-
-export type EventsItems =
-  | ClickedObjectIDsAfterSearch
-  | AddedToCartObjectIDsAfterSearch
-  | PurchasedObjectIDsAfterSearch
-  | ConvertedObjectIDsAfterSearch
-  | ClickedObjectIDs
-  | PurchasedObjectIDs
-  | AddedToCartObjectIDs
-  | ConvertedObjectIDs
-  | ClickedFilters
-  | ConvertedFilters
-  | ViewedObjectIDs
-  | ViewedFilters;

package/model/eventsResponse.ts

@@ -1,16 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * The response of the Insights API.
- */
-export type EventsResponse = {
-  /**
-   * Details about the response, such as error messages.
-   */
-  message?: string;
-
-  /**
-   * The HTTP status code of the response.
-   */
-  status?: number;
-};

package/model/index.ts

@@ -1,29 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export * from './addedToCartObjectIDs';
-export * from './addedToCartObjectIDsAfterSearch';
-export * from './addToCartEvent';
-export * from './clickedFilters';
-export * from './clickedObjectIDs';
-export * from './clickedObjectIDsAfterSearch';
-export * from './clickEvent';
-export * from './clientMethodProps';
-export * from './conversionEvent';
-export * from './convertedFilters';
-export * from './convertedObjectIDs';
-export * from './convertedObjectIDsAfterSearch';
-export * from './discount';
-export * from './errorBase';
-export * from './eventsItems';
-export * from './eventsResponse';
-export * from './insightsEvents';
-export * from './objectData';
-export * from './objectDataAfterSearch';
-export * from './price';
-export * from './purchasedObjectIDs';
-export * from './purchasedObjectIDsAfterSearch';
-export * from './purchaseEvent';
-export * from './value';
-export * from './viewedFilters';
-export * from './viewedObjectIDs';
-export * from './viewEvent';

package/model/insightsEvents.ts

@@ -1,10 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { EventsItems } from './eventsItems';
-
-export type InsightsEvents = {
-  /**
-   * Click and conversion events.  **All** events must be valid, otherwise the API returns an error.
-   */
-  events: Array<EventsItems>;
-};

package/model/objectData.ts

@@ -1,15 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { Discount } from './discount';
-import type { Price } from './price';
-
-export type ObjectData = {
-  price?: Price;
-
-  /**
-   * 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/model/objectDataAfterSearch.ts

@@ -1,20 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { Discount } from './discount';
-import type { Price } from './price';
-
-export 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;
-
-  /**
-   * 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/model/price.ts

@@ -1,6 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-/**
- * Total price of a product, including any discounts, in units of `currency`.
- */
-export type Price = number | string;

package/model/purchaseEvent.ts

@@ -1,3 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-export type PurchaseEvent = 'purchase';

package/model/purchasedObjectIDs.ts

@@ -1,57 +0,0 @@
-// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-
-import type { ConversionEvent } from './conversionEvent';
-import type { ObjectData } from './objectData';
-import type { PurchaseEvent } from './purchaseEvent';
-import type { Value } from './value';
-
-/**
- * Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event.  To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event.
- */
-export type PurchasedObjectIDs = {
-  /**
-   * 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;
-
-  /**
-   * Index name (case-sensitive) to which the event\'s items belong.
-   */
-  index: string;
-
-  /**
-   * Object IDs of the records that are part of the event.
-   */
-  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/).
-   */
-  userToken: string;
-
-  /**
-   * 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;
-
-  /**
-   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
-   */
-  currency?: string;
-
-  /**
-   * 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>;
-
-  /**
-   * 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;
-};