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

Sources/Ingestion/IngestionClient.swift

@@ -2805,11 +2805,17 @@ open class IngestionClient {
     }
 
     /// - parameter taskID: (path) Unique identifier of a task.
+    /// - parameter runTaskPayload: (body)  (optional)
     /// - returns: RunResponse
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
-    open func runTask(taskID: String, requestOptions: RequestOptions? = nil) async throws -> RunResponse {
+    open func runTask(
+        taskID: String,
+        runTaskPayload: RunTaskPayload? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> RunResponse {
         let response: Response<RunResponse> = try await runTaskWithHTTPInfo(
             taskID: taskID,
+            runTaskPayload: runTaskPayload,
             requestOptions: requestOptions
         )
 
@@ -2827,10 +2833,13 @@ open class IngestionClient {
     //  - editSettings
     //
     // - parameter taskID: (path) Unique identifier of a task.
+    //
+    // - parameter runTaskPayload: (body)  (optional)
     // - returns: RequestBuilder<RunResponse>
 
     open func runTaskWithHTTPInfo(
         taskID: String,
+        runTaskPayload: RunTaskPayload? = nil,
         requestOptions userRequestOptions: RequestOptions? = nil
     ) async throws -> Response<RunResponse> {
         guard !taskID.isEmpty else {
@@ -2847,7 +2856,7 @@ open class IngestionClient {
             options: .literal,
             range: nil
         )
-        let body: AnyCodable? = nil
+        let body = runTaskPayload
         let queryParameters: [String: Any?]? = nil
 
         let nillableHeaders: [String: Any?]? = nil
@@ -2857,7 +2866,7 @@ open class IngestionClient {
         return try await self.transporter.send(
             method: "POST",
             path: resourcePath,
-            data: body,
+            data: body ?? AnyCodable(),
             requestOptions: RequestOptions(
                 headers: headers,
                 queryParameters: queryParameters
@@ -2866,12 +2875,18 @@ open class IngestionClient {
     }
 
     /// - parameter taskID: (path) Unique identifier of a task.
+    /// - parameter runTaskPayload: (body)  (optional)
     /// - returns: RunResponse
     @available(*, deprecated, message: "This operation is deprecated.")
     @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
-    open func runTaskV1(taskID: String, requestOptions: RequestOptions? = nil) async throws -> RunResponse {
+    open func runTaskV1(
+        taskID: String,
+        runTaskPayload: RunTaskPayload? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> RunResponse {
         let response: Response<RunResponse> = try await runTaskV1WithHTTPInfo(
             taskID: taskID,
+            runTaskPayload: runTaskPayload,
             requestOptions: requestOptions
         )
 
@@ -2890,11 +2905,14 @@ open class IngestionClient {
     ///  - editSettings
     ///
     /// - parameter taskID: (path) Unique identifier of a task.
+    ///
+    /// - parameter runTaskPayload: (body)  (optional)
     /// - returns: RequestBuilder<RunResponse>
     @available(*, deprecated, message: "This operation is deprecated.")
 
     open func runTaskV1WithHTTPInfo(
         taskID: String,
+        runTaskPayload: RunTaskPayload? = nil,
         requestOptions userRequestOptions: RequestOptions? = nil
     ) async throws -> Response<RunResponse> {
         guard !taskID.isEmpty else {
@@ -2911,7 +2929,7 @@ open class IngestionClient {
             options: .literal,
             range: nil
         )
-        let body: AnyCodable? = nil
+        let body = runTaskPayload
         let queryParameters: [String: Any?]? = nil
 
         let nillableHeaders: [String: Any?]? = nil
@@ -2921,7 +2939,7 @@ open class IngestionClient {
         return try await self.transporter.send(
             method: "POST",
             path: resourcePath,
-            data: body,
+            data: body ?? AnyCodable(),
             requestOptions: RequestOptions(
                 headers: headers,
                 queryParameters: queryParameters

Sources/Ingestion/Models/RunSourcePayload.swift

@@ -14,24 +14,29 @@ public struct RunSourcePayload: Codable, JSONEncodable {
     /// List of entityIDs to update.
     public var entityIDs: [String]?
     public var entityType: EntityType?
+    /// Additional information that will be passed to the created runs.
+    public var runMetadata: [String: AnyCodable]?
 
     public init(
         indexToInclude: [String]? = nil,
         indexToExclude: [String]? = nil,
         entityIDs: [String]? = nil,
-        entityType: EntityType? = nil
+        entityType: EntityType? = nil,
+        runMetadata: [String: AnyCodable]? = nil
     ) {
         self.indexToInclude = indexToInclude
         self.indexToExclude = indexToExclude
         self.entityIDs = entityIDs
         self.entityType = entityType
+        self.runMetadata = runMetadata
     }
 
     public enum CodingKeys: String, CodingKey, CaseIterable {
         case indexToInclude
         case indexToExclude
         case entityIDs
         case entityType
+        case runMetadata
     }
 
     // Encodable protocol methods
@@ -42,6 +47,7 @@ public struct RunSourcePayload: Codable, JSONEncodable {
         try container.encodeIfPresent(self.indexToExclude, forKey: .indexToExclude)
         try container.encodeIfPresent(self.entityIDs, forKey: .entityIDs)
         try container.encodeIfPresent(self.entityType, forKey: .entityType)
+        try container.encodeIfPresent(self.runMetadata, forKey: .runMetadata)
     }
 }
 
@@ -50,7 +56,8 @@ extension RunSourcePayload: Equatable {
         lhs.indexToInclude == rhs.indexToInclude &&
             lhs.indexToExclude == rhs.indexToExclude &&
             lhs.entityIDs == rhs.entityIDs &&
-            lhs.entityType == rhs.entityType
+            lhs.entityType == rhs.entityType &&
+            lhs.runMetadata == rhs.runMetadata
     }
 }
 
@@ -60,5 +67,6 @@ extension RunSourcePayload: Hashable {
         hasher.combine(self.indexToExclude?.hashValue)
         hasher.combine(self.entityIDs?.hashValue)
         hasher.combine(self.entityType?.hashValue)
+        hasher.combine(self.runMetadata?.hashValue)
     }
 }

Sources/Ingestion/Models/RunTaskPayload.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
+
+public struct RunTaskPayload: Codable, JSONEncodable {
+    /// Additional information that will be passed to the created run.
+    public var runMetadata: [String: AnyCodable]?
+
+    public init(runMetadata: [String: AnyCodable]? = nil) {
+        self.runMetadata = runMetadata
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case runMetadata
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.runMetadata, forKey: .runMetadata)
+    }
+}
+
+extension RunTaskPayload: Equatable {
+    public static func ==(lhs: RunTaskPayload, rhs: RunTaskPayload) -> Bool {
+        lhs.runMetadata == rhs.runMetadata
+    }
+}
+
+extension RunTaskPayload: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.runMetadata?.hashValue)
+    }
+}