diff --git a/README.md b/README.md index 83cdb06..17405f1 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ # Amiibo Service -A library written entirely with [Swift](https://www.swift.org) that provides everything the developer needs to interacts with the [Amiibo API](https://www.amiiboapi.com) backend service. +A library written entirely with [Swift](https://www.swift.org) that provides everything the developer needs to interacts with the [Amiibo API](https://www.amiiboapi.org) backend service. ## Installation diff --git a/Sources/AmiiboService/Catalogs/AmiiboService.docc/Library.md b/Sources/AmiiboService/Catalogs/AmiiboService.docc/Library.md index 3b3b871..86c34ea 100644 --- a/Sources/AmiiboService/Catalogs/AmiiboService.docc/Library.md +++ b/Sources/AmiiboService/Catalogs/AmiiboService.docc/Library.md @@ -4,7 +4,7 @@ A library that provides everything the developer needs to interact with the **Am ## Overview -The `amiibo-service` library is a package that allows the developer to interact with the [Amiibo API](https://www.amiiboapi.com) backend service seamlessly, by not only providing the *service* type but also any possible *models*, *filters*, *errors* and *interfaces* types that might be needed during implementation. +The `amiibo-service` library is a package that allows the developer to interact with the [Amiibo API](https://www.amiiboapi.org) backend service seamlessly, by not only providing the *service* type but also any possible *models*, *filters*, *errors* and *interfaces* types that might be needed during implementation. ## Design diff --git a/Sources/AmiiboService/openapi.yaml b/Sources/AmiiboService/openapi.yaml index cb09581..39b113c 100644 --- a/Sources/AmiiboService/openapi.yaml +++ b/Sources/AmiiboService/openapi.yaml @@ -19,7 +19,7 @@ info: description: | # Information - The [AmiiboAPI](https://www.amiiboapi.com) service is primarily used for educational purposes. + The [AmiiboAPI](https://www.amiiboapi.org) service is primarily used for educational purposes. This is a **reading-only API**. Only HTTP GET method is allowed by this API. **No authentication** is required to use this API. All resources are allowed to access. @@ -36,18 +36,18 @@ info: * *You will comply with all applicable law, regulation, and third party rights (including without limitation laws regarding the import or export of data or software, privacy, and local laws). You will not use the APIs to encourage or promote illegal activity or violation of third party rights.* * *These Terms and Conditions are subject to change without notice, from time to time in our sole discretion.* version: v1.0.0 - termsOfService: https://www.amiiboapi.com/docs/#termscondition + termsOfService: https://www.amiiboapi.org/docs/#termscondition contact: name: FAQ - url: https://www.amiiboapi.com/faq/ + url: https://www.amiiboapi.org/faq/ license: name: MIT license identifier: MIT externalDocs: - url: https://www.amiiboapi.com/docs + url: https://www.amiiboapi.org/docs description: Amiibo API documentation servers: - - url: https://www.amiiboapi.com/api + - url: https://www.amiiboapi.org/api description: Live service tags: - name: Amiibo @@ -63,7 +63,7 @@ paths: description: | Get a list of all the Amiibo items available in the database. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#amiibo) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#amiibo) for further information. operationId: getAmiibos tags: - Amiibo @@ -100,7 +100,7 @@ paths: description: | Get a list of all the Amiibo series available in the database. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#series) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#series) for further information. operationId: getAmiiboSeries parameters: - $ref: '#/components/parameters/Key' @@ -128,7 +128,7 @@ paths: description: | Get a list of all the game characters available in the database. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#character) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#character) for further information. operationId: getGameCharacters parameters: - $ref: '#/components/parameters/Key' @@ -156,7 +156,7 @@ paths: description: | Gets a list of all the Game series available in the database. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#gameSeries) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#gameSeries) for further information. operationId: getGameSeries parameters: - $ref: '#/components/parameters/Key' @@ -184,7 +184,7 @@ paths: description: | Gets a list of all the amiibo types available in the database. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#type) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#type) for further information. operationId: getAmiiboTypes parameters: - $ref: '#/components/parameters/Key' @@ -212,7 +212,7 @@ paths: description: | Gets an ISO-formatted date+time when the Amiibo data was last updated. - Please refer to [the documentation of the endpoint](https://www.amiiboapi.com/docs/#lastUpdated) for further information. + Please refer to [the documentation of the endpoint](https://www.amiiboapi.org/docs/#lastUpdated) for further information. operationId: getLastUpdated responses: '200': diff --git a/docs/data/documentation/amiiboservice.json b/docs/data/documentation/amiiboservice.json index 5a40b4d..ef67b5c 100644 --- a/docs/data/documentation/amiiboservice.json +++ b/docs/data/documentation/amiiboservice.json @@ -1 +1 @@ -{"abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"metadata":{"roleHeading":"Framework","role":"collection","title":"AmiiboService","modules":[{"name":"AmiiboService"}],"externalID":"AmiiboService","symbolKind":"module"},"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"amiibo-service","type":"codeVoice"},{"text":" library is a package that allows the developer to interact with the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/www.amiiboapi.com"},{"text":" backend service seamlessly, by not only providing the ","type":"text"},{"inlineContent":[{"type":"text","text":"service"}],"type":"emphasis"},{"text":" type but also any possible ","type":"text"},{"inlineContent":[{"type":"text","text":"models"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"filters"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"errors"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"interfaces"}],"type":"emphasis"},{"text":" types that might be needed during implementation.","type":"text"}]},{"anchor":"Design","level":2,"type":"heading","text":"Design"},{"type":"paragraph","inlineContent":[{"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 ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"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":"text"}]},{"anchor":"Installation","level":2,"type":"heading","text":"Installation"},{"type":"paragraph","inlineContent":[{"text":"To use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your package, then add it as a dependency in the ","type":"text"},{"code":"Package.swift","type":"codeVoice"},{"text":" file:","type":"text"}]},{"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.3.0\"),"," \/\/ other dependencies"," ],"," targets: ["," .target("," name: \"SomeTarget\", "," dependencies: ["," .product(name: \"AmiiboService\", package: \"amiibo-service\"),"," ]"," )"," \/\/ other targets"," ]",")"]},{"type":"paragraph","inlineContent":[{"text":"It is also possible to use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your app in Xcode, then add it as a dependency in your Xcode project.","type":"text"}]},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"type":"text","text":"Swift 5.10 or higher is required in order to compile this library."}],"type":"paragraph"}]},{"anchor":"Tasks","level":2,"type":"heading","text":"Tasks"},{"type":"paragraph","inlineContent":[{"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 ","type":"text"},{"code":"Terminal","type":"codeVoice"},{"text":" application.","type":"text"}]},{"style":"tip","type":"aside","name":"Tip","content":[{"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":"paragraph"}]},{"type":"codeListing","syntax":"bash","code":["$ make"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService","interfaceLanguage":"swift"},"hierarchy":{"paths":[[]]},"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":"Models","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"],"anchor":"Models"},{"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"type":"topic","abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"title":"AmiiboClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"abstract":[{"text":"A model that represents a game series.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeries","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","url":"\/documentation\/amiiboservice\/gameseries","title":"GameSeries","navigatorTitle":[{"text":"GameSeries","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameCharacterFilter":{"abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game characters."}],"url":"\/documentation\/amiiboservice\/gamecharacterfilter","role":"symbol","title":"GameCharacterFilter","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameCharacterFilter"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"GameCharacterFilter","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"type":"topic","title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","role":"symbol","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}]},"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/AmiiboSeries":{"type":"topic","abstract":[{"text":"A model that represents an amiibo series.","type":"text"}],"navigatorTitle":[{"text":"AmiiboSeries","kind":"identifier"}],"title":"AmiiboSeries","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboSeries","kind":"identifier"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo items."}],"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibofilter","navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","title":"AmiiboFilter"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"title":"AmiiboLiveClient","abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient","type":"topic","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"type":"topic","navigatorTitle":[{"text":"GameSeriesFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/gameseriesfilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","role":"symbol","title":"GameSeriesFilter","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game series."}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"GameSeriesFilter"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboTypeFilter":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboTypeFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","type":"topic","url":"\/documentation\/amiiboservice\/amiibotypefilter","kind":"symbol","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo types."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboTypeFilter"}],"title":"AmiiboTypeFilter"},"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"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","role":"symbol","abstract":[{"text":"A model that represents an amiibo type.","type":"text"}],"title":"AmiiboType","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/amiibotype","navigatorTitle":[{"text":"AmiiboType","kind":"identifier"}],"kind":"symbol"},"https://www.amiiboapi.com":{"type":"link","title":"Amiibo API","url":"https:\/\/www.amiiboapi.com","identifier":"https:\/\/www.amiiboapi.com","titleInlineContent":[{"text":"Amiibo API","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"url":"\/documentation\/amiiboservice\/amiiboseriesfilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo series.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","title":"AmiiboSeriesFilter","type":"topic","navigatorTitle":[{"text":"AmiiboSeriesFilter","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboSeriesFilter","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"url":"\/documentation\/amiiboservice\/gamecharacter","abstract":[{"text":"A model that represents a game character.","type":"text"}],"role":"symbol","title":"GameCharacter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameCharacter"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameCharacter"}]},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"type":"topic","title":"Amiibo","url":"\/documentation\/amiiboservice\/amiibo","role":"symbol","abstract":[{"type":"text","text":"A model that represents an amiibo."}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Amiibo","kind":"identifier"}]}}} \ No newline at end of file +{"abstract":[{"text":"A library that provides everything the developer needs to interact with the ","type":"text"},{"type":"strong","inlineContent":[{"text":"Amiibo API","type":"text"}]},{"text":" backend service.","type":"text"}],"metadata":{"roleHeading":"Framework","role":"collection","title":"AmiiboService","modules":[{"name":"AmiiboService"}],"externalID":"AmiiboService","symbolKind":"module"},"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"The ","type":"text"},{"code":"amiibo-service","type":"codeVoice"},{"text":" library is a package that allows the developer to interact with the ","type":"text"},{"isActive":true,"type":"reference","identifier":"https:\/\/www.amiiboapi.org"},{"text":" backend service seamlessly, by not only providing the ","type":"text"},{"inlineContent":[{"type":"text","text":"service"}],"type":"emphasis"},{"text":" type but also any possible ","type":"text"},{"inlineContent":[{"type":"text","text":"models"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"filters"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"errors"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"interfaces"}],"type":"emphasis"},{"text":" types that might be needed during implementation.","type":"text"}]},{"anchor":"Design","level":2,"type":"heading","text":"Design"},{"type":"paragraph","inlineContent":[{"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 ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"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":"text"}]},{"anchor":"Installation","level":2,"type":"heading","text":"Installation"},{"type":"paragraph","inlineContent":[{"text":"To use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your package, then add it as a dependency in the ","type":"text"},{"code":"Package.swift","type":"codeVoice"},{"text":" file:","type":"text"}]},{"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.3.0\"),"," \/\/ other dependencies"," ],"," targets: ["," .target("," name: \"SomeTarget\", "," dependencies: ["," .product(name: \"AmiiboService\", package: \"amiibo-service\"),"," ]"," )"," \/\/ other targets"," ]",")"]},{"type":"paragraph","inlineContent":[{"text":"It is also possible to use the ","type":"text"},{"code":"AmiiboService","type":"codeVoice"},{"text":" library with your app in Xcode, then add it as a dependency in your Xcode project.","type":"text"}]},{"style":"important","type":"aside","name":"Important","content":[{"inlineContent":[{"type":"text","text":"Swift 5.10 or higher is required in order to compile this library."}],"type":"paragraph"}]},{"anchor":"Tasks","level":2,"type":"heading","text":"Tasks"},{"type":"paragraph","inlineContent":[{"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 ","type":"text"},{"code":"Terminal","type":"codeVoice"},{"text":" application.","type":"text"}]},{"style":"tip","type":"aside","name":"Tip","content":[{"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":"paragraph"}]},{"type":"codeListing","syntax":"bash","code":["$ make"]}]}],"sections":[],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/AmiiboService\/documentation\/AmiiboService","interfaceLanguage":"swift"},"hierarchy":{"paths":[[]]},"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":"Models","identifiers":["doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries"],"anchor":"Models"},{"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"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/amiiboservice"]}],"references":{"doc://AmiiboService/documentation/AmiiboService/AmiiboClient":{"type":"topic","abstract":[{"type":"text","text":"A protocol that defines API clients containing all available endpoints to interact with."}],"navigatorTitle":[{"kind":"identifier","text":"AmiiboClient"}],"title":"AmiiboClient","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboClient","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboClient"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboclient"},"doc://AmiiboService/documentation/AmiiboService/GameSeries":{"abstract":[{"text":"A model that represents a game series.","type":"text"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GameSeries","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeries","url":"\/documentation\/amiiboservice\/gameseries","title":"GameSeries","navigatorTitle":[{"text":"GameSeries","kind":"identifier"}],"kind":"symbol","role":"symbol"},"doc://AmiiboService/documentation/AmiiboService/GameCharacterFilter":{"abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game characters."}],"url":"\/documentation\/amiiboservice\/gamecharacterfilter","role":"symbol","title":"GameCharacterFilter","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacterFilter","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameCharacterFilter"}],"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"GameCharacterFilter","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboServiceError":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboServiceError","navigatorTitle":[{"text":"AmiiboServiceError","kind":"identifier"}],"type":"topic","title":"AmiiboServiceError","url":"\/documentation\/amiiboservice\/amiiboserviceerror","role":"symbol","abstract":[{"type":"text","text":"A representation of all the possible errors that the "},{"isActive":true,"type":"reference","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboService"},{"type":"text","text":" service could throw."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboServiceError","kind":"identifier"}]},"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/AmiiboSeries":{"type":"topic","abstract":[{"text":"A model that represents an amiibo series.","type":"text"}],"navigatorTitle":[{"text":"AmiiboSeries","kind":"identifier"}],"title":"AmiiboSeries","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeries","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboSeries","kind":"identifier"}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboseries"},"doc://AmiiboService/documentation/AmiiboService/AmiiboFilter":{"type":"topic","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo items."}],"role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"text":"AmiiboFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/amiibofilter","navigatorTitle":[{"kind":"identifier","text":"AmiiboFilter"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboFilter","title":"AmiiboFilter"},"doc://AmiiboService/documentation/AmiiboService/AmiiboLiveClient":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboLiveClient","fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"AmiiboLiveClient"}],"title":"AmiiboLiveClient","abstract":[{"type":"text","text":"A type that implements a live client to the online service."}],"role":"symbol","kind":"symbol","url":"\/documentation\/amiiboservice\/amiiboliveclient","type":"topic","navigatorTitle":[{"text":"AmiiboLiveClient","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/GameSeriesFilter":{"type":"topic","navigatorTitle":[{"text":"GameSeriesFilter","kind":"identifier"}],"url":"\/documentation\/amiiboservice\/gameseriesfilter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameSeriesFilter","role":"symbol","title":"GameSeriesFilter","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting game series."}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"GameSeriesFilter"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboTypeFilter":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboTypeFilter","kind":"identifier"}],"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboTypeFilter","type":"topic","url":"\/documentation\/amiiboservice\/amiibotypefilter","kind":"symbol","abstract":[{"type":"text","text":"A type that contains values to fine-tune a response when requesting amiibo types."}],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"AmiiboTypeFilter"}],"title":"AmiiboTypeFilter"},"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"},"doc://AmiiboService/documentation/AmiiboService/AmiiboType":{"type":"topic","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboType","role":"symbol","abstract":[{"text":"A model that represents an amiibo type.","type":"text"}],"title":"AmiiboType","fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AmiiboType"}],"url":"\/documentation\/amiiboservice\/amiibotype","navigatorTitle":[{"text":"AmiiboType","kind":"identifier"}],"kind":"symbol"},"https://www.amiiboapi.org":{"type":"link","title":"Amiibo API","url":"https:\/\/www.amiiboapi.org","identifier":"https:\/\/www.amiiboapi.org","titleInlineContent":[{"text":"Amiibo API","type":"text"}]},"doc://AmiiboService/documentation/AmiiboService/AmiiboSeriesFilter":{"url":"\/documentation\/amiiboservice\/amiiboseriesfilter","abstract":[{"text":"A type that contains values to fine-tune a response when requesting amiibo series.","type":"text"}],"role":"symbol","kind":"symbol","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/AmiiboSeriesFilter","title":"AmiiboSeriesFilter","type":"topic","navigatorTitle":[{"text":"AmiiboSeriesFilter","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AmiiboSeriesFilter","kind":"identifier"}]},"doc://AmiiboService/documentation/AmiiboService/GameCharacter":{"url":"\/documentation\/amiiboservice\/gamecharacter","abstract":[{"text":"A model that represents a game character.","type":"text"}],"role":"symbol","title":"GameCharacter","identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/GameCharacter","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"GameCharacter"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"GameCharacter"}]},"doc://AmiiboService/documentation/AmiiboService/Amiibo":{"identifier":"doc:\/\/AmiiboService\/documentation\/AmiiboService\/Amiibo","navigatorTitle":[{"kind":"identifier","text":"Amiibo"}],"type":"topic","title":"Amiibo","url":"\/documentation\/amiiboservice\/amiibo","role":"symbol","abstract":[{"type":"text","text":"A model that represents an amiibo."}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Amiibo","kind":"identifier"}]}}}