feat(specs): add facets query parameter available at run time (#5486) (generated) [skip ci]

Co-authored-by: Clara Muller <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: 3 people

clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/FacetOrdering.cs

@@ -25,7 +25,7 @@ public FacetOrdering() { }
   /// Gets or Sets Facets
   /// </summary>
   [JsonPropertyName("facets")]
-  public Facets Facets { get; set; }
+  public IndexSettingsFacets Facets { get; set; }
 
   /// <summary>
   /// Order of facet values. One object for each facet.

clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/Facets.cs renamed to clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/IndexSettingsFacets.cs

@@ -14,12 +14,12 @@ namespace Algolia.Search.Models.Composition;
 /// <summary>
 /// Order of facet names.
 /// </summary>
-public partial class Facets
+public partial class IndexSettingsFacets
 {
   /// <summary>
-  /// Initializes a new instance of the Facets class.
+  /// Initializes a new instance of the IndexSettingsFacets class.
   /// </summary>
-  public Facets() { }
+  public IndexSettingsFacets() { }
 
   /// <summary>
   /// Explicit order of facets or facet values.  This setting lets you always show specific facets or facet values at the top of the list.
@@ -35,7 +35,7 @@ public Facets() { }
   public override string ToString()
   {
     StringBuilder sb = new StringBuilder();
-    sb.Append("class Facets {\n");
+    sb.Append("class IndexSettingsFacets {\n");
     sb.Append("  Order: ").Append(Order).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
@@ -57,7 +57,7 @@ public virtual string ToJson()
   /// <returns>Boolean</returns>
   public override bool Equals(object obj)
   {
-    if (obj is not Facets input)
+    if (obj is not IndexSettingsFacets input)
     {
       return false;
     }

clients/algoliasearch-client-csharp/algoliasearch/Models/Composition/Params.cs

@@ -56,6 +56,13 @@ public Params() { }
   [JsonPropertyName("relevancyStrictness")]
   public int? RelevancyStrictness { get; set; }
 
+  /// <summary>
+  /// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
+  /// </summary>
+  /// <value>Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts). </value>
+  [JsonPropertyName("facets")]
+  public List<string> Facets { get; set; }
+
   /// <summary>
   /// Gets or Sets FacetFilters
   /// </summary>
@@ -217,6 +224,7 @@ public override string ToString()
     sb.Append("  Page: ").Append(Page).Append("\n");
     sb.Append("  GetRankingInfo: ").Append(GetRankingInfo).Append("\n");
     sb.Append("  RelevancyStrictness: ").Append(RelevancyStrictness).Append("\n");
+    sb.Append("  Facets: ").Append(Facets).Append("\n");
     sb.Append("  FacetFilters: ").Append(FacetFilters).Append("\n");
     sb.Append("  OptionalFilters: ").Append(OptionalFilters).Append("\n");
     sb.Append("  NumericFilters: ").Append(NumericFilters).Append("\n");
@@ -272,6 +280,10 @@ public override bool Equals(object obj)
         RelevancyStrictness == input.RelevancyStrictness
         || RelevancyStrictness.Equals(input.RelevancyStrictness)
       )
+      && (
+        Facets == input.Facets
+        || Facets != null && input.Facets != null && Facets.SequenceEqual(input.Facets)
+      )
       && (
         FacetFilters == input.FacetFilters
         || (FacetFilters != null && FacetFilters.Equals(input.FacetFilters))
@@ -373,6 +385,10 @@ public override int GetHashCode()
       hashCode = (hashCode * 59) + Page.GetHashCode();
       hashCode = (hashCode * 59) + GetRankingInfo.GetHashCode();
       hashCode = (hashCode * 59) + RelevancyStrictness.GetHashCode();
+      if (Facets != null)
+      {
+        hashCode = (hashCode * 59) + Facets.GetHashCode();
+      }
       if (FacetFilters != null)
       {
         hashCode = (hashCode * 59) + FacetFilters.GetHashCode();

clients/algoliasearch-client-dart/packages/client_composition/lib/algolia_client_composition.dart

@@ -47,12 +47,12 @@ export 'src/model/external_source.dart';
 export 'src/model/facet_hits.dart';
 export 'src/model/facet_ordering.dart';
 export 'src/model/facet_stats.dart';
-export 'src/model/facets.dart';
 export 'src/model/get_task_response.dart';
 export 'src/model/highlight_result_option.dart';
 export 'src/model/hit.dart';
 export 'src/model/hit_metadata.dart';
 export 'src/model/hit_ranking_info.dart';
+export 'src/model/index_settings_facets.dart';
 export 'src/model/injected_item.dart';
 export 'src/model/injected_item_hits_metadata.dart';
 export 'src/model/injected_item_metadata.dart';

clients/algoliasearch-client-dart/packages/client_composition/lib/src/deserialize.dart

@@ -40,12 +40,12 @@ import 'package:algolia_client_composition/src/model/external_source.dart';
 import 'package:algolia_client_composition/src/model/facet_hits.dart';
 import 'package:algolia_client_composition/src/model/facet_ordering.dart';
 import 'package:algolia_client_composition/src/model/facet_stats.dart';
-import 'package:algolia_client_composition/src/model/facets.dart';
 import 'package:algolia_client_composition/src/model/get_task_response.dart';
 import 'package:algolia_client_composition/src/model/highlight_result_option.dart';
 import 'package:algolia_client_composition/src/model/hit.dart';
 import 'package:algolia_client_composition/src/model/hit_metadata.dart';
 import 'package:algolia_client_composition/src/model/hit_ranking_info.dart';
+import 'package:algolia_client_composition/src/model/index_settings_facets.dart';
 import 'package:algolia_client_composition/src/model/injected_item.dart';
 import 'package:algolia_client_composition/src/model/injected_item_hits_metadata.dart';
 import 'package:algolia_client_composition/src/model/injected_item_metadata.dart';
@@ -223,8 +223,6 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
           as ReturnType;
     case 'FacetStats':
       return FacetStats.fromJson(value as Map<String, dynamic>) as ReturnType;
-    case 'Facets':
-      return Facets.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'GetTaskResponse':
       return GetTaskResponse.fromJson(value as Map<String, dynamic>)
           as ReturnType;
@@ -238,6 +236,9 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
     case 'HitRankingInfo':
       return HitRankingInfo.fromJson(value as Map<String, dynamic>)
           as ReturnType;
+    case 'IndexSettingsFacets':
+      return IndexSettingsFacets.fromJson(value as Map<String, dynamic>)
+          as ReturnType;
     case 'InjectedItem':
       return InjectedItem.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'InjectedItemHitsMetadata':

clients/algoliasearch-client-dart/packages/client_composition/lib/src/model/facet_ordering.dart

@@ -1,6 +1,6 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 // ignore_for_file: unused_element
-import 'package:algolia_client_composition/src/model/facets.dart';
+import 'package:algolia_client_composition/src/model/index_settings_facets.dart';
 import 'package:algolia_client_composition/src/model/value.dart';
 
 import 'package:json_annotation/json_annotation.dart';
@@ -16,7 +16,7 @@ final class FacetOrdering {
   });
 
   @JsonKey(name: r'facets')
-  final Facets? facets;
+  final IndexSettingsFacets? facets;
 
   /// Order of facet values. One object for each facet.
   @JsonKey(name: r'values')

clients/algoliasearch-client-dart/packages/client_composition/lib/src/model/facet_ordering.g.dart

@@ -3,12 +3,12 @@
 
 import 'package:json_annotation/json_annotation.dart';
 
-part 'facets.g.dart';
+part 'index_settings_facets.g.dart';
 
 @JsonSerializable()
-final class Facets {
-  /// Returns a new [Facets] instance.
-  const Facets({
+final class IndexSettingsFacets {
+  /// Returns a new [IndexSettingsFacets] instance.
+  const IndexSettingsFacets({
     this.order,
   });
 
@@ -18,14 +18,16 @@ final class Facets {
 
   @override
   bool operator ==(Object other) =>
-      identical(this, other) || other is Facets && other.order == order;
+      identical(this, other) ||
+      other is IndexSettingsFacets && other.order == order;
 
   @override
   int get hashCode => order.hashCode;
 
-  factory Facets.fromJson(Map<String, dynamic> json) => _$FacetsFromJson(json);
+  factory IndexSettingsFacets.fromJson(Map<String, dynamic> json) =>
+      _$IndexSettingsFacetsFromJson(json);
 
-  Map<String, dynamic> toJson() => _$FacetsToJson(this);
+  Map<String, dynamic> toJson() => _$IndexSettingsFacetsToJson(this);
 
   @override
   String toString() {

clients/algoliasearch-client-dart/packages/client_composition/lib/src/model/facets.dart renamed to clients/algoliasearch-client-dart/packages/client_composition/lib/src/model/index_settings_facets.dart

@@ -16,6 +16,7 @@ final class Params {
     this.page,
     this.getRankingInfo,
     this.relevancyStrictness,
+    this.facets,
     this.facetFilters,
     this.optionalFilters,
     this.numericFilters,
@@ -61,6 +62,10 @@ final class Params {
   @JsonKey(name: r'relevancyStrictness')
   final int? relevancyStrictness;
 
+  /// Facets for which to retrieve facet values that match the search criteria and the number of matching facet values To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
+  @JsonKey(name: r'facets')
+  final List<String>? facets;
+
   /// One of types:
   /// - [List<List<FacetFilters>>]
   /// - [String]
@@ -176,6 +181,7 @@ final class Params {
           other.page == page &&
           other.getRankingInfo == getRankingInfo &&
           other.relevancyStrictness == relevancyStrictness &&
+          other.facets == facets &&
           other.facetFilters == facetFilters &&
           other.optionalFilters == optionalFilters &&
           other.numericFilters == numericFilters &&
@@ -206,6 +212,7 @@ final class Params {
       page.hashCode +
       getRankingInfo.hashCode +
       relevancyStrictness.hashCode +
+      facets.hashCode +
       facetFilters.hashCode +
       optionalFilters.hashCode +
       numericFilters.hashCode +