feat(specs): add runSource endpoint (generated)

algolia/api-clients-automation#3453

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Pierre Millot <[email protected]>

Author: algolia-bot

Sources/Ingestion/IngestionClient.swift

@@ -2446,6 +2446,73 @@ open class IngestionClient {
         )
     }
 
+    /// - parameter sourceID: (path) Unique identifier of a source.
+    /// - parameter runSourcePayload: (body)  (optional)
+    /// - returns: RunSourceResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func runSource(
+        sourceID: String,
+        runSourcePayload: RunSourcePayload? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> RunSourceResponse {
+        let response: Response<RunSourceResponse> = try await runSourceWithHTTPInfo(
+            sourceID: sourceID,
+            runSourcePayload: runSourcePayload,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
+    // Required API Key ACLs:
+    //  - addObject
+    //  - deleteIndex
+    //  - editSettings
+    //
+    // - parameter sourceID: (path) Unique identifier of a source.
+    //
+    // - parameter runSourcePayload: (body)  (optional)
+    // - returns: RequestBuilder<RunSourceResponse>
+
+    open func runSourceWithHTTPInfo(
+        sourceID: String,
+        runSourcePayload: RunSourcePayload? = nil,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<RunSourceResponse> {
+        guard !sourceID.isEmpty else {
+            throw AlgoliaError.invalidArgument("sourceID", "runSource")
+        }
+
+        var resourcePath = "/1/sources/{sourceID}/run"
+        let sourceIDPreEscape = "\(APIHelper.mapValueToPathItem(sourceID))"
+        let sourceIDPostEscape = sourceIDPreEscape
+            .addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{sourceID}",
+            with: sourceIDPostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = runSourcePayload
+        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 ?? AnyCodable(),
+            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/EntityType.swift

@@ -0,0 +1,15 @@
+// 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 entity to update.
+public enum EntityType: String, Codable, CaseIterable {
+    case product
+    case collection
+}
+
+extension EntityType: Hashable {}

Sources/Ingestion/Models/RunSourcePayload.swift

@@ -0,0 +1,64 @@
+// 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 RunSourcePayload: Codable, JSONEncodable {
+    /// List of index names to include in reidexing/update.
+    public var indexToInclude: [String]?
+    /// List of index names to exclude in reidexing/update.
+    public var indexToExclude: [String]?
+    /// List of entityID to update.
+    public var entityIDs: [String]?
+    public var entityType: EntityType?
+
+    public init(
+        indexToInclude: [String]? = nil,
+        indexToExclude: [String]? = nil,
+        entityIDs: [String]? = nil,
+        entityType: EntityType? = nil
+    ) {
+        self.indexToInclude = indexToInclude
+        self.indexToExclude = indexToExclude
+        self.entityIDs = entityIDs
+        self.entityType = entityType
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case indexToInclude
+        case indexToExclude
+        case entityIDs
+        case entityType
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.indexToInclude, forKey: .indexToInclude)
+        try container.encodeIfPresent(self.indexToExclude, forKey: .indexToExclude)
+        try container.encodeIfPresent(self.entityIDs, forKey: .entityIDs)
+        try container.encodeIfPresent(self.entityType, forKey: .entityType)
+    }
+}
+
+extension RunSourcePayload: Equatable {
+    public static func ==(lhs: RunSourcePayload, rhs: RunSourcePayload) -> Bool {
+        lhs.indexToInclude == rhs.indexToInclude &&
+            lhs.indexToExclude == rhs.indexToExclude &&
+            lhs.entityIDs == rhs.entityIDs &&
+            lhs.entityType == rhs.entityType
+    }
+}
+
+extension RunSourcePayload: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.indexToInclude?.hashValue)
+        hasher.combine(self.indexToExclude?.hashValue)
+        hasher.combine(self.entityIDs?.hashValue)
+        hasher.combine(self.entityType?.hashValue)
+    }
+}

Sources/Ingestion/Models/RunSourceResponse.swift

@@ -0,0 +1,46 @@
+// 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 RunSourceResponse: Codable, JSONEncodable {
+    /// Map of taskID sent for reindex with the corresponding runID.
+    public var taskWithRunID: [String: String]
+    /// Date of creation in RFC 3339 format.
+    public var createdAt: String
+
+    public init(taskWithRunID: [String: String], createdAt: String) {
+        self.taskWithRunID = taskWithRunID
+        self.createdAt = createdAt
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case taskWithRunID
+        case createdAt
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encode(self.taskWithRunID, forKey: .taskWithRunID)
+        try container.encode(self.createdAt, forKey: .createdAt)
+    }
+}
+
+extension RunSourceResponse: Equatable {
+    public static func ==(lhs: RunSourceResponse, rhs: RunSourceResponse) -> Bool {
+        lhs.taskWithRunID == rhs.taskWithRunID &&
+            lhs.createdAt == rhs.createdAt
+    }
+}
+
+extension RunSourceResponse: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.taskWithRunID.hashValue)
+        hasher.combine(self.createdAt.hashValue)
+    }
+}