fix(specs): extend Analytics descriptions (generated)

algolia-bot · gazconroy · Gary Conroy · algolia-bot · commit 44082c3a915a · 2025-01-16T10:59:05.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/lib/algolia/api/analytics_client.rb b/lib/algolia/api/analytics_client.rb
diff --git a/lib/algolia/models/analytics/daily_add_to_cart_rates.rb b/lib/algolia/models/analytics/daily_add_to_cart_rates.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/daily_click_through_rates.rb b/lib/algolia/models/analytics/daily_click_through_rates.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of clicks associated with this search.
diff --git a/lib/algolia/models/analytics/daily_conversion_rates.rb b/lib/algolia/models/analytics/daily_conversion_rates.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/daily_no_click_rates.rb b/lib/algolia/models/analytics/daily_no_click_rates.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/daily_no_results_rates.rb b/lib/algolia/models/analytics/daily_no_results_rates.rb
@@ -15,7 +15,7 @@ class DailyNoResultsRates
       # Number of searches.
       attr_accessor :count
 
-      # 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.
       attr_accessor :rate
 
       # Attribute mapping from ruby-style variable name to JSON key.
diff --git a/lib/algolia/models/analytics/daily_purchase_rates.rb b/lib/algolia/models/analytics/daily_purchase_rates.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/daily_revenue.rb b/lib/algolia/models/analytics/daily_revenue.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     class DailyRevenue
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
       # Date in the format YYYY-MM-DD.
diff --git a/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb b/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/get_click_through_rate_response.rb b/lib/algolia/models/analytics/get_click_through_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of clicks associated with this search.
diff --git a/lib/algolia/models/analytics/get_conversion_rate_response.rb b/lib/algolia/models/analytics/get_conversion_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/get_no_click_rate_response.rb b/lib/algolia/models/analytics/get_no_click_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/get_no_results_rate_response.rb b/lib/algolia/models/analytics/get_no_results_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of searches.
diff --git a/lib/algolia/models/analytics/get_purchase_rate_response.rb b/lib/algolia/models/analytics/get_purchase_rate_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/get_revenue.rb b/lib/algolia/models/analytics/get_revenue.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     class GetRevenue
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
       # Daily revenue.
diff --git a/lib/algolia/models/analytics/get_top_filters_no_results_response.rb b/lib/algolia/models/analytics/get_top_filters_no_results_response.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     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.
       attr_accessor :values
 
       # Attribute mapping from ruby-style variable name to JSON key.
diff --git a/lib/algolia/models/analytics/top_hit.rb b/lib/algolia/models/analytics/top_hit.rb
@@ -6,7 +6,7 @@
 module Algolia
   module Analytics
     class TopHit
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
diff --git a/lib/algolia/models/analytics/top_hit_with_analytics.rb b/lib/algolia/models/analytics/top_hit_with_analytics.rb
@@ -6,16 +6,16 @@
 module Algolia
   module Analytics
     class TopHitWithAnalytics
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
       attr_accessor :count
 
-      # 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.
       attr_accessor :click_through_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.
+      # 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.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb b/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb
@@ -6,16 +6,16 @@
 module Algolia
   module Analytics
     class TopHitWithRevenueAnalytics
-      # Object ID of a record that's returned as a search result.
+      # Object ID of a record returned as a search result.
       attr_accessor :hit
 
       # Number of occurrences.
       attr_accessor :count
 
-      # 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.
       attr_accessor :click_through_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.
+      # 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.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -27,19 +27,19 @@ class TopHitWithRevenueAnalytics
       # Number of conversions from this search.
       attr_accessor :conversion_count
 
-      # 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.
       attr_accessor :add_to_cart_rate
 
       # Number of add-to-cart events from this search.
       attr_accessor :add_to_cart_count
 
-      # 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.
       attr_accessor :purchase_rate
 
       # Number of purchase events from this search.
       attr_accessor :purchase_count
 
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
       # Attribute mapping from ruby-style variable name to JSON key.
diff --git a/lib/algolia/models/analytics/top_search_with_analytics.rb b/lib/algolia/models/analytics/top_search_with_analytics.rb
@@ -12,7 +12,7 @@ class TopSearchWithAnalytics
       # Number of searches.
       attr_accessor :count
 
-      # 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.
       attr_accessor :click_through_rate
 
       # 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.
@@ -21,7 +21,7 @@ class TopSearchWithAnalytics
       # List of positions in the search results and clicks associated with this search.
       attr_accessor :click_positions
 
-      # 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.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
diff --git a/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb b/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb
@@ -12,7 +12,7 @@ class TopSearchWithRevenueAnalytics
       # Number of searches.
       attr_accessor :count
 
-      # 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.
       attr_accessor :click_through_rate
 
       # 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.
@@ -21,7 +21,7 @@ class TopSearchWithRevenueAnalytics
       # List of positions in the search results and clicks associated with this search.
       attr_accessor :click_positions
 
-      # 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.
       attr_accessor :conversion_rate
 
       # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
@@ -36,16 +36,16 @@ class TopSearchWithRevenueAnalytics
       # Number of results (hits).
       attr_accessor :nb_hits
 
-      # Revenue associated with this search, broken-down by currencies.
+      # Revenue associated with this search: broken down by currency.
       attr_accessor :currencies
 
-      # 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.
       attr_accessor :add_to_cart_rate
 
       # Number of add-to-cart events from this search.
       attr_accessor :add_to_cart_count
 
-      # 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.
       attr_accessor :purchase_rate
 
       # Number of purchase events from this search.
