chore: generated code for commit c91ca54f. [skip ci]

algolia/api-clients-automation@c91ca54

Co-authored-by: algolia-bot <[email protected]>
Co-authored-by: Thomas Raffray <[email protected]>
Co-authored-by: shortcuts <[email protected]>

Author: 3 people

Sources/Ingestion/IngestionClient.swift

@@ -2411,4 +2411,120 @@ open class IngestionClient {
             requestOptions: RequestOptions(headers: headers, queryParameters: queryParameters) + userRequestOptions
         )
     }
+
+    /// - parameter sourceCreate: (body)  (optional)
+    /// - returns: SourceValidateResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func validateSource(
+        sourceCreate: SourceCreate? = nil,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> SourceValidateResponse {
+        let response: Response<SourceValidateResponse> = try await validateSourceWithHTTPInfo(
+            sourceCreate: sourceCreate,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
+    // Required API Key ACLs:
+    //  - addObject
+    //  - deleteIndex
+    //  - editSettings
+    //
+    // - parameter sourceCreate: (body)  (optional)
+    // - returns: RequestBuilder<SourceValidateResponse>
+
+    open func validateSourceWithHTTPInfo(
+        sourceCreate: SourceCreate? = nil,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<SourceValidateResponse> {
+        let resourcePath = "/1/sources/validate"
+        let body = sourceCreate
+        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 sourceID: (path) Unique identifier of a source.
+    /// - parameter sourceUpdate: (body)
+    /// - returns: SourceValidateResponse
+    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
+    open func validateSourceBeforeUpdate(
+        sourceID: String,
+        sourceUpdate: SourceUpdate,
+        requestOptions: RequestOptions? = nil
+    ) async throws -> SourceValidateResponse {
+        let response: Response<SourceValidateResponse> = try await validateSourceBeforeUpdateWithHTTPInfo(
+            sourceID: sourceID,
+            sourceUpdate: sourceUpdate,
+            requestOptions: requestOptions
+        )
+
+        guard let body = response.body else {
+            throw AlgoliaError.missingData
+        }
+
+        return body
+    }
+
+    // Validates an update of a source payload to ensure it can be created and that the data source can be reached by
+    // Algolia.
+    // Required API Key ACLs:
+    //  - addObject
+    //  - deleteIndex
+    //  - editSettings
+    //
+    // - parameter sourceID: (path) Unique identifier of a source.
+    //
+    // - parameter sourceUpdate: (body)
+    // - returns: RequestBuilder<SourceValidateResponse>
+
+    open func validateSourceBeforeUpdateWithHTTPInfo(
+        sourceID: String,
+        sourceUpdate: SourceUpdate,
+        requestOptions userRequestOptions: RequestOptions? = nil
+    ) async throws -> Response<SourceValidateResponse> {
+        guard !sourceID.isEmpty else {
+            throw AlgoliaError.invalidArgument("sourceID", "validateSourceBeforeUpdate")
+        }
+
+        var resourcePath = "/1/sources/{sourceID}/validate"
+        let sourceIDPreEscape = "\(APIHelper.mapValueToPathItem(sourceID))"
+        let sourceIDPostEscape = sourceIDPreEscape
+            .addingPercentEncoding(withAllowedCharacters: .urlPathAlgoliaAllowed) ?? ""
+        resourcePath = resourcePath.replacingOccurrences(
+            of: "{sourceID}",
+            with: sourceIDPostEscape,
+            options: .literal,
+            range: nil
+        )
+        let body = sourceUpdate
+        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
+        )
+    }
 }

Sources/Ingestion/Models/SourceValidateResponse.swift

@@ -0,0 +1,60 @@
+// 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 SourceValidateResponse: Codable, JSONEncodable {
+    /// Universally unique identifier (UUID) of a task run.
+    public var runID: String?
+    /// depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
+    public var data: [AnyCodable]?
+    /// in case of error, observability events will be added to the response, if any.
+    public var events: [Event]?
+    /// a message describing the outcome of a validate run.
+    public var message: String
+
+    public init(runID: String? = nil, data: [AnyCodable]? = nil, events: [Event]? = nil, message: String) {
+        self.runID = runID
+        self.data = data
+        self.events = events
+        self.message = message
+    }
+
+    public enum CodingKeys: String, CodingKey, CaseIterable {
+        case runID
+        case data
+        case events
+        case message
+    }
+
+    // Encodable protocol methods
+
+    public func encode(to encoder: Encoder) throws {
+        var container = encoder.container(keyedBy: CodingKeys.self)
+        try container.encodeIfPresent(self.runID, forKey: .runID)
+        try container.encodeIfPresent(self.data, forKey: .data)
+        try container.encodeIfPresent(self.events, forKey: .events)
+        try container.encode(self.message, forKey: .message)
+    }
+}
+
+extension SourceValidateResponse: Equatable {
+    public static func ==(lhs: SourceValidateResponse, rhs: SourceValidateResponse) -> Bool {
+        lhs.runID == rhs.runID &&
+            lhs.data == rhs.data &&
+            lhs.events == rhs.events &&
+            lhs.message == rhs.message
+    }
+}
+
+extension SourceValidateResponse: Hashable {
+    public func hash(into hasher: inout Hasher) {
+        hasher.combine(self.runID?.hashValue)
+        hasher.combine(self.data?.hashValue)
+        hasher.combine(self.events?.hashValue)
+        hasher.combine(self.message.hashValue)
+    }
+}