marvel-service/docs/data/documentation/marvelservice/apiprotocol/getevents(query:headers:).json

{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEvents(query:headers:)"},"abstract":[{"text":"Fetches lists of events.","type":"text"}],"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Query-swift.struct","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":" = .init(), "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Headers-swift.struct","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":" = .init()) "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"typeIdentifier","text":"Output"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","type":"heading","anchor":"discussion","level":2},{"type":"paragraph","inlineContent":[{"type":"text","text":"Fetches lists of events with optional filters."}]},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/v1\/public\/events"},{"type":"text","text":"."}]}],"style":"note"},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/v1\/public\/events\/get(getEvents)"},{"type":"text","text":"."}]}],"style":"note"}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/marvelservice\/apiprotocol\/getevents(query:headers:)"]}],"metadata":{"extendedModule":"MarvelService","symbolKind":"method","roleHeading":"Instance Method","externalID":"s:13MarvelService11APIProtocolPAAE9getEvents5query7headersAA10OperationsOADO6OutputOAI5InputV5QueryV_AM7HeadersVtYaKF","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV","text":"Query"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","text":"getEvents"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","text":"Output"}],"title":"getEvents(query:headers:)","modules":[{"name":"MarvelService"}],"role":"symbol"},"references":{"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Input":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getevents\/input","kind":"symbol","type":"topic","title":"Operations.getEvents.Input","abstract":[],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input","navigatorTitle":[{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/APIProtocol/getEvents(query:headers:)":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol\/getEvents(query:headers:)","url":"\/documentation\/marvelservice\/apiprotocol\/getevents(query:headers:)","abstract":[{"text":"Fetches lists of events.","type":"text"}],"type":"topic","title":"getEvents(query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"},{"kind":"text","text":"("},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV5QueryV","kind":"typeIdentifier","text":"Query"},{"kind":"text","text":", "},{"kind":"externalParam","text":"headers"},{"kind":"text","text":": "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO5InputV7HeadersV","kind":"typeIdentifier","text":"Headers"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:13MarvelService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO","kind":"typeIdentifier","text":"getEvents"},{"kind":"text","text":"."},{"preciseIdentifier":"s:13MarvelService10OperationsO9getEventsO6OutputO","kind":"typeIdentifier","text":"Output"}],"kind":"symbol","role":"symbol"},"doc://MarvelService/documentation/MarvelService":{"kind":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService","role":"collection","abstract":[{"type":"text","text":"A library that allows the developer to interact with the "},{"type":"strong","inlineContent":[{"type":"text","text":"Marvel Comics API"}]},{"type":"text","text":" backend service."}],"url":"\/documentation\/marvelservice","type":"topic","title":"MarvelService"},"doc://MarvelService/documentation/MarvelService/APIProtocol":{"url":"\/documentation\/marvelservice\/apiprotocol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/APIProtocol","title":"APIProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}],"kind":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations":{"role":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","title":"Operations","url":"\/documentation\/marvelservice\/operations"},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Output":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Output","kind":"symbol","abstract":[],"type":"topic","title":"Operations.getEvents.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"url":"\/documentation\/marvelservice\/operations\/getevents\/output","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"role":"symbol"},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Input/Query-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getevents\/input\/query-swift.struct","kind":"symbol","type":"topic","title":"Operations.getEvents.Input.Query","abstract":[],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Query-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"getEvents"}],"role":"symbol","url":"\/documentation\/marvelservice\/operations\/getevents","kind":"symbol","type":"topic","title":"Operations.getEvents","abstract":[{"type":"text","text":"Fetches lists of events."}],"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents","navigatorTitle":[{"kind":"identifier","text":"getEvents"}]},"doc://MarvelService/documentation/MarvelService/Operations/getEvents/Input/Headers-swift.struct":{"url":"\/documentation\/marvelservice\/operations\/getevents\/input\/headers-swift.struct","role":"symbol","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getEvents\/Input\/Headers-swift.struct","abstract":[],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"kind":"symbol","type":"topic","title":"Operations.getEvents.Input.Headers"}}}