Files
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:54:43 +00:00

1 line
7.0 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{"abstract":[{"text":"Add a message to an order.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/addordermessage"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AddOrderMessage","kind":"identifier"}],"navigatorTitle":[{"text":"AddOrderMessage","kind":"identifier"}],"title":"Operations.AddOrderMessage","symbolKind":"enum","externalID":"s:14DiscogsService10OperationsO15AddOrderMessageO","roleHeading":"Enumeration"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AddOrderMessage","kind":"identifier"}],"platforms":["macOS"]}]},{"content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"type":"paragraph","inlineContent":[{"text":"Adds a new message to the orders message log.","type":"text"}]},{"type":"paragraph","inlineContent":[{"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":"text"},{"inlineContent":[{"type":"text","text":"Seller changed status from Old Status to New Status"}],"type":"emphasis"}]},{"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 endpoint requires authentication as a seller."}]},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"POST \/marketplace\/orders\/{order_id}\/messages"},{"type":"text","text":"."}],"type":"paragraph"}]},{"name":"Remark","style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/marketplace\/orders\/{order_id}\/messages\/post(addOrderMessage)"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"kind":"symbol","sections":[],"topicSections":[{"title":"Structures","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input"],"anchor":"Structures"},{"title":"Type Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/id"],"anchor":"Type-Properties"},{"title":"Enumerations","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output"],"anchor":"Enumerations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AddOrderMessage"}],"kind":"symbol","role":"symbol","title":"Operations.AddOrderMessage","url":"\/documentation\/discogsservice\/operations\/addordermessage","abstract":[{"text":"Add a message to an order.","type":"text"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"AddOrderMessage"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Input":{"url":"\/documentation\/discogsservice\/operations\/addordermessage\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"abstract":[],"title":"Operations.AddOrderMessage.Input","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Input","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/id":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/id","abstract":[],"type":"topic","title":"id","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/operations\/addordermessage\/id"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/Output","type":"topic","role":"symbol","kind":"symbol","abstract":[],"title":"Operations.AddOrderMessage.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/discogsservice\/operations\/addordermessage\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/AddOrderMessage/AcceptableContentType":{"title":"Operations.AddOrderMessage.AcceptableContentType","type":"topic","url":"\/documentation\/discogsservice\/operations\/addordermessage\/acceptablecontenttype","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"AcceptableContentType","kind":"identifier"}],"navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/AddOrderMessage\/AcceptableContentType","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"role":"collection","type":"topic","title":"DiscogsService","kind":"symbol","url":"\/documentation\/discogsservice","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService","abstract":[{"type":"text","text":"A Swift client library for the Discogs API, built on top of Swift OpenAPI."}]},"doc://DiscogsService/documentation/DiscogsService/Operations":{"url":"\/documentation\/discogsservice\/operations","abstract":[{"text":"API operations, with input and output types, generated from ","type":"text"},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"symbol","type":"topic","title":"Operations"}}}