Files
discogs-service/docs/data/documentation/discogsservice/client/getcollectionvalue(path:headers:).json
T

1 line
14 KiB
JSON

{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionValue","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionValue","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionValue","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input\/Headers-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV7HeadersV"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionValue","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","text":"Discussion","level":2,"type":"heading"},{"inlineContent":[{"type":"text","text":"Returns the estimated minimum, median, and maximum values for a collection of a user."}],"type":"paragraph"},{"inlineContent":[{"text":"This endpoint requires authentication as the collection owner.","type":"text"}],"type":"paragraph"},{"name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/collection\/value"},{"type":"text","text":"."}],"type":"paragraph"}],"style":"note","type":"aside"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/collection\/value\/get(getCollectionValue)"},{"text":".","type":"text"}]}],"style":"note","type":"aside"}],"kind":"content"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"metadata":{"roleHeading":"Instance Method","extendedModule":"DiscogsService","symbolKind":"method","title":"getCollectionValue(path:headers:)","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService11APIProtocolPAAE18getCollectionValue4path7headersAA10OperationsO03GeteF0O6OutputOAJ5InputV4PathV_AN7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","role":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getCollectionValue"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier","text":"GetCollectionValue"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier","text":"GetCollectionValue"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier","text":"GetCollectionValue"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","kind":"typeIdentifier","text":"Output"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Get the estimated monetary value for a collection of a user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/getcollectionvalue(path:headers:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionValue(path:headers:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"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":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Output":{"url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetCollectionValue.Output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue":{"url":"\/documentation\/discogsservice\/operations\/getcollectionvalue","kind":"symbol","abstract":[{"type":"text","text":"Get the estimated monetary value for a collection of a user."}],"type":"topic","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionValue","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","navigatorTitle":[{"text":"GetCollectionValue","kind":"identifier"}],"title":"Operations.GetCollectionValue"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Input":{"url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/input","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.GetCollectionValue.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/Operations/GetCollectionValue/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/input\/path-swift.struct","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input\/Path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"title":"Operations.GetCollectionValue.Input.Path"},"doc://DiscogsService/documentation/DiscogsService/Client/getCollectionValue(path:headers:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getCollectionValue(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCollectionValue","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV4PathV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","kind":"typeIdentifier"}],"role":"symbol","type":"topic","title":"getCollectionValue(path:headers:)","abstract":[{"text":"Get the estimated monetary value for a collection of a user.","type":"text"}],"url":"\/documentation\/discogsservice\/client\/getcollectionvalue(path:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Input/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Input\/Headers-swift.struct","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"role":"symbol","type":"topic","title":"Operations.GetCollectionValue.Input.Headers","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/input\/headers-swift.struct"}}}