diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/ABTestResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/ABTestResponse.cs index 747a46ead5..089e4b4189 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/ABTestResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Abtesting/ABTestResponse.cs @@ -26,7 +26,7 @@ public ABTestResponse() { } /// /// Index name of the A/B test variant (case-sensitive). (required). /// Unique A/B test identifier. (required). - /// 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). + /// 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). public ABTestResponse(string index, int abTestID, long taskID) { Index = index ?? throw new ArgumentNullException(nameof(index)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs index 62fc80a788..406dd3c5a1 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAddToCartRates.cs @@ -24,8 +24,8 @@ public DailyAddToCartRates() { } /// /// Initializes a new instance of the DailyAddToCartRates class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of add-to-cart events from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). public DailyAddToCartRates(double? rate, int trackedSearchCount, int addToCartCount, string date) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAverageClicks.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAverageClicks.cs index f83eb4a890..be1c71725b 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAverageClicks.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyAverageClicks.cs @@ -24,7 +24,7 @@ public DailyAverageClicks() { } /// /// Initializes a new instance of the DailyAverageClicks class. /// - /// 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). + /// 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). /// Number of clicks associated with this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). public DailyAverageClicks(double? average, int clickCount, string date) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs index 17257f301a..91186409ad 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyClickThroughRates.cs @@ -24,9 +24,9 @@ public DailyClickThroughRates() { } /// /// Initializes a new instance of the DailyClickThroughRates class. /// - /// 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). + /// 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). /// Number of clicks associated with this search. (required) (default to 0). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). public DailyClickThroughRates(double? rate, int clickCount, int trackedSearchCount, string date) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs index 2ba3f3c62a..9dc7278af3 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyConversionRates.cs @@ -24,8 +24,8 @@ public DailyConversionRates() { } /// /// Initializes a new instance of the DailyConversionRates class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). public DailyConversionRates(double? rate, int trackedSearchCount, int conversionCount, string date) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs index 0a002655ad..9dbf156cce 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyNoClickRates.cs @@ -25,7 +25,7 @@ public DailyNoClickRates() { } /// Initializes a new instance of the DailyNoClickRates class. /// /// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of times this search was returned as a result without any click. (required). /// Date in the format YYYY-MM-DD. (required). public DailyNoClickRates(double rate, int count, int noClickCount, string date) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs index 5c6d944f5d..cc7479cefd 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/DailyPurchaseRates.cs @@ -24,8 +24,8 @@ public DailyPurchaseRates() { } /// /// Initializes a new instance of the DailyPurchaseRates class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of purchase events from this search. (required) (default to 0). /// Date in the format YYYY-MM-DD. (required). public DailyPurchaseRates(double? rate, int trackedSearchCount, int purchaseCount, string date) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs index 46aa26b233..faf688b662 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAddToCartRateResponse.cs @@ -24,8 +24,8 @@ public GetAddToCartRateResponse() { } /// /// Initializes a new instance of the GetAddToCartRateResponse class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of add-to-cart events from this search. (required) (default to 0). /// Daily add-to-cart rates. (required). public GetAddToCartRateResponse(double? rate, int trackedSearchCount, int addToCartCount, List dates) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAverageClickPositionResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAverageClickPositionResponse.cs index cd3488b72d..23733f5164 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAverageClickPositionResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetAverageClickPositionResponse.cs @@ -24,7 +24,7 @@ public GetAverageClickPositionResponse() { } /// /// Initializes a new instance of the GetAverageClickPositionResponse class. /// - /// 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). + /// 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). /// Number of clicks associated with this search. (required) (default to 0). /// Daily average click positions. (required). public GetAverageClickPositionResponse(double? average, int clickCount, List dates) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs index 11721c6e6b..ca3817919b 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetClickThroughRateResponse.cs @@ -24,9 +24,9 @@ public GetClickThroughRateResponse() { } /// /// Initializes a new instance of the GetClickThroughRateResponse class. /// - /// 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). + /// 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). /// Number of clicks associated with this search. (required) (default to 0). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Daily click-through rates. (required). public GetClickThroughRateResponse(double? rate, int clickCount, int trackedSearchCount, List dates) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetConversionRateResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetConversionRateResponse.cs index 0f2f477523..43b25bf7ad 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetConversionRateResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetConversionRateResponse.cs @@ -24,8 +24,8 @@ public GetConversionRateResponse() { } /// /// Initializes a new instance of the GetConversionRateResponse class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Daily conversion rates. (required). public GetConversionRateResponse(double? rate, int trackedSearchCount, int conversionCount, List dates) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs index 7db445b2d0..18c515b83f 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetNoClickRateResponse.cs @@ -25,7 +25,7 @@ public GetNoClickRateResponse() { } /// Initializes a new instance of the GetNoClickRateResponse class. /// /// No click rate, calculated as number of tracked searches without any click divided by the number of tracked searches. (required). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of times this search was returned as a result without any click. (required). /// Daily no click rates. (required). public GetNoClickRateResponse(double rate, int count, int noClickCount, List dates) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs index 8cb7bfa077..e254998680 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetPurchaseRateResponse.cs @@ -24,8 +24,8 @@ public GetPurchaseRateResponse() { } /// /// Initializes a new instance of the GetPurchaseRateResponse class. /// - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of purchase events from this search. (required) (default to 0). /// Daily purchase rates. (required). public GetPurchaseRateResponse(double? rate, int trackedSearchCount, int purchaseCount, List dates) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs index 7b10fedb5b..6b9a3a4c49 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/GetTopFiltersNoResultsResponse.cs @@ -24,7 +24,7 @@ public GetTopFiltersNoResultsResponse() { } /// /// Initializes a new instance of the GetTopFiltersNoResultsResponse class. /// - /// 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). + /// 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). public GetTopFiltersNoResultsResponse(List values) { Values = values ?? throw new ArgumentNullException(nameof(values)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/Operator.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/Operator.cs index 747c044ee7..e869c8b676 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/Operator.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/Operator.cs @@ -25,37 +25,37 @@ public enum Operator Colon = 1, /// - /// Enum LessThan for value: < + /// Enum LessThan for value: < /// [JsonPropertyName("<")] LessThan = 2, /// - /// Enum LessThanOrEqualTo for value: <= + /// Enum LessThanOrEqualTo for value: <= /// [JsonPropertyName("<=")] LessThanOrEqualTo = 3, /// - /// Enum Equal for value: = + /// Enum Equal for value: = /// [JsonPropertyName("=")] Equal = 4, /// - /// Enum NotEqual for value: != + /// Enum NotEqual for value: != /// [JsonPropertyName("!=")] NotEqual = 5, /// - /// Enum GreaterThan for value: > + /// Enum GreaterThan for value: > /// [JsonPropertyName(">")] GreaterThan = 6, /// - /// Enum GreaterThanOrEqualTo for value: >= + /// Enum GreaterThanOrEqualTo for value: >= /// [JsonPropertyName(">=")] GreaterThanOrEqualTo = 7 diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHit.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHit.cs index 904b49443e..ebc617f8d7 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHit.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHit.cs @@ -24,7 +24,7 @@ public TopHit() { } /// /// Initializes a new instance of the TopHit class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record that's returned as a search result. (required). /// Number of occurrences. (required). public TopHit(string hit, int count) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs index 074ae90ef3..5591fc819d 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithAnalytics.cs @@ -24,11 +24,11 @@ public TopHitWithAnalytics() { } /// /// Initializes a new instance of the TopHitWithAnalytics class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record that's returned as a search result. (required). /// Number of occurrences. (required). - /// 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). - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). public TopHitWithAnalytics(string hit, int count, double? clickThroughRate, double? conversionRate, int trackedHitCount, int clickCount, int conversionCount) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs index 2bce7b1785..b4c64a67e0 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopHitWithRevenueAnalytics.cs @@ -24,16 +24,16 @@ public TopHitWithRevenueAnalytics() { } /// /// Initializes a new instance of the TopHitWithRevenueAnalytics class. /// - /// Object ID of a record that's returned as a search result. (required). + /// Object ID of a record that's returned as a search result. (required). /// Number of occurrences. (required). - /// 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). - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). - /// 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). + /// 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). /// Number of add-to-cart events from this search. (required) (default to 0). - /// 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). + /// 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). /// Number of purchase events from this search. (required) (default to 0). /// Revenue associated with this search, broken-down by currencies. (required). public TopHitWithRevenueAnalytics(string hit, int count, double? clickThroughRate, double? conversionRate, int trackedHitCount, int clickCount, int conversionCount, double? addToCartRate, int addToCartCount, double? purchaseRate, int purchaseCount, Dictionary currencies) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs index 9f27d80ff5..786dac9412 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithAnalytics.cs @@ -26,11 +26,11 @@ public TopSearchWithAnalytics() { } /// /// Search query. (required). /// Number of searches. (required). - /// 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). - /// 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). + /// 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). + /// 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). /// List of positions in the search results and clicks associated with this search. (required). - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Number of results (hits). (required). diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs index 196687e53a..fa9f7a26b1 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Analytics/TopSearchWithRevenueAnalytics.cs @@ -26,18 +26,18 @@ public TopSearchWithRevenueAnalytics() { } /// /// Search query. (required). /// Number of searches. (required). - /// 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). - /// 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). + /// 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). + /// 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). /// List of positions in the search results and clicks associated with this search. (required). - /// 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). - /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). + /// 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). + /// Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true. (required) (default to 0). /// Number of clicks associated with this search. (required) (default to 0). /// Number of conversions from this search. (required) (default to 0). /// Number of results (hits). (required). /// Revenue associated with this search, broken-down by currencies. (required). - /// 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). + /// 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). /// Number of add-to-cart events from this search. (required) (default to 0). - /// 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). + /// 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). /// Number of purchase events from this search. (required) (default to 0). public TopSearchWithRevenueAnalytics(string search, int count, double? clickThroughRate, double? averageClickPosition, List clickPositions, double? conversionRate, int trackedSearchCount, int clickCount, int conversionCount, int nbHits, Dictionary currencies, double? addToCartRate, int addToCartCount, double? purchaseRate, int purchaseCount) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAPIKey.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAPIKey.cs index 778e85e8c0..d0a62ddacd 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAPIKey.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAPIKey.cs @@ -24,7 +24,7 @@ public AuthAPIKey() { } /// /// Initializes a new instance of the AuthAPIKey class. /// - /// API key. This field is `null` in the API response. (required). + /// API key. This field is `null` in the API response. (required). public AuthAPIKey(string key) { Key = key ?? throw new ArgumentNullException(nameof(key)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgolia.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgolia.cs index 6056d6915f..0de7461c61 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgolia.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgolia.cs @@ -25,7 +25,7 @@ public AuthAlgolia() { } /// Initializes a new instance of the AuthAlgolia class. /// /// Algolia application ID. (required). - /// Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response. (required). + /// Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response. (required). public AuthAlgolia(string appID, string apiKey) { AppID = appID ?? throw new ArgumentNullException(nameof(appID)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgoliaInsights.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgoliaInsights.cs index d7c3731149..0fcd68dddf 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgoliaInsights.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthAlgoliaInsights.cs @@ -25,7 +25,7 @@ public AuthAlgoliaInsights() { } /// Initializes a new instance of the AuthAlgoliaInsights class. /// /// Algolia application ID. (required). - /// Algolia API key with the ACL: `search`. This field is `null` in the API response. (required). + /// Algolia API key with the ACL: `search`. This field is `null` in the API response. (required). public AuthAlgoliaInsights(string appID, string apiKey) { AppID = appID ?? throw new ArgumentNullException(nameof(appID)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthBasic.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthBasic.cs index 014afc3a7b..53dbd25dcd 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthBasic.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthBasic.cs @@ -25,7 +25,7 @@ public AuthBasic() { } /// Initializes a new instance of the AuthBasic class. /// /// Username. (required). - /// Password. This field is `null` in the API response. (required). + /// Password. This field is `null` in the API response. (required). public AuthBasic(string username, string password) { Username = username ?? throw new ArgumentNullException(nameof(username)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthGoogleServiceAccount.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthGoogleServiceAccount.cs index 2fb545e2c5..81b87676ed 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthGoogleServiceAccount.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthGoogleServiceAccount.cs @@ -25,7 +25,7 @@ public AuthGoogleServiceAccount() { } /// Initializes a new instance of the AuthGoogleServiceAccount class. /// /// Email address of the Google service account. (required). - /// Private key of the Google service account. This field is `null` in the API response. (required). + /// Private key of the Google service account. This field is `null` in the API response. (required). public AuthGoogleServiceAccount(string clientEmail, string privateKey) { ClientEmail = clientEmail ?? throw new ArgumentNullException(nameof(clientEmail)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthOAuth.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthOAuth.cs index f8986b6ba9..2203e047fb 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthOAuth.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/AuthOAuth.cs @@ -26,7 +26,7 @@ public AuthOAuth() { } /// /// URL for the OAuth endpoint. (required). /// Client ID. (required). - /// Client secret. This field is `null` in the API response. (required). + /// Client secret. This field is `null` in the API response. (required). public AuthOAuth(string url, string clientId, string clientSecret) { Url = url ?? throw new ArgumentNullException(nameof(url)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTrigger.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTrigger.cs index 1cd3cbcc9e..7f480ce92e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTrigger.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTrigger.cs @@ -31,7 +31,7 @@ public ScheduleTrigger() { } /// Initializes a new instance of the ScheduleTrigger class. /// /// type (required). - /// Cron expression for the task's schedule. (required). + /// Cron expression for the task's schedule. (required). /// The next scheduled run of the task in RFC 3339 format. (required). public ScheduleTrigger(ScheduleTriggerType? type, string cron, string nextRun) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTriggerInput.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTriggerInput.cs index 5f0454d5de..35d2fec051 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTriggerInput.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/ScheduleTriggerInput.cs @@ -31,7 +31,7 @@ public ScheduleTriggerInput() { } /// Initializes a new instance of the ScheduleTriggerInput class. /// /// type (required). - /// Cron expression for the task's schedule. (required). + /// Cron expression for the task's schedule. (required). public ScheduleTriggerInput(ScheduleTriggerType? type, string cron) { Type = type; diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TriggerUpdateInput.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TriggerUpdateInput.cs index 724489f275..50ef2d2a4a 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TriggerUpdateInput.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Ingestion/TriggerUpdateInput.cs @@ -24,7 +24,7 @@ public TriggerUpdateInput() { } /// /// Initializes a new instance of the TriggerUpdateInput class. /// - /// Cron expression for the task's schedule. (required). + /// Cron expression for the task's schedule. (required). public TriggerUpdateInput(string cron) { Cron = cron ?? throw new ArgumentNullException(nameof(cron)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDs.cs index b2b6031b92..348271cde3 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDs.cs @@ -36,12 +36,12 @@ public AddedToCartObjectIDs() { } /// /// Initializes a new instance of the AddedToCartObjectIDs class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). /// eventSubtype (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public AddedToCartObjectIDs(string eventName, ConversionEvent? eventType, AddToCartEvent? eventSubtype, string index, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDsAfterSearch.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDsAfterSearch.cs index ff679b676f..e9870d9bde 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDsAfterSearch.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/AddedToCartObjectIDsAfterSearch.cs @@ -36,13 +36,13 @@ public AddedToCartObjectIDsAfterSearch() { } /// /// Initializes a new instance of the AddedToCartObjectIDsAfterSearch class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). /// eventSubtype (required). - /// Index name (case-sensitive) to which the event's items belong. (required). - /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). + /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public AddedToCartObjectIDsAfterSearch(string eventName, ConversionEvent? eventType, AddToCartEvent? eventSubtype, string index, string queryID, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedFilters.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedFilters.cs index 18942e6060..9f4681640c 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedFilters.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedFilters.cs @@ -30,11 +30,11 @@ public ClickedFilters() { } /// /// Initializes a new instance of the ClickedFilters class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). - /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Index name (case-sensitive) to which the event's items belong. (required). + /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ClickedFilters(string eventName, ClickEvent? eventType, string index, List filters, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDs.cs index 8cb2645aa5..ef79e9f78e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDs.cs @@ -30,11 +30,11 @@ public ClickedObjectIDs() { } /// /// Initializes a new instance of the ClickedObjectIDs class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ClickedObjectIDs(string eventName, ClickEvent? eventType, string index, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDsAfterSearch.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDsAfterSearch.cs index 845ce468c8..644e63d6d7 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDsAfterSearch.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ClickedObjectIDsAfterSearch.cs @@ -30,13 +30,13 @@ public ClickedObjectIDsAfterSearch() { } /// /// Initializes a new instance of the ClickedObjectIDsAfterSearch class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Position of the clicked item the search results. You must provide 1 `position` for each `objectID`. (required). - /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Position of the clicked item the search results. You must provide 1 `position` for each `objectID`. (required). + /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ClickedObjectIDsAfterSearch(string eventName, ClickEvent? eventType, string index, List objectIDs, List positions, string queryID, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedFilters.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedFilters.cs index 71240d8869..8f4884fc5d 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedFilters.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedFilters.cs @@ -30,11 +30,11 @@ public ConvertedFilters() { } /// /// Initializes a new instance of the ConvertedFilters class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). - /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Index name (case-sensitive) to which the event's items belong. (required). + /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ConvertedFilters(string eventName, ConversionEvent? eventType, string index, List filters, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDs.cs index 079cb8e5f2..b12a1132a7 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDs.cs @@ -30,11 +30,11 @@ public ConvertedObjectIDs() { } /// /// Initializes a new instance of the ConvertedObjectIDs class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ConvertedObjectIDs(string eventName, ConversionEvent? eventType, string index, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDsAfterSearch.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDsAfterSearch.cs index b2b6963615..8c13952d0a 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDsAfterSearch.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ConvertedObjectIDsAfterSearch.cs @@ -30,12 +30,12 @@ public ConvertedObjectIDsAfterSearch() { } /// /// Initializes a new instance of the ConvertedObjectIDsAfterSearch class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Unique identifier for a search query. The query ID is required for events related to search or browse requests. If you add `clickAnalytics: true` as a search request parameter, the query ID is included in the API response. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ConvertedObjectIDsAfterSearch(string eventName, ConversionEvent? eventType, string index, List objectIDs, string queryID, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDs.cs index 157f682dde..d256e1c65e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDs.cs @@ -36,12 +36,12 @@ public PurchasedObjectIDs() { } /// /// Initializes a new instance of the PurchasedObjectIDs class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). /// eventSubtype (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public PurchasedObjectIDs(string eventName, ConversionEvent? eventType, PurchaseEvent? eventSubtype, string index, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDsAfterSearch.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDsAfterSearch.cs index adab384f21..d30afd12a6 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDsAfterSearch.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/PurchasedObjectIDsAfterSearch.cs @@ -36,13 +36,13 @@ public PurchasedObjectIDsAfterSearch() { } /// /// Initializes a new instance of the PurchasedObjectIDsAfterSearch class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). /// eventSubtype (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). - /// Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Extra information about the records involved in a purchase or add-to-cart events. If provided, it must be the same length as `objectIDs`. (required). public PurchasedObjectIDsAfterSearch(string eventName, ConversionEvent? eventType, PurchaseEvent? eventSubtype, string index, List objectIDs, string userToken, List objectData) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedFilters.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedFilters.cs index e8a6b2c2b7..ea413d0ce9 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedFilters.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedFilters.cs @@ -30,11 +30,11 @@ public ViewedFilters() { } /// /// Initializes a new instance of the ViewedFilters class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). - /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Index name (case-sensitive) to which the event's items belong. (required). + /// Applied facet filters. Facet filters are `facet:value` pairs. Facet values must be URL-encoded, such as, `discount:10%25`. (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ViewedFilters(string eventName, ViewEvent? eventType, string index, List filters, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedObjectIDs.cs index 1368b8a3a9..944a25d01b 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Insights/ViewedObjectIDs.cs @@ -30,11 +30,11 @@ public ViewedObjectIDs() { } /// /// Initializes a new instance of the ViewedObjectIDs class. /// - /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). + /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) framework. (required). /// eventType (required). - /// Index name (case-sensitive) to which the event's items belong. (required). + /// Index name (case-sensitive) to which the event's items belong. (required). /// Object IDs of the records that are part of the event. (required). - /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). + /// Anonymous or pseudonymous user identifier. Don't use personally identifiable information in user tokens. For more information, see [User token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). public ViewedObjectIDs(string eventName, ViewEvent? eventType, string index, List objectIDs, string userToken) { EventName = eventName ?? throw new ArgumentNullException(nameof(eventName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Personalization/DeleteUserProfileResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Personalization/DeleteUserProfileResponse.cs index ff61aaea3d..de64ba9979 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Personalization/DeleteUserProfileResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Personalization/DeleteUserProfileResponse.cs @@ -25,7 +25,7 @@ public DeleteUserProfileResponse() { } /// Initializes a new instance of the DeleteUserProfileResponse class. /// /// Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/). (required). - /// Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile. (required). + /// Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile. (required). public DeleteUserProfileResponse(string userToken, string deletedUntil) { UserToken = userToken ?? throw new ArgumentNullException(nameof(userToken)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/DeletedAtResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/DeletedAtResponse.cs index 5bb5075e8f..7bfa91dd7d 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/DeletedAtResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/DeletedAtResponse.cs @@ -24,7 +24,7 @@ public DeletedAtResponse() { } /// /// Initializes a new instance of the DeletedAtResponse class. /// - /// 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). + /// 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). /// Date and time when the object was deleted, in RFC 3339 format. (required). public DeletedAtResponse(long taskID, string deletedAt) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendUpdatedAtResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendUpdatedAtResponse.cs index 50f14860be..d2fdfa9e45 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendUpdatedAtResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/RecommendUpdatedAtResponse.cs @@ -24,7 +24,7 @@ public RecommendUpdatedAtResponse() { } /// /// Initializes a new instance of the RecommendUpdatedAtResponse class. /// - /// 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). + /// 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). /// Date and time when the object was updated, in RFC 3339 format. (required). public RecommendUpdatedAtResponse(long taskID, string updatedAt) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs index 8ab88483c5..01c94c3d4e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Recommend/TrendingFacetHit.cs @@ -24,8 +24,8 @@ public TrendingFacetHit() { } /// /// Initializes a new instance of the TrendingFacetHit class. /// - /// Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned. (required). - /// Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned. (required). + /// Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned. (required). + /// Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned. (required). public TrendingFacetHit(string facetName, string facetValue) { FacetName = facetName ?? throw new ArgumentNullException(nameof(facetName)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ApiKey.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ApiKey.cs index 3449fd8bfa..d56e718b68 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ApiKey.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ApiKey.cs @@ -24,7 +24,7 @@ public ApiKey() { } /// /// Initializes a new instance of the ApiKey class. /// - /// Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). (required). + /// Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). (required). public ApiKey(List acl) { Acl = acl ?? throw new ArgumentNullException(nameof(acl)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/AutomaticFacetFilter.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/AutomaticFacetFilter.cs index c9656db165..5b8fa87718 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/AutomaticFacetFilter.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/AutomaticFacetFilter.cs @@ -24,7 +24,7 @@ public AutomaticFacetFilter() { } /// /// Initializes a new instance of the AutomaticFacetFilter class. /// - /// Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`. (required). + /// Facet name to be applied as filter. The name must match placeholders in the `pattern` parameter. For example, with `pattern: {facet:genre}`, `automaticFacetFilters` must be `genre`. (required). public AutomaticFacetFilter(string facet) { Facet = facet ?? throw new ArgumentNullException(nameof(facet)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchRequest.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchRequest.cs index 70d6f4c261..c02bb56099 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchRequest.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchRequest.cs @@ -31,7 +31,7 @@ public BatchRequest() { } /// Initializes a new instance of the BatchRequest class. /// /// action (required). - /// Operation arguments (varies with specified `action`). (required). + /// Operation arguments (varies with specified `action`). (required). public BatchRequest(Action? action, object body) { Action = action; diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchResponse.cs index aaf48d031b..c6672b467e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BatchResponse.cs @@ -24,7 +24,7 @@ public BatchResponse() { } /// /// Initializes a new instance of the BatchResponse class. /// - /// 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). + /// 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). /// Unique record identifiers. (required). public BatchResponse(long taskID, List objectIDs) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BrowseResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BrowseResponse.cs index 8df25bd1ae..cbf00ac7de 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BrowseResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/BrowseResponse.cs @@ -26,7 +26,7 @@ public BrowseResponse() { } /// /// Time the server took to process the request, in milliseconds. (required). /// Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting. (required). - /// Search query. (required) (default to ""). + /// Search query. (required) (default to ""). /// URL-encoded string of all search parameters. (required). public BrowseResponse(int processingTimeMS, List hits, string query, string varParams) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/DeletedAtResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/DeletedAtResponse.cs index e9216d2a01..97f5a77ddc 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/DeletedAtResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/DeletedAtResponse.cs @@ -24,7 +24,7 @@ public DeletedAtResponse() { } /// /// Initializes a new instance of the DeletedAtResponse class. /// - /// 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). + /// 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). /// Date and time when the object was deleted, in RFC 3339 format. (required). public DeletedAtResponse(long taskID, string deletedAt) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/GetApiKeyResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/GetApiKeyResponse.cs index 1fc5f59ff0..2d93c04fef 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/GetApiKeyResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/GetApiKeyResponse.cs @@ -25,7 +25,7 @@ public GetApiKeyResponse() { } /// Initializes a new instance of the GetApiKeyResponse class. /// /// Timestamp when the object was created, in milliseconds since the Unix epoch. (required). - /// Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). (required). + /// Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see [access control list](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). (required). public GetApiKeyResponse(long createdAt, List acl) { CreatedAt = createdAt; diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Log.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Log.cs index 67e27ec6ef..970eb28132 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Log.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/Log.cs @@ -34,7 +34,7 @@ public Log() { } /// Request headers (API keys are obfuscated). (required). /// SHA1 signature of the log entry. (required). /// Number of API requests. (required). - /// Processing time for the query in milliseconds. This doesn't include latency due to the network. (required). + /// Processing time for the query in milliseconds. This doesn't include latency due to the network. (required). public Log(string timestamp, string method, string answerCode, string queryBody, string answer, string url, string ip, string queryHeaders, string sha1, string nbApiCalls, string processingTimeMs) { Timestamp = timestamp ?? throw new ArgumentNullException(nameof(timestamp)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/PromoteObjectIDs.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/PromoteObjectIDs.cs index 1107b4ac1a..ffef4f1e33 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/PromoteObjectIDs.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/PromoteObjectIDs.cs @@ -24,7 +24,7 @@ public PromoteObjectIDs() { } /// /// Initializes a new instance of the PromoteObjectIDs class. /// - /// Object IDs of the records you want to promote. The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results. (required). + /// Object IDs of the records you want to promote. The records are placed as a group at the `position`. For example, if you want to promote four records to position `0`, they will be the first four search results. (required). /// Position in the search results where you want to show the promoted records. (required). public PromoteObjectIDs(List objectIDs, int position) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ReplaceAllObjectsResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ReplaceAllObjectsResponse.cs index 0030039a19..25c823dcf4 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ReplaceAllObjectsResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/ReplaceAllObjectsResponse.cs @@ -25,7 +25,7 @@ public ReplaceAllObjectsResponse() { } /// Initializes a new instance of the ReplaceAllObjectsResponse class. /// /// copyOperationResponse (required). - /// The response of the `batch` request(s). (required). + /// The response of the `batch` request(s). (required). /// moveOperationResponse (required). public ReplaceAllObjectsResponse(UpdatedAtResponse copyOperationResponse, List batchResponses, UpdatedAtResponse moveOperationResponse) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveObjectResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveObjectResponse.cs index 3db5cf0485..772842a337 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveObjectResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveObjectResponse.cs @@ -25,7 +25,7 @@ public SaveObjectResponse() { } /// Initializes a new instance of the SaveObjectResponse class. /// /// Date and time when the object was created, in RFC 3339 format. (required). - /// 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). + /// 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). public SaveObjectResponse(string createdAt, long taskID) { CreatedAt = createdAt ?? throw new ArgumentNullException(nameof(createdAt)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveSynonymResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveSynonymResponse.cs index 94275f6137..87eebce6e2 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveSynonymResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SaveSynonymResponse.cs @@ -24,7 +24,7 @@ public SaveSynonymResponse() { } /// /// Initializes a new instance of the SaveSynonymResponse class. /// - /// 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). + /// 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). /// Date and time when the object was updated, in RFC 3339 format. (required). /// Unique identifier of a synonym object. (required). public SaveSynonymResponse(long taskID, string updatedAt, string id) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesParams.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesParams.cs index f4a85e2be1..1229d88239 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesParams.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesParams.cs @@ -30,7 +30,7 @@ public SearchDictionaryEntriesParams() { } /// /// Initializes a new instance of the SearchDictionaryEntriesParams class. /// - /// Search query. (required) (default to ""). + /// Search query. (required) (default to ""). public SearchDictionaryEntriesParams(string query) { Query = query ?? throw new ArgumentNullException(nameof(query)); diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs index 7b8a99443a..c1992bfc4e 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchDictionaryEntriesResponse.cs @@ -25,7 +25,7 @@ public SearchDictionaryEntriesResponse() { } /// Initializes a new instance of the SearchDictionaryEntriesResponse class. /// /// Dictionary entries matching the search criteria. (required). - /// Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. (required). + /// Requested page of the API response. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. (required). /// Number of results (hits). (required). /// Number of pages of results. (required). public SearchDictionaryEntriesResponse(List hits, int page, int nbHits, int nbPages) diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchResponse.cs index e0a2079df0..6e5d0470d4 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchResponse.cs @@ -29,7 +29,7 @@ public SearchResponse() /// /// Time the server took to process the request, in milliseconds. (required). /// Search results (hits). Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting. (required). - /// Search query. (required) (default to ""). + /// Search query. (required) (default to ""). /// URL-encoded string of all search parameters. (required). public SearchResponse(int processingTimeMS, List hits, string query, string varParams) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs index f6afc7f4f8..972581758a 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/SearchUserIdsResponse.cs @@ -27,7 +27,7 @@ public SearchUserIdsResponse() { } /// User objects that match the query. (required). /// Number of results (hits). (required). /// Page of search results to retrieve. (required) (default to 0). - /// Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. (required) (default to 20). + /// Maximum number of hits per page. Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)). - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on. For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2. (required) (default to 20). /// Date and time when the object was updated, in RFC 3339 format. (required). public SearchUserIdsResponse(List hits, int nbHits, int page, int hitsPerPage, string updatedAt) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedAtResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedAtResponse.cs index 248ee6488d..a458f576d5 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedAtResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedAtResponse.cs @@ -24,7 +24,7 @@ public UpdatedAtResponse() { } /// /// Initializes a new instance of the UpdatedAtResponse class. /// - /// 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). + /// 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). /// Date and time when the object was updated, in RFC 3339 format. (required). public UpdatedAtResponse(long taskID, string updatedAt) { diff --git a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedRuleResponse.cs b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedRuleResponse.cs index 530c9f6e26..0db02c1c1c 100644 --- a/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedRuleResponse.cs +++ b/clients/algoliasearch-client-csharp/algoliasearch/Models/Search/UpdatedRuleResponse.cs @@ -26,7 +26,7 @@ public UpdatedRuleResponse() { } /// /// Unique identifier of a rule object. (required). /// Date and time when the object was updated, in RFC 3339 format. (required). - /// 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). + /// 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). public UpdatedRuleResponse(string objectID, string updatedAt, long taskID) { ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID)); diff --git a/clients/algoliasearch-client-php/lib/Model/Abtesting/Status.php b/clients/algoliasearch-client-php/lib/Model/Abtesting/Status.php index 0e56a974a3..7bfae17c20 100644 --- a/clients/algoliasearch-client-php/lib/Model/Abtesting/Status.php +++ b/clients/algoliasearch-client-php/lib/Model/Abtesting/Status.php @@ -9,7 +9,7 @@ * * @category Class * - * @description A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed. + * @description A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed. */ class Status { diff --git a/clients/algoliasearch-client-php/lib/Model/Analytics/Operator.php b/clients/algoliasearch-client-php/lib/Model/Analytics/Operator.php index 6e8a336cca..c70233f1c8 100644 --- a/clients/algoliasearch-client-php/lib/Model/Analytics/Operator.php +++ b/clients/algoliasearch-client-php/lib/Model/Analytics/Operator.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator. + * @description Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the operator. For a numeric filter `count>50`, `>` is the operator. */ class Operator { diff --git a/clients/algoliasearch-client-php/lib/Model/Analytics/OrderBy.php b/clients/algoliasearch-client-php/lib/Model/Analytics/OrderBy.php index 87e81c57c3..0da014fd24 100644 --- a/clients/algoliasearch-client-php/lib/Model/Analytics/OrderBy.php +++ b/clients/algoliasearch-client-php/lib/Model/Analytics/OrderBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. + * @description Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. */ class OrderBy { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/AuthenticationType.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/AuthenticationType.php index 241ba0c8fe..4e0c627e4e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/AuthenticationType.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/AuthenticationType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Type of authentication. This determines the type of credentials required in the `input` object. + * @description Type of authentication. This determines the type of credentials required in the `input` object. */ class AuthenticationType { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/DestinationType.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/DestinationType.php index 554cbeb9c2..ad33c606fa 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/DestinationType.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/DestinationType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API. + * @description Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API. */ class DestinationType { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/OnDemandTriggerType.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/OnDemandTriggerType.php index 175ad983bb..729346fe04 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/OnDemandTriggerType.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/OnDemandTriggerType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task is run manually, with the `/run` endpoint. + * @description Task is run manually, with the `/run` endpoint. */ class OnDemandTriggerType { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/RunReasonCode.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/RunReasonCode.php index ddcef1d684..bffdc1e01a 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/RunReasonCode.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/RunReasonCode.php @@ -9,7 +9,7 @@ * * @category Class * - * @description A code for the task run's outcome. A readable description of the code is included in the `reason` response property. + * @description A code for the task run's outcome. A readable description of the code is included in the `reason` response property. */ class RunReasonCode { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/ShopifyInput.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/ShopifyInput.php index ec0adba013..999363bc0e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/ShopifyInput.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/ShopifyInput.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Represents the required elements of the task input when using a `shopify` source. + * @description Represents the required elements of the task input when using a `shopify` source. */ class ShopifyInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/StreamingInput.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/StreamingInput.php index f0b22409bf..63470f7f64 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/StreamingInput.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/StreamingInput.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed. + * @description Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed. */ class StreamingInput extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskCreateV1.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskCreateV1.php index 4be61cfa93..cb61f7cdc0 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskCreateV1.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskCreateV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. + * @description API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. */ class TaskCreateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskUpdateV1.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskUpdateV1.php index 33f4af08cc..7ec0f1f43b 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskUpdateV1.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskUpdateV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. + * @description API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix. */ class TaskUpdateV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskV1.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskV1.php index dd2e0c983c..c6b5bc461c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskV1.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/TaskV1.php @@ -12,7 +12,7 @@ * * @category Class * - * @description The V1 task object, please use methods and types that don't contain the V1 suffix. + * @description The V1 task object, please use methods and types that don't contain the V1 suffix. */ class TaskV1 extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Ingestion/TriggerType.php b/clients/algoliasearch-client-php/lib/Model/Ingestion/TriggerType.php index dcc8523586..7c939b4e61 100644 --- a/clients/algoliasearch-client-php/lib/Model/Ingestion/TriggerType.php +++ b/clients/algoliasearch-client-php/lib/Model/Ingestion/TriggerType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task after an event is received, such as, a webhook. - `streaming`. Run the task continuously. + * @description Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task after an event is received, such as, a webhook. - `streaming`. Run the task continuously. */ class TriggerType { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDs.php b/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDs.php index 67bb8f87c6..7f3a6bc5f2 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDs.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event. + * @description Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related to Algolia requests, use the \"Added to cart object IDs after search\" event. */ class AddedToCartObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php b/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php index 9feede99be..b1eb17c35d 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/AddedToCartObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. */ class AddedToCartObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDs.php b/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDs.php index 2d401e566e..cd09282482 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDs.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event. + * @description Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use the \"Clicked object IDs after search\" event. */ class ClickedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDsAfterSearch.php b/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDsAfterSearch.php index 2a93ea4da4..1cbe2c017c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDsAfterSearch.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/ClickedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event. + * @description Click event after an Algolia request. Use this event to track when users click items in the search results. If you're building your category pages with Algolia, you'll also use this event. */ class ClickedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDs.php b/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDs.php index db717a2b33..d73d21a576 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDs.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event. + * @description Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia requests, use the \"Converted object IDs after search\" event. */ class ConvertedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php b/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php index 365ba7e7e8..92af986d02 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/ConvertedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If you're building your category pages with Algolia, you'll also use this event. */ class ConvertedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/Discount.php b/clients/algoliasearch-client-php/lib/Model/Insights/Discount.php index e550af0b69..e01bfc337d 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/Discount.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/Discount.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Absolute value of the discount for this product, in units of `currency`. + * @description Absolute value of the discount for this product, in units of `currency`. */ class Discount extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/Price.php b/clients/algoliasearch-client-php/lib/Model/Insights/Price.php index 1d7a77258a..7f6d03de65 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/Price.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/Price.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Total price of a product, including any discounts, in units of `currency`. + * @description Total price of a product, including any discounts, in units of `currency`. */ class Price extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDs.php b/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDs.php index d9591118b8..ea6ef409c5 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDs.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDs.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event. + * @description Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia requests, use the \"Purchased object IDs after search\" event. */ class PurchasedObjectIDs extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php b/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php index fdf3ee13b9..d994a206f8 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/PurchasedObjectIDsAfterSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. + * @description Use this event to track when users make a purchase after a previous Algolia request. If you're building your category pages with Algolia, you'll also use this event. */ class PurchasedObjectIDsAfterSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Insights/Value.php b/clients/algoliasearch-client-php/lib/Model/Insights/Value.php index cbd417438f..d0e32da02e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Insights/Value.php +++ b/clients/algoliasearch-client-php/lib/Model/Insights/Value.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Total monetary value of this event in units of `currency`. + * @description Total monetary value of this event in units of `currency`. */ class Value extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/QuerySuggestions/LogLevel.php b/clients/algoliasearch-client-php/lib/Model/QuerySuggestions/LogLevel.php index ab60fe36a1..1af5b4c911 100644 --- a/clients/algoliasearch-client-php/lib/Model/QuerySuggestions/LogLevel.php +++ b/clients/algoliasearch-client-php/lib/Model/QuerySuggestions/LogLevel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error. + * @description Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The Query Suggestions process encountered an error. */ class LogLevel { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadius.php b/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadius.php index 92fd146b80..72935cacca 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadius.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadius.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. + * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. */ class AroundRadius extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadiusAll.php b/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadiusAll.php index 9d7e7194d4..5d713460c6 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadiusAll.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/AroundRadiusAll.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. + * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. */ class AroundRadiusAll { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/Distinct.php b/clients/algoliasearch-client-php/lib/Model/Recommend/Distinct.php index 7dc7061012..c574cf6bc6 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/Distinct.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/Distinct.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. + * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. */ class Distinct extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/ExactOnSingleWordQuery.php b/clients/algoliasearch-client-php/lib/Model/Recommend/ExactOnSingleWordQuery.php index 1a67b9fc45..aa2c05d65f 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/ExactOnSingleWordQuery.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/ExactOnSingleWordQuery.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. + * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. */ class ExactOnSingleWordQuery { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/FacetFilters.php b/clients/algoliasearch-client-php/lib/Model/Recommend/FacetFilters.php index c1ae722482..ad27e66b39 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/FacetFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/FacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. + * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. */ class FacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/FbtModel.php b/clients/algoliasearch-client-php/lib/Model/Recommend/FbtModel.php index 7893f77a13..c6b7910c2e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/FbtModel.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/FbtModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID `objectID`. + * @description Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID `objectID`. */ class FbtModel { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/LookingSimilarModel.php b/clients/algoliasearch-client-php/lib/Model/Recommend/LookingSimilarModel.php index 7292387c92..1679db2b88 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/LookingSimilarModel.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/LookingSimilarModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index. + * @description Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index. */ class LookingSimilarModel { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/NumericFilters.php b/clients/algoliasearch-client-php/lib/Model/Recommend/NumericFilters.php index d25a211eec..1c22a4e5f4 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/NumericFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/NumericFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. + * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. */ class NumericFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/OptionalFilters.php b/clients/algoliasearch-client-php/lib/Model/Recommend/OptionalFilters.php index d69b876293..67e1d3714d 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/OptionalFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/OptionalFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. + * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. */ class OptionalFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/QueryType.php b/clients/algoliasearch-client-php/lib/Model/Recommend/QueryType.php index e76c68e7a9..674fe67713 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/QueryType.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/QueryType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). + * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). */ class QueryType { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/Recommend/RankingInfo.php index a534d988d3..54afcf2a8d 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/RankingInfo.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Object with detailed information about the record's ranking. + * @description Object with detailed information about the record's ranking. */ class RankingInfo extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/RecommendedForYouModel.php b/clients/algoliasearch-client-php/lib/Model/Recommend/RecommendedForYouModel.php index 05030e5b9e..fd131fbcc2 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/RecommendedForYouModel.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/RecommendedForYouModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description \"Recommened for you\" model. + * @description \"Recommened for you\" model. */ class RecommendedForYouModel { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/RelatedModel.php b/clients/algoliasearch-client-php/lib/Model/Recommend/RelatedModel.php index b0cf9e6270..c130399e62 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/RelatedModel.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/RelatedModel.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes. + * @description Related products or similar content model. This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes. */ class RelatedModel { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveStopWords.php b/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveStopWords.php index aa4236e578..110d4ef77c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveStopWords.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveStopWords.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. + * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. */ class RemoveStopWords extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveWordsIfNoResults.php b/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveWordsIfNoResults.php index 6bc82a73df..b7110b86b4 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveWordsIfNoResults.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/RemoveWordsIfNoResults.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). + * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). */ class RemoveWordsIfNoResults { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/SortRemainingBy.php b/clients/algoliasearch-client-php/lib/Model/Recommend/SortRemainingBy.php index 56674ec4ca..f0a6c942f9 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/SortRemainingBy.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/SortRemainingBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. + * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. */ class SortRemainingBy { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/TagFilters.php b/clients/algoliasearch-client-php/lib/Model/Recommend/TagFilters.php index 491e751868..3875584320 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/TagFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/TagFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. + * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. */ class TagFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/TaskStatus.php b/clients/algoliasearch-client-php/lib/Model/Recommend/TaskStatus.php index 2983ae3c91..6a03132c2f 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/TaskStatus.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/TaskStatus.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task status, `published` if the task is completed, `notPublished` otherwise. + * @description Task status, `published` if the task is completed, `notPublished` otherwise. */ class TaskStatus { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/TypoTolerance.php b/clients/algoliasearch-client-php/lib/Model/Recommend/TypoTolerance.php index 9616409ba7..24cecfa99f 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/TypoTolerance.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/TypoTolerance.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. + * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. */ class TypoTolerance extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Recommend/TypoToleranceEnum.php b/clients/algoliasearch-client-php/lib/Model/Recommend/TypoToleranceEnum.php index 4477eb6e53..41e4d49bb5 100644 --- a/clients/algoliasearch-client-php/lib/Model/Recommend/TypoToleranceEnum.php +++ b/clients/algoliasearch-client-php/lib/Model/Recommend/TypoToleranceEnum.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. + * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. */ class TypoToleranceEnum { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/Anchoring.php b/clients/algoliasearch-client-php/lib/Model/Search/Anchoring.php index c86c900602..d367cce1b7 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/Anchoring.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/Anchoring.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. + * @description Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns with `anchoring: is`. */ class Anchoring { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/AroundRadius.php b/clients/algoliasearch-client-php/lib/Model/Search/AroundRadius.php index 299de4f543..1e32c05b9e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/AroundRadius.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/AroundRadius.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. + * @description Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of hits around the central location. The search radius is small if there are many hits close to the central coordinates. */ class AroundRadius extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/AroundRadiusAll.php b/clients/algoliasearch-client-php/lib/Model/Search/AroundRadiusAll.php index 318fe0db82..c95350e5e2 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/AroundRadiusAll.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/AroundRadiusAll.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. + * @description Return all records with a valid `_geoloc` attribute. Don't filter by distance. */ class AroundRadiusAll { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/AutomaticFacetFilters.php b/clients/algoliasearch-client-php/lib/Model/Search/AutomaticFacetFilters.php index 07e235f2a1..7677ec70a1 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/AutomaticFacetFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/AutomaticFacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies. + * @description Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the results to show the top-ranked comedy movies. */ class AutomaticFacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/ConsequenceQuery.php b/clients/algoliasearch-client-php/lib/Model/Search/ConsequenceQuery.php index 37a58b41e5..624b1da8a1 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/ConsequenceQuery.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/ConsequenceQuery.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query. + * @description Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query. */ class ConsequenceQuery extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/DictionaryLanguage.php b/clients/algoliasearch-client-php/lib/Model/Search/DictionaryLanguage.php index 51b32408a5..b461ca1163 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/DictionaryLanguage.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/DictionaryLanguage.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Dictionary type. If `null`, this dictionary type isn't supported for the language. + * @description Dictionary type. If `null`, this dictionary type isn't supported for the language. */ class DictionaryLanguage extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/Distinct.php b/clients/algoliasearch-client-php/lib/Model/Search/Distinct.php index a89c99243d..3220717a26 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/Distinct.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/Distinct.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. + * @description Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set. */ class Distinct extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/ExactOnSingleWordQuery.php b/clients/algoliasearch-client-php/lib/Model/Search/ExactOnSingleWordQuery.php index 0c7a38ff28..1e334153c0 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/ExactOnSingleWordQuery.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/ExactOnSingleWordQuery.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. + * @description Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won't. */ class ExactOnSingleWordQuery { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/FacetFilters.php b/clients/algoliasearch-client-php/lib/Model/Search/FacetFilters.php index d6eef00fb0..8b6c046914 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/FacetFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/FacetFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. + * @description Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. */ class FacetFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/NumericFilters.php b/clients/algoliasearch-client-php/lib/Model/Search/NumericFilters.php index 4aa982801c..9c86f216bb 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/NumericFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/NumericFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. + * @description Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`. */ class NumericFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/OptionalFilters.php b/clients/algoliasearch-client-php/lib/Model/Search/OptionalFilters.php index c77212197e..db4908850a 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/OptionalFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/OptionalFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. + * @description Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don't work with numeric attributes. */ class OptionalFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/QueryType.php b/clients/algoliasearch-client-php/lib/Model/Search/QueryType.php index 15e14f4919..1a9924e9c4 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/QueryType.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/QueryType.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). + * @description Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). */ class QueryType { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/RankingInfo.php b/clients/algoliasearch-client-php/lib/Model/Search/RankingInfo.php index 89fd9512ff..bfadf432a8 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/RankingInfo.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/RankingInfo.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Object with detailed information about the record's ranking. + * @description Object with detailed information about the record's ranking. */ class RankingInfo extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/RemoveStopWords.php b/clients/algoliasearch-client-php/lib/Model/Search/RemoveStopWords.php index 274b4d0a42..7d2318ac3f 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/RemoveStopWords.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/RemoveStopWords.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. + * @description Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You should only use this feature for the languages used in your index. */ class RemoveStopWords extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/RemoveWordsIfNoResults.php b/clients/algoliasearch-client-php/lib/Model/Search/RemoveWordsIfNoResults.php index c7390c40ff..edd11a2f96 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/RemoveWordsIfNoResults.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/RemoveWordsIfNoResults.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). + * @description Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). */ class RemoveWordsIfNoResults { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchParamsObject.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchParamsObject.php index 756a45df95..c599e20214 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchParamsObject.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchParamsObject.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Each parameter value, including the `query` must not be larger than 512 bytes. + * @description Each parameter value, including the `query` must not be larger than 512 bytes. */ class SearchParamsObject extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchStrategy.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchStrategy.php index 19333c7f89..61f990e49b 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchStrategy.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchStrategy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. + * @description Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. */ class SearchStrategy { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeDefault.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeDefault.php index d03ae54958..da7100982d 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeDefault.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeDefault.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). */ class SearchTypeDefault { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeFacet.php b/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeFacet.php index 944627c526..72b23ad14a 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeFacet.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SearchTypeFacet.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). + * @description - `default`: perform a search query - `facet` [searches for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). */ class SearchTypeFacet { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SemanticSearch.php b/clients/algoliasearch-client-php/lib/Model/Search/SemanticSearch.php index 4339ee1b89..59c8f70fb7 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SemanticSearch.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SemanticSearch.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. + * @description Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. */ class SemanticSearch extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/SortRemainingBy.php b/clients/algoliasearch-client-php/lib/Model/Search/SortRemainingBy.php index 00bdeb5fa6..5d51e550f1 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/SortRemainingBy.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/SortRemainingBy.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. + * @description Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining facet values by decreasing count. The count is the number of matching records containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly positioned. */ class SortRemainingBy { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/TagFilters.php b/clients/algoliasearch-client-php/lib/Model/Search/TagFilters.php index 0f840fd03d..857288c725 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/TagFilters.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/TagFilters.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. + * @description Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet count. The same combination and escaping rules apply as for `facetFilters`. */ class TagFilters extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/TaskStatus.php b/clients/algoliasearch-client-php/lib/Model/Search/TaskStatus.php index 3bd916c129..3edcbaf26c 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/TaskStatus.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/TaskStatus.php @@ -9,7 +9,7 @@ * * @category Class * - * @description Task status, `published` if the task is completed, `notPublished` otherwise. + * @description Task status, `published` if the task is completed, `notPublished` otherwise. */ class TaskStatus { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/TypoTolerance.php b/clients/algoliasearch-client-php/lib/Model/Search/TypoTolerance.php index 5b6430acc9..1f41e1fa1e 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/TypoTolerance.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/TypoTolerance.php @@ -12,7 +12,7 @@ * * @category Class * - * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. + * @description Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active. */ class TypoTolerance extends AbstractModel implements ModelInterface, \ArrayAccess, \JsonSerializable { diff --git a/clients/algoliasearch-client-php/lib/Model/Search/TypoToleranceEnum.php b/clients/algoliasearch-client-php/lib/Model/Search/TypoToleranceEnum.php index 99c8ad4e05..aa05374aa9 100644 --- a/clients/algoliasearch-client-php/lib/Model/Search/TypoToleranceEnum.php +++ b/clients/algoliasearch-client-php/lib/Model/Search/TypoToleranceEnum.php @@ -9,7 +9,7 @@ * * @category Class * - * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. + * @description - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting. */ class TypoToleranceEnum { diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/abtesting_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/abtesting_client.rb index ae38b2b1a5..5869a67270 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/abtesting_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/abtesting_client.rb @@ -101,7 +101,7 @@ def add_ab_tests(add_ab_tests_request, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -133,7 +133,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -144,7 +144,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -176,7 +176,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -187,7 +187,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -220,7 +220,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -232,7 +232,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -265,7 +265,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -462,7 +462,7 @@ def schedule_ab_test(schedule_ab_tests_request, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Abtesting::ScheduleABTestResponse") end - # Stops an A/B test by its ID. You can't restart stopped A/B tests. + # Stops an A/B test by its ID. You can't restart stopped A/B tests. # # Required API Key ACLs: # - editSettings diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb index 2d28fd075e..0bf089997d 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/analytics_client.rb @@ -57,7 +57,7 @@ def add_user_agent_segment(segment, version = nil) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -89,7 +89,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -100,7 +100,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -132,7 +132,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -143,7 +143,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -176,7 +176,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -188,7 +188,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -221,7 +221,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -236,9 +236,9 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -275,9 +275,9 @@ def get_add_to_cart_rate_with_http_info(index, start_date = nil, end_date = nil, # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetAddToCartRateResponse] def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -288,14 +288,14 @@ def get_add_to_cart_rate(index, start_date = nil, end_date = nil, tags = nil, re ) end - # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked search results' positions. For example, if users only ever click on the first result for any search, the average click position is 1. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_average_click_position_with_http_info( @@ -338,9 +338,9 @@ def get_average_click_position_with_http_info( # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetAverageClickPositionResponse] def get_average_click_position(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -356,9 +356,9 @@ def get_average_click_position(index, start_date = nil, end_date = nil, tags = n # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -395,9 +395,9 @@ def get_click_positions_with_http_info(index, start_date = nil, end_date = nil, # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetClickPositionsResponse] def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -413,9 +413,9 @@ def get_click_positions(index, start_date = nil, end_date = nil, tags = nil, req # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_click_through_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -452,9 +452,9 @@ def get_click_through_rate_with_http_info(index, start_date = nil, end_date = ni # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetClickThroughRateResponse] def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -470,9 +470,9 @@ def get_click_through_rate(index, start_date = nil, end_date = nil, tags = nil, # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -509,9 +509,9 @@ def get_conversion_rate_with_http_info(index, start_date = nil, end_date = nil, # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetConversionRateResponse] def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -522,14 +522,14 @@ def get_conversion_rate(index, start_date = nil, end_date = nil, tags = nil, req ) end - # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't lead to any click within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -566,9 +566,9 @@ def get_no_click_rate_with_http_info(index, start_date = nil, end_date = nil, ta # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetNoClickRateResponse] def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -576,14 +576,14 @@ def get_no_click_rate(index, start_date = nil, end_date = nil, tags = nil, reque @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetNoClickRateResponse") end - # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the fraction of searches that didn't return any results within a time range, including a daily breakdown. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -620,9 +620,9 @@ def get_no_results_rate_with_http_info(index, start_date = nil, end_date = nil, # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetNoResultsRateResponse] def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -638,9 +638,9 @@ def get_no_results_rate(index, start_date = nil, end_date = nil, tags = nil, req # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -677,9 +677,9 @@ def get_purchase_rate_with_http_info(index, start_date = nil, end_date = nil, ta # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetPurchaseRateResponse] def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -695,9 +695,9 @@ def get_purchase_rate(index, start_date = nil, end_date = nil, tags = nil, reque # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -734,9 +734,9 @@ def get_revenue_with_http_info(index, start_date = nil, end_date = nil, tags = n # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetRevenue] def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -749,9 +749,9 @@ def get_revenue(index, start_date = nil, end_date = nil, tags = nil, request_opt # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_searches_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -788,9 +788,9 @@ def get_searches_count_with_http_info(index, start_date = nil, end_date = nil, t # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetSearchesCountResponse] def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -801,16 +801,16 @@ def get_searches_count(index, start_date = nil, end_date = nil, tags = nil, requ ) end - # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. + # Retrieves the most popular searches that didn't lead to any clicks, from the 1,000 most frequent searches. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_searches_no_clicks_with_http_info( @@ -857,11 +857,11 @@ def get_searches_no_clicks_with_http_info( # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetSearchesNoClicksResponse] def get_searches_no_clicks( @@ -888,16 +888,16 @@ def get_searches_no_clicks( ) end - # Retrieves the most popular searches that didn't return any results. + # Retrieves the most popular searches that didn't return any results. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_searches_no_results_with_http_info( @@ -944,11 +944,11 @@ def get_searches_no_results_with_http_info( # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetSearchesNoResultsResponse] def get_searches_no_results( @@ -1025,11 +1025,11 @@ def get_status(index, request_options = {}) # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_countries_with_http_info( @@ -1076,11 +1076,11 @@ def get_top_countries_with_http_info( # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopCountriesResponse] def get_top_countries( @@ -1099,17 +1099,17 @@ def get_top_countries( ) end - # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_filter_attributes_with_http_info( @@ -1159,11 +1159,11 @@ def get_top_filter_attributes_with_http_info( # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopFilterAttributesResponse] def get_top_filter_attributes( @@ -1192,18 +1192,18 @@ def get_top_filter_attributes( ) end - # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. + # Retrieves the most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attributesForFaceting` setting. # # Required API Key ACLs: # - analytics # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_filter_for_attribute_with_http_info( @@ -1259,11 +1259,11 @@ def get_top_filter_for_attribute_with_http_info( # @param attribute [String] Attribute name. (required) # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopFilterForAttributeResponse] def get_top_filter_for_attribute( @@ -1294,17 +1294,17 @@ def get_top_filter_for_attribute( ) end - # Retrieves the most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. + # Retrieves the most frequently used filters for a search that didn't return any results. To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_filters_no_results_with_http_info( @@ -1354,11 +1354,11 @@ def get_top_filters_no_results_with_http_info( # - analytics # @param index [String] Index name. (required) # @param search [String] Search query. - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopFiltersNoResultsResponse] def get_top_filters_no_results( @@ -1395,11 +1395,11 @@ def get_top_filters_no_results( # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_hits_with_http_info( @@ -1455,11 +1455,11 @@ def get_top_hits_with_http_info( # @param search [String] Search query. # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopHitsResponse] def get_top_hits( @@ -1496,13 +1496,13 @@ def get_top_hits( # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_top_searches_with_http_info( @@ -1559,13 +1559,13 @@ def get_top_searches_with_http_info( # @param index [String] Index name. (required) # @param click_analytics [Boolean] Whether to include metrics related to click and conversion events in the response. (default to false) # @param revenue_analytics [Boolean] Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response. (default to false) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param order_by [OrderBy] Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available. (default to 'searchCount') # @param direction [Direction] Sorting direction of the results: ascending or descending. (default to 'asc') - # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) - # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param limit [Integer] Number of items to return. Combined with the `offset` parameter, only the first 1000 items can be retrieved. (default to 10) + # @param offset [Integer] Position of the first item to return. Combined with the `limit` parameter, only the first 1000 items can be retrieved. (default to 0) + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetTopSearchesResponse] def get_top_searches( @@ -1597,14 +1597,14 @@ def get_top_searches( @api_client.deserialize(response.body, request_options[:debug_return_type] || "Analytics::GetTopSearchesResponse") end - # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. + # Retrieves the number of unique users within a time range, including a daily breakdown. Since this endpoint returns the number of unique users, the sum of the daily values might be different from the total number. By default, Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header. By default, the analyzed period includes the last eight days including the current day. # # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) @@ -1641,9 +1641,9 @@ def get_users_count_with_http_info(index, start_date = nil, end_date = nil, tags # Required API Key ACLs: # - analytics # @param index [String] Index name. (required) - # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. - # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. - # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). + # @param start_date [String] Start date of the period to analyze, in `YYYY-MM-DD` format. + # @param end_date [String] End date of the period to analyze, in `YYYY-MM-DD` format. + # @param tags [String] Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/). # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [GetUsersCountResponse] def get_users_count(index, start_date = nil, end_date = nil, tags = nil, request_options = {}) diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/ingestion_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/ingestion_client.rb index 3ecf035b64..e6fd2a026b 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/ingestion_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/ingestion_client.rb @@ -245,7 +245,7 @@ def create_task(task_create, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskCreateResponse") end - # Creates a new task using the v1 endpoint, please use `createTask` instead. + # Creates a new task using the v1 endpoint, please use `createTask` instead. # @param task_create [TaskCreateV1] Request body for creating a task. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -330,7 +330,7 @@ def create_transformation(transformation_create, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -362,7 +362,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -373,7 +373,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -405,7 +405,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -416,7 +416,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -449,7 +449,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -461,7 +461,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -494,7 +494,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -504,7 +504,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object") end - # Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination. + # Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination. # # Required API Key ACLs: # - addObject @@ -555,7 +555,7 @@ def delete_authentication(authentication_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::DeleteResponse") end - # Deletes a destination by its ID. You can't delete destinations that are referenced in tasks. + # Deletes a destination by its ID. You can't delete destinations that are referenced in tasks. # # Required API Key ACLs: # - addObject @@ -606,7 +606,7 @@ def delete_destination(destination_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::DeleteResponse") end - # Deletes a source by its ID. You can't delete sources that are referenced in tasks. + # Deletes a source by its ID. You can't delete sources that are referenced in tasks. # # Required API Key ACLs: # - addObject @@ -694,7 +694,7 @@ def delete_task(task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::DeleteResponse") end - # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead. + # Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead. # @param task_id [String] Unique identifier of a task. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -825,7 +825,7 @@ def disable_task(task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse") end - # Disables a task using the v1 endpoint, please use `disableTask` instead. + # Disables a task using the v1 endpoint, please use `disableTask` instead. # # Required API Key ACLs: # - addObject @@ -921,7 +921,7 @@ def enable_task(task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse") end - # Enables a task using the v1 endpoint, please use `enableTask` instead. + # Enables a task using the v1 endpoint, please use `enableTask` instead. # # Required API Key ACLs: # - addObject @@ -1272,7 +1272,7 @@ def get_task(task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::Task") end - # Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead. + # Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead. # # Required API Key ACLs: # - addObject @@ -1759,7 +1759,7 @@ def list_runs( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param type [Array] Source type. Some sources require authentication. - # @param authentication_id [Array] Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. + # @param authentication_id [Array] Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. # @param sort [SourceSortKeys] Property by which to sort the list of sources. (default to 'createdAt') # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc') # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1810,7 +1810,7 @@ def list_sources_with_http_info( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param type [Array] Source type. Some sources require authentication. - # @param authentication_id [Array] Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. + # @param authentication_id [Array] Authentication IDs of the sources to retrieve. 'none' returns sources that doesn't have an authentication. # @param sort [SourceSortKeys] Property by which to sort the list of sources. (default to 'createdAt') # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc') # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1845,7 +1845,7 @@ def list_sources( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param action [Array] Actions for filtering the list of tasks. - # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. + # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. # @param source_id [Array] Source IDs for filtering the list of tasks. # @param destination_id [Array] Destination IDs for filtering the list of tasks. # @param trigger_type [Array] Type of task trigger for filtering the list of tasks. @@ -1905,7 +1905,7 @@ def list_tasks_with_http_info( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param action [Array] Actions for filtering the list of tasks. - # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. + # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. # @param source_id [Array] Source IDs for filtering the list of tasks. # @param destination_id [Array] Destination IDs for filtering the list of tasks. # @param trigger_type [Array] Type of task trigger for filtering the list of tasks. @@ -1940,7 +1940,7 @@ def list_tasks( @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::ListTasksResponse") end - # Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead. + # Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead. # # Required API Key ACLs: # - addObject @@ -1949,7 +1949,7 @@ def list_tasks( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param action [Array] Actions for filtering the list of tasks. - # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. + # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. # @param source_id [Array] Source IDs for filtering the list of tasks. # @param destination_id [Array] Destination IDs for filtering the list of tasks. # @param trigger_type [Array] Type of task trigger for filtering the list of tasks. @@ -2009,7 +2009,7 @@ def list_tasks_v1_with_http_info( # @param items_per_page [Integer] Number of items per page. (default to 10) # @param page [Integer] Page number of the paginated API response. # @param action [Array] Actions for filtering the list of tasks. - # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. + # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status. # @param source_id [Array] Source IDs for filtering the list of tasks. # @param destination_id [Array] Destination IDs for filtering the list of tasks. # @param trigger_type [Array] Type of task trigger for filtering the list of tasks. @@ -2106,14 +2106,14 @@ def list_transformations(items_per_page = nil, page = nil, sort = nil, order = n ) end - # Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints. + # Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints. # # Required API Key ACLs: # - addObject # - deleteIndex # - editSettings # @param task_id [String] Unique identifier of a task. (required) - # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) + # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def push_task_with_http_info(task_id, push_task_payload, request_options = {}) @@ -2152,7 +2152,7 @@ def push_task_with_http_info(task_id, push_task_payload, request_options = {}) # - deleteIndex # - editSettings # @param task_id [String] Unique identifier of a task. (required) - # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) + # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [RunResponse] def push_task(task_id, push_task_payload, request_options = {}) @@ -2258,7 +2258,7 @@ def run_task(task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse") end - # Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints. + # Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints. # # Required API Key ACLs: # - addObject @@ -2498,7 +2498,7 @@ def search_tasks(task_search, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array") end - # Searches for tasks using the v1 endpoint, please use `searchTasks` instead. + # Searches for tasks using the v1 endpoint, please use `searchTasks` instead. # # Required API Key ACLs: # - addObject @@ -2594,7 +2594,7 @@ def search_transformations(transformation_search, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array") end - # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`. + # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`. # # Required API Key ACLs: # - addObject @@ -2979,7 +2979,7 @@ def update_task(task_id, task_update, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse") end - # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead. + # Updates a task by its ID using the v1 endpoint, please use `updateTask` instead. # @param task_id [String] Unique identifier of a task. (required) # @param task_update [TaskUpdateV1] (required) diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb index 3aa3286a41..07cdbbc341 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/insights_client.rb @@ -57,7 +57,7 @@ def add_user_agent_segment(segment, version = nil) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -89,7 +89,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -100,7 +100,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -132,7 +132,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -143,7 +143,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -176,7 +176,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -188,7 +188,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -221,7 +221,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -231,7 +231,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object") end - # Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API. + # Deletes all events related to the specified user token from events metrics and analytics. The deletion is asynchronous, and processed within 48 hours. To delete a personalization user profile, see `Delete a user profile` in the Personalization API. # @param user_token [String] User token for which to delete all associated events. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -271,7 +271,7 @@ def delete_user_token(user_token, request_options = {}) nil end - # Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbsp;MB. + # Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2 MB. # @param insights_events [InsightsEvents] (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/monitoring_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/monitoring_client.rb index 20b0517ffe..0f48d87bc8 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/monitoring_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/monitoring_client.rb @@ -42,7 +42,7 @@ def add_user_agent_segment(segment, version = nil) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -74,7 +74,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -85,7 +85,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -117,7 +117,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -128,7 +128,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -161,7 +161,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -173,7 +173,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -206,7 +206,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -409,10 +409,10 @@ def get_latency(clusters, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Monitoring::LatencyResponse") end - # Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key). + # Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key). - # @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required) - # @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required) + # @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required) + # @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_metrics_with_http_info(metric, period, request_options = {}) @@ -448,8 +448,8 @@ def get_metrics_with_http_info(metric, period, request_options = {}) # Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key). - # @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required) - # @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required) + # @param metric [Metric] Metric to report. For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`. (required) + # @param period [Period] Period over which to aggregate the metrics: - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [InfrastructureResponse] def get_metrics(metric, period, request_options = {}) @@ -500,7 +500,7 @@ def get_reachability(clusters, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Hash") end - # Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters. + # Retrieves the servers that belong to clusters. The response depends on whether you authenticate your API request: - With authentication, the response lists the servers assigned to your Algolia application's cluster. - Without authentication, the response lists the servers for all Algolia clusters. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/personalization_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/personalization_client.rb index e71ff025d9..862763aada 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/personalization_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/personalization_client.rb @@ -57,7 +57,7 @@ def add_user_agent_segment(segment, version = nil) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -89,7 +89,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -100,7 +100,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -132,7 +132,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -143,7 +143,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -176,7 +176,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -188,7 +188,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -221,7 +221,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/query_suggestions_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/query_suggestions_client.rb index c5caba0557..ee8da8a11d 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/query_suggestions_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/query_suggestions_client.rb @@ -101,7 +101,7 @@ def create_config(configuration_with_index, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -133,7 +133,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -144,7 +144,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -176,7 +176,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -187,7 +187,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -220,7 +220,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -232,7 +232,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -265,7 +265,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -275,7 +275,7 @@ def custom_put(path, parameters = nil, body = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Object") end - # Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation. + # Deletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query Suggestions index itself, use the Search API and the `Delete an index` operation. # # Required API Key ACLs: # - editSettings diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/recommend_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/recommend_client.rb index ce7a414513..c3259c178f 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/recommend_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/recommend_client.rb @@ -48,7 +48,7 @@ def add_user_agent_segment(segment, version = nil) self end - # Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead). + # Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead). # # Required API Key ACLs: # - editSettings @@ -107,7 +107,7 @@ def batch_recommend_rules(index_name, model, recommend_rule = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -139,7 +139,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -150,7 +150,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -182,7 +182,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -193,7 +193,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -226,7 +226,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -238,7 +238,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -271,7 +271,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb b/clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb index e0452a19eb..5a4603e02d 100644 --- a/clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb +++ b/clients/algoliasearch-client-ruby/lib/algolia/api/search_client.rb @@ -95,7 +95,7 @@ def add_api_key(api_key, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse") end - # If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). + # If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). # # Required API Key ACLs: # - addObject @@ -252,7 +252,7 @@ def assign_user_id(x_algolia_user_id, assign_user_id_params, request_options = { @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::CreatedAtResponse") end - # Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. + # Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name. # @param index_name [String] Name of the index on which to perform the operation. (required) # @param batch_write_params [BatchWriteParams] (required) @@ -298,7 +298,7 @@ def batch(index_name, batch_write_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::BatchResponse") end - # Assigns multiple user IDs to a cluster. **You can't move users with this operation**. + # Assigns multiple user IDs to a cluster. **You can't move users with this operation**. # # Required API Key ACLs: # - admin @@ -412,7 +412,7 @@ def batch_dictionary_entries(dictionary_name, batch_dictionary_entries_params, r @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse") end - # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they'll be ignored. + # Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance. Browse requests automatically apply these settings: - `advancedSyntax`: `false` - `attributesToHighlight`: `[]` - `attributesToSnippet`: `[]` - `distinct`: `false` - `enablePersonalization`: `false` - `enableRules`: `false` - `facets`: `[]` - `getRankingInfo`: `false` - `ignorePlurals`: `false` - `optionalFilters`: `[]` - `typoTolerance`: `true` or `false` (`min` and `strict` evaluate to `true`) If you send these parameters with your browse requests, they'll be ignored. # # Required API Key ACLs: # - browse @@ -598,7 +598,7 @@ def clear_synonyms(index_name, forward_to_replicas = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -630,7 +630,7 @@ def custom_delete_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -641,7 +641,7 @@ def custom_delete(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -673,7 +673,7 @@ def custom_get_with_http_info(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] @@ -684,7 +684,7 @@ def custom_get(path, parameters = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -717,7 +717,7 @@ def custom_post_with_http_info(path, parameters = nil, body = nil, request_optio # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -729,7 +729,7 @@ def custom_post(path, parameters = nil, body = nil, request_options = {}) # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -762,7 +762,7 @@ def custom_put_with_http_info(path, parameters = nil, body = nil, request_option # This method allow you to send requests to the Algolia REST API. - # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) + # @param path [String] Path of the endpoint, anything after \"/1\" must be specified. (required) # @param parameters [Hash] Query parameters to apply to the current query. # @param body [Object] Parameters to send with the custom request. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -816,7 +816,7 @@ def delete_api_key(key, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteApiKeyResponse") end - # This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch). + # This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](#tag/Records/operation/batch). # # Required API Key ACLs: # - deleteIndex @@ -866,7 +866,7 @@ def delete_by(index_name, delete_by_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse") end - # Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). + # Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/). # # Required API Key ACLs: # - deleteIndex @@ -910,7 +910,7 @@ def delete_index(index_name, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse") end - # Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy). + # Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy). # # Required API Key ACLs: # - deleteObject @@ -963,7 +963,7 @@ def delete_object(index_name, object_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse") end - # Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules). + # Deletes a rule by its ID. To find the object ID for rules, use the [`search` operation](#tag/Rules/operation/searchRules). # # Required API Key ACLs: # - editSettings @@ -1062,7 +1062,7 @@ def delete_source(source, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeleteSourceResponse") end - # Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + # Deletes a synonym by its ID. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). # # Required API Key ACLs: # - editSettings @@ -1117,7 +1117,7 @@ def delete_synonym(index_name, object_id, forward_to_replicas = nil, request_opt @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::DeletedAtResponse") end - # Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by `<redacted>`. + # Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key, with the description replaced by ``. # @param key [String] API key. (required) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -1278,7 +1278,7 @@ def get_dictionary_settings(request_options = {}) ) end - # The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. + # The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. # # Required API Key ACLs: # - logs @@ -1327,13 +1327,13 @@ def get_logs(offset = nil, length = nil, index_name = nil, type = nil, request_o @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetLogsResponse") end - # Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). + # Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects). # # Required API Key ACLs: # - search # @param index_name [String] Name of the index on which to perform the operation. (required) # @param object_id [String] Unique record identifier. (required) - # @param attributes_to_retrieve [Array] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. + # @param attributes_to_retrieve [Array] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = nil, request_options = {}) @@ -1378,7 +1378,7 @@ def get_object_with_http_info(index_name, object_id, attributes_to_retrieve = ni # - search # @param index_name [String] Name of the index on which to perform the operation. (required) # @param object_id [String] Unique record identifier. (required) - # @param attributes_to_retrieve [Array] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. + # @param attributes_to_retrieve [Array] Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Object] def get_object(index_name, object_id, attributes_to_retrieve = nil, request_options = {}) @@ -1430,7 +1430,7 @@ def get_objects(get_objects_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetObjectsResponse") end - # Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). + # Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules). # # Required API Key ACLs: # - settings @@ -1563,7 +1563,7 @@ def get_sources(request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array") end - # Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). + # Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms). # # Required API Key ACLs: # - settings @@ -1615,7 +1615,7 @@ def get_synonym(index_name, object_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SynonymHit") end - # Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status. + # Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status. # # Required API Key ACLs: # - addObject @@ -1667,7 +1667,7 @@ def get_task(index_name, task_id, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetTaskResponse") end - # Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. + # Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. # # Required API Key ACLs: # - admin @@ -1704,7 +1704,7 @@ def get_top_user_ids(request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::GetTopUserIdsResponse") end - # Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. + # Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. # # Required API Key ACLs: # - admin @@ -1752,7 +1752,7 @@ def get_user_id(user_id, request_options = {}) # # Required API Key ACLs: # - admin - # @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response. + # @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def has_pending_mappings_with_http_info(get_clusters = nil, request_options = {}) @@ -1780,7 +1780,7 @@ def has_pending_mappings_with_http_info(get_clusters = nil, request_options = {} # # Required API Key ACLs: # - admin - # @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response. + # @param get_clusters [Boolean] Whether to include the cluster's pending mapping state in the response. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [HasPendingMappingsResponse] def has_pending_mappings(get_clusters = nil, request_options = {}) @@ -1869,7 +1869,7 @@ def list_clusters(request_options = {}) # # Required API Key ACLs: # - listIndexes - # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. + # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. # @param hits_per_page [Integer] Number of hits per page. (default to 100) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -1899,7 +1899,7 @@ def list_indices_with_http_info(page = nil, hits_per_page = nil, request_options # # Required API Key ACLs: # - listIndexes - # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. + # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. # @param hits_per_page [Integer] Number of hits per page. (default to 100) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [ListIndicesResponse] @@ -1908,11 +1908,11 @@ def list_indices(page = nil, hits_per_page = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ListIndicesResponse") end - # Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. + # Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. # # Required API Key ACLs: # - admin - # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. + # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. # @param hits_per_page [Integer] Number of hits per page. (default to 100) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -1942,7 +1942,7 @@ def list_user_ids_with_http_info(page = nil, hits_per_page = nil, request_option # # Required API Key ACLs: # - admin - # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. + # @param page [Integer] Requested page of the API response. If `null`, the API response is not paginated. # @param hits_per_page [Integer] Number of hits per page. (default to 100) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [ListUserIdsResponse] @@ -1991,7 +1991,7 @@ def multiple_batch(batch_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::MultipleBatchResponse") end - # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/). + # Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for their analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keeps its original name, and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/). # # Required API Key ACLs: # - addObject @@ -2041,14 +2041,14 @@ def operation_index(index_name, operation_index_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse") end - # Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. + # Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor. To update an attribute without pushing the entire record, you can use these built-in operations. These operations can be helpful if you don't have access to your initial data. - Increment: increment a numeric attribute - Decrement: decrement a numeric attribute - Add: append a number or string element to an array attribute - Remove: remove all matching number or string elements from an array attribute made of numbers or strings - AddUnique: add a number or string element to an array attribute made of numbers or strings only if it's not already present - IncrementFrom: increment a numeric integer attribute only if the provided value matches the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementFrom value of 2 for the version attribute, but the current value of the attribute is 1, the engine ignores the update. If the object doesn't exist, the engine only creates it if you pass an IncrementFrom value of 0. - IncrementSet: increment a numeric integer attribute only if the provided value is greater than the current value, and otherwise ignore the whole object update. For example, if you pass an IncrementSet value of 2 for the version attribute, and the current value of the attribute is 1, the engine updates the object. If the object doesn't exist yet, the engine only creates it if you pass an IncrementSet value greater than 0. You can specify an operation by providing an object with the attribute to update as the key and its value being an object with the following properties: - _operation: the operation to apply on the attribute - value: the right-hand side argument to the operation, for example, increment or decrement step, value to add or remove. # # Required API Key ACLs: # - addObject # @param index_name [String] Name of the index on which to perform the operation. (required) # @param object_id [String] Unique record identifier. (required) # @param attributes_to_update [Object] Attributes with their values. (required) - # @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true) + # @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def partial_update_object_with_http_info( @@ -2100,7 +2100,7 @@ def partial_update_object_with_http_info( # @param index_name [String] Name of the index on which to perform the operation. (required) # @param object_id [String] Unique record identifier. (required) # @param attributes_to_update [Object] Attributes with their values. (required) - # @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true) + # @param create_if_not_exists [Boolean] Whether to create a new record if it doesn't exist. (default to true) # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [UpdatedAtWithObjectIdResponse] def partial_update_object( @@ -2211,7 +2211,7 @@ def replace_sources(source, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::ReplaceSourceResponse") end - # Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored. + # Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored. # # Required API Key ACLs: # - admin @@ -2255,7 +2255,7 @@ def restore_api_key(key, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::AddApiKeyResponse") end - # Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). + # Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch). # # Required API Key ACLs: # - addObject @@ -2305,7 +2305,7 @@ def save_object(index_name, body, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveObjectResponse") end - # If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). + # If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules). # # Required API Key ACLs: # - editSettings @@ -2366,7 +2366,7 @@ def save_rule(index_name, object_id, rule, forward_to_replicas = nil, request_op @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedRuleResponse") end - # Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. + # Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced. # # Required API Key ACLs: # - editSettings @@ -2434,7 +2434,7 @@ def save_rules(index_name, rules, forward_to_replicas = nil, clear_existing_rule @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse") end - # If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). + # If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms). # # Required API Key ACLs: # - editSettings @@ -2495,7 +2495,7 @@ def save_synonym(index_name, object_id, synonym_hit, forward_to_replicas = nil, @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SaveSynonymResponse") end - # If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. + # If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced. # # Required API Key ACLs: # - editSettings @@ -2680,12 +2680,12 @@ def search_dictionary_entries(dictionary_name, search_dictionary_entries_params, ) end - # Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**. + # Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**. # # Required API Key ACLs: # - search # @param index_name [String] Name of the index on which to perform the operation. (required) - # @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required) + # @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required) # @param search_for_facet_values_request [SearchForFacetValuesRequest] # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response @@ -2730,7 +2730,7 @@ def search_for_facet_values_with_http_info( # Required API Key ACLs: # - search # @param index_name [String] Name of the index on which to perform the operation. (required) - # @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required) + # @param facet_name [String] Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required) # @param search_for_facet_values_request [SearchForFacetValuesRequest] # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [SearchForFacetValuesResponse] @@ -2793,7 +2793,7 @@ def search_rules(index_name, search_rules_params = nil, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchRulesResponse") end - # Searches a single index and returns matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. + # Searches a single index and returns matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting. # # Required API Key ACLs: # - search @@ -2844,7 +2844,7 @@ def search_single_index(index_name, search_params = nil, request_options = {}) # Required API Key ACLs: # - settings # @param index_name [String] Name of the index on which to perform the operation. (required) - # @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation. + # @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [Http::Response] the response def search_synonyms_with_http_info(index_name, search_synonyms_params = nil, request_options = {}) @@ -2880,7 +2880,7 @@ def search_synonyms_with_http_info(index_name, search_synonyms_params = nil, req # Required API Key ACLs: # - settings # @param index_name [String] Name of the index on which to perform the operation. (required) - # @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation. + # @param search_synonyms_params [SearchSynonymsParams] Body of the `searchSynonyms` operation. # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) # @return [SearchSynonymsResponse] def search_synonyms(index_name, search_synonyms_params = nil, request_options = {}) @@ -2888,7 +2888,7 @@ def search_synonyms(index_name, search_synonyms_params = nil, request_options = @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::SearchSynonymsResponse") end - # Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). + # Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours). # # Required API Key ACLs: # - admin @@ -2979,7 +2979,7 @@ def set_dictionary_settings(dictionary_settings_params, request_options = {}) @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdatedAtResponse") end - # Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index. + # Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index. # # Required API Key ACLs: # - editSettings diff --git a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/analytics/Operator.scala b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/analytics/Operator.scala index 5537b346b9..6f63e8090c 100644 --- a/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/analytics/Operator.scala +++ b/clients/algoliasearch-client-scala/src/main/scala/algoliasearch/analytics/Operator.scala @@ -36,22 +36,22 @@ object Operator { override def toString = ":" } case object LessThan extends Operator { - override def toString = "<" + override def toString = "<" } case object LessThanOrEqualTo extends Operator { - override def toString = "<=" + override def toString = "<=" } case object Equal extends Operator { - override def toString = "=" + override def toString = "=" } case object NotEqual extends Operator { - override def toString = "!=" + override def toString = "!=" } case object GreaterThan extends Operator { - override def toString = ">" + override def toString = ">" } case object GreaterThanOrEqualTo extends Operator { - override def toString = ">=" + override def toString = ">=" } val values: Seq[Operator] = Seq(Colon, LessThan, LessThanOrEqualTo, Equal, NotEqual, GreaterThan, GreaterThanOrEqualTo) diff --git a/clients/algoliasearch-client-swift/Sources/Abtesting/Models/AbtestingStatus.swift b/clients/algoliasearch-client-swift/Sources/Abtesting/Models/AbtestingStatus.swift index 04f964e70c..0f5af71933 100644 --- a/clients/algoliasearch-client-swift/Sources/Abtesting/Models/AbtestingStatus.swift +++ b/clients/algoliasearch-client-swift/Sources/Abtesting/Models/AbtestingStatus.swift @@ -6,10 +6,9 @@ import Foundation import Core #endif -/// A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - -/// `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - -/// `expired`. The A/B test was automatically stopped after reaching its end date. - `failed`. -/// Creating the A/B test failed. +/// A/B test status. - `active`. The A/B test is live and search traffic is split between the two variants. - +/// `stopped`. You stopped the A/B test. The A/B test data is still available for analysis. - `expired`. The A/B test +/// was automatically stopped after reaching its end date. - `failed`. Creating the A/B test failed. public enum AbtestingStatus: String, Codable, CaseIterable { case active case stopped diff --git a/clients/algoliasearch-client-swift/Sources/Analytics/Models/Operator.swift b/clients/algoliasearch-client-swift/Sources/Analytics/Models/Operator.swift index 3f8b55f972..ce2721dc60 100644 --- a/clients/algoliasearch-client-swift/Sources/Analytics/Models/Operator.swift +++ b/clients/algoliasearch-client-swift/Sources/Analytics/Models/Operator.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, -/// `:` is the operator. For a numeric filter `count>50`, `>` is the operator. +/// Character that characterizes how the filter is applied. For example, for a facet filter `facet:value`, `:` is the +/// operator. For a numeric filter `count>50`, `>` is the operator. public enum Operator: String, Codable, CaseIterable { case colon = ":" case lessThan = "<" diff --git a/clients/algoliasearch-client-swift/Sources/Analytics/Models/OrderBy.swift b/clients/algoliasearch-client-swift/Sources/Analytics/Models/OrderBy.swift index 709302c009..a7a8a034e8 100644 --- a/clients/algoliasearch-client-swift/Sources/Analytics/Models/OrderBy.swift +++ b/clients/algoliasearch-client-swift/Sources/Analytics/Models/OrderBy.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only -/// `searchCount` is available. +/// Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is +/// available. public enum OrderBy: String, Codable, CaseIterable { case searchCount case clickThroughRate diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/AuthenticationType.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/AuthenticationType.swift index aec621a420..7a014fe81e 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/AuthenticationType.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/AuthenticationType.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Type of authentication. This determines the type of credentials required in the `input` object. +/// Type of authentication. This determines the type of credentials required in the `input` object. public enum AuthenticationType: String, Codable, CaseIterable { case googleServiceAccount case basic diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/DestinationType.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/DestinationType.swift index 47e8a71f30..598b0dcc1f 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/DestinationType.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/DestinationType.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is -/// recorded as user events in the Insights API. +/// Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user +/// events in the Insights API. public enum DestinationType: String, Codable, CaseIterable { case search case insights diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/OnDemandTriggerType.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/OnDemandTriggerType.swift index bc7b806c21..adc8dd32ea 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/OnDemandTriggerType.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/OnDemandTriggerType.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Task is run manually, with the `/run` endpoint. +/// Task is run manually, with the `/run` endpoint. public enum OnDemandTriggerType: String, Codable, CaseIterable { case onDemand } diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/RunReasonCode.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/RunReasonCode.swift index 24e3b3955b..c9d43535f7 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/RunReasonCode.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/RunReasonCode.swift @@ -6,8 +6,7 @@ import Foundation import Core #endif -/// A code for the task run's outcome. A readable description of the code is included in the `reason` -/// response property. +/// A code for the task run's outcome. A readable description of the code is included in the `reason` response property. public enum RunReasonCode: String, Codable, CaseIterable { case `internal` case critical diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/ShopifyInput.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/ShopifyInput.swift index c9197b9471..78e4fcabc1 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/ShopifyInput.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/ShopifyInput.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Represents the required elements of the task input when using a `shopify` source. +/// Represents the required elements of the task input when using a `shopify` source. public struct ShopifyInput: Codable, JSONEncodable { public var metafields: [ShopifyMetafield] public var market: ShopifyMarket diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/StreamingInput.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/StreamingInput.swift index ca13986286..3ed25941fe 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/StreamingInput.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/StreamingInput.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted -/// data is continuously streamed. +/// Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is +/// continuously streamed. public struct StreamingInput: Codable, JSONEncodable { public var mapping: MappingInput diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskCreateV1.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskCreateV1.swift index 016def71e2..c5206ed844 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskCreateV1.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskCreateV1.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 +/// API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 /// suffix. @available(*, deprecated, message: "This schema is deprecated.") public struct TaskCreateV1: Codable, JSONEncodable { diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskUpdateV1.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskUpdateV1.swift index 63fd6ae3fa..5303abd508 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskUpdateV1.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskUpdateV1.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 +/// API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 /// suffix. @available(*, deprecated, message: "This schema is deprecated.") public struct TaskUpdateV1: Codable, JSONEncodable { diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskV1.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskV1.swift index ad5440b43b..837320b79e 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskV1.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TaskV1.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// The V1 task object, please use methods and types that don't contain the V1 suffix. +/// The V1 task object, please use methods and types that don't contain the V1 suffix. @available(*, deprecated, message: "This schema is deprecated.") public struct TaskV1: Codable, JSONEncodable { /// Universally unique identifier (UUID) of a task. diff --git a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TriggerType.swift b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TriggerType.swift index 92cdb52fd3..719333e33b 100644 --- a/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TriggerType.swift +++ b/clients/algoliasearch-client-swift/Sources/Ingestion/Models/TriggerType.swift @@ -6,10 +6,9 @@ import Foundation import Core #endif -/// Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the -/// `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - -/// `subscription`. Trigger the task after an event is received, such as, a webhook. - -/// `streaming`. Run the task continuously. +/// Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` +/// endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task +/// after an event is received, such as, a webhook. - `streaming`. Run the task continuously. public enum TriggerType: String, Codable, CaseIterable { case onDemand case schedule diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDs.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDs.swift index df57337961..672f1ad4ab 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDs.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDs.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Use this event to track when users add items to their shopping cart unrelated to a previous Algolia request. For -/// example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events -/// related to Algolia requests, use the \"Added to cart object IDs after search\" event. +/// example, if you don't use Algolia to build your category pages, use this event. To track add-to-cart events related +/// to Algolia requests, use the \"Added to cart object IDs after search\" event. public struct AddedToCartObjectIDs: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDsAfterSearch.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDsAfterSearch.swift index 4fdac1bb3f..473904cb24 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDsAfterSearch.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/AddedToCartObjectIDsAfterSearch.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're -/// building your category pages with Algolia, you'll also use this event. +/// Use this event to track when users add items to their shopping cart after a previous Algolia request. If you're +/// building your category pages with Algolia, you'll also use this event. public struct AddedToCartObjectIDsAfterSearch: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDs.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDs.swift index 996fd23a2b..3c19071f7f 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDs.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDs.swift @@ -6,9 +6,9 @@ import Foundation import Core #endif -/// Use this event to track when users click items unrelated to a previous Algolia request. For example, if you -/// don't use Algolia to build your category pages, use this event. To track click events related to Algolia -/// requests, use the \"Clicked object IDs after search\" event. +/// Use this event to track when users click items unrelated to a previous Algolia request. For example, if you don't +/// use Algolia to build your category pages, use this event. To track click events related to Algolia requests, use +/// the \"Clicked object IDs after search\" event. public struct ClickedObjectIDs: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDsAfterSearch.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDsAfterSearch.swift index 63b3089fbe..7ff6ecf594 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDsAfterSearch.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/ClickedObjectIDsAfterSearch.swift @@ -7,7 +7,7 @@ import Foundation #endif /// Click event after an Algolia request. Use this event to track when users click items in the search results. If -/// you're building your category pages with Algolia, you'll also use this event. +/// you're building your category pages with Algolia, you'll also use this event. public struct ClickedObjectIDsAfterSearch: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDs.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDs.swift index 53d562de2b..d6b123444d 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDs.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDs.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Use this event to track when users convert on items unrelated to a previous Algolia request. For example, if you -/// don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia -/// requests, use the \"Converted object IDs after search\" event. +/// don't use Algolia to build your category pages, use this event. To track conversion events related to Algolia +/// requests, use the \"Converted object IDs after search\" event. public struct ConvertedObjectIDs: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDsAfterSearch.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDsAfterSearch.swift index 53bde7c22d..0d6ac76b41 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDsAfterSearch.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/ConvertedObjectIDsAfterSearch.swift @@ -8,7 +8,7 @@ import Foundation /// Use this event to track when users convert after a previous Algolia request. For example, a user clicks on an item /// in the search results to view the product detail page. Then, the user adds the item to their shopping cart. If -/// you're building your category pages with Algolia, you'll also use this event. +/// you're building your category pages with Algolia, you'll also use this event. public struct ConvertedObjectIDsAfterSearch: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/Discount.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/Discount.swift index 0770b26f9e..9ede58b41e 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/Discount.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/Discount.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Absolute value of the discount for this product, in units of `currency`. +/// Absolute value of the discount for this product, in units of `currency`. public enum Discount: Codable, JSONEncodable, AbstractEncodable { case double(Double) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift index 81c26d66b3..7e41f9f288 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/InsightsValue.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Total monetary value of this event in units of `currency`. +/// Total monetary value of this event in units of `currency`. public enum InsightsValue: Codable, JSONEncodable, AbstractEncodable { case double(Double) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift index 9d2d952376..74f8478356 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/Price.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Total price of a product, including any discounts, in units of `currency`. +/// Total price of a product, including any discounts, in units of `currency`. public enum Price: Codable, JSONEncodable, AbstractEncodable { case double(Double) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDs.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDs.swift index ab39520595..06dedb9fc6 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDs.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDs.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Use this event to track when users make a purchase unrelated to a previous Algolia request. For example, if you -/// don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia -/// requests, use the \"Purchased object IDs after search\" event. +/// don't use Algolia to build your category pages, use this event. To track purchase events related to Algolia +/// requests, use the \"Purchased object IDs after search\" event. public struct PurchasedObjectIDs: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDsAfterSearch.swift b/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDsAfterSearch.swift index ed216f7106..6a861c7416 100644 --- a/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDsAfterSearch.swift +++ b/clients/algoliasearch-client-swift/Sources/Insights/Models/PurchasedObjectIDsAfterSearch.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Use this event to track when users make a purchase after a previous Algolia request. If you're building your -/// category pages with Algolia, you'll also use this event. +/// Use this event to track when users make a purchase after a previous Algolia request. If you're building your +/// category pages with Algolia, you'll also use this event. public struct PurchasedObjectIDsAfterSearch: Codable, JSONEncodable { /// Event name, up to 64 ASCII characters. Consider naming events consistently—for example, by adopting Segment's [object-action](https://segment.com/academy/collecting-data/naming-conventions-for-clean-data/#the-object-action-framework) /// framework. diff --git a/clients/algoliasearch-client-swift/Sources/QuerySuggestions/Models/ModelLogLevel.swift b/clients/algoliasearch-client-swift/Sources/QuerySuggestions/Models/ModelLogLevel.swift index ead98418af..abd442537b 100644 --- a/clients/algoliasearch-client-swift/Sources/QuerySuggestions/Models/ModelLogLevel.swift +++ b/clients/algoliasearch-client-swift/Sources/QuerySuggestions/Models/ModelLogLevel.swift @@ -6,9 +6,9 @@ import Foundation import Core #endif -/// Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for -/// successful inclusion. For example, when a query doesn't generate enough search results. - `INFO`. An -/// informative log entry. - `ERROR`. The Query Suggestions process encountered an error. +/// Type of log entry. - `SKIP`. A query is skipped because it doesn't match the conditions for successful inclusion. +/// For example, when a query doesn't generate enough search results. - `INFO`. An informative log entry. - `ERROR`. The +/// Query Suggestions process encountered an error. public enum ModelLogLevel: String, Codable, CaseIterable { case skip = "SKIP" case info = "INFO" diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/FbtModel.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/FbtModel.swift index 026e3d5a65..50209c49fc 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/FbtModel.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/FbtModel.swift @@ -7,7 +7,7 @@ import Foundation #endif /// Frequently bought together model. This model recommends items that have been purchased within 1 day with the item -/// with the ID `objectID`. +/// with the ID `objectID`. public enum FbtModel: String, Codable, CaseIterable { case boughtTogether = "bought-together" } diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/LookingSimilarModel.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/LookingSimilarModel.swift index a6ca9f8229..56f0753a65 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/LookingSimilarModel.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/LookingSimilarModel.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Looking similar model. This model recommends items that look similar to the item with the ID `objectID` -/// based on image attributes in your index. +/// Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on +/// image attributes in your index. public enum LookingSimilarModel: String, Codable, CaseIterable { case lookingSimilar = "looking-similar" } diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadius.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadius.swift index 6d58c9eb7f..30f35fc7bf 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadius.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadius.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Maximum radius for a search around a central location. This parameter works in combination with the -/// `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined -/// automatically from the density of hits around the central location. The search radius is small if there are many -/// hits close to the central coordinates. +/// Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` +/// and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of +/// hits around the central location. The search radius is small if there are many hits close to the central +/// coordinates. public enum RecommendAroundRadius: Codable, JSONEncodable, AbstractEncodable { case int(Int) case recommendAroundRadiusAll(RecommendAroundRadiusAll) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadiusAll.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadiusAll.swift index 4392ba9742..9ab0124c3c 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadiusAll.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendAroundRadiusAll.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Return all records with a valid `_geoloc` attribute. Don't filter by distance. +/// Return all records with a valid `_geoloc` attribute. Don't filter by distance. public enum RecommendAroundRadiusAll: String, Codable, CaseIterable { case all } diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendDistinct.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendDistinct.swift index eb90fabd2b..95ee901c56 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendDistinct.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendDistinct.swift @@ -7,9 +7,9 @@ import Foundation #endif /// Determines how many records of a group are included in the search results. Records with the same value for the -/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how -/// many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). -/// The `distinct` setting is ignored if `attributeForDistinct` is not set. +/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the +/// group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). +/// The `distinct` setting is ignored if `attributeForDistinct` is not set. public enum RecommendDistinct: Codable, JSONEncodable, AbstractEncodable { case bool(Bool) case int(Int) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift index 69d982b734..f880643ff6 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift @@ -7,12 +7,12 @@ import Foundation #endif /// Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) -/// is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if -/// the query word and attribute value are the same. For example, a search for \"road\" will match the value -/// \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored -/// on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the -/// attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches -/// will be highlighted, partial and prefix matches won't. +/// is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query +/// word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not +/// \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact +/// ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 +/// characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches +/// won't. public enum RecommendExactOnSingleWordQuery: String, Codable, CaseIterable { case attribute case `none` diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendFacetFilters.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendFacetFilters.swift index 09de97316c..f6236c3d9a 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendFacetFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendFacetFilters.swift @@ -7,11 +7,10 @@ import Foundation #endif /// Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using -/// the `filters` parameter, which supports all filter types and combinations with boolean operators.** - -/// `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], -/// filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is -/// interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a -/// `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. +/// the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, +/// filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR +/// filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes +/// that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. public enum RecommendFacetFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfRecommendFacetFilters([RecommendFacetFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendNumericFilters.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendNumericFilters.swift index f554925805..a358774315 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendNumericFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendNumericFilters.swift @@ -6,12 +6,10 @@ import Foundation import Core #endif -/// Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and -/// combinations with boolean operators.** You can use numeric comparison operators: `<`, -/// `<=`, `=`, `!=`, `>`, `>=`. -/// Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO -/// <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for -/// `facetFilters`. +/// Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations +/// with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons +/// are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower +/// and upper boundaries. The same combination rules apply as for `facetFilters`. public enum RecommendNumericFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfRecommendNumericFilters([RecommendNumericFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendOptionalFilters.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendOptionalFilters.swift index aed06801ac..339bc9c152 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendOptionalFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendOptionalFilters.swift @@ -7,10 +7,10 @@ import Foundation #endif /// Filters to promote or demote records in the search results. Optional filters work like facet filters, but they -/// don't exclude records from the search results. Records that match the optional filter rank before records that -/// don't match. If you're using a negative filter `facet:-value`, matching records rank after records -/// that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ -/// sort-by attributes. - Optional filters don't work with numeric attributes. +/// don't exclude records from the search results. Records that match the optional filter rank before records that don't +/// match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - +/// Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - +/// Optional filters don't work with numeric attributes. public enum RecommendOptionalFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfRecommendOptionalFilters([RecommendOptionalFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendQueryType.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendQueryType.swift index ce093ec76f..493d96c916 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendQueryType.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendQueryType.swift @@ -7,9 +7,9 @@ import Foundation #endif /// Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a -/// prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, -/// which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. -/// For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). +/// prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words +/// as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see +/// [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). public enum RecommendQueryType: String, Codable, CaseIterable { case prefixLast case prefixAll diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRankingInfo.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRankingInfo.swift index 17b3e8a299..7754d3cd63 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRankingInfo.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRankingInfo.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Object with detailed information about the record's ranking. +/// Object with detailed information about the record's ranking. public struct RecommendRankingInfo: Codable, JSONEncodable { /// Whether a filter matched the query. public var filters: Int? diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveStopWords.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveStopWords.swift index d88c8b1569..41ec4a3de5 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveStopWords.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveStopWords.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or -/// pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or -/// \"and\" are stop words. You should only use this feature for the languages used in your index. +/// pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You +/// should only use this feature for the languages used in your index. public enum RecommendRemoveStopWords: Codable, JSONEncodable, AbstractEncodable { case arrayOfRecommendSupportedLanguage([RecommendSupportedLanguage]) case bool(Bool) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveWordsIfNoResults.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveWordsIfNoResults.swift index be85c0f2ec..d6695cc267 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveWordsIfNoResults.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendRemoveWordsIfNoResults.swift @@ -6,12 +6,12 @@ import Foundation import Core #endif -/// Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning -/// empty search results. - `none`. No words are removed when a query doesn't return results. - -/// `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there -/// are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then -/// third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. -/// Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). +/// Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty +/// search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the +/// last (then second to last, then third to last) word as optional, until there are results or at most 5 words have +/// been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are +/// results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more +/// information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). public enum RecommendRemoveWordsIfNoResults: String, Codable, CaseIterable { case `none` case lastWords diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendSortRemainingBy.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendSortRemainingBy.swift index a22b42d71e..c0033cecd0 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendSortRemainingBy.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendSortRemainingBy.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Order of facet values that aren't explicitly positioned with the `order` setting. - -/// `count`. Order remaining facet values by decreasing count. The count is the number of matching records -/// containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. -/// Don't show facet values that aren't explicitly positioned. +/// Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining +/// facet values by decreasing count. The count is the number of matching records containing this facet value. - +/// `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly +/// positioned. public enum RecommendSortRemainingBy: String, Codable, CaseIterable { case count case alpha diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTagFilters.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTagFilters.swift index f165a79c8f..81983151de 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTagFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTagFilters.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` -/// parameter, which supports all filter types and combinations with boolean operators.** Different from regular -/// facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet -/// count. The same combination and escaping rules apply as for `facetFilters`. +/// Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which +/// supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can +/// only be used for filtering (including or excluding records). You won't get a facet count. The same combination and +/// escaping rules apply as for `facetFilters`. public enum RecommendTagFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfRecommendTagFilters([RecommendTagFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTaskStatus.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTaskStatus.swift index 233a5fae82..250244b481 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTaskStatus.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTaskStatus.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Task status, `published` if the task is completed, `notPublished` otherwise. +/// Task status, `published` if the task is completed, `notPublished` otherwise. public enum RecommendTaskStatus: String, Codable, CaseIterable { case published case notPublished diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoTolerance.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoTolerance.swift index 12d0a2440b..b4b276f76e 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoTolerance.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoTolerance.swift @@ -8,7 +8,7 @@ import Foundation /// Whether [typo /// tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled -/// and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) +/// and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) /// are also active. public enum RecommendTypoTolerance: Codable, JSONEncodable, AbstractEncodable { case bool(Bool) diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoToleranceEnum.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoToleranceEnum.swift index c9f8d2baac..dc60d94509 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoToleranceEnum.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendTypoToleranceEnum.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, -/// only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 -/// typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the -/// Typo ranking criterion is applied first in the `ranking` setting. +/// - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only +/// include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - +/// `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is +/// applied first in the `ranking` setting. public enum RecommendTypoToleranceEnum: String, Codable, CaseIterable { case min case strict diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendedForYouModel.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendedForYouModel.swift index 4dab95577d..af7afe8fd4 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendedForYouModel.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RecommendedForYouModel.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// \"Recommened for you\" model. +/// \"Recommened for you\" model. public enum RecommendedForYouModel: String, Codable, CaseIterable { case recommendedForYou = "recommended-for-you" } diff --git a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RelatedModel.swift b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RelatedModel.swift index 4dfb359e39..0a213e3b8d 100644 --- a/clients/algoliasearch-client-swift/Sources/Recommend/Models/RelatedModel.swift +++ b/clients/algoliasearch-client-swift/Sources/Recommend/Models/RelatedModel.swift @@ -7,7 +7,7 @@ import Foundation #endif /// Related products or similar content model. This model recommends items that are similar to the item with the ID -/// `objectID`. Similarity is determined from the user interactions and attributes. +/// `objectID`. Similarity is determined from the user interactions and attributes. public enum RelatedModel: String, Codable, CaseIterable { case relatedProducts = "related-products" } diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/DictionaryLanguage.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/DictionaryLanguage.swift index 97e1bb9648..a94f198984 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/DictionaryLanguage.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/DictionaryLanguage.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Dictionary type. If `null`, this dictionary type isn't supported for the language. +/// Dictionary type. If `null`, this dictionary type isn't supported for the language. public struct DictionaryLanguage: Codable, JSONEncodable { /// Number of custom dictionary entries. public var nbCustomEntries: Int? diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAnchoring.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAnchoring.swift index c815cfc4ea..01b8a3cf37 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAnchoring.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAnchoring.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Which part of the search query the pattern should match: - `startsWith`. The pattern must match the -/// beginning of the query. - `endsWith`. The pattern must match the end of the query. - `is`. The -/// pattern must match the query exactly. - `contains`. The pattern must match anywhere in the query. Empty -/// queries are only allowed as patterns with `anchoring: is`. +/// Which part of the search query the pattern should match: - `startsWith`. The pattern must match the beginning of +/// the query. - `endsWith`. The pattern must match the end of the query. - `is`. The pattern must match the query +/// exactly. - `contains`. The pattern must match anywhere in the query. Empty queries are only allowed as patterns +/// with `anchoring: is`. public enum SearchAnchoring: String, Codable, CaseIterable { case `is` case startsWith diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadius.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadius.swift index 7ab4a09fc0..6e51f5e697 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadius.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadius.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Maximum radius for a search around a central location. This parameter works in combination with the -/// `aroundLatLng` and `aroundLatLngViaIP` parameters. By default, the search radius is determined -/// automatically from the density of hits around the central location. The search radius is small if there are many -/// hits close to the central coordinates. +/// Maximum radius for a search around a central location. This parameter works in combination with the `aroundLatLng` +/// and `aroundLatLngViaIP` parameters. By default, the search radius is determined automatically from the density of +/// hits around the central location. The search radius is small if there are many hits close to the central +/// coordinates. public enum SearchAroundRadius: Codable, JSONEncodable, AbstractEncodable { case int(Int) case searchAroundRadiusAll(SearchAroundRadiusAll) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadiusAll.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadiusAll.swift index 2c22a1da62..c9afd6e1de 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadiusAll.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAroundRadiusAll.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Return all records with a valid `_geoloc` attribute. Don't filter by distance. +/// Return all records with a valid `_geoloc` attribute. Don't filter by distance. public enum SearchAroundRadiusAll: String, Codable, CaseIterable { case all } diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAutomaticFacetFilters.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAutomaticFacetFilters.swift index 40404586cc..16d0dd7982 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAutomaticFacetFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchAutomaticFacetFilters.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Filter to be applied to the search. You can use this to respond to search queries that match a facet value. For -/// example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you -/// can filter the results to show the top-ranked comedy movies. +/// example, if users search for \"comedy\", which matches a facet value of the \"genre\" facet, you can filter the +/// results to show the top-ranked comedy movies. public enum SearchAutomaticFacetFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchAutomaticFacetFilter([SearchAutomaticFacetFilter]) case arrayOfString([String]) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchConsequenceQuery.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchConsequenceQuery.swift index 7da2fe324c..b200061781 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchConsequenceQuery.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchConsequenceQuery.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced -/// with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query. +/// Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that +/// string. If `consequenceQuery` is an object, it describes incremental edits made to the query. public enum SearchConsequenceQuery: Codable, JSONEncodable, AbstractEncodable { case searchConsequenceQueryObject(SearchConsequenceQueryObject) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDistinct.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDistinct.swift index 7fddd9bf2b..855b492955 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDistinct.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchDistinct.swift @@ -7,9 +7,9 @@ import Foundation #endif /// Determines how many records of a group are included in the search results. Records with the same value for the -/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how -/// many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). -/// The `distinct` setting is ignored if `attributeForDistinct` is not set. +/// `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the +/// group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). +/// The `distinct` setting is ignored if `attributeForDistinct` is not set. public enum SearchDistinct: Codable, JSONEncodable, AbstractEncodable { case bool(Bool) case int(Int) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchExactOnSingleWordQuery.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchExactOnSingleWordQuery.swift index 0785b0289a..7c759caf9f 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchExactOnSingleWordQuery.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchExactOnSingleWordQuery.swift @@ -7,12 +7,12 @@ import Foundation #endif /// Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) -/// is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if -/// the query word and attribute value are the same. For example, a search for \"road\" will match the value -/// \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored -/// on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the -/// attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches -/// will be highlighted, partial and prefix matches won't. +/// is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query +/// word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not +/// \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact +/// ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 +/// characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches +/// won't. public enum SearchExactOnSingleWordQuery: String, Codable, CaseIterable { case attribute case `none` diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchFacetFilters.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchFacetFilters.swift index fe55c3d9f5..4d07979170 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchFacetFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchFacetFilters.swift @@ -7,11 +7,10 @@ import Foundation #endif /// Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using -/// the `filters` parameter, which supports all filter types and combinations with boolean operators.** - -/// `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], -/// filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is -/// interpreted as `NOT facet:value`. While it's best to avoid attributes that start with a -/// `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. +/// the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, +/// filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR +/// filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it's best to avoid attributes +/// that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`. public enum SearchFacetFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchFacetFilters([SearchFacetFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchNumericFilters.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchNumericFilters.swift index 7b3ccb86af..ec4976237e 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchNumericFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchNumericFilters.swift @@ -6,12 +6,10 @@ import Foundation import Core #endif -/// Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and -/// combinations with boolean operators.** You can use numeric comparison operators: `<`, -/// `<=`, `=`, `!=`, `>`, `>=`. -/// Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO -/// <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for -/// `facetFilters`. +/// Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations +/// with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons +/// are precise up to 3 decimals. You can also provide ranges: `facet: TO `. The range includes the lower +/// and upper boundaries. The same combination rules apply as for `facetFilters`. public enum SearchNumericFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchNumericFilters([SearchNumericFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchOptionalFilters.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchOptionalFilters.swift index 9dc12d7d9c..9d52301273 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchOptionalFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchOptionalFilters.swift @@ -7,10 +7,10 @@ import Foundation #endif /// Filters to promote or demote records in the search results. Optional filters work like facet filters, but they -/// don't exclude records from the search results. Records that match the optional filter rank before records that -/// don't match. If you're using a negative filter `facet:-value`, matching records rank after records -/// that don't match. - Optional filters don't work on virtual replicas. - Optional filters are applied _after_ -/// sort-by attributes. - Optional filters don't work with numeric attributes. +/// don't exclude records from the search results. Records that match the optional filter rank before records that don't +/// match. If you're using a negative filter `facet:-value`, matching records rank after records that don't match. - +/// Optional filters don't work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - +/// Optional filters don't work with numeric attributes. public enum SearchOptionalFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchOptionalFilters([SearchOptionalFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchParams.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchParams.swift index 931385830a..14f146f6b7 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchParams.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchParams.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Parameters to apply to this search. You can use all search parameters, plus special -/// `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`. +/// Parameters to apply to this search. You can use all search parameters, plus special `automaticFacetFilters`, +/// `automaticOptionalFacetFilters`, and `query`. public struct SearchParams: Codable, JSONEncodable { public var query: SearchConsequenceQuery? public var automaticFacetFilters: SearchAutomaticFacetFilters? diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchQueryType.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchQueryType.swift index c429204684..b10a69259c 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchQueryType.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchQueryType.swift @@ -7,9 +7,9 @@ import Foundation #endif /// Determines if and how query words are interpreted as prefixes. By default, only the last query word is treated as a -/// prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, -/// which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. -/// For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). +/// prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words +/// as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see +/// [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/). public enum SearchQueryType: String, Codable, CaseIterable { case prefixLast case prefixAll diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRankingInfo.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRankingInfo.swift index 7edae90691..2dd465f2cb 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRankingInfo.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRankingInfo.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Object with detailed information about the record's ranking. +/// Object with detailed information about the record's ranking. public struct SearchRankingInfo: Codable, JSONEncodable { /// Whether a filter matched the query. public var filters: Int? diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveStopWords.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveStopWords.swift index c58d8b3306..5110a2d015 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveStopWords.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveStopWords.swift @@ -7,8 +7,8 @@ import Foundation #endif /// Removes stop words from the search query. Stop words are common words like articles, conjunctions, prepositions, or -/// pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or -/// \"and\" are stop words. You should only use this feature for the languages used in your index. +/// pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words. You +/// should only use this feature for the languages used in your index. public enum SearchRemoveStopWords: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchSupportedLanguage([SearchSupportedLanguage]) case bool(Bool) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveWordsIfNoResults.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveWordsIfNoResults.swift index 3a0e55eabd..8b91f9cf8c 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveWordsIfNoResults.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchRemoveWordsIfNoResults.swift @@ -6,12 +6,12 @@ import Foundation import Core #endif -/// Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning -/// empty search results. - `none`. No words are removed when a query doesn't return results. - -/// `lastWords`. Treat the last (then second to last, then third to last) word as optional, until there -/// are results or at most 5 words have been removed. - `firstWords`. Treat the first (then second, then -/// third) word as optional, until there are results or at most 5 words have been removed. - `allOptional`. -/// Treat all words as optional. For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). +/// Strategy for removing words from the query when it doesn't return any results. This helps to avoid returning empty +/// search results. - `none`. No words are removed when a query doesn't return results. - `lastWords`. Treat the +/// last (then second to last, then third to last) word as optional, until there are results or at most 5 words have +/// been removed. - `firstWords`. Treat the first (then second, then third) word as optional, until there are +/// results or at most 5 words have been removed. - `allOptional`. Treat all words as optional. For more +/// information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/). public enum SearchRemoveWordsIfNoResults: String, Codable, CaseIterable { case `none` case lastWords diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSearchParamsObject.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSearchParamsObject.swift index 7843c0f3ff..2c8fe5c7c3 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSearchParamsObject.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSearchParamsObject.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Each parameter value, including the `query` must not be larger than 512 bytes. +/// Each parameter value, including the `query` must not be larger than 512 bytes. public struct SearchSearchParamsObject: Codable, JSONEncodable { /// Search query. public var query: String? diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSemanticSearch.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSemanticSearch.swift index 366a753e52..ad936809f1 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSemanticSearch.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSemanticSearch.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. +/// Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`. public struct SearchSemanticSearch: Codable, JSONEncodable { /// Indices from which to collect click and conversion events. If null, the current index and all its replicas are /// used. diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSortRemainingBy.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSortRemainingBy.swift index 347586f439..2760d76b58 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSortRemainingBy.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchSortRemainingBy.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Order of facet values that aren't explicitly positioned with the `order` setting. - -/// `count`. Order remaining facet values by decreasing count. The count is the number of matching records -/// containing this facet value. - `alpha`. Sort facet values alphabetically. - `hidden`. -/// Don't show facet values that aren't explicitly positioned. +/// Order of facet values that aren't explicitly positioned with the `order` setting. - `count`. Order remaining +/// facet values by decreasing count. The count is the number of matching records containing this facet value. - +/// `alpha`. Sort facet values alphabetically. - `hidden`. Don't show facet values that aren't explicitly +/// positioned. public enum SearchSortRemainingBy: String, Codable, CaseIterable { case count case alpha diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchStrategy.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchStrategy.swift index 70e771fe39..28b9c81172 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchStrategy.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchStrategy.swift @@ -6,8 +6,8 @@ import Foundation import Core #endif -/// Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run -/// the queries one by one, stopping as soon as a query matches at least the `hitsPerPage` number of results. +/// Strategy for multiple search queries: - `none`. Run all queries. - `stopIfEnoughMatches`. Run the queries one by +/// one, stopping as soon as a query matches at least the `hitsPerPage` number of results. public enum SearchStrategy: String, Codable, CaseIterable { case `none` case stopIfEnoughMatches diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTagFilters.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTagFilters.swift index 3fce4577ee..cdba30623a 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTagFilters.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTagFilters.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` -/// parameter, which supports all filter types and combinations with boolean operators.** Different from regular -/// facets, `_tags` can only be used for filtering (including or excluding records). You won't get a facet -/// count. The same combination and escaping rules apply as for `facetFilters`. +/// Filter the search by values of the special `_tags` attribute. **Prefer using the `filters` parameter, which +/// supports all filter types and combinations with boolean operators.** Different from regular facets, `_tags` can +/// only be used for filtering (including or excluding records). You won't get a facet count. The same combination and +/// escaping rules apply as for `facetFilters`. public enum SearchTagFilters: Codable, JSONEncodable, AbstractEncodable { case arrayOfSearchTagFilters([SearchTagFilters]) case string(String) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTaskStatus.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTaskStatus.swift index ff88193d7b..04e1c82704 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTaskStatus.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTaskStatus.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// Task status, `published` if the task is completed, `notPublished` otherwise. +/// Task status, `published` if the task is completed, `notPublished` otherwise. public enum SearchTaskStatus: String, Codable, CaseIterable { case published case notPublished diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeDefault.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeDefault.swift index 1c6e1994ce..d506ed21ad 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeDefault.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeDefault.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// - `default`: perform a search query - `facet` [searches for facet +/// - `default`: perform a search query - `facet` [searches for facet /// values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). public enum SearchTypeDefault: String, Codable, CaseIterable { case `default` diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeFacet.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeFacet.swift index ed139dffc0..8a04df5980 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeFacet.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypeFacet.swift @@ -6,7 +6,7 @@ import Foundation import Core #endif -/// - `default`: perform a search query - `facet` [searches for facet +/// - `default`: perform a search query - `facet` [searches for facet /// values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values). public enum SearchTypeFacet: String, Codable, CaseIterable { case facet diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoTolerance.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoTolerance.swift index ab519f0261..2cce07b802 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoTolerance.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoTolerance.swift @@ -8,7 +8,7 @@ import Foundation /// Whether [typo /// tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled -/// and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) +/// and how it is applied. If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) /// are also active. public enum SearchTypoTolerance: Codable, JSONEncodable, AbstractEncodable { case bool(Bool) diff --git a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoToleranceEnum.swift b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoToleranceEnum.swift index c3b2f89a0a..4454368a57 100644 --- a/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoToleranceEnum.swift +++ b/clients/algoliasearch-client-swift/Sources/Search/Models/SearchTypoToleranceEnum.swift @@ -6,10 +6,10 @@ import Foundation import Core #endif -/// - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, -/// only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 -/// typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the -/// Typo ranking criterion is applied first in the `ranking` setting. +/// - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only +/// include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - +/// `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is +/// applied first in the `ranking` setting. public enum SearchTypoToleranceEnum: String, Codable, CaseIterable { case min case strict diff --git a/docs/bundled/search-snippets.json b/docs/bundled/search-snippets.json index d1d4ac7236..d4565c750c 100644 --- a/docs/bundled/search-snippets.json +++ b/docs/bundled/search-snippets.json @@ -158,8 +158,8 @@ "default": "var response = await client.PartialUpdateObjectAsync(\n \"\",\n \"uniqueID\",\n new Dictionary { { \"attributeId\", \"new value\" } }\n);" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "var response = await client.PartialUpdateObjectsAsync(\n \"\",\n new List\n {\n new Dictionary { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n new Dictionary { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n },\n true\n);", - "call partialUpdateObjects with createIfNotExists=false": "var response = await client.PartialUpdateObjectsAsync(\n \"\",\n new List\n {\n new Dictionary { { \"objectID\", \"3\" }, { \"name\", \"Cyril\" } },\n new Dictionary { { \"objectID\", \"4\" }, { \"name\", \"David\" } },\n },\n false\n);" + "call partialUpdateObjects with createIfNotExists=true": "var response = await client.PartialUpdateObjectsAsync(\n \"\",\n new List\n {\n new Dictionary { { \"objectID\", \"1\" }, { \"name\", \"Adam\" } },\n new Dictionary { { \"objectID\", \"2\" }, { \"name\", \"Benoit\" } },\n },\n true\n);", + "call partialUpdateObjects with createIfNotExists=false": "var response = await client.PartialUpdateObjectsAsync(\n \"\",\n new List\n {\n new Dictionary { { \"objectID\", \"3\" }, { \"name\", \"Cyril\" } },\n new Dictionary { { \"objectID\", \"4\" }, { \"name\", \"David\" } },\n },\n false\n);" }, "removeUserId": { "default": "var response = await client.RemoveUserIdAsync(\"uniqueID\");" @@ -404,8 +404,8 @@ "default": "final response = await client.partialUpdateObject(\n indexName: \"\",\n objectID: \"uniqueID\",\n attributesToUpdate: {\n 'attributeId': \"new value\",\n },\n);" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "final response = await client.partialUpdateObjects(\n indexName: \"\",\n objects: [\n {\n 'objectID': \"1\",\n 'name': \"Adam\",\n },\n {\n 'objectID': \"2\",\n 'name': \"Benoit\",\n },\n ],\n createIfNotExists: true,\n);", - "call partialUpdateObjects with createIfNotExists=false": "final response = await client.partialUpdateObjects(\n indexName: \"\",\n objects: [\n {\n 'objectID': \"3\",\n 'name': \"Cyril\",\n },\n {\n 'objectID': \"4\",\n 'name': \"David\",\n },\n ],\n createIfNotExists: false,\n);" + "call partialUpdateObjects with createIfNotExists=true": "final response = await client.partialUpdateObjects(\n indexName: \"\",\n objects: [\n {\n 'objectID': \"1\",\n 'name': \"Adam\",\n },\n {\n 'objectID': \"2\",\n 'name': \"Benoit\",\n },\n ],\n createIfNotExists: true,\n);", + "call partialUpdateObjects with createIfNotExists=false": "final response = await client.partialUpdateObjects(\n indexName: \"\",\n objects: [\n {\n 'objectID': \"3\",\n 'name': \"Cyril\",\n },\n {\n 'objectID': \"4\",\n 'name': \"David\",\n },\n ],\n createIfNotExists: false,\n);" }, "removeUserId": { "default": "final response = await client.removeUserId(\n userID: \"uniqueID\",\n);" @@ -650,8 +650,8 @@ "default": "response, err := client.PartialUpdateObject(client.NewApiPartialUpdateObjectRequest(\n \"\", \"uniqueID\", map[string]any{\"attributeId\": \"new value\"},\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "response, err := client.PartialUpdateObjects(\n \"\",\n []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}},\n search.WithCreateIfNotExists(true))\nif err != nil {\n // handle the eventual error\n panic(err)\n}", - "call partialUpdateObjects with createIfNotExists=false": "response, err := client.PartialUpdateObjects(\n \"\",\n []map[string]any{map[string]any{\"objectID\": \"3\", \"name\": \"Cyril\"}, map[string]any{\"objectID\": \"4\", \"name\": \"David\"}},\n search.WithCreateIfNotExists(false))\nif err != nil {\n // handle the eventual error\n panic(err)\n}" + "call partialUpdateObjects with createIfNotExists=true": "response, err := client.PartialUpdateObjects(\n \"\",\n []map[string]any{map[string]any{\"objectID\": \"1\", \"name\": \"Adam\"}, map[string]any{\"objectID\": \"2\", \"name\": \"Benoit\"}},\n search.WithCreateIfNotExists(true))\nif err != nil {\n // handle the eventual error\n panic(err)\n}", + "call partialUpdateObjects with createIfNotExists=false": "response, err := client.PartialUpdateObjects(\n \"\",\n []map[string]any{map[string]any{\"objectID\": \"3\", \"name\": \"Cyril\"}, map[string]any{\"objectID\": \"4\", \"name\": \"David\"}},\n search.WithCreateIfNotExists(false))\nif err != nil {\n // handle the eventual error\n panic(err)\n}" }, "removeUserId": { "default": "response, err := client.RemoveUserId(client.NewApiRemoveUserIdRequest(\n \"uniqueID\",\n))\nif err != nil {\n // handle the eventual error\n panic(err)\n}" @@ -896,8 +896,8 @@ "default": "client.partialUpdateObject(\n \"\",\n \"uniqueID\",\n new HashMap() {\n {\n put(\"attributeId\", \"new value\");\n }\n }\n);" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "client.partialUpdateObjects(\n \"\",\n Arrays.asList(\n new HashMap() {\n {\n put(\"objectID\", \"1\");\n put(\"name\", \"Adam\");\n }\n },\n new HashMap() {\n {\n put(\"objectID\", \"2\");\n put(\"name\", \"Benoit\");\n }\n }\n ),\n true\n);", - "call partialUpdateObjects with createIfNotExists=false": "client.partialUpdateObjects(\n \"\",\n Arrays.asList(\n new HashMap() {\n {\n put(\"objectID\", \"3\");\n put(\"name\", \"Cyril\");\n }\n },\n new HashMap() {\n {\n put(\"objectID\", \"4\");\n put(\"name\", \"David\");\n }\n }\n ),\n false\n);" + "call partialUpdateObjects with createIfNotExists=true": "client.partialUpdateObjects(\n \"\",\n Arrays.asList(\n new HashMap() {\n {\n put(\"objectID\", \"1\");\n put(\"name\", \"Adam\");\n }\n },\n new HashMap() {\n {\n put(\"objectID\", \"2\");\n put(\"name\", \"Benoit\");\n }\n }\n ),\n true\n);", + "call partialUpdateObjects with createIfNotExists=false": "client.partialUpdateObjects(\n \"\",\n Arrays.asList(\n new HashMap() {\n {\n put(\"objectID\", \"3\");\n put(\"name\", \"Cyril\");\n }\n },\n new HashMap() {\n {\n put(\"objectID\", \"4\");\n put(\"name\", \"David\");\n }\n }\n ),\n false\n);" }, "removeUserId": { "default": "client.removeUserId(\"uniqueID\");" @@ -1142,8 +1142,8 @@ "default": "const response = await client.partialUpdateObject({\n indexName: 'theIndexName',\n objectID: 'uniqueID',\n attributesToUpdate: { attributeId: 'new value' },\n});" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "const response = await client.partialUpdateObjects({\n indexName: 'cts_e2e_partialUpdateObjects_javascript',\n objects: [\n { objectID: '1', name: 'Adam' },\n { objectID: '2', name: 'Benoit' },\n ],\n createIfNotExists: true,\n});", - "call partialUpdateObjects with createIfNotExists=false": "const response = await client.partialUpdateObjects({\n indexName: 'cts_e2e_partialUpdateObjects_javascript',\n objects: [\n { objectID: '3', name: 'Cyril' },\n { objectID: '4', name: 'David' },\n ],\n createIfNotExists: false,\n});" + "call partialUpdateObjects with createIfNotExists=true": "const response = await client.partialUpdateObjects({\n indexName: 'cts_e2e_partialUpdateObjects_javascript',\n objects: [\n { objectID: '1', name: 'Adam' },\n { objectID: '2', name: 'Benoit' },\n ],\n createIfNotExists: true,\n});", + "call partialUpdateObjects with createIfNotExists=false": "const response = await client.partialUpdateObjects({\n indexName: 'cts_e2e_partialUpdateObjects_javascript',\n objects: [\n { objectID: '3', name: 'Cyril' },\n { objectID: '4', name: 'David' },\n ],\n createIfNotExists: false,\n});" }, "removeUserId": { "default": "const response = await client.removeUserId({ userID: 'uniqueID' });" @@ -1388,8 +1388,8 @@ "default": "var response = client.partialUpdateObject(\n indexName = \"\",\n objectID = \"uniqueID\",\n attributesToUpdate = buildJsonObject {\n put(\n \"attributeId\",\n JsonPrimitive(\"new value\"),\n )\n },\n)" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "var response = client.partialUpdateObjects(\n indexName = \"\",\n objects = listOf(\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"1\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Adam\"),\n )\n },\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"2\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Benoit\"),\n )\n },\n ),\n createIfNotExists = true,\n)", - "call partialUpdateObjects with createIfNotExists=false": "var response = client.partialUpdateObjects(\n indexName = \"\",\n objects = listOf(\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"3\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Cyril\"),\n )\n },\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"4\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"David\"),\n )\n },\n ),\n createIfNotExists = false,\n)" + "call partialUpdateObjects with createIfNotExists=true": "var response = client.partialUpdateObjects(\n indexName = \"\",\n objects = listOf(\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"1\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Adam\"),\n )\n },\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"2\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Benoit\"),\n )\n },\n ),\n createIfNotExists = true,\n)", + "call partialUpdateObjects with createIfNotExists=false": "var response = client.partialUpdateObjects(\n indexName = \"\",\n objects = listOf(\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"3\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"Cyril\"),\n )\n },\n buildJsonObject {\n put(\n \"objectID\",\n JsonPrimitive(\"4\"),\n )\n put(\n \"name\",\n JsonPrimitive(\"David\"),\n )\n },\n ),\n createIfNotExists = false,\n)" }, "removeUserId": { "default": "var response = client.removeUserId(\n userID = \"uniqueID\",\n)" @@ -1634,8 +1634,8 @@ "default": "$response = $client->partialUpdateObject(\n '',\n 'uniqueID',\n ['attributeId' => 'new value',\n ],\n);" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "$response = $client->partialUpdateObjects(\n '',\n [\n ['objectID' => '1',\n 'name' => 'Adam',\n ],\n\n ['objectID' => '2',\n 'name' => 'Benoit',\n ],\n ],\n true,\n);", - "call partialUpdateObjects with createIfNotExists=false": "$response = $client->partialUpdateObjects(\n '',\n [\n ['objectID' => '3',\n 'name' => 'Cyril',\n ],\n\n ['objectID' => '4',\n 'name' => 'David',\n ],\n ],\n false,\n);" + "call partialUpdateObjects with createIfNotExists=true": "$response = $client->partialUpdateObjects(\n '',\n [\n ['objectID' => '1',\n 'name' => 'Adam',\n ],\n\n ['objectID' => '2',\n 'name' => 'Benoit',\n ],\n ],\n true,\n);", + "call partialUpdateObjects with createIfNotExists=false": "$response = $client->partialUpdateObjects(\n '',\n [\n ['objectID' => '3',\n 'name' => 'Cyril',\n ],\n\n ['objectID' => '4',\n 'name' => 'David',\n ],\n ],\n false,\n);" }, "removeUserId": { "default": "$response = $client->removeUserId(\n 'uniqueID',\n);" @@ -1880,8 +1880,8 @@ "default": "response = client.partial_update_object(\n index_name=\"\",\n object_id=\"uniqueID\",\n attributes_to_update={\n \"attributeId\": \"new value\",\n },\n)" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "response = client.partial_update_objects(\n index_name=\"\",\n objects=[\n {\n \"objectID\": \"1\",\n \"name\": \"Adam\",\n },\n {\n \"objectID\": \"2\",\n \"name\": \"Benoit\",\n },\n ],\n create_if_not_exists=True,\n)", - "call partialUpdateObjects with createIfNotExists=false": "response = client.partial_update_objects(\n index_name=\"\",\n objects=[\n {\n \"objectID\": \"3\",\n \"name\": \"Cyril\",\n },\n {\n \"objectID\": \"4\",\n \"name\": \"David\",\n },\n ],\n create_if_not_exists=False,\n)" + "call partialUpdateObjects with createIfNotExists=true": "response = client.partial_update_objects(\n index_name=\"\",\n objects=[\n {\n \"objectID\": \"1\",\n \"name\": \"Adam\",\n },\n {\n \"objectID\": \"2\",\n \"name\": \"Benoit\",\n },\n ],\n create_if_not_exists=True,\n)", + "call partialUpdateObjects with createIfNotExists=false": "response = client.partial_update_objects(\n index_name=\"\",\n objects=[\n {\n \"objectID\": \"3\",\n \"name\": \"Cyril\",\n },\n {\n \"objectID\": \"4\",\n \"name\": \"David\",\n },\n ],\n create_if_not_exists=False,\n)" }, "removeUserId": { "default": "response = client.remove_user_id(\n user_id=\"uniqueID\",\n)" @@ -2126,8 +2126,8 @@ "default": "response = client.partial_update_object(\"\", \"uniqueID\", {attributeId: \"new value\"})" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "response = client.partial_update_objects(\n \"\",\n [{objectID: \"1\", name: \"Adam\"}, {objectID: \"2\", name: \"Benoit\"}],\n true\n)", - "call partialUpdateObjects with createIfNotExists=false": "response = client.partial_update_objects(\n \"\",\n [{objectID: \"3\", name: \"Cyril\"}, {objectID: \"4\", name: \"David\"}],\n false\n)" + "call partialUpdateObjects with createIfNotExists=true": "response = client.partial_update_objects(\n \"\",\n [{objectID: \"1\", name: \"Adam\"}, {objectID: \"2\", name: \"Benoit\"}],\n true\n)", + "call partialUpdateObjects with createIfNotExists=false": "response = client.partial_update_objects(\n \"\",\n [{objectID: \"3\", name: \"Cyril\"}, {objectID: \"4\", name: \"David\"}],\n false\n)" }, "removeUserId": { "default": "response = client.remove_user_id(\"uniqueID\")" @@ -2581,8 +2581,8 @@ "default": "let response = try await client.partialUpdateObject(\n indexName: \"\",\n objectID: \"uniqueID\",\n attributesToUpdate: [\"attributeId\": \"new value\"]\n)" }, "partialUpdateObjects": { - "call partialUpdateObjects with createIfNotExists=true": "let response = try await client.partialUpdateObjects(\n indexName: \"\",\n objects: [[\"objectID\": \"1\", \"name\": \"Adam\"], [\"objectID\": \"2\", \"name\": \"Benoit\"]],\n createIfNotExists: true\n)", - "call partialUpdateObjects with createIfNotExists=false": "let response = try await client.partialUpdateObjects(\n indexName: \"\",\n objects: [[\"objectID\": \"3\", \"name\": \"Cyril\"], [\"objectID\": \"4\", \"name\": \"David\"]],\n createIfNotExists: false\n)" + "call partialUpdateObjects with createIfNotExists=true": "let response = try await client.partialUpdateObjects(\n indexName: \"\",\n objects: [[\"objectID\": \"1\", \"name\": \"Adam\"], [\"objectID\": \"2\", \"name\": \"Benoit\"]],\n createIfNotExists: true\n)", + "call partialUpdateObjects with createIfNotExists=false": "let response = try await client.partialUpdateObjects(\n indexName: \"\",\n objects: [[\"objectID\": \"3\", \"name\": \"Cyril\"], [\"objectID\": \"4\", \"name\": \"David\"]],\n createIfNotExists: false\n)" }, "removeUserId": { "default": "let response = try await client.removeUserId(userID: \"uniqueID\")" diff --git a/docs/snippets/csharp/src/Search.cs b/docs/snippets/csharp/src/Search.cs index 1743475462..9a59967c7a 100644 --- a/docs/snippets/csharp/src/Search.cs +++ b/docs/snippets/csharp/src/Search.cs @@ -1301,7 +1301,7 @@ public async Task SnippetForSearchClientPartialUpdateObject() /// public async Task SnippetForSearchClientPartialUpdateObjects() { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")); @@ -1326,7 +1326,7 @@ public async Task SnippetForSearchClientPartialUpdateObjects() /// public async Task SnippetForSearchClientPartialUpdateObjects1() { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client var client = new SearchClient(new SearchConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")); diff --git a/docs/snippets/dart/lib/search.dart b/docs/snippets/dart/lib/search.dart index f18da54d90..a3f13001aa 100644 --- a/docs/snippets/dart/lib/search.dart +++ b/docs/snippets/dart/lib/search.dart @@ -1242,7 +1242,7 @@ void snippetForpartialUpdateObject() async { // // call partialUpdateObjects with createIfNotExists=true void snippetForpartialUpdateObjects() async { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client final client = SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY'); @@ -1270,7 +1270,7 @@ void snippetForpartialUpdateObjects() async { // // call partialUpdateObjects with createIfNotExists=false void snippetForpartialUpdateObjects1() async { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client final client = SearchClient(appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY'); diff --git a/docs/snippets/go/src/search.go b/docs/snippets/go/src/search.go index 27f5f9de79..1996931d55 100644 --- a/docs/snippets/go/src/search.go +++ b/docs/snippets/go/src/search.go @@ -1782,7 +1782,7 @@ func SnippetForPartialUpdateObjectsOfSearch() { call partialUpdateObjects with createIfNotExists=true */ - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") if err != nil { @@ -1812,7 +1812,7 @@ func SnippetForPartialUpdateObjectsOfSearch1() { call partialUpdateObjects with createIfNotExists=false */ - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client client, err := search.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") if err != nil { diff --git a/docs/snippets/java/src/test/java/com/algolia/Search.java b/docs/snippets/java/src/test/java/com/algolia/Search.java index 753c627e68..e3334d67de 100644 --- a/docs/snippets/java/src/test/java/com/algolia/Search.java +++ b/docs/snippets/java/src/test/java/com/algolia/Search.java @@ -1097,7 +1097,7 @@ void snippetForPartialUpdateObject() throws Exception { // // call partialUpdateObjects with createIfNotExists=true void snippetForPartialUpdateObjects() throws Exception { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"); @@ -1128,7 +1128,7 @@ void snippetForPartialUpdateObjects() throws Exception { // // call partialUpdateObjects with createIfNotExists=false void snippetForPartialUpdateObjects1() throws Exception { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client SearchClient client = new SearchClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY"); diff --git a/docs/snippets/javascript/src/search.ts b/docs/snippets/javascript/src/search.ts index 143799b150..dfdcf015cb 100644 --- a/docs/snippets/javascript/src/search.ts +++ b/docs/snippets/javascript/src/search.ts @@ -1200,7 +1200,7 @@ export async function snippetForPartialUpdateObject(): Promise { // // call partialUpdateObjects with createIfNotExists=true export async function snippetForPartialUpdateObjects(): Promise { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client // const client = searchClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); @@ -1225,7 +1225,7 @@ export async function snippetForPartialUpdateObjects(): Promise { // // call partialUpdateObjects with createIfNotExists=false export async function snippetForPartialUpdateObjects1(): Promise { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client // const client = searchClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); diff --git a/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt b/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt index a30306af59..3786084cc8 100644 --- a/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt +++ b/docs/snippets/kotlin/src/main/kotlin/com/algolia/snippets/Search.kt @@ -1316,7 +1316,7 @@ class SnippetSearchClient { } suspend fun snippetForPartialUpdateObjects() { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") @@ -1357,7 +1357,7 @@ class SnippetSearchClient { } suspend fun snippetForPartialUpdateObjects1() { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client val client = SearchClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY") diff --git a/docs/snippets/php/src/Search.php b/docs/snippets/php/src/Search.php index 0d7ff2d6e0..c9b5912db3 100644 --- a/docs/snippets/php/src/Search.php +++ b/docs/snippets/php/src/Search.php @@ -1514,7 +1514,7 @@ public function snippetForPartialUpdateObject(): void */ public function snippetForPartialUpdateObjects(): void { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client $client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); @@ -1546,7 +1546,7 @@ public function snippetForPartialUpdateObjects(): void */ public function snippetForPartialUpdateObjects1(): void { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client $client = SearchClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY'); diff --git a/docs/snippets/python/search.py b/docs/snippets/python/search.py index 3e22014960..a846bd5619 100644 --- a/docs/snippets/python/search.py +++ b/docs/snippets/python/search.py @@ -1545,7 +1545,7 @@ def snippet_for_partial_update_objects(): call partialUpdateObjects with createIfNotExists=true """ - # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true # Initialize the client # In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods. client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") @@ -1578,7 +1578,7 @@ def snippet_for_partial_update_objects1(): call partialUpdateObjects with createIfNotExists=false """ - # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false # Initialize the client # In an asynchronous context, you can use SearchClient instead, which exposes the exact same methods. client = SearchClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") diff --git a/docs/snippets/ruby/search.rb b/docs/snippets/ruby/search.rb index 9189bb142f..4f78878191 100644 --- a/docs/snippets/ruby/search.rb +++ b/docs/snippets/ruby/search.rb @@ -1349,7 +1349,7 @@ def snippet_for_partial_update_object # # call partialUpdateObjects with createIfNotExists=true def snippet_for_partial_update_objects - # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true # Initialize the client client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") @@ -1373,7 +1373,7 @@ def snippet_for_partial_update_objects # # call partialUpdateObjects with createIfNotExists=false def snippet_for_partial_update_objects1 - # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + # >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false # Initialize the client client = Algolia::SearchClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") diff --git a/docs/snippets/swift/Sources/Search.swift b/docs/snippets/swift/Sources/Search.swift index b93c898c9a..4d34c39ba1 100644 --- a/docs/snippets/swift/Sources/Search.swift +++ b/docs/snippets/swift/Sources/Search.swift @@ -1006,7 +1006,7 @@ final class SearchClientSnippet { /// /// call partialUpdateObjects with createIfNotExists=true func snippetForPartialUpdateObjects() async throws { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=true // Initialize the client let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY") @@ -1024,7 +1024,7 @@ final class SearchClientSnippet { /// /// call partialUpdateObjects with createIfNotExists=false func snippetForPartialUpdateObjects1() async throws { - // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false + // >SEPARATOR partialUpdateObjects call partialUpdateObjects with createIfNotExists=false // Initialize the client let client = try SearchClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY") diff --git a/templates/csharp/api.mustache b/templates/csharp/api.mustache index 4e096b67eb..1472cd3cb7 100644 --- a/templates/csharp/api.mustache +++ b/templates/csharp/api.mustache @@ -35,7 +35,7 @@ namespace Algolia.Search.Clients; {{/x-acl}} {{/vendorExtensions}} {{#allParams}} - /// {{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} + /// {{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}} /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. @@ -58,7 +58,7 @@ namespace Algolia.Search.Clients; {{/x-acl}} {{/vendorExtensions}} {{#allParams}} - /// {{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{.}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} + /// {{{description}}}{{^required}} (optional{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}){{/required}}{{#isDeprecated}} (deprecated){{/isDeprecated}} {{/allParams}} /// Add extra http header or query parameters to Algolia. /// Cancellation Token to cancel the request. diff --git a/templates/csharp/modelEnum.mustache b/templates/csharp/modelEnum.mustache index 25579bbca9..71cb02ae19 100644 --- a/templates/csharp/modelEnum.mustache +++ b/templates/csharp/modelEnum.mustache @@ -10,7 +10,7 @@ {{#allowableValues}} {{#enumVars}} /// - /// Enum {{name}} for value: {{value}} + /// Enum {{name}} for value: {{{value}}} /// {{#isString}} {{^useGenericHost}} diff --git a/templates/csharp/modelGeneric.mustache b/templates/csharp/modelGeneric.mustache index f7714ca059..abf0a0cd43 100644 --- a/templates/csharp/modelGeneric.mustache +++ b/templates/csharp/modelGeneric.mustache @@ -126,7 +126,7 @@ /// {{#readWriteVars}} {{#required}} - /// {{description}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{.}}){{/defaultValue}}. + /// {{{description}}}{{^description}}{{nameInCamelCase}}{{/description}}{{#required}} (required){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}. {{/required}} {{/readWriteVars}} {{#hasOnlyReadOnly}} diff --git a/templates/csharp/snippets/method.mustache b/templates/csharp/snippets/method.mustache index e18afbb8e5..502257a89e 100644 --- a/templates/csharp/snippets/method.mustache +++ b/templates/csharp/snippets/method.mustache @@ -21,7 +21,7 @@ public class Snippet{{client}} /// public async Task SnippetFor{{client}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/dart/snippets/method.mustache b/templates/dart/snippets/method.mustache index a75e19cf83..bb3b6320fb 100644 --- a/templates/dart/snippets/method.mustache +++ b/templates/dart/snippets/method.mustache @@ -9,7 +9,7 @@ // // {{{description}}} void snippetFor{{method}}{{testIndex}}() async { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/go/snippets/method.mustache b/templates/go/snippets/method.mustache index e6cef065e9..8f2b5c4204 100644 --- a/templates/go/snippets/method.mustache +++ b/templates/go/snippets/method.mustache @@ -15,7 +15,7 @@ func SnippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}Of{{#lambda.p {{{description}}} */ - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client{{#hasRegionalHost}} with your application region, eg. {{clientPrefix}}.ALGOLIA_APPLICATION_REGION{{/hasRegionalHost}} {{> snippets/init}} diff --git a/templates/java/api.mustache b/templates/java/api.mustache index 7b7466fed1..3a294c5b3f 100644 --- a/templates/java/api.mustache +++ b/templates/java/api.mustache @@ -133,7 +133,7 @@ public class {{classname}} extends ApiClient { {{#operation}} /** * {{{notes}}}{{#allParams}} - * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}} + * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}} {{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}} * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. {{> api_javadoc}} @@ -145,7 +145,7 @@ public class {{classname}} extends ApiClient { {{! This case only sets `requestOptions` as optional }} /** * {{{notes}}}{{#allParams}} - * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}} + * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}} {{#vendorExtensions}}{{#x-is-generic}}* @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}} {{> api_javadoc}} public {{> return_type}} {{operationId}}({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException { @@ -180,7 +180,7 @@ public class {{classname}} extends ApiClient { /** * (asynchronously) * {{{notes}}}{{#allParams}} - * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}} + * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}} * @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}} * @param requestOptions The requestOptions to send along with the query, they will be merged with the transporter requestOptions. {{> api_javadoc}} @@ -204,7 +204,7 @@ public class {{classname}} extends ApiClient { /** * (asynchronously) * {{{notes}}}{{#allParams}} - * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{.}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}} + * @param {{paramName}} {{{description}}}{{#required}} (required){{/required}}{{^required}} (optional{{^isContainer}}{{#defaultValue}}, default to {{{.}}}{{/defaultValue}}{{/isContainer}}){{/required}}{{/allParams}}{{#vendorExtensions}}{{#x-is-generic}} * @param innerType The class held by the index, could be your custom class or {@link Object}.{{/x-is-generic}}{{/vendorExtensions}} {{> api_javadoc}} public {{> return_type_async}} {{operationId}}Async({{#requiredParams}}@Nonnull {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/requiredParams}}{{#hasRequiredParams}}{{#hasOptionalParams}},{{/hasOptionalParams}}{{/hasRequiredParams}}{{#optionalParams}}{{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/optionalParams}}{{#vendorExtensions}}{{#x-is-generic}}, Class innerType{{/x-is-generic}}{{/vendorExtensions}}) throws AlgoliaRuntimeException { diff --git a/templates/java/snippets/method.mustache b/templates/java/snippets/method.mustache index f68b39ef05..0f6c9a65de 100644 --- a/templates/java/snippets/method.mustache +++ b/templates/java/snippets/method.mustache @@ -13,7 +13,7 @@ class Snippet{{client}} { // // {{{description}}} void snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() throws Exception { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/javascript/snippets/method.mustache b/templates/javascript/snippets/method.mustache index ed64a9e8ed..2237ad4b10 100644 --- a/templates/javascript/snippets/method.mustache +++ b/templates/javascript/snippets/method.mustache @@ -11,7 +11,7 @@ import type { RequestOptions } from '@algolia/client-common'; // // {{{description}}} export {{#isAsyncMethod}}async{{/isAsyncMethod}} function snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): {{#isAsyncMethod}}Promise{{/isAsyncMethod}}{{^isAsyncMethod}}void{{/isAsyncMethod}} { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client // {{#hasRegionalHost}}Replace '{{defaultRegion}}' with your Algolia Application Region{{/hasRegionalHost}} {{> snippets/init}} diff --git a/templates/kotlin/snippets/method.mustache b/templates/kotlin/snippets/method.mustache index 83277347db..8a79adcd93 100644 --- a/templates/kotlin/snippets/method.mustache +++ b/templates/kotlin/snippets/method.mustache @@ -12,7 +12,7 @@ class Snippet{{client}} { {{#blocksRequests}} {{#snippets}} suspend fun snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/php/model.mustache b/templates/php/model.mustache index 17b93315c2..2d88539ca4 100644 --- a/templates/php/model.mustache +++ b/templates/php/model.mustache @@ -16,7 +16,7 @@ use Algolia\AlgoliaSearch\Model\ModelInterface; * * @category Class {{#description}} - * @description {{.}} + * @description {{{.}}} {{/description}} * @package {{invokerPackage}} */ diff --git a/templates/php/snippets/method.mustache b/templates/php/snippets/method.mustache index 994e1a891e..1f987c822b 100644 --- a/templates/php/snippets/method.mustache +++ b/templates/php/snippets/method.mustache @@ -19,7 +19,7 @@ class Snippet{{client}} */ public function snippetFor{{#lambda.titlecase}}{{method}}{{/lambda.titlecase}}{{testIndex}}(): void { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/python/snippets/method.mustache b/templates/python/snippets/method.mustache index 974672250d..87c0b469a7 100644 --- a/templates/python/snippets/method.mustache +++ b/templates/python/snippets/method.mustache @@ -11,7 +11,7 @@ def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex} {{{description}}} """ - # >SEPARATOR {{method}} {{testName}} + # >SEPARATOR {{method}} {{{testName}}} # Initialize the client # In an asynchronous context, you can use {{#lambda.pascalcase}}{{{client}}}{{/lambda.pascalcase}} instead, which exposes the exact same methods. {{> snippets/init}} diff --git a/templates/ruby/api.mustache b/templates/ruby/api.mustache index b6a633344c..789a84790d 100644 --- a/templates/ruby/api.mustache +++ b/templates/ruby/api.mustache @@ -77,7 +77,7 @@ module {{moduleName}} {{#operation}} {{#notes}} - # {{.}} + # {{{.}}} {{/notes}} {{#vendorExtensions}} {{#x-acl.0}} @@ -89,10 +89,10 @@ module {{moduleName}} {{/vendorExtensions}} {{#allParams}} {{#required}} - # @param {{paramName}} [{{{dataType}}}] {{description}} (required) + # @param {{paramName}} [{{{dataType}}}] {{{description}}} (required) {{/required}} {{^required}} - # @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + # @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/required}} {{/allParams}} # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) @@ -153,10 +153,10 @@ module {{moduleName}} {{/vendorExtensions}} {{#allParams}} {{#required}} - # @param {{paramName}} [{{{dataType}}}] {{description}} (required) + # @param {{paramName}} [{{{dataType}}}] {{{description}}} (required) {{/required}} {{^required}} - # @param {{paramName}} [{{{dataType}}}] {{description}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} + # @param {{paramName}} [{{{dataType}}}] {{{description}}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} {{/required}} {{/allParams}} # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional) diff --git a/templates/ruby/snippets/method.mustache b/templates/ruby/snippets/method.mustache index 12bb0d2fdf..cd5dc6fd12 100644 --- a/templates/ruby/snippets/method.mustache +++ b/templates/ruby/snippets/method.mustache @@ -9,7 +9,7 @@ # # {{{description}}} def snippet_for_{{#lambda.snakecase}}{{method}}{{/lambda.snakecase}}{{testIndex}} - # >SEPARATOR {{method}} {{testName}} + # >SEPARATOR {{method}} {{{testName}}} # Initialize the client {{> snippets/init}} diff --git a/templates/scala/enum.mustache b/templates/scala/enum.mustache index 5377774ee8..0e715091a2 100644 --- a/templates/scala/enum.mustache +++ b/templates/scala/enum.mustache @@ -9,7 +9,7 @@ object {{classname}} { {{#allowableValues}} {{#values}} case object {{#fnEnumEntry}}{{.}}{{/fnEnumEntry}} extends {{classname}} { - override def toString = "{{.}}" + override def toString = "{{{.}}}" } {{/values}} {{/allowableValues}} diff --git a/templates/scala/snippets/method.mustache b/templates/scala/snippets/method.mustache index bd42066f33..9e3471b9aa 100644 --- a/templates/scala/snippets/method.mustache +++ b/templates/scala/snippets/method.mustache @@ -24,7 +24,7 @@ class Snippet{{client}} { * {{{description}}} */ def snippetFor{{#lambda.pascalcase}}{{client}}{{/lambda.pascalcase}}{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}(): Unit = { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}} diff --git a/templates/swift/model.mustache b/templates/swift/model.mustache index cc32ea4ef9..cb062b6489 100644 --- a/templates/swift/model.mustache +++ b/templates/swift/model.mustache @@ -7,7 +7,7 @@ import Foundation {{#description}} -/** {{.}} */{{/description}}{{#isDeprecated}} +/** {{{.}}} */{{/description}}{{#isDeprecated}} @available(*, deprecated, message: "This schema is deprecated."){{/isDeprecated}}{{#vendorExtensions.x-is-one-of-interface}} {{> modelOneOf}}{{/vendorExtensions.x-is-one-of-interface}}{{^vendorExtensions.x-is-one-of-interface}}{{#isArray}} {{> modelArray}}{{/isArray}}{{^isArray}}{{#isEnum}} diff --git a/templates/swift/snippets/method.mustache b/templates/swift/snippets/method.mustache index 077e02084e..2c22ffb8c5 100644 --- a/templates/swift/snippets/method.mustache +++ b/templates/swift/snippets/method.mustache @@ -12,7 +12,7 @@ final class {{client}}Snippet { // // {{{description}}} func snippetFor{{#lambda.pascalcase}}{{method}}{{/lambda.pascalcase}}{{testIndex}}() async throws { - // >SEPARATOR {{method}} {{testName}} + // >SEPARATOR {{method}} {{{testName}}} // Initialize the client {{> snippets/init}}