swift-libs/Libraries/Communication/Protocols/Client.swift

//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftLibs open source project
//
// Copyright (c) 2023 Röck+Cöde VoF. and the SwiftLibs project authors
// Licensed under the EUPL 1.2 or later.
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftLibs project authors
//
//===----------------------------------------------------------------------===//

import Foundation

/// This protocol defines a client that will be making the remote calls.
public protocol Client {
    
    // MARK: Functions

    /// Makes a request to a remote location based on a given endpoint and expects to return a response casted as a given model type.
    /// - Parameters:
    ///   - endpoint: The endpoint for which to make a remote call.
    ///   - model: The model to cast an expected response from the remote location.
    /// - Returns: A casted model instance created out of a response retrieved from a call to a remote endpoint.
    func request<Model: Decodable>(
        endpoint: some Endpoint,
        as model: Model.Type
    ) async throws -> Model
    
}