This PR contains the work done to address the issue #7, related to documenting the source code that would be used for other developers. To provide further details about the work done: - [x] restructured the hierarchy of some models that are related to the `Amiibo` model; - [x] written documentation for the `AmiiboService` service; - [x] written documentation for the `AmiiboFilter` and `KeyNameFilter` filters; - [x] written documentation for the `Amiibo`, `KeyName`, `LastUpdated` and children model; - [x] written documentation for the `AmiiboClientError` error; - [x] written documentation for the README file. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #10
34 lines
967 B
Swift
34 lines
967 B
Swift
import Foundation
|
|
|
|
extension Amiibo {
|
|
/// This model struct represents a collection of official release dates (if released) of an amiibo in different markets around the world.
|
|
public struct Release {
|
|
|
|
// MARK: Properties
|
|
|
|
/// The official release date (if released) of an amiibo in Australia.
|
|
public let australia: Date?
|
|
|
|
/// The official release date (if released) of an amiibo in Europe.
|
|
public let europe: Date?
|
|
|
|
/// The official release date (if released) of an amiibo in Japan.
|
|
public let japan: Date?
|
|
|
|
/// The official release date (if released) of an amiibo in North America.
|
|
public let america: Date?
|
|
|
|
}
|
|
}
|
|
|
|
// MARK: - Decodable
|
|
|
|
extension Amiibo.Release: Decodable {
|
|
enum CodingKeys: String, CodingKey {
|
|
case australia = "au"
|
|
case europe = "eu"
|
|
case japan = "jp"
|
|
case america = "na"
|
|
}
|
|
}
|