@algolia/client-insights 5.0.0-alpha.10 → 5.0.0-alpha.101

package/dist/model/clickEvent.d.ts

@@ -0,0 +1,2 @@
+export type ClickEvent = 'click';
+//# sourceMappingURL=clickEvent.d.ts.map

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

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

package/dist/model/clickedFilters.d.ts

@@ -0,0 +1,32 @@
+import type { ClickEvent } from './clickEvent';
+/**
+ * Use this event to track when users click facet filters in your user interface.
+ */
+export type ClickedFilters = {
+    /**
+     * 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;
+    /**
+     * 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=clickedFilters.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clickedFilters.d.ts","sourceRoot":"","sources":["../../model/clickedFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;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/clickedObjectIDs.d.ts

@@ -0,0 +1,32 @@
+import type { ClickEvent } from './clickEvent';
+/**
+ * Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don\'t use Algolia to build your category pages, use this event.  To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event.
+ */
+export type ClickedObjectIDs = {
+    /**
+     * 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;
+    /**
+     * 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=clickedObjectIDs.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clickedObjectIDs.d.ts","sourceRoot":"","sources":["../../model/clickedObjectIDs.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;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/clickedObjectIDsAfterSearch.d.ts

@@ -0,0 +1,40 @@
+import type { ClickEvent } from './clickEvent';
+/**
+ * Click event after an Algolia request.  Use this event to track when users click items in the search results. If you\'re building your category pages with Algolia, you\'ll also use this event.
+ */
+export type ClickedObjectIDsAfterSearch = {
+    /**
+     * 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;
+    /**
+     * The name of an Algolia index.
+     */
+    index: string;
+    /**
+     * The object IDs of the records that are part of the event.
+     */
+    objectIDs: string[];
+    /**
+     * 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[];
+    /**
+     * 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=clickedObjectIDsAfterSearch.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clickedObjectIDsAfterSearch.d.ts","sourceRoot":"","sources":["../../model/clickedObjectIDsAfterSearch.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IAEpB;;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/clientMethodProps.d.ts

@@ -1,61 +1,70 @@
-/**
- * Properties for the `del` method.
- */
-export declare type DelProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `get` method.
- */
-export declare type GetProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-};
-/**
- * Properties for the `post` method.
- */
-export declare type PostProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
-/**
- * Properties for the `put` method.
- */
-export declare type PutProps = {
-    /**
-     * The path of the API endpoint to target, anything after the /1 needs to be specified.
-     */
-    path: string;
-    /**
-     * Query parameters to be applied to the current query.
-     */
-    parameters?: Record<string, any>;
-    /**
-     * The parameters to send with the custom request.
-     */
-    body?: Record<string, any>;
-};
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, any>;
+};
+/**
+ * Properties for the `deleteUserToken` method.
+ */
+export type DeleteUserTokenProps = {
+    /**
+     * The user token for which to delete all associated events.
+     */
+    userToken: string;
+};
 //# sourceMappingURL=clientMethodProps.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,oBAAY,QAAQ,GAAG;IACrB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC"}
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC5B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/conversionEvent.d.ts

@@ -0,0 +1,2 @@
+export type ConversionEvent = 'conversion';
+//# sourceMappingURL=conversionEvent.d.ts.map

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

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

package/dist/model/convertedFilters.d.ts

@@ -0,0 +1,29 @@
+import type { ConversionEvent } from './conversionEvent';
+export type ConvertedFilters = {
+    /**
+     * 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;
+    /**
+     * 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=convertedFilters.d.ts.map

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

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

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

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

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

@@ -1,7 +1,28 @@
-export * from './errorBase';
-export * from './eventType';
-export * from './insightEvent';
-export * from './insightEvents';
-export * from './pushEventsResponse';
-export * from './clientMethodProps';
+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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../model/index.ts"],"names":[],"mappings":"AAEA,cAAc,aAAa,CAAC;AAC5B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC"}
+{"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"}