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

{"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"languages":["swift"]}],"kind":"declarations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboservice"]}],"sections":[],"abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(client:)"],"anchor":"Initializers","generated":true},{"title":"Instance Methods","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboSeries(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboTypes(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameCharacters(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameSeries(_:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getLastUpdated()"],"anchor":"Instance-Methods","generated":true}],"metadata":{"roleHeading":"Structure","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboService","kind":"identifier"}],"title":"AmiiboService","symbolKind":"struct","role":"symbol","externalID":"s:13AmiiboServiceAAV","modules":[{"name":"AmiiboService"}],"navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}]},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiibos(_:)":{"type":"topic","abstract":[{"text":"Gets a list of amiibo items based on a given filter.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiibos(_:)","title":"getAmiibos(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiibos","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6FilterV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"Amiibo","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A0V"},{"text":"]","kind":"text"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiibos(_:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getGameSeries(_:)":{"abstract":[{"text":"Gets a list of game series based on a given filter.","type":"text"}],"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getGameSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"GameSeriesFilter","preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"kind":"typeIdentifier","text":"GameSeries","preciseIdentifier":"s:13AmiiboService10GameSeriesV"},{"kind":"text","text":"]"}],"type":"topic","url":"\/documentation\/amiiboservice\/amiiboservice\/getgameseries(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameSeries(_:)","title":"getGameSeries(_:)","kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiiboTypes(_:)":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboTypes(_:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboTypes","kind":"identifier"},{"text":"(","kind":"text"},{"text":"AmiiboTypeFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"AmiiboType","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A4TypeV"},{"text":"]","kind":"text"}],"title":"getAmiiboTypes(_:)","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiibotypes(_:)","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getGameCharacters(_:)":{"url":"\/documentation\/amiiboservice\/amiiboservice\/getgamecharacters(_:)","abstract":[{"text":"Gets a list of game characters based on a given filter.","type":"text"}],"role":"symbol","title":"getGameCharacters(_:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getGameCharacters(_:)","kind":"symbol","type":"topic","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getGameCharacters"},{"kind":"text","text":"("},{"preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV","kind":"typeIdentifier","text":"GameCharacterFilter"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService13GameCharacterV","text":"GameCharacter","kind":"typeIdentifier"},{"text":"]","kind":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/init(client:)":{"abstract":[{"text":"Initializes this service with a specific client type.","type":"text"}],"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"client","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"some","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6ClientP"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/init(client:)","title":"init(client:)","url":"\/documentation\/amiiboservice\/amiiboservice\/init(client:)","kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboService","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","url":"\/documentation\/amiiboservice\/amiiboservice","kind":"symbol","abstract":[{"text":"A type that implements the service that uses a client to make calls.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getAmiiboSeries(_:)":{"type":"topic","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getAmiiboSeries(_:)","title":"getAmiiboSeries(_:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries"},{"kind":"text","text":"]"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboservice\/getamiiboseries(_:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService/getLastUpdated()":{"abstract":[{"text":"Gets the date when the data was last updated.","type":"text"}],"fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLastUpdated"},{"kind":"text","text":"() "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:10Foundation4DateV","kind":"typeIdentifier","text":"Date"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService\/getLastUpdated()","url":"\/documentation\/amiiboservice\/amiiboservice\/getlastupdated()","title":"getLastUpdated()","type":"topic","kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","title":"AmiiboService","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interact with the "},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"role":"collection","url":"\/documentation\/amiiboservice","kind":"symbol","type":"topic"}}}