fix(specs): extend Analytics descriptions (generated)

algolia/api-clients-automation#4360 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: Kai Welke <[email protected]>
algolia · Jan 16, 2025 · d75f01c · d75f01c
1 parent d924762
commit d75f01c
Show file tree

Hide file tree

Showing 21 changed files with 774 additions and 355 deletions.
diff --git a/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java b/algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java
diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyAddToCartRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyAddToCartRates.java
@@ -28,9 +28,9 @@ public DailyAddToCartRates setRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyClickThroughRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyClickThroughRates.java
@@ -28,7 +28,7 @@ public DailyClickThroughRates setRate(Double rate) {
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyConversionRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyConversionRates.java
@@ -28,9 +28,9 @@ public DailyConversionRates setRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoClickRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoClickRates.java
@@ -28,8 +28,8 @@ public DailyNoClickRates setRate(Double rate) {
   }
 
   /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number
-   * of tracked searches. minimum: 0 maximum: 1
+   * No click rate: calculated as the number of tracked searches without clicks divided by the
+   * number of tracked searches. minimum: 0 maximum: 1
    */
   @javax.annotation.Nonnull
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoResultsRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoResultsRates.java
@@ -61,8 +61,8 @@ public DailyNoResultsRates setRate(Double rate) {
   }
 
   /**
-   * No results rate, calculated as number of searches with zero results divided by the total number
-   * of searches. minimum: 0 maximum: 1
+   * No results rate: calculated as the number of searches with zero results divided by the total
+   * number of searches. minimum: 0 maximum: 1
    */
   @javax.annotation.Nonnull
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyPurchaseRates.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyPurchaseRates.java
@@ -28,7 +28,7 @@ public DailyPurchaseRates setRate(Double rate) {
   }
 
   /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event
+   * 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. minimum: 0 maximum: 1
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/DailyRevenue.java b/algoliasearch/src/main/java/com/algolia/model/analytics/DailyRevenue.java
@@ -28,7 +28,7 @@ public DailyRevenue putCurrencies(String key, CurrencyCode currenciesItem) {
     return this;
   }
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency. */
   @javax.annotation.Nonnull
   public Map<String, CurrencyCode> getCurrencies() {
     return currencies;

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetAddToCartRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetAddToCartRateResponse.java
@@ -30,9 +30,9 @@ public GetAddToCartRateResponse setRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetClickThroughRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetClickThroughRateResponse.java
@@ -30,7 +30,7 @@ public GetClickThroughRateResponse setRate(Double rate) {
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetConversionRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetConversionRateResponse.java
@@ -30,9 +30,9 @@ public GetConversionRateResponse setRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetNoClickRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetNoClickRateResponse.java
@@ -30,8 +30,8 @@ public GetNoClickRateResponse setRate(Double rate) {
   }
 
   /**
-   * No click rate, calculated as number of tracked searches without any click divided by the number
-   * of tracked searches. minimum: 0 maximum: 1
+   * No click rate: calculated as the number of tracked searches without clicks divided by the
+   * number of tracked searches. minimum: 0 maximum: 1
    */
   @javax.annotation.Nonnull
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetNoResultsRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetNoResultsRateResponse.java
@@ -30,8 +30,8 @@ public GetNoResultsRateResponse setRate(Double rate) {
   }
 
   /**
-   * No results rate, calculated as number of searches with zero results divided by the total number
-   * of searches. minimum: 0 maximum: 1
+   * No results rate: calculated as the number of searches with zero results divided by the total
+   * number of searches. minimum: 0 maximum: 1
    */
   @javax.annotation.Nonnull
   public Double getRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetPurchaseRateResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetPurchaseRateResponse.java
@@ -30,7 +30,7 @@ public GetPurchaseRateResponse setRate(Double rate) {
   }
 
   /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event
+   * 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. minimum: 0 maximum: 1
    */

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetRevenue.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetRevenue.java
@@ -30,7 +30,7 @@ public GetRevenue putCurrencies(String key, CurrencyCode currenciesItem) {
     return this;
   }
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency. */
   @javax.annotation.Nonnull
   public Map<String, CurrencyCode> getCurrencies() {
     return currencies;

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/GetTopFiltersNoResultsResponse.java b/algoliasearch/src/main/java/com/algolia/model/analytics/GetTopFiltersNoResultsResponse.java
@@ -26,8 +26,7 @@ public GetTopFiltersNoResultsResponse addValues(GetTopFiltersNoResultsValues val
 
   /**
    * 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.
+   * parameter isn't a search without results, or the `search` parameter is absent from the request.
    */
   @javax.annotation.Nullable
   public List<GetTopFiltersNoResultsValues> getValues() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/TopHit.java b/algoliasearch/src/main/java/com/algolia/model/analytics/TopHit.java
@@ -21,7 +21,7 @@ public TopHit setHit(String hit) {
     return this;
   }
 
-  /** Object ID of a record that's returned as a search result. */
+  /** Object ID of a record returned as a search result. */
   @javax.annotation.Nonnull
   public String getHit() {
     return hit;

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithAnalytics.java b/algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithAnalytics.java
@@ -36,7 +36,7 @@ public TopHitWithAnalytics setHit(String hit) {
     return this;
   }
 
-  /** Object ID of a record that's returned as a search result. */
+  /** Object ID of a record returned as a search result. */
   @javax.annotation.Nonnull
   public String getHit() {
     return hit;
@@ -59,7 +59,7 @@ public TopHitWithAnalytics setClickThroughRate(Double clickThroughRate) {
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */
@@ -74,9 +74,9 @@ public TopHitWithAnalytics setConversionRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getConversionRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithRevenueAnalytics.java b/algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithRevenueAnalytics.java
@@ -53,7 +53,7 @@ public TopHitWithRevenueAnalytics setHit(String hit) {
     return this;
   }
 
-  /** Object ID of a record that's returned as a search result. */
+  /** Object ID of a record returned as a search result. */
   @javax.annotation.Nonnull
   public String getHit() {
     return hit;
@@ -76,7 +76,7 @@ public TopHitWithRevenueAnalytics setClickThroughRate(Double clickThroughRate) {
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */
@@ -91,9 +91,9 @@ public TopHitWithRevenueAnalytics setConversionRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getConversionRate() {
@@ -142,9 +142,9 @@ public TopHitWithRevenueAnalytics setAddToCartRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getAddToCartRate() {
@@ -168,7 +168,7 @@ public TopHitWithRevenueAnalytics setPurchaseRate(Double purchaseRate) {
   }
 
   /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event
+   * 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. minimum: 0 maximum: 1
    */
@@ -198,7 +198,7 @@ public TopHitWithRevenueAnalytics putCurrencies(String key, CurrencyCode currenc
     return this;
   }
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency. */
   @javax.annotation.Nonnull
   public Map<String, CurrencyCode> getCurrencies() {
     return currencies;

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithAnalytics.java b/algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithAnalytics.java
@@ -70,7 +70,7 @@ public TopSearchWithAnalytics setClickThroughRate(Double clickThroughRate) {
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */
@@ -115,9 +115,9 @@ public TopSearchWithAnalytics setConversionRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getConversionRate() {

diff --git a/algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithRevenueAnalytics.java b/algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithRevenueAnalytics.java
@@ -87,7 +87,7 @@ public TopSearchWithRevenueAnalytics setClickThroughRate(Double clickThroughRate
   }
 
   /**
-   * Click-through rate, calculated as number of tracked searches with at least one click event
+   * 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. minimum: 0 maximum: 1
    */
@@ -132,9 +132,9 @@ public TopSearchWithRevenueAnalytics setConversionRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getConversionRate() {
@@ -198,7 +198,7 @@ public TopSearchWithRevenueAnalytics putCurrencies(String key, CurrencyCode curr
     return this;
   }
 
-  /** Revenue associated with this search, broken-down by currencies. */
+  /** Revenue associated with this search: broken down by currency. */
   @javax.annotation.Nonnull
   public Map<String, CurrencyCode> getCurrencies() {
     return currencies;
@@ -210,9 +210,9 @@ public TopSearchWithRevenueAnalytics setAddToCartRate(Double 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. minimum: 0 maximum: 1
+   * 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. minimum: 0 maximum: 1
    */
   @javax.annotation.Nullable
   public Double getAddToCartRate() {
@@ -236,7 +236,7 @@ public TopSearchWithRevenueAnalytics setPurchaseRate(Double purchaseRate) {
   }
 
   /**
-   * Purchase rate, calculated as number of tracked searches with at least one purchase event
+   * 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. minimum: 0 maximum: 1
    */