+5

.changeset/thirty-shoes-judge.md

··· 1 1 + --- 2 2 + "@hey-api/openapi-ts": patch 3 3 + --- 4 4 + 5 5 + **output**: default to `.js` extension when module resolution is set to `node16`

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'http://localhost:3000/base' }));

+261

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { HttpResponse } from '@angular/common/http'; 4 4 + import { 5 5 + HttpClient, 6 6 + HttpErrorResponse, 7 7 + HttpEventType, 8 8 + HttpRequest, 9 9 + } from '@angular/common/http'; 10 10 + import { 11 11 + assertInInjectionContext, 12 12 + inject, 13 13 + provideAppInitializer, 14 14 + runInInjectionContext, 15 15 + } from '@angular/core'; 16 16 + import { firstValueFrom } from 'rxjs'; 17 17 + import { filter } from 'rxjs/operators'; 18 18 + 19 19 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 20 20 + import type { HttpMethod } from '../core/types.gen.js'; 21 21 + import { getValidRequestBody } from '../core/utils.gen.js'; 22 22 + import type { 23 23 + Client, 24 24 + Config, 25 25 + RequestOptions, 26 26 + ResolvedRequestOptions, 27 27 + ResponseStyle, 28 28 + } from './types.gen.js'; 29 29 + import { 30 30 + buildUrl, 31 31 + createConfig, 32 32 + createInterceptors, 33 33 + mergeConfigs, 34 34 + mergeHeaders, 35 35 + setAuthParams, 36 36 + } from './utils.gen.js'; 37 37 + 38 38 + export function provideHeyApiClient(client: Client) { 39 39 + return provideAppInitializer(() => { 40 40 + const httpClient = inject(HttpClient); 41 41 + client.setConfig({ httpClient }); 42 42 + }); 43 43 + } 44 44 + 45 45 + export const createClient = (config: Config = {}): Client => { 46 46 + let _config = mergeConfigs(createConfig(), config); 47 47 + 48 48 + const getConfig = (): Config => ({ ..._config }); 49 49 + 50 50 + const setConfig = (config: Config): Config => { 51 51 + _config = mergeConfigs(_config, config); 52 52 + return getConfig(); 53 53 + }; 54 54 + 55 55 + const interceptors = createInterceptors< 56 56 + HttpRequest<unknown>, 57 57 + HttpResponse<unknown>, 58 58 + unknown, 59 59 + ResolvedRequestOptions 60 60 + >(); 61 61 + 62 62 + const requestOptions = < 63 63 + ThrowOnError extends boolean = false, 64 64 + TResponseStyle extends ResponseStyle = 'fields', 65 65 + >( 66 66 + options: RequestOptions<unknown, TResponseStyle, ThrowOnError>, 67 67 + ) => { 68 68 + const opts = { 69 69 + ..._config, 70 70 + ...options, 71 71 + headers: mergeHeaders(_config.headers, options.headers), 72 72 + httpClient: options.httpClient ?? _config.httpClient, 73 73 + serializedBody: undefined, 74 74 + }; 75 75 + 76 76 + if (!opts.httpClient) { 77 77 + if (opts.injector) { 78 78 + opts.httpClient = runInInjectionContext(opts.injector, () => 79 79 + inject(HttpClient), 80 80 + ); 81 81 + } else { 82 82 + assertInInjectionContext(requestOptions); 83 83 + opts.httpClient = inject(HttpClient); 84 84 + } 85 85 + } 86 86 + 87 87 + if (opts.body !== undefined && opts.bodySerializer) { 88 88 + opts.serializedBody = opts.bodySerializer(opts.body); 89 89 + } 90 90 + 91 91 + // remove Content-Type header if body is empty to avoid sending invalid requests 92 92 + if (opts.body === undefined || opts.serializedBody === '') { 93 93 + opts.headers.delete('Content-Type'); 94 94 + } 95 95 + 96 96 + const url = buildUrl(opts as any); 97 97 + 98 98 + const req = new HttpRequest<unknown>( 99 99 + opts.method ?? 'GET', 100 100 + url, 101 101 + getValidRequestBody(opts), 102 102 + { 103 103 + redirect: 'follow', 104 104 + ...opts, 105 105 + }, 106 106 + ); 107 107 + 108 108 + return { opts, req, url }; 109 109 + }; 110 110 + 111 111 + const beforeRequest = async (options: RequestOptions) => { 112 112 + const { opts, req, url } = requestOptions(options); 113 113 + 114 114 + if (opts.security) { 115 115 + await setAuthParams({ 116 116 + ...opts, 117 117 + security: opts.security, 118 118 + }); 119 119 + } 120 120 + 121 121 + if (opts.requestValidator) { 122 122 + await opts.requestValidator(opts); 123 123 + } 124 124 + 125 125 + return { opts, req, url }; 126 126 + }; 127 127 + 128 128 + const request: Client['request'] = async (options) => { 129 129 + // @ts-expect-error 130 130 + const { opts, req: initialReq } = await beforeRequest(options); 131 131 + 132 132 + let req = initialReq; 133 133 + 134 134 + for (const fn of interceptors.request.fns) { 135 135 + if (fn) { 136 136 + req = await fn(req, opts as any); 137 137 + } 138 138 + } 139 139 + 140 140 + const result: { 141 141 + request: HttpRequest<unknown>; 142 142 + response: any; 143 143 + } = { 144 144 + request: req, 145 145 + response: null, 146 146 + }; 147 147 + 148 148 + try { 149 149 + result.response = (await firstValueFrom( 150 150 + opts 151 151 + .httpClient!.request(req) 152 152 + .pipe(filter((event) => event.type === HttpEventType.Response)), 153 153 + )) as HttpResponse<unknown>; 154 154 + 155 155 + for (const fn of interceptors.response.fns) { 156 156 + if (fn) { 157 157 + result.response = await fn(result.response, req, opts as any); 158 158 + } 159 159 + } 160 160 + 161 161 + let bodyResponse = result.response.body; 162 162 + 163 163 + if (opts.responseValidator) { 164 164 + await opts.responseValidator(bodyResponse); 165 165 + } 166 166 + 167 167 + if (opts.responseTransformer) { 168 168 + bodyResponse = await opts.responseTransformer(bodyResponse); 169 169 + } 170 170 + 171 171 + return opts.responseStyle === 'data' 172 172 + ? bodyResponse 173 173 + : { data: bodyResponse, ...result }; 174 174 + } catch (error) { 175 175 + if (error instanceof HttpErrorResponse) { 176 176 + result.response = error; 177 177 + } 178 178 + 179 179 + let finalError = error instanceof HttpErrorResponse ? error.error : error; 180 180 + 181 181 + for (const fn of interceptors.error.fns) { 182 182 + if (fn) { 183 183 + finalError = (await fn( 184 184 + finalError, 185 185 + result.response as any, 186 186 + req, 187 187 + opts as any, 188 188 + )) as string; 189 189 + } 190 190 + } 191 191 + 192 192 + if (opts.throwOnError) { 193 193 + throw finalError; 194 194 + } 195 195 + 196 196 + return opts.responseStyle === 'data' 197 197 + ? undefined 198 198 + : { 199 199 + error: finalError, 200 200 + ...result, 201 201 + }; 202 202 + } 203 203 + }; 204 204 + 205 205 + const makeMethodFn = 206 206 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 207 207 + request({ ...options, method }); 208 208 + 209 209 + const makeSseFn = 210 210 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 211 211 + const { opts, url } = await beforeRequest(options); 212 212 + return createSseClient({ 213 213 + ...opts, 214 214 + body: opts.body as BodyInit | null | undefined, 215 215 + headers: opts.headers as unknown as Record<string, string>, 216 216 + method, 217 217 + url, 218 218 + }); 219 219 + }; 220 220 + 221 221 + return { 222 222 + buildUrl, 223 223 + connect: makeMethodFn('CONNECT'), 224 224 + delete: makeMethodFn('DELETE'), 225 225 + get: makeMethodFn('GET'), 226 226 + getConfig, 227 227 + head: makeMethodFn('HEAD'), 228 228 + interceptors, 229 229 + options: makeMethodFn('OPTIONS'), 230 230 + patch: makeMethodFn('PATCH'), 231 231 + post: makeMethodFn('POST'), 232 232 + put: makeMethodFn('PUT'), 233 233 + request, 234 234 + requestOptions: (options) => { 235 235 + if (options.security) { 236 236 + throw new Error('Security is not supported in requestOptions'); 237 237 + } 238 238 + 239 239 + if (options.requestValidator) { 240 240 + throw new Error( 241 241 + 'Request validation is not supported in requestOptions', 242 242 + ); 243 243 + } 244 244 + 245 245 + return requestOptions(options).req; 246 246 + }, 247 247 + setConfig, 248 248 + sse: { 249 249 + connect: makeSseFn('CONNECT'), 250 250 + delete: makeSseFn('DELETE'), 251 251 + get: makeSseFn('GET'), 252 252 + head: makeSseFn('HEAD'), 253 253 + options: makeSseFn('OPTIONS'), 254 254 + patch: makeSseFn('PATCH'), 255 255 + post: makeSseFn('POST'), 256 256 + put: makeSseFn('PUT'), 257 257 + trace: makeSseFn('TRACE'), 258 258 + }, 259 259 + trace: makeMethodFn('TRACE'), 260 260 + } as Client; 261 261 + };

+25

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + ResolvedRequestOptions, 22 22 + ResponseStyle, 23 23 + TDataShape, 24 24 + } from './types.gen.js'; 25 25 + export { createConfig, mergeHeaders } from './utils.gen.js';

+256

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + HttpClient, 5 5 + HttpErrorResponse, 6 6 + HttpHeaders, 7 7 + HttpRequest, 8 8 + HttpResponse, 9 9 + } from '@angular/common/http'; 10 10 + import type { Injector } from '@angular/core'; 11 11 + 12 12 + import type { Auth } from '../core/auth.gen.js'; 13 13 + import type { 14 14 + ServerSentEventsOptions, 15 15 + ServerSentEventsResult, 16 16 + } from '../core/serverSentEvents.gen.js'; 17 17 + import type { 18 18 + Client as CoreClient, 19 19 + Config as CoreConfig, 20 20 + } from '../core/types.gen.js'; 21 21 + import type { Middleware } from './utils.gen.js'; 22 22 + 23 23 + export type ResponseStyle = 'data' | 'fields'; 24 24 + 25 25 + export interface Config<T extends ClientOptions = ClientOptions> 26 26 + extends Omit<RequestInit, 'body' | 'headers' | 'method'>, 27 27 + Omit<CoreConfig, 'headers'> { 28 28 + /** 29 29 + * Base URL for all requests made by this client. 30 30 + */ 31 31 + baseUrl?: T['baseUrl']; 32 32 + /** 33 33 + * An object containing any HTTP headers that you want to pre-populate your 34 34 + * `HttpHeaders` object with. 35 35 + * 36 36 + * {@link https://angular.dev/api/common/http/HttpHeaders#constructor See more} 37 37 + */ 38 38 + headers?: 39 39 + | HttpHeaders 40 40 + | Record< 41 41 + string, 42 42 + | string 43 43 + | number 44 44 + | boolean 45 45 + | (string | number | boolean)[] 46 46 + | null 47 47 + | undefined 48 48 + | unknown 49 49 + >; 50 50 + /** 51 51 + * The HTTP client to use for making requests. 52 52 + */ 53 53 + httpClient?: HttpClient; 54 54 + /** 55 55 + * Should we return only data or multiple fields (data, error, response, etc.)? 56 56 + * 57 57 + * @default 'fields' 58 58 + */ 59 59 + responseStyle?: ResponseStyle; 60 60 + 61 61 + /** 62 62 + * Throw an error instead of returning it in the response? 63 63 + * 64 64 + * @default false 65 65 + */ 66 66 + throwOnError?: T['throwOnError']; 67 67 + } 68 68 + 69 69 + export interface RequestOptions< 70 70 + TData = unknown, 71 71 + TResponseStyle extends ResponseStyle = 'fields', 72 72 + ThrowOnError extends boolean = boolean, 73 73 + Url extends string = string, 74 74 + > extends Config<{ 75 75 + responseStyle: TResponseStyle; 76 76 + throwOnError: ThrowOnError; 77 77 + }>, 78 78 + Pick< 79 79 + ServerSentEventsOptions<TData>, 80 80 + | 'onSseError' 81 81 + | 'onSseEvent' 82 82 + | 'sseDefaultRetryDelay' 83 83 + | 'sseMaxRetryAttempts' 84 84 + | 'sseMaxRetryDelay' 85 85 + > { 86 86 + /** 87 87 + * Any body that you want to add to your request. 88 88 + * 89 89 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 90 90 + */ 91 91 + body?: unknown; 92 92 + /** 93 93 + * Optional custom injector for dependency resolution if you don't implicitly or explicitly provide one. 94 94 + */ 95 95 + injector?: Injector; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + /** 99 99 + * Security mechanism(s) to use for the request. 100 100 + */ 101 101 + security?: ReadonlyArray<Auth>; 102 102 + url: Url; 103 103 + } 104 104 + 105 105 + export interface ResolvedRequestOptions< 106 106 + TResponseStyle extends ResponseStyle = 'fields', 107 107 + ThrowOnError extends boolean = boolean, 108 108 + Url extends string = string, 109 109 + > extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> { 110 110 + serializedBody?: string; 111 111 + } 112 112 + 113 113 + export type RequestResult< 114 114 + TData = unknown, 115 115 + TError = unknown, 116 116 + ThrowOnError extends boolean = boolean, 117 117 + TResponseStyle extends ResponseStyle = 'fields', 118 118 + > = Promise< 119 119 + ThrowOnError extends true 120 120 + ? TResponseStyle extends 'data' 121 121 + ? TData extends Record<string, unknown> 122 122 + ? TData[keyof TData] 123 123 + : TData 124 124 + : { 125 125 + data: TData extends Record<string, unknown> 126 126 + ? TData[keyof TData] 127 127 + : TData; 128 128 + request: HttpRequest<unknown>; 129 129 + response: HttpResponse<TData>; 130 130 + } 131 131 + : TResponseStyle extends 'data' 132 132 + ? 133 133 + | (TData extends Record<string, unknown> ? TData[keyof TData] : TData) 134 134 + | undefined 135 135 + : 136 136 + | { 137 137 + data: TData extends Record<string, unknown> 138 138 + ? TData[keyof TData] 139 139 + : TData; 140 140 + error: undefined; 141 141 + request: HttpRequest<unknown>; 142 142 + response: HttpResponse<TData>; 143 143 + } 144 144 + | { 145 145 + data: undefined; 146 146 + error: TError[keyof TError]; 147 147 + request: HttpRequest<unknown>; 148 148 + response: HttpErrorResponse & { 149 149 + error: TError[keyof TError] | null; 150 150 + }; 151 151 + } 152 152 + >; 153 153 + 154 154 + export interface ClientOptions { 155 155 + baseUrl?: string; 156 156 + responseStyle?: ResponseStyle; 157 157 + throwOnError?: boolean; 158 158 + } 159 159 + 160 160 + type MethodFn = < 161 161 + TData = unknown, 162 162 + TError = unknown, 163 163 + ThrowOnError extends boolean = false, 164 164 + TResponseStyle extends ResponseStyle = 'fields', 165 165 + >( 166 166 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 167 167 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 168 168 + 169 169 + type SseFn = < 170 170 + TData = unknown, 171 171 + TError = unknown, 172 172 + ThrowOnError extends boolean = false, 173 173 + TResponseStyle extends ResponseStyle = 'fields', 174 174 + >( 175 175 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 176 176 + ) => Promise<ServerSentEventsResult<TData, TError>>; 177 177 + 178 178 + type RequestFn = < 179 179 + TData = unknown, 180 180 + TError = unknown, 181 181 + ThrowOnError extends boolean = false, 182 182 + TResponseStyle extends ResponseStyle = 'fields', 183 183 + >( 184 184 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & 185 185 + Pick< 186 186 + Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 187 187 + 'method' 188 188 + >, 189 189 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 190 190 + 191 191 + type RequestOptionsFn = < 192 192 + ThrowOnError extends boolean = false, 193 193 + TResponseStyle extends ResponseStyle = 'fields', 194 194 + >( 195 195 + options: RequestOptions<unknown, TResponseStyle, ThrowOnError>, 196 196 + ) => HttpRequest<unknown>; 197 197 + 198 198 + type BuildUrlFn = < 199 199 + TData extends { 200 200 + body?: unknown; 201 201 + path?: Record<string, unknown>; 202 202 + query?: Record<string, unknown>; 203 203 + url: string; 204 204 + }, 205 205 + >( 206 206 + options: TData & Options<TData>, 207 207 + ) => string; 208 208 + 209 209 + export type Client = CoreClient< 210 210 + RequestFn, 211 211 + Config, 212 212 + MethodFn, 213 213 + BuildUrlFn, 214 214 + SseFn 215 215 + > & { 216 216 + interceptors: Middleware< 217 217 + HttpRequest<unknown>, 218 218 + HttpResponse<unknown>, 219 219 + unknown, 220 220 + ResolvedRequestOptions 221 221 + >; 222 222 + requestOptions: RequestOptionsFn; 223 223 + }; 224 224 + 225 225 + /** 226 226 + * The `createClientConfig()` function will be called on client initialization 227 227 + * and the returned object will become the client's initial configuration. 228 228 + * 229 229 + * You may want to initialize your client this way instead of calling 230 230 + * `setConfig()`. This is useful for example if you're using Next.js 231 231 + * to ensure your client always has the correct values. 232 232 + */ 233 233 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 234 234 + override?: Config<ClientOptions & T>, 235 235 + ) => Config<Required<ClientOptions> & T>; 236 236 + 237 237 + export interface TDataShape { 238 238 + body?: unknown; 239 239 + headers?: unknown; 240 240 + path?: unknown; 241 241 + query?: unknown; 242 242 + url: string; 243 243 + } 244 244 + 245 245 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 246 246 + 247 247 + export type Options< 248 248 + TData extends TDataShape = TDataShape, 249 249 + ThrowOnError extends boolean = boolean, 250 250 + TResponse = unknown, 251 251 + TResponseStyle extends ResponseStyle = 'fields', 252 252 + > = OmitKeys< 253 253 + RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 254 254 + 'body' | 'path' | 'query' | 'url' 255 255 + > & 256 256 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+426

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { HttpHeaders } from '@angular/common/http'; 4 4 + 5 5 + import { getAuthToken } from '../core/auth.gen.js'; 6 6 + import type { 7 7 + QuerySerializer, 8 8 + QuerySerializerOptions, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + import { 11 11 + serializeArrayParam, 12 12 + serializeObjectParam, 13 13 + serializePrimitiveParam, 14 14 + } from '../core/pathSerializer.gen.js'; 15 15 + import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js'; 16 16 + 17 17 + interface PathSerializer { 18 18 + path: Record<string, unknown>; 19 19 + url: string; 20 20 + } 21 21 + 22 22 + const PATH_PARAM_RE = /\{[^{}]+\}/g; 23 23 + 24 24 + type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 25 25 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 26 26 + type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 27 27 + 28 28 + const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 29 29 + let url = _url; 30 30 + const matches = _url.match(PATH_PARAM_RE); 31 31 + if (matches) { 32 32 + for (const match of matches) { 33 33 + let explode = false; 34 34 + let name = match.substring(1, match.length - 1); 35 35 + let style: ArraySeparatorStyle = 'simple'; 36 36 + 37 37 + if (name.endsWith('*')) { 38 38 + explode = true; 39 39 + name = name.substring(0, name.length - 1); 40 40 + } 41 41 + 42 42 + if (name.startsWith('.')) { 43 43 + name = name.substring(1); 44 44 + style = 'label'; 45 45 + } else if (name.startsWith(';')) { 46 46 + name = name.substring(1); 47 47 + style = 'matrix'; 48 48 + } 49 49 + 50 50 + const value = path[name]; 51 51 + 52 52 + if (value === undefined || value === null) { 53 53 + continue; 54 54 + } 55 55 + 56 56 + if (Array.isArray(value)) { 57 57 + url = url.replace( 58 58 + match, 59 59 + serializeArrayParam({ explode, name, style, value }), 60 60 + ); 61 61 + continue; 62 62 + } 63 63 + 64 64 + if (typeof value === 'object') { 65 65 + url = url.replace( 66 66 + match, 67 67 + serializeObjectParam({ 68 68 + explode, 69 69 + name, 70 70 + style, 71 71 + value: value as Record<string, unknown>, 72 72 + valueOnly: true, 73 73 + }), 74 74 + ); 75 75 + continue; 76 76 + } 77 77 + 78 78 + if (style === 'matrix') { 79 79 + url = url.replace( 80 80 + match, 81 81 + `;${serializePrimitiveParam({ 82 82 + name, 83 83 + value: value as string, 84 84 + })}`, 85 85 + ); 86 86 + continue; 87 87 + } 88 88 + 89 89 + const replaceValue = encodeURIComponent( 90 90 + style === 'label' ? `.${value as string}` : (value as string), 91 91 + ); 92 92 + url = url.replace(match, replaceValue); 93 93 + } 94 94 + } 95 95 + return url; 96 96 + }; 97 97 + 98 98 + export const createQuerySerializer = <T = unknown>({ 99 99 + parameters = {}, 100 100 + ...args 101 101 + }: QuerySerializerOptions = {}) => { 102 102 + const querySerializer = (queryParams: T) => { 103 103 + const search: string[] = []; 104 104 + if (queryParams && typeof queryParams === 'object') { 105 105 + for (const name in queryParams) { 106 106 + const value = queryParams[name]; 107 107 + 108 108 + if (value === undefined || value === null) { 109 109 + continue; 110 110 + } 111 111 + 112 112 + const options = parameters[name] || args; 113 113 + 114 114 + if (Array.isArray(value)) { 115 115 + const serializedArray = serializeArrayParam({ 116 116 + allowReserved: options.allowReserved, 117 117 + explode: true, 118 118 + name, 119 119 + style: 'form', 120 120 + value, 121 121 + ...options.array, 122 122 + }); 123 123 + if (serializedArray) search.push(serializedArray); 124 124 + } else if (typeof value === 'object') { 125 125 + const serializedObject = serializeObjectParam({ 126 126 + allowReserved: options.allowReserved, 127 127 + explode: true, 128 128 + name, 129 129 + style: 'deepObject', 130 130 + value: value as Record<string, unknown>, 131 131 + ...options.object, 132 132 + }); 133 133 + if (serializedObject) search.push(serializedObject); 134 134 + } else { 135 135 + const serializedPrimitive = serializePrimitiveParam({ 136 136 + allowReserved: options.allowReserved, 137 137 + name, 138 138 + value: value as string, 139 139 + }); 140 140 + if (serializedPrimitive) search.push(serializedPrimitive); 141 141 + } 142 142 + } 143 143 + } 144 144 + return search.join('&'); 145 145 + }; 146 146 + return querySerializer; 147 147 + }; 148 148 + 149 149 + /** 150 150 + * Infers parseAs value from provided Content-Type header. 151 151 + */ 152 152 + export const getParseAs = ( 153 153 + contentType: string | null, 154 154 + ): 'blob' | 'formData' | 'json' | 'stream' | 'text' | undefined => { 155 155 + if (!contentType) { 156 156 + // If no Content-Type header is provided, the best we can do is return the raw response body, 157 157 + // which is effectively the same as the 'stream' option. 158 158 + return 'stream'; 159 159 + } 160 160 + 161 161 + const cleanContent = contentType.split(';')[0]?.trim(); 162 162 + 163 163 + if (!cleanContent) { 164 164 + return; 165 165 + } 166 166 + 167 167 + if ( 168 168 + cleanContent.startsWith('application/json') || 169 169 + cleanContent.endsWith('+json') 170 170 + ) { 171 171 + return 'json'; 172 172 + } 173 173 + 174 174 + if (cleanContent === 'multipart/form-data') { 175 175 + return 'formData'; 176 176 + } 177 177 + 178 178 + if ( 179 179 + ['application/', 'audio/', 'image/', 'video/'].some((type) => 180 180 + cleanContent.startsWith(type), 181 181 + ) 182 182 + ) { 183 183 + return 'blob'; 184 184 + } 185 185 + 186 186 + if (cleanContent.startsWith('text/')) { 187 187 + return 'text'; 188 188 + } 189 189 + 190 190 + return; 191 191 + }; 192 192 + 193 193 + export const setAuthParams = async ( 194 194 + options: Pick<Required<RequestOptions>, 'security'> & 195 195 + Pick<RequestOptions, 'auth' | 'query'> & { 196 196 + headers: HttpHeaders; 197 197 + }, 198 198 + ) => { 199 199 + for (const auth of options.security) { 200 200 + const token = await getAuthToken(auth, options.auth); 201 201 + 202 202 + if (!token) { 203 203 + continue; 204 204 + } 205 205 + 206 206 + const name = auth.name ?? 'Authorization'; 207 207 + 208 208 + switch (auth.in) { 209 209 + case 'query': 210 210 + if (!options.query) { 211 211 + options.query = {}; 212 212 + } 213 213 + options.query[name] = token; 214 214 + break; 215 215 + case 'cookie': 216 216 + options.headers = options.headers.append('Cookie', `${name}=${token}`); 217 217 + break; 218 218 + case 'header': 219 219 + default: 220 220 + options.headers = options.headers.set(name, token); 221 221 + break; 222 222 + } 223 223 + 224 224 + return; 225 225 + } 226 226 + }; 227 227 + 228 228 + export const buildUrl: Client['buildUrl'] = (options) => { 229 229 + const url = getUrl({ 230 230 + baseUrl: options.baseUrl as string, 231 231 + path: options.path, 232 232 + query: options.query, 233 233 + querySerializer: 234 234 + typeof options.querySerializer === 'function' 235 235 + ? options.querySerializer 236 236 + : createQuerySerializer(options.querySerializer), 237 237 + url: options.url, 238 238 + }); 239 239 + return url; 240 240 + }; 241 241 + 242 242 + export const getUrl = ({ 243 243 + baseUrl, 244 244 + path, 245 245 + query, 246 246 + querySerializer, 247 247 + url: _url, 248 248 + }: { 249 249 + baseUrl?: string; 250 250 + path?: Record<string, unknown>; 251 251 + query?: Record<string, unknown>; 252 252 + querySerializer: QuerySerializer; 253 253 + url: string; 254 254 + }) => { 255 255 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 256 256 + let url = (baseUrl ?? '') + pathUrl; 257 257 + if (path) { 258 258 + url = defaultPathSerializer({ path, url }); 259 259 + } 260 260 + let search = query ? querySerializer(query) : ''; 261 261 + if (search.startsWith('?')) { 262 262 + search = search.substring(1); 263 263 + } 264 264 + if (search) { 265 265 + url += `?${search}`; 266 266 + } 267 267 + return url; 268 268 + }; 269 269 + 270 270 + export const mergeConfigs = (a: Config, b: Config): Config => { 271 271 + const config = { ...a, ...b }; 272 272 + if (config.baseUrl?.endsWith('/')) { 273 273 + config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1); 274 274 + } 275 275 + config.headers = mergeHeaders(a.headers, b.headers); 276 276 + return config; 277 277 + }; 278 278 + 279 279 + export const mergeHeaders = ( 280 280 + ...headers: Array<Required<Config>['headers'] | undefined> 281 281 + ): HttpHeaders => { 282 282 + let mergedHeaders = new HttpHeaders(); 283 283 + 284 284 + for (const header of headers) { 285 285 + if (!header || typeof header !== 'object') { 286 286 + continue; 287 287 + } 288 288 + 289 289 + if (header instanceof HttpHeaders) { 290 290 + // Merge HttpHeaders instance 291 291 + header.keys().forEach((key) => { 292 292 + const values = header.getAll(key); 293 293 + if (values) { 294 294 + values.forEach((value) => { 295 295 + mergedHeaders = mergedHeaders.append(key, value); 296 296 + }); 297 297 + } 298 298 + }); 299 299 + } else { 300 300 + // Merge plain object headers 301 301 + for (const [key, value] of Object.entries(header)) { 302 302 + if (value === null) { 303 303 + mergedHeaders = mergedHeaders.delete(key); 304 304 + } else if (Array.isArray(value)) { 305 305 + for (const v of value) { 306 306 + mergedHeaders = mergedHeaders.append(key, v as string); 307 307 + } 308 308 + } else if (value !== undefined) { 309 309 + // assume object headers are meant to be JSON stringified, i.e. their 310 310 + // content value in OpenAPI specification is 'application/json' 311 311 + mergedHeaders = mergedHeaders.set( 312 312 + key, 313 313 + typeof value === 'object' 314 314 + ? JSON.stringify(value) 315 315 + : (value as string), 316 316 + ); 317 317 + } 318 318 + } 319 319 + } 320 320 + } 321 321 + 322 322 + return mergedHeaders; 323 323 + }; 324 324 + 325 325 + type ErrInterceptor<Err, Res, Req, Options> = ( 326 326 + error: Err, 327 327 + response: Res, 328 328 + request: Req, 329 329 + options: Options, 330 330 + ) => Err | Promise<Err>; 331 331 + 332 332 + type ReqInterceptor<Req, Options> = ( 333 333 + request: Req, 334 334 + options: Options, 335 335 + ) => Req | Promise<Req>; 336 336 + 337 337 + type ResInterceptor<Res, Req, Options> = ( 338 338 + response: Res, 339 339 + request: Req, 340 340 + options: Options, 341 341 + ) => Res | Promise<Res>; 342 342 + 343 343 + class Interceptors<Interceptor> { 344 344 + fns: Array<Interceptor | null> = []; 345 345 + 346 346 + clear(): void { 347 347 + this.fns = []; 348 348 + } 349 349 + 350 350 + eject(id: number | Interceptor): void { 351 351 + const index = this.getInterceptorIndex(id); 352 352 + if (this.fns[index]) { 353 353 + this.fns[index] = null; 354 354 + } 355 355 + } 356 356 + 357 357 + exists(id: number | Interceptor): boolean { 358 358 + const index = this.getInterceptorIndex(id); 359 359 + return Boolean(this.fns[index]); 360 360 + } 361 361 + 362 362 + getInterceptorIndex(id: number | Interceptor): number { 363 363 + if (typeof id === 'number') { 364 364 + return this.fns[id] ? id : -1; 365 365 + } 366 366 + return this.fns.indexOf(id); 367 367 + } 368 368 + 369 369 + update( 370 370 + id: number | Interceptor, 371 371 + fn: Interceptor, 372 372 + ): number | Interceptor | false { 373 373 + const index = this.getInterceptorIndex(id); 374 374 + if (this.fns[index]) { 375 375 + this.fns[index] = fn; 376 376 + return id; 377 377 + } 378 378 + return false; 379 379 + } 380 380 + 381 381 + use(fn: Interceptor): number { 382 382 + this.fns.push(fn); 383 383 + return this.fns.length - 1; 384 384 + } 385 385 + } 386 386 + 387 387 + export interface Middleware<Req, Res, Err, Options> { 388 388 + error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>; 389 389 + request: Interceptors<ReqInterceptor<Req, Options>>; 390 390 + response: Interceptors<ResInterceptor<Res, Req, Options>>; 391 391 + } 392 392 + 393 393 + export const createInterceptors = <Req, Res, Err, Options>(): Middleware< 394 394 + Req, 395 395 + Res, 396 396 + Err, 397 397 + Options 398 398 + > => ({ 399 399 + error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(), 400 400 + request: new Interceptors<ReqInterceptor<Req, Options>>(), 401 401 + response: new Interceptors<ResInterceptor<Res, Req, Options>>(), 402 402 + }); 403 403 + 404 404 + const defaultQuerySerializer = createQuerySerializer({ 405 405 + allowReserved: false, 406 406 + array: { 407 407 + explode: true, 408 408 + style: 'form', 409 409 + }, 410 410 + object: { 411 411 + explode: true, 412 412 + style: 'deepObject', 413 413 + }, 414 414 + }); 415 415 + 416 416 + const defaultHeaders = { 417 417 + 'Content-Type': 'application/json', 418 418 + }; 419 419 + 420 420 + export const createConfig = <T extends ClientOptions = ClientOptions>( 421 421 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 422 422 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 423 423 + headers: defaultHeaders, 424 424 + querySerializer: defaultQuerySerializer, 425 425 + ...override, 426 426 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options?.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options?.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-angular/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseUrl: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseURL: 'http://localhost:3000/base' }));

+163

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { AxiosError, AxiosInstance, RawAxiosRequestHeaders } from 'axios'; 4 4 + import axios from 'axios'; 5 5 + 6 6 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 7 7 + import type { HttpMethod } from '../core/types.gen.js'; 8 8 + import { getValidRequestBody } from '../core/utils.gen.js'; 9 9 + import type { Client, Config, RequestOptions } from './types.gen.js'; 10 10 + import { 11 11 + buildUrl, 12 12 + createConfig, 13 13 + mergeConfigs, 14 14 + mergeHeaders, 15 15 + setAuthParams, 16 16 + } from './utils.gen.js'; 17 17 + 18 18 + export const createClient = (config: Config = {}): Client => { 19 19 + let _config = mergeConfigs(createConfig(), config); 20 20 + 21 21 + let instance: AxiosInstance; 22 22 + 23 23 + if (_config.axios && !('Axios' in _config.axios)) { 24 24 + instance = _config.axios; 25 25 + } else { 26 26 + // eslint-disable-next-line @typescript-eslint/no-unused-vars 27 27 + const { auth, ...configWithoutAuth } = _config; 28 28 + instance = axios.create(configWithoutAuth); 29 29 + } 30 30 + 31 31 + const getConfig = (): Config => ({ ..._config }); 32 32 + 33 33 + const setConfig = (config: Config): Config => { 34 34 + _config = mergeConfigs(_config, config); 35 35 + instance.defaults = { 36 36 + ...instance.defaults, 37 37 + ..._config, 38 38 + // @ts-expect-error 39 39 + headers: mergeHeaders(instance.defaults.headers, _config.headers), 40 40 + }; 41 41 + return getConfig(); 42 42 + }; 43 43 + 44 44 + const beforeRequest = async (options: RequestOptions) => { 45 45 + const opts = { 46 46 + ..._config, 47 47 + ...options, 48 48 + axios: options.axios ?? _config.axios ?? instance, 49 49 + headers: mergeHeaders(_config.headers, options.headers), 50 50 + }; 51 51 + 52 52 + if (opts.security) { 53 53 + await setAuthParams({ 54 54 + ...opts, 55 55 + security: opts.security, 56 56 + }); 57 57 + } 58 58 + 59 59 + if (opts.requestValidator) { 60 60 + await opts.requestValidator(opts); 61 61 + } 62 62 + 63 63 + if (opts.body !== undefined && opts.bodySerializer) { 64 64 + opts.body = opts.bodySerializer(opts.body); 65 65 + } 66 66 + 67 67 + const url = buildUrl(opts); 68 68 + 69 69 + return { opts, url }; 70 70 + }; 71 71 + 72 72 + // @ts-expect-error 73 73 + const request: Client['request'] = async (options) => { 74 74 + // @ts-expect-error 75 75 + const { opts, url } = await beforeRequest(options); 76 76 + try { 77 77 + // assign Axios here for consistency with fetch 78 78 + const _axios = opts.axios!; 79 79 + // eslint-disable-next-line @typescript-eslint/no-unused-vars 80 80 + const { auth, ...optsWithoutAuth } = opts; 81 81 + const response = await _axios({ 82 82 + ...optsWithoutAuth, 83 83 + baseURL: '', // the baseURL is already included in `url` 84 84 + data: getValidRequestBody(opts), 85 85 + headers: opts.headers as RawAxiosRequestHeaders, 86 86 + // let `paramsSerializer()` handle query params if it exists 87 87 + params: !opts.paramsSerializer ? opts.query : undefined, 88 88 + url, 89 89 + }); 90 90 + 91 91 + let { data } = response; 92 92 + 93 93 + if (opts.responseType === 'json') { 94 94 + if (opts.responseValidator) { 95 95 + await opts.responseValidator(data); 96 96 + } 97 97 + 98 98 + if (opts.responseTransformer) { 99 99 + data = await opts.responseTransformer(data); 100 100 + } 101 101 + } 102 102 + 103 103 + return { 104 104 + ...response, 105 105 + data: data ?? {}, 106 106 + }; 107 107 + } catch (error) { 108 108 + const e = error as AxiosError; 109 109 + if (opts.throwOnError) { 110 110 + throw e; 111 111 + } 112 112 + // @ts-expect-error 113 113 + e.error = e.response?.data ?? {}; 114 114 + return e; 115 115 + } 116 116 + }; 117 117 + 118 118 + const makeMethodFn = 119 119 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 120 120 + request({ ...options, method }); 121 121 + 122 122 + const makeSseFn = 123 123 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 124 124 + const { opts, url } = await beforeRequest(options); 125 125 + return createSseClient({ 126 126 + ...opts, 127 127 + body: opts.body as BodyInit | null | undefined, 128 128 + headers: opts.headers as Record<string, string>, 129 129 + method, 130 130 + // @ts-expect-error 131 131 + signal: opts.signal, 132 132 + url, 133 133 + }); 134 134 + }; 135 135 + 136 136 + return { 137 137 + buildUrl, 138 138 + connect: makeMethodFn('CONNECT'), 139 139 + delete: makeMethodFn('DELETE'), 140 140 + get: makeMethodFn('GET'), 141 141 + getConfig, 142 142 + head: makeMethodFn('HEAD'), 143 143 + instance, 144 144 + options: makeMethodFn('OPTIONS'), 145 145 + patch: makeMethodFn('PATCH'), 146 146 + post: makeMethodFn('POST'), 147 147 + put: makeMethodFn('PUT'), 148 148 + request, 149 149 + setConfig, 150 150 + sse: { 151 151 + connect: makeSseFn('CONNECT'), 152 152 + delete: makeSseFn('DELETE'), 153 153 + get: makeSseFn('GET'), 154 154 + head: makeSseFn('HEAD'), 155 155 + options: makeSseFn('OPTIONS'), 156 156 + patch: makeSseFn('PATCH'), 157 157 + post: makeSseFn('POST'), 158 158 + put: makeSseFn('PUT'), 159 159 + trace: makeSseFn('TRACE'), 160 160 + }, 161 161 + trace: makeMethodFn('TRACE'), 162 162 + } as Client; 163 163 + };

+23

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + TDataShape, 22 22 + } from './types.gen.js'; 23 23 + export { createConfig } from './utils.gen.js';

+197

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + AxiosError, 5 5 + AxiosInstance, 6 6 + AxiosRequestHeaders, 7 7 + AxiosResponse, 8 8 + AxiosStatic, 9 9 + CreateAxiosDefaults, 10 10 + } from 'axios'; 11 11 + 12 12 + import type { Auth } from '../core/auth.gen.js'; 13 13 + import type { 14 14 + ServerSentEventsOptions, 15 15 + ServerSentEventsResult, 16 16 + } from '../core/serverSentEvents.gen.js'; 17 17 + import type { 18 18 + Client as CoreClient, 19 19 + Config as CoreConfig, 20 20 + } from '../core/types.gen.js'; 21 21 + 22 22 + export interface Config<T extends ClientOptions = ClientOptions> 23 23 + extends Omit<CreateAxiosDefaults, 'auth' | 'baseURL' | 'headers' | 'method'>, 24 24 + CoreConfig { 25 25 + /** 26 26 + * Axios implementation. You can use this option to provide either an 27 27 + * `AxiosStatic` or an `AxiosInstance`. 28 28 + * 29 29 + * @default axios 30 30 + */ 31 31 + axios?: AxiosStatic | AxiosInstance; 32 32 + /** 33 33 + * Base URL for all requests made by this client. 34 34 + */ 35 35 + baseURL?: T['baseURL']; 36 36 + /** 37 37 + * An object containing any HTTP headers that you want to pre-populate your 38 38 + * `Headers` object with. 39 39 + * 40 40 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 41 41 + */ 42 42 + headers?: 43 43 + | AxiosRequestHeaders 44 44 + | Record< 45 45 + string, 46 46 + | string 47 47 + | number 48 48 + | boolean 49 49 + | (string | number | boolean)[] 50 50 + | null 51 51 + | undefined 52 52 + | unknown 53 53 + >; 54 54 + /** 55 55 + * Throw an error instead of returning it in the response? 56 56 + * 57 57 + * @default false 58 58 + */ 59 59 + throwOnError?: T['throwOnError']; 60 60 + } 61 61 + 62 62 + export interface RequestOptions< 63 63 + TData = unknown, 64 64 + ThrowOnError extends boolean = boolean, 65 65 + Url extends string = string, 66 66 + > extends Config<{ 67 67 + throwOnError: ThrowOnError; 68 68 + }>, 69 69 + Pick< 70 70 + ServerSentEventsOptions<TData>, 71 71 + | 'onSseError' 72 72 + | 'onSseEvent' 73 73 + | 'sseDefaultRetryDelay' 74 74 + | 'sseMaxRetryAttempts' 75 75 + | 'sseMaxRetryDelay' 76 76 + > { 77 77 + /** 78 78 + * Any body that you want to add to your request. 79 79 + * 80 80 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 81 81 + */ 82 82 + body?: unknown; 83 83 + path?: Record<string, unknown>; 84 84 + query?: Record<string, unknown>; 85 85 + /** 86 86 + * Security mechanism(s) to use for the request. 87 87 + */ 88 88 + security?: ReadonlyArray<Auth>; 89 89 + url: Url; 90 90 + } 91 91 + 92 92 + export interface ClientOptions { 93 93 + baseURL?: string; 94 94 + throwOnError?: boolean; 95 95 + } 96 96 + 97 97 + export type RequestResult< 98 98 + TData = unknown, 99 99 + TError = unknown, 100 100 + ThrowOnError extends boolean = boolean, 101 101 + > = ThrowOnError extends true 102 102 + ? Promise< 103 103 + AxiosResponse< 104 104 + TData extends Record<string, unknown> ? TData[keyof TData] : TData 105 105 + > 106 106 + > 107 107 + : Promise< 108 108 + | (AxiosResponse< 109 109 + TData extends Record<string, unknown> ? TData[keyof TData] : TData 110 110 + > & { error: undefined }) 111 111 + | (AxiosError< 112 112 + TError extends Record<string, unknown> ? TError[keyof TError] : TError 113 113 + > & { 114 114 + data: undefined; 115 115 + error: TError extends Record<string, unknown> 116 116 + ? TError[keyof TError] 117 117 + : TError; 118 118 + }) 119 119 + >; 120 120 + 121 121 + type MethodFn = < 122 122 + TData = unknown, 123 123 + TError = unknown, 124 124 + ThrowOnError extends boolean = false, 125 125 + >( 126 126 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>, 127 127 + ) => RequestResult<TData, TError, ThrowOnError>; 128 128 + 129 129 + type SseFn = < 130 130 + TData = unknown, 131 131 + TError = unknown, 132 132 + ThrowOnError extends boolean = false, 133 133 + >( 134 134 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>, 135 135 + ) => Promise<ServerSentEventsResult<TData, TError>>; 136 136 + 137 137 + type RequestFn = < 138 138 + TData = unknown, 139 139 + TError = unknown, 140 140 + ThrowOnError extends boolean = false, 141 141 + >( 142 142 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> & 143 143 + Pick<Required<RequestOptions<TData, ThrowOnError>>, 'method'>, 144 144 + ) => RequestResult<TData, TError, ThrowOnError>; 145 145 + 146 146 + type BuildUrlFn = < 147 147 + TData extends { 148 148 + body?: unknown; 149 149 + path?: Record<string, unknown>; 150 150 + query?: Record<string, unknown>; 151 151 + url: string; 152 152 + }, 153 153 + >( 154 154 + options: TData & Options<TData>, 155 155 + ) => string; 156 156 + 157 157 + export type Client = CoreClient< 158 158 + RequestFn, 159 159 + Config, 160 160 + MethodFn, 161 161 + BuildUrlFn, 162 162 + SseFn 163 163 + > & { 164 164 + instance: AxiosInstance; 165 165 + }; 166 166 + 167 167 + /** 168 168 + * The `createClientConfig()` function will be called on client initialization 169 169 + * and the returned object will become the client's initial configuration. 170 170 + * 171 171 + * You may want to initialize your client this way instead of calling 172 172 + * `setConfig()`. This is useful for example if you're using Next.js 173 173 + * to ensure your client always has the correct values. 174 174 + */ 175 175 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 176 176 + override?: Config<ClientOptions & T>, 177 177 + ) => Config<Required<ClientOptions> & T>; 178 178 + 179 179 + export interface TDataShape { 180 180 + body?: unknown; 181 181 + headers?: unknown; 182 182 + path?: unknown; 183 183 + query?: unknown; 184 184 + url: string; 185 185 + } 186 186 + 187 187 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 188 188 + 189 189 + export type Options< 190 190 + TData extends TDataShape = TDataShape, 191 191 + ThrowOnError extends boolean = boolean, 192 192 + TResponse = unknown, 193 193 + > = OmitKeys< 194 194 + RequestOptions<TResponse, ThrowOnError>, 195 195 + 'body' | 'path' | 'query' | 'url' 196 196 + > & 197 197 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+213

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { getAuthToken } from '../core/auth.gen.js'; 4 4 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + import { 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from '../core/pathSerializer.gen.js'; 10 10 + import { getUrl } from '../core/utils.gen.js'; 11 11 + import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js'; 12 12 + 13 13 + export const createQuerySerializer = <T = unknown>({ 14 14 + parameters = {}, 15 15 + ...args 16 16 + }: QuerySerializerOptions = {}) => { 17 17 + const querySerializer = (queryParams: T) => { 18 18 + const search: string[] = []; 19 19 + if (queryParams && typeof queryParams === 'object') { 20 20 + for (const name in queryParams) { 21 21 + const value = queryParams[name]; 22 22 + 23 23 + if (value === undefined || value === null) { 24 24 + continue; 25 25 + } 26 26 + 27 27 + const options = parameters[name] || args; 28 28 + 29 29 + if (Array.isArray(value)) { 30 30 + const serializedArray = serializeArrayParam({ 31 31 + allowReserved: options.allowReserved, 32 32 + explode: true, 33 33 + name, 34 34 + style: 'form', 35 35 + value, 36 36 + ...options.array, 37 37 + }); 38 38 + if (serializedArray) search.push(serializedArray); 39 39 + } else if (typeof value === 'object') { 40 40 + const serializedObject = serializeObjectParam({ 41 41 + allowReserved: options.allowReserved, 42 42 + explode: true, 43 43 + name, 44 44 + style: 'deepObject', 45 45 + value: value as Record<string, unknown>, 46 46 + ...options.object, 47 47 + }); 48 48 + if (serializedObject) search.push(serializedObject); 49 49 + } else { 50 50 + const serializedPrimitive = serializePrimitiveParam({ 51 51 + allowReserved: options.allowReserved, 52 52 + name, 53 53 + value: value as string, 54 54 + }); 55 55 + if (serializedPrimitive) search.push(serializedPrimitive); 56 56 + } 57 57 + } 58 58 + } 59 59 + return search.join('&'); 60 60 + }; 61 61 + return querySerializer; 62 62 + }; 63 63 + 64 64 + const checkForExistence = ( 65 65 + options: Pick<RequestOptions, 'auth' | 'query'> & { 66 66 + headers: Record<any, unknown>; 67 67 + }, 68 68 + name?: string, 69 69 + ): boolean => { 70 70 + if (!name) { 71 71 + return false; 72 72 + } 73 73 + if (name in options.headers || options.query?.[name]) { 74 74 + return true; 75 75 + } 76 76 + if ( 77 77 + 'Cookie' in options.headers && 78 78 + options.headers['Cookie'] && 79 79 + typeof options.headers['Cookie'] === 'string' 80 80 + ) { 81 81 + return options.headers['Cookie'].includes(`${name}=`); 82 82 + } 83 83 + return false; 84 84 + }; 85 85 + 86 86 + export const setAuthParams = async ({ 87 87 + security, 88 88 + ...options 89 89 + }: Pick<Required<RequestOptions>, 'security'> & 90 90 + Pick<RequestOptions, 'auth' | 'query'> & { 91 91 + headers: Record<any, unknown>; 92 92 + }) => { 93 93 + for (const auth of security) { 94 94 + if (checkForExistence(options, auth.name)) { 95 95 + continue; 96 96 + } 97 97 + const token = await getAuthToken(auth, options.auth); 98 98 + 99 99 + if (!token) { 100 100 + continue; 101 101 + } 102 102 + 103 103 + const name = auth.name ?? 'Authorization'; 104 104 + 105 105 + switch (auth.in) { 106 106 + case 'query': 107 107 + if (!options.query) { 108 108 + options.query = {}; 109 109 + } 110 110 + options.query[name] = token; 111 111 + break; 112 112 + case 'cookie': { 113 113 + const value = `${name}=${token}`; 114 114 + if ('Cookie' in options.headers && options.headers['Cookie']) { 115 115 + options.headers['Cookie'] = `${options.headers['Cookie']}; ${value}`; 116 116 + } else { 117 117 + options.headers['Cookie'] = value; 118 118 + } 119 119 + break; 120 120 + } 121 121 + case 'header': 122 122 + default: 123 123 + options.headers[name] = token; 124 124 + break; 125 125 + } 126 126 + } 127 127 + }; 128 128 + 129 129 + export const buildUrl: Client['buildUrl'] = (options) => { 130 130 + const instanceBaseUrl = options.axios?.defaults?.baseURL; 131 131 + 132 132 + const baseUrl = 133 133 + !!options.baseURL && typeof options.baseURL === 'string' 134 134 + ? options.baseURL 135 135 + : instanceBaseUrl; 136 136 + 137 137 + return getUrl({ 138 138 + baseUrl: baseUrl as string, 139 139 + path: options.path, 140 140 + // let `paramsSerializer()` handle query params if it exists 141 141 + query: !options.paramsSerializer ? options.query : undefined, 142 142 + querySerializer: 143 143 + typeof options.querySerializer === 'function' 144 144 + ? options.querySerializer 145 145 + : createQuerySerializer(options.querySerializer), 146 146 + url: options.url, 147 147 + }); 148 148 + }; 149 149 + 150 150 + export const mergeConfigs = (a: Config, b: Config): Config => { 151 151 + const config = { ...a, ...b }; 152 152 + config.headers = mergeHeaders(a.headers, b.headers); 153 153 + return config; 154 154 + }; 155 155 + 156 156 + /** 157 157 + * Special Axios headers keywords allowing to set headers by request method. 158 158 + */ 159 159 + export const axiosHeadersKeywords = [ 160 160 + 'common', 161 161 + 'delete', 162 162 + 'get', 163 163 + 'head', 164 164 + 'patch', 165 165 + 'post', 166 166 + 'put', 167 167 + ] as const; 168 168 + 169 169 + export const mergeHeaders = ( 170 170 + ...headers: Array<Required<Config>['headers'] | undefined> 171 171 + ): Record<any, unknown> => { 172 172 + const mergedHeaders: Record<any, unknown> = {}; 173 173 + for (const header of headers) { 174 174 + if (!header || typeof header !== 'object') { 175 175 + continue; 176 176 + } 177 177 + 178 178 + const iterator = Object.entries(header); 179 179 + 180 180 + for (const [key, value] of iterator) { 181 181 + if ( 182 182 + axiosHeadersKeywords.includes( 183 183 + key as (typeof axiosHeadersKeywords)[number], 184 184 + ) && 185 185 + typeof value === 'object' 186 186 + ) { 187 187 + mergedHeaders[key] = { 188 188 + ...(mergedHeaders[key] as Record<any, unknown>), 189 189 + ...value, 190 190 + }; 191 191 + } else if (value === null) { 192 192 + delete mergedHeaders[key]; 193 193 + } else if (Array.isArray(value)) { 194 194 + for (const v of value) { 195 195 + // @ts-expect-error 196 196 + mergedHeaders[key] = [...(mergedHeaders[key] ?? []), v as string]; 197 197 + } 198 198 + } else if (value !== undefined) { 199 199 + // assume object headers are meant to be JSON stringified, i.e. their 200 200 + // content value in OpenAPI specification is 'application/json' 201 201 + mergedHeaders[key] = 202 202 + typeof value === 'object' ? JSON.stringify(value) : (value as string); 203 203 + } 204 204 + } 205 205 + } 206 206 + return mergedHeaders; 207 207 + }; 208 208 + 209 209 + export const createConfig = <T extends ClientOptions = ClientOptions>( 210 210 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 211 211 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 212 212 + ...override, 213 213 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+247

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + responseType: 'json', 27 27 + url: '/api/v{api-version}/no+tag', 28 28 + ...options, 29 29 + headers: { 30 30 + 'Content-Type': 'application/json', 31 31 + ...options.headers 32 32 + } 33 33 + }); 34 34 + 35 35 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 36 36 + 37 37 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ 38 38 + responseType: 'json', 39 39 + url: '/api/v{api-version}/simple/$count', 40 40 + ...options 41 41 + }); 42 42 + 43 43 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ 44 44 + responseType: 'json', 45 45 + url: '/api/v{api-version}/simple:operation', 46 46 + ...options 47 47 + }); 48 48 + 49 49 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 50 50 + 51 51 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 52 52 + 53 53 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 54 54 + 55 55 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 56 56 + 57 57 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 58 58 + 59 59 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 60 60 + 61 61 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 62 62 + 63 63 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 64 64 + 65 65 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 66 66 + 67 67 + /** 68 68 + * @deprecated 69 69 + */ 70 70 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 71 71 + 72 72 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameterPath}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 100 100 + responseType: 'json', 101 101 + url: '/api/v{api-version}/parameters', 102 102 + ...options, 103 103 + headers: { 104 104 + 'Content-Type': 'application/json', 105 105 + ...options.headers 106 106 + } 107 107 + }); 108 108 + 109 109 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 110 110 + url: '/api/v{api-version}/requestBody', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': 'application/json', 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 119 119 + ...formDataBodySerializer, 120 120 + url: '/api/v{api-version}/formData', 121 121 + ...options, 122 122 + headers: { 123 123 + 'Content-Type': null, 124 124 + ...options?.headers 125 125 + } 126 126 + }); 127 127 + 128 128 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 129 129 + 130 130 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 131 131 + 132 132 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 133 133 + 134 134 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 135 135 + 136 136 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 137 137 + 138 138 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 139 139 + 140 140 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 141 141 + 142 142 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 143 143 + 144 144 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ 145 145 + responseType: 'json', 146 146 + url: '/api/v{api-version}/multiple-tags/response-and-no-content', 147 147 + ...options 148 148 + }); 149 149 + 150 150 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ 151 151 + responseType: 'json', 152 152 + url: '/api/v{api-version}/multiple-tags/a', 153 153 + ...options 154 154 + }); 155 155 + 156 156 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 157 157 + 158 158 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 159 159 + 160 160 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ 161 161 + responseType: 'json', 162 162 + url: '/api/v{api-version}/response', 163 163 + ...options 164 164 + }); 165 165 + 166 166 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ 167 167 + responseType: 'json', 168 168 + url: '/api/v{api-version}/response', 169 169 + ...options 170 170 + }); 171 171 + 172 172 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 173 173 + 174 174 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ 175 175 + responseType: 'json', 176 176 + url: '/api/v{api-version}/types', 177 177 + ...options 178 178 + }); 179 179 + 180 180 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 181 181 + ...urlSearchParamsBodySerializer, 182 182 + responseType: 'json', 183 183 + url: '/api/v{api-version}/upload', 184 184 + ...options, 185 185 + headers: { 186 186 + 'Content-Type': 'application/x-www-form-urlencoded', 187 187 + ...options.headers 188 188 + } 189 189 + }); 190 190 + 191 191 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ 192 192 + responseType: 'blob', 193 193 + url: '/api/v{api-version}/file/{id}', 194 194 + ...options 195 195 + }); 196 196 + 197 197 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 198 198 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 199 199 + responseType: 'json', 200 200 + url: '/api/v{api-version}/complex', 201 201 + ...options 202 202 + }); 203 203 + 204 204 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 205 205 + 206 206 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 207 207 + ...formDataBodySerializer, 208 208 + url: '/api/v{api-version}/multipart', 209 209 + ...options, 210 210 + headers: { 211 211 + 'Content-Type': null, 212 212 + ...options?.headers 213 213 + } 214 214 + }); 215 215 + 216 216 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 217 217 + responseType: 'json', 218 218 + url: '/api/v{api-version}/complex/{id}', 219 219 + ...options, 220 220 + headers: { 221 221 + 'Content-Type': 'application/json-patch+json', 222 222 + ...options.headers 223 223 + } 224 224 + }); 225 225 + 226 226 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 227 227 + 228 228 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 229 229 + 230 230 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ 231 231 + responseType: 'json', 232 232 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 233 233 + ...options 234 234 + }); 235 235 + 236 236 + /** 237 237 + * Login User 238 238 + */ 239 239 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 240 240 + ...urlSearchParamsBodySerializer, 241 241 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 242 242 + ...options, 243 243 + headers: { 244 244 + 'Content-Type': 'application/x-www-form-urlencoded', 245 245 + ...options.headers 246 246 + } 247 247 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-axios/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseURL: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'http://localhost:3000/base' }));

+301

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 4 4 + import type { HttpMethod } from '../core/types.gen.js'; 5 5 + import { getValidRequestBody } from '../core/utils.gen.js'; 6 6 + import type { 7 7 + Client, 8 8 + Config, 9 9 + RequestOptions, 10 10 + ResolvedRequestOptions, 11 11 + } from './types.gen.js'; 12 12 + import { 13 13 + buildUrl, 14 14 + createConfig, 15 15 + createInterceptors, 16 16 + getParseAs, 17 17 + mergeConfigs, 18 18 + mergeHeaders, 19 19 + setAuthParams, 20 20 + } from './utils.gen.js'; 21 21 + 22 22 + type ReqInit = Omit<RequestInit, 'body' | 'headers'> & { 23 23 + body?: any; 24 24 + headers: ReturnType<typeof mergeHeaders>; 25 25 + }; 26 26 + 27 27 + export const createClient = (config: Config = {}): Client => { 28 28 + let _config = mergeConfigs(createConfig(), config); 29 29 + 30 30 + const getConfig = (): Config => ({ ..._config }); 31 31 + 32 32 + const setConfig = (config: Config): Config => { 33 33 + _config = mergeConfigs(_config, config); 34 34 + return getConfig(); 35 35 + }; 36 36 + 37 37 + const interceptors = createInterceptors< 38 38 + Request, 39 39 + Response, 40 40 + unknown, 41 41 + ResolvedRequestOptions 42 42 + >(); 43 43 + 44 44 + const beforeRequest = async (options: RequestOptions) => { 45 45 + const opts = { 46 46 + ..._config, 47 47 + ...options, 48 48 + fetch: options.fetch ?? _config.fetch ?? globalThis.fetch, 49 49 + headers: mergeHeaders(_config.headers, options.headers), 50 50 + serializedBody: undefined, 51 51 + }; 52 52 + 53 53 + if (opts.security) { 54 54 + await setAuthParams({ 55 55 + ...opts, 56 56 + security: opts.security, 57 57 + }); 58 58 + } 59 59 + 60 60 + if (opts.requestValidator) { 61 61 + await opts.requestValidator(opts); 62 62 + } 63 63 + 64 64 + if (opts.body !== undefined && opts.bodySerializer) { 65 65 + opts.serializedBody = opts.bodySerializer(opts.body); 66 66 + } 67 67 + 68 68 + // remove Content-Type header if body is empty to avoid sending invalid requests 69 69 + if (opts.body === undefined || opts.serializedBody === '') { 70 70 + opts.headers.delete('Content-Type'); 71 71 + } 72 72 + 73 73 + const url = buildUrl(opts); 74 74 + 75 75 + return { opts, url }; 76 76 + }; 77 77 + 78 78 + const request: Client['request'] = async (options) => { 79 79 + // @ts-expect-error 80 80 + const { opts, url } = await beforeRequest(options); 81 81 + const requestInit: ReqInit = { 82 82 + redirect: 'follow', 83 83 + ...opts, 84 84 + body: getValidRequestBody(opts), 85 85 + }; 86 86 + 87 87 + let request = new Request(url, requestInit); 88 88 + 89 89 + for (const fn of interceptors.request.fns) { 90 90 + if (fn) { 91 91 + request = await fn(request, opts); 92 92 + } 93 93 + } 94 94 + 95 95 + // fetch must be assigned here, otherwise it would throw the error: 96 96 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 97 97 + const _fetch = opts.fetch!; 98 98 + let response: Response; 99 99 + 100 100 + try { 101 101 + response = await _fetch(request); 102 102 + } catch (error) { 103 103 + // Handle fetch exceptions (AbortError, network errors, etc.) 104 104 + let finalError = error; 105 105 + 106 106 + for (const fn of interceptors.error.fns) { 107 107 + if (fn) { 108 108 + finalError = (await fn( 109 109 + error, 110 110 + undefined as any, 111 111 + request, 112 112 + opts, 113 113 + )) as unknown; 114 114 + } 115 115 + } 116 116 + 117 117 + finalError = finalError || ({} as unknown); 118 118 + 119 119 + if (opts.throwOnError) { 120 120 + throw finalError; 121 121 + } 122 122 + 123 123 + // Return error response 124 124 + return opts.responseStyle === 'data' 125 125 + ? undefined 126 126 + : { 127 127 + error: finalError, 128 128 + request, 129 129 + response: undefined as any, 130 130 + }; 131 131 + } 132 132 + 133 133 + for (const fn of interceptors.response.fns) { 134 134 + if (fn) { 135 135 + response = await fn(response, request, opts); 136 136 + } 137 137 + } 138 138 + 139 139 + const result = { 140 140 + request, 141 141 + response, 142 142 + }; 143 143 + 144 144 + if (response.ok) { 145 145 + const parseAs = 146 146 + (opts.parseAs === 'auto' 147 147 + ? getParseAs(response.headers.get('Content-Type')) 148 148 + : opts.parseAs) ?? 'json'; 149 149 + 150 150 + if ( 151 151 + response.status === 204 || 152 152 + response.headers.get('Content-Length') === '0' 153 153 + ) { 154 154 + let emptyData: any; 155 155 + switch (parseAs) { 156 156 + case 'arrayBuffer': 157 157 + case 'blob': 158 158 + case 'text': 159 159 + emptyData = await response[parseAs](); 160 160 + break; 161 161 + case 'formData': 162 162 + emptyData = new FormData(); 163 163 + break; 164 164 + case 'stream': 165 165 + emptyData = response.body; 166 166 + break; 167 167 + case 'json': 168 168 + default: 169 169 + emptyData = {}; 170 170 + break; 171 171 + } 172 172 + return opts.responseStyle === 'data' 173 173 + ? emptyData 174 174 + : { 175 175 + data: emptyData, 176 176 + ...result, 177 177 + }; 178 178 + } 179 179 + 180 180 + let data: any; 181 181 + switch (parseAs) { 182 182 + case 'arrayBuffer': 183 183 + case 'blob': 184 184 + case 'formData': 185 185 + case 'json': 186 186 + case 'text': 187 187 + data = await response[parseAs](); 188 188 + break; 189 189 + case 'stream': 190 190 + return opts.responseStyle === 'data' 191 191 + ? response.body 192 192 + : { 193 193 + data: response.body, 194 194 + ...result, 195 195 + }; 196 196 + } 197 197 + 198 198 + if (parseAs === 'json') { 199 199 + if (opts.responseValidator) { 200 200 + await opts.responseValidator(data); 201 201 + } 202 202 + 203 203 + if (opts.responseTransformer) { 204 204 + data = await opts.responseTransformer(data); 205 205 + } 206 206 + } 207 207 + 208 208 + return opts.responseStyle === 'data' 209 209 + ? data 210 210 + : { 211 211 + data, 212 212 + ...result, 213 213 + }; 214 214 + } 215 215 + 216 216 + const textError = await response.text(); 217 217 + let jsonError: unknown; 218 218 + 219 219 + try { 220 220 + jsonError = JSON.parse(textError); 221 221 + } catch { 222 222 + // noop 223 223 + } 224 224 + 225 225 + const error = jsonError ?? textError; 226 226 + let finalError = error; 227 227 + 228 228 + for (const fn of interceptors.error.fns) { 229 229 + if (fn) { 230 230 + finalError = (await fn(error, response, request, opts)) as string; 231 231 + } 232 232 + } 233 233 + 234 234 + finalError = finalError || ({} as string); 235 235 + 236 236 + if (opts.throwOnError) { 237 237 + throw finalError; 238 238 + } 239 239 + 240 240 + // TODO: we probably want to return error and improve types 241 241 + return opts.responseStyle === 'data' 242 242 + ? undefined 243 243 + : { 244 244 + error: finalError, 245 245 + ...result, 246 246 + }; 247 247 + }; 248 248 + 249 249 + const makeMethodFn = 250 250 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 251 251 + request({ ...options, method }); 252 252 + 253 253 + const makeSseFn = 254 254 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 255 255 + const { opts, url } = await beforeRequest(options); 256 256 + return createSseClient({ 257 257 + ...opts, 258 258 + body: opts.body as BodyInit | null | undefined, 259 259 + headers: opts.headers as unknown as Record<string, string>, 260 260 + method, 261 261 + onRequest: async (url, init) => { 262 262 + let request = new Request(url, init); 263 263 + for (const fn of interceptors.request.fns) { 264 264 + if (fn) { 265 265 + request = await fn(request, opts); 266 266 + } 267 267 + } 268 268 + return request; 269 269 + }, 270 270 + url, 271 271 + }); 272 272 + }; 273 273 + 274 274 + return { 275 275 + buildUrl, 276 276 + connect: makeMethodFn('CONNECT'), 277 277 + delete: makeMethodFn('DELETE'), 278 278 + get: makeMethodFn('GET'), 279 279 + getConfig, 280 280 + head: makeMethodFn('HEAD'), 281 281 + interceptors, 282 282 + options: makeMethodFn('OPTIONS'), 283 283 + patch: makeMethodFn('PATCH'), 284 284 + post: makeMethodFn('POST'), 285 285 + put: makeMethodFn('PUT'), 286 286 + request, 287 287 + setConfig, 288 288 + sse: { 289 289 + connect: makeSseFn('CONNECT'), 290 290 + delete: makeSseFn('DELETE'), 291 291 + get: makeSseFn('GET'), 292 292 + head: makeSseFn('HEAD'), 293 293 + options: makeSseFn('OPTIONS'), 294 294 + patch: makeSseFn('PATCH'), 295 295 + post: makeSseFn('POST'), 296 296 + put: makeSseFn('PUT'), 297 297 + trace: makeSseFn('TRACE'), 298 298 + }, 299 299 + trace: makeMethodFn('TRACE'), 300 300 + } as Client; 301 301 + };

+25

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + ResolvedRequestOptions, 22 22 + ResponseStyle, 23 23 + TDataShape, 24 24 + } from './types.gen.js'; 25 25 + export { createConfig, mergeHeaders } from './utils.gen.js';

+241

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth } from '../core/auth.gen.js'; 4 4 + import type { 5 5 + ServerSentEventsOptions, 6 6 + ServerSentEventsResult, 7 7 + } from '../core/serverSentEvents.gen.js'; 8 8 + import type { 9 9 + Client as CoreClient, 10 10 + Config as CoreConfig, 11 11 + } from '../core/types.gen.js'; 12 12 + import type { Middleware } from './utils.gen.js'; 13 13 + 14 14 + export type ResponseStyle = 'data' | 'fields'; 15 15 + 16 16 + export interface Config<T extends ClientOptions = ClientOptions> 17 17 + extends Omit<RequestInit, 'body' | 'headers' | 'method'>, 18 18 + CoreConfig { 19 19 + /** 20 20 + * Base URL for all requests made by this client. 21 21 + */ 22 22 + baseUrl?: T['baseUrl']; 23 23 + /** 24 24 + * Fetch API implementation. You can use this option to provide a custom 25 25 + * fetch instance. 26 26 + * 27 27 + * @default globalThis.fetch 28 28 + */ 29 29 + fetch?: typeof fetch; 30 30 + /** 31 31 + * Please don't use the Fetch client for Next.js applications. The `next` 32 32 + * options won't have any effect. 33 33 + * 34 34 + * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead. 35 35 + */ 36 36 + next?: never; 37 37 + /** 38 38 + * Return the response data parsed in a specified format. By default, `auto` 39 39 + * will infer the appropriate method from the `Content-Type` response header. 40 40 + * You can override this behavior with any of the {@link Body} methods. 41 41 + * Select `stream` if you don't want to parse response data at all. 42 42 + * 43 43 + * @default 'auto' 44 44 + */ 45 45 + parseAs?: 46 46 + | 'arrayBuffer' 47 47 + | 'auto' 48 48 + | 'blob' 49 49 + | 'formData' 50 50 + | 'json' 51 51 + | 'stream' 52 52 + | 'text'; 53 53 + /** 54 54 + * Should we return only data or multiple fields (data, error, response, etc.)? 55 55 + * 56 56 + * @default 'fields' 57 57 + */ 58 58 + responseStyle?: ResponseStyle; 59 59 + /** 60 60 + * Throw an error instead of returning it in the response? 61 61 + * 62 62 + * @default false 63 63 + */ 64 64 + throwOnError?: T['throwOnError']; 65 65 + } 66 66 + 67 67 + export interface RequestOptions< 68 68 + TData = unknown, 69 69 + TResponseStyle extends ResponseStyle = 'fields', 70 70 + ThrowOnError extends boolean = boolean, 71 71 + Url extends string = string, 72 72 + > extends Config<{ 73 73 + responseStyle: TResponseStyle; 74 74 + throwOnError: ThrowOnError; 75 75 + }>, 76 76 + Pick< 77 77 + ServerSentEventsOptions<TData>, 78 78 + | 'onSseError' 79 79 + | 'onSseEvent' 80 80 + | 'sseDefaultRetryDelay' 81 81 + | 'sseMaxRetryAttempts' 82 82 + | 'sseMaxRetryDelay' 83 83 + > { 84 84 + /** 85 85 + * Any body that you want to add to your request. 86 86 + * 87 87 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 88 88 + */ 89 89 + body?: unknown; 90 90 + path?: Record<string, unknown>; 91 91 + query?: Record<string, unknown>; 92 92 + /** 93 93 + * Security mechanism(s) to use for the request. 94 94 + */ 95 95 + security?: ReadonlyArray<Auth>; 96 96 + url: Url; 97 97 + } 98 98 + 99 99 + export interface ResolvedRequestOptions< 100 100 + TResponseStyle extends ResponseStyle = 'fields', 101 101 + ThrowOnError extends boolean = boolean, 102 102 + Url extends string = string, 103 103 + > extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> { 104 104 + serializedBody?: string; 105 105 + } 106 106 + 107 107 + export type RequestResult< 108 108 + TData = unknown, 109 109 + TError = unknown, 110 110 + ThrowOnError extends boolean = boolean, 111 111 + TResponseStyle extends ResponseStyle = 'fields', 112 112 + > = ThrowOnError extends true 113 113 + ? Promise< 114 114 + TResponseStyle extends 'data' 115 115 + ? TData extends Record<string, unknown> 116 116 + ? TData[keyof TData] 117 117 + : TData 118 118 + : { 119 119 + data: TData extends Record<string, unknown> 120 120 + ? TData[keyof TData] 121 121 + : TData; 122 122 + request: Request; 123 123 + response: Response; 124 124 + } 125 125 + > 126 126 + : Promise< 127 127 + TResponseStyle extends 'data' 128 128 + ? 129 129 + | (TData extends Record<string, unknown> 130 130 + ? TData[keyof TData] 131 131 + : TData) 132 132 + | undefined 133 133 + : ( 134 134 + | { 135 135 + data: TData extends Record<string, unknown> 136 136 + ? TData[keyof TData] 137 137 + : TData; 138 138 + error: undefined; 139 139 + } 140 140 + | { 141 141 + data: undefined; 142 142 + error: TError extends Record<string, unknown> 143 143 + ? TError[keyof TError] 144 144 + : TError; 145 145 + } 146 146 + ) & { 147 147 + request: Request; 148 148 + response: Response; 149 149 + } 150 150 + >; 151 151 + 152 152 + export interface ClientOptions { 153 153 + baseUrl?: string; 154 154 + responseStyle?: ResponseStyle; 155 155 + throwOnError?: boolean; 156 156 + } 157 157 + 158 158 + type MethodFn = < 159 159 + TData = unknown, 160 160 + TError = unknown, 161 161 + ThrowOnError extends boolean = false, 162 162 + TResponseStyle extends ResponseStyle = 'fields', 163 163 + >( 164 164 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 165 165 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 166 166 + 167 167 + type SseFn = < 168 168 + TData = unknown, 169 169 + TError = unknown, 170 170 + ThrowOnError extends boolean = false, 171 171 + TResponseStyle extends ResponseStyle = 'fields', 172 172 + >( 173 173 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 174 174 + ) => Promise<ServerSentEventsResult<TData, TError>>; 175 175 + 176 176 + type RequestFn = < 177 177 + TData = unknown, 178 178 + TError = unknown, 179 179 + ThrowOnError extends boolean = false, 180 180 + TResponseStyle extends ResponseStyle = 'fields', 181 181 + >( 182 182 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & 183 183 + Pick< 184 184 + Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 185 185 + 'method' 186 186 + >, 187 187 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 188 188 + 189 189 + type BuildUrlFn = < 190 190 + TData extends { 191 191 + body?: unknown; 192 192 + path?: Record<string, unknown>; 193 193 + query?: Record<string, unknown>; 194 194 + url: string; 195 195 + }, 196 196 + >( 197 197 + options: TData & Options<TData>, 198 198 + ) => string; 199 199 + 200 200 + export type Client = CoreClient< 201 201 + RequestFn, 202 202 + Config, 203 203 + MethodFn, 204 204 + BuildUrlFn, 205 205 + SseFn 206 206 + > & { 207 207 + interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>; 208 208 + }; 209 209 + 210 210 + /** 211 211 + * The `createClientConfig()` function will be called on client initialization 212 212 + * and the returned object will become the client's initial configuration. 213 213 + * 214 214 + * You may want to initialize your client this way instead of calling 215 215 + * `setConfig()`. This is useful for example if you're using Next.js 216 216 + * to ensure your client always has the correct values. 217 217 + */ 218 218 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 219 219 + override?: Config<ClientOptions & T>, 220 220 + ) => Config<Required<ClientOptions> & T>; 221 221 + 222 222 + export interface TDataShape { 223 223 + body?: unknown; 224 224 + headers?: unknown; 225 225 + path?: unknown; 226 226 + query?: unknown; 227 227 + url: string; 228 228 + } 229 229 + 230 230 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 231 231 + 232 232 + export type Options< 233 233 + TData extends TDataShape = TDataShape, 234 234 + ThrowOnError extends boolean = boolean, 235 235 + TResponse = unknown, 236 236 + TResponseStyle extends ResponseStyle = 'fields', 237 237 + > = OmitKeys< 238 238 + RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 239 239 + 'body' | 'path' | 'query' | 'url' 240 240 + > & 241 241 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+332

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { getAuthToken } from '../core/auth.gen.js'; 4 4 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + import { jsonBodySerializer } from '../core/bodySerializer.gen.js'; 6 6 + import { 7 7 + serializeArrayParam, 8 8 + serializeObjectParam, 9 9 + serializePrimitiveParam, 10 10 + } from '../core/pathSerializer.gen.js'; 11 11 + import { getUrl } from '../core/utils.gen.js'; 12 12 + import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js'; 13 13 + 14 14 + export const createQuerySerializer = <T = unknown>({ 15 15 + parameters = {}, 16 16 + ...args 17 17 + }: QuerySerializerOptions = {}) => { 18 18 + const querySerializer = (queryParams: T) => { 19 19 + const search: string[] = []; 20 20 + if (queryParams && typeof queryParams === 'object') { 21 21 + for (const name in queryParams) { 22 22 + const value = queryParams[name]; 23 23 + 24 24 + if (value === undefined || value === null) { 25 25 + continue; 26 26 + } 27 27 + 28 28 + const options = parameters[name] || args; 29 29 + 30 30 + if (Array.isArray(value)) { 31 31 + const serializedArray = serializeArrayParam({ 32 32 + allowReserved: options.allowReserved, 33 33 + explode: true, 34 34 + name, 35 35 + style: 'form', 36 36 + value, 37 37 + ...options.array, 38 38 + }); 39 39 + if (serializedArray) search.push(serializedArray); 40 40 + } else if (typeof value === 'object') { 41 41 + const serializedObject = serializeObjectParam({ 42 42 + allowReserved: options.allowReserved, 43 43 + explode: true, 44 44 + name, 45 45 + style: 'deepObject', 46 46 + value: value as Record<string, unknown>, 47 47 + ...options.object, 48 48 + }); 49 49 + if (serializedObject) search.push(serializedObject); 50 50 + } else { 51 51 + const serializedPrimitive = serializePrimitiveParam({ 52 52 + allowReserved: options.allowReserved, 53 53 + name, 54 54 + value: value as string, 55 55 + }); 56 56 + if (serializedPrimitive) search.push(serializedPrimitive); 57 57 + } 58 58 + } 59 59 + } 60 60 + return search.join('&'); 61 61 + }; 62 62 + return querySerializer; 63 63 + }; 64 64 + 65 65 + /** 66 66 + * Infers parseAs value from provided Content-Type header. 67 67 + */ 68 68 + export const getParseAs = ( 69 69 + contentType: string | null, 70 70 + ): Exclude<Config['parseAs'], 'auto'> => { 71 71 + if (!contentType) { 72 72 + // If no Content-Type header is provided, the best we can do is return the raw response body, 73 73 + // which is effectively the same as the 'stream' option. 74 74 + return 'stream'; 75 75 + } 76 76 + 77 77 + const cleanContent = contentType.split(';')[0]?.trim(); 78 78 + 79 79 + if (!cleanContent) { 80 80 + return; 81 81 + } 82 82 + 83 83 + if ( 84 84 + cleanContent.startsWith('application/json') || 85 85 + cleanContent.endsWith('+json') 86 86 + ) { 87 87 + return 'json'; 88 88 + } 89 89 + 90 90 + if (cleanContent === 'multipart/form-data') { 91 91 + return 'formData'; 92 92 + } 93 93 + 94 94 + if ( 95 95 + ['application/', 'audio/', 'image/', 'video/'].some((type) => 96 96 + cleanContent.startsWith(type), 97 97 + ) 98 98 + ) { 99 99 + return 'blob'; 100 100 + } 101 101 + 102 102 + if (cleanContent.startsWith('text/')) { 103 103 + return 'text'; 104 104 + } 105 105 + 106 106 + return; 107 107 + }; 108 108 + 109 109 + const checkForExistence = ( 110 110 + options: Pick<RequestOptions, 'auth' | 'query'> & { 111 111 + headers: Headers; 112 112 + }, 113 113 + name?: string, 114 114 + ): boolean => { 115 115 + if (!name) { 116 116 + return false; 117 117 + } 118 118 + if ( 119 119 + options.headers.has(name) || 120 120 + options.query?.[name] || 121 121 + options.headers.get('Cookie')?.includes(`${name}=`) 122 122 + ) { 123 123 + return true; 124 124 + } 125 125 + return false; 126 126 + }; 127 127 + 128 128 + export const setAuthParams = async ({ 129 129 + security, 130 130 + ...options 131 131 + }: Pick<Required<RequestOptions>, 'security'> & 132 132 + Pick<RequestOptions, 'auth' | 'query'> & { 133 133 + headers: Headers; 134 134 + }) => { 135 135 + for (const auth of security) { 136 136 + if (checkForExistence(options, auth.name)) { 137 137 + continue; 138 138 + } 139 139 + 140 140 + const token = await getAuthToken(auth, options.auth); 141 141 + 142 142 + if (!token) { 143 143 + continue; 144 144 + } 145 145 + 146 146 + const name = auth.name ?? 'Authorization'; 147 147 + 148 148 + switch (auth.in) { 149 149 + case 'query': 150 150 + if (!options.query) { 151 151 + options.query = {}; 152 152 + } 153 153 + options.query[name] = token; 154 154 + break; 155 155 + case 'cookie': 156 156 + options.headers.append('Cookie', `${name}=${token}`); 157 157 + break; 158 158 + case 'header': 159 159 + default: 160 160 + options.headers.set(name, token); 161 161 + break; 162 162 + } 163 163 + } 164 164 + }; 165 165 + 166 166 + export const buildUrl: Client['buildUrl'] = (options) => 167 167 + getUrl({ 168 168 + baseUrl: options.baseUrl as string, 169 169 + path: options.path, 170 170 + query: options.query, 171 171 + querySerializer: 172 172 + typeof options.querySerializer === 'function' 173 173 + ? options.querySerializer 174 174 + : createQuerySerializer(options.querySerializer), 175 175 + url: options.url, 176 176 + }); 177 177 + 178 178 + export const mergeConfigs = (a: Config, b: Config): Config => { 179 179 + const config = { ...a, ...b }; 180 180 + if (config.baseUrl?.endsWith('/')) { 181 181 + config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1); 182 182 + } 183 183 + config.headers = mergeHeaders(a.headers, b.headers); 184 184 + return config; 185 185 + }; 186 186 + 187 187 + const headersEntries = (headers: Headers): Array<[string, string]> => { 188 188 + const entries: Array<[string, string]> = []; 189 189 + headers.forEach((value, key) => { 190 190 + entries.push([key, value]); 191 191 + }); 192 192 + return entries; 193 193 + }; 194 194 + 195 195 + export const mergeHeaders = ( 196 196 + ...headers: Array<Required<Config>['headers'] | undefined> 197 197 + ): Headers => { 198 198 + const mergedHeaders = new Headers(); 199 199 + for (const header of headers) { 200 200 + if (!header) { 201 201 + continue; 202 202 + } 203 203 + 204 204 + const iterator = 205 205 + header instanceof Headers 206 206 + ? headersEntries(header) 207 207 + : Object.entries(header); 208 208 + 209 209 + for (const [key, value] of iterator) { 210 210 + if (value === null) { 211 211 + mergedHeaders.delete(key); 212 212 + } else if (Array.isArray(value)) { 213 213 + for (const v of value) { 214 214 + mergedHeaders.append(key, v as string); 215 215 + } 216 216 + } else if (value !== undefined) { 217 217 + // assume object headers are meant to be JSON stringified, i.e. their 218 218 + // content value in OpenAPI specification is 'application/json' 219 219 + mergedHeaders.set( 220 220 + key, 221 221 + typeof value === 'object' ? JSON.stringify(value) : (value as string), 222 222 + ); 223 223 + } 224 224 + } 225 225 + } 226 226 + return mergedHeaders; 227 227 + }; 228 228 + 229 229 + type ErrInterceptor<Err, Res, Req, Options> = ( 230 230 + error: Err, 231 231 + response: Res, 232 232 + request: Req, 233 233 + options: Options, 234 234 + ) => Err | Promise<Err>; 235 235 + 236 236 + type ReqInterceptor<Req, Options> = ( 237 237 + request: Req, 238 238 + options: Options, 239 239 + ) => Req | Promise<Req>; 240 240 + 241 241 + type ResInterceptor<Res, Req, Options> = ( 242 242 + response: Res, 243 243 + request: Req, 244 244 + options: Options, 245 245 + ) => Res | Promise<Res>; 246 246 + 247 247 + class Interceptors<Interceptor> { 248 248 + fns: Array<Interceptor | null> = []; 249 249 + 250 250 + clear(): void { 251 251 + this.fns = []; 252 252 + } 253 253 + 254 254 + eject(id: number | Interceptor): void { 255 255 + const index = this.getInterceptorIndex(id); 256 256 + if (this.fns[index]) { 257 257 + this.fns[index] = null; 258 258 + } 259 259 + } 260 260 + 261 261 + exists(id: number | Interceptor): boolean { 262 262 + const index = this.getInterceptorIndex(id); 263 263 + return Boolean(this.fns[index]); 264 264 + } 265 265 + 266 266 + getInterceptorIndex(id: number | Interceptor): number { 267 267 + if (typeof id === 'number') { 268 268 + return this.fns[id] ? id : -1; 269 269 + } 270 270 + return this.fns.indexOf(id); 271 271 + } 272 272 + 273 273 + update( 274 274 + id: number | Interceptor, 275 275 + fn: Interceptor, 276 276 + ): number | Interceptor | false { 277 277 + const index = this.getInterceptorIndex(id); 278 278 + if (this.fns[index]) { 279 279 + this.fns[index] = fn; 280 280 + return id; 281 281 + } 282 282 + return false; 283 283 + } 284 284 + 285 285 + use(fn: Interceptor): number { 286 286 + this.fns.push(fn); 287 287 + return this.fns.length - 1; 288 288 + } 289 289 + } 290 290 + 291 291 + export interface Middleware<Req, Res, Err, Options> { 292 292 + error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>; 293 293 + request: Interceptors<ReqInterceptor<Req, Options>>; 294 294 + response: Interceptors<ResInterceptor<Res, Req, Options>>; 295 295 + } 296 296 + 297 297 + export const createInterceptors = <Req, Res, Err, Options>(): Middleware< 298 298 + Req, 299 299 + Res, 300 300 + Err, 301 301 + Options 302 302 + > => ({ 303 303 + error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(), 304 304 + request: new Interceptors<ReqInterceptor<Req, Options>>(), 305 305 + response: new Interceptors<ResInterceptor<Res, Req, Options>>(), 306 306 + }); 307 307 + 308 308 + const defaultQuerySerializer = createQuerySerializer({ 309 309 + allowReserved: false, 310 310 + array: { 311 311 + explode: true, 312 312 + style: 'form', 313 313 + }, 314 314 + object: { 315 315 + explode: true, 316 316 + style: 'deepObject', 317 317 + }, 318 318 + }); 319 319 + 320 320 + const defaultHeaders = { 321 321 + 'Content-Type': 'application/json', 322 322 + }; 323 323 + 324 324 + export const createConfig = <T extends ClientOptions = ClientOptions>( 325 325 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 326 326 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 327 327 + ...jsonBodySerializer, 328 328 + headers: defaultHeaders, 329 329 + parseAs: 'auto', 330 330 + querySerializer: defaultQuerySerializer, 331 331 + ...override, 332 332 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options?.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options?.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-fetch/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseUrl: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'http://localhost:3000/base' }));

+341

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { HTTPError, Options as KyOptions } from 'ky'; 4 4 + import ky from 'ky'; 5 5 + 6 6 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 7 7 + import type { HttpMethod } from '../core/types.gen.js'; 8 8 + import { getValidRequestBody } from '../core/utils.gen.js'; 9 9 + import type { 10 10 + Client, 11 11 + Config, 12 12 + RequestOptions, 13 13 + ResolvedRequestOptions, 14 14 + RetryOptions, 15 15 + } from './types.gen.js'; 16 16 + import type { Middleware } from './utils.gen.js'; 17 17 + import { 18 18 + buildUrl, 19 19 + createConfig, 20 20 + createInterceptors, 21 21 + getParseAs, 22 22 + mergeConfigs, 23 23 + mergeHeaders, 24 24 + setAuthParams, 25 25 + } from './utils.gen.js'; 26 26 + 27 27 + export const createClient = (config: Config = {}): Client => { 28 28 + let _config = mergeConfigs(createConfig(), config); 29 29 + 30 30 + const getConfig = (): Config => ({ ..._config }); 31 31 + 32 32 + const setConfig = (config: Config): Config => { 33 33 + _config = mergeConfigs(_config, config); 34 34 + return getConfig(); 35 35 + }; 36 36 + 37 37 + const interceptors = createInterceptors< 38 38 + Request, 39 39 + Response, 40 40 + unknown, 41 41 + ResolvedRequestOptions 42 42 + >(); 43 43 + 44 44 + const beforeRequest = async (options: RequestOptions) => { 45 45 + const opts = { 46 46 + ..._config, 47 47 + ...options, 48 48 + headers: mergeHeaders(_config.headers, options.headers), 49 49 + ky: options.ky ?? _config.ky ?? ky, 50 50 + serializedBody: undefined, 51 51 + }; 52 52 + 53 53 + if (opts.security) { 54 54 + await setAuthParams({ 55 55 + ...opts, 56 56 + security: opts.security, 57 57 + }); 58 58 + } 59 59 + 60 60 + if (opts.requestValidator) { 61 61 + await opts.requestValidator(opts); 62 62 + } 63 63 + 64 64 + if (opts.body !== undefined && opts.bodySerializer) { 65 65 + opts.serializedBody = opts.bodySerializer(opts.body); 66 66 + } 67 67 + 68 68 + if (opts.body === undefined || opts.serializedBody === '') { 69 69 + opts.headers.delete('Content-Type'); 70 70 + } 71 71 + 72 72 + const url = buildUrl(opts); 73 73 + 74 74 + return { opts, url }; 75 75 + }; 76 76 + 77 77 + const parseErrorResponse = async ( 78 78 + response: Response, 79 79 + request: Request, 80 80 + opts: ResolvedRequestOptions, 81 81 + interceptorsMiddleware: Middleware< 82 82 + Request, 83 83 + Response, 84 84 + unknown, 85 85 + ResolvedRequestOptions 86 86 + >, 87 87 + ) => { 88 88 + const result = { 89 89 + request, 90 90 + response, 91 91 + }; 92 92 + 93 93 + const textError = await response.text(); 94 94 + let jsonError: unknown; 95 95 + 96 96 + try { 97 97 + jsonError = JSON.parse(textError); 98 98 + } catch { 99 99 + jsonError = undefined; 100 100 + } 101 101 + 102 102 + const error = jsonError ?? textError; 103 103 + let finalError = error; 104 104 + 105 105 + for (const fn of interceptorsMiddleware.error.fns) { 106 106 + if (fn) { 107 107 + finalError = (await fn(error, response, request, opts)) as string; 108 108 + } 109 109 + } 110 110 + 111 111 + finalError = finalError || ({} as string); 112 112 + 113 113 + if (opts.throwOnError) { 114 114 + throw finalError; 115 115 + } 116 116 + 117 117 + return opts.responseStyle === 'data' 118 118 + ? undefined 119 119 + : { 120 120 + error: finalError, 121 121 + ...result, 122 122 + }; 123 123 + }; 124 124 + 125 125 + const request: Client['request'] = async (options) => { 126 126 + // @ts-expect-error 127 127 + const { opts, url } = await beforeRequest(options); 128 128 + 129 129 + const kyInstance = opts.ky!; 130 130 + 131 131 + const validBody = getValidRequestBody(opts); 132 132 + 133 133 + const kyOptions: KyOptions = { 134 134 + body: validBody as BodyInit, 135 135 + cache: opts.cache, 136 136 + credentials: opts.credentials, 137 137 + headers: opts.headers, 138 138 + integrity: opts.integrity, 139 139 + keepalive: opts.keepalive, 140 140 + method: opts.method as KyOptions['method'], 141 141 + mode: opts.mode, 142 142 + redirect: 'follow', 143 143 + referrer: opts.referrer, 144 144 + referrerPolicy: opts.referrerPolicy, 145 145 + signal: opts.signal, 146 146 + throwHttpErrors: opts.throwOnError ?? false, 147 147 + timeout: opts.timeout, 148 148 + ...opts.kyOptions, 149 149 + }; 150 150 + 151 151 + if (opts.retry && typeof opts.retry === 'object') { 152 152 + const retryOpts = opts.retry as RetryOptions; 153 153 + kyOptions.retry = { 154 154 + limit: retryOpts.limit ?? 2, 155 155 + methods: retryOpts.methods as Array< 156 156 + | 'get' 157 157 + | 'post' 158 158 + | 'put' 159 159 + | 'patch' 160 160 + | 'head' 161 161 + | 'delete' 162 162 + | 'options' 163 163 + | 'trace' 164 164 + >, 165 165 + statusCodes: retryOpts.statusCodes, 166 166 + }; 167 167 + } 168 168 + 169 169 + let request = new Request(url, { 170 170 + body: kyOptions.body as BodyInit, 171 171 + headers: kyOptions.headers as HeadersInit, 172 172 + method: kyOptions.method, 173 173 + }); 174 174 + 175 175 + for (const fn of interceptors.request.fns) { 176 176 + if (fn) { 177 177 + request = await fn(request, opts); 178 178 + } 179 179 + } 180 180 + 181 181 + let response: Response; 182 182 + 183 183 + try { 184 184 + response = await kyInstance(request, kyOptions); 185 185 + } catch (error) { 186 186 + if (error && typeof error === 'object' && 'response' in error) { 187 187 + const httpError = error as HTTPError; 188 188 + response = httpError.response; 189 189 + 190 190 + for (const fn of interceptors.response.fns) { 191 191 + if (fn) { 192 192 + response = await fn(response, request, opts); 193 193 + } 194 194 + } 195 195 + 196 196 + return parseErrorResponse(response, request, opts, interceptors); 197 197 + } 198 198 + 199 199 + throw error; 200 200 + } 201 201 + 202 202 + for (const fn of interceptors.response.fns) { 203 203 + if (fn) { 204 204 + response = await fn(response, request, opts); 205 205 + } 206 206 + } 207 207 + 208 208 + const result = { 209 209 + request, 210 210 + response, 211 211 + }; 212 212 + 213 213 + if (response.ok) { 214 214 + const parseAs = 215 215 + (opts.parseAs === 'auto' 216 216 + ? getParseAs(response.headers.get('Content-Type')) 217 217 + : opts.parseAs) ?? 'json'; 218 218 + 219 219 + if ( 220 220 + response.status === 204 || 221 221 + response.headers.get('Content-Length') === '0' 222 222 + ) { 223 223 + let emptyData: any; 224 224 + switch (parseAs) { 225 225 + case 'arrayBuffer': 226 226 + case 'blob': 227 227 + case 'text': 228 228 + emptyData = await response[parseAs](); 229 229 + break; 230 230 + case 'formData': 231 231 + emptyData = new FormData(); 232 232 + break; 233 233 + case 'stream': 234 234 + emptyData = response.body; 235 235 + break; 236 236 + case 'json': 237 237 + default: 238 238 + emptyData = {}; 239 239 + break; 240 240 + } 241 241 + return opts.responseStyle === 'data' 242 242 + ? emptyData 243 243 + : { 244 244 + data: emptyData, 245 245 + ...result, 246 246 + }; 247 247 + } 248 248 + 249 249 + let data: any; 250 250 + switch (parseAs) { 251 251 + case 'arrayBuffer': 252 252 + case 'blob': 253 253 + case 'formData': 254 254 + case 'json': 255 255 + case 'text': 256 256 + data = await response[parseAs](); 257 257 + break; 258 258 + case 'stream': 259 259 + return opts.responseStyle === 'data' 260 260 + ? response.body 261 261 + : { 262 262 + data: response.body, 263 263 + ...result, 264 264 + }; 265 265 + } 266 266 + 267 267 + if (parseAs === 'json') { 268 268 + if (opts.responseValidator) { 269 269 + await opts.responseValidator(data); 270 270 + } 271 271 + 272 272 + if (opts.responseTransformer) { 273 273 + data = await opts.responseTransformer(data); 274 274 + } 275 275 + } 276 276 + 277 277 + return opts.responseStyle === 'data' 278 278 + ? data 279 279 + : { 280 280 + data, 281 281 + ...result, 282 282 + }; 283 283 + } 284 284 + 285 285 + return parseErrorResponse(response, request, opts, interceptors); 286 286 + }; 287 287 + 288 288 + const makeMethodFn = 289 289 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 290 290 + request({ ...options, method }); 291 291 + 292 292 + const makeSseFn = 293 293 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 294 294 + const { opts, url } = await beforeRequest(options); 295 295 + return createSseClient({ 296 296 + ...opts, 297 297 + body: opts.body as BodyInit | null | undefined, 298 298 + fetch: globalThis.fetch, 299 299 + headers: opts.headers as unknown as Record<string, string>, 300 300 + method, 301 301 + onRequest: async (url, init) => { 302 302 + let request = new Request(url, init); 303 303 + for (const fn of interceptors.request.fns) { 304 304 + if (fn) { 305 305 + request = await fn(request, opts); 306 306 + } 307 307 + } 308 308 + return request; 309 309 + }, 310 310 + url, 311 311 + }); 312 312 + }; 313 313 + 314 314 + return { 315 315 + buildUrl, 316 316 + connect: makeMethodFn('CONNECT'), 317 317 + delete: makeMethodFn('DELETE'), 318 318 + get: makeMethodFn('GET'), 319 319 + getConfig, 320 320 + head: makeMethodFn('HEAD'), 321 321 + interceptors, 322 322 + options: makeMethodFn('OPTIONS'), 323 323 + patch: makeMethodFn('PATCH'), 324 324 + post: makeMethodFn('POST'), 325 325 + put: makeMethodFn('PUT'), 326 326 + request, 327 327 + setConfig, 328 328 + sse: { 329 329 + connect: makeSseFn('CONNECT'), 330 330 + delete: makeSseFn('DELETE'), 331 331 + get: makeSseFn('GET'), 332 332 + head: makeSseFn('HEAD'), 333 333 + options: makeSseFn('OPTIONS'), 334 334 + patch: makeSseFn('PATCH'), 335 335 + post: makeSseFn('POST'), 336 336 + put: makeSseFn('PUT'), 337 337 + trace: makeSseFn('TRACE'), 338 338 + }, 339 339 + trace: makeMethodFn('TRACE'), 340 340 + } as Client; 341 341 + };

+26

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + ResolvedRequestOptions, 22 22 + ResponseStyle, 23 23 + RetryOptions, 24 24 + TDataShape, 25 25 + } from './types.gen.js'; 26 26 + export { createConfig, mergeHeaders } from './utils.gen.js';

+273

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth } from '../core/auth.gen.js'; 4 4 + import type { 5 5 + ServerSentEventsOptions, 6 6 + ServerSentEventsResult, 7 7 + } from '../core/serverSentEvents.gen.js'; 8 8 + import type { 9 9 + Client as CoreClient, 10 10 + Config as CoreConfig, 11 11 + } from '../core/types.gen.js'; 12 12 + import type { Middleware } from './utils.gen.js'; 13 13 + 14 14 + export type ResponseStyle = 'data' | 'fields'; 15 15 + 16 16 + export interface RetryOptions { 17 17 + /** 18 18 + * Maximum number of retry attempts 19 19 + * 20 20 + * @default 2 21 21 + */ 22 22 + limit?: number; 23 23 + /** 24 24 + * HTTP methods to retry 25 25 + * 26 26 + * @default ['get', 'put', 'head', 'delete', 'options', 'trace'] 27 27 + */ 28 28 + methods?: Array< 29 29 + 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace' 30 30 + >; 31 31 + /** 32 32 + * HTTP status codes to retry 33 33 + * 34 34 + * @default [408, 413, 429, 500, 502, 503, 504] 35 35 + */ 36 36 + statusCodes?: number[]; 37 37 + } 38 38 + 39 39 + export interface Config<T extends ClientOptions = ClientOptions> 40 40 + extends Omit< 41 41 + import('ky').Options, 42 42 + 'body' | 'headers' | 'method' | 'prefixUrl' | 'retry' | 'throwHttpErrors' 43 43 + >, 44 44 + CoreConfig { 45 45 + /** 46 46 + * Base URL for all requests made by this client. 47 47 + */ 48 48 + baseUrl?: T['baseUrl']; 49 49 + /** 50 50 + * Ky instance to use. You can use this option to provide a custom 51 51 + * ky instance. 52 52 + */ 53 53 + ky?: typeof import('ky').default; 54 54 + /** 55 55 + * Additional ky-specific options that will be passed directly to ky. 56 56 + * This allows you to use any ky option not explicitly exposed in the config. 57 57 + */ 58 58 + kyOptions?: Omit<import('ky').Options, 'method' | 'prefixUrl'>; 59 59 + /** 60 60 + * Return the response data parsed in a specified format. By default, `auto` 61 61 + * will infer the appropriate method from the `Content-Type` response header. 62 62 + * You can override this behavior with any of the {@link Body} methods. 63 63 + * Select `stream` if you don't want to parse response data at all. 64 64 + * 65 65 + * @default 'auto' 66 66 + */ 67 67 + parseAs?: 68 68 + | 'arrayBuffer' 69 69 + | 'auto' 70 70 + | 'blob' 71 71 + | 'formData' 72 72 + | 'json' 73 73 + | 'stream' 74 74 + | 'text'; 75 75 + /** 76 76 + * Should we return only data or multiple fields (data, error, response, etc.)? 77 77 + * 78 78 + * @default 'fields' 79 79 + */ 80 80 + responseStyle?: ResponseStyle; 81 81 + /** 82 82 + * Retry configuration 83 83 + */ 84 84 + retry?: RetryOptions; 85 85 + /** 86 86 + * Throw an error instead of returning it in the response? 87 87 + * 88 88 + * @default false 89 89 + */ 90 90 + throwOnError?: T['throwOnError']; 91 91 + /** 92 92 + * Request timeout in milliseconds 93 93 + * 94 94 + * @default 10000 95 95 + */ 96 96 + timeout?: number; 97 97 + } 98 98 + 99 99 + export interface RequestOptions< 100 100 + TData = unknown, 101 101 + TResponseStyle extends ResponseStyle = 'fields', 102 102 + ThrowOnError extends boolean = boolean, 103 103 + Url extends string = string, 104 104 + > extends Config<{ 105 105 + responseStyle: TResponseStyle; 106 106 + throwOnError: ThrowOnError; 107 107 + }>, 108 108 + Pick< 109 109 + ServerSentEventsOptions<TData>, 110 110 + | 'onSseError' 111 111 + | 'onSseEvent' 112 112 + | 'sseDefaultRetryDelay' 113 113 + | 'sseMaxRetryAttempts' 114 114 + | 'sseMaxRetryDelay' 115 115 + > { 116 116 + /** 117 117 + * Any body that you want to add to your request. 118 118 + * 119 119 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 120 120 + */ 121 121 + body?: unknown; 122 122 + path?: Record<string, unknown>; 123 123 + query?: Record<string, unknown>; 124 124 + /** 125 125 + * Security mechanism(s) to use for the request. 126 126 + */ 127 127 + security?: ReadonlyArray<Auth>; 128 128 + url: Url; 129 129 + } 130 130 + 131 131 + export interface ResolvedRequestOptions< 132 132 + TResponseStyle extends ResponseStyle = 'fields', 133 133 + ThrowOnError extends boolean = boolean, 134 134 + Url extends string = string, 135 135 + > extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> { 136 136 + serializedBody?: string; 137 137 + } 138 138 + 139 139 + export type RequestResult< 140 140 + TData = unknown, 141 141 + TError = unknown, 142 142 + ThrowOnError extends boolean = boolean, 143 143 + TResponseStyle extends ResponseStyle = 'fields', 144 144 + > = ThrowOnError extends true 145 145 + ? Promise< 146 146 + TResponseStyle extends 'data' 147 147 + ? TData extends Record<string, unknown> 148 148 + ? TData[keyof TData] 149 149 + : TData 150 150 + : { 151 151 + data: TData extends Record<string, unknown> 152 152 + ? TData[keyof TData] 153 153 + : TData; 154 154 + request: Request; 155 155 + response: Response; 156 156 + } 157 157 + > 158 158 + : Promise< 159 159 + TResponseStyle extends 'data' 160 160 + ? 161 161 + | (TData extends Record<string, unknown> 162 162 + ? TData[keyof TData] 163 163 + : TData) 164 164 + | undefined 165 165 + : ( 166 166 + | { 167 167 + data: TData extends Record<string, unknown> 168 168 + ? TData[keyof TData] 169 169 + : TData; 170 170 + error: undefined; 171 171 + } 172 172 + | { 173 173 + data: undefined; 174 174 + error: TError extends Record<string, unknown> 175 175 + ? TError[keyof TError] 176 176 + : TError; 177 177 + } 178 178 + ) & { 179 179 + request: Request; 180 180 + response: Response; 181 181 + } 182 182 + >; 183 183 + 184 184 + export interface ClientOptions { 185 185 + baseUrl?: string; 186 186 + responseStyle?: ResponseStyle; 187 187 + throwOnError?: boolean; 188 188 + } 189 189 + 190 190 + type MethodFn = < 191 191 + TData = unknown, 192 192 + TError = unknown, 193 193 + ThrowOnError extends boolean = false, 194 194 + TResponseStyle extends ResponseStyle = 'fields', 195 195 + >( 196 196 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 197 197 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 198 198 + 199 199 + type SseFn = < 200 200 + TData = unknown, 201 201 + TError = unknown, 202 202 + ThrowOnError extends boolean = false, 203 203 + TResponseStyle extends ResponseStyle = 'fields', 204 204 + >( 205 205 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 206 206 + ) => Promise<ServerSentEventsResult<TData, TError>>; 207 207 + 208 208 + type RequestFn = < 209 209 + TData = unknown, 210 210 + TError = unknown, 211 211 + ThrowOnError extends boolean = false, 212 212 + TResponseStyle extends ResponseStyle = 'fields', 213 213 + >( 214 214 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & 215 215 + Pick< 216 216 + Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 217 217 + 'method' 218 218 + >, 219 219 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 220 220 + 221 221 + type BuildUrlFn = < 222 222 + TData extends { 223 223 + body?: unknown; 224 224 + path?: Record<string, unknown>; 225 225 + query?: Record<string, unknown>; 226 226 + url: string; 227 227 + }, 228 228 + >( 229 229 + options: TData & Options<TData>, 230 230 + ) => string; 231 231 + 232 232 + export type Client = CoreClient< 233 233 + RequestFn, 234 234 + Config, 235 235 + MethodFn, 236 236 + BuildUrlFn, 237 237 + SseFn 238 238 + > & { 239 239 + interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>; 240 240 + }; 241 241 + 242 242 + /** 243 243 + * The `createClientConfig()` function will be called on client initialization 244 244 + * and the returned object will become the client's initial configuration. 245 245 + * 246 246 + * You may want to initialize your client this way instead of calling 247 247 + * `setConfig()`. This is useful for example if you're using Next.js 248 248 + * to ensure your client always has the correct values. 249 249 + */ 250 250 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 251 251 + override?: Config<ClientOptions & T>, 252 252 + ) => Config<Required<ClientOptions> & T>; 253 253 + 254 254 + export interface TDataShape { 255 255 + body?: unknown; 256 256 + headers?: unknown; 257 257 + path?: unknown; 258 258 + query?: unknown; 259 259 + url: string; 260 260 + } 261 261 + 262 262 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 263 263 + 264 264 + export type Options< 265 265 + TData extends TDataShape = TDataShape, 266 266 + ThrowOnError extends boolean = boolean, 267 267 + TResponse = unknown, 268 268 + TResponseStyle extends ResponseStyle = 'fields', 269 269 + > = OmitKeys< 270 270 + RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 271 271 + 'body' | 'path' | 'query' | 'url' 272 272 + > & 273 273 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+330

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { getAuthToken } from '../core/auth.gen.js'; 4 4 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + import { jsonBodySerializer } from '../core/bodySerializer.gen.js'; 6 6 + import { 7 7 + serializeArrayParam, 8 8 + serializeObjectParam, 9 9 + serializePrimitiveParam, 10 10 + } from '../core/pathSerializer.gen.js'; 11 11 + import { getUrl } from '../core/utils.gen.js'; 12 12 + import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js'; 13 13 + 14 14 + export const createQuerySerializer = <T = unknown>({ 15 15 + parameters = {}, 16 16 + ...args 17 17 + }: QuerySerializerOptions = {}) => { 18 18 + const querySerializer = (queryParams: T) => { 19 19 + const search: string[] = []; 20 20 + if (queryParams && typeof queryParams === 'object') { 21 21 + for (const name in queryParams) { 22 22 + const value = queryParams[name]; 23 23 + 24 24 + if (value === undefined || value === null) { 25 25 + continue; 26 26 + } 27 27 + 28 28 + const options = parameters[name] || args; 29 29 + 30 30 + if (Array.isArray(value)) { 31 31 + const serializedArray = serializeArrayParam({ 32 32 + allowReserved: options.allowReserved, 33 33 + explode: true, 34 34 + name, 35 35 + style: 'form', 36 36 + value, 37 37 + ...options.array, 38 38 + }); 39 39 + if (serializedArray) search.push(serializedArray); 40 40 + } else if (typeof value === 'object') { 41 41 + const serializedObject = serializeObjectParam({ 42 42 + allowReserved: options.allowReserved, 43 43 + explode: true, 44 44 + name, 45 45 + style: 'deepObject', 46 46 + value: value as Record<string, unknown>, 47 47 + ...options.object, 48 48 + }); 49 49 + if (serializedObject) search.push(serializedObject); 50 50 + } else { 51 51 + const serializedPrimitive = serializePrimitiveParam({ 52 52 + allowReserved: options.allowReserved, 53 53 + name, 54 54 + value: value as string, 55 55 + }); 56 56 + if (serializedPrimitive) search.push(serializedPrimitive); 57 57 + } 58 58 + } 59 59 + } 60 60 + return search.join('&'); 61 61 + }; 62 62 + return querySerializer; 63 63 + }; 64 64 + 65 65 + /** 66 66 + * Infers parseAs value from provided Content-Type header. 67 67 + */ 68 68 + export const getParseAs = ( 69 69 + contentType: string | null, 70 70 + ): Exclude<Config['parseAs'], 'auto'> => { 71 71 + if (!contentType) { 72 72 + return 'stream'; 73 73 + } 74 74 + 75 75 + const cleanContent = contentType.split(';')[0]?.trim(); 76 76 + 77 77 + if (!cleanContent) { 78 78 + return; 79 79 + } 80 80 + 81 81 + if ( 82 82 + cleanContent.startsWith('application/json') || 83 83 + cleanContent.endsWith('+json') 84 84 + ) { 85 85 + return 'json'; 86 86 + } 87 87 + 88 88 + if (cleanContent === 'multipart/form-data') { 89 89 + return 'formData'; 90 90 + } 91 91 + 92 92 + if ( 93 93 + ['application/', 'audio/', 'image/', 'video/'].some((type) => 94 94 + cleanContent.startsWith(type), 95 95 + ) 96 96 + ) { 97 97 + return 'blob'; 98 98 + } 99 99 + 100 100 + if (cleanContent.startsWith('text/')) { 101 101 + return 'text'; 102 102 + } 103 103 + 104 104 + return; 105 105 + }; 106 106 + 107 107 + const checkForExistence = ( 108 108 + options: Pick<RequestOptions, 'auth' | 'query'> & { 109 109 + headers: Headers; 110 110 + }, 111 111 + name?: string, 112 112 + ): boolean => { 113 113 + if (!name) { 114 114 + return false; 115 115 + } 116 116 + if ( 117 117 + options.headers.has(name) || 118 118 + options.query?.[name] || 119 119 + options.headers.get('Cookie')?.includes(`${name}=`) 120 120 + ) { 121 121 + return true; 122 122 + } 123 123 + return false; 124 124 + }; 125 125 + 126 126 + export const setAuthParams = async ({ 127 127 + security, 128 128 + ...options 129 129 + }: Pick<Required<RequestOptions>, 'security'> & 130 130 + Pick<RequestOptions, 'auth' | 'query'> & { 131 131 + headers: Headers; 132 132 + }) => { 133 133 + for (const auth of security) { 134 134 + if (checkForExistence(options, auth.name)) { 135 135 + continue; 136 136 + } 137 137 + 138 138 + const token = await getAuthToken(auth, options.auth); 139 139 + 140 140 + if (!token) { 141 141 + continue; 142 142 + } 143 143 + 144 144 + const name = auth.name ?? 'Authorization'; 145 145 + 146 146 + switch (auth.in) { 147 147 + case 'query': 148 148 + if (!options.query) { 149 149 + options.query = {}; 150 150 + } 151 151 + options.query[name] = token; 152 152 + break; 153 153 + case 'cookie': 154 154 + options.headers.append('Cookie', `${name}=${token}`); 155 155 + break; 156 156 + case 'header': 157 157 + default: 158 158 + options.headers.set(name, token); 159 159 + break; 160 160 + } 161 161 + } 162 162 + }; 163 163 + 164 164 + export const buildUrl: Client['buildUrl'] = (options) => 165 165 + getUrl({ 166 166 + baseUrl: options.baseUrl as string, 167 167 + path: options.path, 168 168 + query: options.query, 169 169 + querySerializer: 170 170 + typeof options.querySerializer === 'function' 171 171 + ? options.querySerializer 172 172 + : createQuerySerializer(options.querySerializer), 173 173 + url: options.url, 174 174 + }); 175 175 + 176 176 + export const mergeConfigs = (a: Config, b: Config): Config => { 177 177 + const config = { ...a, ...b }; 178 178 + if (config.baseUrl?.endsWith('/')) { 179 179 + config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1); 180 180 + } 181 181 + config.headers = mergeHeaders(a.headers, b.headers); 182 182 + return config; 183 183 + }; 184 184 + 185 185 + const headersEntries = (headers: Headers): Array<[string, string]> => { 186 186 + const entries: Array<[string, string]> = []; 187 187 + headers.forEach((value, key) => { 188 188 + entries.push([key, value]); 189 189 + }); 190 190 + return entries; 191 191 + }; 192 192 + 193 193 + export const mergeHeaders = ( 194 194 + ...headers: Array<Required<Config>['headers'] | undefined> 195 195 + ): Headers => { 196 196 + const mergedHeaders = new Headers(); 197 197 + for (const header of headers) { 198 198 + if (!header) { 199 199 + continue; 200 200 + } 201 201 + 202 202 + const iterator = 203 203 + header instanceof Headers 204 204 + ? headersEntries(header) 205 205 + : Object.entries(header); 206 206 + 207 207 + for (const [key, value] of iterator) { 208 208 + if (value === null) { 209 209 + mergedHeaders.delete(key); 210 210 + } else if (Array.isArray(value)) { 211 211 + for (const v of value) { 212 212 + mergedHeaders.append(key, v as string); 213 213 + } 214 214 + } else if (value !== undefined) { 215 215 + mergedHeaders.set( 216 216 + key, 217 217 + typeof value === 'object' ? JSON.stringify(value) : (value as string), 218 218 + ); 219 219 + } 220 220 + } 221 221 + } 222 222 + return mergedHeaders; 223 223 + }; 224 224 + 225 225 + type ErrInterceptor<Err, Res, Req, Options> = ( 226 226 + error: Err, 227 227 + response: Res, 228 228 + request: Req, 229 229 + options: Options, 230 230 + ) => Err | Promise<Err>; 231 231 + 232 232 + type ReqInterceptor<Req, Options> = ( 233 233 + request: Req, 234 234 + options: Options, 235 235 + ) => Req | Promise<Req>; 236 236 + 237 237 + type ResInterceptor<Res, Req, Options> = ( 238 238 + response: Res, 239 239 + request: Req, 240 240 + options: Options, 241 241 + ) => Res | Promise<Res>; 242 242 + 243 243 + class Interceptors<Interceptor> { 244 244 + fns: Array<Interceptor | null> = []; 245 245 + 246 246 + clear(): void { 247 247 + this.fns = []; 248 248 + } 249 249 + 250 250 + eject(id: number | Interceptor): void { 251 251 + const index = this.getInterceptorIndex(id); 252 252 + if (this.fns[index]) { 253 253 + this.fns[index] = null; 254 254 + } 255 255 + } 256 256 + 257 257 + exists(id: number | Interceptor): boolean { 258 258 + const index = this.getInterceptorIndex(id); 259 259 + return Boolean(this.fns[index]); 260 260 + } 261 261 + 262 262 + getInterceptorIndex(id: number | Interceptor): number { 263 263 + if (typeof id === 'number') { 264 264 + return this.fns[id] ? id : -1; 265 265 + } 266 266 + return this.fns.indexOf(id); 267 267 + } 268 268 + 269 269 + update( 270 270 + id: number | Interceptor, 271 271 + fn: Interceptor, 272 272 + ): number | Interceptor | false { 273 273 + const index = this.getInterceptorIndex(id); 274 274 + if (this.fns[index]) { 275 275 + this.fns[index] = fn; 276 276 + return id; 277 277 + } 278 278 + return false; 279 279 + } 280 280 + 281 281 + use(fn: Interceptor): number { 282 282 + this.fns.push(fn); 283 283 + return this.fns.length - 1; 284 284 + } 285 285 + } 286 286 + 287 287 + export interface Middleware<Req, Res, Err, Options> { 288 288 + error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>; 289 289 + request: Interceptors<ReqInterceptor<Req, Options>>; 290 290 + response: Interceptors<ResInterceptor<Res, Req, Options>>; 291 291 + } 292 292 + 293 293 + export const createInterceptors = <Req, Res, Err, Options>(): Middleware< 294 294 + Req, 295 295 + Res, 296 296 + Err, 297 297 + Options 298 298 + > => ({ 299 299 + error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(), 300 300 + request: new Interceptors<ReqInterceptor<Req, Options>>(), 301 301 + response: new Interceptors<ResInterceptor<Res, Req, Options>>(), 302 302 + }); 303 303 + 304 304 + const defaultQuerySerializer = createQuerySerializer({ 305 305 + allowReserved: false, 306 306 + array: { 307 307 + explode: true, 308 308 + style: 'form', 309 309 + }, 310 310 + object: { 311 311 + explode: true, 312 312 + style: 'deepObject', 313 313 + }, 314 314 + }); 315 315 + 316 316 + const defaultHeaders = { 317 317 + 'Content-Type': 'application/json', 318 318 + }; 319 319 + 320 320 + export const createConfig = <T extends ClientOptions = ClientOptions>( 321 321 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 322 322 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 323 323 + ...jsonBodySerializer, 324 324 + headers: defaultHeaders, 325 325 + parseAs: 'auto', 326 326 + querySerializer: defaultQuerySerializer, 327 327 + throwOnError: false, 328 328 + timeout: 10000, 329 329 + ...override, 330 330 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options?.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options?.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ky/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseUrl: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'http://localhost:3000/base' }));

+262

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 4 4 + import type { HttpMethod } from '../core/types.gen.js'; 5 5 + import { getValidRequestBody } from '../core/utils.gen.js'; 6 6 + import type { 7 7 + Client, 8 8 + Config, 9 9 + RequestOptions, 10 10 + ResolvedRequestOptions, 11 11 + } from './types.gen.js'; 12 12 + import { 13 13 + buildUrl, 14 14 + createConfig, 15 15 + createInterceptors, 16 16 + getParseAs, 17 17 + mergeConfigs, 18 18 + mergeHeaders, 19 19 + setAuthParams, 20 20 + } from './utils.gen.js'; 21 21 + 22 22 + type ReqInit = Omit<RequestInit, 'body' | 'headers'> & { 23 23 + body?: any; 24 24 + headers: ReturnType<typeof mergeHeaders>; 25 25 + }; 26 26 + 27 27 + export const createClient = (config: Config = {}): Client => { 28 28 + let _config = mergeConfigs(createConfig(), config); 29 29 + 30 30 + const getConfig = (): Config => ({ ..._config }); 31 31 + 32 32 + const setConfig = (config: Config): Config => { 33 33 + _config = mergeConfigs(_config, config); 34 34 + return getConfig(); 35 35 + }; 36 36 + 37 37 + const interceptors = createInterceptors< 38 38 + Response, 39 39 + unknown, 40 40 + ResolvedRequestOptions 41 41 + >(); 42 42 + 43 43 + const beforeRequest = async (options: RequestOptions) => { 44 44 + const opts = { 45 45 + ..._config, 46 46 + ...options, 47 47 + fetch: options.fetch ?? _config.fetch ?? globalThis.fetch, 48 48 + headers: mergeHeaders(_config.headers, options.headers), 49 49 + serializedBody: undefined, 50 50 + }; 51 51 + 52 52 + if (opts.security) { 53 53 + await setAuthParams({ 54 54 + ...opts, 55 55 + security: opts.security, 56 56 + }); 57 57 + } 58 58 + 59 59 + if (opts.requestValidator) { 60 60 + await opts.requestValidator(opts); 61 61 + } 62 62 + 63 63 + if (opts.body !== undefined && opts.bodySerializer) { 64 64 + opts.serializedBody = opts.bodySerializer(opts.body); 65 65 + } 66 66 + 67 67 + // remove Content-Type header if body is empty to avoid sending invalid requests 68 68 + if (opts.body === undefined || opts.serializedBody === '') { 69 69 + opts.headers.delete('Content-Type'); 70 70 + } 71 71 + 72 72 + const url = buildUrl(opts); 73 73 + 74 74 + return { opts, url }; 75 75 + }; 76 76 + 77 77 + // @ts-expect-error 78 78 + const request: Client['request'] = async (options) => { 79 79 + // @ts-expect-error 80 80 + const { opts, url } = await beforeRequest(options); 81 81 + 82 82 + for (const fn of interceptors.request.fns) { 83 83 + if (fn) { 84 84 + await fn(opts); 85 85 + } 86 86 + } 87 87 + 88 88 + // fetch must be assigned here, otherwise it would throw the error: 89 89 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 90 90 + const _fetch = opts.fetch!; 91 91 + const requestInit: ReqInit = { 92 92 + ...opts, 93 93 + body: getValidRequestBody(opts), 94 94 + }; 95 95 + 96 96 + let response = await _fetch(url, requestInit); 97 97 + 98 98 + for (const fn of interceptors.response.fns) { 99 99 + if (fn) { 100 100 + response = await fn(response, opts); 101 101 + } 102 102 + } 103 103 + 104 104 + const result = { 105 105 + response, 106 106 + }; 107 107 + 108 108 + if (response.ok) { 109 109 + const parseAs = 110 110 + (opts.parseAs === 'auto' 111 111 + ? getParseAs(response.headers.get('Content-Type')) 112 112 + : opts.parseAs) ?? 'json'; 113 113 + 114 114 + if ( 115 115 + response.status === 204 || 116 116 + response.headers.get('Content-Length') === '0' 117 117 + ) { 118 118 + let emptyData: any; 119 119 + switch (parseAs) { 120 120 + case 'arrayBuffer': 121 121 + case 'blob': 122 122 + case 'text': 123 123 + emptyData = await response[parseAs](); 124 124 + break; 125 125 + case 'formData': 126 126 + emptyData = new FormData(); 127 127 + break; 128 128 + case 'stream': 129 129 + emptyData = response.body; 130 130 + break; 131 131 + case 'json': 132 132 + default: 133 133 + emptyData = {}; 134 134 + break; 135 135 + } 136 136 + return { 137 137 + data: emptyData, 138 138 + ...result, 139 139 + }; 140 140 + } 141 141 + 142 142 + let data: any; 143 143 + switch (parseAs) { 144 144 + case 'arrayBuffer': 145 145 + case 'blob': 146 146 + case 'formData': 147 147 + case 'json': 148 148 + case 'text': 149 149 + data = await response[parseAs](); 150 150 + break; 151 151 + case 'stream': 152 152 + return { 153 153 + data: response.body, 154 154 + ...result, 155 155 + }; 156 156 + } 157 157 + 158 158 + if (parseAs === 'json') { 159 159 + if (opts.responseValidator) { 160 160 + await opts.responseValidator(data); 161 161 + } 162 162 + 163 163 + if (opts.responseTransformer) { 164 164 + data = await opts.responseTransformer(data); 165 165 + } 166 166 + } 167 167 + 168 168 + return { 169 169 + data, 170 170 + ...result, 171 171 + }; 172 172 + } 173 173 + 174 174 + const textError = await response.text(); 175 175 + let jsonError: unknown; 176 176 + 177 177 + try { 178 178 + jsonError = JSON.parse(textError); 179 179 + } catch { 180 180 + // noop 181 181 + } 182 182 + 183 183 + const error = jsonError ?? textError; 184 184 + let finalError = error; 185 185 + 186 186 + for (const fn of interceptors.error.fns) { 187 187 + if (fn) { 188 188 + finalError = (await fn(error, response, opts)) as string; 189 189 + } 190 190 + } 191 191 + 192 192 + finalError = finalError || ({} as string); 193 193 + 194 194 + if (opts.throwOnError) { 195 195 + throw finalError; 196 196 + } 197 197 + 198 198 + return { 199 199 + error: finalError, 200 200 + ...result, 201 201 + }; 202 202 + }; 203 203 + 204 204 + const makeMethodFn = 205 205 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 206 206 + request({ ...options, method }); 207 207 + 208 208 + const makeSseFn = 209 209 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 210 210 + const { opts, url } = await beforeRequest(options); 211 211 + return createSseClient({ 212 212 + ...opts, 213 213 + body: opts.body as BodyInit | null | undefined, 214 214 + headers: opts.headers as unknown as Record<string, string>, 215 215 + method, 216 216 + onRequest: async (url, init) => { 217 217 + let request = new Request(url, init); 218 218 + const requestInit = { 219 219 + ...init, 220 220 + method: init.method as Config['method'], 221 221 + url, 222 222 + }; 223 223 + for (const fn of interceptors.request.fns) { 224 224 + if (fn) { 225 225 + await fn(requestInit); 226 226 + request = new Request(requestInit.url, requestInit); 227 227 + } 228 228 + } 229 229 + return request; 230 230 + }, 231 231 + url, 232 232 + }); 233 233 + }; 234 234 + 235 235 + return { 236 236 + buildUrl, 237 237 + connect: makeMethodFn('CONNECT'), 238 238 + delete: makeMethodFn('DELETE'), 239 239 + get: makeMethodFn('GET'), 240 240 + getConfig, 241 241 + head: makeMethodFn('HEAD'), 242 242 + interceptors, 243 243 + options: makeMethodFn('OPTIONS'), 244 244 + patch: makeMethodFn('PATCH'), 245 245 + post: makeMethodFn('POST'), 246 246 + put: makeMethodFn('PUT'), 247 247 + request, 248 248 + setConfig, 249 249 + sse: { 250 250 + connect: makeSseFn('CONNECT'), 251 251 + delete: makeSseFn('DELETE'), 252 252 + get: makeSseFn('GET'), 253 253 + head: makeSseFn('HEAD'), 254 254 + options: makeSseFn('OPTIONS'), 255 255 + patch: makeSseFn('PATCH'), 256 256 + post: makeSseFn('POST'), 257 257 + put: makeSseFn('PUT'), 258 258 + trace: makeSseFn('TRACE'), 259 259 + }, 260 260 + trace: makeMethodFn('TRACE'), 261 261 + } as Client; 262 262 + };

+23

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + TDataShape, 22 22 + } from './types.gen.js'; 23 23 + export { createConfig } from './utils.gen.js';

+198

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth } from '../core/auth.gen.js'; 4 4 + import type { 5 5 + ServerSentEventsOptions, 6 6 + ServerSentEventsResult, 7 7 + } from '../core/serverSentEvents.gen.js'; 8 8 + import type { 9 9 + Client as CoreClient, 10 10 + Config as CoreConfig, 11 11 + } from '../core/types.gen.js'; 12 12 + import type { Middleware } from './utils.gen.js'; 13 13 + 14 14 + export interface Config<T extends ClientOptions = ClientOptions> 15 15 + extends Omit<RequestInit, 'body' | 'headers' | 'method'>, 16 16 + CoreConfig { 17 17 + /** 18 18 + * Base URL for all requests made by this client. 19 19 + */ 20 20 + baseUrl?: T['baseUrl']; 21 21 + /** 22 22 + * Fetch API implementation. You can use this option to provide a custom 23 23 + * fetch instance. 24 24 + * 25 25 + * @default globalThis.fetch 26 26 + */ 27 27 + fetch?: typeof fetch; 28 28 + /** 29 29 + * Return the response data parsed in a specified format. By default, `auto` 30 30 + * will infer the appropriate method from the `Content-Type` response header. 31 31 + * You can override this behavior with any of the {@link Body} methods. 32 32 + * Select `stream` if you don't want to parse response data at all. 33 33 + * 34 34 + * @default 'auto' 35 35 + */ 36 36 + parseAs?: 37 37 + | 'arrayBuffer' 38 38 + | 'auto' 39 39 + | 'blob' 40 40 + | 'formData' 41 41 + | 'json' 42 42 + | 'stream' 43 43 + | 'text'; 44 44 + /** 45 45 + * Throw an error instead of returning it in the response? 46 46 + * 47 47 + * @default false 48 48 + */ 49 49 + throwOnError?: T['throwOnError']; 50 50 + } 51 51 + 52 52 + export interface RequestOptions< 53 53 + TData = unknown, 54 54 + ThrowOnError extends boolean = boolean, 55 55 + Url extends string = string, 56 56 + > extends Config<{ 57 57 + throwOnError: ThrowOnError; 58 58 + }>, 59 59 + Pick< 60 60 + ServerSentEventsOptions<TData>, 61 61 + | 'onSseError' 62 62 + | 'onSseEvent' 63 63 + | 'sseDefaultRetryDelay' 64 64 + | 'sseMaxRetryAttempts' 65 65 + | 'sseMaxRetryDelay' 66 66 + > { 67 67 + /** 68 68 + * Any body that you want to add to your request. 69 69 + * 70 70 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 71 71 + */ 72 72 + body?: unknown; 73 73 + path?: Record<string, unknown>; 74 74 + query?: Record<string, unknown>; 75 75 + /** 76 76 + * Security mechanism(s) to use for the request. 77 77 + */ 78 78 + security?: ReadonlyArray<Auth>; 79 79 + url: Url; 80 80 + } 81 81 + 82 82 + export interface ResolvedRequestOptions< 83 83 + ThrowOnError extends boolean = boolean, 84 84 + Url extends string = string, 85 85 + > extends RequestOptions<unknown, ThrowOnError, Url> { 86 86 + serializedBody?: string; 87 87 + } 88 88 + 89 89 + export type RequestResult< 90 90 + TData = unknown, 91 91 + TError = unknown, 92 92 + ThrowOnError extends boolean = boolean, 93 93 + > = ThrowOnError extends true 94 94 + ? Promise<{ 95 95 + data: TData extends Record<string, unknown> ? TData[keyof TData] : TData; 96 96 + response: Response; 97 97 + }> 98 98 + : Promise< 99 99 + ( 100 100 + | { 101 101 + data: TData extends Record<string, unknown> 102 102 + ? TData[keyof TData] 103 103 + : TData; 104 104 + error: undefined; 105 105 + } 106 106 + | { 107 107 + data: undefined; 108 108 + error: TError extends Record<string, unknown> 109 109 + ? TError[keyof TError] 110 110 + : TError; 111 111 + } 112 112 + ) & { 113 113 + response: Response; 114 114 + } 115 115 + >; 116 116 + 117 117 + export interface ClientOptions { 118 118 + baseUrl?: string; 119 119 + throwOnError?: boolean; 120 120 + } 121 121 + 122 122 + type MethodFn = < 123 123 + TData = unknown, 124 124 + TError = unknown, 125 125 + ThrowOnError extends boolean = false, 126 126 + >( 127 127 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>, 128 128 + ) => RequestResult<TData, TError, ThrowOnError>; 129 129 + 130 130 + type SseFn = < 131 131 + TData = unknown, 132 132 + TError = unknown, 133 133 + ThrowOnError extends boolean = false, 134 134 + >( 135 135 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'>, 136 136 + ) => Promise<ServerSentEventsResult<TData, TError>>; 137 137 + 138 138 + type RequestFn = < 139 139 + TData = unknown, 140 140 + TError = unknown, 141 141 + ThrowOnError extends boolean = false, 142 142 + >( 143 143 + options: Omit<RequestOptions<TData, ThrowOnError>, 'method'> & 144 144 + Pick<Required<RequestOptions<TData, ThrowOnError>>, 'method'>, 145 145 + ) => RequestResult<TData, TError, ThrowOnError>; 146 146 + 147 147 + type BuildUrlFn = < 148 148 + TData extends { 149 149 + body?: unknown; 150 150 + path?: Record<string, unknown>; 151 151 + query?: Record<string, unknown>; 152 152 + url: string; 153 153 + }, 154 154 + >( 155 155 + options: TData & Options<TData>, 156 156 + ) => string; 157 157 + 158 158 + export type Client = CoreClient< 159 159 + RequestFn, 160 160 + Config, 161 161 + MethodFn, 162 162 + BuildUrlFn, 163 163 + SseFn 164 164 + > & { 165 165 + interceptors: Middleware<Response, unknown, ResolvedRequestOptions>; 166 166 + }; 167 167 + 168 168 + /** 169 169 + * The `createClientConfig()` function will be called on client initialization 170 170 + * and the returned object will become the client's initial configuration. 171 171 + * 172 172 + * You may want to initialize your client this way instead of calling 173 173 + * `setConfig()`. This is useful for example if you're using Next.js 174 174 + * to ensure your client always has the correct values. 175 175 + */ 176 176 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 177 177 + override?: Config<ClientOptions & T>, 178 178 + ) => Config<Required<ClientOptions> & T>; 179 179 + 180 180 + export interface TDataShape { 181 181 + body?: unknown; 182 182 + headers?: unknown; 183 183 + path?: unknown; 184 184 + query?: unknown; 185 185 + url: string; 186 186 + } 187 187 + 188 188 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 189 189 + 190 190 + export type Options< 191 191 + TData extends TDataShape = TDataShape, 192 192 + ThrowOnError extends boolean = boolean, 193 193 + TResponse = unknown, 194 194 + > = OmitKeys< 195 195 + RequestOptions<TResponse, ThrowOnError>, 196 196 + 'body' | 'path' | 'query' | 'url' 197 197 + > & 198 198 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+438

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { getAuthToken } from '../core/auth.gen.js'; 4 4 + import type { 5 5 + QuerySerializer, 6 6 + QuerySerializerOptions, 7 7 + } from '../core/bodySerializer.gen.js'; 8 8 + import { jsonBodySerializer } from '../core/bodySerializer.gen.js'; 9 9 + import { 10 10 + serializeArrayParam, 11 11 + serializeObjectParam, 12 12 + serializePrimitiveParam, 13 13 + } from '../core/pathSerializer.gen.js'; 14 14 + import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js'; 15 15 + 16 16 + interface PathSerializer { 17 17 + path: Record<string, unknown>; 18 18 + url: string; 19 19 + } 20 20 + 21 21 + const PATH_PARAM_RE = /\{[^{}]+\}/g; 22 22 + 23 23 + type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 24 24 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 25 25 + type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 26 26 + 27 27 + const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 28 28 + let url = _url; 29 29 + const matches = _url.match(PATH_PARAM_RE); 30 30 + if (matches) { 31 31 + for (const match of matches) { 32 32 + let explode = false; 33 33 + let name = match.substring(1, match.length - 1); 34 34 + let style: ArraySeparatorStyle = 'simple'; 35 35 + 36 36 + if (name.endsWith('*')) { 37 37 + explode = true; 38 38 + name = name.substring(0, name.length - 1); 39 39 + } 40 40 + 41 41 + if (name.startsWith('.')) { 42 42 + name = name.substring(1); 43 43 + style = 'label'; 44 44 + } else if (name.startsWith(';')) { 45 45 + name = name.substring(1); 46 46 + style = 'matrix'; 47 47 + } 48 48 + 49 49 + const value = path[name]; 50 50 + 51 51 + if (value === undefined || value === null) { 52 52 + continue; 53 53 + } 54 54 + 55 55 + if (Array.isArray(value)) { 56 56 + url = url.replace( 57 57 + match, 58 58 + serializeArrayParam({ explode, name, style, value }), 59 59 + ); 60 60 + continue; 61 61 + } 62 62 + 63 63 + if (typeof value === 'object') { 64 64 + url = url.replace( 65 65 + match, 66 66 + serializeObjectParam({ 67 67 + explode, 68 68 + name, 69 69 + style, 70 70 + value: value as Record<string, unknown>, 71 71 + valueOnly: true, 72 72 + }), 73 73 + ); 74 74 + continue; 75 75 + } 76 76 + 77 77 + if (style === 'matrix') { 78 78 + url = url.replace( 79 79 + match, 80 80 + `;${serializePrimitiveParam({ 81 81 + name, 82 82 + value: value as string, 83 83 + })}`, 84 84 + ); 85 85 + continue; 86 86 + } 87 87 + 88 88 + const replaceValue = encodeURIComponent( 89 89 + style === 'label' ? `.${value as string}` : (value as string), 90 90 + ); 91 91 + url = url.replace(match, replaceValue); 92 92 + } 93 93 + } 94 94 + return url; 95 95 + }; 96 96 + 97 97 + export const createQuerySerializer = <T = unknown>({ 98 98 + parameters = {}, 99 99 + ...args 100 100 + }: QuerySerializerOptions = {}) => { 101 101 + const querySerializer = (queryParams: T) => { 102 102 + const search: string[] = []; 103 103 + if (queryParams && typeof queryParams === 'object') { 104 104 + for (const name in queryParams) { 105 105 + const value = queryParams[name]; 106 106 + 107 107 + if (value === undefined || value === null) { 108 108 + continue; 109 109 + } 110 110 + 111 111 + const options = parameters[name] || args; 112 112 + 113 113 + if (Array.isArray(value)) { 114 114 + const serializedArray = serializeArrayParam({ 115 115 + allowReserved: options.allowReserved, 116 116 + explode: true, 117 117 + name, 118 118 + style: 'form', 119 119 + value, 120 120 + ...options.array, 121 121 + }); 122 122 + if (serializedArray) search.push(serializedArray); 123 123 + } else if (typeof value === 'object') { 124 124 + const serializedObject = serializeObjectParam({ 125 125 + allowReserved: options.allowReserved, 126 126 + explode: true, 127 127 + name, 128 128 + style: 'deepObject', 129 129 + value: value as Record<string, unknown>, 130 130 + ...options.object, 131 131 + }); 132 132 + if (serializedObject) search.push(serializedObject); 133 133 + } else { 134 134 + const serializedPrimitive = serializePrimitiveParam({ 135 135 + allowReserved: options.allowReserved, 136 136 + name, 137 137 + value: value as string, 138 138 + }); 139 139 + if (serializedPrimitive) search.push(serializedPrimitive); 140 140 + } 141 141 + } 142 142 + } 143 143 + return search.join('&'); 144 144 + }; 145 145 + return querySerializer; 146 146 + }; 147 147 + 148 148 + /** 149 149 + * Infers parseAs value from provided Content-Type header. 150 150 + */ 151 151 + export const getParseAs = ( 152 152 + contentType: string | null, 153 153 + ): Exclude<Config['parseAs'], 'auto'> => { 154 154 + if (!contentType) { 155 155 + // If no Content-Type header is provided, the best we can do is return the raw response body, 156 156 + // which is effectively the same as the 'stream' option. 157 157 + return 'stream'; 158 158 + } 159 159 + 160 160 + const cleanContent = contentType.split(';')[0]?.trim(); 161 161 + 162 162 + if (!cleanContent) { 163 163 + return; 164 164 + } 165 165 + 166 166 + if ( 167 167 + cleanContent.startsWith('application/json') || 168 168 + cleanContent.endsWith('+json') 169 169 + ) { 170 170 + return 'json'; 171 171 + } 172 172 + 173 173 + if (cleanContent === 'multipart/form-data') { 174 174 + return 'formData'; 175 175 + } 176 176 + 177 177 + if ( 178 178 + ['application/', 'audio/', 'image/', 'video/'].some((type) => 179 179 + cleanContent.startsWith(type), 180 180 + ) 181 181 + ) { 182 182 + return 'blob'; 183 183 + } 184 184 + 185 185 + if (cleanContent.startsWith('text/')) { 186 186 + return 'text'; 187 187 + } 188 188 + 189 189 + return; 190 190 + }; 191 191 + 192 192 + const checkForExistence = ( 193 193 + options: Pick<RequestOptions, 'auth' | 'query'> & { 194 194 + headers: Headers; 195 195 + }, 196 196 + name?: string, 197 197 + ): boolean => { 198 198 + if (!name) { 199 199 + return false; 200 200 + } 201 201 + if ( 202 202 + options.headers.has(name) || 203 203 + options.query?.[name] || 204 204 + options.headers.get('Cookie')?.includes(`${name}=`) 205 205 + ) { 206 206 + return true; 207 207 + } 208 208 + return false; 209 209 + }; 210 210 + 211 211 + export const setAuthParams = async ({ 212 212 + security, 213 213 + ...options 214 214 + }: Pick<Required<RequestOptions>, 'security'> & 215 215 + Pick<RequestOptions, 'auth' | 'query'> & { 216 216 + headers: Headers; 217 217 + }) => { 218 218 + for (const auth of security) { 219 219 + if (checkForExistence(options, auth.name)) { 220 220 + continue; 221 221 + } 222 222 + const token = await getAuthToken(auth, options.auth); 223 223 + 224 224 + if (!token) { 225 225 + continue; 226 226 + } 227 227 + 228 228 + const name = auth.name ?? 'Authorization'; 229 229 + 230 230 + switch (auth.in) { 231 231 + case 'query': 232 232 + if (!options.query) { 233 233 + options.query = {}; 234 234 + } 235 235 + options.query[name] = token; 236 236 + break; 237 237 + case 'cookie': 238 238 + options.headers.append('Cookie', `${name}=${token}`); 239 239 + break; 240 240 + case 'header': 241 241 + default: 242 242 + options.headers.set(name, token); 243 243 + break; 244 244 + } 245 245 + } 246 246 + }; 247 247 + 248 248 + export const buildUrl: Client['buildUrl'] = (options) => { 249 249 + const url = getUrl({ 250 250 + baseUrl: options.baseUrl as string, 251 251 + path: options.path, 252 252 + query: options.query, 253 253 + querySerializer: 254 254 + typeof options.querySerializer === 'function' 255 255 + ? options.querySerializer 256 256 + : createQuerySerializer(options.querySerializer), 257 257 + url: options.url, 258 258 + }); 259 259 + return url; 260 260 + }; 261 261 + 262 262 + export const getUrl = ({ 263 263 + baseUrl, 264 264 + path, 265 265 + query, 266 266 + querySerializer, 267 267 + url: _url, 268 268 + }: { 269 269 + baseUrl?: string; 270 270 + path?: Record<string, unknown>; 271 271 + query?: Record<string, unknown>; 272 272 + querySerializer: QuerySerializer; 273 273 + url: string; 274 274 + }) => { 275 275 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 276 276 + let url = (baseUrl ?? '') + pathUrl; 277 277 + if (path) { 278 278 + url = defaultPathSerializer({ path, url }); 279 279 + } 280 280 + let search = query ? querySerializer(query) : ''; 281 281 + if (search.startsWith('?')) { 282 282 + search = search.substring(1); 283 283 + } 284 284 + if (search) { 285 285 + url += `?${search}`; 286 286 + } 287 287 + return url; 288 288 + }; 289 289 + 290 290 + export const mergeConfigs = (a: Config, b: Config): Config => { 291 291 + const config = { ...a, ...b }; 292 292 + if (config.baseUrl?.endsWith('/')) { 293 293 + config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1); 294 294 + } 295 295 + config.headers = mergeHeaders(a.headers, b.headers); 296 296 + return config; 297 297 + }; 298 298 + 299 299 + const headersEntries = (headers: Headers): Array<[string, string]> => { 300 300 + const entries: Array<[string, string]> = []; 301 301 + headers.forEach((value, key) => { 302 302 + entries.push([key, value]); 303 303 + }); 304 304 + return entries; 305 305 + }; 306 306 + 307 307 + export const mergeHeaders = ( 308 308 + ...headers: Array<Required<Config>['headers'] | undefined> 309 309 + ): Headers => { 310 310 + const mergedHeaders = new Headers(); 311 311 + for (const header of headers) { 312 312 + if (!header || typeof header !== 'object') { 313 313 + continue; 314 314 + } 315 315 + 316 316 + const iterator = 317 317 + header instanceof Headers 318 318 + ? headersEntries(header) 319 319 + : Object.entries(header); 320 320 + 321 321 + for (const [key, value] of iterator) { 322 322 + if (value === null) { 323 323 + mergedHeaders.delete(key); 324 324 + } else if (Array.isArray(value)) { 325 325 + for (const v of value) { 326 326 + mergedHeaders.append(key, v as string); 327 327 + } 328 328 + } else if (value !== undefined) { 329 329 + // assume object headers are meant to be JSON stringified, i.e. their 330 330 + // content value in OpenAPI specification is 'application/json' 331 331 + mergedHeaders.set( 332 332 + key, 333 333 + typeof value === 'object' ? JSON.stringify(value) : (value as string), 334 334 + ); 335 335 + } 336 336 + } 337 337 + } 338 338 + return mergedHeaders; 339 339 + }; 340 340 + 341 341 + type ErrInterceptor<Err, Res, Options> = ( 342 342 + error: Err, 343 343 + response: Res, 344 344 + options: Options, 345 345 + ) => Err | Promise<Err>; 346 346 + 347 347 + type ReqInterceptor<Options> = (options: Options) => void | Promise<void>; 348 348 + 349 349 + type ResInterceptor<Res, Options> = ( 350 350 + response: Res, 351 351 + options: Options, 352 352 + ) => Res | Promise<Res>; 353 353 + 354 354 + class Interceptors<Interceptor> { 355 355 + fns: Array<Interceptor | null> = []; 356 356 + 357 357 + clear(): void { 358 358 + this.fns = []; 359 359 + } 360 360 + 361 361 + eject(id: number | Interceptor): void { 362 362 + const index = this.getInterceptorIndex(id); 363 363 + if (this.fns[index]) { 364 364 + this.fns[index] = null; 365 365 + } 366 366 + } 367 367 + 368 368 + exists(id: number | Interceptor): boolean { 369 369 + const index = this.getInterceptorIndex(id); 370 370 + return Boolean(this.fns[index]); 371 371 + } 372 372 + 373 373 + getInterceptorIndex(id: number | Interceptor): number { 374 374 + if (typeof id === 'number') { 375 375 + return this.fns[id] ? id : -1; 376 376 + } 377 377 + return this.fns.indexOf(id); 378 378 + } 379 379 + 380 380 + update( 381 381 + id: number | Interceptor, 382 382 + fn: Interceptor, 383 383 + ): number | Interceptor | false { 384 384 + const index = this.getInterceptorIndex(id); 385 385 + if (this.fns[index]) { 386 386 + this.fns[index] = fn; 387 387 + return id; 388 388 + } 389 389 + return false; 390 390 + } 391 391 + 392 392 + use(fn: Interceptor): number { 393 393 + this.fns.push(fn); 394 394 + return this.fns.length - 1; 395 395 + } 396 396 + } 397 397 + 398 398 + export interface Middleware<Res, Err, Options> { 399 399 + error: Interceptors<ErrInterceptor<Err, Res, Options>>; 400 400 + request: Interceptors<ReqInterceptor<Options>>; 401 401 + response: Interceptors<ResInterceptor<Res, Options>>; 402 402 + } 403 403 + 404 404 + export const createInterceptors = <Res, Err, Options>(): Middleware< 405 405 + Res, 406 406 + Err, 407 407 + Options 408 408 + > => ({ 409 409 + error: new Interceptors<ErrInterceptor<Err, Res, Options>>(), 410 410 + request: new Interceptors<ReqInterceptor<Options>>(), 411 411 + response: new Interceptors<ResInterceptor<Res, Options>>(), 412 412 + }); 413 413 + 414 414 + const defaultQuerySerializer = createQuerySerializer({ 415 415 + allowReserved: false, 416 416 + array: { 417 417 + explode: true, 418 418 + style: 'form', 419 419 + }, 420 420 + object: { 421 421 + explode: true, 422 422 + style: 'deepObject', 423 423 + }, 424 424 + }); 425 425 + 426 426 + const defaultHeaders = { 427 427 + 'Content-Type': 'application/json', 428 428 + }; 429 429 + 430 430 + export const createConfig = <T extends ClientOptions = ClientOptions>( 431 431 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 432 432 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 433 433 + ...jsonBodySerializer, 434 434 + headers: defaultHeaders, 435 435 + parseAs: 'auto', 436 436 + querySerializer: defaultQuerySerializer, 437 437 + ...override, 438 438 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options?.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options?.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-next/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseUrl: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseURL: 'http://localhost:3000/base' }));

+229

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { 4 4 + useAsyncData, 5 5 + useFetch, 6 6 + useLazyAsyncData, 7 7 + useLazyFetch, 8 8 + } from 'nuxt/app'; 9 9 + import { reactive, ref, watch } from 'vue'; 10 10 + 11 11 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 12 12 + import type { HttpMethod } from '../core/types.gen.js'; 13 13 + import type { Client, Config, RequestOptions } from './types.gen.js'; 14 14 + import { 15 15 + buildUrl, 16 16 + createConfig, 17 17 + executeFetchFn, 18 18 + mergeConfigs, 19 19 + mergeHeaders, 20 20 + mergeInterceptors, 21 21 + serializeBody, 22 22 + setAuthParams, 23 23 + unwrapRefs, 24 24 + } from './utils.gen.js'; 25 25 + 26 26 + export const createClient = (config: Config = {}): Client => { 27 27 + let _config = mergeConfigs(createConfig(), config); 28 28 + 29 29 + const getConfig = (): Config => ({ ..._config }); 30 30 + 31 31 + const setConfig = (config: Config): Config => { 32 32 + _config = mergeConfigs(_config, config); 33 33 + return getConfig(); 34 34 + }; 35 35 + 36 36 + const beforeRequest = async (options: RequestOptions) => { 37 37 + const opts = { 38 38 + ..._config, 39 39 + ...options, 40 40 + $fetch: options.$fetch ?? _config.$fetch ?? $fetch, 41 41 + headers: mergeHeaders(_config.headers, options.headers), 42 42 + onRequest: mergeInterceptors(_config.onRequest, options.onRequest), 43 43 + onResponse: mergeInterceptors(_config.onResponse, options.onResponse), 44 44 + }; 45 45 + 46 46 + if (opts.security) { 47 47 + await setAuthParams({ 48 48 + ...opts, 49 49 + security: opts.security, 50 50 + }); 51 51 + } 52 52 + 53 53 + if (opts.requestValidator) { 54 54 + await opts.requestValidator(opts); 55 55 + } 56 56 + 57 57 + const url = buildUrl(opts); 58 58 + 59 59 + return { opts, url }; 60 60 + }; 61 61 + 62 62 + const request: Client['request'] = ({ 63 63 + asyncDataOptions, 64 64 + composable = '$fetch', 65 65 + ...options 66 66 + }) => { 67 67 + const key = options.key; 68 68 + const opts = { 69 69 + ..._config, 70 70 + ...options, 71 71 + $fetch: options.$fetch ?? _config.$fetch ?? $fetch, 72 72 + headers: mergeHeaders(_config.headers, options.headers), 73 73 + onRequest: mergeInterceptors(_config.onRequest, options.onRequest), 74 74 + onResponse: mergeInterceptors(_config.onResponse, options.onResponse), 75 75 + }; 76 76 + 77 77 + const { 78 78 + requestValidator, 79 79 + responseTransformer, 80 80 + responseValidator, 81 81 + security, 82 82 + } = opts; 83 83 + if (requestValidator || security) { 84 84 + // auth must happen in interceptors otherwise we'd need to require 85 85 + // asyncContext enabled 86 86 + // https://nuxt.com/docs/guide/going-further/experimental-features#asynccontext 87 87 + opts.onRequest = [ 88 88 + async ({ options }) => { 89 89 + if (security) { 90 90 + await setAuthParams({ 91 91 + auth: opts.auth, 92 92 + headers: options.headers, 93 93 + query: options.query, 94 94 + security, 95 95 + }); 96 96 + } 97 97 + 98 98 + if (requestValidator) { 99 99 + await requestValidator({ 100 100 + ...options, 101 101 + // @ts-expect-error 102 102 + body: options.rawBody, 103 103 + }); 104 104 + } 105 105 + }, 106 106 + ...opts.onRequest, 107 107 + ]; 108 108 + } 109 109 + 110 110 + if (responseTransformer || responseValidator) { 111 111 + opts.onResponse = [ 112 112 + ...opts.onResponse, 113 113 + async ({ options, response }) => { 114 114 + if (options.responseType && options.responseType !== 'json') { 115 115 + return; 116 116 + } 117 117 + 118 118 + if (!response.ok) { 119 119 + return; 120 120 + } 121 121 + 122 122 + if (responseValidator) { 123 123 + await responseValidator(response._data); 124 124 + } 125 125 + 126 126 + if (responseTransformer) { 127 127 + response._data = await responseTransformer(response._data); 128 128 + } 129 129 + }, 130 130 + ]; 131 131 + } 132 132 + 133 133 + // remove Content-Type header if body is empty to avoid sending invalid requests 134 134 + if (opts.body === undefined || opts.body === '') { 135 135 + opts.headers.delete('Content-Type'); 136 136 + } 137 137 + 138 138 + const fetchFn = opts.$fetch; 139 139 + 140 140 + if (composable === '$fetch') { 141 141 + return executeFetchFn( 142 142 + // @ts-expect-error 143 143 + opts, 144 144 + fetchFn, 145 145 + ); 146 146 + } 147 147 + 148 148 + if (composable === 'useFetch' || composable === 'useLazyFetch') { 149 149 + opts.rawBody = opts.body; 150 150 + const bodyParams = reactive({ 151 151 + body: opts.body, 152 152 + bodySerializer: opts.bodySerializer, 153 153 + }); 154 154 + const body = ref(serializeBody(opts)); 155 155 + opts.body = body; 156 156 + watch(bodyParams, (changed) => { 157 157 + body.value = serializeBody(changed); 158 158 + }); 159 159 + return composable === 'useLazyFetch' 160 160 + ? useLazyFetch(() => buildUrl(opts), opts) 161 161 + : useFetch(() => buildUrl(opts), opts); 162 162 + } 163 163 + 164 164 + const handler: any = () => 165 165 + executeFetchFn( 166 166 + // @ts-expect-error 167 167 + opts, 168 168 + fetchFn, 169 169 + ); 170 170 + 171 171 + if (composable === 'useAsyncData') { 172 172 + return key 173 173 + ? useAsyncData(key, handler, asyncDataOptions) 174 174 + : useAsyncData(handler, asyncDataOptions); 175 175 + } 176 176 + 177 177 + if (composable === 'useLazyAsyncData') { 178 178 + return key 179 179 + ? useLazyAsyncData(key, handler, asyncDataOptions) 180 180 + : useLazyAsyncData(handler, asyncDataOptions); 181 181 + } 182 182 + 183 183 + return undefined as any; 184 184 + }; 185 185 + 186 186 + const makeMethodFn = 187 187 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 188 188 + request({ ...options, method }); 189 189 + 190 190 + const makeSseFn = 191 191 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 192 192 + const { opts, url } = await beforeRequest(options); 193 193 + return createSseClient({ 194 194 + ...unwrapRefs(opts), 195 195 + body: opts.body as BodyInit | null | undefined, 196 196 + method, 197 197 + onRequest: undefined, 198 198 + signal: unwrapRefs(opts.signal) as AbortSignal, 199 199 + url, 200 200 + }); 201 201 + }; 202 202 + 203 203 + return { 204 204 + buildUrl, 205 205 + connect: makeMethodFn('CONNECT'), 206 206 + delete: makeMethodFn('DELETE'), 207 207 + get: makeMethodFn('GET'), 208 208 + getConfig, 209 209 + head: makeMethodFn('HEAD'), 210 210 + options: makeMethodFn('OPTIONS'), 211 211 + patch: makeMethodFn('PATCH'), 212 212 + post: makeMethodFn('POST'), 213 213 + put: makeMethodFn('PUT'), 214 214 + request, 215 215 + setConfig, 216 216 + sse: { 217 217 + connect: makeSseFn('CONNECT'), 218 218 + delete: makeSseFn('DELETE'), 219 219 + get: makeSseFn('GET'), 220 220 + head: makeSseFn('HEAD'), 221 221 + options: makeSseFn('OPTIONS'), 222 222 + patch: makeSseFn('PATCH'), 223 223 + post: makeSseFn('POST'), 224 224 + put: makeSseFn('PUT'), 225 225 + trace: makeSseFn('TRACE'), 226 226 + }, 227 227 + trace: makeMethodFn('TRACE'), 228 228 + } as Client; 229 229 + };

+24

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Composable, 17 17 + Config, 18 18 + CreateClientConfig, 19 19 + Options, 20 20 + RequestOptions, 21 21 + RequestResult, 22 22 + TDataShape, 23 23 + } from './types.gen.js'; 24 24 + export { createConfig } from './utils.gen.js';

+204

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + AsyncDataOptions, 5 5 + useAsyncData, 6 6 + useFetch, 7 7 + UseFetchOptions, 8 8 + useLazyAsyncData, 9 9 + useLazyFetch, 10 10 + } from 'nuxt/app'; 11 11 + import type { Ref } from 'vue'; 12 12 + 13 13 + import type { Auth } from '../core/auth.gen.js'; 14 14 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 15 15 + import type { 16 16 + ServerSentEventsOptions, 17 17 + ServerSentEventsResult, 18 18 + } from '../core/serverSentEvents.gen.js'; 19 19 + import type { 20 20 + Client as CoreClient, 21 21 + Config as CoreConfig, 22 22 + } from '../core/types.gen.js'; 23 23 + 24 24 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 25 25 + type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 26 26 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 27 27 + export type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 28 28 + type ObjectStyle = 'form' | 'deepObject'; 29 29 + 30 30 + export type QuerySerializer = ( 31 31 + query: Parameters<Client['buildUrl']>[0]['query'], 32 32 + ) => string; 33 33 + 34 34 + type WithRefs<TData> = { 35 35 + [K in keyof TData]: NonNullable<TData[K]> extends object 36 36 + ? WithRefs<NonNullable<TData[K]>> | Ref<NonNullable<TData[K]>> 37 37 + : NonNullable<TData[K]> | Ref<NonNullable<TData[K]>>; 38 38 + }; 39 39 + 40 40 + // copied from Nuxt 41 41 + export type KeysOf<T> = Array< 42 42 + T extends T ? (keyof T extends string ? keyof T : never) : never 43 43 + >; 44 44 + 45 45 + export interface Config<T extends ClientOptions = ClientOptions> 46 46 + extends Omit< 47 47 + FetchOptions<unknown>, 48 48 + 'baseURL' | 'body' | 'headers' | 'method' | 'query' 49 49 + >, 50 50 + WithRefs<Pick<FetchOptions<unknown>, 'query'>>, 51 51 + Omit<CoreConfig, 'querySerializer'> { 52 52 + /** 53 53 + * Base URL for all requests made by this client. 54 54 + */ 55 55 + baseURL?: T['baseURL']; 56 56 + /** 57 57 + * A function for serializing request query parameters. By default, arrays 58 58 + * will be exploded in form style, objects will be exploded in deepObject 59 59 + * style, and reserved characters are percent-encoded. 60 60 + * 61 61 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 62 62 + */ 63 63 + querySerializer?: QuerySerializer | QuerySerializerOptions; 64 64 + } 65 65 + 66 66 + export interface RequestOptions< 67 67 + TComposable extends Composable = '$fetch', 68 68 + ResT = unknown, 69 69 + DefaultT = undefined, 70 70 + Url extends string = string, 71 71 + > extends Config, 72 72 + WithRefs<{ 73 73 + /** 74 74 + * Any body that you want to add to your request. 75 75 + * 76 76 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 77 77 + */ 78 78 + body?: unknown; 79 79 + path?: FetchOptions<unknown>['query']; 80 80 + query?: FetchOptions<unknown>['query']; 81 81 + rawBody?: unknown; 82 82 + }>, 83 83 + Pick< 84 84 + ServerSentEventsOptions<ResT>, 85 85 + | 'onSseError' 86 86 + | 'onSseEvent' 87 87 + | 'sseDefaultRetryDelay' 88 88 + | 'sseMaxRetryAttempts' 89 89 + | 'sseMaxRetryDelay' 90 90 + > { 91 91 + asyncDataOptions?: AsyncDataOptions<ResT, ResT, KeysOf<ResT>, DefaultT>; 92 92 + composable?: TComposable; 93 93 + key?: string; 94 94 + /** 95 95 + * Security mechanism(s) to use for the request. 96 96 + */ 97 97 + security?: ReadonlyArray<Auth>; 98 98 + url: Url; 99 99 + } 100 100 + 101 101 + export type RequestResult< 102 102 + TComposable extends Composable, 103 103 + ResT, 104 104 + TError, 105 105 + > = TComposable extends '$fetch' 106 106 + ? ReturnType<typeof $fetch<ResT>> 107 107 + : TComposable extends 'useAsyncData' 108 108 + ? ReturnType<typeof useAsyncData<ResT | null, TError>> 109 109 + : TComposable extends 'useFetch' 110 110 + ? ReturnType<typeof useFetch<ResT | null, TError>> 111 111 + : TComposable extends 'useLazyAsyncData' 112 112 + ? ReturnType<typeof useLazyAsyncData<ResT | null, TError>> 113 113 + : TComposable extends 'useLazyFetch' 114 114 + ? ReturnType<typeof useLazyFetch<ResT | null, TError>> 115 115 + : never; 116 116 + 117 117 + export interface ClientOptions { 118 118 + baseURL?: string; 119 119 + } 120 120 + 121 121 + type MethodFn = < 122 122 + TComposable extends Composable = '$fetch', 123 123 + ResT = unknown, 124 124 + TError = unknown, 125 125 + DefaultT = undefined, 126 126 + >( 127 127 + options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>, 128 128 + ) => RequestResult<TComposable, ResT, TError>; 129 129 + 130 130 + type SseFn = < 131 131 + TComposable extends Composable = '$fetch', 132 132 + ResT = unknown, 133 133 + TError = unknown, 134 134 + DefaultT = undefined, 135 135 + >( 136 136 + options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'>, 137 137 + ) => Promise<ServerSentEventsResult<RequestResult<TComposable, ResT, TError>>>; 138 138 + 139 139 + type RequestFn = < 140 140 + TComposable extends Composable = '$fetch', 141 141 + ResT = unknown, 142 142 + TError = unknown, 143 143 + DefaultT = undefined, 144 144 + >( 145 145 + options: Omit<RequestOptions<TComposable, ResT, DefaultT>, 'method'> & 146 146 + Pick<Required<RequestOptions<TComposable, ResT, DefaultT>>, 'method'>, 147 147 + ) => RequestResult<TComposable, ResT, TError>; 148 148 + 149 149 + /** 150 150 + * The `createClientConfig()` function will be called on client initialization 151 151 + * and the returned object will become the client's initial configuration. 152 152 + * 153 153 + * You may want to initialize your client this way instead of calling 154 154 + * `setConfig()`. This is useful for example if you're using Next.js 155 155 + * to ensure your client always has the correct values. 156 156 + */ 157 157 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 158 158 + override?: Config<ClientOptions & T>, 159 159 + ) => Config<Required<ClientOptions> & T>; 160 160 + 161 161 + export interface TDataShape { 162 162 + body?: unknown; 163 163 + headers?: unknown; 164 164 + path?: FetchOptions<unknown>['query']; 165 165 + query?: FetchOptions<unknown>['query']; 166 166 + url: string; 167 167 + } 168 168 + 169 169 + export type BuildUrlOptions< 170 170 + TData extends Omit<TDataShape, 'headers'> = Omit<TDataShape, 'headers'>, 171 171 + > = Pick<WithRefs<TData>, 'path' | 'query'> & 172 172 + Pick<TData, 'url'> & 173 173 + Pick<Options<'$fetch', TData>, 'baseURL' | 'querySerializer'>; 174 174 + 175 175 + type BuildUrlFn = <TData extends Omit<TDataShape, 'headers'>>( 176 176 + options: BuildUrlOptions<TData>, 177 177 + ) => string; 178 178 + 179 179 + export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn>; 180 180 + 181 181 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 182 182 + 183 183 + export type Options< 184 184 + TComposable extends Composable = '$fetch', 185 185 + TData extends TDataShape = TDataShape, 186 186 + ResT = unknown, 187 187 + DefaultT = undefined, 188 188 + > = OmitKeys< 189 189 + RequestOptions<TComposable, ResT, DefaultT>, 190 190 + 'body' | 'path' | 'query' | 'url' 191 191 + > & 192 192 + ([TData] extends [never] ? unknown : WithRefs<Omit<TData, 'url'>>); 193 193 + 194 194 + type FetchOptions<TData> = Omit< 195 195 + UseFetchOptions<TData, TData>, 196 196 + keyof AsyncDataOptions<TData> 197 197 + >; 198 198 + 199 199 + export type Composable = 200 200 + | '$fetch' 201 201 + | 'useAsyncData' 202 202 + | 'useFetch' 203 203 + | 'useLazyAsyncData' 204 204 + | 'useLazyFetch';

+398

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { ComputedRef, Ref } from 'vue'; 4 4 + import { isRef, toValue, unref } from 'vue'; 5 5 + 6 6 + import { getAuthToken } from '../core/auth.gen.js'; 7 7 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 8 8 + import { jsonBodySerializer } from '../core/bodySerializer.gen.js'; 9 9 + import { 10 10 + serializeArrayParam, 11 11 + serializeObjectParam, 12 12 + serializePrimitiveParam, 13 13 + } from '../core/pathSerializer.gen.js'; 14 14 + import type { 15 15 + ArraySeparatorStyle, 16 16 + BuildUrlOptions, 17 17 + Client, 18 18 + ClientOptions, 19 19 + Config, 20 20 + QuerySerializer, 21 21 + RequestOptions, 22 22 + } from './types.gen.js'; 23 23 + 24 24 + type PathSerializer = Pick<Required<BuildUrlOptions>, 'path' | 'url'>; 25 25 + 26 26 + const PATH_PARAM_RE = /\{[^{}]+\}/g; 27 27 + 28 28 + type MaybeArray<T> = T | T[]; 29 29 + 30 30 + const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 31 31 + let url = _url; 32 32 + const matches = _url.match(PATH_PARAM_RE); 33 33 + if (matches) { 34 34 + for (const match of matches) { 35 35 + let explode = false; 36 36 + let name = match.substring(1, match.length - 1); 37 37 + let style: ArraySeparatorStyle = 'simple'; 38 38 + 39 39 + if (name.endsWith('*')) { 40 40 + explode = true; 41 41 + name = name.substring(0, name.length - 1); 42 42 + } 43 43 + 44 44 + if (name.startsWith('.')) { 45 45 + name = name.substring(1); 46 46 + style = 'label'; 47 47 + } else if (name.startsWith(';')) { 48 48 + name = name.substring(1); 49 49 + style = 'matrix'; 50 50 + } 51 51 + 52 52 + const value = toValue( 53 53 + (toValue(path) as Record<string, unknown> | undefined)?.[name], 54 54 + ); 55 55 + 56 56 + if (value === undefined || value === null) { 57 57 + continue; 58 58 + } 59 59 + 60 60 + if (Array.isArray(value)) { 61 61 + url = url.replace( 62 62 + match, 63 63 + serializeArrayParam({ explode, name, style, value }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (typeof value === 'object') { 69 69 + url = url.replace( 70 70 + match, 71 71 + serializeObjectParam({ 72 72 + explode, 73 73 + name, 74 74 + style, 75 75 + value: value as Record<string, unknown>, 76 76 + valueOnly: true, 77 77 + }), 78 78 + ); 79 79 + continue; 80 80 + } 81 81 + 82 82 + if (style === 'matrix') { 83 83 + url = url.replace( 84 84 + match, 85 85 + `;${serializePrimitiveParam({ 86 86 + name, 87 87 + value: value as string, 88 88 + })}`, 89 89 + ); 90 90 + continue; 91 91 + } 92 92 + 93 93 + const replaceValue = encodeURIComponent( 94 94 + style === 'label' ? `.${value as string}` : (value as string), 95 95 + ); 96 96 + url = url.replace(match, replaceValue); 97 97 + } 98 98 + } 99 99 + return url; 100 100 + }; 101 101 + 102 102 + export const createQuerySerializer = <T = unknown>({ 103 103 + parameters = {}, 104 104 + ...args 105 105 + }: QuerySerializerOptions = {}) => { 106 106 + const querySerializer = (queryParams: T) => { 107 107 + const search: string[] = []; 108 108 + const qParams = toValue(queryParams); 109 109 + if (qParams && typeof qParams === 'object') { 110 110 + for (const name in qParams) { 111 111 + const value = toValue(qParams[name]); 112 112 + 113 113 + if (value === undefined || value === null) { 114 114 + continue; 115 115 + } 116 116 + 117 117 + const options = parameters[name] || args; 118 118 + 119 119 + if (Array.isArray(value)) { 120 120 + const serializedArray = serializeArrayParam({ 121 121 + allowReserved: options.allowReserved, 122 122 + explode: true, 123 123 + name, 124 124 + style: 'form', 125 125 + value, 126 126 + ...options.array, 127 127 + }); 128 128 + if (serializedArray) search.push(serializedArray); 129 129 + } else if (typeof value === 'object') { 130 130 + const serializedObject = serializeObjectParam({ 131 131 + allowReserved: options.allowReserved, 132 132 + explode: true, 133 133 + name, 134 134 + style: 'deepObject', 135 135 + value: value as Record<string, unknown>, 136 136 + ...options.object, 137 137 + }); 138 138 + if (serializedObject) search.push(serializedObject); 139 139 + } else { 140 140 + const serializedPrimitive = serializePrimitiveParam({ 141 141 + allowReserved: options.allowReserved, 142 142 + name, 143 143 + value: value as string, 144 144 + }); 145 145 + if (serializedPrimitive) search.push(serializedPrimitive); 146 146 + } 147 147 + } 148 148 + } 149 149 + return search.join('&'); 150 150 + }; 151 151 + return querySerializer; 152 152 + }; 153 153 + 154 154 + const checkForExistence = ( 155 155 + options: Pick<RequestOptions, 'auth' | 'query'> & { 156 156 + headers: Headers; 157 157 + }, 158 158 + name?: string, 159 159 + ): boolean => { 160 160 + if (!name) { 161 161 + return false; 162 162 + } 163 163 + if ( 164 164 + options.headers.has(name) || 165 165 + (toValue(options.query) as Record<string, unknown> | undefined)?.[name] || 166 166 + options.headers.get('Cookie')?.includes(`${name}=`) 167 167 + ) { 168 168 + return true; 169 169 + } 170 170 + return false; 171 171 + }; 172 172 + 173 173 + export const setAuthParams = async ({ 174 174 + security, 175 175 + ...options 176 176 + }: Pick<Required<RequestOptions>, 'security'> & 177 177 + Pick<RequestOptions, 'auth' | 'query'> & { 178 178 + headers: Headers; 179 179 + }) => { 180 180 + for (const auth of security) { 181 181 + if (checkForExistence(options, auth.name)) { 182 182 + continue; 183 183 + } 184 184 + const token = await getAuthToken(auth, options.auth); 185 185 + 186 186 + if (!token) { 187 187 + continue; 188 188 + } 189 189 + 190 190 + const name = auth.name ?? 'Authorization'; 191 191 + 192 192 + switch (auth.in) { 193 193 + case 'query': { 194 194 + if (!options.query) { 195 195 + options.query = {}; 196 196 + } 197 197 + const queryValue = toValue(options.query) as 198 198 + | Record<string, unknown> 199 199 + | undefined; 200 200 + if (queryValue) { 201 201 + queryValue[name] = token; 202 202 + } 203 203 + break; 204 204 + } 205 205 + case 'cookie': 206 206 + options.headers.append('Cookie', `${name}=${token}`); 207 207 + break; 208 208 + case 'header': 209 209 + default: 210 210 + options.headers.set(name, token); 211 211 + break; 212 212 + } 213 213 + } 214 214 + }; 215 215 + 216 216 + export const buildUrl: Client['buildUrl'] = (options) => { 217 217 + const url = getUrl({ 218 218 + baseUrl: options.baseURL as string, 219 219 + path: options.path, 220 220 + query: options.query, 221 221 + querySerializer: 222 222 + typeof options.querySerializer === 'function' 223 223 + ? options.querySerializer 224 224 + : createQuerySerializer(options.querySerializer), 225 225 + url: options.url, 226 226 + }); 227 227 + return url; 228 228 + }; 229 229 + 230 230 + export const getUrl = ({ 231 231 + baseUrl, 232 232 + path, 233 233 + query, 234 234 + querySerializer, 235 235 + url: _url, 236 236 + }: Pick<BuildUrlOptions, 'path' | 'query' | 'url'> & { 237 237 + baseUrl?: string; 238 238 + querySerializer: QuerySerializer; 239 239 + }) => { 240 240 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 241 241 + let url = (baseUrl ?? '') + pathUrl; 242 242 + if (path) { 243 243 + url = defaultPathSerializer({ path, url }); 244 244 + } 245 245 + let search = query ? querySerializer(query) : ''; 246 246 + if (search.startsWith('?')) { 247 247 + search = search.substring(1); 248 248 + } 249 249 + if (search) { 250 250 + url += `?${search}`; 251 251 + } 252 252 + return url; 253 253 + }; 254 254 + 255 255 + export const mergeConfigs = (a: Config, b: Config): Config => { 256 256 + const config = { ...a, ...b }; 257 257 + if (config.baseURL?.endsWith('/')) { 258 258 + config.baseURL = config.baseURL.substring(0, config.baseURL.length - 1); 259 259 + } 260 260 + config.headers = mergeHeaders(a.headers, b.headers); 261 261 + return config; 262 262 + }; 263 263 + 264 264 + const headersEntries = (headers: Headers): Array<[string, string]> => { 265 265 + const entries: Array<[string, string]> = []; 266 266 + headers.forEach((value, key) => { 267 267 + entries.push([key, value]); 268 268 + }); 269 269 + return entries; 270 270 + }; 271 271 + 272 272 + export const mergeHeaders = ( 273 273 + ...headers: Array<Required<Config>['headers'] | undefined> 274 274 + ): Headers => { 275 275 + const mergedHeaders = new Headers(); 276 276 + for (const header of headers) { 277 277 + if (!header || typeof header !== 'object') { 278 278 + continue; 279 279 + } 280 280 + 281 281 + let h: unknown = header; 282 282 + if (isRef(h)) { 283 283 + h = unref(h); 284 284 + } 285 285 + 286 286 + const iterator = 287 287 + h instanceof Headers 288 288 + ? headersEntries(h) 289 289 + : Object.entries(h as Record<string, unknown>); 290 290 + 291 291 + for (const [key, value] of iterator) { 292 292 + if (value === null) { 293 293 + mergedHeaders.delete(key); 294 294 + } else if (Array.isArray(value)) { 295 295 + for (const v of value) { 296 296 + mergedHeaders.append(key, unwrapRefs(v) as string); 297 297 + } 298 298 + } else if (value !== undefined) { 299 299 + const v = unwrapRefs(value); 300 300 + // assume object headers are meant to be JSON stringified, i.e. their 301 301 + // content value in OpenAPI specification is 'application/json' 302 302 + mergedHeaders.set( 303 303 + key, 304 304 + typeof v === 'object' ? JSON.stringify(v) : (v as string), 305 305 + ); 306 306 + } 307 307 + } 308 308 + } 309 309 + return mergedHeaders; 310 310 + }; 311 311 + 312 312 + export const mergeInterceptors = <T>(...args: Array<MaybeArray<T>>): Array<T> => 313 313 + args.reduce<Array<T>>((acc, item) => { 314 314 + if (typeof item === 'function') { 315 315 + acc.push(item); 316 316 + } else if (Array.isArray(item)) { 317 317 + return acc.concat(item); 318 318 + } 319 319 + return acc; 320 320 + }, []); 321 321 + 322 322 + const defaultQuerySerializer = createQuerySerializer({ 323 323 + allowReserved: false, 324 324 + array: { 325 325 + explode: true, 326 326 + style: 'form', 327 327 + }, 328 328 + object: { 329 329 + explode: true, 330 330 + style: 'deepObject', 331 331 + }, 332 332 + }); 333 333 + 334 334 + const defaultHeaders = { 335 335 + 'Content-Type': 'application/json', 336 336 + }; 337 337 + 338 338 + export const createConfig = <T extends ClientOptions = ClientOptions>( 339 339 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 340 340 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 341 341 + ...jsonBodySerializer, 342 342 + headers: defaultHeaders, 343 343 + querySerializer: defaultQuerySerializer, 344 344 + ...override, 345 345 + }); 346 346 + 347 347 + type UnwrapRefs<T> = 348 348 + T extends Ref<infer V> 349 349 + ? V 350 350 + : T extends ComputedRef<infer V> 351 351 + ? V 352 352 + : T extends Record<string, unknown> // this doesn't handle functions well 353 353 + ? { [K in keyof T]: UnwrapRefs<T[K]> } 354 354 + : T; 355 355 + 356 356 + export const unwrapRefs = <T>(value: T): UnwrapRefs<T> => { 357 357 + if (value === null || typeof value !== 'object' || value instanceof Headers) { 358 358 + return (isRef(value) ? unref(value) : value) as UnwrapRefs<T>; 359 359 + } 360 360 + 361 361 + if (Array.isArray(value)) { 362 362 + return value.map((item) => unwrapRefs(item)) as UnwrapRefs<T>; 363 363 + } 364 364 + 365 365 + if (isRef(value)) { 366 366 + return unwrapRefs(unref(value) as T); 367 367 + } 368 368 + 369 369 + // unwrap into new object to avoid modifying the source 370 370 + const result: Record<string, unknown> = {}; 371 371 + for (const key in value) { 372 372 + result[key] = unwrapRefs(value[key] as T); 373 373 + } 374 374 + return result as UnwrapRefs<T>; 375 375 + }; 376 376 + 377 377 + export const serializeBody = ( 378 378 + opts: Pick<Parameters<Client['request']>[0], 'body' | 'bodySerializer'>, 379 379 + ) => { 380 380 + if (opts.body && opts.bodySerializer) { 381 381 + return opts.bodySerializer(opts.body); 382 382 + } 383 383 + return opts.body; 384 384 + }; 385 385 + 386 386 + export const executeFetchFn = ( 387 387 + opts: Omit<Parameters<Client['request']>[0], 'composable'>, 388 388 + fetchFn: Required<Config>['$fetch'], 389 389 + ) => { 390 390 + const unwrappedOpts = unwrapRefs(opts); 391 391 + unwrappedOpts.rawBody = unwrappedOpts.body; 392 392 + unwrappedOpts.body = serializeBody(unwrappedOpts); 393 393 + return fetchFn( 394 394 + buildUrl(opts), 395 395 + // @ts-expect-error 396 396 + unwrappedOpts, 397 397 + ); 398 398 + };

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, type Composable, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesResponse, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseData, CallWithResponseResponse, CallWithResponsesData, CallWithResponsesError, CallWithResponsesResponse, CallWithResultFromHeaderData, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponse, ComplexTypesData, ComplexTypesResponse, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponse, DummyBData, DummyBResponse, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponse, FooWowData, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationResponse, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponse, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TypesData, TypesResponse, UploadFileData, UploadFileResponse } from './types.gen.js'; 6 6 + 7 7 + export type Options<TComposable extends Composable = '$fetch', TData extends TDataShape = TDataShape, ResT = unknown, DefaultT = undefined> = Options2<TComposable, TData, ResT, DefaultT> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, ExportData, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PatchApiVbyApiVersionNoTagData, unknown, DefaultT>) => (options.client ?? client).patch<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <TComposable extends Composable = '$fetch', DefaultT extends ImportResponse = ImportResponse>(options: Options<TComposable, ImportData, ImportResponse, DefaultT>) => (options.client ?? client).post<TComposable, ImportResponse | DefaultT, unknown, DefaultT>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, FooWowData, unknown, DefaultT>) => (options.client ?? client).put<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <TComposable extends Composable = '$fetch', DefaultT extends ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponse>(options: Options<TComposable, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, DefaultT>) => (options.client ?? client).get<TComposable, ApiVVersionODataControllerCountResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <TComposable extends Composable = '$fetch', DefaultT extends GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponse>(options: Options<TComposable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationResponse, DefaultT>) => (options.client ?? client).get<TComposable, GetApiVbyApiVersionSimpleOperationResponse | DefaultT, GetApiVbyApiVersionSimpleOperationError, DefaultT>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DeleteCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).delete<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, GetCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, HeadCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).head<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, OptionsCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).options<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PatchCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).patch<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PostCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PutCallWithoutParametersAndResponseData, unknown, DefaultT>) => (options.client ?? client).put<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DeleteFooData3, unknown, DefaultT>) => (options.client ?? client).delete<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithDescriptionsData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DeprecatedCallData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithParametersData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithWeirdParameterNamesData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, GetCallWithOptionalParamData, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <TComposable extends Composable = '$fetch', DefaultT extends PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponse>(options: Options<TComposable, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, DefaultT>) => (options.client ?? client).post<TComposable, PostCallWithOptionalParamResponse | DefaultT, unknown, DefaultT>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PostApiVbyApiVersionRequestBodyData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PostApiVbyApiVersionFormDataData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithDefaultParametersData, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithDefaultOptionalParametersData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallToTestOrderOfParamsData, unknown, DefaultT>) => (options.client ?? client).put<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DuplicateNameData, unknown, DefaultT>) => (options.client ?? client).delete<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DuplicateName2Data, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DuplicateName3Data, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, DuplicateName4Data, unknown, DefaultT>) => (options.client ?? client).put<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <TComposable extends Composable = '$fetch', DefaultT extends CallWithNoContentResponseResponse = CallWithNoContentResponseResponse>(options: Options<TComposable, CallWithNoContentResponseData, CallWithNoContentResponseResponse, DefaultT>) => (options.client ?? client).get<TComposable, CallWithNoContentResponseResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <TComposable extends Composable = '$fetch', DefaultT extends CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponse>(options: Options<TComposable, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, DefaultT>) => (options.client ?? client).get<TComposable, CallWithResponseAndNoContentResponseResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <TComposable extends Composable = '$fetch', DefaultT extends DummyAResponse = DummyAResponse>(options: Options<TComposable, DummyAData, DummyAResponse, DefaultT>) => (options.client ?? client).get<TComposable, DummyAResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <TComposable extends Composable = '$fetch', DefaultT extends DummyBResponse = DummyBResponse>(options: Options<TComposable, DummyBData, DummyBResponse, DefaultT>) => (options.client ?? client).get<TComposable, DummyBResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <TComposable extends Composable = '$fetch', DefaultT extends CallWithResponseResponse = CallWithResponseResponse>(options: Options<TComposable, CallWithResponseData, CallWithResponseResponse, DefaultT>) => (options.client ?? client).get<TComposable, CallWithResponseResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <TComposable extends Composable = '$fetch', DefaultT extends CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponse>(options: Options<TComposable, CallWithDuplicateResponsesData, CallWithDuplicateResponsesResponse, DefaultT>) => (options.client ?? client).post<TComposable, CallWithDuplicateResponsesResponse | DefaultT, CallWithDuplicateResponsesError, DefaultT>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <TComposable extends Composable = '$fetch', DefaultT extends CallWithResponsesResponse = CallWithResponsesResponse>(options: Options<TComposable, CallWithResponsesData, CallWithResponsesResponse, DefaultT>) => (options.client ?? client).put<TComposable, CallWithResponsesResponse | DefaultT, CallWithResponsesError, DefaultT>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CollectionFormatData, unknown, DefaultT>) => (options.client ?? client).get<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <TComposable extends Composable = '$fetch', DefaultT extends TypesResponse = TypesResponse>(options: Options<TComposable, TypesData, TypesResponse, DefaultT>) => (options.client ?? client).get<TComposable, TypesResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <TComposable extends Composable = '$fetch', DefaultT extends UploadFileResponse = UploadFileResponse>(options: Options<TComposable, UploadFileData, UploadFileResponse, DefaultT>) => (options.client ?? client).post<TComposable, UploadFileResponse | DefaultT, unknown, DefaultT>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <TComposable extends Composable = '$fetch', DefaultT extends FileResponseResponse = FileResponseResponse>(options: Options<TComposable, FileResponseData, FileResponseResponse, DefaultT>) => (options.client ?? client).get<TComposable, FileResponseResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <TComposable extends Composable = '$fetch', DefaultT extends ComplexTypesResponse = ComplexTypesResponse>(options: Options<TComposable, ComplexTypesData, ComplexTypesResponse, DefaultT>) => (options.client ?? client).get<TComposable, ComplexTypesResponse | DefaultT, unknown, DefaultT>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <TComposable extends Composable = '$fetch', DefaultT extends MultipartResponseResponse = MultipartResponseResponse>(options: Options<TComposable, MultipartResponseData, MultipartResponseResponse, DefaultT>) => (options.client ?? client).get<TComposable, MultipartResponseResponse | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, MultipartRequestData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <TComposable extends Composable = '$fetch', DefaultT extends ComplexParamsResponse = ComplexParamsResponse>(options: Options<TComposable, ComplexParamsData, ComplexParamsResponse, DefaultT>) => (options.client ?? client).put<TComposable, ComplexParamsResponse | DefaultT, unknown, DefaultT>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, CallWithResultFromHeaderData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, TestErrorCodeData, unknown, DefaultT>) => (options.client ?? client).post<TComposable, unknown | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <TComposable extends Composable = '$fetch', DefaultT extends NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Response>(options: Options<TComposable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, DefaultT>) => (options.client ?? client).post<TComposable, NonAsciiæøåÆøÅöôêÊ字符串Response | DefaultT, unknown, DefaultT>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <TComposable extends Composable = '$fetch', DefaultT = undefined>(options: Options<TComposable, PutWithFormUrlEncodedData, unknown, DefaultT>) => (options.client ?? client).put<TComposable, unknown | DefaultT, unknown, DefaultT>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-nuxt/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseURL: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+16

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { type ClientOptions, type Config, createClient, createConfig } from './client/index.js'; 4 4 + import type { ClientOptions as ClientOptions2 } from './types.gen.js'; 5 5 + 6 6 + /** 7 7 + * The `createClientConfig()` function will be called on client initialization 8 8 + * and the returned object will become the client's initial configuration. 9 9 + * 10 10 + * You may want to initialize your client this way instead of calling 11 11 + * `setConfig()`. This is useful for example if you're using Next.js 12 12 + * to ensure your client always has the correct values. 13 13 + */ 14 14 + export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>; 15 15 + 16 16 + export const client = createClient(createConfig<ClientOptions2>({ baseUrl: 'http://localhost:3000/base' }));

+287

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/client/client.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { ofetch, type ResponseType as OfetchResponseType } from 'ofetch'; 4 4 + 5 5 + import { createSseClient } from '../core/serverSentEvents.gen.js'; 6 6 + import type { HttpMethod } from '../core/types.gen.js'; 7 7 + import { getValidRequestBody } from '../core/utils.gen.js'; 8 8 + import type { 9 9 + Client, 10 10 + Config, 11 11 + RequestOptions, 12 12 + ResolvedRequestOptions, 13 13 + } from './types.gen.js'; 14 14 + import { 15 15 + buildOfetchOptions, 16 16 + buildUrl, 17 17 + createConfig, 18 18 + createInterceptors, 19 19 + isRepeatableBody, 20 20 + mapParseAsToResponseType, 21 21 + mergeConfigs, 22 22 + mergeHeaders, 23 23 + parseError, 24 24 + parseSuccess, 25 25 + setAuthParams, 26 26 + wrapDataReturn, 27 27 + wrapErrorReturn, 28 28 + } from './utils.gen.js'; 29 29 + 30 30 + type ReqInit = Omit<RequestInit, 'body' | 'headers'> & { 31 31 + body?: BodyInit | null | undefined; 32 32 + headers: ReturnType<typeof mergeHeaders>; 33 33 + }; 34 34 + 35 35 + export const createClient = (config: Config = {}): Client => { 36 36 + let _config = mergeConfigs(createConfig(), config); 37 37 + 38 38 + const getConfig = (): Config => ({ ..._config }); 39 39 + 40 40 + const setConfig = (config: Config): Config => { 41 41 + _config = mergeConfigs(_config, config); 42 42 + return getConfig(); 43 43 + }; 44 44 + 45 45 + const interceptors = createInterceptors< 46 46 + Request, 47 47 + Response, 48 48 + unknown, 49 49 + ResolvedRequestOptions 50 50 + >(); 51 51 + 52 52 + // precompute serialized / network body 53 53 + const resolveOptions = async (options: RequestOptions) => { 54 54 + const opts = { 55 55 + ..._config, 56 56 + ...options, 57 57 + headers: mergeHeaders(_config.headers, options.headers), 58 58 + serializedBody: undefined, 59 59 + }; 60 60 + 61 61 + if (opts.security) { 62 62 + await setAuthParams({ 63 63 + ...opts, 64 64 + security: opts.security, 65 65 + }); 66 66 + } 67 67 + 68 68 + if (opts.requestValidator) { 69 69 + await opts.requestValidator(opts); 70 70 + } 71 71 + 72 72 + if (opts.body !== undefined && opts.bodySerializer) { 73 73 + opts.serializedBody = opts.bodySerializer(opts.body); 74 74 + } 75 75 + 76 76 + // remove Content-Type if body is empty to avoid invalid requests 77 77 + if (opts.body === undefined || opts.serializedBody === '') { 78 78 + opts.headers.delete('Content-Type'); 79 79 + } 80 80 + 81 81 + // if a raw body is provided (no serializer), adjust Content-Type only when it 82 82 + // equals the default JSON value to better match the concrete body type 83 83 + if ( 84 84 + opts.body !== undefined && 85 85 + opts.bodySerializer === null && 86 86 + (opts.headers.get('Content-Type') || '').toLowerCase() === 87 87 + 'application/json' 88 88 + ) { 89 89 + const b: unknown = opts.body; 90 90 + if (typeof FormData !== 'undefined' && b instanceof FormData) { 91 91 + // let the runtime set the multipart boundary 92 92 + opts.headers.delete('Content-Type'); 93 93 + } else if ( 94 94 + typeof URLSearchParams !== 'undefined' && 95 95 + b instanceof URLSearchParams 96 96 + ) { 97 97 + // standard urlencoded content type (+ charset) 98 98 + opts.headers.set( 99 99 + 'Content-Type', 100 100 + 'application/x-www-form-urlencoded;charset=UTF-8', 101 101 + ); 102 102 + } else if (typeof Blob !== 'undefined' && b instanceof Blob) { 103 103 + const t = b.type?.trim(); 104 104 + if (t) { 105 105 + opts.headers.set('Content-Type', t); 106 106 + } else { 107 107 + // unknown blob type: avoid sending a misleading JSON header 108 108 + opts.headers.delete('Content-Type'); 109 109 + } 110 110 + } 111 111 + } 112 112 + 113 113 + // precompute network body (stability for retries and interceptors) 114 114 + const networkBody = getValidRequestBody(opts) as 115 115 + | RequestInit['body'] 116 116 + | null 117 117 + | undefined; 118 118 + 119 119 + const url = buildUrl(opts); 120 120 + 121 121 + return { networkBody, opts, url }; 122 122 + }; 123 123 + 124 124 + // apply request interceptors and mirror header/method/signal back to opts 125 125 + const applyRequestInterceptors = async ( 126 126 + request: Request, 127 127 + opts: ResolvedRequestOptions, 128 128 + body: BodyInit | null | undefined, 129 129 + ) => { 130 130 + for (const fn of interceptors.request.fns) { 131 131 + if (fn) { 132 132 + request = await fn(request, opts); 133 133 + } 134 134 + } 135 135 + // reflect interceptor changes into opts used by the network layer 136 136 + opts.headers = request.headers; 137 137 + opts.method = request.method as Uppercase<HttpMethod>; 138 138 + // ignore request.body changes to avoid turning serialized bodies into streams 139 139 + // body comes only from getValidRequestBody(options) 140 140 + // reflect signal if present 141 141 + opts.signal = (request as any).signal as AbortSignal | undefined; 142 142 + 143 143 + // When body is FormData, remove Content-Type header to avoid boundary mismatch. 144 144 + // Note: We already delete Content-Type in resolveOptions for FormData, but the 145 145 + // Request constructor (line 175) re-adds it with an auto-generated boundary. 146 146 + // Since we pass the original FormData (not the Request's body) to ofetch, and 147 147 + // ofetch will generate its own boundary, we must remove the Request's Content-Type 148 148 + // to let ofetch set the correct one. Otherwise the boundary in the header won't 149 149 + // match the boundary in the actual multipart body sent by ofetch. 150 150 + if (typeof FormData !== 'undefined' && body instanceof FormData) { 151 151 + opts.headers.delete('Content-Type'); 152 152 + } 153 153 + 154 154 + return request; 155 155 + }; 156 156 + 157 157 + // build ofetch options with stable retry logic based on body repeatability 158 158 + const buildNetworkOptions = ( 159 159 + opts: ResolvedRequestOptions, 160 160 + body: BodyInit | null | undefined, 161 161 + responseType: OfetchResponseType | undefined, 162 162 + ) => { 163 163 + const effectiveRetry = isRepeatableBody(body) 164 164 + ? (opts.retry as any) 165 165 + : (0 as any); 166 166 + return buildOfetchOptions(opts, body, responseType, effectiveRetry); 167 167 + }; 168 168 + 169 169 + const request: Client['request'] = async (options) => { 170 170 + const { 171 171 + networkBody: initialNetworkBody, 172 172 + opts, 173 173 + url, 174 174 + } = await resolveOptions(options as any); 175 175 + // map parseAs -> ofetch responseType once per request 176 176 + const ofetchResponseType: OfetchResponseType | undefined = 177 177 + mapParseAsToResponseType(opts.parseAs, opts.responseType); 178 178 + 179 179 + const $ofetch = opts.ofetch ?? ofetch; 180 180 + 181 181 + // create Request before network to run middleware consistently 182 182 + const networkBody = initialNetworkBody; 183 183 + const requestInit: ReqInit = { 184 184 + body: networkBody, 185 185 + headers: opts.headers as Headers, 186 186 + method: opts.method, 187 187 + redirect: 'follow', 188 188 + signal: opts.signal, 189 189 + }; 190 190 + let request = new Request(url, requestInit); 191 191 + 192 192 + request = await applyRequestInterceptors(request, opts, networkBody); 193 193 + const finalUrl = request.url; 194 194 + 195 195 + // build ofetch options and perform the request (.raw keeps the Response) 196 196 + const responseOptions = buildNetworkOptions( 197 197 + opts as ResolvedRequestOptions, 198 198 + networkBody, 199 199 + ofetchResponseType, 200 200 + ); 201 201 + 202 202 + let response = await $ofetch.raw(finalUrl, responseOptions); 203 203 + 204 204 + for (const fn of interceptors.response.fns) { 205 205 + if (fn) { 206 206 + response = await fn(response, request, opts); 207 207 + } 208 208 + } 209 209 + 210 210 + const result = { request, response }; 211 211 + 212 212 + if (response.ok) { 213 213 + const data = await parseSuccess(response, opts, ofetchResponseType); 214 214 + return wrapDataReturn(data, result, opts.responseStyle); 215 215 + } 216 216 + 217 217 + let finalError = await parseError(response); 218 218 + 219 219 + for (const fn of interceptors.error.fns) { 220 220 + if (fn) { 221 221 + finalError = await fn(finalError, response, request, opts); 222 222 + } 223 223 + } 224 224 + 225 225 + // ensure error is never undefined after interceptors 226 226 + finalError = (finalError as any) || ({} as string); 227 227 + 228 228 + if (opts.throwOnError) { 229 229 + throw finalError; 230 230 + } 231 231 + 232 232 + return wrapErrorReturn(finalError, result, opts.responseStyle) as any; 233 233 + }; 234 234 + 235 235 + const makeMethodFn = 236 236 + (method: Uppercase<HttpMethod>) => (options: RequestOptions) => 237 237 + request({ ...options, method } as any); 238 238 + 239 239 + const makeSseFn = 240 240 + (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => { 241 241 + const { networkBody, opts, url } = await resolveOptions(options); 242 242 + const optsForSse: any = { ...opts }; 243 243 + delete optsForSse.body; // body is provided via serializedBody below 244 244 + return createSseClient({ 245 245 + ...optsForSse, 246 246 + fetch: opts.fetch, 247 247 + headers: opts.headers as Headers, 248 248 + method, 249 249 + onRequest: async (url, init) => { 250 250 + let request = new Request(url, init); 251 251 + request = await applyRequestInterceptors(request, opts, networkBody); 252 252 + return request; 253 253 + }, 254 254 + serializedBody: networkBody as BodyInit | null | undefined, 255 255 + signal: opts.signal, 256 256 + url, 257 257 + }); 258 258 + }; 259 259 + 260 260 + return { 261 261 + buildUrl, 262 262 + connect: makeMethodFn('CONNECT'), 263 263 + delete: makeMethodFn('DELETE'), 264 264 + get: makeMethodFn('GET'), 265 265 + getConfig, 266 266 + head: makeMethodFn('HEAD'), 267 267 + interceptors, 268 268 + options: makeMethodFn('OPTIONS'), 269 269 + patch: makeMethodFn('PATCH'), 270 270 + post: makeMethodFn('POST'), 271 271 + put: makeMethodFn('PUT'), 272 272 + request, 273 273 + setConfig, 274 274 + sse: { 275 275 + connect: makeSseFn('CONNECT'), 276 276 + delete: makeSseFn('DELETE'), 277 277 + get: makeSseFn('GET'), 278 278 + head: makeSseFn('HEAD'), 279 279 + options: makeSseFn('OPTIONS'), 280 280 + patch: makeSseFn('PATCH'), 281 281 + post: makeSseFn('POST'), 282 282 + put: makeSseFn('PUT'), 283 283 + trace: makeSseFn('TRACE'), 284 284 + }, 285 285 + trace: makeMethodFn('TRACE'), 286 286 + } as Client; 287 287 + };

+25

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/client/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type { Auth } from '../core/auth.gen.js'; 4 4 + export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 5 5 + export { 6 6 + formDataBodySerializer, 7 7 + jsonBodySerializer, 8 8 + urlSearchParamsBodySerializer, 9 9 + } from '../core/bodySerializer.gen.js'; 10 10 + export { buildClientParams } from '../core/params.gen.js'; 11 11 + export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js'; 12 12 + export { createClient } from './client.gen.js'; 13 13 + export type { 14 14 + Client, 15 15 + ClientOptions, 16 16 + Config, 17 17 + CreateClientConfig, 18 18 + Options, 19 19 + RequestOptions, 20 20 + RequestResult, 21 21 + ResolvedRequestOptions, 22 22 + ResponseStyle, 23 23 + TDataShape, 24 24 + } from './types.gen.js'; 25 25 + export { createConfig, mergeHeaders } from './utils.gen.js';

+308

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/client/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + FetchOptions as OfetchOptions, 5 5 + ResponseType as OfetchResponseType, 6 6 + } from 'ofetch'; 7 7 + import type { ofetch } from 'ofetch'; 8 8 + 9 9 + import type { Auth } from '../core/auth.gen.js'; 10 10 + import type { 11 11 + ServerSentEventsOptions, 12 12 + ServerSentEventsResult, 13 13 + } from '../core/serverSentEvents.gen.js'; 14 14 + import type { 15 15 + Client as CoreClient, 16 16 + Config as CoreConfig, 17 17 + } from '../core/types.gen.js'; 18 18 + import type { Middleware } from './utils.gen.js'; 19 19 + 20 20 + export type ResponseStyle = 'data' | 'fields'; 21 21 + 22 22 + export interface Config<T extends ClientOptions = ClientOptions> 23 23 + extends Omit<RequestInit, 'body' | 'headers' | 'method'>, 24 24 + CoreConfig { 25 25 + /** 26 26 + * HTTP(S) agent configuration (Node.js only). Passed through to ofetch. 27 27 + */ 28 28 + agent?: OfetchOptions['agent']; 29 29 + /** 30 30 + * Base URL for all requests made by this client. 31 31 + */ 32 32 + baseUrl?: T['baseUrl']; 33 33 + /** 34 34 + * Node-only proxy/agent options. 35 35 + */ 36 36 + dispatcher?: OfetchOptions['dispatcher']; 37 37 + /** 38 38 + * Fetch API implementation. Used for SSE streaming. You can use this option 39 39 + * to provide a custom fetch instance. 40 40 + * 41 41 + * @default globalThis.fetch 42 42 + */ 43 43 + fetch?: typeof fetch; 44 44 + /** 45 45 + * Controls the native ofetch behaviour that throws `FetchError` when 46 46 + * `response.ok === false`. We default to suppressing it to match the fetch 47 47 + * client semantics and let `throwOnError` drive the outcome. 48 48 + */ 49 49 + ignoreResponseError?: OfetchOptions['ignoreResponseError']; 50 50 + // No custom fetch option: provide custom instance via `ofetch` instead 51 51 + /** 52 52 + * Please don't use the Fetch client for Next.js applications. The `next` 53 53 + * options won't have any effect. 54 54 + * 55 55 + * Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead. 56 56 + */ 57 57 + next?: never; 58 58 + /** 59 59 + * Custom ofetch instance created via `ofetch.create()`. If provided, it will 60 60 + * be used for requests instead of the default `ofetch` export. 61 61 + */ 62 62 + ofetch?: typeof ofetch; 63 63 + /** 64 64 + * ofetch hook called before a request is sent. 65 65 + */ 66 66 + onRequest?: OfetchOptions['onRequest']; 67 67 + /** 68 68 + * ofetch hook called when a request fails before receiving a response 69 69 + * (e.g., network errors or aborted requests). 70 70 + */ 71 71 + onRequestError?: OfetchOptions['onRequestError']; 72 72 + /** 73 73 + * ofetch hook called after a successful response is received and parsed. 74 74 + */ 75 75 + onResponse?: OfetchOptions['onResponse']; 76 76 + /** 77 77 + * ofetch hook called when the response indicates an error (non-ok status) 78 78 + * or when response parsing fails. 79 79 + */ 80 80 + onResponseError?: OfetchOptions['onResponseError']; 81 81 + /** 82 82 + * Return the response data parsed in a specified format. By default, `auto` 83 83 + * will infer the appropriate method from the `Content-Type` response header. 84 84 + * You can override this behavior with any of the {@link Body} methods. 85 85 + * Select `stream` if you don't want to parse response data at all. 86 86 + * 87 87 + * @default 'auto' 88 88 + */ 89 89 + parseAs?: 90 90 + | 'arrayBuffer' 91 91 + | 'auto' 92 92 + | 'blob' 93 93 + | 'formData' 94 94 + | 'json' 95 95 + | 'stream' 96 96 + | 'text'; 97 97 + /** Custom response parser (ofetch). */ 98 98 + parseResponse?: OfetchOptions['parseResponse']; 99 99 + /** 100 100 + * Should we return only data or multiple fields (data, error, response, etc.)? 101 101 + * 102 102 + * @default 'fields' 103 103 + */ 104 104 + responseStyle?: ResponseStyle; 105 105 + /** 106 106 + * ofetch responseType override. If provided, it will be passed directly to 107 107 + * ofetch and take precedence over `parseAs`. 108 108 + */ 109 109 + responseType?: OfetchResponseType; 110 110 + /** 111 111 + * Automatically retry failed requests. 112 112 + */ 113 113 + retry?: OfetchOptions['retry']; 114 114 + /** 115 115 + * Delay (in ms) between retry attempts. 116 116 + */ 117 117 + retryDelay?: OfetchOptions['retryDelay']; 118 118 + /** 119 119 + * HTTP status codes that should trigger a retry. 120 120 + */ 121 121 + retryStatusCodes?: OfetchOptions['retryStatusCodes']; 122 122 + /** 123 123 + * Throw an error instead of returning it in the response? 124 124 + * 125 125 + * @default false 126 126 + */ 127 127 + throwOnError?: T['throwOnError']; 128 128 + /** 129 129 + * Abort the request after the given milliseconds. 130 130 + */ 131 131 + timeout?: number; 132 132 + } 133 133 + 134 134 + export interface RequestOptions< 135 135 + TData = unknown, 136 136 + TResponseStyle extends ResponseStyle = 'fields', 137 137 + ThrowOnError extends boolean = boolean, 138 138 + Url extends string = string, 139 139 + > extends Config<{ 140 140 + responseStyle: TResponseStyle; 141 141 + throwOnError: ThrowOnError; 142 142 + }>, 143 143 + Pick< 144 144 + ServerSentEventsOptions<TData>, 145 145 + | 'onSseError' 146 146 + | 'onSseEvent' 147 147 + | 'sseDefaultRetryDelay' 148 148 + | 'sseMaxRetryAttempts' 149 149 + | 'sseMaxRetryDelay' 150 150 + > { 151 151 + /** 152 152 + * Any body that you want to add to your request. 153 153 + * 154 154 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#body} 155 155 + */ 156 156 + body?: unknown; 157 157 + path?: Record<string, unknown>; 158 158 + query?: Record<string, unknown>; 159 159 + /** 160 160 + * Security mechanism(s) to use for the request. 161 161 + */ 162 162 + security?: ReadonlyArray<Auth>; 163 163 + url: Url; 164 164 + } 165 165 + 166 166 + export interface ResolvedRequestOptions< 167 167 + TResponseStyle extends ResponseStyle = 'fields', 168 168 + ThrowOnError extends boolean = boolean, 169 169 + Url extends string = string, 170 170 + > extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> { 171 171 + serializedBody?: string; 172 172 + } 173 173 + 174 174 + export type RequestResult< 175 175 + TData = unknown, 176 176 + TError = unknown, 177 177 + ThrowOnError extends boolean = boolean, 178 178 + TResponseStyle extends ResponseStyle = 'fields', 179 179 + > = ThrowOnError extends true 180 180 + ? Promise< 181 181 + TResponseStyle extends 'data' 182 182 + ? TData extends Record<string, unknown> 183 183 + ? TData[keyof TData] 184 184 + : TData 185 185 + : { 186 186 + data: TData extends Record<string, unknown> 187 187 + ? TData[keyof TData] 188 188 + : TData; 189 189 + request: Request; 190 190 + response: Response; 191 191 + } 192 192 + > 193 193 + : Promise< 194 194 + TResponseStyle extends 'data' 195 195 + ? 196 196 + | (TData extends Record<string, unknown> 197 197 + ? TData[keyof TData] 198 198 + : TData) 199 199 + | undefined 200 200 + : ( 201 201 + | { 202 202 + data: TData extends Record<string, unknown> 203 203 + ? TData[keyof TData] 204 204 + : TData; 205 205 + error: undefined; 206 206 + } 207 207 + | { 208 208 + data: undefined; 209 209 + error: TError extends Record<string, unknown> 210 210 + ? TError[keyof TError] 211 211 + : TError; 212 212 + } 213 213 + ) & { 214 214 + request: Request; 215 215 + response: Response; 216 216 + } 217 217 + >; 218 218 + 219 219 + export interface ClientOptions { 220 220 + baseUrl?: string; 221 221 + responseStyle?: ResponseStyle; 222 222 + throwOnError?: boolean; 223 223 + } 224 224 + 225 225 + type MethodFn = < 226 226 + TData = unknown, 227 227 + TError = unknown, 228 228 + ThrowOnError extends boolean = false, 229 229 + TResponseStyle extends ResponseStyle = 'fields', 230 230 + >( 231 231 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 232 232 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 233 233 + 234 234 + type SseFn = < 235 235 + TData = unknown, 236 236 + TError = unknown, 237 237 + ThrowOnError extends boolean = false, 238 238 + TResponseStyle extends ResponseStyle = 'fields', 239 239 + >( 240 240 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>, 241 241 + ) => Promise<ServerSentEventsResult<TData, TError>>; 242 242 + 243 243 + type RequestFn = < 244 244 + TData = unknown, 245 245 + TError = unknown, 246 246 + ThrowOnError extends boolean = false, 247 247 + TResponseStyle extends ResponseStyle = 'fields', 248 248 + >( 249 249 + options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & 250 250 + Pick< 251 251 + Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 252 252 + 'method' 253 253 + >, 254 254 + ) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>; 255 255 + 256 256 + type BuildUrlFn = < 257 257 + TData extends { 258 258 + body?: unknown; 259 259 + path?: Record<string, unknown>; 260 260 + query?: Record<string, unknown>; 261 261 + url: string; 262 262 + }, 263 263 + >( 264 264 + options: TData & Options<TData>, 265 265 + ) => string; 266 266 + 267 267 + export type Client = CoreClient< 268 268 + RequestFn, 269 269 + Config, 270 270 + MethodFn, 271 271 + BuildUrlFn, 272 272 + SseFn 273 273 + > & { 274 274 + interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>; 275 275 + }; 276 276 + 277 277 + /** 278 278 + * The `createClientConfig()` function will be called on client initialization 279 279 + * and the returned object will become the client's initial configuration. 280 280 + * 281 281 + * You may want to initialize your client this way instead of calling 282 282 + * `setConfig()`. This is useful for example if you're using Next.js 283 283 + * to ensure your client always has the correct values. 284 284 + */ 285 285 + export type CreateClientConfig<T extends ClientOptions = ClientOptions> = ( 286 286 + override?: Config<ClientOptions & T>, 287 287 + ) => Config<Required<ClientOptions> & T>; 288 288 + 289 289 + export interface TDataShape { 290 290 + body?: unknown; 291 291 + headers?: unknown; 292 292 + path?: unknown; 293 293 + query?: unknown; 294 294 + url: string; 295 295 + } 296 296 + 297 297 + type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>; 298 298 + 299 299 + export type Options< 300 300 + TData extends TDataShape = TDataShape, 301 301 + ThrowOnError extends boolean = boolean, 302 302 + TResponse = unknown, 303 303 + TResponseStyle extends ResponseStyle = 'fields', 304 304 + > = OmitKeys< 305 305 + RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 306 306 + 'body' | 'path' | 'query' | 'url' 307 307 + > & 308 308 + ([TData] extends [never] ? unknown : Omit<TData, 'url'>);

+544

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/client/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + FetchOptions as OfetchOptions, 5 5 + ResponseType as OfetchResponseType, 6 6 + } from 'ofetch'; 7 7 + 8 8 + import { getAuthToken } from '../core/auth.gen.js'; 9 9 + import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js'; 10 10 + import { jsonBodySerializer } from '../core/bodySerializer.gen.js'; 11 11 + import { 12 12 + serializeArrayParam, 13 13 + serializeObjectParam, 14 14 + serializePrimitiveParam, 15 15 + } from '../core/pathSerializer.gen.js'; 16 16 + import { getUrl } from '../core/utils.gen.js'; 17 17 + import type { 18 18 + Client, 19 19 + ClientOptions, 20 20 + Config, 21 21 + RequestOptions, 22 22 + ResolvedRequestOptions, 23 23 + ResponseStyle, 24 24 + } from './types.gen.js'; 25 25 + 26 26 + export const createQuerySerializer = <T = unknown>({ 27 27 + parameters = {}, 28 28 + ...args 29 29 + }: QuerySerializerOptions = {}) => { 30 30 + const querySerializer = (queryParams: T) => { 31 31 + const search: string[] = []; 32 32 + if (queryParams && typeof queryParams === 'object') { 33 33 + for (const name in queryParams) { 34 34 + const value = queryParams[name]; 35 35 + 36 36 + if (value === undefined || value === null) { 37 37 + continue; 38 38 + } 39 39 + 40 40 + const options = parameters[name] || args; 41 41 + 42 42 + if (Array.isArray(value)) { 43 43 + const serializedArray = serializeArrayParam({ 44 44 + allowReserved: options.allowReserved, 45 45 + explode: true, 46 46 + name, 47 47 + style: 'form', 48 48 + value, 49 49 + ...options.array, 50 50 + }); 51 51 + if (serializedArray) search.push(serializedArray); 52 52 + } else if (typeof value === 'object') { 53 53 + const serializedObject = serializeObjectParam({ 54 54 + allowReserved: options.allowReserved, 55 55 + explode: true, 56 56 + name, 57 57 + style: 'deepObject', 58 58 + value: value as Record<string, unknown>, 59 59 + ...options.object, 60 60 + }); 61 61 + if (serializedObject) search.push(serializedObject); 62 62 + } else { 63 63 + const serializedPrimitive = serializePrimitiveParam({ 64 64 + allowReserved: options.allowReserved, 65 65 + name, 66 66 + value: value as string, 67 67 + }); 68 68 + if (serializedPrimitive) search.push(serializedPrimitive); 69 69 + } 70 70 + } 71 71 + } 72 72 + return search.join('&'); 73 73 + }; 74 74 + return querySerializer; 75 75 + }; 76 76 + 77 77 + /** 78 78 + * Infers parseAs value from provided Content-Type header. 79 79 + */ 80 80 + export const getParseAs = ( 81 81 + contentType: string | null, 82 82 + ): Exclude<Config['parseAs'], 'auto'> => { 83 83 + if (!contentType) { 84 84 + // If no Content-Type header is provided, the best we can do is return the raw response body, 85 85 + // which is effectively the same as the 'stream' option. 86 86 + return 'stream'; 87 87 + } 88 88 + 89 89 + const cleanContent = contentType.split(';')[0]?.trim(); 90 90 + 91 91 + if (!cleanContent) { 92 92 + return; 93 93 + } 94 94 + 95 95 + if ( 96 96 + cleanContent.startsWith('application/json') || 97 97 + cleanContent.endsWith('+json') 98 98 + ) { 99 99 + return 'json'; 100 100 + } 101 101 + 102 102 + if (cleanContent === 'multipart/form-data') { 103 103 + return 'formData'; 104 104 + } 105 105 + 106 106 + if ( 107 107 + ['application/', 'audio/', 'image/', 'video/'].some((type) => 108 108 + cleanContent.startsWith(type), 109 109 + ) 110 110 + ) { 111 111 + return 'blob'; 112 112 + } 113 113 + 114 114 + if (cleanContent.startsWith('text/')) { 115 115 + return 'text'; 116 116 + } 117 117 + 118 118 + return; 119 119 + }; 120 120 + 121 121 + /** 122 122 + * Map our parseAs value to ofetch responseType when not explicitly provided. 123 123 + */ 124 124 + export const mapParseAsToResponseType = ( 125 125 + parseAs: Config['parseAs'] | undefined, 126 126 + explicit?: OfetchResponseType, 127 127 + ): OfetchResponseType | undefined => { 128 128 + if (explicit) return explicit; 129 129 + switch (parseAs) { 130 130 + case 'arrayBuffer': 131 131 + case 'blob': 132 132 + case 'json': 133 133 + case 'text': 134 134 + case 'stream': 135 135 + return parseAs; 136 136 + case 'formData': 137 137 + case 'auto': 138 138 + default: 139 139 + return undefined; // let ofetch auto-detect 140 140 + } 141 141 + }; 142 142 + 143 143 + const checkForExistence = ( 144 144 + options: Pick<RequestOptions, 'auth' | 'query'> & { 145 145 + headers: Headers; 146 146 + }, 147 147 + name?: string, 148 148 + ): boolean => { 149 149 + if (!name) { 150 150 + return false; 151 151 + } 152 152 + if ( 153 153 + options.headers.has(name) || 154 154 + options.query?.[name] || 155 155 + options.headers.get('Cookie')?.includes(`${name}=`) 156 156 + ) { 157 157 + return true; 158 158 + } 159 159 + return false; 160 160 + }; 161 161 + 162 162 + export const setAuthParams = async ({ 163 163 + security, 164 164 + ...options 165 165 + }: Pick<Required<RequestOptions>, 'security'> & 166 166 + Pick<RequestOptions, 'auth' | 'query'> & { 167 167 + headers: Headers; 168 168 + }) => { 169 169 + for (const auth of security) { 170 170 + if (checkForExistence(options, auth.name)) { 171 171 + continue; 172 172 + } 173 173 + 174 174 + const token = await getAuthToken(auth, options.auth); 175 175 + 176 176 + if (!token) { 177 177 + continue; 178 178 + } 179 179 + 180 180 + const name = auth.name ?? 'Authorization'; 181 181 + 182 182 + switch (auth.in) { 183 183 + case 'query': 184 184 + if (!options.query) { 185 185 + options.query = {}; 186 186 + } 187 187 + options.query[name] = token; 188 188 + break; 189 189 + case 'cookie': 190 190 + options.headers.append('Cookie', `${name}=${token}`); 191 191 + break; 192 192 + case 'header': 193 193 + default: 194 194 + options.headers.set(name, token); 195 195 + break; 196 196 + } 197 197 + } 198 198 + }; 199 199 + 200 200 + export const buildUrl: Client['buildUrl'] = (options) => 201 201 + getUrl({ 202 202 + baseUrl: options.baseUrl as string, 203 203 + path: options.path, 204 204 + query: options.query, 205 205 + querySerializer: 206 206 + typeof options.querySerializer === 'function' 207 207 + ? options.querySerializer 208 208 + : createQuerySerializer(options.querySerializer), 209 209 + url: options.url, 210 210 + }); 211 211 + 212 212 + export const mergeConfigs = (a: Config, b: Config): Config => { 213 213 + const config = { ...a, ...b }; 214 214 + if (config.baseUrl?.endsWith('/')) { 215 215 + config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1); 216 216 + } 217 217 + config.headers = mergeHeaders(a.headers, b.headers); 218 218 + return config; 219 219 + }; 220 220 + 221 221 + const headersEntries = (headers: Headers): Array<[string, string]> => { 222 222 + const entries: Array<[string, string]> = []; 223 223 + headers.forEach((value, key) => { 224 224 + entries.push([key, value]); 225 225 + }); 226 226 + return entries; 227 227 + }; 228 228 + 229 229 + export const mergeHeaders = ( 230 230 + ...headers: Array<Required<Config>['headers'] | undefined> 231 231 + ): Headers => { 232 232 + const mergedHeaders = new Headers(); 233 233 + for (const header of headers) { 234 234 + if (!header) { 235 235 + continue; 236 236 + } 237 237 + 238 238 + const iterator = 239 239 + header instanceof Headers 240 240 + ? headersEntries(header) 241 241 + : Object.entries(header); 242 242 + 243 243 + for (const [key, value] of iterator) { 244 244 + if (value === null) { 245 245 + mergedHeaders.delete(key); 246 246 + } else if (Array.isArray(value)) { 247 247 + for (const v of value) { 248 248 + mergedHeaders.append(key, v as string); 249 249 + } 250 250 + } else if (value !== undefined) { 251 251 + // assume object headers are meant to be JSON stringified, i.e. their 252 252 + // content value in OpenAPI specification is 'application/json' 253 253 + mergedHeaders.set( 254 254 + key, 255 255 + typeof value === 'object' ? JSON.stringify(value) : (value as string), 256 256 + ); 257 257 + } 258 258 + } 259 259 + } 260 260 + return mergedHeaders; 261 261 + }; 262 262 + 263 263 + /** 264 264 + * Heuristic to detect whether a request body can be safely retried. 265 265 + */ 266 266 + export const isRepeatableBody = (body: unknown): boolean => { 267 267 + if (body == null) return true; // undefined/null treated as no-body 268 268 + if (typeof body === 'string') return true; 269 269 + if (typeof URLSearchParams !== 'undefined' && body instanceof URLSearchParams) 270 270 + return true; 271 271 + if (typeof Uint8Array !== 'undefined' && body instanceof Uint8Array) 272 272 + return true; 273 273 + if (typeof ArrayBuffer !== 'undefined' && body instanceof ArrayBuffer) 274 274 + return true; 275 275 + if (typeof Blob !== 'undefined' && body instanceof Blob) return true; 276 276 + if (typeof FormData !== 'undefined' && body instanceof FormData) return true; 277 277 + // Streams are not repeatable 278 278 + if (typeof ReadableStream !== 'undefined' && body instanceof ReadableStream) 279 279 + return false; 280 280 + // Default: assume non-repeatable for unknown structured bodies 281 281 + return false; 282 282 + }; 283 283 + 284 284 + /** 285 285 + * Small helper to unify data vs fields return style. 286 286 + */ 287 287 + export const wrapDataReturn = <T>( 288 288 + data: T, 289 289 + result: { request: Request; response: Response }, 290 290 + responseStyle: ResponseStyle | undefined, 291 291 + ): 292 292 + | T 293 293 + | ((T extends Record<string, unknown> ? { data: T } : { data: T }) & 294 294 + typeof result) => 295 295 + (responseStyle ?? 'fields') === 'data' 296 296 + ? (data as any) 297 297 + : ({ data, ...result } as any); 298 298 + 299 299 + /** 300 300 + * Small helper to unify error vs fields return style. 301 301 + */ 302 302 + export const wrapErrorReturn = <E>( 303 303 + error: E, 304 304 + result: { request: Request; response: Response }, 305 305 + responseStyle: ResponseStyle | undefined, 306 306 + ): 307 307 + | undefined 308 308 + | ((E extends Record<string, unknown> ? { error: E } : { error: E }) & 309 309 + typeof result) => 310 310 + (responseStyle ?? 'fields') === 'data' 311 311 + ? undefined 312 312 + : ({ error, ...result } as any); 313 313 + 314 314 + /** 315 315 + * Build options for $ofetch.raw from our resolved opts and body. 316 316 + */ 317 317 + export const buildOfetchOptions = ( 318 318 + opts: ResolvedRequestOptions, 319 319 + body: BodyInit | null | undefined, 320 320 + responseType: OfetchResponseType | undefined, 321 321 + retryOverride?: OfetchOptions['retry'], 322 322 + ): OfetchOptions => 323 323 + ({ 324 324 + agent: opts.agent as OfetchOptions['agent'], 325 325 + body, 326 326 + credentials: opts.credentials as OfetchOptions['credentials'], 327 327 + dispatcher: opts.dispatcher as OfetchOptions['dispatcher'], 328 328 + headers: opts.headers as Headers, 329 329 + ignoreResponseError: 330 330 + (opts.ignoreResponseError as OfetchOptions['ignoreResponseError']) ?? 331 331 + true, 332 332 + method: opts.method, 333 333 + onRequest: opts.onRequest as OfetchOptions['onRequest'], 334 334 + onRequestError: opts.onRequestError as OfetchOptions['onRequestError'], 335 335 + onResponse: opts.onResponse as OfetchOptions['onResponse'], 336 336 + onResponseError: opts.onResponseError as OfetchOptions['onResponseError'], 337 337 + parseResponse: opts.parseResponse as OfetchOptions['parseResponse'], 338 338 + // URL already includes query 339 339 + query: undefined, 340 340 + responseType, 341 341 + retry: retryOverride ?? (opts.retry as OfetchOptions['retry']), 342 342 + retryDelay: opts.retryDelay as OfetchOptions['retryDelay'], 343 343 + retryStatusCodes: 344 344 + opts.retryStatusCodes as OfetchOptions['retryStatusCodes'], 345 345 + signal: opts.signal, 346 346 + timeout: opts.timeout as number | undefined, 347 347 + }) as OfetchOptions; 348 348 + 349 349 + /** 350 350 + * Parse a successful response, handling empty bodies and stream cases. 351 351 + */ 352 352 + export const parseSuccess = async ( 353 353 + response: Response, 354 354 + opts: ResolvedRequestOptions, 355 355 + ofetchResponseType?: OfetchResponseType, 356 356 + ): Promise<unknown> => { 357 357 + // Stream requested: return stream body 358 358 + if (ofetchResponseType === 'stream') { 359 359 + return response.body; 360 360 + } 361 361 + 362 362 + const inferredParseAs = 363 363 + (opts.parseAs === 'auto' 364 364 + ? getParseAs(response.headers.get('Content-Type')) 365 365 + : opts.parseAs) ?? 'json'; 366 366 + 367 367 + // Handle empty responses 368 368 + if ( 369 369 + response.status === 204 || 370 370 + response.headers.get('Content-Length') === '0' 371 371 + ) { 372 372 + switch (inferredParseAs) { 373 373 + case 'arrayBuffer': 374 374 + case 'blob': 375 375 + case 'text': 376 376 + return await (response as any)[inferredParseAs](); 377 377 + case 'formData': 378 378 + return new FormData(); 379 379 + case 'stream': 380 380 + return response.body; 381 381 + default: 382 382 + return {}; 383 383 + } 384 384 + } 385 385 + 386 386 + // Prefer ofetch-populated data unless we explicitly need raw `formData` 387 387 + let data: unknown = (response as any)._data; 388 388 + if (inferredParseAs === 'formData' || typeof data === 'undefined') { 389 389 + switch (inferredParseAs) { 390 390 + case 'arrayBuffer': 391 391 + case 'blob': 392 392 + case 'formData': 393 393 + case 'text': 394 394 + data = await (response as any)[inferredParseAs](); 395 395 + break; 396 396 + case 'json': { 397 397 + // Some servers return 200 with no Content-Length and empty body. 398 398 + // response.json() would throw; detect empty via clone().text() first. 399 399 + const txt = await response.clone().text(); 400 400 + if (!txt) { 401 401 + data = {}; 402 402 + } else { 403 403 + data = await (response as any).json(); 404 404 + } 405 405 + break; 406 406 + } 407 407 + case 'stream': 408 408 + return response.body; 409 409 + } 410 410 + } 411 411 + 412 412 + if (inferredParseAs === 'json') { 413 413 + if (opts.responseValidator) { 414 414 + await opts.responseValidator(data); 415 415 + } 416 416 + if (opts.responseTransformer) { 417 417 + data = await opts.responseTransformer(data); 418 418 + } 419 419 + } 420 420 + 421 421 + return data; 422 422 + }; 423 423 + 424 424 + /** 425 425 + * Parse an error response payload. 426 426 + */ 427 427 + export const parseError = async (response: Response): Promise<unknown> => { 428 428 + let error: unknown = (response as any)._data; 429 429 + if (typeof error === 'undefined') { 430 430 + const textError = await response.text(); 431 431 + try { 432 432 + error = JSON.parse(textError); 433 433 + } catch { 434 434 + error = textError; 435 435 + } 436 436 + } 437 437 + return error ?? ({} as string); 438 438 + }; 439 439 + 440 440 + type ErrInterceptor<Err, Res, Req, Options> = ( 441 441 + error: Err, 442 442 + response: Res, 443 443 + request: Req, 444 444 + options: Options, 445 445 + ) => Err | Promise<Err>; 446 446 + 447 447 + type ReqInterceptor<Req, Options> = ( 448 448 + request: Req, 449 449 + options: Options, 450 450 + ) => Req | Promise<Req>; 451 451 + 452 452 + type ResInterceptor<Res, Req, Options> = ( 453 453 + response: Res, 454 454 + request: Req, 455 455 + options: Options, 456 456 + ) => Res | Promise<Res>; 457 457 + 458 458 + class Interceptors<Interceptor> { 459 459 + fns: Array<Interceptor | null> = []; 460 460 + 461 461 + clear(): void { 462 462 + this.fns = []; 463 463 + } 464 464 + 465 465 + eject(id: number | Interceptor): void { 466 466 + const index = this.getInterceptorIndex(id); 467 467 + if (this.fns[index]) { 468 468 + this.fns[index] = null; 469 469 + } 470 470 + } 471 471 + 472 472 + exists(id: number | Interceptor): boolean { 473 473 + const index = this.getInterceptorIndex(id); 474 474 + return Boolean(this.fns[index]); 475 475 + } 476 476 + 477 477 + getInterceptorIndex(id: number | Interceptor): number { 478 478 + if (typeof id === 'number') { 479 479 + return this.fns[id] ? id : -1; 480 480 + } 481 481 + return this.fns.indexOf(id); 482 482 + } 483 483 + 484 484 + update( 485 485 + id: number | Interceptor, 486 486 + fn: Interceptor, 487 487 + ): number | Interceptor | false { 488 488 + const index = this.getInterceptorIndex(id); 489 489 + if (this.fns[index]) { 490 490 + this.fns[index] = fn; 491 491 + return id; 492 492 + } 493 493 + return false; 494 494 + } 495 495 + 496 496 + use(fn: Interceptor): number { 497 497 + this.fns.push(fn); 498 498 + return this.fns.length - 1; 499 499 + } 500 500 + } 501 501 + 502 502 + export interface Middleware<Req, Res, Err, Options> { 503 503 + error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>; 504 504 + request: Interceptors<ReqInterceptor<Req, Options>>; 505 505 + response: Interceptors<ResInterceptor<Res, Req, Options>>; 506 506 + } 507 507 + 508 508 + export const createInterceptors = <Req, Res, Err, Options>(): Middleware< 509 509 + Req, 510 510 + Res, 511 511 + Err, 512 512 + Options 513 513 + > => ({ 514 514 + error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(), 515 515 + request: new Interceptors<ReqInterceptor<Req, Options>>(), 516 516 + response: new Interceptors<ResInterceptor<Res, Req, Options>>(), 517 517 + }); 518 518 + 519 519 + const defaultQuerySerializer = createQuerySerializer({ 520 520 + allowReserved: false, 521 521 + array: { 522 522 + explode: true, 523 523 + style: 'form', 524 524 + }, 525 525 + object: { 526 526 + explode: true, 527 527 + style: 'deepObject', 528 528 + }, 529 529 + }); 530 530 + 531 531 + const defaultHeaders = { 532 532 + 'Content-Type': 'application/json', 533 533 + }; 534 534 + 535 535 + export const createConfig = <T extends ClientOptions = ClientOptions>( 536 536 + override: Config<Omit<ClientOptions, keyof T> & T> = {}, 537 537 + ): Config<Omit<ClientOptions, keyof T> & T> => ({ 538 538 + ...jsonBodySerializer, 539 539 + headers: defaultHeaders, 540 540 + ignoreResponseError: true, 541 541 + parseAs: 'auto', 542 542 + querySerializer: defaultQuerySerializer, 543 543 + ...override, 544 544 + });

+42

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/auth.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type AuthToken = string | undefined; 4 4 + 5 5 + export interface Auth { 6 6 + /** 7 7 + * Which part of the request do we use to send the auth? 8 8 + * 9 9 + * @default 'header' 10 10 + */ 11 11 + in?: 'header' | 'query' | 'cookie'; 12 12 + /** 13 13 + * Header or query parameter name. 14 14 + * 15 15 + * @default 'Authorization' 16 16 + */ 17 17 + name?: string; 18 18 + scheme?: 'basic' | 'bearer'; 19 19 + type: 'apiKey' | 'http'; 20 20 + } 21 21 + 22 22 + export const getAuthToken = async ( 23 23 + auth: Auth, 24 24 + callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken, 25 25 + ): Promise<string | undefined> => { 26 26 + const token = 27 27 + typeof callback === 'function' ? await callback(auth) : callback; 28 28 + 29 29 + if (!token) { 30 30 + return; 31 31 + } 32 32 + 33 33 + if (auth.scheme === 'bearer') { 34 34 + return `Bearer ${token}`; 35 35 + } 36 36 + 37 37 + if (auth.scheme === 'basic') { 38 38 + return `Basic ${btoa(token)}`; 39 39 + } 40 40 + 41 41 + return token; 42 42 + };

+100

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/bodySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { 4 4 + ArrayStyle, 5 5 + ObjectStyle, 6 6 + SerializerOptions, 7 7 + } from './pathSerializer.gen.js'; 8 8 + 9 9 + export type QuerySerializer = (query: Record<string, unknown>) => string; 10 10 + 11 11 + export type BodySerializer = (body: any) => any; 12 12 + 13 13 + type QuerySerializerOptionsObject = { 14 14 + allowReserved?: boolean; 15 15 + array?: Partial<SerializerOptions<ArrayStyle>>; 16 16 + object?: Partial<SerializerOptions<ObjectStyle>>; 17 17 + }; 18 18 + 19 19 + export type QuerySerializerOptions = QuerySerializerOptionsObject & { 20 20 + /** 21 21 + * Per-parameter serialization overrides. When provided, these settings 22 22 + * override the global array/object settings for specific parameter names. 23 23 + */ 24 24 + parameters?: Record<string, QuerySerializerOptionsObject>; 25 25 + }; 26 26 + 27 27 + const serializeFormDataPair = ( 28 28 + data: FormData, 29 29 + key: string, 30 30 + value: unknown, 31 31 + ): void => { 32 32 + if (typeof value === 'string' || value instanceof Blob) { 33 33 + data.append(key, value); 34 34 + } else if (value instanceof Date) { 35 35 + data.append(key, value.toISOString()); 36 36 + } else { 37 37 + data.append(key, JSON.stringify(value)); 38 38 + } 39 39 + }; 40 40 + 41 41 + const serializeUrlSearchParamsPair = ( 42 42 + data: URLSearchParams, 43 43 + key: string, 44 44 + value: unknown, 45 45 + ): void => { 46 46 + if (typeof value === 'string') { 47 47 + data.append(key, value); 48 48 + } else { 49 49 + data.append(key, JSON.stringify(value)); 50 50 + } 51 51 + }; 52 52 + 53 53 + export const formDataBodySerializer = { 54 54 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 55 55 + body: T, 56 56 + ): FormData => { 57 57 + const data = new FormData(); 58 58 + 59 59 + Object.entries(body).forEach(([key, value]) => { 60 60 + if (value === undefined || value === null) { 61 61 + return; 62 62 + } 63 63 + if (Array.isArray(value)) { 64 64 + value.forEach((v) => serializeFormDataPair(data, key, v)); 65 65 + } else { 66 66 + serializeFormDataPair(data, key, value); 67 67 + } 68 68 + }); 69 69 + 70 70 + return data; 71 71 + }, 72 72 + }; 73 73 + 74 74 + export const jsonBodySerializer = { 75 75 + bodySerializer: <T>(body: T): string => 76 76 + JSON.stringify(body, (_key, value) => 77 77 + typeof value === 'bigint' ? value.toString() : value, 78 78 + ), 79 79 + }; 80 80 + 81 81 + export const urlSearchParamsBodySerializer = { 82 82 + bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>( 83 83 + body: T, 84 84 + ): string => { 85 85 + const data = new URLSearchParams(); 86 86 + 87 87 + Object.entries(body).forEach(([key, value]) => { 88 88 + if (value === undefined || value === null) { 89 89 + return; 90 90 + } 91 91 + if (Array.isArray(value)) { 92 92 + value.forEach((v) => serializeUrlSearchParamsPair(data, key, v)); 93 93 + } else { 94 94 + serializeUrlSearchParamsPair(data, key, value); 95 95 + } 96 96 + }); 97 97 + 98 98 + return data.toString(); 99 99 + }, 100 100 + };

+176

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/params.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + type Slot = 'body' | 'headers' | 'path' | 'query'; 4 4 + 5 5 + export type Field = 6 6 + | { 7 7 + in: Exclude<Slot, 'body'>; 8 8 + /** 9 9 + * Field name. This is the name we want the user to see and use. 10 10 + */ 11 11 + key: string; 12 12 + /** 13 13 + * Field mapped name. This is the name we want to use in the request. 14 14 + * If omitted, we use the same value as `key`. 15 15 + */ 16 16 + map?: string; 17 17 + } 18 18 + | { 19 19 + in: Extract<Slot, 'body'>; 20 20 + /** 21 21 + * Key isn't required for bodies. 22 22 + */ 23 23 + key?: string; 24 24 + map?: string; 25 25 + } 26 26 + | { 27 27 + /** 28 28 + * Field name. This is the name we want the user to see and use. 29 29 + */ 30 30 + key: string; 31 31 + /** 32 32 + * Field mapped name. This is the name we want to use in the request. 33 33 + * If `in` is omitted, `map` aliases `key` to the transport layer. 34 34 + */ 35 35 + map: Slot; 36 36 + }; 37 37 + 38 38 + export interface Fields { 39 39 + allowExtra?: Partial<Record<Slot, boolean>>; 40 40 + args?: ReadonlyArray<Field>; 41 41 + } 42 42 + 43 43 + export type FieldsConfig = ReadonlyArray<Field | Fields>; 44 44 + 45 45 + const extraPrefixesMap: Record<string, Slot> = { 46 46 + $body_: 'body', 47 47 + $headers_: 'headers', 48 48 + $path_: 'path', 49 49 + $query_: 'query', 50 50 + }; 51 51 + const extraPrefixes = Object.entries(extraPrefixesMap); 52 52 + 53 53 + type KeyMap = Map< 54 54 + string, 55 55 + | { 56 56 + in: Slot; 57 57 + map?: string; 58 58 + } 59 59 + | { 60 60 + in?: never; 61 61 + map: Slot; 62 62 + } 63 63 + >; 64 64 + 65 65 + const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => { 66 66 + if (!map) { 67 67 + map = new Map(); 68 68 + } 69 69 + 70 70 + for (const config of fields) { 71 71 + if ('in' in config) { 72 72 + if (config.key) { 73 73 + map.set(config.key, { 74 74 + in: config.in, 75 75 + map: config.map, 76 76 + }); 77 77 + } 78 78 + } else if ('key' in config) { 79 79 + map.set(config.key, { 80 80 + map: config.map, 81 81 + }); 82 82 + } else if (config.args) { 83 83 + buildKeyMap(config.args, map); 84 84 + } 85 85 + } 86 86 + 87 87 + return map; 88 88 + }; 89 89 + 90 90 + interface Params { 91 91 + body: unknown; 92 92 + headers: Record<string, unknown>; 93 93 + path: Record<string, unknown>; 94 94 + query: Record<string, unknown>; 95 95 + } 96 96 + 97 97 + const stripEmptySlots = (params: Params) => { 98 98 + for (const [slot, value] of Object.entries(params)) { 99 99 + if (value && typeof value === 'object' && !Object.keys(value).length) { 100 100 + delete params[slot as Slot]; 101 101 + } 102 102 + } 103 103 + }; 104 104 + 105 105 + export const buildClientParams = ( 106 106 + args: ReadonlyArray<unknown>, 107 107 + fields: FieldsConfig, 108 108 + ) => { 109 109 + const params: Params = { 110 110 + body: {}, 111 111 + headers: {}, 112 112 + path: {}, 113 113 + query: {}, 114 114 + }; 115 115 + 116 116 + const map = buildKeyMap(fields); 117 117 + 118 118 + let config: FieldsConfig[number] | undefined; 119 119 + 120 120 + for (const [index, arg] of args.entries()) { 121 121 + if (fields[index]) { 122 122 + config = fields[index]; 123 123 + } 124 124 + 125 125 + if (!config) { 126 126 + continue; 127 127 + } 128 128 + 129 129 + if ('in' in config) { 130 130 + if (config.key) { 131 131 + const field = map.get(config.key)!; 132 132 + const name = field.map || config.key; 133 133 + if (field.in) { 134 134 + (params[field.in] as Record<string, unknown>)[name] = arg; 135 135 + } 136 136 + } else { 137 137 + params.body = arg; 138 138 + } 139 139 + } else { 140 140 + for (const [key, value] of Object.entries(arg ?? {})) { 141 141 + const field = map.get(key); 142 142 + 143 143 + if (field) { 144 144 + if (field.in) { 145 145 + const name = field.map || key; 146 146 + (params[field.in] as Record<string, unknown>)[name] = value; 147 147 + } else { 148 148 + params[field.map] = value; 149 149 + } 150 150 + } else { 151 151 + const extra = extraPrefixes.find(([prefix]) => 152 152 + key.startsWith(prefix), 153 153 + ); 154 154 + 155 155 + if (extra) { 156 156 + const [prefix, slot] = extra; 157 157 + (params[slot] as Record<string, unknown>)[ 158 158 + key.slice(prefix.length) 159 159 + ] = value; 160 160 + } else if ('allowExtra' in config && config.allowExtra) { 161 161 + for (const [slot, allowed] of Object.entries(config.allowExtra)) { 162 162 + if (allowed) { 163 163 + (params[slot as Slot] as Record<string, unknown>)[key] = value; 164 164 + break; 165 165 + } 166 166 + } 167 167 + } 168 168 + } 169 169 + } 170 170 + } 171 171 + } 172 172 + 173 173 + stripEmptySlots(params); 174 174 + 175 175 + return params; 176 176 + };

+181

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/pathSerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + interface SerializeOptions<T> 4 4 + extends SerializePrimitiveOptions, 5 5 + SerializerOptions<T> {} 6 6 + 7 7 + interface SerializePrimitiveOptions { 8 8 + allowReserved?: boolean; 9 9 + name: string; 10 10 + } 11 11 + 12 12 + export interface SerializerOptions<T> { 13 13 + /** 14 14 + * @default true 15 15 + */ 16 16 + explode: boolean; 17 17 + style: T; 18 18 + } 19 19 + 20 20 + export type ArrayStyle = 'form' | 'spaceDelimited' | 'pipeDelimited'; 21 21 + export type ArraySeparatorStyle = ArrayStyle | MatrixStyle; 22 22 + type MatrixStyle = 'label' | 'matrix' | 'simple'; 23 23 + export type ObjectStyle = 'form' | 'deepObject'; 24 24 + type ObjectSeparatorStyle = ObjectStyle | MatrixStyle; 25 25 + 26 26 + interface SerializePrimitiveParam extends SerializePrimitiveOptions { 27 27 + value: string; 28 28 + } 29 29 + 30 30 + export const separatorArrayExplode = (style: ArraySeparatorStyle) => { 31 31 + switch (style) { 32 32 + case 'label': 33 33 + return '.'; 34 34 + case 'matrix': 35 35 + return ';'; 36 36 + case 'simple': 37 37 + return ','; 38 38 + default: 39 39 + return '&'; 40 40 + } 41 41 + }; 42 42 + 43 43 + export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => { 44 44 + switch (style) { 45 45 + case 'form': 46 46 + return ','; 47 47 + case 'pipeDelimited': 48 48 + return '|'; 49 49 + case 'spaceDelimited': 50 50 + return '%20'; 51 51 + default: 52 52 + return ','; 53 53 + } 54 54 + }; 55 55 + 56 56 + export const separatorObjectExplode = (style: ObjectSeparatorStyle) => { 57 57 + switch (style) { 58 58 + case 'label': 59 59 + return '.'; 60 60 + case 'matrix': 61 61 + return ';'; 62 62 + case 'simple': 63 63 + return ','; 64 64 + default: 65 65 + return '&'; 66 66 + } 67 67 + }; 68 68 + 69 69 + export const serializeArrayParam = ({ 70 70 + allowReserved, 71 71 + explode, 72 72 + name, 73 73 + style, 74 74 + value, 75 75 + }: SerializeOptions<ArraySeparatorStyle> & { 76 76 + value: unknown[]; 77 77 + }) => { 78 78 + if (!explode) { 79 79 + const joinedValues = ( 80 80 + allowReserved ? value : value.map((v) => encodeURIComponent(v as string)) 81 81 + ).join(separatorArrayNoExplode(style)); 82 82 + switch (style) { 83 83 + case 'label': 84 84 + return `.${joinedValues}`; 85 85 + case 'matrix': 86 86 + return `;${name}=${joinedValues}`; 87 87 + case 'simple': 88 88 + return joinedValues; 89 89 + default: 90 90 + return `${name}=${joinedValues}`; 91 91 + } 92 92 + } 93 93 + 94 94 + const separator = separatorArrayExplode(style); 95 95 + const joinedValues = value 96 96 + .map((v) => { 97 97 + if (style === 'label' || style === 'simple') { 98 98 + return allowReserved ? v : encodeURIComponent(v as string); 99 99 + } 100 100 + 101 101 + return serializePrimitiveParam({ 102 102 + allowReserved, 103 103 + name, 104 104 + value: v as string, 105 105 + }); 106 106 + }) 107 107 + .join(separator); 108 108 + return style === 'label' || style === 'matrix' 109 109 + ? separator + joinedValues 110 110 + : joinedValues; 111 111 + }; 112 112 + 113 113 + export const serializePrimitiveParam = ({ 114 114 + allowReserved, 115 115 + name, 116 116 + value, 117 117 + }: SerializePrimitiveParam) => { 118 118 + if (value === undefined || value === null) { 119 119 + return ''; 120 120 + } 121 121 + 122 122 + if (typeof value === 'object') { 123 123 + throw new Error( 124 124 + 'Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.', 125 125 + ); 126 126 + } 127 127 + 128 128 + return `${name}=${allowReserved ? value : encodeURIComponent(value)}`; 129 129 + }; 130 130 + 131 131 + export const serializeObjectParam = ({ 132 132 + allowReserved, 133 133 + explode, 134 134 + name, 135 135 + style, 136 136 + value, 137 137 + valueOnly, 138 138 + }: SerializeOptions<ObjectSeparatorStyle> & { 139 139 + value: Record<string, unknown> | Date; 140 140 + valueOnly?: boolean; 141 141 + }) => { 142 142 + if (value instanceof Date) { 143 143 + return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`; 144 144 + } 145 145 + 146 146 + if (style !== 'deepObject' && !explode) { 147 147 + let values: string[] = []; 148 148 + Object.entries(value).forEach(([key, v]) => { 149 149 + values = [ 150 150 + ...values, 151 151 + key, 152 152 + allowReserved ? (v as string) : encodeURIComponent(v as string), 153 153 + ]; 154 154 + }); 155 155 + const joinedValues = values.join(','); 156 156 + switch (style) { 157 157 + case 'form': 158 158 + return `${name}=${joinedValues}`; 159 159 + case 'label': 160 160 + return `.${joinedValues}`; 161 161 + case 'matrix': 162 162 + return `;${name}=${joinedValues}`; 163 163 + default: 164 164 + return joinedValues; 165 165 + } 166 166 + } 167 167 + 168 168 + const separator = separatorObjectExplode(style); 169 169 + const joinedValues = Object.entries(value) 170 170 + .map(([key, v]) => 171 171 + serializePrimitiveParam({ 172 172 + allowReserved, 173 173 + name: style === 'deepObject' ? `${name}[${key}]` : key, 174 174 + value: v as string, 175 175 + }), 176 176 + ) 177 177 + .join(separator); 178 178 + return style === 'label' || style === 'matrix' 179 179 + ? separator + joinedValues 180 180 + : joinedValues; 181 181 + };

+136

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/queryKeySerializer.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + /** 4 4 + * JSON-friendly union that mirrors what Pinia Colada can hash. 5 5 + */ 6 6 + export type JsonValue = 7 7 + | null 8 8 + | string 9 9 + | number 10 10 + | boolean 11 11 + | JsonValue[] 12 12 + | { [key: string]: JsonValue }; 13 13 + 14 14 + /** 15 15 + * Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes. 16 16 + */ 17 17 + export const queryKeyJsonReplacer = (_key: string, value: unknown) => { 18 18 + if ( 19 19 + value === undefined || 20 20 + typeof value === 'function' || 21 21 + typeof value === 'symbol' 22 22 + ) { 23 23 + return undefined; 24 24 + } 25 25 + if (typeof value === 'bigint') { 26 26 + return value.toString(); 27 27 + } 28 28 + if (value instanceof Date) { 29 29 + return value.toISOString(); 30 30 + } 31 31 + return value; 32 32 + }; 33 33 + 34 34 + /** 35 35 + * Safely stringifies a value and parses it back into a JsonValue. 36 36 + */ 37 37 + export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => { 38 38 + try { 39 39 + const json = JSON.stringify(input, queryKeyJsonReplacer); 40 40 + if (json === undefined) { 41 41 + return undefined; 42 42 + } 43 43 + return JSON.parse(json) as JsonValue; 44 44 + } catch { 45 45 + return undefined; 46 46 + } 47 47 + }; 48 48 + 49 49 + /** 50 50 + * Detects plain objects (including objects with a null prototype). 51 51 + */ 52 52 + const isPlainObject = (value: unknown): value is Record<string, unknown> => { 53 53 + if (value === null || typeof value !== 'object') { 54 54 + return false; 55 55 + } 56 56 + const prototype = Object.getPrototypeOf(value as object); 57 57 + return prototype === Object.prototype || prototype === null; 58 58 + }; 59 59 + 60 60 + /** 61 61 + * Turns URLSearchParams into a sorted JSON object for deterministic keys. 62 62 + */ 63 63 + const serializeSearchParams = (params: URLSearchParams): JsonValue => { 64 64 + const entries = Array.from(params.entries()).sort(([a], [b]) => 65 65 + a.localeCompare(b), 66 66 + ); 67 67 + const result: Record<string, JsonValue> = {}; 68 68 + 69 69 + for (const [key, value] of entries) { 70 70 + const existing = result[key]; 71 71 + if (existing === undefined) { 72 72 + result[key] = value; 73 73 + continue; 74 74 + } 75 75 + 76 76 + if (Array.isArray(existing)) { 77 77 + (existing as string[]).push(value); 78 78 + } else { 79 79 + result[key] = [existing, value]; 80 80 + } 81 81 + } 82 82 + 83 83 + return result; 84 84 + }; 85 85 + 86 86 + /** 87 87 + * Normalizes any accepted value into a JSON-friendly shape for query keys. 88 88 + */ 89 89 + export const serializeQueryKeyValue = ( 90 90 + value: unknown, 91 91 + ): JsonValue | undefined => { 92 92 + if (value === null) { 93 93 + return null; 94 94 + } 95 95 + 96 96 + if ( 97 97 + typeof value === 'string' || 98 98 + typeof value === 'number' || 99 99 + typeof value === 'boolean' 100 100 + ) { 101 101 + return value; 102 102 + } 103 103 + 104 104 + if ( 105 105 + value === undefined || 106 106 + typeof value === 'function' || 107 107 + typeof value === 'symbol' 108 108 + ) { 109 109 + return undefined; 110 110 + } 111 111 + 112 112 + if (typeof value === 'bigint') { 113 113 + return value.toString(); 114 114 + } 115 115 + 116 116 + if (value instanceof Date) { 117 117 + return value.toISOString(); 118 118 + } 119 119 + 120 120 + if (Array.isArray(value)) { 121 121 + return stringifyToJsonValue(value); 122 122 + } 123 123 + 124 124 + if ( 125 125 + typeof URLSearchParams !== 'undefined' && 126 126 + value instanceof URLSearchParams 127 127 + ) { 128 128 + return serializeSearchParams(value); 129 129 + } 130 130 + 131 131 + if (isPlainObject(value)) { 132 132 + return stringifyToJsonValue(value); 133 133 + } 134 134 + 135 135 + return undefined; 136 136 + };

+266

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/serverSentEvents.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Config } from './types.gen.js'; 4 4 + 5 5 + export type ServerSentEventsOptions<TData = unknown> = Omit< 6 6 + RequestInit, 7 7 + 'method' 8 8 + > & 9 9 + Pick<Config, 'method' | 'responseTransformer' | 'responseValidator'> & { 10 10 + /** 11 11 + * Fetch API implementation. You can use this option to provide a custom 12 12 + * fetch instance. 13 13 + * 14 14 + * @default globalThis.fetch 15 15 + */ 16 16 + fetch?: typeof fetch; 17 17 + /** 18 18 + * Implementing clients can call request interceptors inside this hook. 19 19 + */ 20 20 + onRequest?: (url: string, init: RequestInit) => Promise<Request>; 21 21 + /** 22 22 + * Callback invoked when a network or parsing error occurs during streaming. 23 23 + * 24 24 + * This option applies only if the endpoint returns a stream of events. 25 25 + * 26 26 + * @param error The error that occurred. 27 27 + */ 28 28 + onSseError?: (error: unknown) => void; 29 29 + /** 30 30 + * Callback invoked when an event is streamed from the server. 31 31 + * 32 32 + * This option applies only if the endpoint returns a stream of events. 33 33 + * 34 34 + * @param event Event streamed from the server. 35 35 + * @returns Nothing (void). 36 36 + */ 37 37 + onSseEvent?: (event: StreamEvent<TData>) => void; 38 38 + serializedBody?: RequestInit['body']; 39 39 + /** 40 40 + * Default retry delay in milliseconds. 41 41 + * 42 42 + * This option applies only if the endpoint returns a stream of events. 43 43 + * 44 44 + * @default 3000 45 45 + */ 46 46 + sseDefaultRetryDelay?: number; 47 47 + /** 48 48 + * Maximum number of retry attempts before giving up. 49 49 + */ 50 50 + sseMaxRetryAttempts?: number; 51 51 + /** 52 52 + * Maximum retry delay in milliseconds. 53 53 + * 54 54 + * Applies only when exponential backoff is used. 55 55 + * 56 56 + * This option applies only if the endpoint returns a stream of events. 57 57 + * 58 58 + * @default 30000 59 59 + */ 60 60 + sseMaxRetryDelay?: number; 61 61 + /** 62 62 + * Optional sleep function for retry backoff. 63 63 + * 64 64 + * Defaults to using `setTimeout`. 65 65 + */ 66 66 + sseSleepFn?: (ms: number) => Promise<void>; 67 67 + url: string; 68 68 + }; 69 69 + 70 70 + export interface StreamEvent<TData = unknown> { 71 71 + data: TData; 72 72 + event?: string; 73 73 + id?: string; 74 74 + retry?: number; 75 75 + } 76 76 + 77 77 + export type ServerSentEventsResult< 78 78 + TData = unknown, 79 79 + TReturn = void, 80 80 + TNext = unknown, 81 81 + > = { 82 82 + stream: AsyncGenerator< 83 83 + TData extends Record<string, unknown> ? TData[keyof TData] : TData, 84 84 + TReturn, 85 85 + TNext 86 86 + >; 87 87 + }; 88 88 + 89 89 + export const createSseClient = <TData = unknown>({ 90 90 + onRequest, 91 91 + onSseError, 92 92 + onSseEvent, 93 93 + responseTransformer, 94 94 + responseValidator, 95 95 + sseDefaultRetryDelay, 96 96 + sseMaxRetryAttempts, 97 97 + sseMaxRetryDelay, 98 98 + sseSleepFn, 99 99 + url, 100 100 + ...options 101 101 + }: ServerSentEventsOptions): ServerSentEventsResult<TData> => { 102 102 + let lastEventId: string | undefined; 103 103 + 104 104 + const sleep = 105 105 + sseSleepFn ?? 106 106 + ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms))); 107 107 + 108 108 + const createStream = async function* () { 109 109 + let retryDelay: number = sseDefaultRetryDelay ?? 3000; 110 110 + let attempt = 0; 111 111 + const signal = options.signal ?? new AbortController().signal; 112 112 + 113 113 + while (true) { 114 114 + if (signal.aborted) break; 115 115 + 116 116 + attempt++; 117 117 + 118 118 + const headers = 119 119 + options.headers instanceof Headers 120 120 + ? options.headers 121 121 + : new Headers(options.headers as Record<string, string> | undefined); 122 122 + 123 123 + if (lastEventId !== undefined) { 124 124 + headers.set('Last-Event-ID', lastEventId); 125 125 + } 126 126 + 127 127 + try { 128 128 + const requestInit: RequestInit = { 129 129 + redirect: 'follow', 130 130 + ...options, 131 131 + body: options.serializedBody, 132 132 + headers, 133 133 + signal, 134 134 + }; 135 135 + let request = new Request(url, requestInit); 136 136 + if (onRequest) { 137 137 + request = await onRequest(url, requestInit); 138 138 + } 139 139 + // fetch must be assigned here, otherwise it would throw the error: 140 140 + // TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation 141 141 + const _fetch = options.fetch ?? globalThis.fetch; 142 142 + const response = await _fetch(request); 143 143 + 144 144 + if (!response.ok) 145 145 + throw new Error( 146 146 + `SSE failed: ${response.status} ${response.statusText}`, 147 147 + ); 148 148 + 149 149 + if (!response.body) throw new Error('No body in SSE response'); 150 150 + 151 151 + const reader = response.body 152 152 + .pipeThrough(new TextDecoderStream()) 153 153 + .getReader(); 154 154 + 155 155 + let buffer = ''; 156 156 + 157 157 + const abortHandler = () => { 158 158 + try { 159 159 + reader.cancel(); 160 160 + } catch { 161 161 + // noop 162 162 + } 163 163 + }; 164 164 + 165 165 + signal.addEventListener('abort', abortHandler); 166 166 + 167 167 + try { 168 168 + while (true) { 169 169 + const { done, value } = await reader.read(); 170 170 + if (done) break; 171 171 + buffer += value; 172 172 + // Normalize line endings: CRLF -> LF, then CR -> LF 173 173 + buffer = buffer.replace(/\r\n/g, '\n').replace(/\r/g, '\n'); 174 174 + 175 175 + const chunks = buffer.split('\n\n'); 176 176 + buffer = chunks.pop() ?? ''; 177 177 + 178 178 + for (const chunk of chunks) { 179 179 + const lines = chunk.split('\n'); 180 180 + const dataLines: Array<string> = []; 181 181 + let eventName: string | undefined; 182 182 + 183 183 + for (const line of lines) { 184 184 + if (line.startsWith('data:')) { 185 185 + dataLines.push(line.replace(/^data:\s*/, '')); 186 186 + } else if (line.startsWith('event:')) { 187 187 + eventName = line.replace(/^event:\s*/, ''); 188 188 + } else if (line.startsWith('id:')) { 189 189 + lastEventId = line.replace(/^id:\s*/, ''); 190 190 + } else if (line.startsWith('retry:')) { 191 191 + const parsed = Number.parseInt( 192 192 + line.replace(/^retry:\s*/, ''), 193 193 + 10, 194 194 + ); 195 195 + if (!Number.isNaN(parsed)) { 196 196 + retryDelay = parsed; 197 197 + } 198 198 + } 199 199 + } 200 200 + 201 201 + let data: unknown; 202 202 + let parsedJson = false; 203 203 + 204 204 + if (dataLines.length) { 205 205 + const rawData = dataLines.join('\n'); 206 206 + try { 207 207 + data = JSON.parse(rawData); 208 208 + parsedJson = true; 209 209 + } catch { 210 210 + data = rawData; 211 211 + } 212 212 + } 213 213 + 214 214 + if (parsedJson) { 215 215 + if (responseValidator) { 216 216 + await responseValidator(data); 217 217 + } 218 218 + 219 219 + if (responseTransformer) { 220 220 + data = await responseTransformer(data); 221 221 + } 222 222 + } 223 223 + 224 224 + onSseEvent?.({ 225 225 + data, 226 226 + event: eventName, 227 227 + id: lastEventId, 228 228 + retry: retryDelay, 229 229 + }); 230 230 + 231 231 + if (dataLines.length) { 232 232 + yield data as any; 233 233 + } 234 234 + } 235 235 + } 236 236 + } finally { 237 237 + signal.removeEventListener('abort', abortHandler); 238 238 + reader.releaseLock(); 239 239 + } 240 240 + 241 241 + break; // exit loop on normal completion 242 242 + } catch (error) { 243 243 + // connection failed or aborted; retry after delay 244 244 + onSseError?.(error); 245 245 + 246 246 + if ( 247 247 + sseMaxRetryAttempts !== undefined && 248 248 + attempt >= sseMaxRetryAttempts 249 249 + ) { 250 250 + break; // stop after firing error 251 251 + } 252 252 + 253 253 + // exponential backoff: double retry each attempt, cap at 30s 254 254 + const backoff = Math.min( 255 255 + retryDelay * 2 ** (attempt - 1), 256 256 + sseMaxRetryDelay ?? 30000, 257 257 + ); 258 258 + await sleep(backoff); 259 259 + } 260 260 + } 261 261 + }; 262 262 + 263 263 + const stream = createStream(); 264 264 + 265 265 + return { stream }; 266 266 + };

+118

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { Auth, AuthToken } from './auth.gen.js'; 4 4 + import type { 5 5 + BodySerializer, 6 6 + QuerySerializer, 7 7 + QuerySerializerOptions, 8 8 + } from './bodySerializer.gen.js'; 9 9 + 10 10 + export type HttpMethod = 11 11 + | 'connect' 12 12 + | 'delete' 13 13 + | 'get' 14 14 + | 'head' 15 15 + | 'options' 16 16 + | 'patch' 17 17 + | 'post' 18 18 + | 'put' 19 19 + | 'trace'; 20 20 + 21 21 + export type Client< 22 22 + RequestFn = never, 23 23 + Config = unknown, 24 24 + MethodFn = never, 25 25 + BuildUrlFn = never, 26 26 + SseFn = never, 27 27 + > = { 28 28 + /** 29 29 + * Returns the final request URL. 30 30 + */ 31 31 + buildUrl: BuildUrlFn; 32 32 + getConfig: () => Config; 33 33 + request: RequestFn; 34 34 + setConfig: (config: Config) => Config; 35 35 + } & { 36 36 + [K in HttpMethod]: MethodFn; 37 37 + } & ([SseFn] extends [never] 38 38 + ? { sse?: never } 39 39 + : { sse: { [K in HttpMethod]: SseFn } }); 40 40 + 41 41 + export interface Config { 42 42 + /** 43 43 + * Auth token or a function returning auth token. The resolved value will be 44 44 + * added to the request payload as defined by its `security` array. 45 45 + */ 46 46 + auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken; 47 47 + /** 48 48 + * A function for serializing request body parameter. By default, 49 49 + * {@link JSON.stringify()} will be used. 50 50 + */ 51 51 + bodySerializer?: BodySerializer | null; 52 52 + /** 53 53 + * An object containing any HTTP headers that you want to pre-populate your 54 54 + * `Headers` object with. 55 55 + * 56 56 + * {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more} 57 57 + */ 58 58 + headers?: 59 59 + | RequestInit['headers'] 60 60 + | Record< 61 61 + string, 62 62 + | string 63 63 + | number 64 64 + | boolean 65 65 + | (string | number | boolean)[] 66 66 + | null 67 67 + | undefined 68 68 + | unknown 69 69 + >; 70 70 + /** 71 71 + * The request method. 72 72 + * 73 73 + * {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more} 74 74 + */ 75 75 + method?: Uppercase<HttpMethod>; 76 76 + /** 77 77 + * A function for serializing request query parameters. By default, arrays 78 78 + * will be exploded in form style, objects will be exploded in deepObject 79 79 + * style, and reserved characters are percent-encoded. 80 80 + * 81 81 + * This method will have no effect if the native `paramsSerializer()` Axios 82 82 + * API function is used. 83 83 + * 84 84 + * {@link https://swagger.io/docs/specification/serialization/#query View examples} 85 85 + */ 86 86 + querySerializer?: QuerySerializer | QuerySerializerOptions; 87 87 + /** 88 88 + * A function validating request data. This is useful if you want to ensure 89 89 + * the request conforms to the desired shape, so it can be safely sent to 90 90 + * the server. 91 91 + */ 92 92 + requestValidator?: (data: unknown) => Promise<unknown>; 93 93 + /** 94 94 + * A function transforming response data before it's returned. This is useful 95 95 + * for post-processing data, e.g. converting ISO strings into Date objects. 96 96 + */ 97 97 + responseTransformer?: (data: unknown) => Promise<unknown>; 98 98 + /** 99 99 + * A function validating response data. This is useful if you want to ensure 100 100 + * the response conforms to the desired shape, so it can be safely passed to 101 101 + * the transformers and returned to the user. 102 102 + */ 103 103 + responseValidator?: (data: unknown) => Promise<unknown>; 104 104 + } 105 105 + 106 106 + type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never] 107 107 + ? true 108 108 + : [T] extends [never | undefined] 109 109 + ? [undefined] extends [T] 110 110 + ? false 111 111 + : true 112 112 + : false; 113 113 + 114 114 + export type OmitNever<T extends Record<string, unknown>> = { 115 115 + [K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true 116 116 + ? never 117 117 + : K]: T[K]; 118 118 + };

+143

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/core/utils.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import type { BodySerializer, QuerySerializer } from './bodySerializer.gen.js'; 4 4 + import { 5 5 + type ArraySeparatorStyle, 6 6 + serializeArrayParam, 7 7 + serializeObjectParam, 8 8 + serializePrimitiveParam, 9 9 + } from './pathSerializer.gen.js'; 10 10 + 11 11 + export interface PathSerializer { 12 12 + path: Record<string, unknown>; 13 13 + url: string; 14 14 + } 15 15 + 16 16 + export const PATH_PARAM_RE = /\{[^{}]+\}/g; 17 17 + 18 18 + export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => { 19 19 + let url = _url; 20 20 + const matches = _url.match(PATH_PARAM_RE); 21 21 + if (matches) { 22 22 + for (const match of matches) { 23 23 + let explode = false; 24 24 + let name = match.substring(1, match.length - 1); 25 25 + let style: ArraySeparatorStyle = 'simple'; 26 26 + 27 27 + if (name.endsWith('*')) { 28 28 + explode = true; 29 29 + name = name.substring(0, name.length - 1); 30 30 + } 31 31 + 32 32 + if (name.startsWith('.')) { 33 33 + name = name.substring(1); 34 34 + style = 'label'; 35 35 + } else if (name.startsWith(';')) { 36 36 + name = name.substring(1); 37 37 + style = 'matrix'; 38 38 + } 39 39 + 40 40 + const value = path[name]; 41 41 + 42 42 + if (value === undefined || value === null) { 43 43 + continue; 44 44 + } 45 45 + 46 46 + if (Array.isArray(value)) { 47 47 + url = url.replace( 48 48 + match, 49 49 + serializeArrayParam({ explode, name, style, value }), 50 50 + ); 51 51 + continue; 52 52 + } 53 53 + 54 54 + if (typeof value === 'object') { 55 55 + url = url.replace( 56 56 + match, 57 57 + serializeObjectParam({ 58 58 + explode, 59 59 + name, 60 60 + style, 61 61 + value: value as Record<string, unknown>, 62 62 + valueOnly: true, 63 63 + }), 64 64 + ); 65 65 + continue; 66 66 + } 67 67 + 68 68 + if (style === 'matrix') { 69 69 + url = url.replace( 70 70 + match, 71 71 + `;${serializePrimitiveParam({ 72 72 + name, 73 73 + value: value as string, 74 74 + })}`, 75 75 + ); 76 76 + continue; 77 77 + } 78 78 + 79 79 + const replaceValue = encodeURIComponent( 80 80 + style === 'label' ? `.${value as string}` : (value as string), 81 81 + ); 82 82 + url = url.replace(match, replaceValue); 83 83 + } 84 84 + } 85 85 + return url; 86 86 + }; 87 87 + 88 88 + export const getUrl = ({ 89 89 + baseUrl, 90 90 + path, 91 91 + query, 92 92 + querySerializer, 93 93 + url: _url, 94 94 + }: { 95 95 + baseUrl?: string; 96 96 + path?: Record<string, unknown>; 97 97 + query?: Record<string, unknown>; 98 98 + querySerializer: QuerySerializer; 99 99 + url: string; 100 100 + }) => { 101 101 + const pathUrl = _url.startsWith('/') ? _url : `/${_url}`; 102 102 + let url = (baseUrl ?? '') + pathUrl; 103 103 + if (path) { 104 104 + url = defaultPathSerializer({ path, url }); 105 105 + } 106 106 + let search = query ? querySerializer(query) : ''; 107 107 + if (search.startsWith('?')) { 108 108 + search = search.substring(1); 109 109 + } 110 110 + if (search) { 111 111 + url += `?${search}`; 112 112 + } 113 113 + return url; 114 114 + }; 115 115 + 116 116 + export function getValidRequestBody(options: { 117 117 + body?: unknown; 118 118 + bodySerializer?: BodySerializer | null; 119 119 + serializedBody?: unknown; 120 120 + }) { 121 121 + const hasBody = options.body !== undefined; 122 122 + const isSerializedBody = hasBody && options.bodySerializer; 123 123 + 124 124 + if (isSerializedBody) { 125 125 + if ('serializedBody' in options) { 126 126 + const hasSerializedBody = 127 127 + options.serializedBody !== undefined && options.serializedBody !== ''; 128 128 + 129 129 + return hasSerializedBody ? options.serializedBody : null; 130 130 + } 131 131 + 132 132 + // not all clients implement a serializedBody property (i.e. client-axios) 133 133 + return options.body !== '' ? options.body : null; 134 134 + } 135 135 + 136 136 + // plain/text body 137 137 + if (hasBody) { 138 138 + return options.body; 139 139 + } 140 140 + 141 141 + // no body was provided 142 142 + return undefined; 143 143 + }

+4

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/index.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export { apiVVersionODataControllerCount, callToTestOrderOfParams, callWithDefaultOptionalParameters, callWithDefaultParameters, callWithDescriptions, callWithDuplicateResponses, callWithNoContentResponse, callWithParameters, callWithResponse, callWithResponseAndNoContentResponse, callWithResponses, callWithResultFromHeader, callWithWeirdParameterNames, collectionFormat, complexParams, complexTypes, deleteCallWithoutParametersAndResponse, deleteFoo, deprecatedCall, dummyA, dummyB, duplicateName, duplicateName2, duplicateName3, duplicateName4, export_, fileResponse, fooWow, getApiVbyApiVersionSimpleOperation, getCallWithOptionalParam, getCallWithoutParametersAndResponse, headCallWithoutParametersAndResponse, import_, multipartRequest, multipartResponse, nonAsciiæøåÆøÅöôêÊ字符串, type Options, optionsCallWithoutParametersAndResponse, patchApiVbyApiVersionNoTag, patchCallWithoutParametersAndResponse, postApiVbyApiVersionFormData, postApiVbyApiVersionRequestBody, postCallWithOptionalParam, postCallWithoutParametersAndResponse, putCallWithoutParametersAndResponse, putWithFormUrlEncoded, testErrorCode, types, uploadFile } from './sdk.gen.js'; 4 4 + export type { _3eNum1Период, _400, AdditionalPropertiesIntegerIssue, AdditionalPropertiesUnknownIssue, AdditionalPropertiesUnknownIssue2, AdditionalPropertiesUnknownIssue3, AdditionalPropertiesUnknownIssueWritable, AnyOfAnyAndNull, AnyOfArrays, ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponse, ApiVVersionODataControllerCountResponses, ArrayWithAnyOfProperties, ArrayWithArray, ArrayWithBooleans, ArrayWithNumbers, ArrayWithProperties, ArrayWithReferences, ArrayWithStrings, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesError, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponse, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponse, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponse, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponse, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesError, CallWithResponsesErrors, CallWithResponsesResponse, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CamelCaseCommentWithBreaks, CharactersInDescription, ClientOptions, CollectionFormatData, CommentWithBackticks, CommentWithBackticksAndQuotes, CommentWithBreaks, CommentWithExpressionPlaceholders, CommentWithQuotes, CommentWithReservedCharacters, CommentWithSlashes, ComplexParamsData, ComplexParamsResponse, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponse, ComplexTypesResponses, CompositionBaseModel, CompositionExtendedModel, CompositionWithAllOfAndNullable, CompositionWithAnyOf, CompositionWithAnyOfAndNullable, CompositionWithAnyOfAnonymous, CompositionWithNestedAnyAndTypeNull, CompositionWithNestedAnyOfAndNull, CompositionWithOneOf, CompositionWithOneOfAndComplexArrayDictionary, CompositionWithOneOfAndNullable, CompositionWithOneOfAndProperties, CompositionWithOneOfAndSimpleArrayDictionary, CompositionWithOneOfAndSimpleDictionary, CompositionWithOneOfAnonymous, CompositionWithOneOfDiscriminator, ConstValue, Default, DeleteCallWithoutParametersAndResponseData, DeleteFooData, DeleteFooData2, DeleteFooData3, DeprecatedCallData, DeprecatedModel, DictionaryWithArray, DictionaryWithDictionary, DictionaryWithProperties, DictionaryWithPropertiesAndAdditionalProperties, DictionaryWithReference, DictionaryWithString, DummyAData, DummyAResponse, DummyAResponses, DummyBData, DummyBResponse, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, EnumFromDescription, EnumWithExtensions, EnumWithNumbers, EnumWithReplacedCharacters, EnumWithStrings, EnumWithXEnumNames, ExportData, ExternalRefA, ExternalRefB, ExternalSharedExternalSharedModel, File, FileResponseData, FileResponseResponse, FileResponseResponses, FileWritable, FooWowData, FooWowResponses, FreeFormObjectWithAdditionalPropertiesEqEmptyObject, FreeFormObjectWithAdditionalPropertiesEqTrue, FreeFormObjectWithoutAdditionalProperties, GenericSchemaDuplicateIssue1SystemBoolean, GenericSchemaDuplicateIssue1SystemBooleanWritable, GenericSchemaDuplicateIssue1SystemString, GenericSchemaDuplicateIssue1SystemStringWritable, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationError, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponse, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, Import, ImportData, ImportResponse, ImportResponses, IoK8sApimachineryPkgApisMetaV1DeleteOptions, IoK8sApimachineryPkgApisMetaV1Preconditions, ModelCircle, ModelFromZendesk, ModelSquare, ModelThatExtends, ModelThatExtendsExtends, ModelWithAdditionalPropertiesEqTrue, ModelWithAnyOfConstantSizeArray, ModelWithAnyOfConstantSizeArrayAndIntersect, ModelWithAnyOfConstantSizeArrayNullable, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions, ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable, ModelWithArray, ModelWithArrayReadOnlyAndWriteOnly, ModelWithArrayReadOnlyAndWriteOnlyWritable, ModelWithBackticksInDescription, ModelWithBoolean, ModelWithCircularReference, ModelWithConst, ModelWithConstantSizeArray, ModelWithDictionary, ModelWithDuplicateImports, ModelWithDuplicateProperties, ModelWithEnum, ModelWithEnumFromDescription, ModelWithEnumWithHyphen, ModelWithInteger, ModelWithNestedArrayEnums, ModelWithNestedArrayEnumsData, ModelWithNestedArrayEnumsDataBar, ModelWithNestedArrayEnumsDataFoo, ModelWithNestedCompositionEnums, ModelWithNestedEnums, ModelWithNestedProperties, ModelWithNullableObject, ModelWithNullableString, ModelWithNumericEnumUnion, ModelWithOneOfAndProperties, ModelWithOneOfEnum, ModelWithOrderedProperties, ModelWithPattern, ModelWithPatternWritable, ModelWithPrefixItemsConstantSizeArray, ModelWithProperties, ModelWithPropertiesWritable, ModelWithReadOnlyAndWriteOnly, ModelWithReadOnlyAndWriteOnlyWritable, ModelWithReference, ModelWithReferenceWritable, ModelWithString, ModelWithStringError, MultipartRequestData, MultipartResponseData, MultipartResponseResponse, MultipartResponseResponses, NestedAnyOfArraysNullable, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Response, NonAsciiæøåÆøÅöôêÊ字符串Responses, NonAsciiStringæøåÆøÅöôêÊ字符串, NullableObject, OneOfAllOfIssue, OneOfAllOfIssueWritable, OptionsCallWithoutParametersAndResponseData, Pageable, ParameterSimpleParameterUnused, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponse, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PostServiceWithEmptyTagResponse, PostServiceWithEmptyTagResponse2, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, SchemaWithFormRestrictedKeys, SimpleBoolean, SimpleFile, SimpleFormData, SimpleInteger, SimpleParameter, SimpleReference, SimpleRequestBody, SimpleString, SimpleStringWithPattern, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponse, TypesResponses, UploadFileData, UploadFileResponse, UploadFileResponses, XFooBar } from './types.gen.js';

+206

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/sdk.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + import { client } from './client.gen.js'; 4 4 + import { type Client, formDataBodySerializer, type Options as Options2, type TDataShape, urlSearchParamsBodySerializer } from './client/index.js'; 5 5 + import type { ApiVVersionODataControllerCountData, ApiVVersionODataControllerCountResponses, CallToTestOrderOfParamsData, CallWithDefaultOptionalParametersData, CallWithDefaultParametersData, CallWithDescriptionsData, CallWithDuplicateResponsesData, CallWithDuplicateResponsesErrors, CallWithDuplicateResponsesResponses, CallWithNoContentResponseData, CallWithNoContentResponseResponses, CallWithParametersData, CallWithResponseAndNoContentResponseData, CallWithResponseAndNoContentResponseResponses, CallWithResponseData, CallWithResponseResponses, CallWithResponsesData, CallWithResponsesErrors, CallWithResponsesResponses, CallWithResultFromHeaderData, CallWithResultFromHeaderErrors, CallWithResultFromHeaderResponses, CallWithWeirdParameterNamesData, CollectionFormatData, ComplexParamsData, ComplexParamsResponses, ComplexTypesData, ComplexTypesErrors, ComplexTypesResponses, DeleteCallWithoutParametersAndResponseData, DeleteFooData3, DeprecatedCallData, DummyAData, DummyAResponses, DummyBData, DummyBResponses, DuplicateName2Data, DuplicateName3Data, DuplicateName4Data, DuplicateNameData, ExportData, FileResponseData, FileResponseResponses, FooWowData, FooWowResponses, GetApiVbyApiVersionSimpleOperationData, GetApiVbyApiVersionSimpleOperationErrors, GetApiVbyApiVersionSimpleOperationResponses, GetCallWithOptionalParamData, GetCallWithoutParametersAndResponseData, HeadCallWithoutParametersAndResponseData, ImportData, ImportResponses, MultipartRequestData, MultipartResponseData, MultipartResponseResponses, NonAsciiæøåÆøÅöôêÊ字符串Data, NonAsciiæøåÆøÅöôêÊ字符串Responses, OptionsCallWithoutParametersAndResponseData, PatchApiVbyApiVersionNoTagData, PatchApiVbyApiVersionNoTagResponses, PatchCallWithoutParametersAndResponseData, PostApiVbyApiVersionFormDataData, PostApiVbyApiVersionRequestBodyData, PostCallWithOptionalParamData, PostCallWithOptionalParamResponses, PostCallWithoutParametersAndResponseData, PutCallWithoutParametersAndResponseData, PutWithFormUrlEncodedData, TestErrorCodeData, TestErrorCodeErrors, TestErrorCodeResponses, TypesData, TypesResponses, UploadFileData, UploadFileResponses } from './types.gen.js'; 6 6 + 7 7 + export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & { 8 8 + /** 9 9 + * You can provide a client instance returned by `createClient()` instead of 10 10 + * individual options. This might be also useful if you want to implement a 11 11 + * custom client. 12 12 + */ 13 13 + client?: Client; 14 14 + /** 15 15 + * You can pass arbitrary values through the `meta` object. This can be 16 16 + * used to access values that aren't defined as part of the SDK function. 17 17 + */ 18 18 + meta?: Record<string, unknown>; 19 19 + }; 20 20 + 21 21 + export const export_ = <ThrowOnError extends boolean = false>(options?: Options<ExportData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 22 22 + 23 23 + export const patchApiVbyApiVersionNoTag = <ThrowOnError extends boolean = false>(options?: Options<PatchApiVbyApiVersionNoTagData, ThrowOnError>) => (options?.client ?? client).patch<PatchApiVbyApiVersionNoTagResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 24 24 + 25 25 + export const import_ = <ThrowOnError extends boolean = false>(options: Options<ImportData, ThrowOnError>) => (options.client ?? client).post<ImportResponses, unknown, ThrowOnError>({ 26 26 + url: '/api/v{api-version}/no+tag', 27 27 + ...options, 28 28 + headers: { 29 29 + 'Content-Type': 'application/json', 30 30 + ...options.headers 31 31 + } 32 32 + }); 33 33 + 34 34 + export const fooWow = <ThrowOnError extends boolean = false>(options?: Options<FooWowData, ThrowOnError>) => (options?.client ?? client).put<FooWowResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no+tag', ...options }); 35 35 + 36 36 + export const apiVVersionODataControllerCount = <ThrowOnError extends boolean = false>(options?: Options<ApiVVersionODataControllerCountData, ThrowOnError>) => (options?.client ?? client).get<ApiVVersionODataControllerCountResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple/$count', ...options }); 37 37 + 38 38 + export const getApiVbyApiVersionSimpleOperation = <ThrowOnError extends boolean = false>(options: Options<GetApiVbyApiVersionSimpleOperationData, ThrowOnError>) => (options.client ?? client).get<GetApiVbyApiVersionSimpleOperationResponses, GetApiVbyApiVersionSimpleOperationErrors, ThrowOnError>({ url: '/api/v{api-version}/simple:operation', ...options }); 39 39 + 40 40 + export const deleteCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<DeleteCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 41 41 + 42 42 + export const getCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<GetCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 43 43 + 44 44 + export const headCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<HeadCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).head<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 45 45 + 46 46 + export const optionsCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<OptionsCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).options<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 47 47 + 48 48 + export const patchCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PatchCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).patch<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 49 49 + 50 50 + export const postCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PostCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 51 51 + 52 52 + export const putCallWithoutParametersAndResponse = <ThrowOnError extends boolean = false>(options?: Options<PutCallWithoutParametersAndResponseData, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/simple', ...options }); 53 53 + 54 54 + export const deleteFoo = <ThrowOnError extends boolean = false>(options: Options<DeleteFooData3, ThrowOnError>) => (options.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}', ...options }); 55 55 + 56 56 + export const callWithDescriptions = <ThrowOnError extends boolean = false>(options?: Options<CallWithDescriptionsData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/descriptions', ...options }); 57 57 + 58 58 + /** 59 59 + * @deprecated 60 60 + */ 61 61 + export const deprecatedCall = <ThrowOnError extends boolean = false>(options: Options<DeprecatedCallData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/parameters/deprecated', ...options }); 62 62 + 63 63 + export const callWithParameters = <ThrowOnError extends boolean = false>(options: Options<CallWithParametersData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 64 64 + url: '/api/v{api-version}/parameters/{parameterPath}', 65 65 + ...options, 66 66 + headers: { 67 67 + 'Content-Type': 'application/json', 68 68 + ...options.headers 69 69 + } 70 70 + }); 71 71 + 72 72 + export const callWithWeirdParameterNames = <ThrowOnError extends boolean = false>(options: Options<CallWithWeirdParameterNamesData, ThrowOnError>) => (options.client ?? client).post<unknown, unknown, ThrowOnError>({ 73 73 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}', 74 74 + ...options, 75 75 + headers: { 76 76 + 'Content-Type': 'application/json', 77 77 + ...options.headers 78 78 + } 79 79 + }); 80 80 + 81 81 + export const getCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<GetCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ 82 82 + url: '/api/v{api-version}/parameters', 83 83 + ...options, 84 84 + headers: { 85 85 + 'Content-Type': 'application/json', 86 86 + ...options.headers 87 87 + } 88 88 + }); 89 89 + 90 90 + export const postCallWithOptionalParam = <ThrowOnError extends boolean = false>(options: Options<PostCallWithOptionalParamData, ThrowOnError>) => (options.client ?? client).post<PostCallWithOptionalParamResponses, unknown, ThrowOnError>({ 91 91 + url: '/api/v{api-version}/parameters', 92 92 + ...options, 93 93 + headers: { 94 94 + 'Content-Type': 'application/json', 95 95 + ...options.headers 96 96 + } 97 97 + }); 98 98 + 99 99 + export const postApiVbyApiVersionRequestBody = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionRequestBodyData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 100 100 + url: '/api/v{api-version}/requestBody', 101 101 + ...options, 102 102 + headers: { 103 103 + 'Content-Type': 'application/json', 104 104 + ...options?.headers 105 105 + } 106 106 + }); 107 107 + 108 108 + export const postApiVbyApiVersionFormData = <ThrowOnError extends boolean = false>(options?: Options<PostApiVbyApiVersionFormDataData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 109 109 + ...formDataBodySerializer, 110 110 + url: '/api/v{api-version}/formData', 111 111 + ...options, 112 112 + headers: { 113 113 + 'Content-Type': null, 114 114 + ...options?.headers 115 115 + } 116 116 + }); 117 117 + 118 118 + export const callWithDefaultParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultParametersData, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 119 119 + 120 120 + export const callWithDefaultOptionalParameters = <ThrowOnError extends boolean = false>(options?: Options<CallWithDefaultOptionalParametersData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 121 121 + 122 122 + export const callToTestOrderOfParams = <ThrowOnError extends boolean = false>(options: Options<CallToTestOrderOfParamsData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/defaults', ...options }); 123 123 + 124 124 + export const duplicateName = <ThrowOnError extends boolean = false>(options?: Options<DuplicateNameData, ThrowOnError>) => (options?.client ?? client).delete<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 125 125 + 126 126 + export const duplicateName2 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName2Data, ThrowOnError>) => (options?.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 127 127 + 128 128 + export const duplicateName3 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName3Data, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 129 129 + 130 130 + export const duplicateName4 = <ThrowOnError extends boolean = false>(options?: Options<DuplicateName4Data, ThrowOnError>) => (options?.client ?? client).put<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/duplicate', ...options }); 131 131 + 132 132 + export const callWithNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/no-content', ...options }); 133 133 + 134 134 + export const callWithResponseAndNoContentResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseAndNoContentResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseAndNoContentResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/response-and-no-content', ...options }); 135 135 + 136 136 + export const dummyA = <ThrowOnError extends boolean = false>(options?: Options<DummyAData, ThrowOnError>) => (options?.client ?? client).get<DummyAResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/a', ...options }); 137 137 + 138 138 + export const dummyB = <ThrowOnError extends boolean = false>(options?: Options<DummyBData, ThrowOnError>) => (options?.client ?? client).get<DummyBResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multiple-tags/b', ...options }); 139 139 + 140 140 + export const callWithResponse = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponseData, ThrowOnError>) => (options?.client ?? client).get<CallWithResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 141 141 + 142 142 + export const callWithDuplicateResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithDuplicateResponsesData, ThrowOnError>) => (options?.client ?? client).post<CallWithDuplicateResponsesResponses, CallWithDuplicateResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 143 143 + 144 144 + export const callWithResponses = <ThrowOnError extends boolean = false>(options?: Options<CallWithResponsesData, ThrowOnError>) => (options?.client ?? client).put<CallWithResponsesResponses, CallWithResponsesErrors, ThrowOnError>({ url: '/api/v{api-version}/response', ...options }); 145 145 + 146 146 + export const collectionFormat = <ThrowOnError extends boolean = false>(options: Options<CollectionFormatData, ThrowOnError>) => (options.client ?? client).get<unknown, unknown, ThrowOnError>({ url: '/api/v{api-version}/collectionFormat', ...options }); 147 147 + 148 148 + export const types = <ThrowOnError extends boolean = false>(options: Options<TypesData, ThrowOnError>) => (options.client ?? client).get<TypesResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/types', ...options }); 149 149 + 150 150 + export const uploadFile = <ThrowOnError extends boolean = false>(options: Options<UploadFileData, ThrowOnError>) => (options.client ?? client).post<UploadFileResponses, unknown, ThrowOnError>({ 151 151 + ...urlSearchParamsBodySerializer, 152 152 + url: '/api/v{api-version}/upload', 153 153 + ...options, 154 154 + headers: { 155 155 + 'Content-Type': 'application/x-www-form-urlencoded', 156 156 + ...options.headers 157 157 + } 158 158 + }); 159 159 + 160 160 + export const fileResponse = <ThrowOnError extends boolean = false>(options: Options<FileResponseData, ThrowOnError>) => (options.client ?? client).get<FileResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/file/{id}', ...options }); 161 161 + 162 162 + export const complexTypes = <ThrowOnError extends boolean = false>(options: Options<ComplexTypesData, ThrowOnError>) => (options.client ?? client).get<ComplexTypesResponses, ComplexTypesErrors, ThrowOnError>({ 163 163 + querySerializer: { parameters: { parameterObject: { object: { style: 'form' } } } }, 164 164 + url: '/api/v{api-version}/complex', 165 165 + ...options 166 166 + }); 167 167 + 168 168 + export const multipartResponse = <ThrowOnError extends boolean = false>(options?: Options<MultipartResponseData, ThrowOnError>) => (options?.client ?? client).get<MultipartResponseResponses, unknown, ThrowOnError>({ url: '/api/v{api-version}/multipart', ...options }); 169 169 + 170 170 + export const multipartRequest = <ThrowOnError extends boolean = false>(options?: Options<MultipartRequestData, ThrowOnError>) => (options?.client ?? client).post<unknown, unknown, ThrowOnError>({ 171 171 + ...formDataBodySerializer, 172 172 + url: '/api/v{api-version}/multipart', 173 173 + ...options, 174 174 + headers: { 175 175 + 'Content-Type': null, 176 176 + ...options?.headers 177 177 + } 178 178 + }); 179 179 + 180 180 + export const complexParams = <ThrowOnError extends boolean = false>(options: Options<ComplexParamsData, ThrowOnError>) => (options.client ?? client).put<ComplexParamsResponses, unknown, ThrowOnError>({ 181 181 + url: '/api/v{api-version}/complex/{id}', 182 182 + ...options, 183 183 + headers: { 184 184 + 'Content-Type': 'application/json-patch+json', 185 185 + ...options.headers 186 186 + } 187 187 + }); 188 188 + 189 189 + export const callWithResultFromHeader = <ThrowOnError extends boolean = false>(options?: Options<CallWithResultFromHeaderData, ThrowOnError>) => (options?.client ?? client).post<CallWithResultFromHeaderResponses, CallWithResultFromHeaderErrors, ThrowOnError>({ url: '/api/v{api-version}/header', ...options }); 190 190 + 191 191 + export const testErrorCode = <ThrowOnError extends boolean = false>(options: Options<TestErrorCodeData, ThrowOnError>) => (options.client ?? client).post<TestErrorCodeResponses, TestErrorCodeErrors, ThrowOnError>({ url: '/api/v{api-version}/error', ...options }); 192 192 + 193 193 + export const nonAsciiæøåÆøÅöôêÊ字符串 = <ThrowOnError extends boolean = false>(options: Options<NonAsciiæøåÆøÅöôêÊ字符串Data, ThrowOnError>) => (options.client ?? client).post<NonAsciiæøåÆøÅöôêÊ字符串Responses, unknown, ThrowOnError>({ url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', ...options }); 194 194 + 195 195 + /** 196 196 + * Login User 197 197 + */ 198 198 + export const putWithFormUrlEncoded = <ThrowOnError extends boolean = false>(options: Options<PutWithFormUrlEncodedData, ThrowOnError>) => (options.client ?? client).put<unknown, unknown, ThrowOnError>({ 199 199 + ...urlSearchParamsBodySerializer, 200 200 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串', 201 201 + ...options, 202 202 + headers: { 203 203 + 'Content-Type': 'application/x-www-form-urlencoded', 204 204 + ...options.headers 205 205 + } 206 206 + });

+2091

packages/openapi-ts-tests/main/test/__snapshots__/3.1.x/clients/@hey-api/client-ofetch/tsconfig-node16-sdk/types.gen.ts

··· 1 1 + // This file is auto-generated by @hey-api/openapi-ts 2 2 + 3 3 + export type ClientOptions = { 4 4 + baseUrl: 'http://localhost:3000/base' | (string & {}); 5 5 + }; 6 6 + 7 7 + /** 8 8 + * Model with number-only name 9 9 + */ 10 10 + export type _400 = string; 11 11 + 12 12 + /** 13 13 + * External ref to shared model (A) 14 14 + */ 15 15 + export type ExternalRefA = ExternalSharedExternalSharedModel; 16 16 + 17 17 + /** 18 18 + * External ref to shared model (B) 19 19 + */ 20 20 + export type ExternalRefB = ExternalSharedExternalSharedModel; 21 21 + 22 22 + /** 23 23 + * Testing multiline comments in string: First line 24 24 + * Second line 25 25 + * 26 26 + * Fourth line 27 27 + */ 28 28 + export type CamelCaseCommentWithBreaks = number; 29 29 + 30 30 + /** 31 31 + * Testing multiline comments in string: First line 32 32 + * Second line 33 33 + * 34 34 + * Fourth line 35 35 + */ 36 36 + export type CommentWithBreaks = number; 37 37 + 38 38 + /** 39 39 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 40 40 + */ 41 41 + export type CommentWithBackticks = number; 42 42 + 43 43 + /** 44 44 + * Testing backticks and quotes in string: `backticks`, 'quotes', "double quotes" and ```multiple backticks``` should work 45 45 + */ 46 46 + export type CommentWithBackticksAndQuotes = number; 47 47 + 48 48 + /** 49 49 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 50 50 + */ 51 51 + export type CommentWithSlashes = number; 52 52 + 53 53 + /** 54 54 + * Testing expression placeholders in string: ${expression} should work 55 55 + */ 56 56 + export type CommentWithExpressionPlaceholders = number; 57 57 + 58 58 + /** 59 59 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 60 60 + */ 61 61 + export type CommentWithQuotes = number; 62 62 + 63 63 + /** 64 64 + * Testing reserved characters in string: * inline * and ** inline ** should work 65 65 + */ 66 66 + export type CommentWithReservedCharacters = number; 67 67 + 68 68 + /** 69 69 + * This is a simple number 70 70 + */ 71 71 + export type SimpleInteger = number; 72 72 + 73 73 + /** 74 74 + * This is a simple boolean 75 75 + */ 76 76 + export type SimpleBoolean = boolean; 77 77 + 78 78 + /** 79 79 + * This is a simple string 80 80 + */ 81 81 + export type SimpleString = string; 82 82 + 83 83 + /** 84 84 + * A string with non-ascii (unicode) characters valid in typescript identifiers (æøåÆØÅöÔèÈ字符串) 85 85 + */ 86 86 + export type NonAsciiStringæøåÆøÅöôêÊ字符串 = string; 87 87 + 88 88 + /** 89 89 + * This is a simple file 90 90 + */ 91 91 + export type SimpleFile = Blob | File; 92 92 + 93 93 + /** 94 94 + * This is a simple reference 95 95 + */ 96 96 + export type SimpleReference = ModelWithString; 97 97 + 98 98 + /** 99 99 + * This is a simple string 100 100 + */ 101 101 + export type SimpleStringWithPattern = string | null; 102 102 + 103 103 + /** 104 104 + * This is a simple enum with strings 105 105 + */ 106 106 + export type EnumWithStrings = 'Success' | 'Warning' | 'Error' | '\'Single Quote\'' | '"Double Quotes"' | 'Non-ascii: øæåôöØÆÅÔÖ字符串'; 107 107 + 108 108 + export type EnumWithReplacedCharacters = '\'Single Quote\'' | '"Double Quotes"' | 'øæåôöØÆÅÔÖ字符串' | 3.1 | ''; 109 109 + 110 110 + /** 111 111 + * This is a simple enum with numbers 112 112 + */ 113 113 + export type EnumWithNumbers = 1 | 2 | 3 | 1.1 | 1.2 | 1.3 | 100 | 200 | 300 | -100 | -200 | -300 | -1.1 | -1.2 | -1.3; 114 114 + 115 115 + /** 116 116 + * Success=1,Warning=2,Error=3 117 117 + */ 118 118 + export type EnumFromDescription = number; 119 119 + 120 120 + /** 121 121 + * This is a simple enum with numbers 122 122 + */ 123 123 + export type EnumWithExtensions = 200 | 400 | 500; 124 124 + 125 125 + export type EnumWithXEnumNames = 0 | 1 | 2; 126 126 + 127 127 + /** 128 128 + * This is a simple array with numbers 129 129 + */ 130 130 + export type ArrayWithNumbers = Array<number>; 131 131 + 132 132 + /** 133 133 + * This is a simple array with booleans 134 134 + */ 135 135 + export type ArrayWithBooleans = Array<boolean>; 136 136 + 137 137 + /** 138 138 + * This is a simple array with strings 139 139 + */ 140 140 + export type ArrayWithStrings = Array<string>; 141 141 + 142 142 + /** 143 143 + * This is a simple array with references 144 144 + */ 145 145 + export type ArrayWithReferences = Array<ModelWithString>; 146 146 + 147 147 + /** 148 148 + * This is a simple array containing an array 149 149 + */ 150 150 + export type ArrayWithArray = Array<Array<ModelWithString>>; 151 151 + 152 152 + /** 153 153 + * This is a simple array with properties 154 154 + */ 155 155 + export type ArrayWithProperties = Array<{ 156 156 + '16x16'?: CamelCaseCommentWithBreaks; 157 157 + bar?: string; 158 158 + }>; 159 159 + 160 160 + /** 161 161 + * This is a simple array with any of properties 162 162 + */ 163 163 + export type ArrayWithAnyOfProperties = Array<{ 164 164 + foo?: string; 165 165 + } | { 166 166 + bar?: string; 167 167 + }>; 168 168 + 169 169 + export type AnyOfAnyAndNull = { 170 170 + data?: unknown | null; 171 171 + }; 172 172 + 173 173 + /** 174 174 + * This is a simple array with any of properties 175 175 + */ 176 176 + export type AnyOfArrays = { 177 177 + results?: Array<{ 178 178 + foo?: string; 179 179 + } | { 180 180 + bar?: string; 181 181 + }>; 182 182 + }; 183 183 + 184 184 + /** 185 185 + * This is a string dictionary 186 186 + */ 187 187 + export type DictionaryWithString = { 188 188 + [key: string]: string; 189 189 + }; 190 190 + 191 191 + export type DictionaryWithPropertiesAndAdditionalProperties = { 192 192 + foo?: number; 193 193 + bar?: boolean; 194 194 + [key: string]: string | number | boolean | undefined; 195 195 + }; 196 196 + 197 197 + /** 198 198 + * This is a string reference 199 199 + */ 200 200 + export type DictionaryWithReference = { 201 201 + [key: string]: ModelWithString; 202 202 + }; 203 203 + 204 204 + /** 205 205 + * This is a complex dictionary 206 206 + */ 207 207 + export type DictionaryWithArray = { 208 208 + [key: string]: Array<ModelWithString>; 209 209 + }; 210 210 + 211 211 + /** 212 212 + * This is a string dictionary 213 213 + */ 214 214 + export type DictionaryWithDictionary = { 215 215 + [key: string]: { 216 216 + [key: string]: string; 217 217 + }; 218 218 + }; 219 219 + 220 220 + /** 221 221 + * This is a complex dictionary 222 222 + */ 223 223 + export type DictionaryWithProperties = { 224 224 + [key: string]: { 225 225 + foo?: string; 226 226 + bar?: string; 227 227 + }; 228 228 + }; 229 229 + 230 230 + /** 231 231 + * This is a model with one number property 232 232 + */ 233 233 + export type ModelWithInteger = { 234 234 + /** 235 235 + * This is a simple number property 236 236 + */ 237 237 + prop?: number; 238 238 + }; 239 239 + 240 240 + /** 241 241 + * This is a model with one boolean property 242 242 + */ 243 243 + export type ModelWithBoolean = { 244 244 + /** 245 245 + * This is a simple boolean property 246 246 + */ 247 247 + prop?: boolean; 248 248 + }; 249 249 + 250 250 + /** 251 251 + * This is a model with one string property 252 252 + */ 253 253 + export type ModelWithString = { 254 254 + /** 255 255 + * This is a simple string property 256 256 + */ 257 257 + prop?: string; 258 258 + }; 259 259 + 260 260 + /** 261 261 + * This is a model with one string property 262 262 + */ 263 263 + export type ModelWithStringError = { 264 264 + /** 265 265 + * This is a simple string property 266 266 + */ 267 267 + prop?: string; 268 268 + }; 269 269 + 270 270 + /** 271 271 + * `Comment` or `VoiceComment`. The JSON object for adding voice comments to tickets is different. See [Adding voice comments to tickets](/documentation/ticketing/managing-tickets/adding-voice-comments-to-tickets) 272 272 + */ 273 273 + export type ModelFromZendesk = string; 274 274 + 275 275 + /** 276 276 + * This is a model with one string property 277 277 + */ 278 278 + export type ModelWithNullableString = { 279 279 + /** 280 280 + * This is a simple string property 281 281 + */ 282 282 + nullableProp1?: string | null; 283 283 + /** 284 284 + * This is a simple string property 285 285 + */ 286 286 + nullableRequiredProp1: string | null; 287 287 + /** 288 288 + * This is a simple string property 289 289 + */ 290 290 + nullableProp2?: string | null; 291 291 + /** 292 292 + * This is a simple string property 293 293 + */ 294 294 + nullableRequiredProp2: string | null; 295 295 + /** 296 296 + * This is a simple enum with strings 297 297 + */ 298 298 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 299 299 + }; 300 300 + 301 301 + /** 302 302 + * This is a model with one enum 303 303 + */ 304 304 + export type ModelWithEnum = { 305 305 + /** 306 306 + * This is a simple enum with strings 307 307 + */ 308 308 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 309 309 + /** 310 310 + * These are the HTTP error code enums 311 311 + */ 312 312 + statusCode?: '100' | '200 FOO' | '300 FOO_BAR' | '400 foo-bar' | '500 foo.bar' | '600 foo&bar'; 313 313 + /** 314 314 + * Simple boolean enum 315 315 + */ 316 316 + bool?: true; 317 317 + }; 318 318 + 319 319 + /** 320 320 + * This is a model with one enum with escaped name 321 321 + */ 322 322 + export type ModelWithEnumWithHyphen = { 323 323 + /** 324 324 + * Foo-Bar-Baz-Qux 325 325 + */ 326 326 + 'foo-bar-baz-qux'?: '3.0'; 327 327 + }; 328 328 + 329 329 + /** 330 330 + * This is a model with one enum 331 331 + */ 332 332 + export type ModelWithEnumFromDescription = { 333 333 + /** 334 334 + * Success=1,Warning=2,Error=3 335 335 + */ 336 336 + test?: number; 337 337 + }; 338 338 + 339 339 + /** 340 340 + * This is a model with nested enums 341 341 + */ 342 342 + export type ModelWithNestedEnums = { 343 343 + dictionaryWithEnum?: { 344 344 + [key: string]: 'Success' | 'Warning' | 'Error'; 345 345 + }; 346 346 + dictionaryWithEnumFromDescription?: { 347 347 + [key: string]: number; 348 348 + }; 349 349 + arrayWithEnum?: Array<'Success' | 'Warning' | 'Error'>; 350 350 + arrayWithDescription?: Array<number>; 351 351 + /** 352 352 + * This is a simple enum with strings 353 353 + */ 354 354 + 'foo_bar-enum'?: 'Success' | 'Warning' | 'Error' | 'ØÆÅ字符串'; 355 355 + }; 356 356 + 357 357 + /** 358 358 + * This is a model with one property containing a reference 359 359 + */ 360 360 + export type ModelWithReference = { 361 361 + prop?: ModelWithProperties; 362 362 + }; 363 363 + 364 364 + /** 365 365 + * This is a model with one property containing an array 366 366 + */ 367 367 + export type ModelWithArrayReadOnlyAndWriteOnly = { 368 368 + prop?: Array<ModelWithReadOnlyAndWriteOnly>; 369 369 + propWithFile?: Array<Blob | File>; 370 370 + propWithNumber?: Array<number>; 371 371 + }; 372 372 + 373 373 + /** 374 374 + * This is a model with one property containing an array 375 375 + */ 376 376 + export type ModelWithArray = { 377 377 + prop?: Array<ModelWithString>; 378 378 + propWithFile?: Array<Blob | File>; 379 379 + propWithNumber?: Array<number>; 380 380 + }; 381 381 + 382 382 + /** 383 383 + * This is a model with one property containing a dictionary 384 384 + */ 385 385 + export type ModelWithDictionary = { 386 386 + prop?: { 387 387 + [key: string]: string; 388 388 + }; 389 389 + }; 390 390 + 391 391 + /** 392 392 + * This is a deprecated model with a deprecated property 393 393 + * 394 394 + * @deprecated 395 395 + */ 396 396 + export type DeprecatedModel = { 397 397 + /** 398 398 + * This is a deprecated property 399 399 + * 400 400 + * @deprecated 401 401 + */ 402 402 + prop?: string; 403 403 + }; 404 404 + 405 405 + /** 406 406 + * This is a model with one property containing a circular reference 407 407 + */ 408 408 + export type ModelWithCircularReference = { 409 409 + prop?: ModelWithCircularReference; 410 410 + }; 411 411 + 412 412 + /** 413 413 + * This is a model with one property with a 'one of' relationship 414 414 + */ 415 415 + export type CompositionWithOneOf = { 416 416 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 417 417 + }; 418 418 + 419 419 + /** 420 420 + * This is a model with one property with a 'one of' relationship where the options are not $ref 421 421 + */ 422 422 + export type CompositionWithOneOfAnonymous = { 423 423 + propA?: { 424 424 + propA?: string; 425 425 + } | string | number; 426 426 + }; 427 427 + 428 428 + /** 429 429 + * Circle 430 430 + */ 431 431 + export type ModelCircle = { 432 432 + kind: string; 433 433 + radius?: number; 434 434 + }; 435 435 + 436 436 + /** 437 437 + * Square 438 438 + */ 439 439 + export type ModelSquare = { 440 440 + kind: string; 441 441 + sideLength?: number; 442 442 + }; 443 443 + 444 444 + /** 445 445 + * This is a model with one property with a 'one of' relationship where the options are not $ref 446 446 + */ 447 447 + export type CompositionWithOneOfDiscriminator = ({ 448 448 + kind: 'circle'; 449 449 + } & ModelCircle) | ({ 450 450 + kind: 'square'; 451 451 + } & ModelSquare); 452 452 + 453 453 + /** 454 454 + * This is a model with one property with a 'any of' relationship 455 455 + */ 456 456 + export type CompositionWithAnyOf = { 457 457 + propA?: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 458 458 + }; 459 459 + 460 460 + /** 461 461 + * This is a model with one property with a 'any of' relationship where the options are not $ref 462 462 + */ 463 463 + export type CompositionWithAnyOfAnonymous = { 464 464 + propA?: { 465 465 + propA?: string; 466 466 + } | string | number; 467 467 + }; 468 468 + 469 469 + /** 470 470 + * This is a model with nested 'any of' property with a type null 471 471 + */ 472 472 + export type CompositionWithNestedAnyAndTypeNull = { 473 473 + propA?: Array<ModelWithDictionary | null> | Array<ModelWithArray | null>; 474 474 + }; 475 475 + 476 476 + export type _3eNum1Период = 'Bird' | 'Dog'; 477 477 + 478 478 + export type ConstValue = 'ConstValue'; 479 479 + 480 480 + /** 481 481 + * This is a model with one property with a 'any of' relationship where the options are not $ref 482 482 + */ 483 483 + export type CompositionWithNestedAnyOfAndNull = { 484 484 + /** 485 485 + * Scopes 486 486 + */ 487 487 + propA?: Array<_3eNum1Период | ConstValue> | null; 488 488 + }; 489 489 + 490 490 + /** 491 491 + * This is a model with one property with a 'one of' relationship 492 492 + */ 493 493 + export type CompositionWithOneOfAndNullable = { 494 494 + propA?: { 495 495 + boolean?: boolean; 496 496 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 497 497 + }; 498 498 + 499 499 + /** 500 500 + * This is a model that contains a simple dictionary within composition 501 501 + */ 502 502 + export type CompositionWithOneOfAndSimpleDictionary = { 503 503 + propA?: boolean | { 504 504 + [key: string]: number; 505 505 + }; 506 506 + }; 507 507 + 508 508 + /** 509 509 + * This is a model that contains a dictionary of simple arrays within composition 510 510 + */ 511 511 + export type CompositionWithOneOfAndSimpleArrayDictionary = { 512 512 + propA?: boolean | { 513 513 + [key: string]: Array<boolean>; 514 514 + }; 515 515 + }; 516 516 + 517 517 + /** 518 518 + * This is a model that contains a dictionary of complex arrays (composited) within composition 519 519 + */ 520 520 + export type CompositionWithOneOfAndComplexArrayDictionary = { 521 521 + propA?: boolean | { 522 522 + [key: string]: Array<number | string>; 523 523 + }; 524 524 + }; 525 525 + 526 526 + /** 527 527 + * This is a model with one property with a 'all of' relationship 528 528 + */ 529 529 + export type CompositionWithAllOfAndNullable = { 530 530 + propA?: ({ 531 531 + boolean?: boolean; 532 532 + } & ModelWithEnum & ModelWithArray & ModelWithDictionary) | null; 533 533 + }; 534 534 + 535 535 + /** 536 536 + * This is a model with one property with a 'any of' relationship 537 537 + */ 538 538 + export type CompositionWithAnyOfAndNullable = { 539 539 + propA?: { 540 540 + boolean?: boolean; 541 541 + } | ModelWithEnum | ModelWithArray | ModelWithDictionary | null; 542 542 + }; 543 543 + 544 544 + /** 545 545 + * This is a base model with two simple optional properties 546 546 + */ 547 547 + export type CompositionBaseModel = { 548 548 + firstName?: string; 549 549 + lastname?: string; 550 550 + }; 551 551 + 552 552 + /** 553 553 + * This is a model that extends the base model 554 554 + */ 555 555 + export type CompositionExtendedModel = CompositionBaseModel & { 556 556 + age: number; 557 557 + firstName: string; 558 558 + lastname: string; 559 559 + }; 560 560 + 561 561 + /** 562 562 + * This is a model with one nested property 563 563 + */ 564 564 + export type ModelWithProperties = { 565 565 + required: string; 566 566 + readonly requiredAndReadOnly: string; 567 567 + requiredAndNullable: string | null; 568 568 + string?: string; 569 569 + number?: number; 570 570 + boolean?: boolean; 571 571 + reference?: ModelWithString; 572 572 + 'property with space'?: string; 573 573 + default?: string; 574 574 + try?: string; 575 575 + readonly '@namespace.string'?: string; 576 576 + readonly '@namespace.integer'?: number; 577 577 + }; 578 578 + 579 579 + /** 580 580 + * This is a model with one nested property 581 581 + */ 582 582 + export type ModelWithNestedProperties = { 583 583 + readonly first: { 584 584 + readonly second: { 585 585 + readonly third: string | null; 586 586 + } | null; 587 587 + } | null; 588 588 + }; 589 589 + 590 590 + /** 591 591 + * This is a model with duplicated properties 592 592 + */ 593 593 + export type ModelWithDuplicateProperties = { 594 594 + prop?: ModelWithString; 595 595 + }; 596 596 + 597 597 + /** 598 598 + * This is a model with ordered properties 599 599 + */ 600 600 + export type ModelWithOrderedProperties = { 601 601 + zebra?: string; 602 602 + apple?: string; 603 603 + hawaii?: string; 604 604 + }; 605 605 + 606 606 + /** 607 607 + * This is a model with duplicated imports 608 608 + */ 609 609 + export type ModelWithDuplicateImports = { 610 610 + propA?: ModelWithString; 611 611 + propB?: ModelWithString; 612 612 + propC?: ModelWithString; 613 613 + }; 614 614 + 615 615 + /** 616 616 + * This is a model that extends another model 617 617 + */ 618 618 + export type ModelThatExtends = ModelWithString & { 619 619 + propExtendsA?: string; 620 620 + propExtendsB?: ModelWithString; 621 621 + }; 622 622 + 623 623 + /** 624 624 + * This is a model that extends another model 625 625 + */ 626 626 + export type ModelThatExtendsExtends = ModelWithString & ModelThatExtends & { 627 627 + propExtendsC?: string; 628 628 + propExtendsD?: ModelWithString; 629 629 + }; 630 630 + 631 631 + /** 632 632 + * This is a model that contains a some patterns 633 633 + */ 634 634 + export type ModelWithPattern = { 635 635 + key: string; 636 636 + name: string; 637 637 + readonly enabled?: boolean; 638 638 + readonly modified?: string; 639 639 + id?: string; 640 640 + text?: string; 641 641 + patternWithSingleQuotes?: string; 642 642 + patternWithNewline?: string; 643 643 + patternWithBacktick?: string; 644 644 + }; 645 645 + 646 646 + export type File = { 647 647 + /** 648 648 + * Id 649 649 + */ 650 650 + readonly id?: string; 651 651 + /** 652 652 + * Updated at 653 653 + */ 654 654 + readonly updated_at?: string; 655 655 + /** 656 656 + * Created at 657 657 + */ 658 658 + readonly created_at?: string; 659 659 + /** 660 660 + * Mime 661 661 + */ 662 662 + mime: string; 663 663 + /** 664 664 + * File 665 665 + */ 666 666 + readonly file?: string; 667 667 + }; 668 668 + 669 669 + export type Default = { 670 670 + name?: string; 671 671 + }; 672 672 + 673 673 + export type Pageable = { 674 674 + page?: number; 675 675 + size?: number; 676 676 + sort?: Array<string>; 677 677 + }; 678 678 + 679 679 + /** 680 680 + * This is a free-form object without additionalProperties. 681 681 + */ 682 682 + export type FreeFormObjectWithoutAdditionalProperties = { 683 683 + [key: string]: unknown; 684 684 + }; 685 685 + 686 686 + /** 687 687 + * This is a free-form object with additionalProperties: true. 688 688 + */ 689 689 + export type FreeFormObjectWithAdditionalPropertiesEqTrue = { 690 690 + [key: string]: unknown; 691 691 + }; 692 692 + 693 693 + /** 694 694 + * This is a free-form object with additionalProperties: {}. 695 695 + */ 696 696 + export type FreeFormObjectWithAdditionalPropertiesEqEmptyObject = { 697 697 + [key: string]: unknown; 698 698 + }; 699 699 + 700 700 + export type ModelWithConst = { 701 701 + String?: 'String'; 702 702 + number?: 0; 703 703 + null?: null; 704 704 + withType?: 'Some string'; 705 705 + }; 706 706 + 707 707 + /** 708 708 + * This is a model with one property and additionalProperties: true 709 709 + */ 710 710 + export type ModelWithAdditionalPropertiesEqTrue = { 711 711 + /** 712 712 + * This is a simple string property 713 713 + */ 714 714 + prop?: string; 715 715 + [key: string]: unknown | string | undefined; 716 716 + }; 717 717 + 718 718 + export type NestedAnyOfArraysNullable = { 719 719 + nullableArray?: Array<string | boolean> | null; 720 720 + }; 721 721 + 722 722 + export type CompositionWithOneOfAndProperties = ({ 723 723 + foo: SimpleParameter; 724 724 + } | { 725 725 + bar: NonAsciiStringæøåÆøÅöôêÊ字符串; 726 726 + }) & { 727 727 + baz: number | null; 728 728 + qux: number; 729 729 + }; 730 730 + 731 731 + /** 732 732 + * An object that can be null 733 733 + */ 734 734 + export type NullableObject = { 735 735 + foo?: string; 736 736 + } | null; 737 737 + 738 738 + /** 739 739 + * Some % character 740 740 + */ 741 741 + export type CharactersInDescription = string; 742 742 + 743 743 + export type ModelWithNullableObject = { 744 744 + data?: NullableObject; 745 745 + }; 746 746 + 747 747 + export type ModelWithOneOfEnum = { 748 748 + foo: 'Bar'; 749 749 + } | { 750 750 + foo: 'Baz'; 751 751 + } | { 752 752 + foo: 'Qux'; 753 753 + } | { 754 754 + content: string; 755 755 + foo: 'Quux'; 756 756 + } | { 757 757 + content: [ 758 758 + string, 759 759 + string 760 760 + ]; 761 761 + foo: 'Corge'; 762 762 + }; 763 763 + 764 764 + export type ModelWithNestedArrayEnumsDataFoo = 'foo' | 'bar'; 765 765 + 766 766 + export type ModelWithNestedArrayEnumsDataBar = 'baz' | 'qux'; 767 767 + 768 768 + export type ModelWithNestedArrayEnumsData = { 769 769 + foo?: Array<ModelWithNestedArrayEnumsDataFoo>; 770 770 + bar?: Array<ModelWithNestedArrayEnumsDataBar>; 771 771 + }; 772 772 + 773 773 + export type ModelWithNestedArrayEnums = { 774 774 + array_strings?: Array<string>; 775 775 + data?: ModelWithNestedArrayEnumsData; 776 776 + }; 777 777 + 778 778 + export type ModelWithNestedCompositionEnums = { 779 779 + foo?: ModelWithNestedArrayEnumsDataFoo; 780 780 + }; 781 781 + 782 782 + export type ModelWithReadOnlyAndWriteOnly = { 783 783 + foo: string; 784 784 + readonly bar: string; 785 785 + }; 786 786 + 787 787 + export type ModelWithConstantSizeArray = [ 788 788 + number, 789 789 + number 790 790 + ]; 791 791 + 792 792 + export type ModelWithAnyOfConstantSizeArray = [ 793 793 + number | string, 794 794 + number | string, 795 795 + number | string 796 796 + ]; 797 797 + 798 798 + export type ModelWithPrefixItemsConstantSizeArray = [ 799 799 + ModelWithInteger, 800 800 + number | string, 801 801 + string 802 802 + ]; 803 803 + 804 804 + export type ModelWithAnyOfConstantSizeArrayNullable = [ 805 805 + number | null | string, 806 806 + number | null | string, 807 807 + number | null | string 808 808 + ]; 809 809 + 810 810 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptions = [ 811 811 + number | Import, 812 812 + number | Import 813 813 + ]; 814 814 + 815 815 + export type ModelWithAnyOfConstantSizeArrayAndIntersect = [ 816 816 + number & string, 817 817 + number & string 818 818 + ]; 819 819 + 820 820 + export type ModelWithNumericEnumUnion = { 821 821 + /** 822 822 + * Период 823 823 + */ 824 824 + value?: -10 | -1 | 0 | 1 | 3 | 6 | 12; 825 825 + }; 826 826 + 827 827 + /** 828 828 + * Some description with `back ticks` 829 829 + */ 830 830 + export type ModelWithBackticksInDescription = { 831 831 + /** 832 832 + * The template `that` should be used for parsing and importing the contents of the CSV file. 833 833 + * 834 834 + * <br/><p>There is one placeholder currently supported:<ul> <li><b>${x}</b> - refers to the n-th column in the CSV file, e.g. ${1}, ${2}, ...)</li></ul><p>Example of a correct JSON template:</p> 835 835 + * <pre> 836 836 + * [ 837 837 + * { 838 838 + * "resourceType": "Asset", 839 839 + * "identifier": { 840 840 + * "name": "${1}", 841 841 + * "domain": { 842 842 + * "name": "${2}", 843 843 + * "community": { 844 844 + * "name": "Some Community" 845 845 + * } 846 846 + * } 847 847 + * }, 848 848 + * "attributes" : { 849 849 + * "00000000-0000-0000-0000-000000003115" : [ { 850 850 + * "value" : "${3}" 851 851 + * } ], 852 852 + * "00000000-0000-0000-0000-000000000222" : [ { 853 853 + * "value" : "${4}" 854 854 + * } ] 855 855 + * } 856 856 + * } 857 857 + * ] 858 858 + * </pre> 859 859 + */ 860 860 + template?: string; 861 861 + }; 862 862 + 863 863 + export type ModelWithOneOfAndProperties = (SimpleParameter | NonAsciiStringæøåÆøÅöôêÊ字符串) & { 864 864 + baz: number | null; 865 865 + qux: number; 866 866 + }; 867 867 + 868 868 + /** 869 869 + * Model used to test deduplication strategy (unused) 870 870 + */ 871 871 + export type ParameterSimpleParameterUnused = string; 872 872 + 873 873 + /** 874 874 + * Model used to test deduplication strategy 875 875 + */ 876 876 + export type PostServiceWithEmptyTagResponse = string; 877 877 + 878 878 + /** 879 879 + * Model used to test deduplication strategy 880 880 + */ 881 881 + export type PostServiceWithEmptyTagResponse2 = string; 882 882 + 883 883 + /** 884 884 + * Model used to test deduplication strategy 885 885 + */ 886 886 + export type DeleteFooData = string; 887 887 + 888 888 + /** 889 889 + * Model used to test deduplication strategy 890 890 + */ 891 891 + export type DeleteFooData2 = string; 892 892 + 893 893 + /** 894 894 + * Model with restricted keyword name 895 895 + */ 896 896 + export type Import = string; 897 897 + 898 898 + export type SchemaWithFormRestrictedKeys = { 899 899 + description?: string; 900 900 + 'x-enum-descriptions'?: string; 901 901 + 'x-enum-varnames'?: string; 902 902 + 'x-enumNames'?: string; 903 903 + title?: string; 904 904 + object?: { 905 905 + description?: string; 906 906 + 'x-enum-descriptions'?: string; 907 907 + 'x-enum-varnames'?: string; 908 908 + 'x-enumNames'?: string; 909 909 + title?: string; 910 910 + }; 911 911 + array?: Array<{ 912 912 + description?: string; 913 913 + 'x-enum-descriptions'?: string; 914 914 + 'x-enum-varnames'?: string; 915 915 + 'x-enumNames'?: string; 916 916 + title?: string; 917 917 + }>; 918 918 + }; 919 919 + 920 920 + /** 921 921 + * This schema was giving PascalCase transformations a hard time 922 922 + */ 923 923 + export type IoK8sApimachineryPkgApisMetaV1DeleteOptions = { 924 924 + /** 925 925 + * Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned. 926 926 + */ 927 927 + preconditions?: IoK8sApimachineryPkgApisMetaV1Preconditions; 928 928 + }; 929 929 + 930 930 + /** 931 931 + * This schema was giving PascalCase transformations a hard time 932 932 + */ 933 933 + export type IoK8sApimachineryPkgApisMetaV1Preconditions = { 934 934 + /** 935 935 + * Specifies the target ResourceVersion 936 936 + */ 937 937 + resourceVersion?: string; 938 938 + /** 939 939 + * Specifies the target UID. 940 940 + */ 941 941 + uid?: string; 942 942 + }; 943 943 + 944 944 + export type AdditionalPropertiesUnknownIssue = { 945 945 + [key: string]: string | number; 946 946 + }; 947 947 + 948 948 + export type AdditionalPropertiesUnknownIssue2 = { 949 949 + [key: string]: string | number; 950 950 + }; 951 951 + 952 952 + export type AdditionalPropertiesUnknownIssue3 = string & { 953 953 + entries: { 954 954 + [key: string]: AdditionalPropertiesUnknownIssue; 955 955 + }; 956 956 + }; 957 957 + 958 958 + export type AdditionalPropertiesIntegerIssue = { 959 959 + value: number; 960 960 + [key: string]: number; 961 961 + }; 962 962 + 963 963 + export type OneOfAllOfIssue = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 964 964 + 965 965 + export type GenericSchemaDuplicateIssue1SystemBoolean = { 966 966 + item?: boolean; 967 967 + error?: string | null; 968 968 + readonly hasError?: boolean; 969 969 + data?: { 970 970 + [key: string]: never; 971 971 + }; 972 972 + }; 973 973 + 974 974 + export type GenericSchemaDuplicateIssue1SystemString = { 975 975 + item?: string | null; 976 976 + error?: string | null; 977 977 + readonly hasError?: boolean; 978 978 + }; 979 979 + 980 980 + export type ExternalSharedExternalSharedModel = { 981 981 + id: string; 982 982 + name?: string; 983 983 + }; 984 984 + 985 985 + /** 986 986 + * This is a model with one property containing a reference 987 987 + */ 988 988 + export type ModelWithReferenceWritable = { 989 989 + prop?: ModelWithPropertiesWritable; 990 990 + }; 991 991 + 992 992 + /** 993 993 + * This is a model with one property containing an array 994 994 + */ 995 995 + export type ModelWithArrayReadOnlyAndWriteOnlyWritable = { 996 996 + prop?: Array<ModelWithReadOnlyAndWriteOnlyWritable>; 997 997 + propWithFile?: Array<Blob | File>; 998 998 + propWithNumber?: Array<number>; 999 999 + }; 1000 1000 + 1001 1001 + /** 1002 1002 + * This is a model with one nested property 1003 1003 + */ 1004 1004 + export type ModelWithPropertiesWritable = { 1005 1005 + required: string; 1006 1006 + requiredAndNullable: string | null; 1007 1007 + string?: string; 1008 1008 + number?: number; 1009 1009 + boolean?: boolean; 1010 1010 + reference?: ModelWithString; 1011 1011 + 'property with space'?: string; 1012 1012 + default?: string; 1013 1013 + try?: string; 1014 1014 + }; 1015 1015 + 1016 1016 + /** 1017 1017 + * This is a model that contains a some patterns 1018 1018 + */ 1019 1019 + export type ModelWithPatternWritable = { 1020 1020 + key: string; 1021 1021 + name: string; 1022 1022 + id?: string; 1023 1023 + text?: string; 1024 1024 + patternWithSingleQuotes?: string; 1025 1025 + patternWithNewline?: string; 1026 1026 + patternWithBacktick?: string; 1027 1027 + }; 1028 1028 + 1029 1029 + export type FileWritable = { 1030 1030 + /** 1031 1031 + * Mime 1032 1032 + */ 1033 1033 + mime: string; 1034 1034 + }; 1035 1035 + 1036 1036 + export type ModelWithReadOnlyAndWriteOnlyWritable = { 1037 1037 + foo: string; 1038 1038 + baz: string; 1039 1039 + }; 1040 1040 + 1041 1041 + export type ModelWithAnyOfConstantSizeArrayWithNSizeAndOptionsWritable = [ 1042 1042 + number | Import, 1043 1043 + number | Import 1044 1044 + ]; 1045 1045 + 1046 1046 + export type AdditionalPropertiesUnknownIssueWritable = { 1047 1047 + [key: string]: string | number; 1048 1048 + }; 1049 1049 + 1050 1050 + export type OneOfAllOfIssueWritable = ((ConstValue | GenericSchemaDuplicateIssue1SystemBoolean) & _3eNum1Период) | GenericSchemaDuplicateIssue1SystemString; 1051 1051 + 1052 1052 + export type GenericSchemaDuplicateIssue1SystemBooleanWritable = { 1053 1053 + item?: boolean; 1054 1054 + error?: string | null; 1055 1055 + data?: { 1056 1056 + [key: string]: never; 1057 1057 + }; 1058 1058 + }; 1059 1059 + 1060 1060 + export type GenericSchemaDuplicateIssue1SystemStringWritable = { 1061 1061 + item?: string | null; 1062 1062 + error?: string | null; 1063 1063 + }; 1064 1064 + 1065 1065 + /** 1066 1066 + * This is a reusable parameter 1067 1067 + */ 1068 1068 + export type SimpleParameter = string; 1069 1069 + 1070 1070 + /** 1071 1071 + * Parameter with illegal characters 1072 1072 + */ 1073 1073 + export type XFooBar = ModelWithString; 1074 1074 + 1075 1075 + /** 1076 1076 + * A reusable request body 1077 1077 + */ 1078 1078 + export type SimpleRequestBody = ModelWithString; 1079 1079 + 1080 1080 + /** 1081 1081 + * A reusable request body 1082 1082 + */ 1083 1083 + export type SimpleFormData = ModelWithString; 1084 1084 + 1085 1085 + export type ExportData = { 1086 1086 + body?: never; 1087 1087 + path?: never; 1088 1088 + query?: never; 1089 1089 + url: '/api/v{api-version}/no+tag'; 1090 1090 + }; 1091 1091 + 1092 1092 + export type PatchApiVbyApiVersionNoTagData = { 1093 1093 + body?: never; 1094 1094 + path?: never; 1095 1095 + query?: never; 1096 1096 + url: '/api/v{api-version}/no+tag'; 1097 1097 + }; 1098 1098 + 1099 1099 + export type PatchApiVbyApiVersionNoTagResponses = { 1100 1100 + /** 1101 1101 + * OK 1102 1102 + */ 1103 1103 + default: unknown; 1104 1104 + }; 1105 1105 + 1106 1106 + export type ImportData = { 1107 1107 + body: ModelWithReadOnlyAndWriteOnlyWritable | ModelWithArrayReadOnlyAndWriteOnlyWritable; 1108 1108 + path?: never; 1109 1109 + query?: never; 1110 1110 + url: '/api/v{api-version}/no+tag'; 1111 1111 + }; 1112 1112 + 1113 1113 + export type ImportResponses = { 1114 1114 + /** 1115 1115 + * Success 1116 1116 + */ 1117 1117 + 200: ModelFromZendesk; 1118 1118 + /** 1119 1119 + * Default success response 1120 1120 + */ 1121 1121 + default: ModelWithReadOnlyAndWriteOnly; 1122 1122 + }; 1123 1123 + 1124 1124 + export type ImportResponse = ImportResponses[keyof ImportResponses]; 1125 1125 + 1126 1126 + export type FooWowData = { 1127 1127 + body?: never; 1128 1128 + path?: never; 1129 1129 + query?: never; 1130 1130 + url: '/api/v{api-version}/no+tag'; 1131 1131 + }; 1132 1132 + 1133 1133 + export type FooWowResponses = { 1134 1134 + /** 1135 1135 + * OK 1136 1136 + */ 1137 1137 + default: unknown; 1138 1138 + }; 1139 1139 + 1140 1140 + export type ApiVVersionODataControllerCountData = { 1141 1141 + body?: never; 1142 1142 + path?: never; 1143 1143 + query?: never; 1144 1144 + url: '/api/v{api-version}/simple/$count'; 1145 1145 + }; 1146 1146 + 1147 1147 + export type ApiVVersionODataControllerCountResponses = { 1148 1148 + /** 1149 1149 + * Success 1150 1150 + */ 1151 1151 + 200: ModelFromZendesk; 1152 1152 + }; 1153 1153 + 1154 1154 + export type ApiVVersionODataControllerCountResponse = ApiVVersionODataControllerCountResponses[keyof ApiVVersionODataControllerCountResponses]; 1155 1155 + 1156 1156 + export type GetApiVbyApiVersionSimpleOperationData = { 1157 1157 + body?: never; 1158 1158 + path: { 1159 1159 + /** 1160 1160 + * foo in method 1161 1161 + */ 1162 1162 + foo_param: string; 1163 1163 + }; 1164 1164 + query?: never; 1165 1165 + url: '/api/v{api-version}/simple:operation'; 1166 1166 + }; 1167 1167 + 1168 1168 + export type GetApiVbyApiVersionSimpleOperationErrors = { 1169 1169 + /** 1170 1170 + * Default error response 1171 1171 + */ 1172 1172 + default: ModelWithBoolean; 1173 1173 + }; 1174 1174 + 1175 1175 + export type GetApiVbyApiVersionSimpleOperationError = GetApiVbyApiVersionSimpleOperationErrors[keyof GetApiVbyApiVersionSimpleOperationErrors]; 1176 1176 + 1177 1177 + export type GetApiVbyApiVersionSimpleOperationResponses = { 1178 1178 + /** 1179 1179 + * Response is a simple number 1180 1180 + */ 1181 1181 + 200: number; 1182 1182 + }; 1183 1183 + 1184 1184 + export type GetApiVbyApiVersionSimpleOperationResponse = GetApiVbyApiVersionSimpleOperationResponses[keyof GetApiVbyApiVersionSimpleOperationResponses]; 1185 1185 + 1186 1186 + export type DeleteCallWithoutParametersAndResponseData = { 1187 1187 + body?: never; 1188 1188 + path?: never; 1189 1189 + query?: never; 1190 1190 + url: '/api/v{api-version}/simple'; 1191 1191 + }; 1192 1192 + 1193 1193 + export type GetCallWithoutParametersAndResponseData = { 1194 1194 + body?: never; 1195 1195 + path?: never; 1196 1196 + query?: never; 1197 1197 + url: '/api/v{api-version}/simple'; 1198 1198 + }; 1199 1199 + 1200 1200 + export type HeadCallWithoutParametersAndResponseData = { 1201 1201 + body?: never; 1202 1202 + path?: never; 1203 1203 + query?: never; 1204 1204 + url: '/api/v{api-version}/simple'; 1205 1205 + }; 1206 1206 + 1207 1207 + export type OptionsCallWithoutParametersAndResponseData = { 1208 1208 + body?: never; 1209 1209 + path?: never; 1210 1210 + query?: never; 1211 1211 + url: '/api/v{api-version}/simple'; 1212 1212 + }; 1213 1213 + 1214 1214 + export type PatchCallWithoutParametersAndResponseData = { 1215 1215 + body?: never; 1216 1216 + path?: never; 1217 1217 + query?: never; 1218 1218 + url: '/api/v{api-version}/simple'; 1219 1219 + }; 1220 1220 + 1221 1221 + export type PostCallWithoutParametersAndResponseData = { 1222 1222 + body?: never; 1223 1223 + path?: never; 1224 1224 + query?: never; 1225 1225 + url: '/api/v{api-version}/simple'; 1226 1226 + }; 1227 1227 + 1228 1228 + export type PutCallWithoutParametersAndResponseData = { 1229 1229 + body?: never; 1230 1230 + path?: never; 1231 1231 + query?: never; 1232 1232 + url: '/api/v{api-version}/simple'; 1233 1233 + }; 1234 1234 + 1235 1235 + export type DeleteFooData3 = { 1236 1236 + body?: never; 1237 1237 + headers: { 1238 1238 + /** 1239 1239 + * Parameter with illegal characters 1240 1240 + */ 1241 1241 + 'x-Foo-Bar': ModelWithString; 1242 1242 + }; 1243 1243 + path: { 1244 1244 + /** 1245 1245 + * foo in method 1246 1246 + */ 1247 1247 + foo_param: string; 1248 1248 + /** 1249 1249 + * bar in method 1250 1250 + */ 1251 1251 + BarParam: string; 1252 1252 + }; 1253 1253 + query?: never; 1254 1254 + url: '/api/v{api-version}/foo/{foo_param}/bar/{BarParam}'; 1255 1255 + }; 1256 1256 + 1257 1257 + export type CallWithDescriptionsData = { 1258 1258 + body?: never; 1259 1259 + path?: never; 1260 1260 + query?: { 1261 1261 + /** 1262 1262 + * Testing multiline comments in string: First line 1263 1263 + * Second line 1264 1264 + * 1265 1265 + * Fourth line 1266 1266 + */ 1267 1267 + parameterWithBreaks?: string; 1268 1268 + /** 1269 1269 + * Testing backticks in string: `backticks` and ```multiple backticks``` should work 1270 1270 + */ 1271 1271 + parameterWithBackticks?: string; 1272 1272 + /** 1273 1273 + * Testing slashes in string: \backwards\\\ and /forwards/// should work 1274 1274 + */ 1275 1275 + parameterWithSlashes?: string; 1276 1276 + /** 1277 1277 + * Testing expression placeholders in string: ${expression} should work 1278 1278 + */ 1279 1279 + parameterWithExpressionPlaceholders?: string; 1280 1280 + /** 1281 1281 + * Testing quotes in string: 'single quote''' and "double quotes""" should work 1282 1282 + */ 1283 1283 + parameterWithQuotes?: string; 1284 1284 + /** 1285 1285 + * Testing reserved characters in string: * inline * and ** inline ** should work 1286 1286 + */ 1287 1287 + parameterWithReservedCharacters?: string; 1288 1288 + }; 1289 1289 + url: '/api/v{api-version}/descriptions'; 1290 1290 + }; 1291 1291 + 1292 1292 + export type DeprecatedCallData = { 1293 1293 + body?: never; 1294 1294 + headers: { 1295 1295 + /** 1296 1296 + * This parameter is deprecated 1297 1297 + * 1298 1298 + * @deprecated 1299 1299 + */ 1300 1300 + parameter: DeprecatedModel | null; 1301 1301 + }; 1302 1302 + path?: never; 1303 1303 + query?: never; 1304 1304 + url: '/api/v{api-version}/parameters/deprecated'; 1305 1305 + }; 1306 1306 + 1307 1307 + export type CallWithParametersData = { 1308 1308 + /** 1309 1309 + * This is the parameter that goes into the body 1310 1310 + */ 1311 1311 + body: { 1312 1312 + [key: string]: unknown; 1313 1313 + } | null; 1314 1314 + headers: { 1315 1315 + /** 1316 1316 + * This is the parameter that goes into the header 1317 1317 + */ 1318 1318 + parameterHeader: string | null; 1319 1319 + }; 1320 1320 + path: { 1321 1321 + /** 1322 1322 + * This is the parameter that goes into the path 1323 1323 + */ 1324 1324 + parameterPath: string | null; 1325 1325 + /** 1326 1326 + * api-version should be required in standalone clients 1327 1327 + */ 1328 1328 + 'api-version': string | null; 1329 1329 + }; 1330 1330 + query: { 1331 1331 + foo_ref_enum?: ModelWithNestedArrayEnumsDataFoo; 1332 1332 + foo_all_of_enum: ModelWithNestedArrayEnumsDataFoo; 1333 1333 + /** 1334 1334 + * This is the parameter that goes into the query params 1335 1335 + */ 1336 1336 + cursor: string | null; 1337 1337 + }; 1338 1338 + url: '/api/v{api-version}/parameters/{parameterPath}'; 1339 1339 + }; 1340 1340 + 1341 1341 + export type CallWithWeirdParameterNamesData = { 1342 1342 + /** 1343 1343 + * This is the parameter that goes into the body 1344 1344 + */ 1345 1345 + body: ModelWithString | null; 1346 1346 + headers: { 1347 1347 + /** 1348 1348 + * This is the parameter that goes into the request header 1349 1349 + */ 1350 1350 + 'parameter.header': string | null; 1351 1351 + }; 1352 1352 + path: { 1353 1353 + /** 1354 1354 + * This is the parameter that goes into the path 1355 1355 + */ 1356 1356 + 'parameter.path.1'?: string; 1357 1357 + /** 1358 1358 + * This is the parameter that goes into the path 1359 1359 + */ 1360 1360 + 'parameter-path-2'?: string; 1361 1361 + /** 1362 1362 + * This is the parameter that goes into the path 1363 1363 + */ 1364 1364 + 'PARAMETER-PATH-3'?: string; 1365 1365 + /** 1366 1366 + * api-version should be required in standalone clients 1367 1367 + */ 1368 1368 + 'api-version': string | null; 1369 1369 + }; 1370 1370 + query: { 1371 1371 + /** 1372 1372 + * This is the parameter with a reserved keyword 1373 1373 + */ 1374 1374 + default?: string; 1375 1375 + /** 1376 1376 + * This is the parameter that goes into the request query params 1377 1377 + */ 1378 1378 + 'parameter-query': string | null; 1379 1379 + }; 1380 1380 + url: '/api/v{api-version}/parameters/{parameter.path.1}/{parameter-path-2}/{PARAMETER-PATH-3}'; 1381 1381 + }; 1382 1382 + 1383 1383 + export type GetCallWithOptionalParamData = { 1384 1384 + /** 1385 1385 + * This is a required parameter 1386 1386 + */ 1387 1387 + body: ModelWithOneOfEnum; 1388 1388 + path?: never; 1389 1389 + query?: { 1390 1390 + /** 1391 1391 + * This is an optional parameter 1392 1392 + */ 1393 1393 + page?: number; 1394 1394 + }; 1395 1395 + url: '/api/v{api-version}/parameters'; 1396 1396 + }; 1397 1397 + 1398 1398 + export type PostCallWithOptionalParamData = { 1399 1399 + /** 1400 1400 + * This is an optional parameter 1401 1401 + */ 1402 1402 + body?: { 1403 1403 + offset?: number | null; 1404 1404 + }; 1405 1405 + path?: never; 1406 1406 + query: { 1407 1407 + /** 1408 1408 + * This is a required parameter 1409 1409 + */ 1410 1410 + parameter: Pageable; 1411 1411 + }; 1412 1412 + url: '/api/v{api-version}/parameters'; 1413 1413 + }; 1414 1414 + 1415 1415 + export type PostCallWithOptionalParamResponses = { 1416 1416 + /** 1417 1417 + * Response is a simple number 1418 1418 + */ 1419 1419 + 200: number; 1420 1420 + /** 1421 1421 + * Success 1422 1422 + */ 1423 1423 + 204: void; 1424 1424 + }; 1425 1425 + 1426 1426 + export type PostCallWithOptionalParamResponse = PostCallWithOptionalParamResponses[keyof PostCallWithOptionalParamResponses]; 1427 1427 + 1428 1428 + export type PostApiVbyApiVersionRequestBodyData = { 1429 1429 + /** 1430 1430 + * A reusable request body 1431 1431 + */ 1432 1432 + body?: SimpleRequestBody; 1433 1433 + path?: never; 1434 1434 + query?: { 1435 1435 + /** 1436 1436 + * This is a reusable parameter 1437 1437 + */ 1438 1438 + parameter?: string; 1439 1439 + }; 1440 1440 + url: '/api/v{api-version}/requestBody'; 1441 1441 + }; 1442 1442 + 1443 1443 + export type PostApiVbyApiVersionFormDataData = { 1444 1444 + /** 1445 1445 + * A reusable request body 1446 1446 + */ 1447 1447 + body?: SimpleFormData; 1448 1448 + path?: never; 1449 1449 + query?: { 1450 1450 + /** 1451 1451 + * This is a reusable parameter 1452 1452 + */ 1453 1453 + parameter?: string; 1454 1454 + }; 1455 1455 + url: '/api/v{api-version}/formData'; 1456 1456 + }; 1457 1457 + 1458 1458 + export type CallWithDefaultParametersData = { 1459 1459 + body?: never; 1460 1460 + path?: never; 1461 1461 + query?: { 1462 1462 + /** 1463 1463 + * This is a simple string with default value 1464 1464 + */ 1465 1465 + parameterString?: string | null; 1466 1466 + /** 1467 1467 + * This is a simple number with default value 1468 1468 + */ 1469 1469 + parameterNumber?: number | null; 1470 1470 + /** 1471 1471 + * This is a simple boolean with default value 1472 1472 + */ 1473 1473 + parameterBoolean?: boolean | null; 1474 1474 + /** 1475 1475 + * This is a simple enum with default value 1476 1476 + */ 1477 1477 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1478 1478 + /** 1479 1479 + * This is a simple model with default value 1480 1480 + */ 1481 1481 + parameterModel?: ModelWithString | null; 1482 1482 + }; 1483 1483 + url: '/api/v{api-version}/defaults'; 1484 1484 + }; 1485 1485 + 1486 1486 + export type CallWithDefaultOptionalParametersData = { 1487 1487 + body?: never; 1488 1488 + path?: never; 1489 1489 + query?: { 1490 1490 + /** 1491 1491 + * This is a simple string that is optional with default value 1492 1492 + */ 1493 1493 + parameterString?: string; 1494 1494 + /** 1495 1495 + * This is a simple number that is optional with default value 1496 1496 + */ 1497 1497 + parameterNumber?: number; 1498 1498 + /** 1499 1499 + * This is a simple boolean that is optional with default value 1500 1500 + */ 1501 1501 + parameterBoolean?: boolean; 1502 1502 + /** 1503 1503 + * This is a simple enum that is optional with default value 1504 1504 + */ 1505 1505 + parameterEnum?: 'Success' | 'Warning' | 'Error'; 1506 1506 + /** 1507 1507 + * This is a simple model that is optional with default value 1508 1508 + */ 1509 1509 + parameterModel?: ModelWithString; 1510 1510 + }; 1511 1511 + url: '/api/v{api-version}/defaults'; 1512 1512 + }; 1513 1513 + 1514 1514 + export type CallToTestOrderOfParamsData = { 1515 1515 + body?: never; 1516 1516 + path?: never; 1517 1517 + query: { 1518 1518 + /** 1519 1519 + * This is a optional string with default 1520 1520 + */ 1521 1521 + parameterOptionalStringWithDefault?: string; 1522 1522 + /** 1523 1523 + * This is a optional string with empty default 1524 1524 + */ 1525 1525 + parameterOptionalStringWithEmptyDefault?: string; 1526 1526 + /** 1527 1527 + * This is a optional string with no default 1528 1528 + */ 1529 1529 + parameterOptionalStringWithNoDefault?: string; 1530 1530 + /** 1531 1531 + * This is a string with default 1532 1532 + */ 1533 1533 + parameterStringWithDefault: string; 1534 1534 + /** 1535 1535 + * This is a string with empty default 1536 1536 + */ 1537 1537 + parameterStringWithEmptyDefault: string; 1538 1538 + /** 1539 1539 + * This is a string with no default 1540 1540 + */ 1541 1541 + parameterStringWithNoDefault: string; 1542 1542 + /** 1543 1543 + * This is a string that can be null with no default 1544 1544 + */ 1545 1545 + parameterStringNullableWithNoDefault?: string | null; 1546 1546 + /** 1547 1547 + * This is a string that can be null with default 1548 1548 + */ 1549 1549 + parameterStringNullableWithDefault?: string | null; 1550 1550 + }; 1551 1551 + url: '/api/v{api-version}/defaults'; 1552 1552 + }; 1553 1553 + 1554 1554 + export type DuplicateNameData = { 1555 1555 + body?: never; 1556 1556 + path?: never; 1557 1557 + query?: never; 1558 1558 + url: '/api/v{api-version}/duplicate'; 1559 1559 + }; 1560 1560 + 1561 1561 + export type DuplicateName2Data = { 1562 1562 + body?: never; 1563 1563 + path?: never; 1564 1564 + query?: never; 1565 1565 + url: '/api/v{api-version}/duplicate'; 1566 1566 + }; 1567 1567 + 1568 1568 + export type DuplicateName3Data = { 1569 1569 + body?: never; 1570 1570 + path?: never; 1571 1571 + query?: never; 1572 1572 + url: '/api/v{api-version}/duplicate'; 1573 1573 + }; 1574 1574 + 1575 1575 + export type DuplicateName4Data = { 1576 1576 + body?: never; 1577 1577 + path?: never; 1578 1578 + query?: never; 1579 1579 + url: '/api/v{api-version}/duplicate'; 1580 1580 + }; 1581 1581 + 1582 1582 + export type CallWithNoContentResponseData = { 1583 1583 + body?: never; 1584 1584 + path?: never; 1585 1585 + query?: never; 1586 1586 + url: '/api/v{api-version}/no-content'; 1587 1587 + }; 1588 1588 + 1589 1589 + export type CallWithNoContentResponseResponses = { 1590 1590 + /** 1591 1591 + * Success 1592 1592 + */ 1593 1593 + 204: void; 1594 1594 + }; 1595 1595 + 1596 1596 + export type CallWithNoContentResponseResponse = CallWithNoContentResponseResponses[keyof CallWithNoContentResponseResponses]; 1597 1597 + 1598 1598 + export type CallWithResponseAndNoContentResponseData = { 1599 1599 + body?: never; 1600 1600 + path?: never; 1601 1601 + query?: never; 1602 1602 + url: '/api/v{api-version}/multiple-tags/response-and-no-content'; 1603 1603 + }; 1604 1604 + 1605 1605 + export type CallWithResponseAndNoContentResponseResponses = { 1606 1606 + /** 1607 1607 + * Response is a simple number 1608 1608 + */ 1609 1609 + 200: number; 1610 1610 + /** 1611 1611 + * Success 1612 1612 + */ 1613 1613 + 204: void; 1614 1614 + }; 1615 1615 + 1616 1616 + export type CallWithResponseAndNoContentResponseResponse = CallWithResponseAndNoContentResponseResponses[keyof CallWithResponseAndNoContentResponseResponses]; 1617 1617 + 1618 1618 + export type DummyAData = { 1619 1619 + body?: never; 1620 1620 + path?: never; 1621 1621 + query?: never; 1622 1622 + url: '/api/v{api-version}/multiple-tags/a'; 1623 1623 + }; 1624 1624 + 1625 1625 + export type DummyAResponses = { 1626 1626 + 200: _400; 1627 1627 + }; 1628 1628 + 1629 1629 + export type DummyAResponse = DummyAResponses[keyof DummyAResponses]; 1630 1630 + 1631 1631 + export type DummyBData = { 1632 1632 + body?: never; 1633 1633 + path?: never; 1634 1634 + query?: never; 1635 1635 + url: '/api/v{api-version}/multiple-tags/b'; 1636 1636 + }; 1637 1637 + 1638 1638 + export type DummyBResponses = { 1639 1639 + /** 1640 1640 + * Success 1641 1641 + */ 1642 1642 + 204: void; 1643 1643 + }; 1644 1644 + 1645 1645 + export type DummyBResponse = DummyBResponses[keyof DummyBResponses]; 1646 1646 + 1647 1647 + export type CallWithResponseData = { 1648 1648 + body?: never; 1649 1649 + path?: never; 1650 1650 + query?: never; 1651 1651 + url: '/api/v{api-version}/response'; 1652 1652 + }; 1653 1653 + 1654 1654 + export type CallWithResponseResponses = { 1655 1655 + default: Import; 1656 1656 + }; 1657 1657 + 1658 1658 + export type CallWithResponseResponse = CallWithResponseResponses[keyof CallWithResponseResponses]; 1659 1659 + 1660 1660 + export type CallWithDuplicateResponsesData = { 1661 1661 + body?: never; 1662 1662 + path?: never; 1663 1663 + query?: never; 1664 1664 + url: '/api/v{api-version}/response'; 1665 1665 + }; 1666 1666 + 1667 1667 + export type CallWithDuplicateResponsesErrors = { 1668 1668 + /** 1669 1669 + * Message for 500 error 1670 1670 + */ 1671 1671 + 500: ModelWithStringError; 1672 1672 + /** 1673 1673 + * Message for 501 error 1674 1674 + */ 1675 1675 + 501: ModelWithStringError; 1676 1676 + /** 1677 1677 + * Message for 502 error 1678 1678 + */ 1679 1679 + 502: ModelWithStringError; 1680 1680 + /** 1681 1681 + * Message for 4XX errors 1682 1682 + */ 1683 1683 + '4XX': DictionaryWithArray; 1684 1684 + /** 1685 1685 + * Default error response 1686 1686 + */ 1687 1687 + default: ModelWithBoolean; 1688 1688 + }; 1689 1689 + 1690 1690 + export type CallWithDuplicateResponsesError = CallWithDuplicateResponsesErrors[keyof CallWithDuplicateResponsesErrors]; 1691 1691 + 1692 1692 + export type CallWithDuplicateResponsesResponses = { 1693 1693 + /** 1694 1694 + * Message for 200 response 1695 1695 + */ 1696 1696 + 200: ModelWithBoolean & ModelWithInteger; 1697 1697 + /** 1698 1698 + * Message for 201 response 1699 1699 + */ 1700 1700 + 201: ModelWithString; 1701 1701 + /** 1702 1702 + * Message for 202 response 1703 1703 + */ 1704 1704 + 202: ModelWithString; 1705 1705 + }; 1706 1706 + 1707 1707 + export type CallWithDuplicateResponsesResponse = CallWithDuplicateResponsesResponses[keyof CallWithDuplicateResponsesResponses]; 1708 1708 + 1709 1709 + export type CallWithResponsesData = { 1710 1710 + body?: never; 1711 1711 + path?: never; 1712 1712 + query?: never; 1713 1713 + url: '/api/v{api-version}/response'; 1714 1714 + }; 1715 1715 + 1716 1716 + export type CallWithResponsesErrors = { 1717 1717 + /** 1718 1718 + * Message for 500 error 1719 1719 + */ 1720 1720 + 500: ModelWithStringError; 1721 1721 + /** 1722 1722 + * Message for 501 error 1723 1723 + */ 1724 1724 + 501: ModelWithStringError; 1725 1725 + /** 1726 1726 + * Message for 502 error 1727 1727 + */ 1728 1728 + 502: ModelWithStringError; 1729 1729 + /** 1730 1730 + * Message for default response 1731 1731 + */ 1732 1732 + default: ModelWithStringError; 1733 1733 + }; 1734 1734 + 1735 1735 + export type CallWithResponsesError = CallWithResponsesErrors[keyof CallWithResponsesErrors]; 1736 1736 + 1737 1737 + export type CallWithResponsesResponses = { 1738 1738 + /** 1739 1739 + * Message for 200 response 1740 1740 + */ 1741 1741 + 200: { 1742 1742 + readonly '@namespace.string'?: string; 1743 1743 + readonly '@namespace.integer'?: number; 1744 1744 + readonly value?: Array<ModelWithString>; 1745 1745 + }; 1746 1746 + /** 1747 1747 + * Message for 201 response 1748 1748 + */ 1749 1749 + 201: ModelThatExtends; 1750 1750 + /** 1751 1751 + * Message for 202 response 1752 1752 + */ 1753 1753 + 202: ModelThatExtendsExtends; 1754 1754 + }; 1755 1755 + 1756 1756 + export type CallWithResponsesResponse = CallWithResponsesResponses[keyof CallWithResponsesResponses]; 1757 1757 + 1758 1758 + export type CollectionFormatData = { 1759 1759 + body?: never; 1760 1760 + path?: never; 1761 1761 + query: { 1762 1762 + /** 1763 1763 + * This is an array parameter that is sent as csv format (comma-separated values) 1764 1764 + */ 1765 1765 + parameterArrayCSV: Array<string> | null; 1766 1766 + /** 1767 1767 + * This is an array parameter that is sent as ssv format (space-separated values) 1768 1768 + */ 1769 1769 + parameterArraySSV: Array<string> | null; 1770 1770 + /** 1771 1771 + * This is an array parameter that is sent as tsv format (tab-separated values) 1772 1772 + */ 1773 1773 + parameterArrayTSV: Array<string> | null; 1774 1774 + /** 1775 1775 + * This is an array parameter that is sent as pipes format (pipe-separated values) 1776 1776 + */ 1777 1777 + parameterArrayPipes: Array<string> | null; 1778 1778 + /** 1779 1779 + * This is an array parameter that is sent as multi format (multiple parameter instances) 1780 1780 + */ 1781 1781 + parameterArrayMulti: Array<string> | null; 1782 1782 + }; 1783 1783 + url: '/api/v{api-version}/collectionFormat'; 1784 1784 + }; 1785 1785 + 1786 1786 + export type TypesData = { 1787 1787 + body?: never; 1788 1788 + path?: { 1789 1789 + /** 1790 1790 + * This is a number parameter 1791 1791 + */ 1792 1792 + id?: number; 1793 1793 + }; 1794 1794 + query: { 1795 1795 + /** 1796 1796 + * This is a number parameter 1797 1797 + */ 1798 1798 + parameterNumber: number; 1799 1799 + /** 1800 1800 + * This is a string parameter 1801 1801 + */ 1802 1802 + parameterString: string | null; 1803 1803 + /** 1804 1804 + * This is a boolean parameter 1805 1805 + */ 1806 1806 + parameterBoolean: boolean | null; 1807 1807 + /** 1808 1808 + * This is an object parameter 1809 1809 + */ 1810 1810 + parameterObject: { 1811 1811 + [key: string]: unknown; 1812 1812 + } | null; 1813 1813 + /** 1814 1814 + * This is an array parameter 1815 1815 + */ 1816 1816 + parameterArray: Array<string> | null; 1817 1817 + /** 1818 1818 + * This is a dictionary parameter 1819 1819 + */ 1820 1820 + parameterDictionary: { 1821 1821 + [key: string]: unknown; 1822 1822 + } | null; 1823 1823 + /** 1824 1824 + * This is an enum parameter 1825 1825 + */ 1826 1826 + parameterEnum: 'Success' | 'Warning' | 'Error' | null; 1827 1827 + }; 1828 1828 + url: '/api/v{api-version}/types'; 1829 1829 + }; 1830 1830 + 1831 1831 + export type TypesResponses = { 1832 1832 + /** 1833 1833 + * Response is a simple number 1834 1834 + */ 1835 1835 + 200: number; 1836 1836 + /** 1837 1837 + * Response is a simple string 1838 1838 + */ 1839 1839 + 201: string; 1840 1840 + /** 1841 1841 + * Response is a simple boolean 1842 1842 + */ 1843 1843 + 202: boolean; 1844 1844 + /** 1845 1845 + * Response is a simple object 1846 1846 + */ 1847 1847 + 203: { 1848 1848 + [key: string]: unknown; 1849 1849 + }; 1850 1850 + }; 1851 1851 + 1852 1852 + export type TypesResponse = TypesResponses[keyof TypesResponses]; 1853 1853 + 1854 1854 + export type UploadFileData = { 1855 1855 + body: Blob | File; 1856 1856 + path: { 1857 1857 + /** 1858 1858 + * api-version should be required in standalone clients 1859 1859 + */ 1860 1860 + 'api-version': string | null; 1861 1861 + }; 1862 1862 + query?: never; 1863 1863 + url: '/api/v{api-version}/upload'; 1864 1864 + }; 1865 1865 + 1866 1866 + export type UploadFileResponses = { 1867 1867 + 200: boolean; 1868 1868 + }; 1869 1869 + 1870 1870 + export type UploadFileResponse = UploadFileResponses[keyof UploadFileResponses]; 1871 1871 + 1872 1872 + export type FileResponseData = { 1873 1873 + body?: never; 1874 1874 + path: { 1875 1875 + id: string; 1876 1876 + /** 1877 1877 + * api-version should be required in standalone clients 1878 1878 + */ 1879 1879 + 'api-version': string; 1880 1880 + }; 1881 1881 + query?: never; 1882 1882 + url: '/api/v{api-version}/file/{id}'; 1883 1883 + }; 1884 1884 + 1885 1885 + export type FileResponseResponses = { 1886 1886 + /** 1887 1887 + * Success 1888 1888 + */ 1889 1889 + 200: Blob | File; 1890 1890 + }; 1891 1891 + 1892 1892 + export type FileResponseResponse = FileResponseResponses[keyof FileResponseResponses]; 1893 1893 + 1894 1894 + export type ComplexTypesData = { 1895 1895 + body?: never; 1896 1896 + path?: never; 1897 1897 + query: { 1898 1898 + /** 1899 1899 + * Parameter containing object 1900 1900 + */ 1901 1901 + parameterObject: { 1902 1902 + first?: { 1903 1903 + second?: { 1904 1904 + third?: string; 1905 1905 + }; 1906 1906 + }; 1907 1907 + }; 1908 1908 + /** 1909 1909 + * Parameter containing reference 1910 1910 + */ 1911 1911 + parameterReference: ModelWithString; 1912 1912 + }; 1913 1913 + url: '/api/v{api-version}/complex'; 1914 1914 + }; 1915 1915 + 1916 1916 + export type ComplexTypesErrors = { 1917 1917 + /** 1918 1918 + * 400 `server` error 1919 1919 + */ 1920 1920 + 400: unknown; 1921 1921 + /** 1922 1922 + * 500 server error 1923 1923 + */ 1924 1924 + 500: unknown; 1925 1925 + }; 1926 1926 + 1927 1927 + export type ComplexTypesResponses = { 1928 1928 + /** 1929 1929 + * Successful response 1930 1930 + */ 1931 1931 + 200: Array<ModelWithString>; 1932 1932 + }; 1933 1933 + 1934 1934 + export type ComplexTypesResponse = ComplexTypesResponses[keyof ComplexTypesResponses]; 1935 1935 + 1936 1936 + export type MultipartResponseData = { 1937 1937 + body?: never; 1938 1938 + path?: never; 1939 1939 + query?: never; 1940 1940 + url: '/api/v{api-version}/multipart'; 1941 1941 + }; 1942 1942 + 1943 1943 + export type MultipartResponseResponses = { 1944 1944 + /** 1945 1945 + * OK 1946 1946 + */ 1947 1947 + 200: { 1948 1948 + file?: Blob | File; 1949 1949 + metadata?: { 1950 1950 + foo?: string; 1951 1951 + bar?: string; 1952 1952 + }; 1953 1953 + }; 1954 1954 + }; 1955 1955 + 1956 1956 + export type MultipartResponseResponse = MultipartResponseResponses[keyof MultipartResponseResponses]; 1957 1957 + 1958 1958 + export type MultipartRequestData = { 1959 1959 + body?: { 1960 1960 + content?: Blob | File; 1961 1961 + data?: ModelWithString | null; 1962 1962 + }; 1963 1963 + path?: never; 1964 1964 + query?: never; 1965 1965 + url: '/api/v{api-version}/multipart'; 1966 1966 + }; 1967 1967 + 1968 1968 + export type ComplexParamsData = { 1969 1969 + body?: { 1970 1970 + readonly key: string | null; 1971 1971 + name: string | null; 1972 1972 + enabled?: boolean; 1973 1973 + type: 'Monkey' | 'Horse' | 'Bird'; 1974 1974 + listOfModels?: Array<ModelWithString> | null; 1975 1975 + listOfStrings?: Array<string> | null; 1976 1976 + parameters: ModelWithString | ModelWithEnum | ModelWithArray | ModelWithDictionary; 1977 1977 + readonly user?: { 1978 1978 + readonly id?: number; 1979 1979 + readonly name?: string | null; 1980 1980 + }; 1981 1981 + }; 1982 1982 + path: { 1983 1983 + id: number; 1984 1984 + /** 1985 1985 + * api-version should be required in standalone clients 1986 1986 + */ 1987 1987 + 'api-version': string; 1988 1988 + }; 1989 1989 + query?: never; 1990 1990 + url: '/api/v{api-version}/complex/{id}'; 1991 1991 + }; 1992 1992 + 1993 1993 + export type ComplexParamsResponses = { 1994 1994 + /** 1995 1995 + * Success 1996 1996 + */ 1997 1997 + 200: ModelWithString; 1998 1998 + }; 1999 1999 + 2000 2000 + export type ComplexParamsResponse = ComplexParamsResponses[keyof ComplexParamsResponses]; 2001 2001 + 2002 2002 + export type CallWithResultFromHeaderData = { 2003 2003 + body?: never; 2004 2004 + path?: never; 2005 2005 + query?: never; 2006 2006 + url: '/api/v{api-version}/header'; 2007 2007 + }; 2008 2008 + 2009 2009 + export type CallWithResultFromHeaderErrors = { 2010 2010 + /** 2011 2011 + * 400 server error 2012 2012 + */ 2013 2013 + 400: unknown; 2014 2014 + /** 2015 2015 + * 500 server error 2016 2016 + */ 2017 2017 + 500: unknown; 2018 2018 + }; 2019 2019 + 2020 2020 + export type CallWithResultFromHeaderResponses = { 2021 2021 + /** 2022 2022 + * Successful response 2023 2023 + */ 2024 2024 + 200: unknown; 2025 2025 + }; 2026 2026 + 2027 2027 + export type TestErrorCodeData = { 2028 2028 + body?: never; 2029 2029 + path?: never; 2030 2030 + query: { 2031 2031 + /** 2032 2032 + * Status code to return 2033 2033 + */ 2034 2034 + status: number; 2035 2035 + }; 2036 2036 + url: '/api/v{api-version}/error'; 2037 2037 + }; 2038 2038 + 2039 2039 + export type TestErrorCodeErrors = { 2040 2040 + /** 2041 2041 + * Custom message: Internal Server Error 2042 2042 + */ 2043 2043 + 500: unknown; 2044 2044 + /** 2045 2045 + * Custom message: Not Implemented 2046 2046 + */ 2047 2047 + 501: unknown; 2048 2048 + /** 2049 2049 + * Custom message: Bad Gateway 2050 2050 + */ 2051 2051 + 502: unknown; 2052 2052 + /** 2053 2053 + * Custom message: Service Unavailable 2054 2054 + */ 2055 2055 + 503: unknown; 2056 2056 + }; 2057 2057 + 2058 2058 + export type TestErrorCodeResponses = { 2059 2059 + /** 2060 2060 + * Custom message: Successful response 2061 2061 + */ 2062 2062 + 200: unknown; 2063 2063 + }; 2064 2064 + 2065 2065 + export type NonAsciiæøåÆøÅöôêÊ字符串Data = { 2066 2066 + body?: never; 2067 2067 + path?: never; 2068 2068 + query: { 2069 2069 + /** 2070 2070 + * Dummy input param 2071 2071 + */ 2072 2072 + nonAsciiParamæøåÆØÅöôêÊ: number; 2073 2073 + }; 2074 2074 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2075 2075 + }; 2076 2076 + 2077 2077 + export type NonAsciiæøåÆøÅöôêÊ字符串Responses = { 2078 2078 + /** 2079 2079 + * Successful response 2080 2080 + */ 2081 2081 + 200: Array<NonAsciiStringæøåÆøÅöôêÊ字符串>; 2082 2082 + }; 2083 2083 + 2084 2084 + export type NonAsciiæøåÆøÅöôêÊ字符串Response = NonAsciiæøåÆøÅöôêÊ字符串Responses[keyof NonAsciiæøåÆøÅöôêÊ字符串Responses]; 2085 2085 + 2086 2086 + export type PutWithFormUrlEncodedData = { 2087 2087 + body: ArrayWithStrings; 2088 2088 + path?: never; 2089 2089 + query?: never; 2090 2090 + url: '/api/v{api-version}/non-ascii-æøåÆØÅöôêÊ字符串'; 2091 2091 + };

+14

packages/openapi-ts-tests/main/test/clients.test.ts

··· 162 162 { 163 163 config: createConfig({ 164 164 output: { 165 165 + path: 'tsconfig-node16-sdk', 166 166 + tsConfigPath: path.join( 167 167 + __dirname, 168 168 + 'tsconfig', 169 169 + 'tsconfig.node16.json', 170 170 + ), 171 171 + }, 172 172 + plugins: [client, '@hey-api/sdk'], 173 173 + }), 174 174 + description: 'SDK with Node16 tsconfig', 175 175 + }, 176 176 + { 177 177 + config: createConfig({ 178 178 + output: { 165 179 importFileExtension: '.ts', 166 180 path: 'import-file-extension-ts', 167 181 },

+9

packages/openapi-ts-tests/main/test/tsconfig/tsconfig.node16.json

··· 1 1 + { 2 2 + "extends": "../../../tsconfig.base.json", 3 3 + "compilerOptions": { 4 4 + "declaration": false, 5 5 + "moduleResolution": "node16", 6 6 + "resolveJsonModule": true, 7 7 + "skipLibCheck": true 8 8 + } 9 9 + }

+4 -2

packages/openapi-ts/src/config/output.ts

··· 50 50 output.tsConfig = loadTsConfig(findTsConfigPath(output.tsConfigPath)); 51 51 if ( 52 52 output.importFileExtension === undefined && 53 53 - output.tsConfig?.options.moduleResolution === 54 54 - ts.ModuleResolutionKind.NodeNext 53 53 + (output.tsConfig?.options.moduleResolution === 54 54 + ts.ModuleResolutionKind.NodeNext || 55 55 + output.tsConfig?.options.moduleResolution === 56 56 + ts.ModuleResolutionKind.Node16) 55 57 ) { 56 58 output.importFileExtension = '.js'; 57 59 }

+4 -4

packages/openapi-ts/src/types/output.d.ts

··· 70 70 /** 71 71 * If specified, this will be the file extension used when importing 72 72 * other modules. By default, we don't add a file extension and let the 73 73 - * runtime resolve it. If you're using moduleResolution `nodenext`, we 74 74 - * default to `.js`. 73 73 + * runtime resolve it. If you're using moduleResolution `nodenext` or 74 74 + * `node16`, we default to `.js`. 75 75 * 76 76 * @default undefined 77 77 */ ··· 170 170 /** 171 171 * If specified, this will be the file extension used when importing 172 172 * other modules. By default, we don't add a file extension and let the 173 173 - * runtime resolve it. If you're using moduleResolution `nodenext`, we 174 174 - * default to `.js`. 173 173 + * runtime resolve it. If you're using moduleResolution `nodenext` or 174 174 + * `node16`, we default to `.js`. 175 175 */ 176 176 importFileExtension: ImportFileExtensions | (string & {}) | null | undefined; 177 177 /**