Skip to content

Commit

Permalink
fix(specs): make the searchParams compatible with v4 [skip-bc] (#4108)…
Browse files Browse the repository at this point in the history
… (generated) [skip ci]

Co-authored-by: Pierre Millot <[email protected]>
  • Loading branch information
algolia-bot and millotp committed Nov 18, 2024
1 parent 7807ad7 commit 0b0bf4c
Show file tree
Hide file tree
Showing 293 changed files with 6,894 additions and 4,122 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public AuthInput(AuthAlgoliaInsights actualInstance)
/// Initializes a new instance of the AuthInput class
/// with a Dictionary{string, string}
/// </summary>
/// <param name="actualInstance">An instance of Dictionary&lt;string, string&gt;.</param>
/// <param name="actualInstance">An instance of Dictionary<string, string>.</param>
public AuthInput(Dictionary<string, string> actualInstance)
{
ActualInstance = actualInstance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ public AuthInputPartial(AuthAlgoliaInsightsPartial actualInstance)
/// Initializes a new instance of the AuthInputPartial class
/// with a Dictionary{string, string}
/// </summary>
/// <param name="actualInstance">An instance of Dictionary&lt;string, string&gt;.</param>
/// <param name="actualInstance">An instance of Dictionary<string, string>.</param>
public AuthInputPartial(Dictionary<string, string> actualInstance)
{
ActualInstance = actualInstance;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public partial class Languages : AbstractSchema
/// Initializes a new instance of the Languages class
/// with a List{String}
/// </summary>
/// <param name="actualInstance">An instance of List&lt;string&gt;.</param>
/// <param name="actualInstance">An instance of List<string>.</param>
public Languages(List<string> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public AroundPrecision(int actualInstance)
/// Initializes a new instance of the AroundPrecision class
/// with a List{Range}
/// </summary>
/// <param name="actualInstance">An instance of List&lt;Range&gt;.</param>
/// <param name="actualInstance">An instance of List<Range>.</param>
public AroundPrecision(List<Range> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public partial class FacetFilters : AbstractSchema
/// Initializes a new instance of the FacetFilters class
/// with a List{FacetFilters}
/// </summary>
/// <param name="actualInstance">An instance of List&lt;FacetFilters&gt;.</param>
/// <param name="actualInstance">An instance of List<FacetFilters>.</param>
public FacetFilters(List<FacetFilters> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,11 +141,10 @@ public FallbackParams()
public int? MinimumAroundRadius { get; set; }

/// <summary>
/// Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
/// Gets or Sets InsideBoundingBox
/// </summary>
/// <value>Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). </value>
[JsonPropertyName("insideBoundingBox")]
public List<List<double>> InsideBoundingBox { get; set; }
public InsideBoundingBox InsideBoundingBox { get; set; }

/// <summary>
/// Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
Expand Down Expand Up @@ -357,6 +356,13 @@ public FallbackParams()
[JsonPropertyName("attributeForDistinct")]
public string AttributeForDistinct { get; set; }

/// <summary>
/// Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
/// </summary>
/// <value>Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).</value>
[JsonPropertyName("maxFacetHits")]
public int? MaxFacetHits { get; set; }

/// <summary>
/// Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
/// </summary>
Expand Down Expand Up @@ -502,11 +508,10 @@ public FallbackParams()
public bool? AdvancedSyntax { get; set; }

/// <summary>
/// Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
/// Gets or Sets OptionalWords
/// </summary>
/// <value>Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words). </value>
[JsonPropertyName("optionalWords")]
public List<string> OptionalWords { get; set; }
public OptionalWords OptionalWords { get; set; }

/// <summary>
/// Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
Expand Down Expand Up @@ -556,13 +561,6 @@ public FallbackParams()
[JsonPropertyName("responseFields")]
public List<string> ResponseFields { get; set; }

/// <summary>
/// Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
/// </summary>
/// <value>Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).</value>
[JsonPropertyName("maxFacetHits")]
public int? MaxFacetHits { get; set; }

/// <summary>
/// Maximum number of facet values to return for each facet.
/// </summary>
Expand Down Expand Up @@ -657,6 +655,7 @@ public override string ToString()
sb.Append(" UserData: ").Append(UserData).Append("\n");
sb.Append(" CustomNormalization: ").Append(CustomNormalization).Append("\n");
sb.Append(" AttributeForDistinct: ").Append(AttributeForDistinct).Append("\n");
sb.Append(" MaxFacetHits: ").Append(MaxFacetHits).Append("\n");
sb.Append(" AttributesToRetrieve: ").Append(AttributesToRetrieve).Append("\n");
sb.Append(" Ranking: ").Append(Ranking).Append("\n");
sb.Append(" RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
Expand Down Expand Up @@ -689,7 +688,6 @@ public override string ToString()
sb.Append(" ReplaceSynonymsInHighlight: ").Append(ReplaceSynonymsInHighlight).Append("\n");
sb.Append(" MinProximity: ").Append(MinProximity).Append("\n");
sb.Append(" ResponseFields: ").Append(ResponseFields).Append("\n");
sb.Append(" MaxFacetHits: ").Append(MaxFacetHits).Append("\n");
sb.Append(" MaxValuesPerFacet: ").Append(MaxValuesPerFacet).Append("\n");
sb.Append(" SortFacetValuesBy: ").Append(SortFacetValuesBy).Append("\n");
sb.Append(" AttributeCriteriaComputedByMinProximity: ").Append(AttributeCriteriaComputedByMinProximity).Append("\n");
Expand Down Expand Up @@ -737,7 +735,7 @@ public override bool Equals(object obj)
(AroundRadius == input.AroundRadius || (AroundRadius != null && AroundRadius.Equals(input.AroundRadius))) &&
(AroundPrecision == input.AroundPrecision || (AroundPrecision != null && AroundPrecision.Equals(input.AroundPrecision))) &&
(MinimumAroundRadius == input.MinimumAroundRadius || MinimumAroundRadius.Equals(input.MinimumAroundRadius)) &&
(InsideBoundingBox == input.InsideBoundingBox || InsideBoundingBox != null && input.InsideBoundingBox != null && InsideBoundingBox.SequenceEqual(input.InsideBoundingBox)) &&
(InsideBoundingBox == input.InsideBoundingBox || (InsideBoundingBox != null && InsideBoundingBox.Equals(input.InsideBoundingBox))) &&
(InsidePolygon == input.InsidePolygon || InsidePolygon != null && input.InsidePolygon != null && InsidePolygon.SequenceEqual(input.InsidePolygon)) &&
(NaturalLanguages == input.NaturalLanguages || NaturalLanguages != null && input.NaturalLanguages != null && NaturalLanguages.SequenceEqual(input.NaturalLanguages)) &&
(RuleContexts == input.RuleContexts || RuleContexts != null && input.RuleContexts != null && RuleContexts.SequenceEqual(input.RuleContexts)) &&
Expand Down Expand Up @@ -768,6 +766,7 @@ public override bool Equals(object obj)
(UserData == input.UserData || (UserData != null && UserData.Equals(input.UserData))) &&
(CustomNormalization == input.CustomNormalization || CustomNormalization != null && input.CustomNormalization != null && CustomNormalization.SequenceEqual(input.CustomNormalization)) &&
(AttributeForDistinct == input.AttributeForDistinct || (AttributeForDistinct != null && AttributeForDistinct.Equals(input.AttributeForDistinct))) &&
(MaxFacetHits == input.MaxFacetHits || MaxFacetHits.Equals(input.MaxFacetHits)) &&
(AttributesToRetrieve == input.AttributesToRetrieve || AttributesToRetrieve != null && input.AttributesToRetrieve != null && AttributesToRetrieve.SequenceEqual(input.AttributesToRetrieve)) &&
(Ranking == input.Ranking || Ranking != null && input.Ranking != null && Ranking.SequenceEqual(input.Ranking)) &&
(RelevancyStrictness == input.RelevancyStrictness || RelevancyStrictness.Equals(input.RelevancyStrictness)) &&
Expand All @@ -791,7 +790,7 @@ public override bool Equals(object obj)
(QueryType == input.QueryType || QueryType.Equals(input.QueryType)) &&
(RemoveWordsIfNoResults == input.RemoveWordsIfNoResults || RemoveWordsIfNoResults.Equals(input.RemoveWordsIfNoResults)) &&
(AdvancedSyntax == input.AdvancedSyntax || AdvancedSyntax.Equals(input.AdvancedSyntax)) &&
(OptionalWords == input.OptionalWords || OptionalWords != null && input.OptionalWords != null && OptionalWords.SequenceEqual(input.OptionalWords)) &&
(OptionalWords == input.OptionalWords || (OptionalWords != null && OptionalWords.Equals(input.OptionalWords))) &&
(DisableExactOnAttributes == input.DisableExactOnAttributes || DisableExactOnAttributes != null && input.DisableExactOnAttributes != null && DisableExactOnAttributes.SequenceEqual(input.DisableExactOnAttributes)) &&
(ExactOnSingleWordQuery == input.ExactOnSingleWordQuery || ExactOnSingleWordQuery.Equals(input.ExactOnSingleWordQuery)) &&
(AlternativesAsExact == input.AlternativesAsExact || AlternativesAsExact != null && input.AlternativesAsExact != null && AlternativesAsExact.SequenceEqual(input.AlternativesAsExact)) &&
Expand All @@ -800,7 +799,6 @@ public override bool Equals(object obj)
(ReplaceSynonymsInHighlight == input.ReplaceSynonymsInHighlight || ReplaceSynonymsInHighlight.Equals(input.ReplaceSynonymsInHighlight)) &&
(MinProximity == input.MinProximity || MinProximity.Equals(input.MinProximity)) &&
(ResponseFields == input.ResponseFields || ResponseFields != null && input.ResponseFields != null && ResponseFields.SequenceEqual(input.ResponseFields)) &&
(MaxFacetHits == input.MaxFacetHits || MaxFacetHits.Equals(input.MaxFacetHits)) &&
(MaxValuesPerFacet == input.MaxValuesPerFacet || MaxValuesPerFacet.Equals(input.MaxValuesPerFacet)) &&
(SortFacetValuesBy == input.SortFacetValuesBy || (SortFacetValuesBy != null && SortFacetValuesBy.Equals(input.SortFacetValuesBy))) &&
(AttributeCriteriaComputedByMinProximity == input.AttributeCriteriaComputedByMinProximity || AttributeCriteriaComputedByMinProximity.Equals(input.AttributeCriteriaComputedByMinProximity)) &&
Expand Down Expand Up @@ -963,6 +961,7 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + AttributeForDistinct.GetHashCode();
}
hashCode = (hashCode * 59) + MaxFacetHits.GetHashCode();
if (AttributesToRetrieve != null)
{
hashCode = (hashCode * 59) + AttributesToRetrieve.GetHashCode();
Expand Down Expand Up @@ -1049,7 +1048,6 @@ public override int GetHashCode()
{
hashCode = (hashCode * 59) + ResponseFields.GetHashCode();
}
hashCode = (hashCode * 59) + MaxFacetHits.GetHashCode();
hashCode = (hashCode * 59) + MaxValuesPerFacet.GetHashCode();
if (SortFacetValuesBy != null)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public HighlightResult(HighlightResultOption actualInstance)
/// Initializes a new instance of the HighlightResult class
/// with a Dictionary{string, HighlightResult}
/// </summary>
/// <param name="actualInstance">An instance of Dictionary&lt;string, HighlightResult&gt;.</param>
/// <param name="actualInstance">An instance of Dictionary<string, HighlightResult>.</param>
public HighlightResult(Dictionary<string, HighlightResult> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand All @@ -44,7 +44,7 @@ public HighlightResult(Dictionary<string, HighlightResult> actualInstance)
/// Initializes a new instance of the HighlightResult class
/// with a List{HighlightResult}
/// </summary>
/// <param name="actualInstance">An instance of List&lt;HighlightResult&gt;.</param>
/// <param name="actualInstance">An instance of List<HighlightResult>.</param>
public HighlightResult(List<HighlightResult> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ public partial class IgnorePlurals : AbstractSchema
/// Initializes a new instance of the IgnorePlurals class
/// with a List{SupportedLanguage}
/// </summary>
/// <param name="actualInstance">An instance of List&lt;SupportedLanguage&gt;.</param>
/// <param name="actualInstance">An instance of List<SupportedLanguage>.</param>
public IgnorePlurals(List<SupportedLanguage> actualInstance)
{
ActualInstance = actualInstance ?? throw new ArgumentException("Invalid instance found. Must not be null.");
Expand Down
Loading

0 comments on commit 0b0bf4c

Please sign in to comment.