@algolia/client-insights 5.0.0-alpha.90 → 5.0.0-alpha.97

package/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;
 };

package/model/clientMethodProps.ts

@@ -1,9 +1,9 @@
 // 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 `del` method.
+ * Properties for the `customDelete` method.
  */
-export type DelProps = {
+export type CustomDeleteProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -15,9 +15,9 @@ export type DelProps = {
 };
 
 /**
- * Properties for the `get` method.
+ * Properties for the `customGet` method.
  */
-export type GetProps = {
+export type CustomGetProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -29,9 +29,9 @@ export type GetProps = {
 };
 
 /**
- * Properties for the `post` method.
+ * Properties for the `customPost` method.
  */
-export type PostProps = {
+export type CustomPostProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -47,9 +47,9 @@ export type PostProps = {
 };
 
 /**
- * Properties for the `put` method.
+ * Properties for the `customPut` method.
  */
-export type PutProps = {
+export type CustomPutProps = {
   /**
    * Path of the endpoint, anything after \"/1\" must be specified.
    */
@@ -63,3 +63,13 @@ export type PutProps = {
    */
   body?: Record<string, any>;
 };
+
+/**
+ * Properties for the `deleteUserToken` method.
+ */
+export type DeleteUserTokenProps = {
+  /**
+   * The user token for which to delete all associated events.
+   */
+  userToken: string;
+};

package/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;
 };

package/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;
 };

package/model/convertedObjectIDsAfterSearch.ts

@@ -7,19 +7,19 @@ import type { ConversionEvent } from './conversionEvent';
  */
 export type ConvertedObjectIDsAfterSearch = {
   /**
-   * 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[];
 
@@ -29,17 +29,17 @@ export type ConvertedObjectIDsAfterSearch = {
   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;
 };

package/model/discount.ts

@@ -1,6 +1,6 @@
 // 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 in effect for this object, measured in `currency`.
+ * The absolute value of the discount for this product, in units of `currency`.
  */
 export type Discount = number | string;

package/model/index.ts

@@ -22,6 +22,7 @@ export * from './price';
 export * from './purchaseEvent';
 export * from './purchasedObjectIDs';
 export * from './purchasedObjectIDsAfterSearch';
+export * from './value';
 export * from './viewEvent';
 export * from './viewedFilters';
 export * from './viewedObjectIDs';

package/model/insightsEvents.ts

@@ -4,7 +4,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. Some attributes require other attributes to be declared, and some attributes can\'t be declared at the same time.  **All** events must be valid, otherwise the API returns an error.
+   * 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.
    */
   events: EventsItems[];
 };

package/model/objectData.ts

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

package/model/objectDataAfterSearch.ts

@@ -5,14 +5,14 @@ import type { Price } from './price';
 
 export type ObjectDataAfterSearch = {
   /**
-   * ID of the query that this specific record is attributable to. Used to track purchase events with multiple items originating from different searches.
+   * Unique identifier for a search query, used to track purchase events with multiple records that originate from different searches.
    */
   queryID?: string;
 
   price?: Price;
 
   /**
-   * The quantity of the purchased or added-to-cart item. The total value of a purchase is the sum of `quantity` multiplied with the `price` for each purchased item.
+   * 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?: number;
 

package/model/price.ts

@@ -1,6 +1,6 @@
 // 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 price of the item. This should be the final price, inclusive of any discounts in effect.
+ * The total price of a product, including any discounts, in units of `currency`.
  */
 export type Price = number | string;

package/model/purchasedObjectIDs.ts

@@ -3,13 +3,14 @@
 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 = {
   /**
-   * 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 PurchasedObjectIDs = {
   eventSubtype: PurchaseEvent;
 
   /**
-   * 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;
 };

package/model/purchasedObjectIDsAfterSearch.ts

@@ -3,13 +3,14 @@
 import type { ConversionEvent } from './conversionEvent';
 import type { ObjectDataAfterSearch } from './objectDataAfterSearch';
 import type { PurchaseEvent } from './purchaseEvent';
+import type { Value } from './value';
 
 /**
  * Use this event to track when users make a purchase after a previous Algolia request. If you\'re building your category pages with Algolia, you\'ll also use this event.
  */
 export type PurchasedObjectIDsAfterSearch = {
   /**
-   * 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,42 +19,39 @@ export type PurchasedObjectIDsAfterSearch = {
   eventSubtype: PurchaseEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   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.
+   * The object IDs of the records that are part of the event.
    */
-  queryID: string;
+  objectIDs: string[];
 
   /**
-   * List of object identifiers for items of an Algolia index.
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  objectIDs: string[];
+  userToken: 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 identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
    */
-  objectData?: ObjectDataAfterSearch[];
+  authenticatedUserToken?: 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.
+   * Three-letter [currency code](https://www.iso.org/iso-4217-currency-codes.html).
    */
   currency?: string;
 
   /**
-   * Anonymous or pseudonymous user identifier.   > **Note**: Never include personally identifiable information in user tokens.
+   * Extra information about the records involved in a purchase or add-to-cart events.  If provided, it must be the same length as `objectIDs`.
    */
-  userToken: string;
+  objectData?: ObjectDataAfterSearch[];
 
   /**
-   * 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.
+   * 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;
 
-  /**
-   * User token for authenticated users.
-   */
-  authenticatedUserToken?: string;
+  value?: Value;
 };

package/model/value.ts

@@ -0,0 +1,6 @@
+// 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 monetary value of this event in units of `currency`.
+ */
+export type Value = number | string;

package/model/viewedFilters.ts

@@ -7,14 +7,14 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedFilters = {
   /**
-   * 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: ViewEvent;
 
   /**
-   * Name of the Algolia index.
+   * The name of an Algolia index.
    */
   index: string;
 
@@ -24,17 +24,17 @@ export type ViewedFilters = {
   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;
 };

package/model/viewedObjectIDs.ts

@@ -7,34 +7,34 @@ import type { ViewEvent } from './viewEvent';
  */
 export type ViewedObjectIDs = {
   /**
-   * 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: ViewEvent;
 
   /**
-   * 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;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-insights",
-  "version": "5.0.0-alpha.90",
+  "version": "5.0.0-alpha.97",
   "description": "JavaScript client for client-insights",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -39,14 +39,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.91",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.91",
-    "@algolia/requester-node-http": "5.0.0-alpha.91"
+    "@algolia/client-common": "5.0.0-alpha.98",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.98",
+    "@algolia/requester-node-http": "5.0.0-alpha.98"
   },
   "devDependencies": {
-    "@types/node": "20.8.10",
-    "rollup": "4.3.0",
-    "typescript": "5.2.2"
+    "@types/node": "20.11.1",
+    "rollup": "4.9.5",
+    "typescript": "5.3.3"
   },
   "engines": {
     "node": ">= 14.0.0"