@scalar/api-client 2.1.36 → 2.1.38

package/dist/layouts/Modal/create-api-client-modal.d.ts

@@ -6,6 +6,7 @@ import { type ClientConfiguration } from '../../libs/index.js';
  */
 export declare const createApiClientModal: (el: HTMLElement | null, configuration?: ClientConfiguration, mountOnInitialize?: boolean) => Promise<{
     app: import("vue").App<Element>;
+    updateSpec: (spec: import("@scalar/types/legacy").SpecConfiguration) => Promise<void>;
     updateConfig(newConfig: ClientConfiguration, mergeConfigs?: boolean): void;
     updateServer: (serverUrl: string) => void;
     onUpdateServer: (callback: (url: string) => void) => void;
@@ -14,7 +15,6 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
         propertyKey: P;
         value: import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").Collection["auth"][string], P>;
     }) => void;
-    updateSpec: (spec: import("@scalar/types/legacy").SpecConfiguration) => Promise<void>;
     route: (params: import("../../libs/index.js").OpenClientPayload) => void;
     open: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
     mount: (mountingEl?: HTMLElement | null) => void;
@@ -274,6 +274,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 schema?: unknown;
                 content?: unknown;
                 style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                example?: unknown;
+                examples?: Record<string, {
+                    value?: unknown;
+                    summary?: string | undefined;
+                }> | undefined;
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
@@ -539,6 +544,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 schema?: unknown;
                 content?: unknown;
                 style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                example?: unknown;
+                examples?: Record<string, {
+                    value?: unknown;
+                    summary?: string | undefined;
+                }> | undefined;
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
@@ -1147,6 +1157,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         collectionMutators: {
             rawAdd: (item: {
@@ -1769,6 +1780,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         environmentMutators: {
             delete: (uid: string) => void;
@@ -1826,6 +1838,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         requestMutators: {
             rawAdd: (item: {
@@ -1856,6 +1869,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -1888,6 +1906,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -1921,11 +1944,16 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }) => void;
-            edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
+            edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -1953,10 +1981,15 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
+            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
                 path: string;
                 type: "request";
                 uid: string;
@@ -1984,6 +2017,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -2015,11 +2053,16 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
+            untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -2047,10 +2090,15 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
+            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
                 path: string;
                 type: "request";
                 uid: string;
@@ -2078,6 +2126,11 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -2109,12 +2162,18 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         findRequestParents: (r: import("@scalar/oas-utils/entities/spec").Request) => string[];
         requestExampleMutators: {
@@ -3017,6 +3076,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         requestHistory: import("vue").Reactive<import("@scalar/oas-utils/entities/spec").RequestEvent[]>;
         securitySchemeMutators: {
@@ -3129,7 +3189,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
                 };
                 'x-scalar-client-id': string;
                 description?: string | undefined;
-            };
+            } | null;
             delete: (schemeUid: string) => void;
             set: (item: {
                 type: "apiKey";
@@ -3514,6 +3574,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         serverMutators: {
             rawAdd: (item: {
@@ -3587,6 +3648,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         tagMutators: {
             rawAdd: (item: {
@@ -3714,6 +3776,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         workspaceMutators: {
             rawAdd: (item: {
@@ -3886,6 +3949,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
     };
 }>;
@@ -3896,6 +3960,7 @@ export declare const createApiClientModal: (el: HTMLElement | null, configuratio
  */
 export declare const createApiClientModalSync: (el: HTMLElement | null, configuration?: ClientConfiguration, mountOnInitialize?: boolean) => {
     app: import("vue").App<Element>;
+    updateSpec: (spec: import("@scalar/types/legacy").SpecConfiguration) => Promise<void>;
     updateConfig(newConfig: ClientConfiguration, mergeConfigs?: boolean): void;
     updateServer: (serverUrl: string) => void;
     onUpdateServer: (callback: (url: string) => void) => void;
@@ -3904,7 +3969,6 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
         propertyKey: P;
         value: import("@scalar/object-utils/nested").PathValue<import("@scalar/oas-utils/entities/spec").Collection["auth"][string], P>;
     }) => void;
-    updateSpec: (spec: import("@scalar/types/legacy").SpecConfiguration) => Promise<void>;
     route: (params: import("../../libs/index.js").OpenClientPayload) => void;
     open: (payload?: import("../../libs/index.js").OpenClientPayload) => void;
     mount: (mountingEl?: HTMLElement | null) => void;
@@ -4164,6 +4228,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 schema?: unknown;
                 content?: unknown;
                 style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                example?: unknown;
+                examples?: Record<string, {
+                    value?: unknown;
+                    summary?: string | undefined;
+                }> | undefined;
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
@@ -4429,6 +4498,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 schema?: unknown;
                 content?: unknown;
                 style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                example?: unknown;
+                examples?: Record<string, {
+                    value?: unknown;
+                    summary?: string | undefined;
+                }> | undefined;
             }[] | undefined;
             requestBody?: any;
             responses?: Record<string, any> | undefined;
@@ -5037,6 +5111,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         collectionMutators: {
             rawAdd: (item: {
@@ -5659,6 +5734,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         environmentMutators: {
             delete: (uid: string) => void;
@@ -5716,6 +5792,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         requestMutators: {
             rawAdd: (item: {
@@ -5746,6 +5823,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -5778,6 +5860,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -5811,11 +5898,16 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }) => void;
-            edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
+            edit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -5843,10 +5935,15 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
+            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
                 path: string;
                 type: "request";
                 uid: string;
@@ -5874,6 +5971,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -5905,11 +6007,16 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
-            untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.deprecated` | `parameters.${number}.content` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.schema` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? {
+            untrackedEdit: <P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" | `servers.${number}` | `parameters.${number}` | `parameters.${number}.required` | `parameters.${number}.description` | `parameters.${number}.style` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.example` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.deprecated` | `parameters.${number}.schema` | `parameters.${number}.examples.${string}` | `selectedSecuritySchemeUids.${number}` | `tags.${number}` | `examples.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.url" | "externalDocs.description" | `requestBody.${string}` | `responses.${string}`>(uid: string, path: P, value: P extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? {
                 path: string;
                 type: "request";
                 uid: string;
@@ -5937,10 +6044,15 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
-            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "deprecated" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
+            }[P] : P extends `${infer K}.${infer R}` ? K extends "method" | "type" | "summary" | "path" | "servers" | "description" | "parameters" | "uid" | "selectedSecuritySchemeUids" | "tags" | "examples" | "security" | "externalDocs" | "selectedServerUid" | "deprecated" | "operationId" | "requestBody" | "responses" ? R extends import("@scalar/object-utils/nested").Path<{
                 path: string;
                 type: "request";
                 uid: string;
@@ -5968,6 +6080,11 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
@@ -5999,12 +6116,18 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                     schema?: unknown;
                     content?: unknown;
                     style?: "matrix" | "simple" | "form" | "label" | "spaceDelimited" | "pipeDelimited" | "deepObject" | undefined;
+                    example?: unknown;
+                    examples?: Record<string, {
+                        value?: unknown;
+                        summary?: string | undefined;
+                    }> | undefined;
                 }[] | undefined;
                 requestBody?: any;
                 responses?: Record<string, any> | undefined;
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         findRequestParents: (r: import("@scalar/oas-utils/entities/spec").Request) => string[];
         requestExampleMutators: {
@@ -6907,6 +7030,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         requestHistory: import("vue").Reactive<import("@scalar/oas-utils/entities/spec").RequestEvent[]>;
         securitySchemeMutators: {
@@ -7019,7 +7143,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
                 };
                 'x-scalar-client-id': string;
                 description?: string | undefined;
-            };
+            } | null;
             delete: (schemeUid: string) => void;
             set: (item: {
                 type: "apiKey";
@@ -7404,6 +7528,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never)) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         serverMutators: {
             rawAdd: (item: {
@@ -7477,6 +7602,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         tagMutators: {
             rawAdd: (item: {
@@ -7604,6 +7730,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
         workspaceMutators: {
             rawAdd: (item: {
@@ -7776,6 +7903,7 @@ export declare const createApiClientModalSync: (el: HTMLElement | null, configur
             }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
             undo: (uid: string) => void;
             redo: (uid: string) => void;
+            reset: () => void;
         };
     };
 };