diff --git a/Sources/Public/Filters/AmiiboFilter.swift b/Sources/Public/Filters/AmiiboFilter.swift index 45b9186..6712ae7 100644 --- a/Sources/Public/Filters/AmiiboFilter.swift +++ b/Sources/Public/Filters/AmiiboFilter.swift @@ -10,21 +10,47 @@ // //===----------------------------------------------------------------------=== +/// A type that contains values to fine-tune a response when requesting amiibo items. public struct AmiiboFilter { // MARK: Properties + /// A game character to return, if any. public let gameCharacter: String? + + /// A game series to return, if any. public let gameSeries: String? + + /// An amiibo identifier to return, if any. public let identifier: String? + + /// An amiibo name to return, if any. public let name: String? + + /// An amiibo series to return, if any. public let series: String? + + /// A flag indicating whether to include games in the response, if any. public let showGames: Bool? + + /// A flag indicating whether to include amiibo usages in games in the response, if any. public let showUsage: Bool? + + /// An amiibo type to return, if any. public let type: String? - // MARK: Initialisers + // MARK: Initializers + /// Initializes this filter. + /// - Parameters: + /// - identifier: An amiibo identifier to return, if any. + /// - name: An amiibo name to return, if any. + /// - type: An amiibo type to return, if any. + /// - series: An amiibo series to return, if any. + /// - gameCharacter: A game character to return, if any. + /// - gameSeries: A game series to return, if any. + /// - showGames: A flag indicating whether to include games in the response, if any. + /// - showUsage: A flag indicating whether to include amiibo usages in games in the response, if any. public init( identifier: String? = nil, name: String? = nil, diff --git a/Sources/Public/Filters/AmiiboSeriesFilter.swift b/Sources/Public/Filters/AmiiboSeriesFilter.swift index c10f4dc..3df3abe 100644 --- a/Sources/Public/Filters/AmiiboSeriesFilter.swift +++ b/Sources/Public/Filters/AmiiboSeriesFilter.swift @@ -10,6 +10,7 @@ // //===----------------------------------------------------------------------=== +/// A type that contains values to fine-tune a response when requesting amiibo series. public struct AmiiboSeriesFilter: KeyNameFilter { // MARK: Properties @@ -17,7 +18,7 @@ public struct AmiiboSeriesFilter: KeyNameFilter { public let key: String? public let name: String? - // MARK: Initialisers + // MARK: Initializers public init() { self.key = nil diff --git a/Sources/Public/Filters/AmiiboTypeFilter.swift b/Sources/Public/Filters/AmiiboTypeFilter.swift index 04d709a..11a6ae3 100644 --- a/Sources/Public/Filters/AmiiboTypeFilter.swift +++ b/Sources/Public/Filters/AmiiboTypeFilter.swift @@ -10,6 +10,7 @@ // //===----------------------------------------------------------------------=== +/// A type that contains values to fine-tune a response when requesting amiibo types. public struct AmiiboTypeFilter: KeyNameFilter { // MARK: Properties @@ -17,7 +18,7 @@ public struct AmiiboTypeFilter: KeyNameFilter { public let key: String? public let name: String? - // MARK: Initialisers + // MARK: Initializers public init() { self.key = nil diff --git a/Sources/Public/Filters/GameCharacterFilter.swift b/Sources/Public/Filters/GameCharacterFilter.swift index 27a2ddf..3298feb 100644 --- a/Sources/Public/Filters/GameCharacterFilter.swift +++ b/Sources/Public/Filters/GameCharacterFilter.swift @@ -10,6 +10,7 @@ // //===----------------------------------------------------------------------=== +/// A type that contains values to fine-tune a response when requesting game characters. public struct GameCharacterFilter: KeyNameFilter { // MARK: Properties @@ -17,7 +18,7 @@ public struct GameCharacterFilter: KeyNameFilter { public let key: String? public let name: String? - // MARK: Initialisers + // MARK: Initializers public init() { self.key = nil diff --git a/Sources/Public/Filters/GameSeriesFilter.swift b/Sources/Public/Filters/GameSeriesFilter.swift index 837a5bb..d45a73f 100644 --- a/Sources/Public/Filters/GameSeriesFilter.swift +++ b/Sources/Public/Filters/GameSeriesFilter.swift @@ -10,6 +10,7 @@ // //===----------------------------------------------------------------------=== +/// A type that contains values to fine-tune a response when requesting game series. public struct GameSeriesFilter: KeyNameFilter { // MARK: Properties @@ -17,7 +18,7 @@ public struct GameSeriesFilter: KeyNameFilter { public let key: String? public let name: String? - // MARK: Initialisers + // MARK: Initializers public init() { self.key = nil