1 line
9.9 KiB
JSON
1 line
9.9 KiB
JSON
{"variants":[{"paths":["\/documentation\/amiiboservice\/amiiboclient"],"traits":[{"interfaceLanguage":"swift"}]}],"metadata":{"externalID":"s:13AmiiboService0A6ClientP","title":"AmiiboClient","navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"modules":[{"name":"AmiiboService"}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"role":"symbol","symbolKind":"protocol","roleHeading":"Protocol"},"topicSections":[{"title":"Amiibo endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiibos(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboSeries(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboTypes(by:)"],"anchor":"Amiibo-endpoints"},{"title":"Game endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getGameCharacters(by:)","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getGameSeries(by:)"],"anchor":"Game-endpoints"},{"title":"System endpoints","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getLastUpdated()"],"anchor":"System-endpoints"}],"relationshipsSections":[{"title":"Conforming Types","kind":"relationships","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"],"type":"conformingTypes"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","interfaceLanguage":"swift"},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService"]]},"sections":[],"abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"seeAlsoSections":[{"title":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"],"generated":true,"anchor":"Clients"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"languages":["swift"]}]}],"references":{"https://www.amiiboapi.org":{"identifier":"https:\/\/www.amiiboapi.org","type":"link","title":"Amiibo API","titleInlineContent":[{"text":"Amiibo API","type":"text"}],"url":"https:\/\/www.amiiboapi.org"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getAmiiboTypes(by:)":{"kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboTypes"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"AmiiboTypeFilter","preciseIdentifier":"s:13AmiiboService0A10TypeFilterV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","text":"AmiiboType","preciseIdentifier":"s:13AmiiboService0A4TypeV"},{"kind":"text","text":"]"}],"title":"getAmiiboTypes(by:)","url":"\/documentation\/amiiboservice\/amiiboclient\/getamiibotypes(by:)","abstract":[{"type":"text","text":"Gets a list of amiibo types based on a given filter."}],"type":"topic","required":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboTypes(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getGameSeries(by:)":{"required":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getGameSeries(by:)","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient\/getgameseries(by:)","title":"getGameSeries(by:)","type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService16GameSeriesFilterV","text":"GameSeriesFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService10GameSeriesV","text":"GameSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"abstract":[{"text":"Gets a list of game series based on a given filter.","type":"text"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","title":"AmiiboService","url":"\/documentation\/amiiboservice","abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"type":"topic","role":"collection"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboLiveClient"}],"title":"AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","type":"topic","abstract":[{"text":"A type that implements a live client to the ","type":"text"},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.org","type":"reference"},{"text":" online service.","type":"text"}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboLiveClient"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getGameCharacters(by:)":{"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Gets a list of game characters based on a given filter.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboclient\/getgamecharacters(by:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getGameCharacters(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getGameCharacters","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"GameCharacterFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService19GameCharacterFilterV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"GameCharacter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService13GameCharacterV"},{"text":"]","kind":"text"}],"title":"getGameCharacters(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getLastUpdated()":{"kind":"symbol","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLastUpdated","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Date","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation4DateV"}],"title":"getLastUpdated()","abstract":[{"text":"Gets the date when the data was last updated.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboclient\/getlastupdated()","type":"topic","required":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getLastUpdated()"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getAmiibos(by:)":{"kind":"symbol","required":true,"type":"topic","abstract":[{"type":"text","text":"Gets a list of amiibo items based on a given filter."}],"url":"\/documentation\/amiiboservice\/amiiboclient\/getamiibos(by:)","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiibos(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiibos","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AmiiboFilter","preciseIdentifier":"s:13AmiiboService0A6FilterV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"Amiibo","preciseIdentifier":"s:13AmiiboService0A0V","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"title":"getAmiibos(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getAmiiboSeries(by:)":{"kind":"symbol","required":true,"type":"topic","abstract":[{"text":"Gets a list of amiibo series based on a given filter.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboSeries(by:)","url":"\/documentation\/amiiboservice\/amiiboclient\/getamiiboseries(by:)","role":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries","kind":"typeIdentifier"},{"text":"]","kind":"text"}],"title":"getAmiiboSeries(by:)"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboClient","kind":"identifier"}],"type":"topic","abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"url":"\/documentation\/amiiboservice\/amiiboclient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","role":"symbol","title":"AmiiboClient"}}} |