feat(specs): add put task endpoint to ingestion api (generated)

algolia/api-clients-automation#5281

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

algoliasearch/Clients/IngestionClient.cs

@@ -1788,6 +1788,42 @@ WatchResponse PushTask(
     CancellationToken cancellationToken = default
   );
 
+  /// <summary>
+  /// Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+  /// </summary>
+  /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="taskReplace"></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>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>Task of TaskUpdateResponse</returns>
+  Task<TaskUpdateResponse> ReplaceTaskAsync(
+    string taskID,
+    TaskReplace taskReplace,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  );
+
+  /// <summary>
+  /// Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields. (Synchronous version)
+  /// </summary>
+  /// <param name="taskID">Unique identifier of a task.</param>
+  /// <param name="taskReplace"></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>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaApiException">Thrown when the API call was rejected by Algolia</exception>
+  /// <exception cref="Algolia.Search.Exceptions.AlgoliaUnreachableHostException">Thrown when the client failed to call the endpoint</exception>
+  /// <returns>TaskUpdateResponse</returns>
+  TaskUpdateResponse ReplaceTask(
+    string taskID,
+    TaskReplace taskReplace,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  );
+
   /// <summary>
   /// Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
   /// </summary>
@@ -2451,7 +2487,7 @@ SourceUpdateResponse UpdateSource(
   );
 
   /// <summary>
-  /// Updates a task by its ID.
+  /// Partially updates a task by its ID.
   /// </summary>
   /// <param name="taskID">Unique identifier of a task.</param>
   /// <param name="taskUpdate"></param>
@@ -2469,7 +2505,7 @@ Task<TaskUpdateResponse> UpdateTaskAsync(
   );
 
   /// <summary>
-  /// Updates a task by its ID. (Synchronous version)
+  /// Partially updates a task by its ID. (Synchronous version)
   /// </summary>
   /// <param name="taskID">Unique identifier of a task.</param>
   /// <param name="taskUpdate"></param>
@@ -4265,6 +4301,45 @@ public WatchResponse PushTask(
       PushTaskAsync(taskID, pushTaskPayload, watch, options, cancellationToken)
     );
 
+  /// <inheritdoc />
+  public async Task<TaskUpdateResponse> ReplaceTaskAsync(
+    string taskID,
+    TaskReplace taskReplace,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  )
+  {
+    if (taskID == null)
+      throw new ArgumentException("Parameter `taskID` is required when calling `ReplaceTask`.");
+
+    if (taskReplace == null)
+      throw new ArgumentException(
+        "Parameter `taskReplace` is required when calling `ReplaceTask`."
+      );
+
+    var requestOptions = new InternalRequestOptions(options);
+
+    requestOptions.PathParameters.Add("taskID", QueryStringHelper.ParameterToString(taskID));
+
+    requestOptions.Data = taskReplace;
+    return await _transport
+      .ExecuteRequestAsync<TaskUpdateResponse>(
+        new HttpMethod("PUT"),
+        "/2/tasks/{taskID}",
+        requestOptions,
+        cancellationToken
+      )
+      .ConfigureAwait(false);
+  }
+
+  /// <inheritdoc />
+  public TaskUpdateResponse ReplaceTask(
+    string taskID,
+    TaskReplace taskReplace,
+    RequestOptions options = null,
+    CancellationToken cancellationToken = default
+  ) => AsyncHelper.RunSync(() => ReplaceTaskAsync(taskID, taskReplace, options, cancellationToken));
+
   /// <inheritdoc />
   public async Task<RunSourceResponse> RunSourceAsync(
     string sourceID,

algoliasearch/Models/Ingestion/TaskReplace.cs

@@ -0,0 +1,208 @@
+//
+// 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>
+/// API request body for updating a task.
+/// </summary>
+public partial class TaskReplace
+{
+  /// <summary>
+  /// Gets or Sets Action
+  /// </summary>
+  [JsonPropertyName("action")]
+  public ActionType? Action { get; set; }
+
+  /// <summary>
+  /// Gets or Sets SubscriptionAction
+  /// </summary>
+  [JsonPropertyName("subscriptionAction")]
+  public ActionType? SubscriptionAction { get; set; }
+
+  /// <summary>
+  /// Initializes a new instance of the TaskReplace class.
+  /// </summary>
+  [JsonConstructor]
+  public TaskReplace() { }
+
+  /// <summary>
+  /// Initializes a new instance of the TaskReplace class.
+  /// </summary>
+  /// <param name="destinationID">Universally unique identifier (UUID) of a destination resource. (required).</param>
+  /// <param name="action">action (required).</param>
+  public TaskReplace(string destinationID, ActionType? action)
+  {
+    DestinationID = destinationID ?? throw new ArgumentNullException(nameof(destinationID));
+    Action = action;
+  }
+
+  /// <summary>
+  /// Universally unique identifier (UUID) of a destination resource.
+  /// </summary>
+  /// <value>Universally unique identifier (UUID) of a destination resource.</value>
+  [JsonPropertyName("destinationID")]
+  public string DestinationID { get; set; }
+
+  /// <summary>
+  /// Cron expression for the task's schedule.
+  /// </summary>
+  /// <value>Cron expression for the task's schedule.</value>
+  [JsonPropertyName("cron")]
+  public string Cron { get; set; }
+
+  /// <summary>
+  /// Whether the task is enabled.
+  /// </summary>
+  /// <value>Whether the task is enabled.</value>
+  [JsonPropertyName("enabled")]
+  public bool? Enabled { get; set; }
+
+  /// <summary>
+  /// Maximum accepted percentage of failures for a task run to finish successfully.
+  /// </summary>
+  /// <value>Maximum accepted percentage of failures for a task run to finish successfully.</value>
+  [JsonPropertyName("failureThreshold")]
+  public int? FailureThreshold { get; set; }
+
+  /// <summary>
+  /// Gets or Sets Input
+  /// </summary>
+  [JsonPropertyName("input")]
+  public TaskInput Input { get; set; }
+
+  /// <summary>
+  /// Date of the last cursor in RFC 3339 format.
+  /// </summary>
+  /// <value>Date of the last cursor in RFC 3339 format.</value>
+  [JsonPropertyName("cursor")]
+  public string Cursor { get; set; }
+
+  /// <summary>
+  /// Gets or Sets Notifications
+  /// </summary>
+  [JsonPropertyName("notifications")]
+  public Notifications Notifications { get; set; }
+
+  /// <summary>
+  /// Gets or Sets Policies
+  /// </summary>
+  [JsonPropertyName("policies")]
+  public Policies Policies { 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 TaskReplace {\n");
+    sb.Append("  DestinationID: ").Append(DestinationID).Append("\n");
+    sb.Append("  Action: ").Append(Action).Append("\n");
+    sb.Append("  SubscriptionAction: ").Append(SubscriptionAction).Append("\n");
+    sb.Append("  Cron: ").Append(Cron).Append("\n");
+    sb.Append("  Enabled: ").Append(Enabled).Append("\n");
+    sb.Append("  FailureThreshold: ").Append(FailureThreshold).Append("\n");
+    sb.Append("  Input: ").Append(Input).Append("\n");
+    sb.Append("  Cursor: ").Append(Cursor).Append("\n");
+    sb.Append("  Notifications: ").Append(Notifications).Append("\n");
+    sb.Append("  Policies: ").Append(Policies).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 TaskReplace input)
+    {
+      return false;
+    }
+
+    return (
+        DestinationID == input.DestinationID
+        || (DestinationID != null && DestinationID.Equals(input.DestinationID))
+      )
+      && (Action == input.Action || Action.Equals(input.Action))
+      && (
+        SubscriptionAction == input.SubscriptionAction
+        || SubscriptionAction.Equals(input.SubscriptionAction)
+      )
+      && (Cron == input.Cron || (Cron != null && Cron.Equals(input.Cron)))
+      && (Enabled == input.Enabled || Enabled.Equals(input.Enabled))
+      && (
+        FailureThreshold == input.FailureThreshold
+        || FailureThreshold.Equals(input.FailureThreshold)
+      )
+      && (Input == input.Input || (Input != null && Input.Equals(input.Input)))
+      && (Cursor == input.Cursor || (Cursor != null && Cursor.Equals(input.Cursor)))
+      && (
+        Notifications == input.Notifications
+        || (Notifications != null && Notifications.Equals(input.Notifications))
+      )
+      && (Policies == input.Policies || (Policies != null && Policies.Equals(input.Policies)));
+  }
+
+  /// <summary>
+  /// Gets the hash code
+  /// </summary>
+  /// <returns>Hash code</returns>
+  public override int GetHashCode()
+  {
+    unchecked // Overflow is fine, just wrap
+    {
+      int hashCode = 41;
+      if (DestinationID != null)
+      {
+        hashCode = (hashCode * 59) + DestinationID.GetHashCode();
+      }
+      hashCode = (hashCode * 59) + Action.GetHashCode();
+      hashCode = (hashCode * 59) + SubscriptionAction.GetHashCode();
+      if (Cron != null)
+      {
+        hashCode = (hashCode * 59) + Cron.GetHashCode();
+      }
+      hashCode = (hashCode * 59) + Enabled.GetHashCode();
+      hashCode = (hashCode * 59) + FailureThreshold.GetHashCode();
+      if (Input != null)
+      {
+        hashCode = (hashCode * 59) + Input.GetHashCode();
+      }
+      if (Cursor != null)
+      {
+        hashCode = (hashCode * 59) + Cursor.GetHashCode();
+      }
+      if (Notifications != null)
+      {
+        hashCode = (hashCode * 59) + Notifications.GetHashCode();
+      }
+      if (Policies != null)
+      {
+        hashCode = (hashCode * 59) + Policies.GetHashCode();
+      }
+      return hashCode;
+    }
+  }
+}

algoliasearch/Models/Ingestion/TaskUpdate.cs

@@ -12,7 +12,7 @@
 namespace Algolia.Search.Models.Ingestion;
 
 /// <summary>
-/// API request body for updating a task.
+/// API request body for partially updating a task.
 /// </summary>
 public partial class TaskUpdate
 {