javier
37c0f3e322
This PR contains the work done to: * Documented all the `private`, `internal`, and `public` interfaces on the existing codebase; * Set the DocC documentation catalog in the project; * Written the main `Library` article for the DocC documentation catalog; * Added the documentation tasks in the `Makefile` file. Reviewed-on: #4 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
46 lines
1.4 KiB
Swift
46 lines
1.4 KiB
Swift
//===----------------------------------------------------------------------===
|
|
//
|
|
// 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
|
|
//
|
|
//===----------------------------------------------------------------------===
|
|
|
|
extension Amiibo {
|
|
/// A model that represents a game related to an amiibo item.
|
|
public struct Game: Sendable {
|
|
|
|
// MARK: Properties
|
|
|
|
/// A list of identifiers.
|
|
public let identifiers: [String]
|
|
|
|
/// A name.
|
|
public let name: String
|
|
|
|
/// A list of amiibo usages, if any.
|
|
public let usages: [Usage]?
|
|
|
|
// MARK: Initializers
|
|
|
|
/// Initializes this model from a given payload.
|
|
/// - Parameter payload: A payload that contains the values for the model.
|
|
init(_ payload: Components.Schemas.AmiiboGame) {
|
|
self.identifiers = payload.gameID
|
|
self.name = payload.gameName
|
|
self.usages = {
|
|
guard let usages = payload.amiiboUsage else {
|
|
return nil
|
|
}
|
|
|
|
return usages.map { .init($0) }
|
|
}()
|
|
}
|
|
|
|
}
|
|
}
|