Files
discogs-service/docs/data/documentation/discogsservice/client/getwantlist(_:).json
T

1 line
15 KiB
JSON

{"metadata":{"roleHeading":"Instance Method","role":"symbol","modules":[{"name":"DiscogsService"}],"symbolKind":"method","title":"getWantlist(_:)","externalID":"s:14DiscogsService6ClientV11getWantlistyAA10OperationsO03GetE0O6OutputOAH5InputVYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO","kind":"typeIdentifier","text":"GetWantlist"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO","kind":"typeIdentifier","text":"GetWantlist"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO","kind":"typeIdentifier","text":"Output"}]},"variants":[{"paths":["\/documentation\/discogsservice\/client\/getwantlist(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getWantlist","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"input"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO","kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output"}]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","text":"Discussion","level":2},{"type":"paragraph","inlineContent":[{"text":"Returnss the list of releases in a wantlist of a user. Accepts Pagination parameters.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"If the wantlist has been made private by its owner, you must be authenticated as the owner to view it.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"The notes field will be visible if you are authenticated as the wantlist owner.","type":"text"}]},{"content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/wants"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark","style":"note"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/wants\/get(getWantlist)"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","name":"Remark","style":"note"}]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"abstract":[{"text":"Get a list of releases in a wantlist of a user.","type":"text"}],"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"],"title":"User Wantlist","generated":true,"anchor":"User-Wantlist"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Client/updateInWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/updateinwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Update a release into a wantlist of a user."}],"title":"updateInWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"updateInWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"UpdateInWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO16UpdateInWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/updateInWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Client/deleteFromWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/deletefromwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Delete a release from a wantlist of a user."}],"title":"deleteFromWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"deleteFromWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"DeleteFromWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18DeleteFromWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/deleteFromWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist":{"type":"topic","navigatorTitle":[{"text":"GetWantlist","kind":"identifier"}],"title":"Operations.GetWantlist","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetWantlist","kind":"identifier"}],"abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getwantlist"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/Input":{"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getwantlist\/input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","kind":"symbol","title":"Operations.GetWantlist.Input"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"},"doc://DiscogsService/documentation/DiscogsService/Client/getWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/getwantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"title":"getWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO11GetWantlistO6OutputO"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/operations"},"doc://DiscogsService/documentation/DiscogsService/Client/addToWantlist(_:)":{"url":"\/documentation\/discogsservice\/client\/addtowantlist(_:)","role":"symbol","abstract":[{"type":"text","text":"Add a release into a wantlist of a user."}],"title":"addToWantlist(_:)","type":"topic","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"addToWantlist"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO5InputV"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"AddToWantlist","preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO13AddToWantlistO6OutputO","text":"Output","kind":"typeIdentifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addToWantlist(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/Output":{"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetWantlist.Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getwantlist\/output"}}}