@algolia/client-analytics 5.0.0-alpha.11 → 5.0.0-alpha.111

package/model/getTopFilterForAttribute.ts

@@ -1,23 +1,22 @@
-// 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 { Operator } from './operator';
 
 export type GetTopFilterForAttribute = {
   /**
-   * The attribute.
+   * Attribute name.
    */
   attribute: string;
 
-  /**
-   * The operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
-   * The value of the attribute.
+   * Attribute value.
    */
   value: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/getTopFilterForAttributeResponse.ts

@@ -1,10 +1,10 @@
-// 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 { GetTopFilterForAttribute } from './getTopFilterForAttribute';
 
 export type GetTopFilterForAttributeResponse = {
   /**
-   * A list of filters for the given attributes.
+   * Filter values for an attribute.
    */
   values: GetTopFilterForAttribute[];
 };

package/model/getTopFiltersNoResultsResponse.ts

@@ -1,10 +1,10 @@
-// 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 { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValues';
 
 export type GetTopFiltersNoResultsResponse = {
   /**
-   * A list of filters without results.
+   * Filters for searches without any results. If null, the search term specified with the `search` parameter is not a search without results, or the `search` parameter is absent from the request.
    */
-  values: GetTopFiltersNoResultsValues[];
+  values: GetTopFiltersNoResultsValues[] | null;
 };

package/model/getTopFiltersNoResultsValue.ts

@@ -1,18 +1,17 @@
-// 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 { Operator } from './operator';
 
 export type GetTopFiltersNoResultsValue = {
   /**
-   * The attribute.
+   * Attribute name.
    */
   attribute: string;
 
-  /**
-   * The operator.
-   */
-  operator: string;
+  operator: Operator;
 
   /**
-   * The value of the attribute.
+   * Attribute value.
    */
   value: string;
 };

package/model/getTopFiltersNoResultsValues.ts

@@ -1,15 +1,15 @@
-// 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 { GetTopFiltersNoResultsValue } from './getTopFiltersNoResultsValue';
 
 export type GetTopFiltersNoResultsValues = {
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 
   /**
-   * A list of filters without results.
+   * Filters with no results.
    */
   values: GetTopFiltersNoResultsValue[];
 };

package/model/getTopHitsResponse.ts

@@ -1,6 +1,10 @@
-// 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 { TopHitsResponse } from './topHitsResponse';
 import type { TopHitsResponseWithAnalytics } from './topHitsResponseWithAnalytics';
+import type { TopHitsResponseWithRevenueAnalytics } from './topHitsResponseWithRevenueAnalytics';
 
-export type GetTopHitsResponse = TopHitsResponse | TopHitsResponseWithAnalytics;
+export type GetTopHitsResponse =
+  | TopHitsResponse
+  | TopHitsResponseWithAnalytics
+  | TopHitsResponseWithRevenueAnalytics;

package/model/getTopSearchesResponse.ts

@@ -1,8 +1,10 @@
-// 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 { TopSearchesResponse } from './topSearchesResponse';
 import type { TopSearchesResponseWithAnalytics } from './topSearchesResponseWithAnalytics';
+import type { TopSearchesResponseWithRevenueAnalytics } from './topSearchesResponseWithRevenueAnalytics';
 
 export type GetTopSearchesResponse =
   | TopSearchesResponse
-  | TopSearchesResponseWithAnalytics;
+  | TopSearchesResponseWithAnalytics
+  | TopSearchesResponseWithRevenueAnalytics;

package/model/getUsersCountResponse.ts

@@ -1,15 +1,15 @@
-// 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 { UserWithDate } from './userWithDate';
+import type { DailyUsers } from './dailyUsers';
 
 export type GetUsersCountResponse = {
   /**
-   * The number of occurrences.
+   * Number of unique users.
    */
   count: number;
 
   /**
-   * A list of users count with their date.
+   * Daily number of unique users.
    */
-  dates: UserWithDate[];
+  dates: DailyUsers[];
 };

package/model/index.ts

@@ -1,17 +1,30 @@
-// 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 './averageClickEvent';
-export * from './clickPosition';
-export * from './clickThroughRateEvent';
-export * from './conversionRateEvent';
+export * from './clickPositionsInner';
+export * from './currenciesValue';
+export * from './dailyAddToCartRates';
+export * from './dailyAverageClicks';
+export * from './dailyClickThroughRates';
+export * from './dailyConversionRates';
+export * from './dailyNoClickRates';
+export * from './dailyNoResultsRates';
+export * from './dailyPurchaseRates';
+export * from './dailyRevenue';
+export * from './dailySearches';
+export * from './dailySearchesNoClicks';
+export * from './dailySearchesNoResults';
+export * from './dailyUsers';
 export * from './direction';
 export * from './errorBase';
+export * from './getAddToCartRateResponse';
 export * from './getAverageClickPositionResponse';
 export * from './getClickPositionsResponse';
 export * from './getClickThroughRateResponse';
-export * from './getConversationRateResponse';
+export * from './getConversionRateResponse';
 export * from './getNoClickRateResponse';
 export * from './getNoResultsRateResponse';
+export * from './getPurchaseRateResponse';
+export * from './getRevenue';
 export * from './getSearchesCountResponse';
 export * from './getSearchesNoClicksResponse';
 export * from './getSearchesNoResultsResponse';
@@ -27,20 +40,19 @@ export * from './getTopFiltersNoResultsValues';
 export * from './getTopHitsResponse';
 export * from './getTopSearchesResponse';
 export * from './getUsersCountResponse';
-export * from './noClickRateEvent';
-export * from './noResultsRateEvent';
+export * from './operator';
 export * from './orderBy';
-export * from './searchEvent';
-export * from './searchNoClickEvent';
-export * from './searchNoResultEvent';
 export * from './topCountry';
 export * from './topHit';
 export * from './topHitWithAnalytics';
+export * from './topHitWithRevenueAnalytics';
 export * from './topHitsResponse';
 export * from './topHitsResponseWithAnalytics';
+export * from './topHitsResponseWithRevenueAnalytics';
 export * from './topSearch';
 export * from './topSearchWithAnalytics';
+export * from './topSearchWithRevenueAnalytics';
 export * from './topSearchesResponse';
 export * from './topSearchesResponseWithAnalytics';
-export * from './userWithDate';
+export * from './topSearchesResponseWithRevenueAnalytics';
 export * from './clientMethodProps';

package/model/operator.ts

@@ -0,0 +1,6 @@
+// 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.
+
+/**
+ * Character that characterizes how the filter is applied.  For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator.
+ */
+export type Operator = ':' | '!=' | '<' | '<=' | '=' | '>' | '>=';

package/model/orderBy.ts

@@ -1,5 +1,8 @@
-// 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.
 
+/**
+ * Attribute by which to order the response items.  If the `clickAnalytics` parameter is false, only `searchCount` is available.
+ */
 export type OrderBy =
   | 'averageClickPosition'
   | 'clickThroughRate'

package/model/topCountry.ts

@@ -1,13 +1,13 @@
-// 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 TopCountry = {
   /**
-   * The country.
+   * Country code.
    */
   country: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/topHit.ts

@@ -1,13 +1,13 @@
-// 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 TopHit = {
   /**
-   * The hit.
+   * Object ID of a record that\'s returned as a search result.
    */
   hit: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 };

package/model/topHitWithAnalytics.ts

@@ -1,38 +1,38 @@
-// 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 TopHitWithAnalytics = {
   /**
-   * The hit.
+   * Object ID of a record that\'s returned as a search result.
    */
   hit: string;
 
   /**
-   * The number of occurrences.
+   * Number of occurrences.
    */
   count: number;
 
   /**
-   * The click-through rate.
+   * 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.
    */
-  clickThroughRate: number;
+  clickThroughRate: number | null;
 
   /**
-   * The conversion rate.
+   * 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.
    */
-  conversionRate: number;
+  conversionRate: number | null;
 
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
-  trackedSearchCount: number;
+  trackedHitCount: number;
 
   /**
-   * The number of click event.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * The number of converted clicks.
+   * Number of conversions from this search.
    */
   conversionCount: number;
 };

package/model/topHitWithRevenueAnalytics.ts

@@ -0,0 +1,65 @@
+// 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 { CurrenciesValue } from './currenciesValue';
+
+export type TopHitWithRevenueAnalytics = {
+  /**
+   * Object ID of a record that\'s returned as a search result.
+   */
+  hit: string;
+
+  /**
+   * Number of occurrences.
+   */
+  count: number;
+
+  /**
+   * 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.
+   */
+  clickThroughRate: number | null;
+
+  /**
+   * 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.
+   */
+  conversionRate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedHitCount: number;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Number of conversions from this search.
+   */
+  conversionCount: number;
+
+  /**
+   * 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.
+   */
+  addToCartRate: number | null;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+   */
+  purchaseRate: number | null;
+
+  /**
+   * Number of purchase events from this search.
+   */
+  purchaseCount: number;
+
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+};

package/model/topHitsResponse.ts

@@ -1,10 +1,10 @@
-// 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 { TopHit } from './topHit';
 
 export type TopHitsResponse = {
   /**
-   * A list of top hits with their count.
+   * Most frequent search results.
    */
   hits: TopHit[];
 };

package/model/topHitsResponseWithAnalytics.ts

@@ -1,10 +1,10 @@
-// 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 { TopHitWithAnalytics } from './topHitWithAnalytics';
 
 export type TopHitsResponseWithAnalytics = {
   /**
-   * A list of top hits with their count and analytics.
+   * Most frequent search results with click and conversion metrics.
    */
   hits: TopHitWithAnalytics[];
 };

package/model/topHitsResponseWithRevenueAnalytics.ts

@@ -0,0 +1,10 @@
+// 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 { TopHitWithRevenueAnalytics } from './topHitWithRevenueAnalytics';
+
+export type TopHitsResponseWithRevenueAnalytics = {
+  /**
+   * Most frequent search results with click, conversion, and revenue metrics.
+   */
+  hits: TopHitWithRevenueAnalytics[];
+};

package/model/topSearch.ts

@@ -1,18 +1,18 @@
-// 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 TopSearch = {
   /**
-   * The search query.
+   * Search query.
    */
   search: string;
 
   /**
-   * The number of occurrences.
+   * Number of searches.
    */
   count: number;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package/model/topSearchWithAnalytics.ts

@@ -1,48 +1,55 @@
-// 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 { ClickPositionsInner } from './clickPositionsInner';
 
 export type TopSearchWithAnalytics = {
   /**
-   * The search query.
+   * Search query.
    */
   search: string;
 
   /**
-   * The number of occurrences.
+   * Number of searches.
    */
   count: number;
 
   /**
-   * The click-through rate.
+   * 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.
+   */
+  clickThroughRate: number | null;
+
+  /**
+   * 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.
    */
-  clickThroughRate: number;
+  averageClickPosition: number | null;
 
   /**
-   * The average position of all the click count event.
+   * List of positions in the search results and clicks associated with this search.
    */
-  averageClickPosition: number;
+  clickPositions: ClickPositionsInner[];
 
   /**
-   * The conversion rate.
+   * 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.
    */
-  conversionRate: number;
+  conversionRate: number | null;
 
   /**
-   * The number of tracked search click.
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
    */
   trackedSearchCount: number;
 
   /**
-   * The number of click event.
+   * Number of clicks associated with this search.
    */
   clickCount: number;
 
   /**
-   * The number of converted clicks.
+   * Number of conversions from this search.
    */
   conversionCount: number;
 
   /**
-   * Number of hits that the search query matched.
+   * Number of results (hits).
    */
   nbHits: number;
 };

package/model/topSearchWithRevenueAnalytics.ts

@@ -0,0 +1,81 @@
+// 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 { ClickPositionsInner } from './clickPositionsInner';
+import type { CurrenciesValue } from './currenciesValue';
+
+export type TopSearchWithRevenueAnalytics = {
+  /**
+   * Search query.
+   */
+  search: string;
+
+  /**
+   * Number of searches.
+   */
+  count: number;
+
+  /**
+   * 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.
+   */
+  clickThroughRate: number | null;
+
+  /**
+   * 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.
+   */
+  averageClickPosition: number | null;
+
+  /**
+   * List of positions in the search results and clicks associated with this search.
+   */
+  clickPositions: ClickPositionsInner[];
+
+  /**
+   * 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.
+   */
+  conversionRate: number | null;
+
+  /**
+   * Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
+   */
+  trackedSearchCount: number;
+
+  /**
+   * Number of clicks associated with this search.
+   */
+  clickCount: number;
+
+  /**
+   * Number of conversions from this search.
+   */
+  conversionCount: number;
+
+  /**
+   * Number of results (hits).
+   */
+  nbHits: number;
+
+  /**
+   * Revenue associated with this search, broken-down by currencies.
+   */
+  currencies: Record<string, CurrenciesValue>;
+
+  /**
+   * 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.
+   */
+  addToCartRate: number | null;
+
+  /**
+   * Number of add-to-cart events from this search.
+   */
+  addToCartCount: number;
+
+  /**
+   * Purchase rate, calculated as number of tracked searches with at least one purchase event divided by the number of tracked searches. If null, Algolia didn\'t receive any search requests with `clickAnalytics` set to true.
+   */
+  purchaseRate: number | null;
+
+  /**
+   * Number of purchase events from this search.
+   */
+  purchaseCount: number;
+};

package/model/topSearchesResponse.ts

@@ -1,10 +1,10 @@
-// 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 { TopSearch } from './topSearch';
 
 export type TopSearchesResponse = {
   /**
-   * A list of top searches with their count.
+   * Most popular searches and their number of search results (hits).
    */
   searches: TopSearch[];
 };

package/model/topSearchesResponseWithAnalytics.ts

@@ -1,10 +1,10 @@
-// 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 { TopSearchWithAnalytics } from './topSearchWithAnalytics';
 
 export type TopSearchesResponseWithAnalytics = {
   /**
-   * A list of top searches with their count and analytics.
+   * Most popular searches and their associated click and conversion metrics.
    */
   searches: TopSearchWithAnalytics[];
 };

package/model/topSearchesResponseWithRevenueAnalytics.ts

@@ -0,0 +1,10 @@
+// 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 { TopSearchWithRevenueAnalytics } from './topSearchWithRevenueAnalytics';
+
+export type TopSearchesResponseWithRevenueAnalytics = {
+  /**
+   * Most popular searches, including their click and revenue metrics.
+   */
+  searches: TopSearchWithRevenueAnalytics[];
+};