Renamed the APIClient protocol as AmiiboClient in the library target and also, make it a public protocol.

2025-09-12 01:05:41 +02:00
parent 03fa6ee89b
commit 2f0fb0cd7f
1 changed files with 1 additions and 1 deletions
@@ -0,0 +1,92 @@
+//===----------------------------------------------------------------------===
+//
+// This source file is part of the AmiiboService open source project
+//
+// Copyright (c) 2024-2025 Röck+Cöde VoF. and the AmiiboAPI project authors
+// Licensed under the EUPL 1.2 or later.
+//
+// See LICENSE for license information
+// See CONTRIBUTORS for the list of AmiiboAPI project authors
+//
+//===----------------------------------------------------------------------===
+
+import Foundation
+
+/// A protocol that defines API clients containing all available endpoints to interact with.
+public protocol AmiiboClient {
+    
+    // MARK: Functions
+    
+#if swift(>=6.0)
+    /// Gets a list of amiibo items based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo items.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiibos(by filter: AmiiboFilter) async throws(AmiiboServiceError) -> [Amiibo]
+    
+    /// Gets a list of amiibo series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiiboSeries(by filter: AmiiboSeriesFilter) async throws(AmiiboServiceError) -> [AmiiboSeries]
+    
+    /// Gets a list of amiibo types based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo types.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiiboTypes(by filter: AmiiboTypeFilter) async throws(AmiiboServiceError) -> [AmiiboType]
+    
+    /// Gets a list of game characters based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game characters.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getGameCharacters(by filter: GameCharacterFilter) async throws(AmiiboServiceError) -> [GameCharacter]
+    
+    /// Gets a list of game series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getGameSeries(by filter: GameSeriesFilter) async throws(AmiiboServiceError) -> [GameSeries]
+    
+    /// Gets the date when the data was last updated.
+    /// - Returns: A last updated date.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getLastUpdated() async throws(AmiiboServiceError) -> Date
+#else
+    /// Gets a list of amiibo items based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo items.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiibos(by filter: AmiiboFilter) async throws -> [Amiibo]
+    
+    /// Gets a list of amiibo series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiiboSeries(by filter: AmiiboSeriesFilter) async throws -> [AmiiboSeries]
+    
+    /// Gets a list of amiibo types based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered amiibo types.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getAmiiboTypes(by filter: AmiiboTypeFilter) async throws -> [AmiiboType]
+    
+    /// Gets a list of game characters based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game characters.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getGameCharacters(by filter: GameCharacterFilter) async throws -> [GameCharacter]
+    
+    /// Gets a list of game series based on a given filter.
+    /// - Parameter filter: A filter to remove unwanted items from the result.
+    /// - Returns: A list of filtered game series.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getGameSeries(by filter: GameSeriesFilter) async throws -> [GameSeries]
+    
+    /// Gets the date when the data was last updated.
+    /// - Returns: A last updated date.
+    /// - Throws: An ``AmiiboServiceError`` error in case some issue is encountered while generating the result.
+    func getLastUpdated() async throws -> Date
+#endif
+
+}