Javier Cicchelli d8163ab0de [Bugfix] Communications (#7)
This PR contains the work done to implement some bugfixes to the existing source code related to the `Communications` library of this package.

To provide further details about the work done:
- [x] removed an unnecessary function from the `Client` public protocol;
- [x] moved the `MakeURLRequestError` public error to its own file;
- [x] added the `parameters` property to the `Endpoint` public protocol;
- [x] added support for the parameters handling in the `MakeURLRequestUseCase` use case.

Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Reviewed-on: #7
2023-04-18 22:55:25 +00:00

31 lines
1.1 KiB
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
}