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

Sources/Ingestion/IngestionClient.swift

@@ -2724,6 +2724,72 @@ open class IngestionClient {
         )
     }
 
+    /// - parameter taskID: (path) Unique identifier of a task.
+    /// - parameter taskReplace: (body)
+    /// - returns: TaskUpdateResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func replaceTask(
+        taskID: String,
+        taskReplace: TaskReplace,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> TaskUpdateResponse {
+        let response: Response<TaskUpdateResponse> = try await replaceTaskWithHTTPInfo(
+            taskID: taskID,
+            taskReplace: taskReplace,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+    //
+    //
+    // - parameter taskID: (path) Unique identifier of a task.
+    //
+    // - parameter taskReplace: (body)
+    // - returns: RequestBuilder<TaskUpdateResponse>
+
+    open func replaceTaskWithHTTPInfo(
+        taskID: String,
+        taskReplace: TaskReplace,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<TaskUpdateResponse> {
+        guard !taskID.isEmpty else {
+            throw AlgoliaError.invalidArgument("taskID", "replaceTask")
+        }
+
+        var resourcePath = "/2/tasks/{taskID}"
+        let taskIDPreEscape = "\(APIHelper.mapValueToPathItem(taskID))"
+        let taskIDPostEscape = taskIDPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{taskID}",
+            with: taskIDPostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = taskReplace
+        let queryParameters: [String: Any?]? = nil
+
+        let nillableHeaders: [String: Any?]? = nil
+
+        let headers = APIHelper.rejectNilHeaders(nillableHeaders)
+
+        return try await self.transporter.send(
+            method: "PUT",
+            path: resourcePath,
+            data: body,
+            requestOptions: RequestOptions(
+                headers: headers,
+                queryParameters: queryParameters
+            ) + userRequestOptions
+        )
+    }
+
     /// - parameter sourceID: (path) Unique identifier of a source.
     /// - parameter runSourcePayload: (body)  (optional)
     /// - returns: RunSourceResponse
@@ -3661,7 +3727,7 @@ open class IngestionClient {
         return body
     }
 
-    // Updates a task by its ID.
+    // Partially updates a task by its ID.
     //
     //
     // - parameter taskID: (path) Unique identifier of a task.

Sources/Ingestion/Models/TaskReplace.swift

@@ -0,0 +1,109 @@
+// 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.
+
+import Foundation
+#if canImport(Core)
+    import Core
+#endif
+
+/// API request body for updating a task.
+public struct TaskReplace: Codable, JSONEncodable {
+    /// Universally unique identifier (UUID) of a destination resource.
+    public var destinationID: String
+    public var action: ActionType
+    public var subscriptionAction: ActionType?
+    /// Cron expression for the task's schedule.
+    public var cron: String?
+    /// Whether the task is enabled.
+    public var enabled: Bool?
+    /// Maximum accepted percentage of failures for a task run to finish successfully.
+    public var failureThreshold: Int?
+    public var input: TaskInput?
+    /// Date of the last cursor in RFC 3339 format.
+    public var cursor: String?
+    public var notifications: Notifications?
+    public var policies: Policies?
+
+    public init(
+        destinationID: String,
+        action: ActionType,
+        subscriptionAction: ActionType? = nil,
+        cron: String? = nil,
+        enabled: Bool? = nil,
+        failureThreshold: Int? = nil,
+        input: TaskInput? = nil,
+        cursor: String? = nil,
+        notifications: Notifications? = nil,
+        policies: Policies? = nil
+    ) {
+        self.destinationID = destinationID
+        self.action = action
+        self.subscriptionAction = subscriptionAction
+        self.cron = cron
+        self.enabled = enabled
+        self.failureThreshold = failureThreshold
+        self.input = input
+        self.cursor = cursor
+        self.notifications = notifications
+        self.policies = policies
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case destinationID
+        case action
+        case subscriptionAction
+        case cron
+        case enabled
+        case failureThreshold
+        case input
+        case cursor
+        case notifications
+        case policies
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.destinationID, forKey: .destinationID)
+        try container.encode(self.action, forKey: .action)
+        try container.encodeIfPresent(self.subscriptionAction, forKey: .subscriptionAction)
+        try container.encodeIfPresent(self.cron, forKey: .cron)
+        try container.encodeIfPresent(self.enabled, forKey: .enabled)
+        try container.encodeIfPresent(self.failureThreshold, forKey: .failureThreshold)
+        try container.encodeIfPresent(self.input, forKey: .input)
+        try container.encodeIfPresent(self.cursor, forKey: .cursor)
+        try container.encodeIfPresent(self.notifications, forKey: .notifications)
+        try container.encodeIfPresent(self.policies, forKey: .policies)
+    }
+}
+
+extension TaskReplace: Equatable {
+    public static func ==(lhs: TaskReplace, rhs: TaskReplace) -> Bool {
+        lhs.destinationID == rhs.destinationID &&
+            lhs.action == rhs.action &&
+            lhs.subscriptionAction == rhs.subscriptionAction &&
+            lhs.cron == rhs.cron &&
+            lhs.enabled == rhs.enabled &&
+            lhs.failureThreshold == rhs.failureThreshold &&
+            lhs.input == rhs.input &&
+            lhs.cursor == rhs.cursor &&
+            lhs.notifications == rhs.notifications &&
+            lhs.policies == rhs.policies
+    }
+}
+
+extension TaskReplace: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.destinationID.hashValue)
+        hasher.combine(self.action.hashValue)
+        hasher.combine(self.subscriptionAction?.hashValue)
+        hasher.combine(self.cron?.hashValue)
+        hasher.combine(self.enabled?.hashValue)
+        hasher.combine(self.failureThreshold?.hashValue)
+        hasher.combine(self.input?.hashValue)
+        hasher.combine(self.cursor?.hashValue)
+        hasher.combine(self.notifications?.hashValue)
+        hasher.combine(self.policies?.hashValue)
+    }
+}

Sources/Ingestion/Models/TaskUpdate.swift

@@ -6,7 +6,7 @@ import Foundation
     import Core
 #endif
 
-/// API request body for updating a task.
+/// API request body for partially updating a task.
 public struct TaskUpdate: Codable, JSONEncodable {
     /// Universally unique identifier (UUID) of a destination resource.
     public var destinationID: String?