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

{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"AmiiboService"}]},{"type":"text","text":" provides a service, filters and models for retrieving data from the remote "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" endpoints to use in libraries and applications targeting Apple platforms, such as "},{"type":"emphasis","inlineContent":[{"type":"text","text":"iOS"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"macOS"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"tvOS"}]},{"type":"text","text":", and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"watchOS"}]},{"type":"text","text":". This package provides structures that can be used to include filters to the requests to send to the remote service if required. In addition, the structures to model the kinds of data coming in from those responses into entities are also provided."}]}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/amiiboservice"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService","interfaceLanguage":"swift"},"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."}],"kind":"symbol","metadata":{"roleHeading":"Framework","externalID":"AmiiboService","title":"AmiiboService","symbolKind":"module","role":"collection","modules":[{"name":"AmiiboService"}]},"hierarchy":{"paths":[[]]},"topicSections":[{"title":"Essentials","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/GettingStarted","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"]},{"title":"Filter data when making requests","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyNameFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/CharacterFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter"]},{"title":"Models to decode the data coming from the responses","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/LastUpdated"]},{"title":"Errors that can be thrown by the service","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"role":"symbol","title":"GameSeriesFilter","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeriesFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering game series."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameSeriesFilter"}],"url":"\/documentation\/amiiboservice\/gameseriesfilter"},"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/KeyNameFilter":{"role":"symbol","title":"KeyNameFilter","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"KeyNameFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos series ("},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter"},{"type":"text","text":"), amiibo types ("},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter"},{"type":"text","text":"), characters ("},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/CharacterFilter"},{"type":"text","text":"), or game series ("},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter"},{"type":"text","text":")."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyNameFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeyNameFilter"}],"url":"\/documentation\/amiiboservice\/keynamefilter"},"doc://AmiiboService/documentation/AmiiboService/LastUpdated":{"role":"symbol","title":"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\/LastUpdated","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"LastUpdated"}],"url":"\/documentation\/amiiboservice\/lastupdated"},"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/AmiiboClientError":{"role":"symbol","title":"AmiiboClientError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClientError"}],"abstract":[{"type":"text","text":"This error definitions represents any error happening while the client makes a request to the remote API and handles the respective response, excluding the decoding of the retrieved data into a particular model."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClientError","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboClientError"}],"url":"\/documentation\/amiiboservice\/amiiboclienterror"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"role":"symbol","title":"AmiiboSeriesFilter","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeriesFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos series."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeriesFilter"}],"url":"\/documentation\/amiiboservice\/amiiboseriesfilter"},"doc://AmiiboService/documentation/AmiiboService/Character":{"role":"symbol","title":"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\/Character","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Character"}],"url":"\/documentation\/amiiboservice\/character"},"doc://AmiiboService/documentation/AmiiboService/AmiiboTypeFilter":{"role":"symbol","title":"AmiiboTypeFilter","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboTypeFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibo types."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboTypeFilter"}],"url":"\/documentation\/amiiboservice\/amiibotypefilter"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"role":"symbol","title":"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\/GameSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"url":"\/documentation\/amiiboservice\/gameseries"},"doc://AmiiboService/documentation/AmiiboService/KeyName":{"role":"symbol","title":"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\/AmiiboSeries"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType"},{"type":"text","text":", "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Character"},{"type":"text","text":" and "},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/KeyName","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"KeyName"}],"url":"\/documentation\/amiiboservice\/keyname"},"doc://AmiiboService/documentation/AmiiboService/GettingStarted":{"role":"article","title":"Getting Started","abstract":[{"type":"text","text":"Install the package and start using the service to retrieve any available data from the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":"."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GettingStarted","kind":"article","type":"topic","url":"\/documentation\/amiiboservice\/gettingstarted"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"role":"symbol","title":"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\/AmiiboSeries","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"url":"\/documentation\/amiiboservice\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"role":"symbol","title":"AmiiboService","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboService"}],"abstract":[{"type":"text","text":"This service provides the interface to make remote API calls to the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.amiiboapi.com"},{"type":"text","text":" and, subsequently, handle its responses."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"url":"\/documentation\/amiiboservice\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"role":"symbol","title":"AmiiboFilter","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering amiibos."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"url":"\/documentation\/amiiboservice\/amiibofilter"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"role":"symbol","title":"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\/Amiibo","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"url":"\/documentation\/amiiboservice\/amiibo"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"role":"symbol","title":"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\/AmiiboType","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/amiibotype"},"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/CharacterFilter":{"role":"symbol","title":"CharacterFilter","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"CharacterFilter"}],"abstract":[{"type":"text","text":"This filter provides all the possible parameters (and combinations) available at the remote API applies when filtering characters."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/CharacterFilter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"CharacterFilter"}],"url":"\/documentation\/amiiboservice\/characterfilter"}}}