window.utility2.stateInit({"utility2":{"assetsDict":{"/assets.index.css":"","/assets.index.template.html":"\n\n\n\n\n\nswgg\n\n\n\n\n
\n
\n\n
\n\n
\n swgg\n \n \n \n clear api-keys\n
\n
\n \n
\n\n
\n loading script\n
\n
\n
\n
\n [ this document was created with\n swgg\n ]\n
\n\n
\n\n\n\n\n\n","/assets.swgg.swagger.json":"{\n \"basePath\": \"/\",\n \"externalDocs\": {\n \"description\": \"find out more about itunes-search's web-apis\",\n \"url\": \"https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html\"\n },\n \"info\": {\n \"description\": \"this zero-dependency package will provide a swagger-client for itunes-search's web-apis, with a working web-demo\",\n \"title\": \"swgg-itunes-search\",\n \"version\": \"2018.1.16\",\n \"x-swgg-downloadStandaloneApp\": \"https://kaizhu256.github.io/node-swgg-itunes-search/build..beta..travis-ci.org/app/assets.app.js\",\n \"x-swgg-homepage\": \"https://github.com/kaizhu256/node-swgg-itunes-search\"\n },\n \"parameters\": {\n \"itunes-search.callback\": {\n \"default\": \"wsSearchCB\",\n \"description\": \"The name of the Javascript callback function you want to use when returning search results to your website.\",\n \"in\": \"query\",\n \"name\": \"callback\",\n \"type\": \"string\"\n },\n \"itunes-search.entity\": {\n \"description\": \"The type of results you want returned, relative to the specified media type. For example: movieArtist for a movie media type search. The default is the track entity associated with the specified media type.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html#//apple_ref/doc/uid/TP40017632-CH5-SW2\",\n \"enum\": [\n \"album\",\n \"all\",\n \"allArtist\",\n \"allTrack\",\n \"audiobook\",\n \"audiobookAuthor\",\n \"ebook\",\n \"iPadSoftware\",\n \"macSoftware\",\n \"mix\",\n \"movie\",\n \"movieArtist\",\n \"music\",\n \"musicArtist\",\n \"musicTrack\",\n \"musicVideo\",\n \"podcast\",\n \"podcastAuthor\",\n \"shortFilm\",\n \"shortFilmArtist\",\n \"software\",\n \"song\",\n \"tvEpisode\",\n \"tvSeason\",\n \"tvShow\"\n ],\n \"in\": \"query\",\n \"name\": \"entity\",\n \"type\": \"string\"\n },\n \"itunes-search.limit\": {\n \"description\": \"entity limit per id/isbn/upc/amgAlbumId/amgArtistId/amgVideoId\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"type\": \"integer\"\n },\n \"itunes-search.sort\": {\n \"description\": \"sort parameter\",\n \"enum\": [\n \"recent\"\n ],\n \"in\": \"query\",\n \"name\": \"sort\",\n \"type\": \"string\"\n }\n },\n \"paths\": {\n \"/lookup#amgAlbumId.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23amgAlbumId.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"15175\",\n \"15176\",\n \"15177\",\n \"15178\",\n \"15183\",\n \"15184\",\n \"15187\",\n \"1519\",\n \"15191\",\n \"15195\",\n \"15197\",\n \"15198\"\n ],\n \"description\": \"AMG Album ID\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"amgAlbumId\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/lookup#amgArtistId.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23amgArtistId.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"468749\",\n \"5723\"\n ],\n \"description\": \"AMG artist ID\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"amgArtistId\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/lookup#amgVideoId.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23amgVideoId.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"17120\"\n ],\n \"description\": \"AMG Video ID\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"amgVideoId\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/lookup#id.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23id.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"909253\",\n \"284910350\"\n ],\n \"description\": \"iTunes ID\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"id\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/lookup#isbn.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23isbn.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"9780316069359\"\n ],\n \"description\": \"13 digit ISBN\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"isbn\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/lookup#upc.required\": {\n \"get\": {\n \"description\": \"Lookup API.\\n\\nYou can also create a lookup request to search for content in the stores based on iTunes IDs, UPCs/ EANs, and All Music Guide (AMG) IDs. ID-based lookups are faster and contain fewer false-positive results.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/LookupExamples.html\",\n \"operationId\": \"_2Flookup_23upc.required_20GET\",\n \"parameters\": [\n {\n \"default\": [\n \"720642462928\"\n ],\n \"description\": \"UPC/EAN barcode\",\n \"in\": \"query\",\n \"items\": {\n \"type\": \"string\"\n },\n \"name\": \"upc\",\n \"required\": true,\n \"type\": \"array\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.limit\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.sort\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n },\n \"/search\": {\n \"get\": {\n \"description\": \"Search API.\\n\\nTo search for content from a field in your website and display the results in your website, you must create a search field that passes a fully-qualified URL content request to the iTunes Store, parse the JavaScript Object Notation (JSON) format returned from the search, and display the results in your website.\\n\\nThe fully-qualified URL must have the following format: https://itunes.apple.com/search?parameterkeyvalue. Where parameterkeyvalue can be one or more parameter key and value pairs indicating the details of your query.\\n\\nTo construct a parameter key and value pair, you must concatenate each parameter key with an equal sign (=) and a value string. For example: key1=value1. To create a string of parameter key and value pairs, you must concatenate each pair using an ampersand (&). For example: key1=value1&key2=value2&key3=value3.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html\",\n \"operationId\": \"_2Fsearch_20GET\",\n \"parameters\": [\n {\n \"default\": \"jack+johnson\",\n \"description\": \"The URL-encoded text string you want to search for. For example: jack+johnson.\",\n \"in\": \"query\",\n \"name\": \"term\",\n \"required\": true,\n \"type\": \"string\"\n },\n {\n \"default\": \"US\",\n \"description\": \"The two-letter country code for the store you want to search. The search uses the default store front for the specified country. For example: US. The default is US.\\n\\nhttps://en.wikipedia.org/wiki/ISO_3166-1_alpha-2\",\n \"in\": \"query\",\n \"name\": \"country\",\n \"required\": true,\n \"type\": \"string\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.entity\"\n },\n {\n \"description\": \"The attribute you want to search for in the stores, relative to the specified media type. For example, if you want to search for an artist by name specify entity=allArtist&attribute=allArtistTerm. In this example, if you search for term=maroon, iTunes returns “Maroon 5” in the search results, instead of all artists who have ever recorded a song with the word “maroon” in the title. The default is all attributes associated with the specified media type.\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html#//apple_ref/doc/uid/TP40017632-CH5-SW3\",\n \"enum\": [\n \"actorTerm\",\n \"albumTerm\",\n \"all\",\n \"allArtistTerm\",\n \"allTrackTerm\",\n \"artistTerm\",\n \"audiobook\",\n \"authorTerm\",\n \"composerTerm\",\n \"descriptionTerm\",\n \"directorTerm\",\n \"featureFilmTerm\",\n \"genreIndex\",\n \"keywordsTerm\",\n \"languageTerm\",\n \"mixTerm\",\n \"movie\",\n \"movieArtistTerm\",\n \"movieTerm\",\n \"music\",\n \"musicVideo\",\n \"podcast\",\n \"producerTerm\",\n \"ratingIndex\",\n \"ratingTerm\",\n \"releaseYearTerm\",\n \"shortFilm\",\n \"shortFilmTerm\",\n \"showTerm\",\n \"software\",\n \"softwareDeveloper\",\n \"songTerm\",\n \"titleTerm\",\n \"tvEpisodeTerm\",\n \"tvSeasonTerm\",\n \"tvShow\"\n ],\n \"in\": \"query\",\n \"name\": \"attribute\",\n \"type\": \"string\"\n },\n {\n \"$ref\": \"#/parameters/itunes-search.callback\"\n },\n {\n \"description\": \"The number of search results you want the iTunes Store to return. For example: 25. The default is 50.\",\n \"in\": \"query\",\n \"name\": \"limit\",\n \"type\": \"integer\"\n },\n {\n \"default\": \"en_us\",\n \"description\": \"The language, English or Japanese, you want to use when returning search results. Specify the language using the five-letter codename. For example: en_us. The default is en_us (English).\",\n \"enum\": [\n \"en_us\",\n \"ja_jp\"\n ],\n \"in\": \"query\",\n \"name\": \"lang\",\n \"type\": \"string\"\n },\n {\n \"default\": 2,\n \"description\": \"The search result key version you want to receive back from your search. The default is 2.\",\n \"enum\": [\n 1,\n 2\n ],\n \"in\": \"query\",\n \"name\": \"version\",\n \"type\": \"integer\"\n },\n {\n \"default\": \"Yes\",\n \"description\": \"A flag indicating whether or not you want to include explicit content in your search results. The default is Yes.\",\n \"enum\": [\n \"Yes\",\n \"No\"\n ],\n \"in\": \"query\",\n \"name\": \"explicit\",\n \"type\": \"string\"\n }\n ],\n \"responses\": {\n \"default\": {\n \"description\": \"default response\"\n }\n },\n \"tags\": [\n \"itunes-search\"\n ],\n \"x-swgg-host\": \"itunes.apple.com\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n }\n },\n \"schemes\": [\n \"https\"\n ],\n \"swagger\": \"2.0\",\n \"tags\": [\n {\n \"description\": \"iTunes Search API\\n\\nhttps://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/iTuneSearchAPI/Searching.html\",\n \"name\": \"itunes-search\",\n \"x-swgg-tags0\": \"itunes-search\"\n }\n ],\n \"x-swgg-operationIdFromPath\": true\n}\n"},"env":{"NODE_ENV":"test","npm_package_description":"this zero-dependency package will provide a swagger-client for itunes-search's web-apis, with a working web-demo","npm_package_homepage":"https://github.com/kaizhu256/node-swgg-itunes-search","npm_package_name":"swgg-itunes-search","npm_package_nameLib":"swgg_itunes_search","npm_package_version":"2018.1.16"}}});