feat(specs): add v2 endpoints for ingestion

algolia/api-clients-automation#3416

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

Author: algolia-bot

Sources/Ingestion/IngestionClient.swift

@@ -2376,6 +2376,76 @@ open class IngestionClient {
         )
     }
 
+    /// - parameter taskID: (path) Unique identifier of a task.
+    /// - parameter batchWriteParams: (body) Request body of a Search API `batch` request that will be pushed in the
+    /// Connectors pipeline.
+    /// - returns: RunResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func pushTask(
+        taskID: String,
+        batchWriteParams: IngestionBatchWriteParams,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> RunResponse {
+        let response: Response<RunResponse> = try await pushTaskWithHTTPInfo(
+            taskID: taskID,
+            batchWriteParams: batchWriteParams,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the
+    // observability endpoints.
+    // Required API Key ACLs:
+    //  - addObject
+    //  - deleteIndex
+    //  - editSettings
+    //
+    // - parameter taskID: (path) Unique identifier of a task.
+    //
+    // - parameter batchWriteParams: (body) Request body of a Search API `batch` request that will be pushed in the
+    // Connectors pipeline.
+    // - returns: RequestBuilder<RunResponse>
+
+    open func pushTaskWithHTTPInfo(
+        taskID: String,
+        batchWriteParams: IngestionBatchWriteParams,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<RunResponse> {
+        guard !taskID.isEmpty else {
+            throw AlgoliaError.invalidArgument("taskID", "pushTask")
+        }
+
+        var resourcePath = "/2/tasks/{taskID}/push"
+        let taskIDPreEscape = "\(APIHelper.mapValueToPathItem(taskID))"
+        let taskIDPostEscape = taskIDPreEscape
+            .addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{taskID}",
+            with: taskIDPostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = batchWriteParams
+        let queryParameters: [String: Any?]? = nil
+
+        let nillableHeaders: [String: Any?]? = nil
+
+        let headers = APIHelper.rejectNilHeaders(nillableHeaders)
+
+        return try await self.transporter.send(
+            method: "POST",
+            path: resourcePath,
+            data: body,
+            requestOptions: RequestOptions(headers: headers, queryParameters: queryParameters) + userRequestOptions
+        )
+    }
+
     /// - parameter taskID: (path) Unique identifier of a task.
     /// - returns: RunResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)

Sources/Ingestion/Models/IngestionAction.swift

@@ -0,0 +1,20 @@
+// 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
+
+/// Type of indexing operation.
+public enum IngestionAction: String, Codable, CaseIterable {
+    case addObject
+    case updateObject
+    case partialUpdateObject
+    case partialUpdateObjectNoCreate
+    case deleteObject
+    case delete
+    case clear
+}
+
+extension IngestionAction: Hashable {}

Sources/Ingestion/Models/IngestionBatchRequest.swift

@@ -0,0 +1,45 @@
+// 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
+
+public struct IngestionBatchRequest: Codable, JSONEncodable {
+    public var action: IngestionAction
+    /// Operation arguments (varies with specified `action`).
+    public var body: AnyCodable
+
+    public init(action: IngestionAction, body: AnyCodable) {
+        self.action = action
+        self.body = body
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case action
+        case body
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.action, forKey: .action)
+        try container.encode(self.body, forKey: .body)
+    }
+}
+
+extension IngestionBatchRequest: Equatable {
+    public static func ==(lhs: IngestionBatchRequest, rhs: IngestionBatchRequest) -> Bool {
+        lhs.action == rhs.action &&
+            lhs.body == rhs.body
+    }
+}
+
+extension IngestionBatchRequest: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.action.hashValue)
+        hasher.combine(self.body.hashValue)
+    }
+}

Sources/Ingestion/Models/IngestionBatchWriteParams.swift

@@ -0,0 +1,39 @@
+// 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
+
+/// Batch parameters.
+public struct IngestionBatchWriteParams: Codable, JSONEncodable {
+    public var requests: [IngestionBatchRequest]
+
+    public init(requests: [IngestionBatchRequest]) {
+        self.requests = requests
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case requests
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.requests, forKey: .requests)
+    }
+}
+
+extension IngestionBatchWriteParams: Equatable {
+    public static func ==(lhs: IngestionBatchWriteParams, rhs: IngestionBatchWriteParams) -> Bool {
+        lhs.requests == rhs.requests
+    }
+}
+
+extension IngestionBatchWriteParams: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.requests.hashValue)
+    }
+}

Sources/Search/Extra/SearchClientExtension.swift

@@ -426,7 +426,7 @@ public extension SearchClient {
     func chunkedBatch(
         indexName: String,
         objects: [some Encodable],
-        action: Action = .addObject,
+        action: SearchAction = .addObject,
         waitForTasks: Bool = false,
         batchSize: Int = 1000,
         requestOptions: RequestOptions? = nil
@@ -439,7 +439,7 @@ public extension SearchClient {
         for batch in batches {
             let batchResponse = try await self.batch(
                 indexName: indexName,
-                batchWriteParams: BatchWriteParams(
+                batchWriteParams: SearchBatchWriteParams(
                     requests: batch.map {
                         .init(action: action, body: AnyCodable($0))
                     }

Sources/Search/Models/MultipleBatchRequest.swift

@@ -7,13 +7,13 @@ import Foundation
 #endif
 
 public struct MultipleBatchRequest: Codable, JSONEncodable {
-    public var action: Action
+    public var action: SearchAction
     /// Operation arguments (varies with specified `action`).
     public var body: AnyCodable
     /// Index name (case-sensitive).
     public var indexName: String
 
-    public init(action: Action, body: AnyCodable, indexName: String) {
+    public init(action: SearchAction, body: AnyCodable, indexName: String) {
         self.action = action
         self.body = body
         self.indexName = indexName

Sources/Search/Models/Action.swift renamed to Sources/Search/Models/SearchAction.swift

@@ -7,7 +7,7 @@ import Foundation
 #endif
 
 /// Type of indexing operation.
-public enum Action: String, Codable, CaseIterable {
+public enum SearchAction: String, Codable, CaseIterable {
     case addObject
     case updateObject
     case partialUpdateObject
@@ -17,4 +17,4 @@ public enum Action: String, Codable, CaseIterable {
     case clear
 }
 
-extension Action: Hashable {}
+extension SearchAction: Hashable {}

Sources/Search/Models/BatchRequest.swift renamed to Sources/Search/Models/SearchBatchRequest.swift

@@ -6,12 +6,12 @@ import Foundation
     import Core
 #endif
 
-public struct BatchRequest: Codable, JSONEncodable {
-    public var action: Action
+public struct SearchBatchRequest: Codable, JSONEncodable {
+    public var action: SearchAction
     /// Operation arguments (varies with specified `action`).
     public var body: AnyCodable
 
-    public init(action: Action, body: AnyCodable) {
+    public init(action: SearchAction, body: AnyCodable) {
         self.action = action
         self.body = body
     }
@@ -30,14 +30,14 @@ public struct BatchRequest: Codable, JSONEncodable {
     }
 }
 
-extension BatchRequest: Equatable {
-    public static func ==(lhs: BatchRequest, rhs: BatchRequest) -> Bool {
+extension SearchBatchRequest: Equatable {
+    public static func ==(lhs: SearchBatchRequest, rhs: SearchBatchRequest) -> Bool {
         lhs.action == rhs.action &&
             lhs.body == rhs.body
     }
 }
 
-extension BatchRequest: Hashable {
+extension SearchBatchRequest: Hashable {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(self.action.hashValue)
         hasher.combine(self.body.hashValue)

Sources/Search/Models/BatchWriteParams.swift renamed to Sources/Search/Models/SearchBatchWriteParams.swift

@@ -7,10 +7,10 @@ import Foundation
 #endif
 
 /// Batch parameters.
-public struct BatchWriteParams: Codable, JSONEncodable {
-    public var requests: [BatchRequest]
+public struct SearchBatchWriteParams: Codable, JSONEncodable {
+    public var requests: [SearchBatchRequest]
 
-    public init(requests: [BatchRequest]) {
+    public init(requests: [SearchBatchRequest]) {
         self.requests = requests
     }
 
@@ -26,13 +26,13 @@ public struct BatchWriteParams: Codable, JSONEncodable {
     }
 }
 
-extension BatchWriteParams: Equatable {
-    public static func ==(lhs: BatchWriteParams, rhs: BatchWriteParams) -> Bool {
+extension SearchBatchWriteParams: Equatable {
+    public static func ==(lhs: SearchBatchWriteParams, rhs: SearchBatchWriteParams) -> Bool {
         lhs.requests == rhs.requests
     }
 }
 
-extension BatchWriteParams: Hashable {
+extension SearchBatchWriteParams: Hashable {
     public func hash(into hasher: inout Hasher) {
         hasher.combine(self.requests.hashValue)
     }

Sources/Search/SearchClient.swift

@@ -267,7 +267,7 @@ open class SearchClient {
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
     open func batch(
         indexName: String,
-        batchWriteParams: BatchWriteParams,
+        batchWriteParams: SearchBatchWriteParams,
         requestOptions: RequestOptions? = nil
     ) async throws -> BatchResponse {
         let response: Response<BatchResponse> = try await batchWithHTTPInfo(
@@ -295,7 +295,7 @@ open class SearchClient {
 
     open func batchWithHTTPInfo(
         indexName: String,
-        batchWriteParams: BatchWriteParams,
+        batchWriteParams: SearchBatchWriteParams,
         requestOptions userRequestOptions: RequestOptions? = nil
     ) async throws -> Response<BatchResponse> {
         guard !indexName.isEmpty else {