amiibo-service/docs/data/documentation/amiiboservice/dto/amiibo.json

{"seeAlsoSections":[{"title":"Models","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/KeyName","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Character","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/GameSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/LastUpdated"],"generated":true}],"schemaVersion":{"major":0,"minor":3,"patch":0},"metadata":{"navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"role":"symbol","title":"DTO.Amiibo","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"symbolKind":"struct","externalID":"s:13AmiiboService3DTOO0A0V","extendedModule":"AmiiboService","modules":[{"name":"AmiiboService"}]},"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"sections":[],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo","interfaceLanguage":"swift"},"relationshipsSections":[{"identifiers":["doc:\/\/AmiiboService\/Se","doc:\/\/AmiiboService\/SE"],"kind":"relationships","title":"Conforms To","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"topicSections":[{"title":"Structures","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Game","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Games-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Release-swift.struct"]},{"title":"Instance Properties","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/character","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/gameSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/games-swift.property","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/head","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/imageURL","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/name","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/release-swift.property","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/series","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/tail","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/type"]},{"title":"Default Implementations","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Decodable-Implementations","doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Encodable-Implementations"],"generated":true}],"variants":[{"paths":["\/documentation\/amiiboservice\/dto\/amiibo"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"languages":["swift"],"platforms":["macOS"]}]}],"references":{"doc://AmiiboService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/AmiiboService\/SE"},"doc://AmiiboService/documentation/AmiiboService/DTO/AmiiboSeries":{"role":"symbol","title":"DTO.AmiiboSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeries"}],"abstract":[{"type":"text","text":"This model represents the series an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"url":"\/documentation\/amiiboservice\/dto\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/name":{"role":"symbol","title":"name","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The name of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/name","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/name"},"https://www.amiiboapi.com":{"title":"Amiibo API","titleInlineContent":[{"type":"text","text":"Amiibo API"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com","url":"https:\/\/www.amiiboapi.com"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/series":{"role":"symbol","title":"series","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"series"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The series the amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/series","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/series"},"doc://AmiiboService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/AmiiboService\/Se"},"https://www.amiiboapi.com/docs/#amiibo":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo","url":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/Game":{"role":"symbol","title":"DTO.Amiibo.Game","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Game"}],"abstract":[{"type":"text","text":"This model structs represents a game that is related to an amiibo, when requested to the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Game","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Game"}],"url":"\/documentation\/amiiboservice\/dto\/amiibo\/game"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/gameSeries":{"role":"symbol","title":"gameSeries","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"gameSeries"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The game series of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/gameSeries","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/gameseries"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/type":{"role":"symbol","title":"type","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"type"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The type the amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/type","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/type"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/imageURL":{"role":"symbol","title":"imageURL","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"imageURL"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"abstract":[{"type":"text","text":"The URL to an image of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/imageURL","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/imageurl"},"doc://AmiiboService/documentation/AmiiboService/DTO":{"role":"symbol","title":"DTO","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DTO"}],"abstract":[{"type":"text","text":"This enumeration represents the namespace in which the public struct models are being exposed outside this package, to avoid any possible ambiguities."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"DTO"}],"url":"\/documentation\/amiiboservice\/dto"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/games-swift.property":{"role":"symbol","title":"games","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"games"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DTO","preciseIdentifier":"s:13AmiiboService3DTOO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService3DTOO0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Games","preciseIdentifier":"s:13AmiiboService3DTOO0A0V5GamesV"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"The games related to the amiibo, if requested."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/games-swift.property","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/games-swift.property"},"doc://AmiiboService/documentation/AmiiboService/DTO/LastUpdated":{"role":"symbol","title":"DTO.LastUpdated","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"LastUpdated"}],"abstract":[{"type":"text","text":"This model represents the latest date when the remote API has been updated."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/LastUpdated","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LastUpdated"}],"url":"\/documentation\/amiiboservice\/dto\/lastupdated"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/head":{"role":"symbol","title":"head","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"head"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The first 8 values of the hexadecimal that identifies the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/head","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/head"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo":{"role":"symbol","title":"DTO.Amiibo","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Amiibo"}],"abstract":[{"type":"text","text":"This model struct represents an amiibo that is retrieved from the respective "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com\/docs\/#amiibo"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/dto\/amiibo"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/Games-swift.struct":{"role":"symbol","title":"DTO.Amiibo.Games","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Games"}],"abstract":[{"type":"text","text":"This model represents the list of games related to a particular amiibo, grouped by system."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Games-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Games"}],"url":"\/documentation\/amiiboservice\/dto\/amiibo\/games-swift.struct"},"https://www.amiiboapi.com/docs/#showGames":{"title":"remote API endpoint","titleInlineContent":[{"type":"text","text":"remote API endpoint"}],"type":"link","identifier":"https:\/\/www.amiiboapi.com\/docs\/#showGames","url":"https:\/\/www.amiiboapi.com\/docs\/#showGames"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/Release-swift.struct":{"role":"symbol","title":"DTO.Amiibo.Release","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Release"}],"abstract":[{"type":"text","text":"This model struct represents a collection of official release dates (if released) of an amiibo in different markets around the world."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Release-swift.struct","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Release"}],"url":"\/documentation\/amiiboservice\/dto\/amiibo\/release-swift.struct"},"doc://AmiiboService/documentation/AmiiboService/DTO/AmiiboType":{"role":"symbol","title":"DTO.AmiiboType","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboType"}],"abstract":[{"type":"text","text":"This model represents the type an amiibo belongs to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboType","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/dto\/amiibotype"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/Encodable-Implementations":{"role":"collectionGroup","title":"Encodable Implementations","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Encodable-Implementations","kind":"article","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/encodable-implementations"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/release-swift.property":{"role":"symbol","title":"release","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"release"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"DTO","preciseIdentifier":"s:13AmiiboService3DTOO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Amiibo","preciseIdentifier":"s:13AmiiboService3DTOO0A0V"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Release","preciseIdentifier":"s:13AmiiboService3DTOO0A0V7ReleaseV"}],"abstract":[{"type":"text","text":"The release dates of the amiibo (if released) in Australia, Europe, Japan and North America."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/release-swift.property","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/release-swift.property"},"doc://AmiiboService/documentation/AmiiboService/DTO/Character":{"role":"symbol","title":"DTO.Character","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Character"}],"abstract":[{"type":"text","text":"This model represents the character an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Character","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Character"}],"url":"\/documentation\/amiiboservice\/dto\/character"},"doc://AmiiboService/documentation/AmiiboService":{"role":"collection","title":"AmiiboService","abstract":[{"type":"text","text":"Ready-to-use service that retrieves decoded entities from any of the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" available endpoints."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/DTO/GameSeries":{"role":"symbol","title":"DTO.GameSeries","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeries"}],"abstract":[{"type":"text","text":"This model represents the games series an amiibo is associated to."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/GameSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"url":"\/documentation\/amiiboservice\/dto\/gameseries"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/tail":{"role":"symbol","title":"tail","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"tail"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The last 8 values of the hexadecimal that identifies the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/tail","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/tail"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/character":{"role":"symbol","title":"character","fragments":[{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"character"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"abstract":[{"type":"text","text":"The character of the amiibo."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/character","kind":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/character"},"doc://AmiiboService/documentation/AmiiboService/DTO/KeyName":{"role":"symbol","title":"DTO.KeyName","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeyName"}],"abstract":[{"type":"text","text":"This model is a concrete genetic definition that represents the following models: "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboSeries"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/AmiiboType"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Character"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/GameSeries"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/KeyName","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeyName"}],"url":"\/documentation\/amiiboservice\/dto\/keyname"},"doc://AmiiboService/documentation/AmiiboService/DTO/Amiibo/Decodable-Implementations":{"role":"collectionGroup","title":"Decodable Implementations","abstract":[],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/DTO\/Amiibo\/Decodable-Implementations","kind":"article","type":"topic","url":"\/documentation\/amiiboservice\/dto\/amiibo\/decodable-implementations"}}}