fix(specs): extend Analytics descriptions (generated)

algolia-bot · gazconroy · Gary Conroy · algolia-bot · commit 2d621ef70464 · 2025-01-16T10:58:59.000Z
algolia/api-clients-automation#4360 Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com> Co-authored-by: gazconroy <gazconroyster@gmail.com> Co-authored-by: Gary Conroy <gary.conroy@LON-M3P-GConroy.local> Co-authored-by: Kai Welke <kai.welke@algolia.com>
diff --git a/packages/client-analytics/model/clientMethodProps.ts b/packages/client-analytics/model/clientMethodProps.ts
@@ -511,7 +511,7 @@ export type GetTopHitsProps = {
    */
   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.
+   * Whether to include metrics related to revenue events in the response.
    */
   revenueAnalytics?: boolean;
   /**
@@ -549,7 +549,7 @@ export type GetTopSearchesProps = {
    */
   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.
+   * Whether to include metrics related to revenue events in the response.
    */
   revenueAnalytics?: boolean;
   /**
diff --git a/packages/client-analytics/model/dailyAddToCartRates.ts b/packages/client-analytics/model/dailyAddToCartRates.ts
@@ -2,7 +2,7 @@
 
 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.
+   * Add-to-cart rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/dailyClickThroughRates.ts b/packages/client-analytics/model/dailyClickThroughRates.ts
@@ -2,7 +2,7 @@
 
 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.
+   * Click-through rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/dailyConversionRates.ts b/packages/client-analytics/model/dailyConversionRates.ts
@@ -2,7 +2,7 @@
 
 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.
+   * Conversion rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/dailyNoClickRates.ts b/packages/client-analytics/model/dailyNoClickRates.ts
@@ -2,7 +2,7 @@
 
 export type DailyNoClickRates = {
   /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+   * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
    */
   rate: number;
 
diff --git a/packages/client-analytics/model/dailyNoResultsRates.ts b/packages/client-analytics/model/dailyNoResultsRates.ts
@@ -17,7 +17,7 @@ export type DailyNoResultsRates = {
   count: number;
 
   /**
-   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+   * No results rate: calculated as the number of searches with zero results divided by the total number of searches.
    */
   rate: number;
 };
diff --git a/packages/client-analytics/model/dailyPurchaseRates.ts b/packages/client-analytics/model/dailyPurchaseRates.ts
@@ -2,7 +2,7 @@
 
 export type DailyPurchaseRates = {
   /**
-   * 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.
+   * Purchase rate: calculated as the 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.
    */
   rate: number | null;
 
diff --git a/packages/client-analytics/model/dailyRevenue.ts b/packages/client-analytics/model/dailyRevenue.ts
@@ -4,7 +4,7 @@ import type { CurrencyCode } from './currencyCode';
 
 export type DailyRevenue = {
   /**
-   * Revenue associated with this search, broken-down by currencies.
+   * Revenue associated with this search: broken down by currency.
    */
   currencies: { [key: string]: CurrencyCode };
 
diff --git a/packages/client-analytics/model/getAddToCartRateResponse.ts b/packages/client-analytics/model/getAddToCartRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyAddToCartRates } from './dailyAddToCartRates';
 
 export type GetAddToCartRateResponse = {
   /**
-   * 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.
+   * Add-to-cart rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/getClickThroughRateResponse.ts b/packages/client-analytics/model/getClickThroughRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyClickThroughRates } from './dailyClickThroughRates';
 
 export type GetClickThroughRateResponse = {
   /**
-   * 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.
+   * Click-through rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/getConversionRateResponse.ts b/packages/client-analytics/model/getConversionRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyConversionRates } from './dailyConversionRates';
 
 export type GetConversionRateResponse = {
   /**
-   * 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.
+   * Conversion rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/getNoClickRateResponse.ts b/packages/client-analytics/model/getNoClickRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyNoClickRates } from './dailyNoClickRates';
 
 export type GetNoClickRateResponse = {
   /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+   * No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
    */
   rate: number;
 
diff --git a/packages/client-analytics/model/getNoResultsRateResponse.ts b/packages/client-analytics/model/getNoResultsRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyNoResultsRates } from './dailyNoResultsRates';
 
 export type GetNoResultsRateResponse = {
   /**
-   * No results rate, calculated as number of searches with zero results divided by the total number of searches.
+   * No results rate: calculated as the number of searches with zero results divided by the total number of searches.
    */
   rate: number;
 
diff --git a/packages/client-analytics/model/getPurchaseRateResponse.ts b/packages/client-analytics/model/getPurchaseRateResponse.ts
@@ -4,7 +4,7 @@ import type { DailyPurchaseRates } from './dailyPurchaseRates';
 
 export type GetPurchaseRateResponse = {
   /**
-   * 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.
+   * Purchase rate: calculated as the 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.
    */
   rate: number | null;
 
diff --git a/packages/client-analytics/model/getRevenue.ts b/packages/client-analytics/model/getRevenue.ts
@@ -5,7 +5,7 @@ import type { DailyRevenue } from './dailyRevenue';
 
 export type GetRevenue = {
   /**
-   * Revenue associated with this search, broken-down by currencies.
+   * Revenue associated with this search: broken down by currency.
    */
   currencies: { [key: string]: CurrencyCode };
 
diff --git a/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts b/packages/client-analytics/model/getTopFiltersNoResultsResponse.ts
@@ -4,7 +4,7 @@ import type { GetTopFiltersNoResultsValues } from './getTopFiltersNoResultsValue
 
 export type GetTopFiltersNoResultsResponse = {
   /**
-   * 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.
+   * Filters for searches without any results. If null, the search term specified with the `search` parameter isn\'t a search without results, or the `search` parameter is absent from the request.
    */
   values: Array<GetTopFiltersNoResultsValues> | null;
 };
diff --git a/packages/client-analytics/model/topHit.ts b/packages/client-analytics/model/topHit.ts
@@ -2,7 +2,7 @@
 
 export type TopHit = {
   /**
-   * Object ID of a record that\'s returned as a search result.
+   * Object ID of a record returned as a search result.
    */
   hit: string;
 
diff --git a/packages/client-analytics/model/topHitWithAnalytics.ts b/packages/client-analytics/model/topHitWithAnalytics.ts
@@ -2,7 +2,7 @@
 
 export type TopHitWithAnalytics = {
   /**
-   * Object ID of a record that\'s returned as a search result.
+   * Object ID of a record returned as a search result.
    */
   hit: string;
 
@@ -12,12 +12,12 @@ export type TopHitWithAnalytics = {
   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.
+   * Click-through rate: calculated as the 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.
+   * Conversion rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/topHitWithRevenueAnalytics.ts b/packages/client-analytics/model/topHitWithRevenueAnalytics.ts
@@ -4,7 +4,7 @@ import type { CurrencyCode } from './currencyCode';
 
 export type TopHitWithRevenueAnalytics = {
   /**
-   * Object ID of a record that\'s returned as a search result.
+   * Object ID of a record returned as a search result.
    */
   hit: string;
 
@@ -14,12 +14,12 @@ export type TopHitWithRevenueAnalytics = {
   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.
+   * Click-through rate: calculated as the 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.
+   * Conversion rate: calculated as the 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;
 
@@ -39,7 +39,7 @@ export type TopHitWithRevenueAnalytics = {
   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.
+   * Add-to-cart rate: calculated as the 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;
 
@@ -49,7 +49,7 @@ export type TopHitWithRevenueAnalytics = {
   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.
+   * Purchase rate: calculated as the 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;
 
@@ -59,7 +59,7 @@ export type TopHitWithRevenueAnalytics = {
   purchaseCount: number;
 
   /**
-   * Revenue associated with this search, broken-down by currencies.
+   * Revenue associated with this search: broken down by currency.
    */
   currencies: { [key: string]: CurrencyCode };
 };
diff --git a/packages/client-analytics/model/topSearchWithAnalytics.ts b/packages/client-analytics/model/topSearchWithAnalytics.ts
@@ -14,7 +14,7 @@ export type TopSearchWithAnalytics = {
   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.
+   * Click-through rate: calculated as the 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;
 
@@ -29,7 +29,7 @@ export type TopSearchWithAnalytics = {
   clickPositions: Array<ClickPosition>;
 
   /**
-   * 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.
+   * Conversion rate: calculated as the 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;
 
diff --git a/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts b/packages/client-analytics/model/topSearchWithRevenueAnalytics.ts
@@ -15,7 +15,7 @@ export type TopSearchWithRevenueAnalytics = {
   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.
+   * Click-through rate: calculated as the 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;
 
@@ -30,7 +30,7 @@ export type TopSearchWithRevenueAnalytics = {
   clickPositions: Array<ClickPosition>;
 
   /**
-   * 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.
+   * Conversion rate: calculated as the 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;
 
@@ -55,12 +55,12 @@ export type TopSearchWithRevenueAnalytics = {
   nbHits: number;
 
   /**
-   * Revenue associated with this search, broken-down by currencies.
+   * Revenue associated with this search: broken down by currency.
    */
   currencies: { [key: string]: CurrencyCode };
 
   /**
-   * 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.
+   * Add-to-cart rate: calculated as the 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;
 
@@ -70,7 +70,7 @@ export type TopSearchWithRevenueAnalytics = {
   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.
+   * Purchase rate: calculated as the 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;
 
diff --git a/packages/client-analytics/src/analyticsClient.ts b/packages/client-analytics/src/analyticsClient.ts
