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

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