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

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

@@ -1,86 +1,89 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { DelProps, GetProps, PostProps, PutProps } from '../model/clientMethodProps';
-import type { InsightEvents } from '../model/insightEvents';
-import type { PushEventsResponse } from '../model/pushEventsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.10";
-export declare const REGIONS: readonly ["de", "us"];
-export declare 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.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param del - The del object.
-     * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param del.parameters - Query parameters to be applied 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>>;
-    /**
-     * 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 - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param get.parameters - Query parameters to be applied 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>>;
-    /**
-     * 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 - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param post.parameters - Query parameters to be applied to the current query.
-     * @param post.body - The 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>>;
-    /**
-     * This command pushes an array of events.  An event is   - an action: `eventName`   - performed in a context: `eventType`   - at some point in time provided: `timestamp`   - by an end user: `userToken`   - on something: `index`   Notes:   - To be accepted, all events sent must be valid.   - The size of the body must be *less than 2 MB*.   - When an event is tied to an Algolia search, it must also provide a `queryID`. If that event is a `click`, their absolute `positions` should also be passed.   - We consider that an `index` provides access to 2 resources: objects and filters. An event can only interact with a single resource type, but not necessarily on a single item. As such an event will accept an array of `objectIDs` or `filters`.
-     *
-     * @summary Push events.
-     * @param insightEvents - The insightEvents object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    pushEvents(insightEvents: InsightEvents, requestOptions?: RequestOptions): Promise<PushEventsResponse>;
-    /**
-     * This method allow you to send requests to the Algolia REST API.
-     *
-     * @summary Send requests to the Algolia REST API.
-     * @param put - The put object.
-     * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
-     * @param put.parameters - Query parameters to be applied to the current query.
-     * @param put.body - The 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.
-     */
-    put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
-};
-/**
- * The client type.
- */
-export declare type InsightsClient = ReturnType<typeof createInsightsClient>;
+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

@@ -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,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAEtE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAW5C,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;8BAEc,aAAa,mBACX,cAAc,GAC9B,QAAQ,kBAAkB,CAAC;IA4B9B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;EAoBlC;AAED;;GAEG;AACH,oBAAY,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,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.js

@@ -1,2 +1,2 @@
 // eslint-disable-next-line import/no-commonjs,import/extensions
-module.exports = require('./dist/client-insights.cjs.js');
+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;
+};

package/model/addedToCartObjectIDsAfterSearch.ts

@@ -0,0 +1,62 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { AddToCartEvent } from './addToCartEvent';
+import type { ConversionEvent } from './conversionEvent';
+import type { ObjectDataAfterSearch } from './objectDataAfterSearch';
+import type { Value } from './value';
+
+/**
+ * Use this event to track when users add items to their shopping cart after a previous Algolia request. If you\'re building your category pages with Algolia, you\'ll also use this event.
+ */
+export type AddedToCartObjectIDsAfterSearch = {
+  /**
+   * 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;
+
+  /**
+   * 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;
+
+  /**
+   * 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;
+};

package/model/clickEvent.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 ClickEvent = 'click';

package/model/clickedFilters.ts

@@ -0,0 +1,40 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ClickEvent } from './clickEvent';
+
+/**
+ * Use this event to track when users click facet filters in your user interface.
+ */
+export type ClickedFilters = {
+  /**
+   * 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;
+};

package/model/clickedObjectIDs.ts

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

package/model/clickedObjectIDsAfterSearch.ts

@@ -0,0 +1,50 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+import type { ClickEvent } from './clickEvent';
+
+/**
+ * Click event after an Algolia request.  Use this event to track when users click items in the search results. If you\'re building your category pages with Algolia, you\'ll also use this event.
+ */
+export type ClickedObjectIDsAfterSearch = {
+  /**
+   * 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;
+};