fix(specs): extend Analytics descriptions (generated)

algolia-bot · gazconroy · Gary Conroy · algolia-bot · commit b1f0128d2163 · 2025-01-16T10:59:00.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/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt b/client/src/commonMain/kotlin/com/algolia/client/api/AnalyticsClient.kt
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyAddToCartRates.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * DailyAddToCartRates
  *
- * @param rate 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param addToCartCount Number of add-to-cart events from this search.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyClickThroughRates.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * DailyClickThroughRates
  *
- * @param 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.
+ * @param rate 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.
  * @param clickCount Number of clicks associated with this search.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of clicks associated with this search. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyConversionRates.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * DailyConversionRates
  *
- * @param 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param conversionCount Number of conversions from this search.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoClickRates.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * DailyNoClickRates
  *
- * @param rate No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+ * @param rate No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
  * @param count Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param noClickCount Number of times this search was returned as a result without any click.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyNoResultsRates.kt
@@ -10,7 +10,7 @@ import kotlinx.serialization.json.*
  * @param date Date in the format YYYY-MM-DD.
  * @param noResultCount Number of searches without any results.
  * @param count Number of searches.
- * @param rate No results rate, calculated as number of searches with zero results divided by the total number of searches.
+ * @param rate No results rate: calculated as the number of searches with zero results divided by the total number of searches.
  */
 @Serializable
 public data class DailyNoResultsRates(
@@ -24,6 +24,6 @@ public data class DailyNoResultsRates(
   /** Number of searches. */
   @SerialName(value = "count") val count: Int,
 
-  /** 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.  */
   @SerialName(value = "rate") val rate: Double,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyPurchaseRates.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * DailyPurchaseRates
  *
- * @param rate 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param purchaseCount Number of purchase events from this search.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/DailyRevenue.kt
@@ -7,13 +7,13 @@ import kotlinx.serialization.json.*
 /**
  * DailyRevenue
  *
- * @param currencies Revenue associated with this search, broken-down by currencies.
+ * @param currencies Revenue associated with this search: broken down by currency.
  * @param date Date in the format YYYY-MM-DD.
  */
 @Serializable
 public data class DailyRevenue(
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency.  */
   @SerialName(value = "currencies") val currencies: Map<kotlin.String, CurrencyCode>,
 
   /** Date in the format YYYY-MM-DD. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetAddToCartRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetAddToCartRateResponse
  *
- * @param rate 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param addToCartCount Number of add-to-cart events from this search.
  * @param dates Daily add-to-cart rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetClickThroughRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetClickThroughRateResponse
  *
- * @param 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.
+ * @param rate 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.
  * @param clickCount Number of clicks associated with this search.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param dates Daily click-through rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of clicks associated with this search. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetConversionRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetConversionRateResponse
  *
- * @param 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param conversionCount Number of conversions from this search.
  * @param dates Daily conversion rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoClickRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetNoClickRateResponse
  *
- * @param rate No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.
+ * @param rate No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.
  * @param count Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param noClickCount Number of times this search was returned as a result without any click.
  * @param dates Daily no click rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetNoResultsRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetNoResultsRateResponse
  *
- * @param rate No results rate, calculated as number of searches with zero results divided by the total number of searches.
+ * @param rate No results rate: calculated as the number of searches with zero results divided by the total number of searches.
  * @param count Number of searches.
  * @param noResultCount Number of searches without any results.
  * @param dates Daily no results rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of searches. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetPurchaseRateResponse.kt
@@ -7,15 +7,15 @@ import kotlinx.serialization.json.*
 /**
  * GetPurchaseRateResponse
  *
- * @param rate 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.
+ * @param rate 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.
  * @param trackedSearchCount Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
  * @param purchaseCount Number of purchase events from this search.
  * @param dates Daily purchase rates.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "rate") val rate: Double,
 
   /** Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetRevenue.kt
@@ -7,13 +7,13 @@ import kotlinx.serialization.json.*
 /**
  * GetRevenue
  *
- * @param currencies Revenue associated with this search, broken-down by currencies.
+ * @param currencies Revenue associated with this search: broken down by currency.
  * @param dates Daily revenue.
  */
 @Serializable
 public data class GetRevenue(
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency.  */
   @SerialName(value = "currencies") val currencies: Map<kotlin.String, CurrencyCode>,
 
   /** Daily revenue. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/GetTopFiltersNoResultsResponse.kt
@@ -7,11 +7,11 @@ import kotlinx.serialization.json.*
 /**
  * GetTopFiltersNoResultsResponse
  *
- * @param values 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.
+ * @param values 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.
  */
 @Serializable
 public data class 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.  */
   @SerialName(value = "values") val values: List<GetTopFiltersNoResultsValues>,
 )
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHit.kt
@@ -7,13 +7,13 @@ import kotlinx.serialization.json.*
 /**
  * TopHit
  *
- * @param hit Object ID of a record that's returned as a search result.
+ * @param hit Object ID of a record returned as a search result.
  * @param count Number of occurrences.
  */
 @Serializable
 public data class TopHit(
 
-  /** Object ID of a record that's returned as a search result. */
+  /** Object ID of a record returned as a search result. */
   @SerialName(value = "hit") val hit: String,
 
   /** Number of occurrences. */
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithAnalytics.kt
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopHitWithRevenueAnalytics.kt
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithAnalytics.kt
diff --git a/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt b/client/src/commonMain/kotlin/com/algolia/client/model/analytics/TopSearchWithRevenueAnalytics.kt
