Skip to content

Commit

Permalink
fix(clients): escape char in comments (#3973) (generated) [skip ci]
Browse files Browse the repository at this point in the history
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
  • Loading branch information
algolia-bot committed Oct 15, 2024
1 parent 162dfaf commit cd7c432
Show file tree
Hide file tree
Showing 225 changed files with 715 additions and 724 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ public ABTestResponse() { }
/// </summary>
/// <param name="index">Index name of the A/B test variant (case-sensitive). (required).</param>
/// <param name="abTestID">Unique A/B test identifier. (required).</param>
/// <param name="taskID">Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task&#39;s progress with the [&#x60;task&#x60; operation](#tag/Indices/operation/getTask) and this &#x60;taskID&#x60;. (required).</param>
/// <param name="taskID">Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`. (required).</param>
public ABTestResponse(string index, int abTestID, long taskID)
{
Index = index ?? throw new ArgumentNullException(nameof(index));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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>
public DailyAddToCartRates(double? rate, int trackedSearchCount, int addToCartCount, string date)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public DailyAverageClicks() { }
/// <summary>
/// Initializes a new instance of the DailyAverageClicks class.
/// </summary>
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="average">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. (required).</param>
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
/// <param name="date">Date in the format YYYY-MM-DD. (required).</param>
public DailyAverageClicks(double? average, int clickCount, string date)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <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="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 &#x60;clickAnalytics&#x60; parameter is true. (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>
public DailyClickThroughRates(double? rate, int clickCount, int trackedSearchCount, string date)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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>
public DailyConversionRates(double? rate, int trackedSearchCount, int conversionCount, string date)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public DailyNoClickRates() { }
/// 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="count">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</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>
public DailyNoClickRates(double rate, int count, int noClickCount, string date)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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>
public DailyPurchaseRates(double? rate, int trackedSearchCount, int purchaseCount, string date)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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>
public GetAddToCartRateResponse(double? rate, int trackedSearchCount, int addToCartCount, List<DailyAddToCartRates> dates)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public GetAverageClickPositionResponse() { }
/// <summary>
/// Initializes a new instance of the GetAverageClickPositionResponse class.
/// </summary>
/// <param name="average">Average position of a clicked search result in the list of search results. If null, Algolia didn&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="average">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. (required).</param>
/// <param name="clickCount">Number of clicks associated with this search. (required) (default to 0).</param>
/// <param name="dates">Daily average click positions. (required).</param>
public GetAverageClickPositionResponse(double? average, int clickCount, List<DailyAverageClicks> dates)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ public GetClickThroughRateResponse() { }
/// <summary>
/// Initializes a new instance of the GetClickThroughRateResponse 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <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="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 &#x60;clickAnalytics&#x60; parameter is true. (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="dates">Daily click-through rates. (required).</param>
public GetClickThroughRateResponse(double? rate, int clickCount, int trackedSearchCount, List<DailyClickThroughRates> dates)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ public GetConversionRateResponse() { }
/// <summary>
/// Initializes a new instance of the GetConversionRateResponse 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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="dates">Daily conversion rates. (required).</param>
public GetConversionRateResponse(double? rate, int trackedSearchCount, int conversionCount, List<DailyConversionRates> dates)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ public GetNoClickRateResponse() { }
/// Initializes a new instance of the GetNoClickRateResponse 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="count">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</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="dates">Daily no click rates. (required).</param>
public GetNoClickRateResponse(double rate, int count, int noClickCount, List<DailyNoClickRates> dates)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ public GetPurchaseRateResponse() { }
/// <summary>
/// Initializes a new instance of the GetPurchaseRateResponse 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&#39;t receive any search requests with &#x60;clickAnalytics&#x60; set to true. (required).</param>
/// <param name="trackedSearchCount">Number of tracked searches. Tracked searches are search requests where the &#x60;clickAnalytics&#x60; parameter is true. (required) (default to 0).</param>
/// <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="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="dates">Daily purchase rates. (required).</param>
public GetPurchaseRateResponse(double? rate, int trackedSearchCount, int purchaseCount, List<DailyPurchaseRates> dates)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public GetTopFiltersNoResultsResponse() { }
/// <summary>
/// Initializes a new instance of the GetTopFiltersNoResultsResponse class.
/// </summary>
/// <param name="values">Filters for searches without any results. If null, the search term specified with the &#x60;search&#x60; parameter is not a search without results, or the &#x60;search&#x60; parameter is absent from the request. (required).</param>
/// <param name="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. (required).</param>
public GetTopFiltersNoResultsResponse(List<GetTopFiltersNoResultsValues> values)
{
Values = values ?? throw new ArgumentNullException(nameof(values));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,37 +25,37 @@ public enum Operator
Colon = 1,

/// <summary>
/// Enum LessThan for value: &lt;
/// Enum LessThan for value: <
/// </summary>
[JsonPropertyName("<")]
LessThan = 2,

/// <summary>
/// Enum LessThanOrEqualTo for value: &lt;&#x3D;
/// Enum LessThanOrEqualTo for value: <=
/// </summary>
[JsonPropertyName("<=")]
LessThanOrEqualTo = 3,

/// <summary>
/// Enum Equal for value: &#x3D;
/// Enum Equal for value: =
/// </summary>
[JsonPropertyName("=")]
Equal = 4,

/// <summary>
/// Enum NotEqual for value: !&#x3D;
/// Enum NotEqual for value: !=
/// </summary>
[JsonPropertyName("!=")]
NotEqual = 5,

/// <summary>
/// Enum GreaterThan for value: &gt;
/// Enum GreaterThan for value: >
/// </summary>
[JsonPropertyName(">")]
GreaterThan = 6,

/// <summary>
/// Enum GreaterThanOrEqualTo for value: &gt;&#x3D;
/// Enum GreaterThanOrEqualTo for value: >=
/// </summary>
[JsonPropertyName(">=")]
GreaterThanOrEqualTo = 7
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public TopHit() { }
/// <summary>
/// Initializes a new instance of the TopHit class.
/// </summary>
/// <param name="hit">Object ID of a record that&#39;s returned as a search result. (required).</param>
/// <param name="hit">Object ID of a record that's returned as a search result. (required).</param>
/// <param name="count">Number of occurrences. (required).</param>
public TopHit(string hit, int count)
{
Expand Down
Loading

0 comments on commit cd7c432

Please sign in to comment.