algoliasearch 5.0.0-alpha.9 → 5.0.0-alpha.90

package/dist/client-abtesting/src/abtestingClient.d.ts

@@ -1,125 +1,127 @@
-import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
-import type { ABTest } from '../model/aBTest';
-import type { ABTestResponse } from '../model/aBTestResponse';
-import type { AddABTestsRequest } from '../model/addABTestsRequest';
-import type { DelProps, DeleteABTestProps, GetProps, GetABTestProps, ListABTestsProps, PostProps, PutProps, StopABTestProps } from '../model/clientMethodProps';
-import type { ListABTestsResponse } from '../model/listABTestsResponse';
-export declare const apiClientVersion = "5.0.0-alpha.9";
-export declare const REGIONS: readonly ["de", "us"];
-export declare type Region = typeof REGIONS[number];
-export declare function createAbtestingClient({ 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;
-    /**
-     * Creates a new A/B test with provided configuration. You can set an A/B test on two different indices with different settings, or on the same index with different search parameters by providing a customSearchParameters setting on one of the variants.
-     *
-     * @summary Create a test.
-     * @param addABTestsRequest - The addABTestsRequest object.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
-    /**
-     * 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>>;
-    /**
-     * Delete a test.
-     *
-     * @summary Delete a test.
-     * @param deleteABTest - The deleteABTest object.
-     * @param deleteABTest.id - The A/B test ID.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
-    /**
-     * 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>>;
-    /**
-     * Returns metadata and metrics for an A/B test.
-     *
-     * @summary Get a test.
-     * @param getABTest - The getABTest object.
-     * @param getABTest.id - The A/B test ID.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
-    /**
-     * Fetch all existing A/B tests for App that are available for the current API Key. When no data has been processed, the metrics will be returned as null.
-     *
-     * @summary List all tests.
-     * @param listABTests - The listABTests object.
-     * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
-     * @param listABTests.limit - Number of records to return. Limit is the size of the page.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    listABTests({ offset, limit }: ListABTestsProps, requestOptions?: RequestOptions): Promise<ListABTestsResponse>;
-    /**
-     * 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 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>>;
-    /**
-     * Marks the A/B test as stopped. At this point, the test is over and cannot be restarted. As a result, your application is back to normal: index A will perform as usual, receiving 100% of all search requests. Associated metadata and metrics are still stored.
-     *
-     * @summary Stop a test.
-     * @param stopABTest - The stopABTest object.
-     * @param stopABTest.id - The A/B test ID.
-     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-     */
-    stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
-};
-/**
- * The client type.
- */
-export declare type AbtestingClient = ReturnType<typeof createAbtestingClient>;
+import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
+import type { ABTest } from '../model/aBTest';
+import type { ABTestResponse } from '../model/aBTestResponse';
+import type { AddABTestsRequest } from '../model/addABTestsRequest';
+import type { DelProps, DeleteABTestProps, GetProps, GetABTestProps, ListABTestsProps, PostProps, PutProps, StopABTestProps } from '../model/clientMethodProps';
+import type { ListABTestsResponse } from '../model/listABTestsResponse';
+export declare const apiClientVersion = "5.0.0-alpha.90";
+export declare const REGIONS: readonly ["de", "us"];
+export type Region = (typeof REGIONS)[number];
+export declare function createAbtestingClient({ 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;
+    /**
+     * Creates an A/B test.
+     *
+     * @summary Create an A/B test.
+     * @param addABTestsRequest - The addABTestsRequest object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    addABTests(addABTestsRequest: AddABTestsRequest, requestOptions?: RequestOptions): Promise<ABTestResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param del - The del object.
+     * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param del.parameters - Query parameters to apply to the current query.
+     * @param 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>>;
+    /**
+     * Delete an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     *
+     * @summary Delete an A/B test.
+     * @param deleteABTest - The deleteABTest object.
+     * @param deleteABTest.id - Unique A/B test ID.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param get - The get object.
+     * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param get.parameters - Query parameters to apply to the current query.
+     * @param 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>>;
+    /**
+     * Get specific details for an A/B test. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     *
+     * @summary Get A/B test details.
+     * @param getABTest - The getABTest object.
+     * @param getABTest.id - Unique A/B test ID.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
+    /**
+     * List all A/B tests.
+     *
+     * @summary List all A/B tests.
+     * @param listABTests - The listABTests object.
+     * @param listABTests.offset - Position of the starting record. Used for paging. 0 is the first record.
+     * @param listABTests.limit - Number of records to return (page size).
+     * @param listABTests.indexPrefix - Only return A/B tests for indices starting with this prefix.
+     * @param listABTests.indexSuffix - Only return A/B tests for indices ending with this suffix.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
+    /**
+     * This method allow you to send requests to the Algolia REST API.
+     *
+     * @summary Send requests to the Algolia REST API.
+     * @param post - The post object.
+     * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param post.parameters - Query parameters to apply to the current query.
+     * @param post.body - Parameters to send with the custom request.
+     * @param 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 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 - Path of the endpoint, anything after \"/1\" must be specified.
+     * @param put.parameters - Query parameters to apply to the current query.
+     * @param put.body - Parameters to send with the custom request.
+     * @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>>;
+    /**
+     * If stopped, the test is over and can\'t be restarted. There is now only one index, receiving 100% of all search requests. The data gathered for stopped A/B tests is retained. To determine the `id` for an A/B test, use the [`listABTests` operation](#tag/abtest/operation/listABTests).
+     *
+     * @summary Stop an A/B test.
+     * @param stopABTest - The stopABTest object.
+     * @param stopABTest.id - Unique A/B test ID.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
+};
+/**
+ * The client type.
+ */
+export type AbtestingClient = ReturnType<typeof createAbtestingClient>;
 //# sourceMappingURL=abtestingClient.d.ts.map

package/dist/client-abtesting/src/abtestingClient.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,oBAAY,MAAM,GAAG,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;AAW5C,wBAAgB,qBAAqB,CAAC,EACpC,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;;;;;;OAMG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;OAQG;mCAEkB,gBAAgB,mBAClB,cAAc,GAC9B,QAAQ,mBAAmB,CAAC;IAuB/B;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
+{"version":3,"file":"abtestingClient.d.ts","sourceRoot":"","sources":["../../../../client-abtesting/src/abtestingClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EACV,QAAQ,EACR,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,gBAAgB,EAChB,SAAS,EACT,QAAQ,EACR,eAAe,EAChB,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AAExE,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAEjD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAW9C,wBAAgB,qBAAqB,CAAC,EACpC,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;;;;;;OAMG;kCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAsC1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;yBAEO,iBAAiB,mBACR,cAAc,GAC9B,QAAQ,cAAc,CAAC;IAwB1B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;OAOG;sBAEO,cAAc,mBACL,cAAc,GAC9B,QAAQ,MAAM,CAAC;IAsBlB;;;;;;;;;;OAUG;8DAE4C,gBAAgB,mBAC7C,cAAc,GAAG,SAAS,GACzC,QAAQ,mBAAmB,CAAC;IA+B/B;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;OAOG;uBAEO,eAAe,mBACN,cAAc,GAC9B,QAAQ,cAAc,CAAC;EAwB7B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}

package/dist/client-analytics/model/averageClickEvent.d.ts

@@ -1,15 +1,15 @@
-export declare type AverageClickEvent = {
-    /**
-     * The average of all the click count event.
-     */
-    average: number;
-    /**
-     * The number of click event.
-     */
-    clickCount: number;
-    /**
-     * Date of the event.
-     */
-    date: string;
-};
+export type AverageClickEvent = {
+    /**
+     * Average count of all click events.
+     */
+    average: number;
+    /**
+     * Number of click events.
+     */
+    clickCount: number;
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+};
 //# sourceMappingURL=averageClickEvent.d.ts.map

package/dist/client-analytics/model/averageClickEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"averageClickEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/averageClickEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"averageClickEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/averageClickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client-analytics/model/clickPosition.d.ts

@@ -1,11 +1,11 @@
-export declare type ClickPosition = {
-    /**
-     * Range of positions with the following pattern: - Positions from 1 to 10 included are displayed in separated groups. - Positions from 11 to 20 included are grouped together. - Positions from 21 and up are grouped together.
-     */
-    position: number[];
-    /**
-     * The number of click event.
-     */
-    clickCount: number;
-};
+export type ClickPosition = {
+    /**
+     * Range of positions with the following pattern: - For positions 1 to 10, the number of click events are shown for each position - For positions 11 to 20, all click events are grouped - For positions 21 and up, all click events are grouped.
+     */
+    position: number[];
+    /**
+     * Number of click events.
+     */
+    clickCount: number;
+};
 //# sourceMappingURL=clickPosition.d.ts.map

package/dist/client-analytics/model/clickPosition.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clickPosition.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickPosition.ts"],"names":[],"mappings":"AAEA,oBAAY,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}
+{"version":3,"file":"clickPosition.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickPosition.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,QAAQ,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC"}

package/dist/client-analytics/model/clickThroughRateEvent.d.ts

@@ -1,19 +1,19 @@
-export declare type ClickThroughRateEvent = {
-    /**
-     * The click-through rate.
-     */
-    rate: number;
-    /**
-     * The number of click event.
-     */
-    clickCount: number;
-    /**
-     * The number of tracked search click.
-     */
-    trackedSearchCount: number;
-    /**
-     * Date of the event.
-     */
-    date: string;
-};
+export type ClickThroughRateEvent = {
+    /**
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     */
+    rate: number;
+    /**
+     * Number of click events.
+     */
+    clickCount: number;
+    /**
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     */
+    trackedSearchCount: number;
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+};
 //# sourceMappingURL=clickThroughRateEvent.d.ts.map

package/dist/client-analytics/model/clickThroughRateEvent.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"clickThroughRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickThroughRateEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"clickThroughRateEvent.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clickThroughRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}