refactor(specs): re-organise response for Composition API (#5744) (generated) [skip ci]

Co-authored-by: Clara Muller <5667350+ClaraMuller@users.noreply.github.com>

Author: algolia-bot

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

@@ -25,16 +25,16 @@ public CompositionRunAppliedRules() { }
   /// <summary>
   /// Initializes a new instance of the CompositionRunAppliedRules class.
   /// </summary>
-  /// <param name="objectID">Unique record identifier. (required).</param>
+  /// <param name="objectID">The objectID of the applied composition rule on this query. (required).</param>
   public CompositionRunAppliedRules(string objectID)
   {
     ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
   }
 
   /// <summary>
-  /// Unique record identifier.
+  /// The objectID of the applied composition rule on this query.
   /// </summary>
-  /// <value>Unique record identifier.</value>
+  /// <value>The objectID of the applied composition rule on this query.</value>
   [JsonPropertyName("objectID")]
   public string ObjectID { get; set; }
 

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

@@ -28,17 +28,17 @@ public CompositionRunSearchResponse()
   /// <summary>
   /// Initializes a new instance of the CompositionRunSearchResponse class.
   /// </summary>
-  /// <param name="objectID">Unique record identifier. (required).</param>
+  /// <param name="objectID">The objectID of the composition which generated this result set. (required).</param>
   public CompositionRunSearchResponse(string objectID)
   {
     ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
     AdditionalProperties = new Dictionary<string, object>();
   }
 
   /// <summary>
-  /// Unique record identifier.
+  /// The objectID of the composition which generated this result set.
   /// </summary>
-  /// <value>Unique record identifier.</value>
+  /// <value>The objectID of the composition which generated this result set.</value>
   [JsonPropertyName("objectID")]
   public string ObjectID { get; set; }
 

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

@@ -25,16 +25,16 @@ public ResultsInjectedItemAppliedRulesInfoResponse() { }
   /// <summary>
   /// Initializes a new instance of the ResultsInjectedItemAppliedRulesInfoResponse class.
   /// </summary>
-  /// <param name="objectID">Unique record identifier. (required).</param>
+  /// <param name="objectID">The objectID of the applied index level rule on this injected group. (required).</param>
   public ResultsInjectedItemAppliedRulesInfoResponse(string objectID)
   {
     ObjectID = objectID ?? throw new ArgumentNullException(nameof(objectID));
   }
 
   /// <summary>
-  /// Unique record identifier.
+  /// The objectID of the applied index level rule on this injected group.
   /// </summary>
-  /// <value>Unique record identifier.</value>
+  /// <value>The objectID of the applied index level rule on this injected group.</value>
   [JsonPropertyName("objectID")]
   public string ObjectID { get; set; }
 

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

@@ -28,16 +28,17 @@ public ResultsInjectedItemInfoResponse()
   /// <summary>
   /// Initializes a new instance of the ResultsInjectedItemInfoResponse class.
   /// </summary>
-  /// <param name="key">key (required).</param>
+  /// <param name="key">The key of the injected group. (required).</param>
   public ResultsInjectedItemInfoResponse(string key)
   {
     Key = key ?? throw new ArgumentNullException(nameof(key));
     AdditionalProperties = new Dictionary<string, object>();
   }
 
   /// <summary>
-  /// Gets or Sets Key
+  /// The key of the injected group.
   /// </summary>
+  /// <value>The key of the injected group.</value>
   [JsonPropertyName("key")]
   public string Key { get; set; }
 

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

@@ -25,32 +25,32 @@ public SearchResultsItem() { }
   /// <summary>
   /// Initializes a new instance of the SearchResultsItem class.
   /// </summary>
-  /// <param name="page">The current page of the results. (required).</param>
+  /// <param name="hits">Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.  (required).</param>
+  /// <param name="hitsPerPage">Number of hits returned per page. (required).</param>
   /// <param name="nbHits">Number of results (hits). (required).</param>
   /// <param name="nbPages">Number of pages of results. (required).</param>
-  /// <param name="hitsPerPage">Number of hits returned per page. (required).</param>
-  /// <param name="hits">Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.  (required).</param>
-  /// <param name="query">The search query string. (required).</param>
+  /// <param name="page">The current page of the results. (required).</param>
   /// <param name="varParams">URL-encoded string of all search parameters. (required).</param>
+  /// <param name="query">The search query string. (required).</param>
   /// <param name="compositions">compositions (required).</param>
   public SearchResultsItem(
-    int page,
+    List<T> hits,
+    int hitsPerPage,
     int nbHits,
     int nbPages,
-    int hitsPerPage,
-    List<T> hits,
-    string query,
+    int page,
     string varParams,
+    string query,
     Dictionary<string, ResultsCompositionInfoResponse> compositions
   )
   {
-    Page = page;
+    Hits = hits ?? throw new ArgumentNullException(nameof(hits));
+    HitsPerPage = hitsPerPage;
     NbHits = nbHits;
     NbPages = nbPages;
-    HitsPerPage = hitsPerPage;
-    Hits = hits ?? throw new ArgumentNullException(nameof(hits));
-    Query = query ?? throw new ArgumentNullException(nameof(query));
+    Page = page;
     Params = varParams ?? throw new ArgumentNullException(nameof(varParams));
+    Query = query ?? throw new ArgumentNullException(nameof(query));
     Compositions = compositions ?? throw new ArgumentNullException(nameof(compositions));
   }
 
@@ -237,11 +237,18 @@ Dictionary<string, ResultsCompositionInfoResponse> compositions
   public bool? AutomaticInsights { get; set; }
 
   /// <summary>
-  /// The current page of the results.
+  /// Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
   /// </summary>
-  /// <value>The current page of the results.</value>
-  [JsonPropertyName("page")]
-  public int Page { get; set; }
+  /// <value>Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting. </value>
+  [JsonPropertyName("hits")]
+  public List<T> Hits { get; set; }
+
+  /// <summary>
+  /// Number of hits returned per page.
+  /// </summary>
+  /// <value>Number of hits returned per page.</value>
+  [JsonPropertyName("hitsPerPage")]
+  public int HitsPerPage { get; set; }
 
   /// <summary>
   /// Number of results (hits).
@@ -258,18 +265,18 @@ Dictionary<string, ResultsCompositionInfoResponse> compositions
   public int NbPages { get; set; }
 
   /// <summary>
-  /// Number of hits returned per page.
+  /// The current page of the results.
   /// </summary>
-  /// <value>Number of hits returned per page.</value>
-  [JsonPropertyName("hitsPerPage")]
-  public int HitsPerPage { get; set; }
+  /// <value>The current page of the results.</value>
+  [JsonPropertyName("page")]
+  public int Page { get; set; }
 
   /// <summary>
-  /// Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+  /// URL-encoded string of all search parameters.
   /// </summary>
-  /// <value>Search results (hits).  Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting. </value>
-  [JsonPropertyName("hits")]
-  public List<T> Hits { get; set; }
+  /// <value>URL-encoded string of all search parameters.</value>
+  [JsonPropertyName("params")]
+  public string Params { get; set; }
 
   /// <summary>
   /// The search query string.
@@ -278,13 +285,6 @@ Dictionary<string, ResultsCompositionInfoResponse> compositions
   [JsonPropertyName("query")]
   public string Query { get; set; }
 
-  /// <summary>
-  /// URL-encoded string of all search parameters.
-  /// </summary>
-  /// <value>URL-encoded string of all search parameters.</value>
-  [JsonPropertyName("params")]
-  public string Params { get; set; }
-
   /// <summary>
   /// Gets or Sets Compositions
   /// </summary>
@@ -325,13 +325,13 @@ public override string ToString()
     sb.Append("  UserData: ").Append(UserData).Append("\n");
     sb.Append("  QueryID: ").Append(QueryID).Append("\n");
     sb.Append("  AutomaticInsights: ").Append(AutomaticInsights).Append("\n");
-    sb.Append("  Page: ").Append(Page).Append("\n");
+    sb.Append("  Hits: ").Append(Hits).Append("\n");
+    sb.Append("  HitsPerPage: ").Append(HitsPerPage).Append("\n");
     sb.Append("  NbHits: ").Append(NbHits).Append("\n");
     sb.Append("  NbPages: ").Append(NbPages).Append("\n");
-    sb.Append("  HitsPerPage: ").Append(HitsPerPage).Append("\n");
-    sb.Append("  Hits: ").Append(Hits).Append("\n");
-    sb.Append("  Query: ").Append(Query).Append("\n");
+    sb.Append("  Page: ").Append(Page).Append("\n");
     sb.Append("  Params: ").Append(Params).Append("\n");
+    sb.Append("  Query: ").Append(Query).Append("\n");
     sb.Append("  Compositions: ").Append(Compositions).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
@@ -433,15 +433,15 @@ public override bool Equals(object obj)
         AutomaticInsights == input.AutomaticInsights
         || AutomaticInsights.Equals(input.AutomaticInsights)
       )
-      && (Page == input.Page || Page.Equals(input.Page))
-      && (NbHits == input.NbHits || NbHits.Equals(input.NbHits))
-      && (NbPages == input.NbPages || NbPages.Equals(input.NbPages))
-      && (HitsPerPage == input.HitsPerPage || HitsPerPage.Equals(input.HitsPerPage))
       && (
         Hits == input.Hits || Hits != null && input.Hits != null && Hits.SequenceEqual(input.Hits)
       )
-      && (Query == input.Query || (Query != null && Query.Equals(input.Query)))
+      && (HitsPerPage == input.HitsPerPage || HitsPerPage.Equals(input.HitsPerPage))
+      && (NbHits == input.NbHits || NbHits.Equals(input.NbHits))
+      && (NbPages == input.NbPages || NbPages.Equals(input.NbPages))
+      && (Page == input.Page || Page.Equals(input.Page))
       && (Params == input.Params || (Params != null && Params.Equals(input.Params)))
+      && (Query == input.Query || (Query != null && Query.Equals(input.Query)))
       && (
         Compositions == input.Compositions
         || Compositions != null
@@ -536,22 +536,22 @@ public override int GetHashCode()
         hashCode = (hashCode * 59) + QueryID.GetHashCode();
       }
       hashCode = (hashCode * 59) + AutomaticInsights.GetHashCode();
-      hashCode = (hashCode * 59) + Page.GetHashCode();
-      hashCode = (hashCode * 59) + NbHits.GetHashCode();
-      hashCode = (hashCode * 59) + NbPages.GetHashCode();
-      hashCode = (hashCode * 59) + HitsPerPage.GetHashCode();
       if (Hits != null)
       {
         hashCode = (hashCode * 59) + Hits.GetHashCode();
       }
-      if (Query != null)
-      {
-        hashCode = (hashCode * 59) + Query.GetHashCode();
-      }
+      hashCode = (hashCode * 59) + HitsPerPage.GetHashCode();
+      hashCode = (hashCode * 59) + NbHits.GetHashCode();
+      hashCode = (hashCode * 59) + NbPages.GetHashCode();
+      hashCode = (hashCode * 59) + Page.GetHashCode();
       if (Params != null)
       {
         hashCode = (hashCode * 59) + Params.GetHashCode();
       }
+      if (Query != null)
+      {
+        hashCode = (hashCode * 59) + Query.GetHashCode();
+      }
       if (Compositions != null)
       {
         hashCode = (hashCode * 59) + Compositions.GetHashCode();

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

@@ -85,12 +85,11 @@ export 'src/model/rules_multiple_batch_response.dart';
 export 'src/model/search.dart';
 export 'src/model/search_composition_rules_params.dart';
 export 'src/model/search_composition_rules_response.dart';
+export 'src/model/search_fields.dart';
 export 'src/model/search_for_facet_values_params.dart';
 export 'src/model/search_for_facet_values_request.dart';
 export 'src/model/search_for_facet_values_response.dart';
 export 'src/model/search_for_facet_values_results.dart';
-export 'src/model/search_hits.dart';
-export 'src/model/search_pagination.dart';
 export 'src/model/search_response.dart';
 export 'src/model/search_results.dart';
 export 'src/model/search_results_item.dart';

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

@@ -78,12 +78,11 @@ import 'package:algolia_client_composition/src/model/rules_multiple_batch_respon
 import 'package:algolia_client_composition/src/model/search.dart';
 import 'package:algolia_client_composition/src/model/search_composition_rules_params.dart';
 import 'package:algolia_client_composition/src/model/search_composition_rules_response.dart';
+import 'package:algolia_client_composition/src/model/search_fields.dart';
 import 'package:algolia_client_composition/src/model/search_for_facet_values_params.dart';
 import 'package:algolia_client_composition/src/model/search_for_facet_values_request.dart';
 import 'package:algolia_client_composition/src/model/search_for_facet_values_response.dart';
 import 'package:algolia_client_composition/src/model/search_for_facet_values_results.dart';
-import 'package:algolia_client_composition/src/model/search_hits.dart';
-import 'package:algolia_client_composition/src/model/search_pagination.dart';
 import 'package:algolia_client_composition/src/model/search_response.dart';
 import 'package:algolia_client_composition/src/model/search_results.dart';
 import 'package:algolia_client_composition/src/model/search_results_item.dart';
@@ -322,6 +321,8 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
     case 'SearchCompositionRulesResponse':
       return SearchCompositionRulesResponse.fromJson(
           value as Map<String, dynamic>) as ReturnType;
+    case 'SearchFields':
+      return SearchFields.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'SearchForFacetValuesParams':
       return SearchForFacetValuesParams.fromJson(value as Map<String, dynamic>)
           as ReturnType;
@@ -334,11 +335,6 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
     case 'SearchForFacetValuesResults':
       return SearchForFacetValuesResults.fromJson(value as Map<String, dynamic>)
           as ReturnType;
-    case 'SearchHits':
-      return SearchHits.fromJson(value as Map<String, dynamic>) as ReturnType;
-    case 'SearchPagination':
-      return SearchPagination.fromJson(value as Map<String, dynamic>)
-          as ReturnType;
     case 'SearchResponse':
       return SearchResponse.fromJson(value as Map<String, dynamic>)
           as ReturnType;

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

@@ -2,19 +2,16 @@
 // ignore_for_file: unused_element
 import 'package:algolia_client_composition/src/model/compositions_search_response.dart';
 
-import 'package:collection/collection.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'composition_base_search_response.g.dart';
 
-@JsonSerializable(createFieldMap: true)
-final class CompositionBaseSearchResponse
-    extends DelegatingMap<String, dynamic> {
+@JsonSerializable()
+final class CompositionBaseSearchResponse {
   /// Returns a new [CompositionBaseSearchResponse] instance.
   const CompositionBaseSearchResponse({
     this.compositions,
-    Map<String, dynamic> additionalProperties = const {},
-  }) : super(additionalProperties);
+  });
 
   @JsonKey(name: r'compositions')
   final CompositionsSearchResponse? compositions;
@@ -23,26 +20,15 @@ final class CompositionBaseSearchResponse
   bool operator ==(Object other) =>
       identical(this, other) ||
       other is CompositionBaseSearchResponse &&
-          other.compositions == compositions &&
-          const MapEquality<String, dynamic>().equals(this, this);
+          other.compositions == compositions;
 
   @override
-  int get hashCode =>
-      compositions.hashCode + const MapEquality<String, dynamic>().hash(this);
-
-  factory CompositionBaseSearchResponse.fromJson(Map<String, dynamic> json) {
-    final instance = _$CompositionBaseSearchResponseFromJson(json);
-    final additionalProperties = Map<String, dynamic>.from(json)
-      ..removeWhere((key, value) =>
-          _$CompositionBaseSearchResponseFieldMap.containsKey(key));
-    return CompositionBaseSearchResponse(
-      compositions: instance.compositions,
-      additionalProperties: additionalProperties,
-    );
-  }
+  int get hashCode => compositions.hashCode;
+
+  factory CompositionBaseSearchResponse.fromJson(Map<String, dynamic> json) =>
+      _$CompositionBaseSearchResponseFromJson(json);
 
-  Map<String, dynamic> toJson() =>
-      _$CompositionBaseSearchResponseToJson(this)..addAll(this);
+  Map<String, dynamic> toJson() => _$CompositionBaseSearchResponseToJson(this);
 
   @override
   String toString() {

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

@@ -12,7 +12,7 @@ final class CompositionRunAppliedRules {
     required this.objectID,
   });
 
-  /// Unique record identifier.
+  /// The objectID of the applied composition rule on this query.
   @JsonKey(name: r'objectID')
   final String objectID;