feat(specs): add fields for metadata in composition injectedItems (#5241) (generated) [skip ci]

Co-authored-by: Gavin Wade <[email protected]>

Author: algolia-bot

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

@@ -68,6 +68,12 @@ public Hit(string objectID)
   [JsonPropertyName("_distinctSeqID")]
   public int? DistinctSeqID { get; set; }
 
+  /// <summary>
+  /// Gets or Sets Extra
+  /// </summary>
+  [JsonPropertyName("_extra")]
+  public HitMetadata Extra { get; set; }
+
   /// <summary>
   /// Gets or Sets additional properties
   /// </summary>
@@ -87,6 +93,7 @@ public override string ToString()
     sb.Append("  SnippetResult: ").Append(SnippetResult).Append("\n");
     sb.Append("  RankingInfo: ").Append(RankingInfo).Append("\n");
     sb.Append("  DistinctSeqID: ").Append(DistinctSeqID).Append("\n");
+    sb.Append("  Extra: ").Append(Extra).Append("\n");
     sb.Append("  AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
@@ -131,6 +138,7 @@ public override bool Equals(object obj)
         || (RankingInfo != null && RankingInfo.Equals(input.RankingInfo))
       )
       && (DistinctSeqID == input.DistinctSeqID || DistinctSeqID.Equals(input.DistinctSeqID))
+      && (Extra == input.Extra || (Extra != null && Extra.Equals(input.Extra)))
       && (
         AdditionalProperties.Count == input.AdditionalProperties.Count
         && !AdditionalProperties.Except(input.AdditionalProperties).Any()
@@ -163,6 +171,10 @@ public override int GetHashCode()
         hashCode = (hashCode * 59) + RankingInfo.GetHashCode();
       }
       hashCode = (hashCode * 59) + DistinctSeqID.GetHashCode();
+      if (Extra != null)
+      {
+        hashCode = (hashCode * 59) + Extra.GetHashCode();
+      }
       if (AdditionalProperties != null)
       {
         hashCode = (hashCode * 59) + AdditionalProperties.GetHashCode();

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

@@ -0,0 +1,105 @@
+//
+// 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.
+//
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using Algolia.Search.Serializer;
+
+namespace Algolia.Search.Models.Composition;
+
+/// <summary>
+/// An object that contains the extra key-value pairs provided in the injectedItem definition.
+/// </summary>
+public partial class HitMetadata
+{
+  /// <summary>
+  /// Initializes a new instance of the HitMetadata class.
+  /// </summary>
+  public HitMetadata()
+  {
+    AdditionalProperties = new Dictionary<string, object>();
+  }
+
+  /// <summary>
+  /// The key of the injectedItem that inserted this metadata.
+  /// </summary>
+  /// <value>The key of the injectedItem that inserted this metadata.</value>
+  [JsonPropertyName("_injectedItemKey")]
+  public string InjectedItemKey { get; set; }
+
+  /// <summary>
+  /// Gets or Sets additional properties
+  /// </summary>
+  [JsonExtensionData]
+  public IDictionary<string, object> AdditionalProperties { get; set; }
+
+  /// <summary>
+  /// Returns the string presentation of the object
+  /// </summary>
+  /// <returns>String presentation of the object</returns>
+  public override string ToString()
+  {
+    StringBuilder sb = new StringBuilder();
+    sb.Append("class HitMetadata {\n");
+    sb.Append("  InjectedItemKey: ").Append(InjectedItemKey).Append("\n");
+    sb.Append("  AdditionalProperties: ").Append(AdditionalProperties).Append("\n");
+    sb.Append("}\n");
+    return sb.ToString();
+  }
+
+  /// <summary>
+  /// Returns the JSON string presentation of the object
+  /// </summary>
+  /// <returns>JSON string presentation of the object</returns>
+  public virtual string ToJson()
+  {
+    return JsonSerializer.Serialize(this, JsonConfig.Options);
+  }
+
+  /// <summary>
+  /// Returns true if objects are equal
+  /// </summary>
+  /// <param name="obj">Object to be compared</param>
+  /// <returns>Boolean</returns>
+  public override bool Equals(object obj)
+  {
+    if (obj is not HitMetadata input)
+    {
+      return false;
+    }
+
+    return (
+        InjectedItemKey == input.InjectedItemKey
+        || (InjectedItemKey != null && InjectedItemKey.Equals(input.InjectedItemKey))
+      )
+      && (
+        AdditionalProperties.Count == input.AdditionalProperties.Count
+        && !AdditionalProperties.Except(input.AdditionalProperties).Any()
+      );
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (InjectedItemKey != null)
+      {
+        hashCode = (hashCode * 59) + InjectedItemKey.GetHashCode();
+      }
+      if (AdditionalProperties != null)
+      {
+        hashCode = (hashCode * 59) + AdditionalProperties.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+}

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

@@ -25,6 +25,7 @@ export 'src/model/facet_stats.dart';
 export 'src/model/facets.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/match_level.dart';
 export 'src/model/matched_geo_location.dart';

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

@@ -18,6 +18,7 @@ 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/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/match_level.dart';
 import 'package:algolia_client_composition/src/model/matched_geo_location.dart';
@@ -119,6 +120,8 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
           as ReturnType;
     case 'Hit':
       return Hit.fromJson(value as Map<String, dynamic>) as ReturnType;
+    case 'HitMetadata':
+      return HitMetadata.fromJson(value as Map<String, dynamic>) as ReturnType;
     case 'HitRankingInfo':
       return HitRankingInfo.fromJson(value as Map<String, dynamic>)
           as ReturnType;

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

@@ -1,5 +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/hit_metadata.dart';
 import 'package:algolia_client_composition/src/model/hit_ranking_info.dart';
 
 import 'package:collection/collection.dart';
@@ -16,6 +17,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
     this.snippetResult,
     this.rankingInfo,
     this.distinctSeqID,
+    this.extra,
     Map<String, dynamic> additionalProperties = const {},
   }) : super(additionalProperties);
 
@@ -37,6 +39,9 @@ final class Hit extends DelegatingMap<String, dynamic> {
   @JsonKey(name: r'_distinctSeqID')
   final int? distinctSeqID;
 
+  @JsonKey(name: r'_extra')
+  final HitMetadata? extra;
+
   @override
   bool operator ==(Object other) =>
       identical(this, other) ||
@@ -46,6 +51,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
           other.snippetResult == snippetResult &&
           other.rankingInfo == rankingInfo &&
           other.distinctSeqID == distinctSeqID &&
+          other.extra == extra &&
           const MapEquality<String, dynamic>().equals(this, this);
 
   @override
@@ -55,6 +61,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
       snippetResult.hashCode +
       rankingInfo.hashCode +
       distinctSeqID.hashCode +
+      extra.hashCode +
       const MapEquality<String, dynamic>().hash(this);
 
   factory Hit.fromJson(Map<String, dynamic> json) {
@@ -67,6 +74,7 @@ final class Hit extends DelegatingMap<String, dynamic> {
       snippetResult: instance.snippetResult,
       rankingInfo: instance.rankingInfo,
       distinctSeqID: instance.distinctSeqID,
+      extra: instance.extra,
       additionalProperties: additionalProperties,
     );
   }

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

@@ -0,0 +1,49 @@
+// 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:collection/collection.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'hit_metadata.g.dart';
+
+@JsonSerializable(createFieldMap: true)
+final class HitMetadata extends DelegatingMap<String, dynamic> {
+  /// Returns a new [HitMetadata] instance.
+  const HitMetadata({
+    this.injectedItemKey,
+    Map<String, dynamic> additionalProperties = const {},
+  }) : super(additionalProperties);
+
+  /// The key of the injectedItem that inserted this metadata.
+  @JsonKey(name: r'_injectedItemKey')
+  final String? injectedItemKey;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is HitMetadata &&
+          other.injectedItemKey == injectedItemKey &&
+          const MapEquality<String, dynamic>().equals(this, this);
+
+  @override
+  int get hashCode =>
+      injectedItemKey.hashCode +
+      const MapEquality<String, dynamic>().hash(this);
+
+  factory HitMetadata.fromJson(Map<String, dynamic> json) {
+    final instance = _$HitMetadataFromJson(json);
+    final additionalProperties = Map<String, dynamic>.from(json)
+      ..removeWhere((key, value) => _$HitMetadataFieldMap.containsKey(key));
+    return HitMetadata(
+      injectedItemKey: instance.injectedItemKey,
+      additionalProperties: additionalProperties,
+    );
+  }
+
+  Map<String, dynamic> toJson() => _$HitMetadataToJson(this)..addAll(this);
+
+  @override
+  String toString() {
+    return toJson().toString();
+  }
+}