1 line
18 KiB
JSON
1 line
18 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"abstract":[{"type":"text","text":"Add a message to an order."}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/addordermessage(path:headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addOrderMessage(path:headers:body:)","interfaceLanguage":"swift"},"metadata":{"roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addOrderMessage","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","kind":"typeIdentifier","text":"Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV","kind":"typeIdentifier","text":"Path"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"headers"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"RequestBodies","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO"},{"text":".","kind":"text"},{"text":"OrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO"}],"extendedModule":"DiscogsService","role":"symbol","modules":[{"name":"DiscogsService"}],"symbolKind":"method","externalID":"s:14DiscogsService11APIProtocolPAAE15addOrderMessage4path7headers4bodyAA10OperationsO03AddeF0O6OutputOAK5InputV4PathV_AO7HeadersVAA10ComponentsO13RequestBodiesO0eF0OtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV","title":"addOrderMessage(path:headers:body:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addOrderMessage","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV","text":"Path","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Path-swift.struct"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO","text":"AddOrderMessage","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV","text":"Input","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Headers-swift.struct"},{"text":" = .init(), ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO","text":"RequestBodies","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO","text":"OrderMessage","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/OrderMessage"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Adds a new message to the order’s message log."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"When posting a new message, it is also possible to update the order status. In this case, the message will automatically be prepended with: "},{"type":"emphasis","inlineContent":[{"type":"text","text":"Seller changed status from Old Status to New Status"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"While both "},{"type":"codeVoice","code":"message"},{"type":"text","text":" and "},{"type":"codeVoice","code":"status"},{"type":"text","text":" properties are each optional, one or both must be present."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"This endpoints requires authentication as a seller."}]},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"POST \/marketplace\/orders\/{order_id}\/messages"},{"type":"text","text":"."}]}]},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/orders\/{order_id}\/messages\/post(addOrderMessage)"},{"type":"text","text":"."}]}]}]}],"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Output":{"abstract":[],"kind":"symbol","title":"Operations.AddOrderMessage.Output","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output","url":"\/documentation\/discogsservice\/operations\/addordermessage\/output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage":{"title":"Operations.AddOrderMessage","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AddOrderMessage","kind":"identifier"}],"navigatorTitle":[{"text":"AddOrderMessage","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/addordermessage","abstract":[{"type":"text","text":"Add a message to an order."}],"role":"symbol","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input":{"abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/addordermessage\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input","type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","title":"Operations.AddOrderMessage.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input/Path-swift.struct":{"title":"Operations.AddOrderMessage.Input.Path","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/addordermessage\/input\/path-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Path-swift.struct","type":"topic","navigatorTitle":[{"text":"Path","kind":"identifier"}],"kind":"symbol","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Client/addOrderMessage(path:headers:body:)":{"title":"addOrderMessage(path:headers:body:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"addOrderMessage","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO5InputV7HeadersV"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"RequestBodies","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO"},{"text":".","kind":"text"},{"text":"OrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO13RequestBodiesO12OrderMessageO"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"AddOrderMessage","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15AddOrderMessageO6OutputO"}],"role":"symbol","url":"\/documentation\/discogsservice\/client\/addordermessage(path:headers:body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/addOrderMessage(path:headers:body:)","type":"topic","kind":"symbol","abstract":[{"type":"text","text":"Add a message to an order."}]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","url":"\/documentation\/discogsservice","abstract":[],"role":"collection","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","url":"\/documentation\/discogsservice\/operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/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"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input/Headers-swift.struct":{"abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/addordermessage\/input\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input\/Headers-swift.struct","type":"topic","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"kind":"symbol","title":"Operations.AddOrderMessage.Input.Headers"},"doc://DiscogsService/documentation/DiscogsService/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"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Artists"}]},{"text":", ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Releases"}]},{"text":", and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Labels"}]},{"text":". Your application can also manage ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"User Collections"}]},{"text":" and ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Wantlists"}]},{"text":", create ","type":"text"},{"type":"emphasis","inlineContent":[{"type":"text","text":"Marketplace"}]},{"text":" listings, and more.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","title":"Client","url":"\/documentation\/discogsservice\/client","role":"symbol","navigatorTitle":[{"text":"Client","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies":{"url":"\/documentation\/discogsservice\/components\/requestbodies","title":"Components.RequestBodies","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"RequestBodies"}],"navigatorTitle":[{"kind":"identifier","text":"RequestBodies"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/requestBodies"},{"type":"text","text":" section of the OpenAPI document."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/RequestBodies/OrderMessage":{"url":"\/documentation\/discogsservice\/components\/requestbodies\/ordermessage","title":"Components.RequestBodies.OrderMessage","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"OrderMessage","kind":"identifier"}],"navigatorTitle":[{"kind":"identifier","text":"OrderMessage"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/RequestBodies\/OrderMessage","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"kind":"symbol"}}} |