eaee2b84f0
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>
1 line
12 KiB
JSON
1 line
12 KiB
JSON
{"relationshipsSections":[{"title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","kind":"relationships"}],"sections":[],"abstract":[{"text":"A requested refund for an order, if any.","type":"text"}],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RefundPayload"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/OrderMessage\/refund"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside","style":"note"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload"},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"symbolKind":"struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RefundPayload","kind":"identifier"}],"navigatorTitle":[{"text":"RefundPayload","kind":"identifier"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO12OrderMessageV13RefundPayloadV","role":"symbol","title":"Components.Schemas.OrderMessage.RefundPayload"},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/init(amount:order:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/init(from:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/amount","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/order"],"generated":true,"anchor":"Instance-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/CodingKeys"],"generated":true,"anchor":"Enumerations"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/order":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/order","abstract":[{"type":"text","text":"A reference to an order for which a refund has been requested."}],"type":"topic","title":"order","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"order"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7OrderIdV","kind":"typeIdentifier","text":"OrderId"}],"kind":"symbol","role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/order"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"symbol","role":"symbol","type":"topic","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"code":"#\/components\/schemas","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/components\/schemas","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Schemas"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload":{"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload","navigatorTitle":[{"kind":"identifier","text":"RefundPayload"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"RefundPayload"}],"abstract":[{"text":"A requested refund for an order, if any.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload","title":"Components.Schemas.OrderMessage.RefundPayload"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/amount":{"role":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/amount","kind":"symbol","title":"amount","abstract":[{"text":"An amount for a requested refund of an order.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"amount"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/amount"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/init(from:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/init(from:)","title":"init(from:)","type":"topic","role":"symbol","kind":"symbol","abstract":[{"type":"text","text":"Creates a new instance by decoding from the given decoder."}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"preciseIdentifier":"s:s7DecoderP","kind":"typeIdentifier","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/init(amount:order:)":{"abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"RefundPayload"},{"text":".","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/init(amount:order:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"amount"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"order"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","kind":"typeIdentifier","text":"Schemas"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO7OrderIdV","kind":"typeIdentifier","text":"OrderId"},{"kind":"text","text":")"}],"title":"init(amount:order:)","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/init(amount:order:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/CodingKeys":{"title":"Components.Schemas.OrderMessage.RefundPayload.CodingKeys","type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/codingkeys","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/CodingKeys","kind":"symbol","abstract":[],"role":"symbol"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage":{"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"OrderMessage"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage","type":"topic","role":"symbol","title":"Components.Schemas.OrderMessage","abstract":[{"text":"A type that represents a message of an order.","type":"text"}],"kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"OrderMessage"}],"url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/OrderMessage/RefundPayload/Equatable-Implementations":{"kind":"article","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/ordermessage\/refundpayload\/equatable-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/OrderMessage\/RefundPayload\/Equatable-Implementations","role":"collectionGroup"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Components"}],"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Components"}],"role":"symbol","kind":"symbol","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},"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."}]}}} |