marvel-service/docs/data/documentation/marvelservice/operations/getcharactersbyseriesid/input/query-swift.struct.json

{"schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct","interfaceLanguage":"swift"},"relationshipsSections":[{"kind":"relationships","type":"conformsTo","title":"Conforms To","identifiers":["doc:\/\/MarvelService\/SQ","doc:\/\/MarvelService\/SH","doc:\/\/MarvelService\/s8SendableP","doc:\/\/MarvelService\/s16SendableMetatypeP"]}],"topicSections":[{"anchor":"Initializers","title":"Initializers","generated":true,"identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:events:stories:orderBy:limit:offset:)"]},{"generated":true,"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/comics","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/events","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/limit","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/modifiedSince","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/name","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/nameStartsWith","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/offset","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderBy","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/stories"]},{"generated":true,"anchor":"Type-Aliases","title":"Type Aliases","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderByPayload"]},{"generated":true,"anchor":"Enumerations","title":"Enumerations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderByPayloadPayload"]},{"generated":true,"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/Equatable-Implementations"]}],"hierarchy":{"paths":[["doc:\/\/MarvelService\/documentation\/MarvelService","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input"]]},"sections":[],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","text":"Overview","type":"heading","level":2},{"style":"note","type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/v1\/public\/series\/{seriesId}\/characters\/GET\/query"},{"text":".","type":"text"}]}]}]}],"metadata":{"modules":[{"name":"MarvelService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"externalID":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV5QueryV","navigatorTitle":[{"kind":"identifier","text":"Query"}],"roleHeading":"Structure","role":"symbol","symbolKind":"struct","title":"Operations.getCharactersBySeriesId.Input.Query"},"variants":[{"paths":["\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/name":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/name","kind":"symbol","title":"name","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/name","role":"symbol","type":"topic","abstract":[{"text":"Return only characters matching the specified full character name.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"name"},{"kind":"text","text":": "},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/init(name:nameStartsWith:modifiedSince:comics:events:stories:orderBy:limit:offset:)":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/init(name:nameStartsWith:modifiedSince:comics:events:stories:orderBy:limit:offset:)","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/init(name:namestartswith:modifiedsince:comics:events:stories:orderby:limit:offset:)","kind":"symbol","role":"symbol","title":"init(name:nameStartsWith:modifiedSince:comics:events:stories:orderBy:limit:offset:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"name"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"nameStartsWith"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"modifiedSince"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"comics"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"events"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"stories"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?, "},{"kind":"externalParam","text":"orderBy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:13MarvelService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"getCharactersBySeriesId","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Query","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV5QueryV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"orderByPayload","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV5QueryV05orderF7Payloada"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"limit"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"offset"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?)"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Query"},{"type":"text","text":"."}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/stories":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/stories","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"stories","kind":"identifier"},{"text":": [","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"},{"text":"]?","kind":"text"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/stories","title":"stories","kind":"symbol","role":"symbol","abstract":[{"text":"Return only characters which appear the specified stories (accepts a comma-separated list of ids).","type":"text"}]},"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/getCharactersBySeriesId/Input/Query-swift.struct/orderByPayload":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderByPayload","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/orderbypayload","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"orderByPayload"}],"role":"symbol","title":"Operations.getCharactersBySeriesId.Input.Query.orderByPayload","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderByPayload"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/limit":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/limit","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"limit"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/limit","title":"limit","kind":"symbol","role":"symbol","abstract":[{"text":"Limit the result set to the specified number of resources.","type":"text"}]},"doc://MarvelService/s8SendableP":{"identifier":"doc:\/\/MarvelService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/Equatable-Implementations":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/Equatable-Implementations","type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/equatable-implementations","title":"Equatable Implementations","kind":"article","role":"collectionGroup","abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input":{"navigatorTitle":[{"kind":"identifier","text":"Input"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input","kind":"symbol","title":"Operations.getCharactersBySeriesId.Input","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input","role":"symbol","type":"topic","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId","kind":"symbol","navigatorTitle":[{"text":"getCharactersBySeriesId","kind":"identifier"}],"role":"symbol","title":"Operations.getCharactersBySeriesId","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getCharactersBySeriesId","kind":"identifier"}],"abstract":[{"text":"Fetches lists of characters filtered by a series id.","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"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/comics":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/comics","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/comics","kind":"symbol","role":"symbol","title":"comics","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"comics"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"]?"}],"abstract":[{"type":"text","text":"Return only characters which appear in the specified comics (accepts a comma-separated list of ids)."}]},"doc://MarvelService/SH":{"identifier":"doc:\/\/MarvelService\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/orderBy":{"identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderBy","type":"topic","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"orderBy"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO","text":"getCharactersBySeriesId"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV","text":"Input"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV5QueryV","text":"Query"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:13MarvelService10OperationsO23getCharactersBySeriesIdO5InputV5QueryV05orderF7Payloada","text":"orderByPayload"},{"kind":"text","text":"?"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/orderby","title":"orderBy","kind":"symbol","role":"symbol","abstract":[{"text":"Order the result set by a field or fields. Add a “-” to the value sort in descending order. Multiple values are given priority in the order in which they are passed.","type":"text"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct":{"navigatorTitle":[{"kind":"identifier","text":"Query"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct","kind":"symbol","title":"Operations.getCharactersBySeriesId.Input.Query","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct","role":"symbol","type":"topic","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/orderByPayloadPayload":{"type":"topic","url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/orderbypayloadpayload","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/orderByPayloadPayload","kind":"symbol","navigatorTitle":[{"text":"orderByPayloadPayload","kind":"identifier"}],"role":"symbol","title":"Operations.getCharactersBySeriesId.Input.Query.orderByPayloadPayload","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"orderByPayloadPayload","kind":"identifier"}],"abstract":[]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/nameStartsWith":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/namestartswith","type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/nameStartsWith","kind":"symbol","role":"symbol","title":"nameStartsWith","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"nameStartsWith","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:SS","text":"String","kind":"typeIdentifier"},{"text":"?","kind":"text"}],"abstract":[{"text":"Return characters with names that begin with the specified string.","type":"text"}]},"doc://MarvelService/SQ":{"identifier":"doc:\/\/MarvelService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/modifiedSince":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/modifiedsince","kind":"symbol","title":"modifiedSince","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/modifiedSince","role":"symbol","type":"topic","abstract":[{"text":"Return only characters which have been modified since the specified date.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"modifiedSince"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/offset":{"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/offset","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/offset","type":"topic","kind":"symbol","role":"symbol","title":"offset","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"offset","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":"?","kind":"text"}],"abstract":[{"type":"text","text":"Skip the specified number of resources in the result set."}]},"doc://MarvelService/s16SendableMetatypeP":{"identifier":"doc:\/\/MarvelService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://MarvelService/documentation/MarvelService/Operations/getCharactersBySeriesId/Input/Query-swift.struct/events":{"type":"topic","identifier":"doc:\/\/MarvelService\/documentation\/MarvelService\/Operations\/getCharactersBySeriesId\/Input\/Query-swift.struct\/events","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"events"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"]?"}],"url":"\/documentation\/marvelservice\/operations\/getcharactersbyseriesid\/input\/query-swift.struct\/events","title":"events","kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Return only characters which appear comics that took place in the specified events (accepts a comma-separated list of ids)."}]}}}