@algolia/client-insights 0.0.0 → 5.0.0-alpha.100

package/dist/model/convertedObjectIDs.d.ts

@@ -0,0 +1,32 @@
+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 = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: string[];
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * 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;
+};
+//# sourceMappingURL=convertedObjectIDs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/convertedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B;;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/model/convertedObjectIDsAfterSearch.d.ts

@@ -0,0 +1,36 @@
+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 = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: 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;
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * 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;
+};
+//# sourceMappingURL=convertedObjectIDsAfterSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"convertedObjectIDsAfterSearch.d.ts","sourceRoot":"","sources":["../../model/convertedObjectIDsAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,eAAe,CAAC;IAE3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;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/discount.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The absolute value of the discount for this product, in units of `currency`.
+ */
+export type Discount = number | string;
+//# sourceMappingURL=discount.d.ts.map

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

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

package/dist/model/errorBase.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Error.
+ */
+export type ErrorBase = Record<string, any> & {
+    message?: string;
+};
+//# sourceMappingURL=errorBase.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

package/dist/model/eventsItems.d.ts

@@ -0,0 +1,14 @@
+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 = AddedToCartObjectIDs | AddedToCartObjectIDsAfterSearch | ClickedFilters | ClickedObjectIDs | ClickedObjectIDsAfterSearch | ConvertedFilters | ConvertedObjectIDs | ConvertedObjectIDsAfterSearch | PurchasedObjectIDs | PurchasedObjectIDsAfterSearch | ViewedFilters | ViewedObjectIDs;
+//# sourceMappingURL=eventsItems.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventsItems.d.ts","sourceRoot":"","sources":["../../model/eventsItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AACzF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACrF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,WAAW,GACnB,oBAAoB,GACpB,+BAA+B,GAC/B,cAAc,GACd,gBAAgB,GAChB,2BAA2B,GAC3B,gBAAgB,GAChB,kBAAkB,GAClB,6BAA6B,GAC7B,kBAAkB,GAClB,6BAA6B,GAC7B,aAAa,GACb,eAAe,CAAC"}

package/dist/model/eventsResponse.d.ts

@@ -0,0 +1,14 @@
+/**
+ * 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;
+};
+//# sourceMappingURL=eventsResponse.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"eventsResponse.d.ts","sourceRoot":"","sources":["../../model/eventsResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/index.d.ts

@@ -0,0 +1,28 @@
+export * from './addToCartEvent';
+export * from './addedToCartObjectIDs';
+export * from './addedToCartObjectIDsAfterSearch';
+export * from './clickEvent';
+export * from './clickedFilters';
+export * from './clickedObjectIDs';
+export * from './clickedObjectIDsAfterSearch';
+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 './purchaseEvent';
+export * from './purchasedObjectIDs';
+export * from './purchasedObjectIDsAfterSearch';
+export * from './value';
+export * from './viewEvent';
+export * from './viewedFilters';
+export * from './viewedObjectIDs';
+export * from './clientMethodProps';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,kBAAkB,CAAC;AACjC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mCAAmC,CAAC;AAClD,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,cAAc,CAAC;AAC7B,cAAc,yBAAyB,CAAC;AACxC,cAAc,SAAS,CAAC;AACxB,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iCAAiC,CAAC;AAChD,cAAc,SAAS,CAAC;AACxB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC"}

package/dist/model/insightsEvents.d.ts

@@ -0,0 +1,8 @@
+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.  **All** events must be valid, otherwise the API returns an error.
+     */
+    events: EventsItems[];
+};
+//# sourceMappingURL=insightsEvents.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insightsEvents.d.ts","sourceRoot":"","sources":["../../model/insightsEvents.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAEjD,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,MAAM,EAAE,WAAW,EAAE,CAAC;CACvB,CAAC"}

package/dist/model/objectData.d.ts

@@ -0,0 +1,11 @@
+import type { Discount } from './discount';
+import type { Price } from './price';
+export type ObjectData = {
+    price?: Price;
+    /**
+     * 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;
+};
+//# sourceMappingURL=objectData.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"objectData.d.ts","sourceRoot":"","sources":["../../model/objectData.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,MAAM,UAAU,GAAG;IACvB,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC"}

package/dist/model/objectDataAfterSearch.d.ts

@@ -0,0 +1,15 @@
+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;
+    /**
+     * 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;
+};
+//# sourceMappingURL=objectDataAfterSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"objectDataAfterSearch.d.ts","sourceRoot":"","sources":["../../model/objectDataAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB,CAAC"}

package/dist/model/price.d.ts

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

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

package/dist/model/purchaseEvent.d.ts

@@ -0,0 +1,2 @@
+export type PurchaseEvent = 'purchase';
+//# sourceMappingURL=purchaseEvent.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"purchaseEvent.d.ts","sourceRoot":"","sources":["../../model/purchaseEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC"}

package/dist/model/purchasedObjectIDs.d.ts

@@ -0,0 +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 = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: string[];
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    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?: ObjectData[];
+    /**
+     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     */
+    timestamp?: number;
+    value?: Value;
+};
+//# sourceMappingURL=purchasedObjectIDs.d.ts.map

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

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

@@ -0,0 +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 = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: string[];
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    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?: ObjectDataAfterSearch[];
+    /**
+     * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+     */
+    timestamp?: number;
+    value?: Value;
+};
+//# sourceMappingURL=purchasedObjectIDsAfterSearch.d.ts.map

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

@@ -0,0 +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;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/viewEvent.d.ts

@@ -0,0 +1,2 @@
+export type ViewEvent = 'view';
+//# sourceMappingURL=viewEvent.d.ts.map

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

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

package/dist/model/viewedFilters.d.ts

@@ -0,0 +1,32 @@
+import type { ViewEvent } from './viewEvent';
+/**
+ * Use this method to capture active filters. For example, when browsing a category page, users see content filtered on that specific category.
+ */
+export type ViewedFilters = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * Facet filters.  Each facet filter string must be URL-encoded, such as, `discount:10%25`.
+     */
+    filters: string[];
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * 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;
+};
+//# sourceMappingURL=viewedFilters.d.ts.map

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

@@ -0,0 +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,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/model/viewedObjectIDs.d.ts

@@ -0,0 +1,32 @@
+import type { ViewEvent } from './viewEvent';
+/**
+ * Use this event to track when users viewed items in the search results.
+ */
+export type ViewedObjectIDs = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: string[];
+    /**
+     * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+     */
+    userToken: string;
+    /**
+     * 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;
+};
+//# sourceMappingURL=viewedObjectIDs.d.ts.map

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

@@ -0,0 +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,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/src/insightsClient.d.ts

@@ -0,0 +1,89 @@
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+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.100";
+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 & {
+    region?: Region;
+}): {
+    transporter: import("@algolia/client-common").Transporter;
+    /**
+     * The `appId` currently in use.
+     */
+    appId: string;
+    /**
+     * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
+     */
+    clearCache(): Promise<void>;
+    /**
+     * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
+     */
+    readonly _ua: string;
+    /**
+     * Adds a `segment` to the `x-algolia-agent` sent with every requests.
+     *
+     * @param segment - The algolia agent (user-agent) segment to add.
+     * @param version - The version of the agent.
+     */
+    addAlgoliaAgent(segment: string, version?: string): void;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @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.
+     */
+    customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @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.
+     */
+    customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @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.
+     */
+    customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * This method allow you to 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.
+     */
+    customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
+    /**
+     * 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).
+     *
+     * @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.
+     */
+    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.
+     *
+     * @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.
+ */
+export type InsightsClient = ReturnType<typeof createInsightsClient>;
+//# sourceMappingURL=insightsClient.d.ts.map

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

@@ -0,0 +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,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,oBAAoB,CAAC;AAElD,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;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;OAMG;mCAEc,oBAAoB,mBAClB,cAAc,GAC9B,QAAQ,IAAI,CAAC;IAwBhB;;;;;OAKG;+BAEe,cAAc,mBACb,cAAc,GAC9B,QAAQ,cAAc,CAAC;EA4B7B;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC"}

package/index.d.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-unresolved
+export * from './dist/builds/node';

package/index.js

@@ -0,0 +1,2 @@
+// eslint-disable-next-line import/no-commonjs,import/extensions
+module.exports = require('./dist/client-insights.cjs');

package/model/addToCartEvent.ts

@@ -0,0 +1,3 @@
+// 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 AddToCartEvent = 'addToCart';

package/model/addedToCartObjectIDs.ts

@@ -0,0 +1,57 @@
+// 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 { 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 = {
+  /**
+   * 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: AddToCartEvent;
+
+  /**
+   * The name of an Algolia index.
+   */
+  index: string;
+
+  /**
+   * The object IDs of the records that are part of the event.
+   */
+  objectIDs: string[];
+
+  /**
+   * An anonymous or pseudonymous user identifier.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  userToken: string;
+
+  /**
+   * An identifier for authenticated users.  > **Note**: Never include personally identifiable information in user tokens.
+   */
+  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?: ObjectData[];
+
+  /**
+   * The timestamp of the event in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time). By default, the Insights API uses the time it receives an event as its timestamp.
+   */
+  timestamp?: number;
+
+  value?: Value;
+};