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

package/dist/model/objectDataAfterSearch.d.ts

@@ -2,12 +2,12 @@ import type { Discount } from './discount';
 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;
     discount?: Discount;

package/dist/model/price.d.ts

@@ -1,5 +1,5 @@
 /**
- * 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;
 //# sourceMappingURL=price.d.ts.map

package/dist/model/purchasedObjectIDs.d.ts

@@ -1,43 +1,45 @@
 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;
     eventType: ConversionEvent;
     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;
 };
 //# sourceMappingURL=purchasedObjectIDs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"purchasedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/purchasedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;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,UAAU,CAAC,EAAE,UAAU,EAAE,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC"}
+{"version":3,"file":"purchasedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/purchasedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;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,UAAU,EAAE,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}

package/dist/model/purchasedObjectIDsAfterSearch.d.ts

@@ -1,47 +1,45 @@
 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;
     eventType: ConversionEvent;
     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;
 };
 //# sourceMappingURL=purchasedObjectIDsAfterSearch.d.ts.map

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;AAErD;;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,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,UAAU,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,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,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC"}

package/dist/model/value.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Total monetary value of this event in units of `currency`.
+ */
+export type Value = number | string;
+//# sourceMappingURL=value.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../model/value.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC"}

package/dist/model/viewedFilters.d.ts

@@ -4,12 +4,12 @@ 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;
     /**
@@ -17,16 +17,16 @@ 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;
 };
 //# sourceMappingURL=viewedFilters.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"viewedFilters.d.ts","sourceRoot":"","sources":["../../model/viewedFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC"}
+{"version":3,"file":"viewedFilters.d.ts","sourceRoot":"","sources":["../../model/viewedFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/model/viewedObjectIDs.d.ts

@@ -4,29 +4,29 @@ 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;
 };
 //# sourceMappingURL=viewedObjectIDs.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"viewedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/viewedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC,CAAC"}
+{"version":3,"file":"viewedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/viewedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;IAErB;;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,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/src/insightsClient.d.ts

@@ -1,8 +1,8 @@
 import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { DelProps, GetProps, PostProps, PutProps } from '../model/clientMethodProps';
+import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteUserTokenProps } from '../model/clientMethodProps';
 import type { EventsResponse } from '../model/eventsResponse';
 import type { InsightsEvents } from '../model/insightsEvents';
-export declare const apiClientVersion = "5.0.0-alpha.91";
+export declare const apiClientVersion = "5.0.0-alpha.97";
 export declare const REGIONS: readonly ["de", "us"];
 export type Region = (typeof REGIONS)[number];
 export declare function createInsightsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -32,52 +32,61 @@ export declare function createInsightsClient({ appId: appIdOption, apiKey: apiKe
      * This method allow you to send requests to the Algolia REST API.
      *
      * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param del.parameters - Query parameters to apply to the current query.
+     * @param customDelete - The customDelete object.
+     * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customDelete.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
      * @summary Send requests to the Algolia REST API.
-     * @param get - The get object.
-     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param get.parameters - Query parameters to apply to the current query.
+     * @param customGet - The customGet object.
+     * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customGet.parameters - Query parameters to apply to the current query.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
      * This method allow you to send requests to the Algolia REST API.
      *
      * @summary Send requests to the Algolia REST API.
-     * @param post - The post object.
-     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param post.parameters - Query parameters to apply to the current query.
-     * @param post.body - Parameters to send with the custom request.
+     * @param customPost - The customPost object.
+     * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPost.parameters - Query parameters to apply to the current query.
+     * @param customPost.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * Send a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbsp;MB.
+     * This method allow you to send requests to the Algolia REST API.
      *
-     * @summary Send events.
-     * @param insightsEvents - The insightsEvents object.
+     * @summary Send requests to the Algolia REST API.
+     * @param customPut - The customPut object.
+     * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param customPut.parameters - Query parameters to apply to the current query.
+     * @param customPut.body - Parameters to send with the custom request.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    pushEvents(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<EventsResponse>;
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
     /**
-     * This method allow you to send requests to the Algolia REST API.
+     * Delete all events related to a certain user token from events metrics and analytics. To delete a personalization user profile, see [Delete a user profile](https://www.algolia.com/doc/rest-api/personalization/#delete-a-user-profile).
      *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
-     * @param put.parameters - Query parameters to apply to the current query.
-     * @param put.body - Parameters to send with the custom request.
+     * @summary Delete user token.
+     * @param deleteUserToken - The deleteUserToken object.
+     * @param deleteUserToken.userToken - The user token for which to delete all associated events.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    deleteUserToken({ userToken }: DeleteUserTokenProps, requestOptions?: RequestOptions): Promise<void>;
+    /**
+     * Send a list of events to the Insights API.  You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbsp;MB.
+     *
+     * @summary Send events.
+     * @param insightsEvents - The insightsEvents object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    pushEvents(insightsEvents: InsightsEvents, requestOptions?: RequestOptions): Promise<EventsResponse>;
 };
 /**
  * The client type.

package/dist/src/insightsClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"insightsClient.d.ts","sourceRoot":"","sources":["../../src/insightsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,QAAQ,EACT,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,oBAAoB,CAAC,EACnC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;OAMG;+BAEe,cAAc,mBACb,cAAc,GAC9B,QAAQ,cAAc,CAAC;IA4B1B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;EAoBlC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}
+{"version":3,"file":"insightsClient.d.ts","sourceRoot":"","sources":["../../src/insightsClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,oBAAoB,EACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAE9D,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,oBAAoB,CAAC,EACnC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE;;IAwBxC;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;;OASG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;OASG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;OAOG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IAwBhB;;;;;;OAMG;+BAEe,cAAc,mBACb,cAAc,GAC9B,QAAQ,cAAc,CAAC;EA4B7B;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

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

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

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

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