algoliasearch 5.2.4-beta.1 → 5.2.4

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

@@ -0,0 +1,579 @@
+import type { Direction } from './direction';
+import type { OrderBy } from './orderBy';
+/**
+ * Properties for the `customDelete` method.
+ */
+export type CustomDeleteProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customGet` method.
+ */
+export type CustomGetProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+};
+/**
+ * Properties for the `customPost` method.
+ */
+export type CustomPostProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `customPut` method.
+ */
+export type CustomPutProps = {
+    /**
+     * Path of the endpoint, anything after \"/1\" must be specified.
+     */
+    path: string;
+    /**
+     * Query parameters to apply to the current query.
+     */
+    parameters?: Record<string, any>;
+    /**
+     * Parameters to send with the custom request.
+     */
+    body?: Record<string, unknown>;
+};
+/**
+ * Properties for the `getAddToCartRate` method.
+ */
+export type GetAddToCartRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getAverageClickPosition` method.
+ */
+export type GetAverageClickPositionProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getClickPositions` method.
+ */
+export type GetClickPositionsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getClickThroughRate` method.
+ */
+export type GetClickThroughRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getConversionRate` method.
+ */
+export type GetConversionRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getNoClickRate` method.
+ */
+export type GetNoClickRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getNoResultsRate` method.
+ */
+export type GetNoResultsRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getPurchaseRate` method.
+ */
+export type GetPurchaseRateProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getRevenue` method.
+ */
+export type GetRevenueProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesCount` method.
+ */
+export type GetSearchesCountProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesNoClicks` method.
+ */
+export type GetSearchesNoClicksProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getSearchesNoResults` method.
+ */
+export type GetSearchesNoResultsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getStatus` method.
+ */
+export type GetStatusProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+};
+/**
+ * Properties for the `getTopCountries` method.
+ */
+export type GetTopCountriesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFilterAttributes` method.
+ */
+export type GetTopFilterAttributesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFilterForAttribute` method.
+ */
+export type GetTopFilterForAttributeProps = {
+    /**
+     * Attribute name.
+     */
+    attribute: string;
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getTopFiltersNoResults` method.
+ */
+export type GetTopFiltersNoResultsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getTopHits` method.
+ */
+export type GetTopHitsProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Search query.
+     */
+    search?: string;
+    /**
+     * Whether to include metrics related to click and conversion events in the response.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     */
+    revenueAnalytics?: boolean;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getTopSearches` method.
+ */
+export type GetTopSearchesProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Whether to include metrics related to click and conversion events in the response.
+     */
+    clickAnalytics?: boolean;
+    /**
+     * Whether to include revenue-related metrics in the response.  If true, metrics related to click and conversion events are also included in the response.
+     */
+    revenueAnalytics?: boolean;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+     */
+    orderBy?: OrderBy;
+    /**
+     * Sorting direction of the results: ascending or descending.
+     */
+    direction?: Direction;
+    /**
+     * Number of items to return.
+     */
+    limit?: number;
+    /**
+     * Position of the first item to return.
+     */
+    offset?: number;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+/**
+ * Properties for the `getUsersCount` method.
+ */
+export type GetUsersCountProps = {
+    /**
+     * Index name.
+     */
+    index: string;
+    /**
+     * Start date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    startDate?: string;
+    /**
+     * End date of the period to analyze, in `YYYY-MM-DD` format.
+     */
+    endDate?: string;
+    /**
+     * Tags by which to segment the analytics.  You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+     */
+    tags?: string;
+};
+//# sourceMappingURL=clientMethodProps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}

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

@@ -0,0 +1,14 @@
+/**
+ * Currency code.
+ */
+export type CurrencyCode = {
+    /**
+     * Currency code.
+     */
+    currency?: string;
+    /**
+     * Revenue associated with this search in this currency.
+     */
+    revenue?: number;
+};
+//# sourceMappingURL=currencyCode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"currencyCode.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/currencyCode.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}

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

@@ -0,0 +1,19 @@
+export type DailyAddToCartRates = {
+    /**
+     * Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of add-to-cart events from this search.
+     */
+    addToCartCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+//# sourceMappingURL=dailyAddToCartRates.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dailyAddToCartRates.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/dailyAddToCartRates.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

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

@@ -0,0 +1,15 @@
+export type DailyAverageClicks = {
+    /**
+     * Average position of a clicked search result in the list of search results. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    average: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+//# sourceMappingURL=dailyAverageClicks.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dailyAverageClicks.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/dailyAverageClicks.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

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

@@ -0,0 +1,19 @@
+export type DailyClickThroughRates = {
+    /**
+     * Click-through rate, calculated as number of tracked searches with at least one click event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of clicks associated with this search.
+     */
+    clickCount: number;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+//# sourceMappingURL=dailyClickThroughRates.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dailyClickThroughRates.d.ts","sourceRoot":"","sources":["../../../../client-analytics/model/dailyClickThroughRates.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

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

@@ -0,0 +1,19 @@
+export type DailyConversionRates = {
+    /**
+     * Conversion rate, calculated as number of tracked searches with at least one conversion event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+     */
+    rate: number | null;
+    /**
+     * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+     */
+    trackedSearchCount: number;
+    /**
+     * Number of conversions from this search.
+     */
+    conversionCount: number;
+    /**
+     * Date in the format YYYY-MM-DD.
+     */
+    date: string;
+};
+//# sourceMappingURL=dailyConversionRates.d.ts.map