@algolia/client-insights 5.0.0-alpha.53 → 5.0.0-alpha.55

package/dist/model/index.d.ts

@@ -1,7 +1,7 @@
-export * from './errorBase';
-export * from './eventType';
-export * from './insightEvent';
-export * from './insightEvents';
-export * from './pushEventsResponse';
-export * from './clientMethodProps';
+export * from './errorBase';
+export * from './eventType';
+export * from './insightEvent';
+export * from './insightEvents';
+export * from './pushEventsResponse';
+export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

package/dist/model/insightEvent.d.ts

@@ -1,40 +1,40 @@
-import type { EventType } from './eventType';
-/**
- * Insights event.
- */
-export type InsightEvent = {
-    eventType: EventType;
-    /**
-     * A user-defined string used to categorize events.
-     */
-    eventName: string;
-    /**
-     * Name of the targeted index.
-     */
-    index: string;
-    /**
-     * A user identifier. Depending if the user is logged-in or not, several strategies can be used from a sessionId to a technical identifier. You should always send pseudonymous or anonymous userTokens.
-     */
-    userToken: string;
-    /**
-     * Time of the event expressed in milliseconds since the Unix epoch.
-     */
-    timestamp?: number;
-    /**
-     * Algolia queryID. This is required when an event is tied to a search.
-     */
-    queryID?: string;
-    /**
-     * An array of index objectID. Limited to 20 objects. An event can’t have both objectIDs and filters at the same time.
-     */
-    objectIDs?: string[];
-    /**
-     * An array of filters. Limited to 10 filters. An event can’t have both objectIDs and filters at the same time.
-     */
-    filters?: string[];
-    /**
-     * Position of the click in the list of Algolia search results. This field is required if a queryID is provided. One position must be provided for each objectID.
-     */
-    positions?: number[];
-};
+import type { EventType } from './eventType';
+/**
+ * Insights event.
+ */
+export type InsightEvent = {
+    eventType: EventType;
+    /**
+     * A user-defined string used to categorize events.
+     */
+    eventName: string;
+    /**
+     * Name of the targeted index.
+     */
+    index: string;
+    /**
+     * A user identifier. Depending if the user is logged-in or not, several strategies can be used from a sessionId to a technical identifier. You should always send pseudonymous or anonymous userTokens.
+     */
+    userToken: string;
+    /**
+     * Time of the event expressed in milliseconds since the Unix epoch.
+     */
+    timestamp?: number;
+    /**
+     * Algolia queryID. This is required when an event is tied to a search.
+     */
+    queryID?: string;
+    /**
+     * An array of index objectID. Limited to 20 objects. An event can’t have both objectIDs and filters at the same time.
+     */
+    objectIDs?: string[];
+    /**
+     * An array of filters. Limited to 10 filters. An event can’t have both objectIDs and filters at the same time.
+     */
+    filters?: string[];
+    /**
+     * Position of the click in the list of Algolia search results. This field is required if a queryID is provided. One position must be provided for each objectID.
+     */
+    positions?: number[];
+};
 //# sourceMappingURL=insightEvent.d.ts.map

package/dist/model/insightEvents.d.ts

@@ -1,11 +1,11 @@
-import type { InsightEvent } from './insightEvent';
-/**
- * Object containing the events sent.
- */
-export type InsightEvents = {
-    /**
-     * Array of events sent.
-     */
-    events: InsightEvent[];
-};
+import type { InsightEvent } from './insightEvent';
+/**
+ * Object containing the events sent.
+ */
+export type InsightEvents = {
+    /**
+     * Array of events sent.
+     */
+    events: InsightEvent[];
+};
 //# sourceMappingURL=insightEvents.d.ts.map

package/dist/model/pushEventsResponse.d.ts

@@ -1,7 +1,7 @@
-export type PushEventsResponse = {
-    /**
-     * A message confirming the event push.
-     */
-    message: string;
-};
+export type PushEventsResponse = {
+    /**
+     * A message confirming the event push.
+     */
+    message: string;
+};
 //# sourceMappingURL=pushEventsResponse.d.ts.map

package/dist/src/insightsClient.d.ts

@@ -1,86 +1,86 @@
-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.53";
-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.
-     *
-     * @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 type InsightsClient = ReturnType<typeof createInsightsClient>;
+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.55";
+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.
+     *
+     * @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 type InsightsClient = ReturnType<typeof createInsightsClient>;
 //# sourceMappingURL=insightsClient.d.ts.map

package/model/clientMethodProps.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 /**
  * Properties for the `del` method.

package/model/errorBase.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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.
 
 /**
  * Error.

package/model/eventType.ts

@@ -1,3 +1,3 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 EventType = 'click' | 'conversion' | 'view';

package/model/index.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 * from './errorBase';
 export * from './eventType';

package/model/insightEvent.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { EventType } from './eventType';
 

package/model/insightEvents.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 { InsightEvent } from './insightEvent';
 

package/model/pushEventsResponse.ts

@@ -1,4 +1,4 @@
-// This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
+// 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 PushEventsResponse = {
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@algolia/client-insights",
-  "version": "5.0.0-alpha.53",
+  "version": "5.0.0-alpha.55",
   "description": "JavaScript client for client-insights",
   "repository": "algolia/algoliasearch-client-javascript",
   "license": "MIT",
@@ -38,14 +38,14 @@
     "clean": "rm -rf ./dist || true"
   },
   "dependencies": {
-    "@algolia/client-common": "5.0.0-alpha.53",
-    "@algolia/requester-browser-xhr": "5.0.0-alpha.53",
-    "@algolia/requester-node-http": "5.0.0-alpha.53"
+    "@algolia/client-common": "5.0.0-alpha.55",
+    "@algolia/requester-browser-xhr": "5.0.0-alpha.55",
+    "@algolia/requester-node-http": "5.0.0-alpha.55"
   },
   "devDependencies": {
-    "@types/node": "18.14.2",
+    "@types/node": "18.15.11",
     "rollup": "2.79.1",
-    "typescript": "4.9.5"
+    "typescript": "5.0.3"
   },
   "engines": {
     "node": ">= 14.0.0"