fix(specs): extend Analytics descriptions (#4360) (generated) [skip ci]

Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: Kai Welke <[email protected]>
algolia · Jan 16, 2025 · 10358e7 · 10358e7
1 parent 22167b8
commit 10358e7
Show file tree

Hide file tree

Showing 251 changed files with 2,784 additions and 1,357 deletions.
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsClient.cs
diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsConfiguration.cs b/clients/algoliasearch-client-csharp/algoliasearch/Clients/AnalyticsConfiguration.cs
@@ -1,7 +1,7 @@
 /*
 * Analytics API
 *
-* The Analytics API gives you access to metrics related to your Algolia search experience.  ## Base URLs  The base URLs for requests to the Analytics API are:  - `https://analytics.us.algolia.com` - `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above servers, based on your geographical location)  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Availability and authentication  Access to the Analytics API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Rate limits  You can make up to **100 requests per minute per app** to the Analytics API. The response includes headers with information about the limits.  ## Parameters  Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces.  ## Response status and errors  The Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information.  ## Version  The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL. 
+* The Analytics API gives you access to metrics related to your Algolia search experience.  ## Base URLs  The base URLs for requests to the Analytics API are:  - `https://analytics.us.algolia.com` - `https://analytics.de.algolia.com` - `https://analytics.algolia.com` (routes requests to the closest of the above servers, based on your geographical location)  Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics).  **All requests must use HTTPS.**  ## Availability and authentication  Access to the Analytics API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing).  To authenticate your API requests, add these headers:  - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request.   The required access control list (ACL) to make a request is listed in each endpoint's reference.  You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account).  ## Rate limits  You can make up to **100 requests per minute per app** to the Analytics API. The response includes headers with information about the limits.  ## Parameters  Query parameters must be [URL-encoded](https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding). Non-ASCII characters must be UTF-8 encoded. Plus characters (`+`) are interpreted as spaces.  ## Response status and errors  The Analytics API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.  - Successful responses return a `2xx` status - Client errors return a `4xx` status - Server errors are indicated by a `5xx` status.  Error responses have a `message` property with more information.  ## Version  The current version of the Analytics API is version 2, as indicated by the `/2/` in each endpoint's URL.  ## Query aggregation  Algolia accepts queries on each keystroke. To ensure you have relevant analytics data, however, the series of keystrokes is aggregated to keep only the latest (final) user query. This is called \"prefix\" aggregation.  For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/).  See the analytics implementation overview for more information about query aggregation. 
 *
 * The version of the OpenAPI document: 2.0.0
 * Generated by: https://github.com/openapitools/openapi-generator.git

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs
@@ -24,7 +24,7 @@ public DailyAddToCartRates() { }
   /// <summary>
   /// Initializes a new instance of the DailyAddToCartRates class.
   /// </summary>
-  /// <param name="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.  (required).</param>
+  /// <param name="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.  (required).</param>
   /// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="addToCartCount">Number of add-to-cart events from this search. (required) (default to 0).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
@@ -37,9 +37,9 @@ public DailyAddToCartRates(double? rate, int trackedSearchCount, int addToCartCo
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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. </value>
   [JsonPropertyName("rate")]
   public double? Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs
@@ -24,7 +24,7 @@ public DailyClickThroughRates() { }
   /// <summary>
   /// Initializes a new instance of the DailyClickThroughRates class.
   /// </summary>
-  /// <param name="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.  (required).</param>
+  /// <param name="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.  (required).</param>
   /// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
   /// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
@@ -37,9 +37,9 @@ public DailyClickThroughRates(double? rate, int clickCount, int trackedSearchCou
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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. </value>
   [JsonPropertyName("rate")]
   public double? Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs
@@ -24,7 +24,7 @@ public DailyConversionRates() { }
   /// <summary>
   /// Initializes a new instance of the DailyConversionRates class.
   /// </summary>
-  /// <param name="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.  (required).</param>
+  /// <param name="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.  (required).</param>
   /// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="conversionCount">Number of conversions from this search. (required) (default to 0).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
@@ -37,9 +37,9 @@ public DailyConversionRates(double? rate, int trackedSearchCount, int conversion
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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. </value>
   [JsonPropertyName("rate")]
   public double? Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs
@@ -24,7 +24,7 @@ public DailyNoClickRates() { }
   /// <summary>
   /// Initializes a new instance of the DailyNoClickRates class.
   /// </summary>
-  /// <param name="rate">No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required).</param>
+  /// <param name="rate">No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches.  (required).</param>
   /// <param name="count">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="noClickCount">Number of times this search was returned as a result without any click. (required).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
@@ -37,9 +37,9 @@ public DailyNoClickRates(double rate, int count, int noClickCount, string date)
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches.</value>
+  /// <value>No click rate: calculated as the number of tracked searches without clicks divided by the number of tracked searches. </value>
   [JsonPropertyName("rate")]
   public double Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoResultsRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoResultsRates.cs
@@ -27,7 +27,7 @@ public DailyNoResultsRates() { }
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
   /// <param name="noResultCount">Number of searches without any results. (required).</param>
   /// <param name="count">Number of searches. (required).</param>
-  /// <param name="rate">No results rate, calculated as number of searches with zero results divided by the total number of searches. (required).</param>
+  /// <param name="rate">No results rate: calculated as the number of searches with zero results divided by the total number of searches.  (required).</param>
   public DailyNoResultsRates(string date, int noResultCount, int count, double rate)
   {
     Date = date ?? throw new ArgumentNullException(nameof(date));
@@ -58,9 +58,9 @@ public DailyNoResultsRates(string date, int noResultCount, int count, double rat
   public int Count { get; set; }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>No results rate, calculated as number of searches with zero results divided by the total number of searches.</value>
+  /// <value>No results rate: calculated as the number of searches with zero results divided by the total number of searches. </value>
   [JsonPropertyName("rate")]
   public double Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs
@@ -24,7 +24,7 @@ public DailyPurchaseRates() { }
   /// <summary>
   /// Initializes a new instance of the DailyPurchaseRates class.
   /// </summary>
-  /// <param name="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.  (required).</param>
+  /// <param name="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.  (required).</param>
   /// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="purchaseCount">Number of purchase events from this search. (required) (default to 0).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
@@ -37,9 +37,9 @@ public DailyPurchaseRates(double? rate, int trackedSearchCount, int purchaseCoun
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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. </value>
   [JsonPropertyName("rate")]
   public double? Rate { get; set; }
 

diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyRevenue.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyRevenue.cs
@@ -24,7 +24,7 @@ public DailyRevenue() { }
   /// <summary>
   /// Initializes a new instance of the DailyRevenue class.
   /// </summary>
-  /// <param name="currencies">Revenue associated with this search, broken-down by currencies. (required).</param>
+  /// <param name="currencies">Revenue associated with this search: broken down by currency.  (required).</param>
   /// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
   public DailyRevenue(Dictionary<string, CurrencyCode> currencies, string date)
   {
@@ -33,9 +33,9 @@ public DailyRevenue(Dictionary<string, CurrencyCode> currencies, string date)
   }
 
   /// <summary>
-  /// Revenue associated with this search, broken-down by currencies.
+  /// Revenue associated with this search: broken down by currency. 
   /// </summary>
-  /// <value>Revenue associated with this search, broken-down by currencies.</value>
+  /// <value>Revenue associated with this search: broken down by currency. </value>
   [JsonPropertyName("currencies")]
   public Dictionary<string, CurrencyCode> Currencies { get; set; }
 

diff --git a/...ts/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs b/...ts/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs
@@ -24,7 +24,7 @@ public GetAddToCartRateResponse() { }
   /// <summary>
   /// Initializes a new instance of the GetAddToCartRateResponse class.
   /// </summary>
-  /// <param name="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.  (required).</param>
+  /// <param name="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.  (required).</param>
   /// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0).</param>
   /// <param name="addToCartCount">Number of add-to-cart events from this search. (required) (default to 0).</param>
   /// <param name="dates">Daily add-to-cart rates. (required).</param>
@@ -37,9 +37,9 @@ public GetAddToCartRateResponse(double? rate, int trackedSearchCount, int addToC
   }
 
   /// <summary>
-  /// 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. 
   /// </summary>
-  /// <value>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. </value>
+  /// <value>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. </value>
   [JsonPropertyName("rate")]
   public double? Rate { get; set; }