feat(specs): document runMetadata parameter (generated)

algolia/api-clients-automation#5087

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Devin Beeuwkes <[email protected]>

Author: algolia-bot

algoliasearch/Clients/IngestionClient.cs

@@ -1843,6 +1843,7 @@ RunSourceResponse RunSource(
   ///   - deleteIndex
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="runTaskPayload"> (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1851,6 +1852,7 @@ RunSourceResponse RunSource(
   /// <returns>Task of RunResponse</returns>
   Task<RunResponse> RunTaskAsync(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1864,6 +1866,7 @@ Task<RunResponse> RunTaskAsync(
   ///   - deleteIndex
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="runTaskPayload"> (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1872,6 +1875,7 @@ Task<RunResponse> RunTaskAsync(
   /// <returns>RunResponse</returns>
   RunResponse RunTask(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1885,6 +1889,7 @@ RunResponse RunTask(
   ///   - deleteIndex
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="runTaskPayload"> (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1894,6 +1899,7 @@ RunResponse RunTask(
   [Obsolete]
   Task<RunResponse> RunTaskV1Async(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -1907,6 +1913,7 @@ Task<RunResponse> RunTaskV1Async(
   ///   - deleteIndex
   ///   - editSettings
   /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="runTaskPayload"> (optional)</param>
   /// <param name="options">Add extra http header or query parameters to Algolia.</param>
   /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
   /// <exception cref="ArgumentException">Thrown when arguments are not correct</exception>
@@ -1916,6 +1923,7 @@ Task<RunResponse> RunTaskV1Async(
   [Obsolete]
   RunResponse RunTaskV1(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   );
@@ -4297,6 +4305,7 @@ public RunSourceResponse RunSource(
   /// <inheritdoc />
   public async Task<RunResponse> RunTaskAsync(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   )
@@ -4308,6 +4317,7 @@ public async Task<RunResponse> RunTaskAsync(
 
     requestOptions.PathParameters.Add("taskID", QueryStringHelper.ParameterToString(taskID));
 
+    requestOptions.Data = runTaskPayload;
     return await _transport
       .ExecuteRequestAsync<RunResponse>(
         new HttpMethod("POST"),
@@ -4321,14 +4331,16 @@ public async Task<RunResponse> RunTaskAsync(
   /// <inheritdoc />
   public RunResponse RunTask(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
-  ) => AsyncHelper.RunSync(() => RunTaskAsync(taskID, options, cancellationToken));
+  ) => AsyncHelper.RunSync(() => RunTaskAsync(taskID, runTaskPayload, options, cancellationToken));
 
   /// <inheritdoc />
   [Obsolete]
   public async Task<RunResponse> RunTaskV1Async(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
   )
@@ -4340,6 +4352,7 @@ public async Task<RunResponse> RunTaskV1Async(
 
     requestOptions.PathParameters.Add("taskID", QueryStringHelper.ParameterToString(taskID));
 
+    requestOptions.Data = runTaskPayload;
     return await _transport
       .ExecuteRequestAsync<RunResponse>(
         new HttpMethod("POST"),
@@ -4354,9 +4367,11 @@ public async Task<RunResponse> RunTaskV1Async(
   [Obsolete]
   public RunResponse RunTaskV1(
     string taskID,
+    RunTaskPayload runTaskPayload = default,
     RequestOptions options = null,
     CancellationToken cancellationToken = default
-  ) => AsyncHelper.RunSync(() => RunTaskV1Async(taskID, options, cancellationToken));
+  ) =>
+    AsyncHelper.RunSync(() => RunTaskV1Async(taskID, runTaskPayload, options, cancellationToken));
 
   /// <inheritdoc />
   public async Task<List<Authentication>> SearchAuthenticationsAsync(

algoliasearch/Models/Ingestion/RunSourcePayload.cs

@@ -48,6 +48,13 @@ public RunSourcePayload() { }
   [JsonPropertyName("entityIDs")]
   public List<string> EntityIDs { get; set; }
 
+  /// <summary>
+  /// Additional information that will be passed to the created runs.
+  /// </summary>
+  /// <value>Additional information that will be passed to the created runs.</value>
+  [JsonPropertyName("runMetadata")]
+  public Dictionary<string, object> RunMetadata { get; set; }
+
   /// <summary>
   /// Returns the string presentation of the object
   /// </summary>
@@ -60,6 +67,7 @@ public override string ToString()
     sb.Append("  IndexToExclude: ").Append(IndexToExclude).Append("\n");
     sb.Append("  EntityIDs: ").Append(EntityIDs).Append("\n");
     sb.Append("  EntityType: ").Append(EntityType).Append("\n");
+    sb.Append("  RunMetadata: ").Append(RunMetadata).Append("\n");
     sb.Append("}\n");
     return sb.ToString();
   }
@@ -101,7 +109,13 @@ public override bool Equals(object obj)
         EntityIDs == input.EntityIDs
         || EntityIDs != null && input.EntityIDs != null && EntityIDs.SequenceEqual(input.EntityIDs)
       )
-      && (EntityType == input.EntityType || EntityType.Equals(input.EntityType));
+      && (EntityType == input.EntityType || EntityType.Equals(input.EntityType))
+      && (
+        RunMetadata == input.RunMetadata
+        || RunMetadata != null
+          && input.RunMetadata != null
+          && RunMetadata.SequenceEqual(input.RunMetadata)
+      );
   }
 
   /// <summary>
@@ -126,6 +140,10 @@ public override int GetHashCode()
         hashCode = (hashCode * 59) + EntityIDs.GetHashCode();
       }
       hashCode = (hashCode * 59) + EntityType.GetHashCode();
+      if (RunMetadata != null)
+      {
+        hashCode = (hashCode * 59) + RunMetadata.GetHashCode();
+      }
       return hashCode;
     }
   }

algoliasearch/Models/Ingestion/RunTaskPayload.cs

@@ -0,0 +1,89 @@
+//
+// 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.Ingestion;
+
+/// <summary>
+/// RunTaskPayload
+/// </summary>
+public partial class RunTaskPayload
+{
+  /// <summary>
+  /// Initializes a new instance of the RunTaskPayload class.
+  /// </summary>
+  public RunTaskPayload() { }
+
+  /// <summary>
+  /// Additional information that will be passed to the created run.
+  /// </summary>
+  /// <value>Additional information that will be passed to the created run.</value>
+  [JsonPropertyName("runMetadata")]
+  public Dictionary<string, object> RunMetadata { 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 RunTaskPayload {\n");
+    sb.Append("  RunMetadata: ").Append(RunMetadata).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 RunTaskPayload input)
+    {
+      return false;
+    }
+
+    return (
+      RunMetadata == input.RunMetadata
+      || RunMetadata != null
+        && input.RunMetadata != null
+        && RunMetadata.SequenceEqual(input.RunMetadata)
+    );
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (RunMetadata != null)
+      {
+        hashCode = (hashCode * 59) + RunMetadata.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+}