@scalar/api-client 2.3.11 → 2.3.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (57) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/dist/components/AddressBar/AddressBarHistory.vue.d.ts.map +1 -1
  3. package/dist/components/AddressBar/AddressBarHistory.vue.js +2 -2
  4. package/dist/components/AddressBar/AddressBarHistory.vue2.js +45 -51
  5. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts +6 -0
  6. package/dist/components/CommandPalette/TheCommandPalette.vue.d.ts.map +1 -1
  7. package/dist/components/ImportCollection/hooks/useUrlPrefetcher.d.ts +1 -1
  8. package/dist/components/ImportCollection/hooks/useUrlPrefetcher.d.ts.map +1 -1
  9. package/dist/components/ImportCollection/hooks/useUrlPrefetcher.js +3 -3
  10. package/dist/components/Server/ServerDropdownItem.vue.d.ts.map +1 -1
  11. package/dist/components/Server/ServerDropdownItem.vue.js +1 -1
  12. package/dist/components/Server/ServerDropdownItem.vue2.js +25 -22
  13. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.d.ts.map +1 -1
  14. package/dist/components/ViewLayout/ViewLayoutCollapse.vue.js +25 -26
  15. package/dist/layouts/App/create-api-client-app.d.ts +154 -4
  16. package/dist/layouts/App/create-api-client-app.d.ts.map +1 -1
  17. package/dist/layouts/Modal/create-api-client-modal.d.ts +308 -8
  18. package/dist/layouts/Modal/create-api-client-modal.d.ts.map +1 -1
  19. package/dist/layouts/Web/create-api-client-web.d.ts +154 -4
  20. package/dist/layouts/Web/create-api-client-web.d.ts.map +1 -1
  21. package/dist/libs/create-client.d.ts +154 -4
  22. package/dist/libs/create-client.d.ts.map +1 -1
  23. package/dist/libs/create-client.js +40 -37
  24. package/dist/libs/find-request.d.ts +15 -0
  25. package/dist/libs/find-request.d.ts.map +1 -1
  26. package/dist/libs/send-request/create-request-operation.d.ts.map +1 -1
  27. package/dist/libs/send-request/create-request-operation.js +41 -41
  28. package/dist/libs/send-request/create-request-operation.test.d.ts +15 -0
  29. package/dist/libs/send-request/create-request-operation.test.d.ts.map +1 -1
  30. package/dist/store/active-entities.d.ts +15 -0
  31. package/dist/store/active-entities.d.ts.map +1 -1
  32. package/dist/store/import-spec.d.ts.map +1 -1
  33. package/dist/store/import-spec.js +12 -12
  34. package/dist/store/requests.d.ts +169 -4
  35. package/dist/store/requests.d.ts.map +1 -1
  36. package/dist/store/store.d.ts +154 -4
  37. package/dist/store/store.d.ts.map +1 -1
  38. package/dist/style.css +1 -1
  39. package/dist/views/Collection/CollectionAuthentication.vue.js +2 -2
  40. package/dist/views/Request/RequestRoot.vue.d.ts.map +1 -1
  41. package/dist/views/Request/RequestRoot.vue.js +1 -1
  42. package/dist/views/Request/RequestRoot.vue2.js +71 -61
  43. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.d.ts.map +1 -1
  44. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue.js +2 -2
  45. package/dist/views/Request/RequestSection/RequestAuth/RequestAuthTab.vue2.js +32 -32
  46. package/dist/views/Request/RequestSection/RequestCodeExample.vue.d.ts.map +1 -1
  47. package/dist/views/Request/RequestSection/RequestCodeExample.vue.js +3 -3
  48. package/dist/views/Request/RequestSection/RequestCodeExample.vue2.js +123 -79
  49. package/dist/views/Request/RequestSection/RequestSection.vue.d.ts.map +1 -1
  50. package/dist/views/Request/RequestSection/RequestSection.vue.js +2 -2
  51. package/dist/views/Request/RequestSection/RequestSection.vue2.js +1 -1
  52. package/dist/views/Request/ResponseSection/ResponseBody.vue.d.ts.map +1 -1
  53. package/dist/views/Request/ResponseSection/ResponseBody.vue.js +2 -2
  54. package/dist/views/Request/ResponseSection/ResponseBody.vue2.js +6 -6
  55. package/dist/views/Request/ResponseSection/ResponseEmpty.vue2.js +1 -1
  56. package/dist/views/Request/hooks/useOpenApiWatcher.js +25 -25
  57. package/package.json +14 -14
package/dist/layouts/Modal/create-api-client-modal.d.ts CHANGED
@@ -270,6 +270,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
270
270
  }[] | undefined;
271
271
  requestBody?: any;
272
272
  responses?: Record<string, any> | undefined;
273
+ 'x-codeSamples'?: {
274
+ source: string;
275
+ label?: string | undefined;
276
+ lang?: string | undefined;
277
+ }[] | undefined;
278
+ 'x-code-samples'?: {
279
+ source: string;
280
+ label?: string | undefined;
281
+ lang?: string | undefined;
282
+ }[] | undefined;
283
+ 'x-custom-examples'?: {
284
+ source: string;
285
+ label?: string | undefined;
286
+ lang?: string | undefined;
287
+ }[] | undefined;
273
288
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
274
289
  }>;
275
290
  servers: Record<string, {
@@ -1191,6 +1206,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1191
1206
  }[] | undefined;
1192
1207
  requestBody?: any;
1193
1208
  responses?: Record<string, any> | undefined;
1209
+ 'x-codeSamples'?: {
1210
+ source: string;
1211
+ label?: string | undefined;
1212
+ lang?: string | undefined;
1213
+ }[] | undefined;
1214
+ 'x-code-samples'?: {
1215
+ source: string;
1216
+ label?: string | undefined;
1217
+ lang?: string | undefined;
1218
+ }[] | undefined;
1219
+ 'x-custom-examples'?: {
1220
+ source: string;
1221
+ label?: string | undefined;
1222
+ lang?: string | undefined;
1223
+ }[] | undefined;
1194
1224
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1195
1225
  }) => void;
1196
1226
  add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
@@ -1231,6 +1261,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1231
1261
  }[] | undefined;
1232
1262
  requestBody?: any;
1233
1263
  responses?: Record<string, any> | undefined;
1264
+ 'x-codeSamples'?: {
1265
+ source: string;
1266
+ label?: string | undefined;
1267
+ lang?: string | undefined;
1268
+ }[] | undefined;
1269
+ 'x-code-samples'?: {
1270
+ source: string;
1271
+ label?: string | undefined;
1272
+ lang?: string | undefined;
1273
+ }[] | undefined;
1274
+ 'x-custom-examples'?: {
1275
+ source: string;
1276
+ label?: string | undefined;
1277
+ lang?: string | undefined;
1278
+ }[] | undefined;
1234
1279
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1235
1280
  };
1236
1281
  delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
@@ -1272,9 +1317,24 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1272
1317
  }[] | undefined;
1273
1318
  requestBody?: any;
1274
1319
  responses?: Record<string, any> | undefined;
1320
+ 'x-codeSamples'?: {
1321
+ source: string;
1322
+ label?: string | undefined;
1323
+ lang?: string | undefined;
1324
+ }[] | undefined;
1325
+ 'x-code-samples'?: {
1326
+ source: string;
1327
+ label?: string | undefined;
1328
+ lang?: string | undefined;
1329
+ }[] | undefined;
1330
+ 'x-custom-examples'?: {
1331
+ source: string;
1332
+ label?: string | undefined;
1333
+ lang?: string | undefined;
1334
+ }[] | undefined;
1275
1335
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1276
1336
  }) => void;
1277
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1337
+ edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1278
1338
  uid: string & import("zod").BRAND<"operation">;
1279
1339
  path: string;
1280
1340
  type: "request";
@@ -1312,8 +1372,23 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1312
1372
  }[] | undefined;
1313
1373
  requestBody?: any;
1314
1374
  responses?: Record<string, any> | undefined;
1375
+ 'x-codeSamples'?: {
1376
+ source: string;
1377
+ label?: string | undefined;
1378
+ lang?: string | undefined;
1379
+ }[] | undefined;
1380
+ 'x-code-samples'?: {
1381
+ source: string;
1382
+ label?: string | undefined;
1383
+ lang?: string | undefined;
1384
+ }[] | undefined;
1385
+ 'x-custom-examples'?: {
1386
+ source: string;
1387
+ label?: string | undefined;
1388
+ lang?: string | undefined;
1389
+ }[] | undefined;
1315
1390
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1316
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1391
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1317
1392
  uid: string & import("zod").BRAND<"operation">;
1318
1393
  path: string;
1319
1394
  type: "request";
@@ -1351,6 +1426,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1351
1426
  }[] | undefined;
1352
1427
  requestBody?: any;
1353
1428
  responses?: Record<string, any> | undefined;
1429
+ 'x-codeSamples'?: {
1430
+ source: string;
1431
+ label?: string | undefined;
1432
+ lang?: string | undefined;
1433
+ }[] | undefined;
1434
+ 'x-code-samples'?: {
1435
+ source: string;
1436
+ label?: string | undefined;
1437
+ lang?: string | undefined;
1438
+ }[] | undefined;
1439
+ 'x-custom-examples'?: {
1440
+ source: string;
1441
+ label?: string | undefined;
1442
+ lang?: string | undefined;
1443
+ }[] | undefined;
1354
1444
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1355
1445
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
1356
1446
  uid: string & import("zod").BRAND<"operation">;
@@ -1390,9 +1480,24 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1390
1480
  }[] | undefined;
1391
1481
  requestBody?: any;
1392
1482
  responses?: Record<string, any> | undefined;
1483
+ 'x-codeSamples'?: {
1484
+ source: string;
1485
+ label?: string | undefined;
1486
+ lang?: string | undefined;
1487
+ }[] | undefined;
1488
+ 'x-code-samples'?: {
1489
+ source: string;
1490
+ label?: string | undefined;
1491
+ lang?: string | undefined;
1492
+ }[] | undefined;
1493
+ 'x-custom-examples'?: {
1494
+ source: string;
1495
+ label?: string | undefined;
1496
+ lang?: string | undefined;
1497
+ }[] | undefined;
1393
1498
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1394
1499
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1395
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1500
+ untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
1396
1501
  uid: string & import("zod").BRAND<"operation">;
1397
1502
  path: string;
1398
1503
  type: "request";
@@ -1430,8 +1535,23 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1430
1535
  }[] | undefined;
1431
1536
  requestBody?: any;
1432
1537
  responses?: Record<string, any> | undefined;
1538
+ 'x-codeSamples'?: {
1539
+ source: string;
1540
+ label?: string | undefined;
1541
+ lang?: string | undefined;
1542
+ }[] | undefined;
1543
+ 'x-code-samples'?: {
1544
+ source: string;
1545
+ label?: string | undefined;
1546
+ lang?: string | undefined;
1547
+ }[] | undefined;
1548
+ 'x-custom-examples'?: {
1549
+ source: string;
1550
+ label?: string | undefined;
1551
+ lang?: string | undefined;
1552
+ }[] | undefined;
1433
1553
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1434
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1554
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
1435
1555
  uid: string & import("zod").BRAND<"operation">;
1436
1556
  path: string;
1437
1557
  type: "request";
@@ -1469,6 +1589,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1469
1589
  }[] | undefined;
1470
1590
  requestBody?: any;
1471
1591
  responses?: Record<string, any> | undefined;
1592
+ 'x-codeSamples'?: {
1593
+ source: string;
1594
+ label?: string | undefined;
1595
+ lang?: string | undefined;
1596
+ }[] | undefined;
1597
+ 'x-code-samples'?: {
1598
+ source: string;
1599
+ label?: string | undefined;
1600
+ lang?: string | undefined;
1601
+ }[] | undefined;
1602
+ 'x-custom-examples'?: {
1603
+ source: string;
1604
+ label?: string | undefined;
1605
+ lang?: string | undefined;
1606
+ }[] | undefined;
1472
1607
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1473
1608
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
1474
1609
  uid: string & import("zod").BRAND<"operation">;
@@ -1508,6 +1643,21 @@ export declare const createApiClientModal: ({ el, configuration, mountOnInitiali
1508
1643
  }[] | undefined;
1509
1644
  requestBody?: any;
1510
1645
  responses?: Record<string, any> | undefined;
1646
+ 'x-codeSamples'?: {
1647
+ source: string;
1648
+ label?: string | undefined;
1649
+ lang?: string | undefined;
1650
+ }[] | undefined;
1651
+ 'x-code-samples'?: {
1652
+ source: string;
1653
+ label?: string | undefined;
1654
+ lang?: string | undefined;
1655
+ }[] | undefined;
1656
+ 'x-custom-examples'?: {
1657
+ source: string;
1658
+ label?: string | undefined;
1659
+ lang?: string | undefined;
1660
+ }[] | undefined;
1511
1661
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
1512
1662
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
1513
1663
  undo: (uid: string & import("zod").BRAND<"operation">) => void;
@@ -3854,6 +4004,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
3854
4004
  }[] | undefined;
3855
4005
  requestBody?: any;
3856
4006
  responses?: Record<string, any> | undefined;
4007
+ 'x-codeSamples'?: {
4008
+ source: string;
4009
+ label?: string | undefined;
4010
+ lang?: string | undefined;
4011
+ }[] | undefined;
4012
+ 'x-code-samples'?: {
4013
+ source: string;
4014
+ label?: string | undefined;
4015
+ lang?: string | undefined;
4016
+ }[] | undefined;
4017
+ 'x-custom-examples'?: {
4018
+ source: string;
4019
+ label?: string | undefined;
4020
+ lang?: string | undefined;
4021
+ }[] | undefined;
3857
4022
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
3858
4023
  }>;
3859
4024
  servers: Record<string, {
@@ -4775,6 +4940,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4775
4940
  }[] | undefined;
4776
4941
  requestBody?: any;
4777
4942
  responses?: Record<string, any> | undefined;
4943
+ 'x-codeSamples'?: {
4944
+ source: string;
4945
+ label?: string | undefined;
4946
+ lang?: string | undefined;
4947
+ }[] | undefined;
4948
+ 'x-code-samples'?: {
4949
+ source: string;
4950
+ label?: string | undefined;
4951
+ lang?: string | undefined;
4952
+ }[] | undefined;
4953
+ 'x-custom-examples'?: {
4954
+ source: string;
4955
+ label?: string | undefined;
4956
+ lang?: string | undefined;
4957
+ }[] | undefined;
4778
4958
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4779
4959
  }) => void;
4780
4960
  add: (payload: import("@scalar/oas-utils/entities/spec").RequestPayload, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void | {
@@ -4815,6 +4995,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4815
4995
  }[] | undefined;
4816
4996
  requestBody?: any;
4817
4997
  responses?: Record<string, any> | undefined;
4998
+ 'x-codeSamples'?: {
4999
+ source: string;
5000
+ label?: string | undefined;
5001
+ lang?: string | undefined;
5002
+ }[] | undefined;
5003
+ 'x-code-samples'?: {
5004
+ source: string;
5005
+ label?: string | undefined;
5006
+ lang?: string | undefined;
5007
+ }[] | undefined;
5008
+ 'x-custom-examples'?: {
5009
+ source: string;
5010
+ label?: string | undefined;
5011
+ lang?: string | undefined;
5012
+ }[] | undefined;
4818
5013
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4819
5014
  };
4820
5015
  delete: (request: import("@scalar/oas-utils/entities/spec").Request, collectionUid: import("@scalar/oas-utils/entities/spec").Collection["uid"]) => void;
@@ -4856,9 +5051,24 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4856
5051
  }[] | undefined;
4857
5052
  requestBody?: any;
4858
5053
  responses?: Record<string, any> | undefined;
5054
+ 'x-codeSamples'?: {
5055
+ source: string;
5056
+ label?: string | undefined;
5057
+ lang?: string | undefined;
5058
+ }[] | undefined;
5059
+ 'x-code-samples'?: {
5060
+ source: string;
5061
+ label?: string | undefined;
5062
+ lang?: string | undefined;
5063
+ }[] | undefined;
5064
+ 'x-custom-examples'?: {
5065
+ source: string;
5066
+ label?: string | undefined;
5067
+ lang?: string | undefined;
5068
+ }[] | undefined;
4859
5069
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4860
5070
  }) => void;
4861
- edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
5071
+ edit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: (string & import("zod").BRAND<"operation">) | null | undefined, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
4862
5072
  uid: string & import("zod").BRAND<"operation">;
4863
5073
  path: string;
4864
5074
  type: "request";
@@ -4896,8 +5106,23 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4896
5106
  }[] | undefined;
4897
5107
  requestBody?: any;
4898
5108
  responses?: Record<string, any> | undefined;
5109
+ 'x-codeSamples'?: {
5110
+ source: string;
5111
+ label?: string | undefined;
5112
+ lang?: string | undefined;
5113
+ }[] | undefined;
5114
+ 'x-code-samples'?: {
5115
+ source: string;
5116
+ label?: string | undefined;
5117
+ lang?: string | undefined;
5118
+ }[] | undefined;
5119
+ 'x-custom-examples'?: {
5120
+ source: string;
5121
+ label?: string | undefined;
5122
+ lang?: string | undefined;
5123
+ }[] | undefined;
4899
5124
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4900
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5125
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
4901
5126
  uid: string & import("zod").BRAND<"operation">;
4902
5127
  path: string;
4903
5128
  type: "request";
@@ -4935,6 +5160,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4935
5160
  }[] | undefined;
4936
5161
  requestBody?: any;
4937
5162
  responses?: Record<string, any> | undefined;
5163
+ 'x-codeSamples'?: {
5164
+ source: string;
5165
+ label?: string | undefined;
5166
+ lang?: string | undefined;
5167
+ }[] | undefined;
5168
+ 'x-code-samples'?: {
5169
+ source: string;
5170
+ label?: string | undefined;
5171
+ lang?: string | undefined;
5172
+ }[] | undefined;
5173
+ 'x-custom-examples'?: {
5174
+ source: string;
5175
+ label?: string | undefined;
5176
+ lang?: string | undefined;
5177
+ }[] | undefined;
4938
5178
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4939
5179
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
4940
5180
  uid: string & import("zod").BRAND<"operation">;
@@ -4974,9 +5214,24 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
4974
5214
  }[] | undefined;
4975
5215
  requestBody?: any;
4976
5216
  responses?: Record<string, any> | undefined;
5217
+ 'x-codeSamples'?: {
5218
+ source: string;
5219
+ label?: string | undefined;
5220
+ lang?: string | undefined;
5221
+ }[] | undefined;
5222
+ 'x-code-samples'?: {
5223
+ source: string;
5224
+ label?: string | undefined;
5225
+ lang?: string | undefined;
5226
+ }[] | undefined;
5227
+ 'x-custom-examples'?: {
5228
+ source: string;
5229
+ label?: string | undefined;
5230
+ lang?: string | undefined;
5231
+ }[] | undefined;
4977
5232
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
4978
5233
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
4979
- untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
5234
+ untrackedEdit: <P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | `tags.${number}` | `security.${number}` | `security.${number}.${string}` | "externalDocs.description" | "externalDocs.url" | `selectedSecuritySchemeUids.${number}` | `selectedSecuritySchemeUids.${number}.${number}` | `servers.${number}` | "examples" | `requestBody.${string}` | `examples.${number}` | `parameters.${number}` | `parameters.${number}.description` | `parameters.${number}.deprecated` | `parameters.${number}.example` | `parameters.${number}.name` | `parameters.${number}.in` | `parameters.${number}.style` | `parameters.${number}.examples` | `parameters.${number}.content` | `parameters.${number}.required` | `parameters.${number}.schema` | `parameters.${number}.examples.${number}` | `parameters.${number}.examples.${string}` | `responses.${string}` | `x-codeSamples.${number}` | `x-codeSamples.${number}.label` | `x-codeSamples.${number}.source` | `x-codeSamples.${number}.lang` | `x-code-samples.${number}` | `x-code-samples.${number}.label` | `x-code-samples.${number}.source` | `x-code-samples.${number}.lang` | `x-custom-examples.${number}` | `x-custom-examples.${number}.label` | `x-custom-examples.${number}.source` | `x-custom-examples.${number}.lang`>(uid: string & import("zod").BRAND<"operation">, path: P, value: P extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? {
4980
5235
  uid: string & import("zod").BRAND<"operation">;
4981
5236
  path: string;
4982
5237
  type: "request";
@@ -5014,8 +5269,23 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
5014
5269
  }[] | undefined;
5015
5270
  requestBody?: any;
5016
5271
  responses?: Record<string, any> | undefined;
5272
+ 'x-codeSamples'?: {
5273
+ source: string;
5274
+ label?: string | undefined;
5275
+ lang?: string | undefined;
5276
+ }[] | undefined;
5277
+ 'x-code-samples'?: {
5278
+ source: string;
5279
+ label?: string | undefined;
5280
+ lang?: string | undefined;
5281
+ }[] | undefined;
5282
+ 'x-custom-examples'?: {
5283
+ source: string;
5284
+ label?: string | undefined;
5285
+ lang?: string | undefined;
5286
+ }[] | undefined;
5017
5287
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
5018
- }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5288
+ }[P] : P extends `${infer K}.${infer R}` ? K extends "tags" | "summary" | "description" | "operationId" | "security" | "requestBody" | "parameters" | "externalDocs" | "deprecated" | "responses" | "x-internal" | "x-scalar-ignore" | "x-codeSamples" | "x-code-samples" | "x-custom-examples" | "x-scalar-stability" | "path" | "method" | "type" | "uid" | "selectedSecuritySchemeUids" | "servers" | "selectedServerUid" | "examples" ? R extends import("@scalar/object-utils/nested").Path<{
5019
5289
  uid: string & import("zod").BRAND<"operation">;
5020
5290
  path: string;
5021
5291
  type: "request";
@@ -5053,6 +5323,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
5053
5323
  }[] | undefined;
5054
5324
  requestBody?: any;
5055
5325
  responses?: Record<string, any> | undefined;
5326
+ 'x-codeSamples'?: {
5327
+ source: string;
5328
+ label?: string | undefined;
5329
+ lang?: string | undefined;
5330
+ }[] | undefined;
5331
+ 'x-code-samples'?: {
5332
+ source: string;
5333
+ label?: string | undefined;
5334
+ lang?: string | undefined;
5335
+ }[] | undefined;
5336
+ 'x-custom-examples'?: {
5337
+ source: string;
5338
+ label?: string | undefined;
5339
+ lang?: string | undefined;
5340
+ }[] | undefined;
5056
5341
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
5057
5342
  }[K]> ? import("@scalar/object-utils/nested").PathValue<{
5058
5343
  uid: string & import("zod").BRAND<"operation">;
@@ -5092,6 +5377,21 @@ export declare const createApiClientModalSync: ({ el, configuration, mountOnInit
5092
5377
  }[] | undefined;
5093
5378
  requestBody?: any;
5094
5379
  responses?: Record<string, any> | undefined;
5380
+ 'x-codeSamples'?: {
5381
+ source: string;
5382
+ label?: string | undefined;
5383
+ lang?: string | undefined;
5384
+ }[] | undefined;
5385
+ 'x-code-samples'?: {
5386
+ source: string;
5387
+ label?: string | undefined;
5388
+ lang?: string | undefined;
5389
+ }[] | undefined;
5390
+ 'x-custom-examples'?: {
5391
+ source: string;
5392
+ label?: string | undefined;
5393
+ lang?: string | undefined;
5394
+ }[] | undefined;
5095
5395
  'x-scalar-stability'?: import("@scalar/types").XScalarStability | undefined;
5096
5396
  }[K], R> : never : K extends `${number}` ? never : never : P extends `${number}` ? never : never) => void;
5097
5397
  undo: (uid: string & import("zod").BRAND<"operation">) => void;