@algolia/client-analytics 5.0.0-alpha.8 → 5.0.0-alpha.80

package/dist/model/getTopFiltersNoResultsValue.d.ts

@@ -1,15 +1,15 @@
-export declare type GetTopFiltersNoResultsValue = {
-    /**
-     * The attribute.
-     */
-    attribute: string;
-    /**
-     * The operator.
-     */
-    operator: string;
-    /**
-     * The value of the attribute.
-     */
-    value: string;
-};
+export type GetTopFiltersNoResultsValue = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    /**
+     * Operator.
+     */
+    operator: string;
+    /**
+     * Attribute value.
+     */
+    value: string;
+};
 //# sourceMappingURL=getTopFiltersNoResultsValue.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTopFiltersNoResultsValue.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValue.ts"],"names":[],"mappings":"AAEA,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"getTopFiltersNoResultsValue.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValue.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/getTopFiltersNoResultsValues.d.ts

@@ -1,12 +1,12 @@
-import type { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
-export declare type GetTopFiltersNoResultsValues = {
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * A list of filters without results.
-     */
-    values: GetTopFiltersNoResultsValue[];
-};
+import type { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
+export type GetTopFiltersNoResultsValues = {
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Filters with no results.
+     */
+    values: GetTopFiltersNoResultsValue[];
+};
 //# sourceMappingURL=getTopFiltersNoResultsValues.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTopFiltersNoResultsValues.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValues.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,2BAA2B,EAAE,CAAC;CACvC,CAAC"}
+{"version":3,"file":"getTopFiltersNoResultsValues.d.ts","sourceRoot":"","sources":["../../model/getTopFiltersNoResultsValues.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,2BAA2B,EAAE,CAAC;CACvC,CAAC"}

package/dist/model/getTopHitsResponse.d.ts

@@ -1,4 +1,4 @@
-import type { TopHitsResponse } from './topHitsResponse';
-import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
-export declare type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
+import type { TopHitsResponse } from './topHitsResponse';
+import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
+export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
 //# sourceMappingURL=getTopHitsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTopHitsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,oBAAY,kBAAkB,GAAG,eAAe,GAAG,4BAA4B,CAAC"}
+{"version":3,"file":"getTopHitsResponse.d.ts","sourceRoot":"","sources":["../../model/getTopHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AAEnF,MAAM,MAAM,kBAAkB,GAAG,eAAe,GAAG,4BAA4B,CAAC"}

package/dist/model/getTopSearchesResponse.d.ts

@@ -1,4 +1,4 @@
-import type { TopSearchesResponse } from './topSearchesResponse';
-import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
-export declare type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics;
+import type { TopSearchesResponse } from './topSearchesResponse';
+import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
+export type GetTopSearchesResponse = TopSearchesResponse | TopSearchesResponseWithAnalytics;
 //# sourceMappingURL=getTopSearchesResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getTopSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/getTopSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAE3F,oBAAY,sBAAsB,GAC9B,mBAAmB,GACnB,gCAAgC,CAAC"}
+{"version":3,"file":"getTopSearchesResponse.d.ts","sourceRoot":"","sources":["../../model/getTopSearchesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,oCAAoC,CAAC;AAE3F,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,gCAAgC,CAAC"}

package/dist/model/getUsersCountResponse.d.ts

@@ -1,12 +1,12 @@
-import type { UserWithDate } from './userWithDate';
-export declare type GetUsersCountResponse = {
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * A list of users count with their date.
-     */
-    dates: UserWithDate[];
-};
+import type { UserWithDate } from './userWithDate';
+export type GetUsersCountResponse = {
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * User count.
+     */
+    dates: UserWithDate[];
+};
 //# sourceMappingURL=getUsersCountResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"getUsersCountResponse.d.ts","sourceRoot":"","sources":["../../model/getUsersCountResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,oBAAY,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB,CAAC"}
+{"version":3,"file":"getUsersCountResponse.d.ts","sourceRoot":"","sources":["../../model/getUsersCountResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB,CAAC"}

package/dist/model/index.d.ts

@@ -1,45 +1,45 @@
-export * from './averageClickEvent';
-export * from './clickPosition';
-export * from './clickThroughRateEvent';
-export * from './conversionRateEvent';
-export * from './direction';
-export * from './errorBase';
-export * from './getAverageClickPositionResponse';
-export * from './getClickPositionsResponse';
-export * from './getClickThroughRateResponse';
-export * from './getConversationRateResponse';
-export * from './getNoClickRateResponse';
-export * from './getNoResultsRateResponse';
-export * from './getSearchesCountResponse';
-export * from './getSearchesNoClicksResponse';
-export * from './getSearchesNoResultsResponse';
-export * from './getStatusResponse';
-export * from './getTopCountriesResponse';
-export * from './getTopFilterAttribute';
-export * from './getTopFilterAttributesResponse';
-export * from './getTopFilterForAttribute';
-export * from './getTopFilterForAttributeResponse';
-export * from './getTopFiltersNoResultsResponse';
-export * from './getTopFiltersNoResultsValue';
-export * from './getTopFiltersNoResultsValues';
-export * from './getTopHitsResponse';
-export * from './getTopSearchesResponse';
-export * from './getUsersCountResponse';
-export * from './noClickRateEvent';
-export * from './noResultsRateEvent';
-export * from './orderBy';
-export * from './searchEvent';
-export * from './searchNoClickEvent';
-export * from './searchNoResultEvent';
-export * from './topCountry';
-export * from './topHit';
-export * from './topHitWithAnalytics';
-export * from './topHitsResponse';
-export * from './topHitsResponseWithAnalytics';
-export * from './topSearch';
-export * from './topSearchWithAnalytics';
-export * from './topSearchesResponse';
-export * from './topSearchesResponseWithAnalytics';
-export * from './userWithDate';
-export * from './clientMethodProps';
+export * from './averageClickEvent';
+export * from './clickPosition';
+export * from './clickThroughRateEvent';
+export * from './conversionRateEvent';
+export * from './direction';
+export * from './errorBase';
+export * from './getAverageClickPositionResponse';
+export * from './getClickPositionsResponse';
+export * from './getClickThroughRateResponse';
+export * from './getConversationRateResponse';
+export * from './getNoClickRateResponse';
+export * from './getNoResultsRateResponse';
+export * from './getSearchesCountResponse';
+export * from './getSearchesNoClicksResponse';
+export * from './getSearchesNoResultsResponse';
+export * from './getStatusResponse';
+export * from './getTopCountriesResponse';
+export * from './getTopFilterAttribute';
+export * from './getTopFilterAttributesResponse';
+export * from './getTopFilterForAttribute';
+export * from './getTopFilterForAttributeResponse';
+export * from './getTopFiltersNoResultsResponse';
+export * from './getTopFiltersNoResultsValue';
+export * from './getTopFiltersNoResultsValues';
+export * from './getTopHitsResponse';
+export * from './getTopSearchesResponse';
+export * from './getUsersCountResponse';
+export * from './noClickRateEvent';
+export * from './noResultsRateEvent';
+export * from './orderBy';
+export * from './searchEvent';
+export * from './searchNoClickEvent';
+export * from './searchNoResultEvent';
+export * from './topCountry';
+export * from './topHit';
+export * from './topHitWithAnalytics';
+export * from './topHitsResponse';
+export * from './topHitsResponseWithAnalytics';
+export * from './topSearch';
+export * from './topSearchWithAnalytics';
+export * from './topSearchesResponse';
+export * from './topSearchesResponseWithAnalytics';
+export * from './userWithDate';
+export * from './clientMethodProps';
 //# sourceMappingURL=index.d.ts.map

package/dist/model/noClickRateEvent.d.ts

@@ -1,19 +1,19 @@
-export declare type NoClickRateEvent = {
-    /**
-     * The click-through rate.
-     */
-    rate: number;
-    /**
-     * The number of click event.
-     */
-    count: number;
-    /**
-     * The number of click event.
-     */
-    noClickCount: number;
-    /**
-     * Date of the event.
-     */
-    date: string;
-};
+export type NoClickRateEvent = {
+    /**
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     */
+    rate: number;
+    /**
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     */
+    count: number;
+    /**
+     * Number of click events.
+     */
+    noClickCount: number;
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+};
 //# sourceMappingURL=noClickRateEvent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"noClickRateEvent.d.ts","sourceRoot":"","sources":["../../model/noClickRateEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"noClickRateEvent.d.ts","sourceRoot":"","sources":["../../model/noClickRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/model/noResultsRateEvent.d.ts

@@ -1,19 +1,19 @@
-export declare type NoResultsRateEvent = {
-    /**
-     * Date of the event.
-     */
-    date: string;
-    /**
-     * The number of occurrences.
-     */
-    noResultCount: number;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * The click-through rate.
-     */
-    rate: number;
-};
+export type NoResultsRateEvent = {
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of occurences.
+     */
+    noResultCount: number;
+    /**
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     */
+    count: number;
+    /**
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     */
+    rate: number;
+};
 //# sourceMappingURL=noResultsRateEvent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"noResultsRateEvent.d.ts","sourceRoot":"","sources":["../../model/noResultsRateEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
+{"version":3,"file":"noResultsRateEvent.d.ts","sourceRoot":"","sources":["../../model/noResultsRateEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/model/orderBy.d.ts

@@ -1,2 +1,5 @@
-export declare type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
+/**
+ * Method for ordering results. `clickThroughRate`, `conversionRate` and `averageClickPosition` are only available if the `clickAnalytics` parameter is `true`.
+ */
+export type OrderBy = 'averageClickPosition' | 'clickThroughRate' | 'conversionRate' | 'searchCount';
 //# sourceMappingURL=orderBy.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"orderBy.d.ts","sourceRoot":"","sources":["../../model/orderBy.ts"],"names":[],"mappings":"AAEA,oBAAY,OAAO,GACf,sBAAsB,GACtB,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,CAAC"}
+{"version":3,"file":"orderBy.d.ts","sourceRoot":"","sources":["../../model/orderBy.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,OAAO,GACf,sBAAsB,GACtB,kBAAkB,GAClB,gBAAgB,GAChB,aAAa,CAAC"}

package/dist/model/searchEvent.d.ts

@@ -1,11 +1,11 @@
-export declare type SearchEvent = {
-    /**
-     * Date of the event.
-     */
-    date: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-};
+export type SearchEvent = {
+    /**
+     * Date of the event in the format YYYY-MM-DD.
+     */
+    date: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
 //# sourceMappingURL=searchEvent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchEvent.d.ts","sourceRoot":"","sources":["../../model/searchEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"searchEvent.d.ts","sourceRoot":"","sources":["../../model/searchEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/searchNoClickEvent.d.ts

@@ -1,15 +1,15 @@
-export declare type SearchNoClickEvent = {
-    /**
-     * The search query.
-     */
-    search: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * The number of occurrences.
-     */
-    withFilterCount: number;
-};
+export type SearchNoClickEvent = {
+    /**
+     * User query.
+     */
+    search: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Number of occurrences.
+     */
+    withFilterCount: number;
+};
 //# sourceMappingURL=searchNoClickEvent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchNoClickEvent.d.ts","sourceRoot":"","sources":["../../model/searchNoClickEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}
+{"version":3,"file":"searchNoClickEvent.d.ts","sourceRoot":"","sources":["../../model/searchNoClickEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/model/searchNoResultEvent.d.ts

@@ -1,15 +1,15 @@
-export declare type SearchNoResultEvent = {
-    /**
-     * The search query.
-     */
-    search: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+export type SearchNoResultEvent = {
+    /**
+     * User query.
+     */
+    search: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * Number of hits the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=searchNoResultEvent.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"searchNoResultEvent.d.ts","sourceRoot":"","sources":["../../model/searchNoResultEvent.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"searchNoResultEvent.d.ts","sourceRoot":"","sources":["../../model/searchNoResultEvent.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}

package/dist/model/topCountry.d.ts

@@ -1,11 +1,11 @@
-export declare type TopCountry = {
-    /**
-     * The country.
-     */
-    country: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-};
+export type TopCountry = {
+    /**
+     * Country.
+     */
+    country: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
 //# sourceMappingURL=topCountry.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topCountry.d.ts","sourceRoot":"","sources":["../../model/topCountry.ts"],"names":[],"mappings":"AAEA,oBAAY,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"topCountry.d.ts","sourceRoot":"","sources":["../../model/topCountry.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/topHit.d.ts

@@ -1,11 +1,11 @@
-export declare type TopHit = {
-    /**
-     * The hit.
-     */
-    hit: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-};
+export type TopHit = {
+    /**
+     * Hit.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+};
 //# sourceMappingURL=topHit.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topHit.d.ts","sourceRoot":"","sources":["../../model/topHit.ts"],"names":[],"mappings":"AAEA,oBAAY,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}
+{"version":3,"file":"topHit.d.ts","sourceRoot":"","sources":["../../model/topHit.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC"}

package/dist/model/topHitWithAnalytics.d.ts

@@ -1,31 +1,31 @@
-export declare type TopHitWithAnalytics = {
-    /**
-     * The hit.
-     */
-    hit: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * The click-through rate.
-     */
-    clickThroughRate: number;
-    /**
-     * The conversion rate.
-     */
-    conversionRate: number;
-    /**
-     * The number of tracked search click.
-     */
-    trackedSearchCount: number;
-    /**
-     * The number of click event.
-     */
-    clickCount: number;
-    /**
-     * The number of converted clicks.
-     */
-    conversionCount: number;
-};
+export type TopHitWithAnalytics = {
+    /**
+     * Hit.
+     */
+    hit: string;
+    /**
+     * Number of occurrences.
+     */
+    count: number;
+    /**
+     * [Click-through rate (CTR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate).
+     */
+    clickThroughRate: number;
+    /**
+     * [Conversion rate (CR)](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate).
+     */
+    conversionRate: number;
+    /**
+     * Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of click events.
+     */
+    clickCount: number;
+    /**
+     * Number of converted clicks.
+     */
+    conversionCount: number;
+};
 //# sourceMappingURL=topHitWithAnalytics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topHitWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitWithAnalytics.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}
+{"version":3,"file":"topHitWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitWithAnalytics.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC"}

package/dist/model/topHitsResponse.d.ts

@@ -1,8 +1,8 @@
-import type { TopHit } from './topHit';
-export declare type TopHitsResponse = {
-    /**
-     * A list of top hits with their count.
-     */
-    hits: TopHit[];
-};
+import type { TopHit } from './topHit';
+export type TopHitsResponse = {
+    /**
+     * Top hits.
+     */
+    hits: TopHit[];
+};
 //# sourceMappingURL=topHitsResponse.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topHitsResponse.d.ts","sourceRoot":"","sources":["../../model/topHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}
+{"version":3,"file":"topHitsResponse.d.ts","sourceRoot":"","sources":["../../model/topHitsResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB,CAAC"}

package/dist/model/topHitsResponseWithAnalytics.d.ts

@@ -1,8 +1,8 @@
-import type { TopHitWithAnalytics } from './topHitWithAnalytics';
-export declare type TopHitsResponseWithAnalytics = {
-    /**
-     * A list of top hits with their count and analytics.
-     */
-    hits: TopHitWithAnalytics[];
-};
+import type { TopHitWithAnalytics } from './topHitWithAnalytics';
+export type TopHitsResponseWithAnalytics = {
+    /**
+     * Top hits.
+     */
+    hits: TopHitWithAnalytics[];
+};
 //# sourceMappingURL=topHitsResponseWithAnalytics.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topHitsResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitsResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,oBAAY,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B,CAAC"}
+{"version":3,"file":"topHitsResponseWithAnalytics.d.ts","sourceRoot":"","sources":["../../model/topHitsResponseWithAnalytics.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,mBAAmB,EAAE,CAAC;CAC7B,CAAC"}

package/dist/model/topSearch.d.ts

@@ -1,15 +1,15 @@
-export declare type TopSearch = {
-    /**
-     * The search query.
-     */
-    search: string;
-    /**
-     * The number of occurrences.
-     */
-    count: number;
-    /**
-     * Number of hits that the search query matched.
-     */
-    nbHits: number;
-};
+export type TopSearch = {
+    /**
+     * User query.
+     */
+    search: string;
+    /**
+     * Number of tracked _and_ untracked searches (where the `clickAnalytics` parameter isn\'t `true`).
+     */
+    count: number;
+    /**
+     * Number of hits the search query matched.
+     */
+    nbHits: number;
+};
 //# sourceMappingURL=topSearch.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"topSearch.d.ts","sourceRoot":"","sources":["../../model/topSearch.ts"],"names":[],"mappings":"AAEA,oBAAY,SAAS,GAAG;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}
+{"version":3,"file":"topSearch.d.ts","sourceRoot":"","sources":["../../model/topSearch.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC"}