fix(specs): extend Analytics descriptions (generated)

algolia-bot · gazconroy · Gary Conroy · algolia-bot · commit 31666b2768c6 · 2025-01-16T10:59:03.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/algoliasearch/analytics/client.py b/algoliasearch/analytics/client.py
diff --git a/algoliasearch/analytics/models/daily_add_to_cart_rates.py b/algoliasearch/analytics/models/daily_add_to_cart_rates.py
@@ -36,7 +36,7 @@ class DailyAddToCartRates(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     add_to_cart_count: int
diff --git a/algoliasearch/analytics/models/daily_click_through_rates.py b/algoliasearch/analytics/models/daily_click_through_rates.py
@@ -36,7 +36,7 @@ class DailyClickThroughRates(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     click_count: int
     """ Number of clicks associated with this search. """
     tracked_search_count: int
diff --git a/algoliasearch/analytics/models/daily_conversion_rates.py b/algoliasearch/analytics/models/daily_conversion_rates.py
@@ -36,7 +36,7 @@ class DailyConversionRates(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     conversion_count: int
diff --git a/algoliasearch/analytics/models/daily_no_click_rates.py b/algoliasearch/analytics/models/daily_no_click_rates.py
@@ -36,7 +36,7 @@ class DailyNoClickRates(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     no_click_count: int
diff --git a/algoliasearch/analytics/models/daily_no_results_rates.py b/algoliasearch/analytics/models/daily_no_results_rates.py
@@ -42,7 +42,7 @@ class DailyNoResultsRates(BaseModel):
     count: int
     """ Number of searches. """
     rate: float
-    """ 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.  """
 
     model_config = ConfigDict(
         strict=False,
diff --git a/algoliasearch/analytics/models/daily_purchase_rates.py b/algoliasearch/analytics/models/daily_purchase_rates.py
@@ -36,7 +36,7 @@ class DailyPurchaseRates(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     purchase_count: int
diff --git a/algoliasearch/analytics/models/daily_revenue.py b/algoliasearch/analytics/models/daily_revenue.py
@@ -36,7 +36,7 @@ class DailyRevenue(BaseModel):
     """
 
     currencies: Dict[str, CurrencyCode]
-    """ Revenue associated with this search, broken-down by currencies. """
+    """ Revenue associated with this search: broken down by currency.  """
     var_date: str
     """ Date in the format YYYY-MM-DD. """
 
diff --git a/algoliasearch/analytics/models/get_add_to_cart_rate_response.py b/algoliasearch/analytics/models/get_add_to_cart_rate_response.py
@@ -38,7 +38,7 @@ class GetAddToCartRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     add_to_cart_count: int
diff --git a/algoliasearch/analytics/models/get_click_through_rate_response.py b/algoliasearch/analytics/models/get_click_through_rate_response.py
@@ -40,7 +40,7 @@ class GetClickThroughRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     click_count: int
     """ Number of clicks associated with this search. """
     tracked_search_count: int
diff --git a/algoliasearch/analytics/models/get_conversion_rate_response.py b/algoliasearch/analytics/models/get_conversion_rate_response.py
@@ -38,7 +38,7 @@ class GetConversionRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     conversion_count: int
diff --git a/algoliasearch/analytics/models/get_no_click_rate_response.py b/algoliasearch/analytics/models/get_no_click_rate_response.py
@@ -38,7 +38,7 @@ class GetNoClickRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     no_click_count: int
diff --git a/algoliasearch/analytics/models/get_no_results_rate_response.py b/algoliasearch/analytics/models/get_no_results_rate_response.py
@@ -38,7 +38,7 @@ class GetNoResultsRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     count: int
     """ Number of searches. """
     no_result_count: int
diff --git a/algoliasearch/analytics/models/get_purchase_rate_response.py b/algoliasearch/analytics/models/get_purchase_rate_response.py
@@ -38,7 +38,7 @@ class GetPurchaseRateResponse(BaseModel):
     """
 
     rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     purchase_count: int
diff --git a/algoliasearch/analytics/models/get_revenue.py b/algoliasearch/analytics/models/get_revenue.py
@@ -37,7 +37,7 @@ class GetRevenue(BaseModel):
     """
 
     currencies: Dict[str, CurrencyCode]
-    """ Revenue associated with this search, broken-down by currencies. """
+    """ Revenue associated with this search: broken down by currency.  """
     dates: List[DailyRevenue]
     """ Daily revenue. """
 
diff --git a/algoliasearch/analytics/models/get_top_filters_no_results_response.py b/algoliasearch/analytics/models/get_top_filters_no_results_response.py
@@ -37,7 +37,7 @@ class GetTopFiltersNoResultsResponse(BaseModel):
     """
 
     values: List[GetTopFiltersNoResultsValues]
-    """ 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.  """
 
     model_config = ConfigDict(
         strict=False,
diff --git a/algoliasearch/analytics/models/top_hit.py b/algoliasearch/analytics/models/top_hit.py
@@ -34,7 +34,7 @@ class TopHit(BaseModel):
     """
 
     hit: str
-    """ Object ID of a record that's returned as a search result. """
+    """ Object ID of a record returned as a search result. """
     count: int
     """ Number of occurrences. """
 
diff --git a/algoliasearch/analytics/models/top_hit_with_analytics.py b/algoliasearch/analytics/models/top_hit_with_analytics.py
@@ -39,13 +39,13 @@ class TopHitWithAnalytics(BaseModel):
     """
 
     hit: str
-    """ Object ID of a record that's returned as a search result. """
+    """ Object ID of a record returned as a search result. """
     count: int
     """ Number of occurrences. """
     click_through_rate: float
-    """ 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.  """
     conversion_rate: float
-    """ 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.  """
     tracked_hit_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     click_count: int
diff --git a/algoliasearch/analytics/models/top_hit_with_revenue_analytics.py b/algoliasearch/analytics/models/top_hit_with_revenue_analytics.py
@@ -46,29 +46,29 @@ class TopHitWithRevenueAnalytics(BaseModel):
     """
 
     hit: str
-    """ Object ID of a record that's returned as a search result. """
+    """ Object ID of a record returned as a search result. """
     count: int
     """ Number of occurrences. """
     click_through_rate: float
-    """ 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.  """
     conversion_rate: float
-    """ 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.  """
     tracked_hit_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     click_count: int
     """ Number of clicks associated with this search. """
     conversion_count: int
     """ Number of conversions from this search. """
     add_to_cart_rate: float
-    """ 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.  """
     add_to_cart_count: int
     """ Number of add-to-cart events from this search. """
     purchase_rate: float
-    """ 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.  """
     purchase_count: int
     """ Number of purchase events from this search. """
     currencies: Dict[str, CurrencyCode]
-    """ Revenue associated with this search, broken-down by currencies. """
+    """ Revenue associated with this search: broken down by currency.  """
 
     model_config = ConfigDict(
         strict=False,
diff --git a/algoliasearch/analytics/models/top_search_with_analytics.py b/algoliasearch/analytics/models/top_search_with_analytics.py
@@ -48,13 +48,13 @@ class TopSearchWithAnalytics(BaseModel):
     count: int
     """ Number of searches. """
     click_through_rate: float
-    """ 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.  """
     average_click_position: float
     """ 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.  """
     click_positions: List[ClickPosition]
     """ List of positions in the search results and clicks associated with this search. """
     conversion_rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     click_count: int
diff --git a/algoliasearch/analytics/models/top_search_with_revenue_analytics.py b/algoliasearch/analytics/models/top_search_with_revenue_analytics.py
@@ -54,13 +54,13 @@ class TopSearchWithRevenueAnalytics(BaseModel):
     count: int
     """ Number of searches. """
     click_through_rate: float
-    """ 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.  """
     average_click_position: float
     """ 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.  """
     click_positions: List[ClickPosition]
     """ List of positions in the search results and clicks associated with this search. """
     conversion_rate: float
-    """ 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.  """
     tracked_search_count: int
     """ Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. """
     click_count: int
@@ -70,13 +70,13 @@ class TopSearchWithRevenueAnalytics(BaseModel):
     nb_hits: int
     """ Number of results (hits). """
     currencies: Dict[str, CurrencyCode]
-    """ Revenue associated with this search, broken-down by currencies. """
+    """ Revenue associated with this search: broken down by currency.  """
     add_to_cart_rate: float
-    """ 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.  """
     add_to_cart_count: int
     """ Number of add-to-cart events from this search. """
     purchase_rate: float
-    """ 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.  """
     purchase_count: int
     """ Number of purchase events from this search. """
 
