feat(specs): add global push endpoint (generated)

algolia/api-clients-automation#4855

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

Author: algolia-bot

Sources/Ingestion/IngestionClient.swift

@@ -2546,9 +2546,94 @@ open class IngestionClient {
         )
     }
 
+    /// - parameter indexName: (path) Name of the index on which to perform the operation.
+    /// - parameter pushTaskPayload: (body)
+    /// - parameter watch: (query) When provided, the push operation will be synchronous and the API will wait for the
+    /// ingestion to be finished before responding. (optional)
+    /// - returns: WatchResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func push(
+        indexName: String,
+        pushTaskPayload: PushTaskPayload,
+        watch: Bool? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> WatchResponse {
+        let response: Response<WatchResponse> = try await pushWithHTTPInfo(
+            indexName: indexName,
+            pushTaskPayload: pushTaskPayload,
+            watch: watch,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the
+    // `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to
+    // see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
+    // this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an
+    // `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
+    // Required API Key ACLs:
+    //  - addObject
+    //  - deleteIndex
+    //  - editSettings
+    //
+    // - parameter indexName: (path) Name of the index on which to perform the operation.
+    //
+    // - parameter pushTaskPayload: (body)
+    //
+    // - parameter watch: (query) When provided, the push operation will be synchronous and the API will wait for the
+    // ingestion to be finished before responding. (optional)
+    // - returns: RequestBuilder<WatchResponse>
+
+    open func pushWithHTTPInfo(
+        indexName: String,
+        pushTaskPayload: PushTaskPayload,
+        watch: Bool? = nil,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<WatchResponse> {
+        guard !indexName.isEmpty else {
+            throw AlgoliaError.invalidArgument("indexName", "push")
+        }
+
+        var resourcePath = "/1/push/{indexName}"
+        let indexNamePreEscape = "\(APIHelper.mapValueToPathItem(indexName))"
+        let indexNamePostEscape = indexNamePreEscape
+            .addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{indexName}",
+            with: indexNamePostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = pushTaskPayload
+        let queryParameters: [String: Any?] = [
+            "watch": watch?.encodeToJSON(),
+        ]
+
+        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,
+                readTimeout: 180,
+                writeTimeout: 180
+            ) + userRequestOptions
+        )
+    }
+
     /// - parameter taskID: (path) Unique identifier of a task.
-    /// - parameter pushTaskPayload: (body) Request body of a Search API `batch` request that will be pushed in the
-    /// Connectors pipeline.
+    /// - parameter pushTaskPayload: (body)
     /// - parameter watch: (query) When provided, the push operation will be synchronous and the API will wait for the
     /// ingestion to be finished before responding. (optional)
     /// - returns: WatchResponse
@@ -2573,17 +2658,19 @@ open class IngestionClient {
         return body
     }
 
-    // Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the
-    // observability endpoints.
+    // Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the
+    // `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to
+    // see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/),
+    // this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID`
+    // instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
     // Required API Key ACLs:
     //  - addObject
     //  - deleteIndex
     //  - editSettings
     //
     // - parameter taskID: (path) Unique identifier of a task.
     //
-    // - parameter pushTaskPayload: (body) Request body of a Search API `batch` request that will be pushed in the
-    // Connectors pipeline.
+    // - parameter pushTaskPayload: (body)
     //
     // - parameter watch: (query) When provided, the push operation will be synchronous and the API will wait for the
     // ingestion to be finished before responding. (optional)

Sources/Ingestion/Models/IngestionAction.swift

@@ -12,9 +12,6 @@ public enum IngestionAction: String, Codable, CaseIterable {
     case updateObject
     case partialUpdateObject
     case partialUpdateObjectNoCreate
-    case deleteObject
-    case delete
-    case clear
 }
 
 extension IngestionAction: Hashable {}