feat(specs): add facets query parameter available at run time (generated)

algolia/api-clients-automation#5486

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

Author: 3 people

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';

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':

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')

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() {

packages/client_composition/lib/src/model/facets.dart renamed to 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 +