fix(specs): extend Analytics descriptions (generated)

algolia-bot · gazconroy · Gary Conroy · algolia-bot · commit 175dd42aacf2 · 2025-01-16T10:59:02.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/Api/AnalyticsClient.php b/lib/Api/AnalyticsClient.php
diff --git a/lib/Model/Analytics/DailyAddToCartRates.php b/lib/Model/Analytics/DailyAddToCartRates.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyClickThroughRates.php b/lib/Model/Analytics/DailyClickThroughRates.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyConversionRates.php b/lib/Model/Analytics/DailyConversionRates.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyNoClickRates.php b/lib/Model/Analytics/DailyNoClickRates.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $rate no click rate, calculated as number of tracked searches without any click divided by the number of tracked searches
+     * @param float $rate no click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyNoResultsRates.php b/lib/Model/Analytics/DailyNoResultsRates.php
@@ -275,7 +275,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $rate no results rate, calculated as number of searches with zero results divided by the total number of searches
+     * @param float $rate no results rate: calculated as the number of searches with zero results divided by the total number of searches
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyPurchaseRates.php b/lib/Model/Analytics/DailyPurchaseRates.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/DailyRevenue.php b/lib/Model/Analytics/DailyRevenue.php
@@ -181,7 +181,7 @@ public function getCurrencies()
     /**
      * Sets currencies.
      *
-     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search, broken-down by currencies
+     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search: broken down by currency
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetAddToCartRateResponse.php b/lib/Model/Analytics/GetAddToCartRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetClickThroughRateResponse.php b/lib/Model/Analytics/GetClickThroughRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetConversionRateResponse.php b/lib/Model/Analytics/GetConversionRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetNoClickRateResponse.php b/lib/Model/Analytics/GetNoClickRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $rate no click rate, calculated as number of tracked searches without any click divided by the number of tracked searches
+     * @param float $rate no click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetNoResultsRateResponse.php b/lib/Model/Analytics/GetNoResultsRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $rate no results rate, calculated as number of searches with zero results divided by the total number of searches
+     * @param float $rate no results rate: calculated as the number of searches with zero results divided by the total number of searches
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetPurchaseRateResponse.php b/lib/Model/Analytics/GetPurchaseRateResponse.php
@@ -203,7 +203,7 @@ public function getRate()
     /**
      * Sets rate.
      *
-     * @param float $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 float $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetRevenue.php b/lib/Model/Analytics/GetRevenue.php
@@ -181,7 +181,7 @@ public function getCurrencies()
     /**
      * Sets currencies.
      *
-     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search, broken-down by currencies
+     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search: broken down by currency
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/GetTopFiltersNoResultsResponse.php b/lib/Model/Analytics/GetTopFiltersNoResultsResponse.php
@@ -170,7 +170,7 @@ public function getValues()
     /**
      * Sets values.
      *
-     * @param \Algolia\AlgoliaSearch\Model\Analytics\GetTopFiltersNoResultsValues[] $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 \Algolia\AlgoliaSearch\Model\Analytics\GetTopFiltersNoResultsValues[] $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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/TopHit.php b/lib/Model/Analytics/TopHit.php
@@ -181,7 +181,7 @@ public function getHit()
     /**
      * Sets hit.
      *
-     * @param string $hit object ID of a record that's returned as a search result
+     * @param string $hit object ID of a record returned as a search result
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/TopHitWithAnalytics.php b/lib/Model/Analytics/TopHitWithAnalytics.php
@@ -236,7 +236,7 @@ public function getHit()
     /**
      * Sets hit.
      *
-     * @param string $hit object ID of a record that's returned as a search result
+     * @param string $hit object ID of a record returned as a search result
      *
      * @return self
      */
@@ -284,7 +284,7 @@ public function getClickThroughRate()
     /**
      * Sets clickThroughRate.
      *
-     * @param float $clickThroughRate 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 float $clickThroughRate 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.
      *
      * @return self
      */
@@ -308,7 +308,7 @@ public function getConversionRate()
     /**
      * Sets conversionRate.
      *
-     * @param float $conversionRate 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 float $conversionRate 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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/TopHitWithRevenueAnalytics.php b/lib/Model/Analytics/TopHitWithRevenueAnalytics.php
@@ -291,7 +291,7 @@ public function getHit()
     /**
      * Sets hit.
      *
-     * @param string $hit object ID of a record that's returned as a search result
+     * @param string $hit object ID of a record returned as a search result
      *
      * @return self
      */
@@ -339,7 +339,7 @@ public function getClickThroughRate()
     /**
      * Sets clickThroughRate.
      *
-     * @param float $clickThroughRate 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 float $clickThroughRate 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.
      *
      * @return self
      */
@@ -363,7 +363,7 @@ public function getConversionRate()
     /**
      * Sets conversionRate.
      *
-     * @param float $conversionRate 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 float $conversionRate 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.
      *
      * @return self
      */
@@ -459,7 +459,7 @@ public function getAddToCartRate()
     /**
      * Sets addToCartRate.
      *
-     * @param float $addToCartRate 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 float $addToCartRate 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.
      *
      * @return self
      */
@@ -507,7 +507,7 @@ public function getPurchaseRate()
     /**
      * Sets purchaseRate.
      *
-     * @param float $purchaseRate 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 float $purchaseRate 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.
      *
      * @return self
      */
@@ -555,7 +555,7 @@ public function getCurrencies()
     /**
      * Sets currencies.
      *
-     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search, broken-down by currencies
+     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search: broken down by currency
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/TopSearchWithAnalytics.php b/lib/Model/Analytics/TopSearchWithAnalytics.php
@@ -317,7 +317,7 @@ public function getClickThroughRate()
     /**
      * Sets clickThroughRate.
      *
-     * @param float $clickThroughRate 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 float $clickThroughRate 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.
      *
      * @return self
      */
@@ -389,7 +389,7 @@ public function getConversionRate()
     /**
      * Sets conversionRate.
      *
-     * @param float $conversionRate 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 float $conversionRate 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.
      *
      * @return self
      */
diff --git a/lib/Model/Analytics/TopSearchWithRevenueAnalytics.php b/lib/Model/Analytics/TopSearchWithRevenueAnalytics.php
@@ -372,7 +372,7 @@ public function getClickThroughRate()
     /**
      * Sets clickThroughRate.
      *
-     * @param float $clickThroughRate 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 float $clickThroughRate 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.
      *
      * @return self
      */
@@ -444,7 +444,7 @@ public function getConversionRate()
     /**
      * Sets conversionRate.
      *
-     * @param float $conversionRate 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 float $conversionRate 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.
      *
      * @return self
      */
@@ -564,7 +564,7 @@ public function getCurrencies()
     /**
      * Sets currencies.
      *
-     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search, broken-down by currencies
+     * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search: broken down by currency
      *
      * @return self
      */
@@ -588,7 +588,7 @@ public function getAddToCartRate()
     /**
      * Sets addToCartRate.
      *
-     * @param float $addToCartRate 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 float $addToCartRate 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.
      *
      * @return self
      */
@@ -636,7 +636,7 @@ public function getPurchaseRate()
     /**
      * Sets purchaseRate.
      *
-     * @param float $purchaseRate 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 float $purchaseRate 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.
      *
      * @return self
      */

Original file line number	Diff line number	Diff line change
`@@ -203,7 +203,7 @@ public function getRate()`
`203`	`203`	`/**`
`204`	`204`	`* Sets rate.`
`205`	`205`	`*`
`206`		- * @param float $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.
	`206`	+ * @param float $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.
`207`	`207`	`*`
`208`	`208`	`* @return self`
`209`	`209`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -275,7 +275,7 @@ public function getRate()`
`275`	`275`	`/**`
`276`	`276`	`* Sets rate.`
`277`	`277`	`*`
`278`		`- * @param float $rate no results rate, calculated as number of searches with zero results divided by the total number of searches`
	`278`	`+ * @param float $rate no results rate: calculated as the number of searches with zero results divided by the total number of searches`
`279`	`279`	`*`
`280`	`280`	`* @return self`
`281`	`281`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ public function getCurrencies()`
`181`	`181`	`/**`
`182`	`182`	`* Sets currencies.`
`183`	`183`	`*`
`184`		`- * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search, broken-down by currencies`
	`184`	`+ * @param array<string,\Algolia\AlgoliaSearch\Model\Analytics\CurrencyCode> $currencies revenue associated with this search: broken down by currency`
`185`	`185`	`*`
`186`	`186`	`* @return self`
`187`	`187`	`*/`