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

{"metadata":{"roleHeading":"Framework","externalID":"AmiiboService","modules":[{"name":"AmiiboService"}],"symbolKind":"module","title":"AmiiboService","role":"collection"},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A library that provides everything the developer needs to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Amiibo API"}]},{"type":"text","text":" backend service."}],"topicSections":[{"title":"Service","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"],"anchor":"Service"},{"title":"Clients","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"],"anchor":"Clients"},{"title":"Types","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Platform-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"],"anchor":"Types"},{"title":"Filters","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter"],"anchor":"Filters"},{"title":"Errors","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError"],"anchor":"Errors"}],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice"]}],"sections":[],"primaryContentSections":[{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"The "},{"code":"amiibo-service","type":"codeVoice"},{"type":"text","text":" library is a package that allows the developer to interact with the "},{"isActive":true,"identifier":"https:\/\/www.amiiboapi.com","type":"reference"},{"type":"text","text":" backend service seamlessly, by not only providing the "},{"type":"emphasis","inlineContent":[{"type":"text","text":"service"}]},{"type":"text","text":" type but also any possible "},{"type":"emphasis","inlineContent":[{"type":"text","text":"models"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"filters"}]},{"type":"text","text":", "},{"type":"emphasis","inlineContent":[{"type":"text","text":"errors"}]},{"type":"text","text":" and "},{"type":"emphasis","inlineContent":[{"type":"text","text":"interfaces"}]},{"type":"text","text":" types that might be needed during implementation."}]},{"type":"heading","level":2,"text":"Design","anchor":"Design"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Although it could have been possible to generate a one-to-one RESTful client based on the Open API specification document that describe the available endpoints of the backend service, it was decided to design a "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" service type that removes the complexities of the API design imposed by the backend service, and provides the developer with a simple interface, and a seamless experience."}]},{"type":"heading","level":2,"text":"Installation","anchor":"Installation"},{"type":"paragraph","inlineContent":[{"type":"text","text":"To use the "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" library with your package, then add it as a dependency in the "},{"code":"Package.swift","type":"codeVoice"},{"type":"text","text":" file:"}]},{"type":"codeListing","syntax":"swift","code":["let package = Package(","    \/\/ name, platforms, products, etc.","    dependencies: [","        .package(url: \"https:\/\/github.com\/rock-n-code\/amiibo-service\", from: \"1.1.0\"),","        \/\/ other dependencies","    ],","    targets: [","        .target(","            name: \"SomeTarget\", ","            dependencies: [","                .product(name: \"AmiiboService\", package: \"amiibo-service\"),","            ]","        )","        \/\/ other targets","    ]",")"]},{"type":"paragraph","inlineContent":[{"type":"text","text":"It is also possible to use the "},{"code":"AmiiboService","type":"codeVoice"},{"type":"text","text":" library with your app in Xcode, then add it as a dependency in your Xcode project."}]},{"type":"aside","name":"Important","style":"important","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Swift 5.10 or higher is required in order to compile this library."}]}]},{"type":"heading","level":2,"text":"Tasks","anchor":"Tasks"},{"type":"paragraph","inlineContent":[{"type":"text","text":"This library offers a set of ready-to-use tasks that simplify the interaction with the library, which the developer can use from any "},{"code":"Terminal","type":"codeVoice"},{"type":"text","text":" application."}]},{"type":"aside","name":"Tip","style":"tip","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"To show the available list of tasks, plus display some explanations about each and every one of them; please enter the following command:"}]}]},{"type":"codeListing","syntax":"bash","code":["$ make"]}]}],"hierarchy":{"paths":[[]]},"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboSeries":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboSeries"}],"title":"AmiiboSeries","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboseries","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboSeries"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","type":"topic","abstract":[{"text":"A model that represents an amiibo series.","type":"text"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Game":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Game","kind":"symbol","type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Game","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibo\/game","navigatorTitle":[{"text":"Game","kind":"identifier"}],"title":"Amiibo.Game","abstract":[{"type":"text","text":"A model that represents a game related to an amiibo item."}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","navigatorTitle":[{"text":"GameSeriesFilter","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/amiiboservice\/gameseriesfilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting game series.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"GameSeriesFilter","kind":"identifier"}],"title":"GameSeriesFilter","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","role":"symbol","kind":"symbol","type":"topic","title":"AmiiboService","navigatorTitle":[{"text":"AmiiboService","kind":"identifier"}],"abstract":[{"type":"text","text":"A type that implements the service that uses a client to make calls."}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboService"}],"url":"\/documentation\/amiiboservice\/amiiboservice"},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"role":"symbol","navigatorTitle":[{"text":"GameCharacter","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameCharacter","kind":"identifier"}],"title":"GameCharacter","url":"\/documentation\/amiiboservice\/gamecharacter","abstract":[{"type":"text","text":"A model that represents a game character."}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","kind":"symbol"},"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"title":"AmiiboClient","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","type":"topic","abstract":[{"text":"A protocol that defines API clients containing all available endpoints to interact with.","type":"text"}],"role":"symbol"},"https://www.amiiboapi.com":{"titleInlineContent":[{"text":"Amiibo API","type":"text"}],"identifier":"https:\/\/www.amiiboapi.com","title":"Amiibo API","url":"https:\/\/www.amiiboapi.com","type":"link"},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"role":"symbol","type":"topic","url":"\/documentation\/amiiboservice\/amiibo","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Amiibo","kind":"identifier"}],"abstract":[{"text":"A model that represents an amiibo item.","type":"text"}],"navigatorTitle":[{"text":"Amiibo","kind":"identifier"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","title":"Amiibo"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboType"}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboType"}],"abstract":[{"type":"text","text":"A model that represents an amiibo type."}],"kind":"symbol","type":"topic","role":"symbol","title":"AmiiboType","url":"\/documentation\/amiiboservice\/amiibotype"},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"navigatorTitle":[{"kind":"identifier","text":"AmiiboSeriesFilter"}],"title":"AmiiboSeriesFilter","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboseriesfilter","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboSeriesFilter"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","type":"topic","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo series.","type":"text"}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Platform-swift.struct":{"navigatorTitle":[{"text":"Platform","kind":"identifier"}],"title":"Amiibo.Platform","kind":"symbol","url":"\/documentation\/amiiboservice\/amiibo\/platform-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Platform","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Platform-swift.struct","type":"topic","abstract":[{"type":"text","text":"A model that represents a collection of "},{"code":"WiiU","type":"codeVoice"},{"type":"text","text":", "},{"code":"3DS","type":"codeVoice"},{"type":"text","text":", and "},{"code":"Switch","type":"codeVoice"},{"type":"text","text":" games related to an amiibo item."}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService":{"identifier":"doc:\/\/AmiiboService\/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."}],"kind":"symbol","type":"topic","role":"collection","url":"\/documentation\/amiiboservice","title":"AmiiboService"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"role":"symbol","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboLiveClient","kind":"identifier"}],"title":"AmiiboLiveClient","url":"\/documentation\/amiiboservice\/amiiboliveclient","abstract":[{"text":"A type that implements a live client to the online service.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","kind":"symbol","role":"symbol","title":"AmiiboFilter","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo items."}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"text":"AmiiboFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibofilter","type":"topic"},"doc://AmiiboService/documentation/AmiiboService/AmiiboTypeFilter":{"navigatorTitle":[{"text":"AmiiboTypeFilter","kind":"identifier"}],"kind":"symbol","type":"topic","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo types.","type":"text"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","url":"\/documentation\/amiiboservice\/amiibotypefilter","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboTypeFilter","kind":"identifier"}],"role":"symbol","title":"AmiiboTypeFilter"},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"AmiiboServiceError","kind":"identifier"}],"navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"abstract":[{"text":"A representation of all the possible errors that the ","type":"text"},{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService","isActive":true,"type":"reference"},{"text":" service could throw.","type":"text"}],"kind":"symbol","type":"topic","role":"symbol","url":"\/documentation\/amiiboservice\/amiiboserviceerror","title":"AmiiboServiceError"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Usage":{"type":"topic","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Usage","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Usage"}],"url":"\/documentation\/amiiboservice\/amiibo\/usage","navigatorTitle":[{"kind":"identifier","text":"Usage"}],"title":"Amiibo.Usage","abstract":[{"type":"text","text":"A model that represents the usage of an amiibo item within a certain game."}],"role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GameSeries"}],"type":"topic","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameSeries"}],"title":"GameSeries","url":"\/documentation\/amiiboservice\/gameseries","abstract":[{"type":"text","text":"A model that represents a game series."}],"kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"},"doc://AmiiboService/documentation/AmiiboService/GameCharacterFilter":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","role":"symbol","kind":"symbol","type":"topic","title":"GameCharacterFilter","navigatorTitle":[{"kind":"identifier","text":"GameCharacterFilter"}],"abstract":[{"text":"A type that contains values to fine-tune a response when requesting game characters.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameCharacterFilter"}],"url":"\/documentation\/amiiboservice\/gamecharacterfilter"},"doc://AmiiboService/documentation/AmiiboService/Amiibo/Release-swift.struct":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo\/Release-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Release"}],"navigatorTitle":[{"text":"Release","kind":"identifier"}],"abstract":[{"type":"text","text":"A model that represents a collection of release dates related to an amiibo item."}],"kind":"symbol","type":"topic","role":"symbol","title":"Amiibo.Release","url":"\/documentation\/amiiboservice\/amiibo\/release-swift.struct"}}}