amiibo-service/docs/data/documentation/amiiboservice/amiiboclient/getamiiboseries(by:).json

{"metadata":{"role":"symbol","required":true,"modules":[{"name":"AmiiboService"}],"roleHeading":"Instance Method","symbolKind":"method","externalID":"s:13AmiiboService0A6ClientP03getA6Series2bySayAA0aE0VGAA0aE6FilterV_tYaKF","title":"getAmiiboSeries(by:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","kind":"typeIdentifier","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":"]"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice\/amiiboclient\/getamiiboseries(by:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboSeries(by:)"},"kind":"symbol","primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getAmiiboSeries"},{"kind":"text","text":"("},{"kind":"externalParam","text":"by"},{"kind":"text","text":" "},{"kind":"internalParam","text":"filter"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV","text":"AmiiboSeriesFilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> ["},{"kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV","text":"AmiiboSeries","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries"},{"kind":"text","text":"]"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"filter","content":[{"inlineContent":[{"type":"text","text":"A filter to remove unwanted items from the result."}],"type":"paragraph"}]}]},{"content":[{"type":"heading","anchor":"return-value","text":"Return Value","level":2},{"type":"paragraph","inlineContent":[{"text":"A list of filtered amiibo series.","type":"text"}]}],"kind":"content"},{"content":[{"type":"heading","anchor":"discussion","text":"Discussion","level":2},{"content":[{"type":"paragraph","inlineContent":[{"text":"An ","type":"text"},{"type":"reference","isActive":true,"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"},{"type":"text","text":" error in case some issue is encountered while generating the result."}]}],"type":"aside","style":"note","name":"Throws"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/AmiiboService\/documentation\/AmiiboService","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient"]]},"abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"kind":"symbol","role":"symbol","title":"AmiiboService","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","navigatorTitle":[{"kind":"identifier","text":"AmiiboService"}],"abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboService"}],"url":"\/documentation\/amiiboservice\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboSeries","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboseries","abstract":[{"type":"text","text":"A model that represents an amiibo series."}],"role":"symbol","title":"AmiiboSeries"},"doc://AmiiboService/documentation/AmiiboService":{"url":"\/documentation\/amiiboservice","type":"topic","title":"AmiiboService","role":"collection","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService","kind":"symbol","abstract":[{"type":"text","text":"A library that provides everything the developer needs to interacts with the "},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"type":"text","text":" backend service."}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","type":"topic","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboServiceError"}],"abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true,"type":"reference"},{"type":"text","text":" service could throw."}],"kind":"symbol","title":"AmiiboServiceError","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboServiceError"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"kind":"symbol","role":"symbol","title":"AmiiboClient","type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","navigatorTitle":[{"text":"AmiiboClient","kind":"identifier"}],"abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"url":"\/documentation\/amiiboservice\/amiiboclient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboSeriesFilter"}],"role":"symbol","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo series.","type":"text"}],"url":"\/documentation\/amiiboservice\/amiiboseriesfilter","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeriesFilter"}],"title":"AmiiboSeriesFilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient/getAmiiboSeries(by:)":{"type":"topic","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getAmiiboSeries","kind":"identifier"},{"text":"(","kind":"text"},{"text":"by","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"AmiiboSeriesFilter","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A12SeriesFilterV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> [","kind":"text"},{"text":"AmiiboSeries","kind":"typeIdentifier","preciseIdentifier":"s:13AmiiboService0A6SeriesV"},{"text":"]","kind":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient\/getAmiiboSeries(by:)","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient\/getamiiboseries(by:)","abstract":[{"type":"text","text":"Gets a list of amiibo series based on a given filter."}],"required":true,"role":"symbol","title":"getAmiiboSeries(by:)"}}}