@scalar/oas-utils 0.2.43 → 0.2.45

package/dist/entities/spec/request-examples.d.ts

@@ -0,0 +1,916 @@
+import { z } from 'zod';
+import type { RequestParameter } from './parameters.js';
+import type { Request } from './requests.js';
+import type { Server } from './server.js';
+export declare const requestExampleParametersSchema: z.ZodObject<{
+    key: z.ZodDefault<z.ZodString>;
+    value: z.ZodDefault<z.ZodString>;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    file: z.ZodOptional<z.ZodAny>;
+    description: z.ZodOptional<z.ZodString>;
+    /** Params are linked to parents such as path params and global headers/cookies */
+    refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    type: z.ZodOptional<z.ZodString>;
+    format: z.ZodOptional<z.ZodString>;
+    minimum: z.ZodOptional<z.ZodNumber>;
+    maximum: z.ZodOptional<z.ZodNumber>;
+    default: z.ZodOptional<z.ZodAny>;
+    nullable: z.ZodOptional<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    key: string;
+    enabled: boolean;
+    minimum?: number | undefined;
+    type?: string | undefined;
+    maximum?: number | undefined;
+    default?: any;
+    required?: boolean | undefined;
+    description?: string | undefined;
+    enum?: string[] | undefined;
+    format?: string | undefined;
+    file?: any;
+    refUid?: string | undefined;
+    nullable?: boolean | undefined;
+}, {
+    minimum?: number | undefined;
+    type?: string | undefined;
+    maximum?: number | undefined;
+    value?: string | undefined;
+    default?: any;
+    required?: boolean | undefined;
+    description?: string | undefined;
+    enum?: string[] | undefined;
+    format?: string | undefined;
+    key?: string | undefined;
+    enabled?: boolean | undefined;
+    file?: any;
+    refUid?: string | undefined;
+    nullable?: boolean | undefined;
+}>;
+/** Request examples - formerly known as instances - are "children" of requests */
+export type RequestExampleParameter = z.infer<typeof requestExampleParametersSchema>;
+/**
+ * Possible encodings for example request bodies when using text formats
+ *
+ * TODO: This list may not be comprehensive enough
+ */
+export declare const exampleRequestBodyEncoding: readonly ["json", "text", "html", "javascript", "xml", "yaml", "edn"];
+export type BodyEncoding = (typeof exampleRequestBodyEncoding)[number];
+export declare const exampleRequestBodySchema: z.ZodObject<{
+    raw: z.ZodOptional<z.ZodObject<{
+        encoding: z.ZodDefault<z.ZodEnum<["json", "text", "html", "javascript", "xml", "yaml", "edn"]>>;
+        value: z.ZodDefault<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        value: string;
+        encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+    }, {
+        value?: string | undefined;
+        encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
+    }>>;
+    formData: z.ZodOptional<z.ZodObject<{
+        encoding: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"form-data">, z.ZodLiteral<"urlencoded">]>>;
+        value: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            minimum: z.ZodOptional<z.ZodNumber>;
+            maximum: z.ZodOptional<z.ZodNumber>;
+            default: z.ZodOptional<z.ZodAny>;
+            nullable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }, {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        value: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        encoding: "form-data" | "urlencoded";
+    }, {
+        value?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        encoding?: "form-data" | "urlencoded" | undefined;
+    }>>;
+    binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
+    activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
+}, "strip", z.ZodTypeAny, {
+    activeBody: "formData" | "raw" | "binary";
+    formData?: {
+        value: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        encoding: "form-data" | "urlencoded";
+    } | undefined;
+    raw?: {
+        value: string;
+        encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+    } | undefined;
+    binary?: Blob | undefined;
+}, {
+    formData?: {
+        value?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        encoding?: "form-data" | "urlencoded" | undefined;
+    } | undefined;
+    raw?: {
+        value?: string | undefined;
+        encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
+    } | undefined;
+    binary?: Blob | undefined;
+    activeBody?: "formData" | "raw" | "binary" | undefined;
+}>;
+export type ExampleRequestBody = z.infer<typeof exampleRequestBodySchema>;
+export declare const requestExampleSchema: z.ZodObject<{
+    type: z.ZodDefault<z.ZodOptional<z.ZodLiteral<"requestExample">>>;
+    uid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    requestUid: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    name: z.ZodDefault<z.ZodOptional<z.ZodString>>;
+    body: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        raw: z.ZodOptional<z.ZodObject<{
+            encoding: z.ZodDefault<z.ZodEnum<["json", "text", "html", "javascript", "xml", "yaml", "edn"]>>;
+            value: z.ZodDefault<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+        }, {
+            value?: string | undefined;
+            encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
+        }>>;
+        formData: z.ZodOptional<z.ZodObject<{
+            encoding: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"form-data">, z.ZodLiteral<"urlencoded">]>>;
+            value: z.ZodDefault<z.ZodArray<z.ZodObject<{
+                key: z.ZodDefault<z.ZodString>;
+                value: z.ZodDefault<z.ZodString>;
+                enabled: z.ZodDefault<z.ZodBoolean>;
+                file: z.ZodOptional<z.ZodAny>;
+                description: z.ZodOptional<z.ZodString>;
+                /** Params are linked to parents such as path params and global headers/cookies */
+                refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+                required: z.ZodOptional<z.ZodBoolean>;
+                enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+                type: z.ZodOptional<z.ZodString>;
+                format: z.ZodOptional<z.ZodString>;
+                minimum: z.ZodOptional<z.ZodNumber>;
+                maximum: z.ZodOptional<z.ZodNumber>;
+                default: z.ZodOptional<z.ZodAny>;
+                nullable: z.ZodOptional<z.ZodBoolean>;
+            }, "strip", z.ZodTypeAny, {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }, {
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                value?: string | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                key?: string | undefined;
+                enabled?: boolean | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }>, "many">>;
+        }, "strip", z.ZodTypeAny, {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        }, {
+            value?: {
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                value?: string | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                key?: string | undefined;
+                enabled?: boolean | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[] | undefined;
+            encoding?: "form-data" | "urlencoded" | undefined;
+        }>>;
+        binary: z.ZodOptional<z.ZodType<Blob, z.ZodTypeDef, Blob>>;
+        activeBody: z.ZodDefault<z.ZodUnion<[z.ZodLiteral<"raw">, z.ZodLiteral<"formData">, z.ZodLiteral<"binary">]>>;
+    }, "strip", z.ZodTypeAny, {
+        activeBody: "formData" | "raw" | "binary";
+        formData?: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        } | undefined;
+        raw?: {
+            value: string;
+            encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+        } | undefined;
+        binary?: Blob | undefined;
+    }, {
+        formData?: {
+            value?: {
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                value?: string | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                key?: string | undefined;
+                enabled?: boolean | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[] | undefined;
+            encoding?: "form-data" | "urlencoded" | undefined;
+        } | undefined;
+        raw?: {
+            value?: string | undefined;
+            encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
+        } | undefined;
+        binary?: Blob | undefined;
+        activeBody?: "formData" | "raw" | "binary" | undefined;
+    }>>>;
+    parameters: z.ZodDefault<z.ZodOptional<z.ZodObject<{
+        path: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            minimum: z.ZodOptional<z.ZodNumber>;
+            maximum: z.ZodOptional<z.ZodNumber>;
+            default: z.ZodOptional<z.ZodAny>;
+            nullable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }, {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }>, "many">>;
+        query: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            minimum: z.ZodOptional<z.ZodNumber>;
+            maximum: z.ZodOptional<z.ZodNumber>;
+            default: z.ZodOptional<z.ZodAny>;
+            nullable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }, {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }>, "many">>;
+        headers: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            minimum: z.ZodOptional<z.ZodNumber>;
+            maximum: z.ZodOptional<z.ZodNumber>;
+            default: z.ZodOptional<z.ZodAny>;
+            nullable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }, {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }>, "many">>;
+        cookies: z.ZodDefault<z.ZodArray<z.ZodObject<{
+            key: z.ZodDefault<z.ZodString>;
+            value: z.ZodDefault<z.ZodString>;
+            enabled: z.ZodDefault<z.ZodBoolean>;
+            file: z.ZodOptional<z.ZodAny>;
+            description: z.ZodOptional<z.ZodString>;
+            /** Params are linked to parents such as path params and global headers/cookies */
+            refUid: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodString>>>;
+            required: z.ZodOptional<z.ZodBoolean>;
+            enum: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+            type: z.ZodOptional<z.ZodString>;
+            format: z.ZodOptional<z.ZodString>;
+            minimum: z.ZodOptional<z.ZodNumber>;
+            maximum: z.ZodOptional<z.ZodNumber>;
+            default: z.ZodOptional<z.ZodAny>;
+            nullable: z.ZodOptional<z.ZodBoolean>;
+        }, "strip", z.ZodTypeAny, {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }, {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        path: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        cookies: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        query: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        headers: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+    }, {
+        path?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        cookies?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        query?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        headers?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+    }>>>;
+    serverVariables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>>;
+}, "strip", z.ZodTypeAny, {
+    type: "requestExample";
+    uid: string;
+    name: string;
+    body: {
+        activeBody: "formData" | "raw" | "binary";
+        formData?: {
+            value: {
+                value: string;
+                key: string;
+                enabled: boolean;
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[];
+            encoding: "form-data" | "urlencoded";
+        } | undefined;
+        raw?: {
+            value: string;
+            encoding: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn";
+        } | undefined;
+        binary?: Blob | undefined;
+    };
+    requestUid: string;
+    parameters: {
+        path: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        cookies: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        query: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+        headers: {
+            value: string;
+            key: string;
+            enabled: boolean;
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[];
+    };
+    serverVariables?: Record<string, string[]> | undefined;
+}, {
+    type?: "requestExample" | undefined;
+    uid?: string | undefined;
+    name?: string | undefined;
+    body?: {
+        formData?: {
+            value?: {
+                minimum?: number | undefined;
+                type?: string | undefined;
+                maximum?: number | undefined;
+                value?: string | undefined;
+                default?: any;
+                required?: boolean | undefined;
+                description?: string | undefined;
+                enum?: string[] | undefined;
+                format?: string | undefined;
+                key?: string | undefined;
+                enabled?: boolean | undefined;
+                file?: any;
+                refUid?: string | undefined;
+                nullable?: boolean | undefined;
+            }[] | undefined;
+            encoding?: "form-data" | "urlencoded" | undefined;
+        } | undefined;
+        raw?: {
+            value?: string | undefined;
+            encoding?: "xml" | "text" | "json" | "html" | "javascript" | "yaml" | "edn" | undefined;
+        } | undefined;
+        binary?: Blob | undefined;
+        activeBody?: "formData" | "raw" | "binary" | undefined;
+    } | undefined;
+    requestUid?: string | undefined;
+    parameters?: {
+        path?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        cookies?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        query?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+        headers?: {
+            minimum?: number | undefined;
+            type?: string | undefined;
+            maximum?: number | undefined;
+            value?: string | undefined;
+            default?: any;
+            required?: boolean | undefined;
+            description?: string | undefined;
+            enum?: string[] | undefined;
+            format?: string | undefined;
+            key?: string | undefined;
+            enabled?: boolean | undefined;
+            file?: any;
+            refUid?: string | undefined;
+            nullable?: boolean | undefined;
+        }[] | undefined;
+    } | undefined;
+    serverVariables?: Record<string, string[]> | undefined;
+}>;
+/** A single set 23of params for a request example */
+export type RequestExample = z.infer<typeof requestExampleSchema>;
+export type RequestExamplePayload = z.input<typeof requestExampleSchema>;
+/** Create new instance parameter from a request parameter */
+export declare function createParamInstance(param: RequestParameter): {
+    value: string;
+    key: string;
+    enabled: boolean;
+    minimum?: number | undefined;
+    type?: string | undefined;
+    maximum?: number | undefined;
+    default?: any;
+    required?: boolean | undefined;
+    description?: string | undefined;
+    enum?: string[] | undefined;
+    format?: string | undefined;
+    file?: any;
+    refUid?: string | undefined;
+    nullable?: boolean | undefined;
+};
+/**
+ * Create new request example from a request
+ * Iterates the name of the example if provided
+ */
+export declare function createExampleFromRequest(request: Request, name: string, server?: Server): RequestExample;
+//# sourceMappingURL=request-examples.d.ts.map