@chatbotkit/sdk 1.22.0 → 1.24.0

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 (49) hide show
  1. package/dist/cjs/platform/doc/index.cjs +21 -0
  2. package/dist/cjs/platform/doc/index.d.ts +8 -0
  3. package/dist/cjs/platform/doc/v1.cjs +26 -0
  4. package/dist/cjs/platform/doc/v1.d.ts +19 -0
  5. package/dist/cjs/platform/example/index.cjs +3 -0
  6. package/dist/cjs/platform/example/index.d.ts +1 -0
  7. package/dist/cjs/platform/example/v1.cjs +8 -0
  8. package/dist/cjs/platform/example/v1.d.ts +2 -0
  9. package/dist/cjs/platform/index.cjs +12 -8
  10. package/dist/cjs/platform/index.d.ts +6 -2
  11. package/dist/cjs/platform/manual/index.cjs +21 -0
  12. package/dist/cjs/platform/manual/index.d.ts +8 -0
  13. package/dist/cjs/platform/manual/v1.cjs +26 -0
  14. package/dist/cjs/platform/manual/v1.d.ts +19 -0
  15. package/dist/cjs/platform/tutorial/index.cjs +21 -0
  16. package/dist/cjs/platform/tutorial/index.d.ts +8 -0
  17. package/dist/cjs/platform/tutorial/v1.cjs +26 -0
  18. package/dist/cjs/platform/tutorial/v1.d.ts +19 -0
  19. package/dist/cjs/report/index.cjs +4 -4
  20. package/dist/cjs/report/index.d.ts +2 -2
  21. package/dist/cjs/report/v1.cjs +6 -6
  22. package/dist/cjs/report/v1.d.ts +5 -5
  23. package/dist/cjs/types/api/v1.d.ts +501 -311
  24. package/dist/cjs/types/report.d.ts +17 -1
  25. package/dist/esm/platform/doc/index.d.ts +8 -0
  26. package/dist/esm/platform/doc/index.js +17 -0
  27. package/dist/esm/platform/doc/v1.d.ts +19 -0
  28. package/dist/esm/platform/doc/v1.js +21 -0
  29. package/dist/esm/platform/example/index.d.ts +1 -0
  30. package/dist/esm/platform/example/index.js +4 -1
  31. package/dist/esm/platform/example/v1.d.ts +2 -0
  32. package/dist/esm/platform/example/v1.js +7 -0
  33. package/dist/esm/platform/index.d.ts +6 -2
  34. package/dist/esm/platform/index.js +6 -2
  35. package/dist/esm/platform/manual/index.d.ts +8 -0
  36. package/dist/esm/platform/manual/index.js +17 -0
  37. package/dist/esm/platform/manual/v1.d.ts +19 -0
  38. package/dist/esm/platform/manual/v1.js +21 -0
  39. package/dist/esm/platform/tutorial/index.d.ts +8 -0
  40. package/dist/esm/platform/tutorial/index.js +17 -0
  41. package/dist/esm/platform/tutorial/v1.d.ts +19 -0
  42. package/dist/esm/platform/tutorial/v1.js +21 -0
  43. package/dist/esm/report/index.d.ts +2 -2
  44. package/dist/esm/report/index.js +5 -5
  45. package/dist/esm/report/v1.d.ts +5 -5
  46. package/dist/esm/report/v1.js +4 -4
  47. package/dist/esm/types/api/v1.d.ts +501 -311
  48. package/dist/esm/types/report.d.ts +17 -1
  49. package/package.json +152 -2
@@ -38,7 +38,7 @@ export interface paths {
38
38
  patch?: never;
39
39
  trace?: never;
40
40
  };
41
- "/report/{reportId}/fetch": {
41
+ "/report/{reportId}/generate": {
42
42
  parameters: {
43
43
  query?: never;
44
44
  header?: never;
@@ -53,7 +53,31 @@ export interface paths {
53
53
  * parameters.
54
54
  *
55
55
  */
56
- post: operations["fetchReport"];
56
+ post: operations["generateReport"];
57
+ delete?: never;
58
+ options?: never;
59
+ head?: never;
60
+ patch?: never;
61
+ trace?: never;
62
+ };
63
+ "/report/generate": {
64
+ parameters: {
65
+ query?: never;
66
+ header?: never;
67
+ path?: never;
68
+ cookie?: never;
69
+ };
70
+ get?: never;
71
+ put?: never;
72
+ /**
73
+ * Generate multiple reports
74
+ * @description Generates multiple reports in a single request. Input is a map where
75
+ * each key is a report ID and each value contains the input parameters
76
+ * for that report. Returns a map with the same keys containing the
77
+ * corresponding report outputs.
78
+ *
79
+ */
80
+ post: operations["generateReports"];
57
81
  delete?: never;
58
82
  options?: never;
59
83
  head?: never;
@@ -3292,7 +3316,7 @@ export interface paths {
3292
3316
  patch?: never;
3293
3317
  trace?: never;
3294
3318
  };
3295
- "/platform/content/doc/{docId}/fetch": {
3319
+ "/platform/doc/{docId}/fetch": {
3296
3320
  parameters: {
3297
3321
  query?: never;
3298
3322
  header?: never;
@@ -3305,7 +3329,7 @@ export interface paths {
3305
3329
  * includes the markdown content and all associated frontmatter.
3306
3330
  *
3307
3331
  */
3308
- get: operations["fetchPlatformContentDoc"];
3332
+ get: operations["fetchPlatformDoc"];
3309
3333
  put?: never;
3310
3334
  post?: never;
3311
3335
  delete?: never;
@@ -3314,7 +3338,7 @@ export interface paths {
3314
3338
  patch?: never;
3315
3339
  trace?: never;
3316
3340
  };
3317
- "/platform/content/doc/list": {
3341
+ "/platform/doc/list": {
3318
3342
  parameters: {
3319
3343
  query?: never;
3320
3344
  header?: never;
@@ -3326,7 +3350,7 @@ export interface paths {
3326
3350
  * @description Returns a list of available documentation docs with their metadata.
3327
3351
  *
3328
3352
  */
3329
- get: operations["listPlatformContentDocs"];
3353
+ get: operations["listPlatformDocs"];
3330
3354
  put?: never;
3331
3355
  post?: never;
3332
3356
  delete?: never;
@@ -3335,7 +3359,7 @@ export interface paths {
3335
3359
  patch?: never;
3336
3360
  trace?: never;
3337
3361
  };
3338
- "/platform/content/doc/search": {
3362
+ "/platform/doc/search": {
3339
3363
  parameters: {
3340
3364
  query?: never;
3341
3365
  header?: never;
@@ -3345,27 +3369,39 @@ export interface paths {
3345
3369
  get?: never;
3346
3370
  put?: never;
3347
3371
  /** Search platform docs using semantic similarity */
3348
- post: operations["searchPlatformContentDocs"];
3372
+ post: operations["searchPlatformDocs"];
3349
3373
  delete?: never;
3350
3374
  options?: never;
3351
3375
  head?: never;
3352
3376
  patch?: never;
3353
3377
  trace?: never;
3354
3378
  };
3355
- "/platform/content/manual/{manualId}/fetch": {
3379
+ "/platform/example/{exampleId}/clone": {
3356
3380
  parameters: {
3357
3381
  query?: never;
3358
3382
  header?: never;
3359
3383
  path?: never;
3360
3384
  cookie?: never;
3361
3385
  };
3362
- /**
3363
- * Fetch a specific platform manual
3364
- * @description Retrieves the complete content and metadata of a specific manual. This
3365
- * includes the markdown content and all associated frontmatter.
3366
- *
3367
- */
3368
- get: operations["fetchPlatformContentManual"];
3386
+ get?: never;
3387
+ put?: never;
3388
+ /** Clone a platform example */
3389
+ post: operations["clonePlatformExample"];
3390
+ delete?: never;
3391
+ options?: never;
3392
+ head?: never;
3393
+ patch?: never;
3394
+ trace?: never;
3395
+ };
3396
+ "/platform/example/{exampleId}/fetch": {
3397
+ parameters: {
3398
+ query?: never;
3399
+ header?: never;
3400
+ path?: never;
3401
+ cookie?: never;
3402
+ };
3403
+ /** Fetch a specific platform example with full details */
3404
+ get: operations["fetchPlatformExample"];
3369
3405
  put?: never;
3370
3406
  post?: never;
3371
3407
  delete?: never;
@@ -3374,19 +3410,15 @@ export interface paths {
3374
3410
  patch?: never;
3375
3411
  trace?: never;
3376
3412
  };
3377
- "/platform/content/manual/list": {
3413
+ "/platform/example/list": {
3378
3414
  parameters: {
3379
3415
  query?: never;
3380
3416
  header?: never;
3381
3417
  path?: never;
3382
3418
  cookie?: never;
3383
3419
  };
3384
- /**
3385
- * Retrieve a list of platform manuals
3386
- * @description Returns a list of available documentation manuals with their metadata.
3387
- *
3388
- */
3389
- get: operations["listPlatformContentManuals"];
3420
+ /** Retrieve a list of platform examples */
3421
+ get: operations["listPlatformExamples"];
3390
3422
  put?: never;
3391
3423
  post?: never;
3392
3424
  delete?: never;
@@ -3395,7 +3427,7 @@ export interface paths {
3395
3427
  patch?: never;
3396
3428
  trace?: never;
3397
3429
  };
3398
- "/platform/content/manual/search": {
3430
+ "/platform/example/search": {
3399
3431
  parameters: {
3400
3432
  query?: never;
3401
3433
  header?: never;
@@ -3404,15 +3436,15 @@ export interface paths {
3404
3436
  };
3405
3437
  get?: never;
3406
3438
  put?: never;
3407
- /** Search platform manuals using semantic similarity */
3408
- post: operations["searchPlatformContentManuals"];
3439
+ /** Search platform examples using semantic similarity */
3440
+ post: operations["searchPlatformExamples"];
3409
3441
  delete?: never;
3410
3442
  options?: never;
3411
3443
  head?: never;
3412
3444
  patch?: never;
3413
3445
  trace?: never;
3414
3446
  };
3415
- "/platform/content/tutorial/{tutorialId}/fetch": {
3447
+ "/platform/manual/{manualId}/fetch": {
3416
3448
  parameters: {
3417
3449
  query?: never;
3418
3450
  header?: never;
@@ -3420,12 +3452,12 @@ export interface paths {
3420
3452
  cookie?: never;
3421
3453
  };
3422
3454
  /**
3423
- * Fetch a specific platform tutorial
3424
- * @description Retrieves the complete content and metadata of a specific tutorial. This
3455
+ * Fetch a specific platform manual
3456
+ * @description Retrieves the complete content and metadata of a specific manual. This
3425
3457
  * includes the markdown content and all associated frontmatter.
3426
3458
  *
3427
3459
  */
3428
- get: operations["fetchPlatformContentTutorial"];
3460
+ get: operations["fetchPlatformManual"];
3429
3461
  put?: never;
3430
3462
  post?: never;
3431
3463
  delete?: never;
@@ -3434,7 +3466,7 @@ export interface paths {
3434
3466
  patch?: never;
3435
3467
  trace?: never;
3436
3468
  };
3437
- "/platform/content/tutorial/list": {
3469
+ "/platform/manual/list": {
3438
3470
  parameters: {
3439
3471
  query?: never;
3440
3472
  header?: never;
@@ -3442,11 +3474,11 @@ export interface paths {
3442
3474
  cookie?: never;
3443
3475
  };
3444
3476
  /**
3445
- * Retrieve a list of platform tutorials
3446
- * @description Returns a list of available tutorials with their metadata.
3477
+ * Retrieve a list of platform manuals
3478
+ * @description Returns a list of available documentation manuals with their metadata.
3447
3479
  *
3448
3480
  */
3449
- get: operations["listPlatformContentTutorials"];
3481
+ get: operations["listPlatformManuals"];
3450
3482
  put?: never;
3451
3483
  post?: never;
3452
3484
  delete?: never;
@@ -3455,7 +3487,7 @@ export interface paths {
3455
3487
  patch?: never;
3456
3488
  trace?: never;
3457
3489
  };
3458
- "/platform/content/tutorial/search": {
3490
+ "/platform/manual/search": {
3459
3491
  parameters: {
3460
3492
  query?: never;
3461
3493
  header?: never;
@@ -3464,40 +3496,40 @@ export interface paths {
3464
3496
  };
3465
3497
  get?: never;
3466
3498
  put?: never;
3467
- /** Search platform tutorials using semantic similarity */
3468
- post: operations["searchPlatformContentTutorials"];
3499
+ /** Search platform manuals using semantic similarity */
3500
+ post: operations["searchPlatformManuals"];
3469
3501
  delete?: never;
3470
3502
  options?: never;
3471
3503
  head?: never;
3472
3504
  patch?: never;
3473
3505
  trace?: never;
3474
3506
  };
3475
- "/platform/example/{exampleId}/clone": {
3507
+ "/platform/model/list": {
3476
3508
  parameters: {
3477
3509
  query?: never;
3478
3510
  header?: never;
3479
3511
  path?: never;
3480
3512
  cookie?: never;
3481
3513
  };
3482
- get?: never;
3514
+ /** Retrieve a list of platform models */
3515
+ get: operations["listPlatformModels"];
3483
3516
  put?: never;
3484
- /** Clone a platform example */
3485
- post: operations["clonePlatformExample"];
3517
+ post?: never;
3486
3518
  delete?: never;
3487
3519
  options?: never;
3488
3520
  head?: never;
3489
3521
  patch?: never;
3490
3522
  trace?: never;
3491
3523
  };
3492
- "/platform/example/list": {
3524
+ "/platform/secret/list": {
3493
3525
  parameters: {
3494
3526
  query?: never;
3495
3527
  header?: never;
3496
3528
  path?: never;
3497
3529
  cookie?: never;
3498
3530
  };
3499
- /** Retrieve a list of platform examples */
3500
- get: operations["listPlatformExamples"];
3531
+ /** Retrieve a list of platform secrets */
3532
+ get: operations["listPlatformSecrets"];
3501
3533
  put?: never;
3502
3534
  post?: never;
3503
3535
  delete?: never;
@@ -3506,32 +3538,41 @@ export interface paths {
3506
3538
  patch?: never;
3507
3539
  trace?: never;
3508
3540
  };
3509
- "/platform/example/search": {
3541
+ "/platform/tutorial/{tutorialId}/fetch": {
3510
3542
  parameters: {
3511
3543
  query?: never;
3512
3544
  header?: never;
3513
3545
  path?: never;
3514
3546
  cookie?: never;
3515
3547
  };
3516
- get?: never;
3548
+ /**
3549
+ * Fetch a specific platform tutorial
3550
+ * @description Retrieves the complete content and metadata of a specific tutorial. This
3551
+ * includes the markdown content and all associated frontmatter.
3552
+ *
3553
+ */
3554
+ get: operations["fetchPlatformTutorial"];
3517
3555
  put?: never;
3518
- /** Search platform examples using semantic similarity */
3519
- post: operations["searchPlatformExamples"];
3556
+ post?: never;
3520
3557
  delete?: never;
3521
3558
  options?: never;
3522
3559
  head?: never;
3523
3560
  patch?: never;
3524
3561
  trace?: never;
3525
3562
  };
3526
- "/platform/model/list": {
3563
+ "/platform/tutorial/list": {
3527
3564
  parameters: {
3528
3565
  query?: never;
3529
3566
  header?: never;
3530
3567
  path?: never;
3531
3568
  cookie?: never;
3532
3569
  };
3533
- /** Retrieve a list of platform models */
3534
- get: operations["listPlatformModels"];
3570
+ /**
3571
+ * Retrieve a list of platform tutorials
3572
+ * @description Returns a list of available tutorials with their metadata.
3573
+ *
3574
+ */
3575
+ get: operations["listPlatformTutorials"];
3535
3576
  put?: never;
3536
3577
  post?: never;
3537
3578
  delete?: never;
@@ -3540,17 +3581,17 @@ export interface paths {
3540
3581
  patch?: never;
3541
3582
  trace?: never;
3542
3583
  };
3543
- "/platform/secret/list": {
3584
+ "/platform/tutorial/search": {
3544
3585
  parameters: {
3545
3586
  query?: never;
3546
3587
  header?: never;
3547
3588
  path?: never;
3548
3589
  cookie?: never;
3549
3590
  };
3550
- /** Retrieve a list of platform secrets */
3551
- get: operations["listPlatformSecrets"];
3591
+ get?: never;
3552
3592
  put?: never;
3553
- post?: never;
3593
+ /** Search platform tutorials using semantic similarity */
3594
+ post: operations["searchPlatformTutorials"];
3554
3595
  delete?: never;
3555
3596
  options?: never;
3556
3597
  head?: never;
@@ -4375,6 +4416,16 @@ export interface components {
4375
4416
  * @enum {string}
4376
4417
  */
4377
4418
  Schedule: "never" | "quarterhourly" | "halfhourly" | "hourly" | "daily" | "weekly" | "monthly";
4419
+ /**
4420
+ * @description The task execution status
4421
+ * @enum {string}
4422
+ */
4423
+ TaskStatus: "idle" | "running";
4424
+ /**
4425
+ * @description The task execution outcome
4426
+ * @enum {string}
4427
+ */
4428
+ TaskOutcome: "pending" | "success" | "failure";
4378
4429
  /**
4379
4430
  * @description The blueprint visibility
4380
4431
  * @enum {string}
@@ -4914,7 +4965,7 @@ export interface operations {
4914
4965
  };
4915
4966
  };
4916
4967
  };
4917
- fetchReport: {
4968
+ generateReport: {
4918
4969
  parameters: {
4919
4970
  query?: never;
4920
4971
  header?: never;
@@ -4958,6 +5009,54 @@ export interface operations {
4958
5009
  };
4959
5010
  };
4960
5011
  };
5012
+ generateReports: {
5013
+ parameters: {
5014
+ query?: never;
5015
+ header?: never;
5016
+ path?: never;
5017
+ cookie?: never;
5018
+ };
5019
+ requestBody: {
5020
+ content: {
5021
+ /** @example {
5022
+ * "clr3m5n8k000008jq7h9e5b1a": {
5023
+ * "periodDays": 30
5024
+ * },
5025
+ * "clr3m5n8k000108jq7h9e5b1b": {
5026
+ * "periodDays": 7
5027
+ * }
5028
+ * } */
5029
+ "application/json": {
5030
+ [key: string]: Record<string, never>;
5031
+ };
5032
+ };
5033
+ };
5034
+ responses: {
5035
+ /** @description The reports were generated successfully */
5036
+ 200: {
5037
+ headers: {
5038
+ [name: string]: unknown;
5039
+ };
5040
+ content: {
5041
+ "application/json": {
5042
+ [key: string]: Record<string, never> | {
5043
+ /** @description Error message if report generation failed */
5044
+ error?: string;
5045
+ };
5046
+ };
5047
+ };
5048
+ };
5049
+ /** @description An error response */
5050
+ default: {
5051
+ headers: {
5052
+ [name: string]: unknown;
5053
+ };
5054
+ content: {
5055
+ "application/json": unknown;
5056
+ };
5057
+ };
5058
+ };
5059
+ };
4961
5060
  cloneBlueprint: {
4962
5061
  parameters: {
4963
5062
  query?: never;
@@ -17325,7 +17424,7 @@ export interface operations {
17325
17424
  };
17326
17425
  };
17327
17426
  };
17328
- fetchPlatformContentDoc: {
17427
+ fetchPlatformDoc: {
17329
17428
  parameters: {
17330
17429
  query?: never;
17331
17430
  header?: never;
@@ -17366,7 +17465,7 @@ export interface operations {
17366
17465
  /** @description The markdown content of the doc */
17367
17466
  content: string;
17368
17467
  /** @description The URL to the official documentation page */
17369
- url?: string;
17468
+ link?: string;
17370
17469
  };
17371
17470
  };
17372
17471
  };
@@ -17388,7 +17487,7 @@ export interface operations {
17388
17487
  };
17389
17488
  };
17390
17489
  };
17391
- listPlatformContentDocs: {
17490
+ listPlatformDocs: {
17392
17491
  parameters: {
17393
17492
  query?: {
17394
17493
  cursor?: string;
@@ -17415,7 +17514,7 @@ export interface operations {
17415
17514
  /** @description The associated name */
17416
17515
  name: string;
17417
17516
  /** @description The associated description */
17418
- description?: string;
17517
+ description: string;
17419
17518
  /** @description Meta data information */
17420
17519
  meta?: {
17421
17520
  [key: string]: unknown;
@@ -17429,11 +17528,11 @@ export interface operations {
17429
17528
  /** @description The category of the doc */
17430
17529
  category?: string;
17431
17530
  /** @description Tags associated with the doc */
17432
- tags?: string[];
17531
+ tags: string[];
17433
17532
  /** @description The display order index */
17434
- index?: number;
17533
+ index: number;
17435
17534
  /** @description The URL to the official documentation page */
17436
- url?: string;
17535
+ link: string;
17437
17536
  }[];
17438
17537
  };
17439
17538
  "application/jsonl": {
@@ -17447,7 +17546,7 @@ export interface operations {
17447
17546
  /** @description The associated name */
17448
17547
  name: string;
17449
17548
  /** @description The associated description */
17450
- description?: string;
17549
+ description: string;
17451
17550
  /** @description Meta data information */
17452
17551
  meta?: {
17453
17552
  [key: string]: unknown;
@@ -17461,11 +17560,11 @@ export interface operations {
17461
17560
  /** @description The category of the doc */
17462
17561
  category?: string;
17463
17562
  /** @description Tags associated with the doc */
17464
- tags?: string[];
17563
+ tags: string[];
17465
17564
  /** @description The display order index */
17466
- index?: number;
17565
+ index: number;
17467
17566
  /** @description The URL to the official documentation page */
17468
- url?: string;
17567
+ link: string;
17469
17568
  };
17470
17569
  };
17471
17570
  };
@@ -17481,7 +17580,7 @@ export interface operations {
17481
17580
  };
17482
17581
  };
17483
17582
  };
17484
- searchPlatformContentDocs: {
17583
+ searchPlatformDocs: {
17485
17584
  parameters: {
17486
17585
  query?: never;
17487
17586
  header?: never;
@@ -17535,7 +17634,7 @@ export interface operations {
17535
17634
  /** @description An excerpt from the most relevant part of the doc */
17536
17635
  excerpt: string;
17537
17636
  /** @description The URL to the official documentation page */
17538
- url: string;
17637
+ link: string;
17539
17638
  }[];
17540
17639
  };
17541
17640
  };
@@ -17551,52 +17650,98 @@ export interface operations {
17551
17650
  };
17552
17651
  };
17553
17652
  };
17554
- fetchPlatformContentManual: {
17653
+ clonePlatformExample: {
17555
17654
  parameters: {
17556
17655
  query?: never;
17557
17656
  header?: never;
17558
17657
  path: {
17559
- manualId: string;
17658
+ exampleId: string;
17659
+ };
17660
+ cookie?: never;
17661
+ };
17662
+ requestBody: {
17663
+ content: {
17664
+ "application/json": Record<string, never>;
17665
+ };
17666
+ };
17667
+ responses: {
17668
+ /** @description The example was cloned successfully */
17669
+ 200: {
17670
+ headers: {
17671
+ [name: string]: unknown;
17672
+ };
17673
+ content: {
17674
+ "application/json": {
17675
+ /** @description A map of resource types to arrays of created resources */
17676
+ resources: {
17677
+ [key: string]: {
17678
+ /** @description The unique identifier of the resource */
17679
+ id: string;
17680
+ /** @description The name of the resource */
17681
+ name?: string;
17682
+ /** @description The description of the resource */
17683
+ description?: string;
17684
+ }[];
17685
+ };
17686
+ };
17687
+ };
17688
+ };
17689
+ /** @description An error response */
17690
+ default: {
17691
+ headers: {
17692
+ [name: string]: unknown;
17693
+ };
17694
+ content: {
17695
+ "application/json": unknown;
17696
+ };
17697
+ };
17698
+ };
17699
+ };
17700
+ fetchPlatformExample: {
17701
+ parameters: {
17702
+ query?: never;
17703
+ header?: never;
17704
+ path: {
17705
+ exampleId: string;
17560
17706
  };
17561
17707
  cookie?: never;
17562
17708
  };
17563
17709
  requestBody?: never;
17564
17710
  responses: {
17565
- /** @description The manual was retrieved successfully */
17711
+ /** @description The example was fetched successfully */
17566
17712
  200: {
17567
17713
  headers: {
17568
17714
  [name: string]: unknown;
17569
17715
  };
17570
17716
  content: {
17571
17717
  "application/json": {
17572
- /** @description The associated name */
17718
+ /** @description The ID (slug) of the example */
17719
+ id: string;
17720
+ /** @description The name of the example */
17573
17721
  name: string;
17574
- /** @description The associated description */
17575
- description?: string;
17576
- /** @description Meta data information */
17577
- meta?: {
17722
+ /** @description The description of the example */
17723
+ description: string;
17724
+ /**
17725
+ * @description The type of the example
17726
+ * @enum {string}
17727
+ */
17728
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17729
+ /** @description The full configuration details of the example */
17730
+ config: {
17578
17731
  [key: string]: unknown;
17579
17732
  };
17580
- /** @description The instance ID */
17581
- id: string;
17582
- /** @description The timestamp (ms) when the instance was created */
17583
- createdAt: number;
17584
- /** @description The timestamp (ms) when the instance was updated */
17585
- updatedAt: number;
17586
- /** @description The category of the manual */
17587
- category?: string;
17588
- /** @description Tags associated with the manual */
17733
+ /** @description The URL to the official example page */
17734
+ link: string;
17735
+ /** @description Tags associated with the example */
17589
17736
  tags?: string[];
17590
- /** @description The display order index */
17591
- index?: number;
17592
- /** @description The markdown content of the manual */
17593
- content: string;
17594
- /** @description The URL to the official documentation page */
17595
- url?: string;
17737
+ /** @description The creation timestamp */
17738
+ createdAt?: number;
17739
+ /** @description The last update timestamp */
17740
+ updatedAt?: number;
17596
17741
  };
17597
17742
  };
17598
17743
  };
17599
- /** @description Manual not found */
17744
+ /** @description The example was not found */
17600
17745
  404: {
17601
17746
  headers: {
17602
17747
  [name: string]: unknown;
@@ -17614,7 +17759,7 @@ export interface operations {
17614
17759
  };
17615
17760
  };
17616
17761
  };
17617
- listPlatformContentManuals: {
17762
+ listPlatformExamples: {
17618
17763
  parameters: {
17619
17764
  query?: {
17620
17765
  cursor?: string;
@@ -17630,7 +17775,7 @@ export interface operations {
17630
17775
  };
17631
17776
  requestBody?: never;
17632
17777
  responses: {
17633
- /** @description The list of manuals was retrieved successfully */
17778
+ /** @description The list of examples was retrieved successfully */
17634
17779
  200: {
17635
17780
  headers: {
17636
17781
  [name: string]: unknown;
@@ -17641,7 +17786,7 @@ export interface operations {
17641
17786
  /** @description The associated name */
17642
17787
  name: string;
17643
17788
  /** @description The associated description */
17644
- description?: string;
17789
+ description: string;
17645
17790
  /** @description Meta data information */
17646
17791
  meta?: {
17647
17792
  [key: string]: unknown;
@@ -17652,14 +17797,15 @@ export interface operations {
17652
17797
  createdAt: number;
17653
17798
  /** @description The timestamp (ms) when the instance was updated */
17654
17799
  updatedAt: number;
17655
- /** @description The category of the manual */
17656
- category?: string;
17657
- /** @description Tags associated with the manual */
17800
+ /**
17801
+ * @description The type of the example
17802
+ * @enum {string}
17803
+ */
17804
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17805
+ /** @description Tags associated with the example */
17658
17806
  tags?: string[];
17659
- /** @description The display order index */
17660
- index?: number;
17661
- /** @description The URL to the official documentation page */
17662
- url?: string;
17807
+ /** @description The URL to the official example page */
17808
+ link: string;
17663
17809
  }[];
17664
17810
  };
17665
17811
  "application/jsonl": {
@@ -17673,7 +17819,7 @@ export interface operations {
17673
17819
  /** @description The associated name */
17674
17820
  name: string;
17675
17821
  /** @description The associated description */
17676
- description?: string;
17822
+ description: string;
17677
17823
  /** @description Meta data information */
17678
17824
  meta?: {
17679
17825
  [key: string]: unknown;
@@ -17684,14 +17830,15 @@ export interface operations {
17684
17830
  createdAt: number;
17685
17831
  /** @description The timestamp (ms) when the instance was updated */
17686
17832
  updatedAt: number;
17687
- /** @description The category of the manual */
17688
- category?: string;
17689
- /** @description Tags associated with the manual */
17833
+ /**
17834
+ * @description The type of the example
17835
+ * @enum {string}
17836
+ */
17837
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17838
+ /** @description Tags associated with the example */
17690
17839
  tags?: string[];
17691
- /** @description The display order index */
17692
- index?: number;
17693
- /** @description The URL to the official documentation page */
17694
- url?: string;
17840
+ /** @description The URL to the official example page */
17841
+ link: string;
17695
17842
  };
17696
17843
  };
17697
17844
  };
@@ -17707,7 +17854,7 @@ export interface operations {
17707
17854
  };
17708
17855
  };
17709
17856
  };
17710
- searchPlatformContentManuals: {
17857
+ searchPlatformExamples: {
17711
17858
  parameters: {
17712
17859
  query?: never;
17713
17860
  header?: never;
@@ -17717,7 +17864,7 @@ export interface operations {
17717
17864
  requestBody: {
17718
17865
  content: {
17719
17866
  "application/json": {
17720
- /** @description The search query to find relevant manuals */
17867
+ /** @description The search query to find relevant examples */
17721
17868
  search: string;
17722
17869
  /**
17723
17870
  * @description The maximum number of results to return (1-100, default 10)
@@ -17750,18 +17897,15 @@ export interface operations {
17750
17897
  createdAt: number;
17751
17898
  /** @description The timestamp (ms) when the instance was updated */
17752
17899
  updatedAt: number;
17753
- /** @description The category of the manual */
17754
- category?: string;
17755
- /** @description Tags associated with the manual */
17756
- tags: string[];
17757
- /** @description The display order index */
17758
- index: number;
17759
- /** @description The similarity score of the search result */
17760
- score: number;
17761
- /** @description An excerpt from the most relevant part of the manual */
17762
- excerpt: string;
17763
- /** @description The URL to the official documentation page */
17764
- url: string;
17900
+ /**
17901
+ * @description The type of the example
17902
+ * @enum {string}
17903
+ */
17904
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17905
+ /** @description Tags associated with the example */
17906
+ tags?: string[];
17907
+ /** @description The URL to the official example page */
17908
+ link: string;
17765
17909
  }[];
17766
17910
  };
17767
17911
  };
@@ -17777,18 +17921,18 @@ export interface operations {
17777
17921
  };
17778
17922
  };
17779
17923
  };
17780
- fetchPlatformContentTutorial: {
17924
+ fetchPlatformManual: {
17781
17925
  parameters: {
17782
17926
  query?: never;
17783
17927
  header?: never;
17784
17928
  path: {
17785
- tutorialId: string;
17929
+ manualId: string;
17786
17930
  };
17787
17931
  cookie?: never;
17788
17932
  };
17789
17933
  requestBody?: never;
17790
17934
  responses: {
17791
- /** @description The tutorial was retrieved successfully */
17935
+ /** @description The manual was retrieved successfully */
17792
17936
  200: {
17793
17937
  headers: {
17794
17938
  [name: string]: unknown;
@@ -17809,20 +17953,20 @@ export interface operations {
17809
17953
  createdAt: number;
17810
17954
  /** @description The timestamp (ms) when the instance was updated */
17811
17955
  updatedAt: number;
17812
- /** @description The category of the tutorial */
17956
+ /** @description The category of the manual */
17813
17957
  category?: string;
17814
- /** @description Tags associated with the tutorial */
17958
+ /** @description Tags associated with the manual */
17815
17959
  tags?: string[];
17816
17960
  /** @description The display order index */
17817
17961
  index?: number;
17818
- /** @description The markdown content of the tutorial */
17962
+ /** @description The markdown content of the manual */
17819
17963
  content: string;
17820
- /** @description The URL to the official tutorial page */
17821
- url?: string;
17964
+ /** @description The URL to the official documentation page */
17965
+ link?: string;
17822
17966
  };
17823
17967
  };
17824
17968
  };
17825
- /** @description Tutorial not found */
17969
+ /** @description Manual not found */
17826
17970
  404: {
17827
17971
  headers: {
17828
17972
  [name: string]: unknown;
@@ -17840,7 +17984,7 @@ export interface operations {
17840
17984
  };
17841
17985
  };
17842
17986
  };
17843
- listPlatformContentTutorials: {
17987
+ listPlatformManuals: {
17844
17988
  parameters: {
17845
17989
  query?: {
17846
17990
  cursor?: string;
@@ -17856,7 +18000,7 @@ export interface operations {
17856
18000
  };
17857
18001
  requestBody?: never;
17858
18002
  responses: {
17859
- /** @description The list of tutorials was retrieved successfully */
18003
+ /** @description The list of manuals was retrieved successfully */
17860
18004
  200: {
17861
18005
  headers: {
17862
18006
  [name: string]: unknown;
@@ -17867,7 +18011,7 @@ export interface operations {
17867
18011
  /** @description The associated name */
17868
18012
  name: string;
17869
18013
  /** @description The associated description */
17870
- description?: string;
18014
+ description: string;
17871
18015
  /** @description Meta data information */
17872
18016
  meta?: {
17873
18017
  [key: string]: unknown;
@@ -17878,14 +18022,14 @@ export interface operations {
17878
18022
  createdAt: number;
17879
18023
  /** @description The timestamp (ms) when the instance was updated */
17880
18024
  updatedAt: number;
17881
- /** @description The category of the tutorial */
18025
+ /** @description The category of the manual */
17882
18026
  category?: string;
17883
- /** @description Tags associated with the tutorial */
17884
- tags?: string[];
18027
+ /** @description Tags associated with the manual */
18028
+ tags: string[];
17885
18029
  /** @description The display order index */
17886
- index?: number;
17887
- /** @description The URL to the official tutorial page */
17888
- url?: string;
18030
+ index: number;
18031
+ /** @description The URL to the official documentation page */
18032
+ link: string;
17889
18033
  }[];
17890
18034
  };
17891
18035
  "application/jsonl": {
@@ -17899,7 +18043,7 @@ export interface operations {
17899
18043
  /** @description The associated name */
17900
18044
  name: string;
17901
18045
  /** @description The associated description */
17902
- description?: string;
18046
+ description: string;
17903
18047
  /** @description Meta data information */
17904
18048
  meta?: {
17905
18049
  [key: string]: unknown;
@@ -17910,14 +18054,14 @@ export interface operations {
17910
18054
  createdAt: number;
17911
18055
  /** @description The timestamp (ms) when the instance was updated */
17912
18056
  updatedAt: number;
17913
- /** @description The category of the tutorial */
18057
+ /** @description The category of the manual */
17914
18058
  category?: string;
17915
- /** @description Tags associated with the tutorial */
17916
- tags?: string[];
18059
+ /** @description Tags associated with the manual */
18060
+ tags: string[];
17917
18061
  /** @description The display order index */
17918
- index?: number;
17919
- /** @description The URL to the official tutorial page */
17920
- url?: string;
18062
+ index: number;
18063
+ /** @description The URL to the official documentation page */
18064
+ link: string;
17921
18065
  };
17922
18066
  };
17923
18067
  };
@@ -17933,7 +18077,7 @@ export interface operations {
17933
18077
  };
17934
18078
  };
17935
18079
  };
17936
- searchPlatformContentTutorials: {
18080
+ searchPlatformManuals: {
17937
18081
  parameters: {
17938
18082
  query?: never;
17939
18083
  header?: never;
@@ -17943,7 +18087,7 @@ export interface operations {
17943
18087
  requestBody: {
17944
18088
  content: {
17945
18089
  "application/json": {
17946
- /** @description The search query to find relevant tutorials */
18090
+ /** @description The search query to find relevant manuals */
17947
18091
  search: string;
17948
18092
  /**
17949
18093
  * @description The maximum number of results to return (1-100, default 10)
@@ -17976,18 +18120,18 @@ export interface operations {
17976
18120
  createdAt: number;
17977
18121
  /** @description The timestamp (ms) when the instance was updated */
17978
18122
  updatedAt: number;
17979
- /** @description The category of the tutorial */
18123
+ /** @description The category of the manual */
17980
18124
  category?: string;
17981
- /** @description Tags associated with the tutorial */
18125
+ /** @description Tags associated with the manual */
17982
18126
  tags: string[];
17983
18127
  /** @description The display order index */
17984
18128
  index: number;
17985
18129
  /** @description The similarity score of the search result */
17986
18130
  score: number;
17987
- /** @description An excerpt from the most relevant part of the tutorial */
18131
+ /** @description An excerpt from the most relevant part of the manual */
17988
18132
  excerpt: string;
17989
- /** @description The URL to the official tutorial page */
17990
- url: string;
18133
+ /** @description The URL to the official documentation page */
18134
+ link: string;
17991
18135
  }[];
17992
18136
  };
17993
18137
  };
@@ -18003,38 +18147,88 @@ export interface operations {
18003
18147
  };
18004
18148
  };
18005
18149
  };
18006
- clonePlatformExample: {
18150
+ listPlatformModels: {
18007
18151
  parameters: {
18008
- query?: never;
18009
- header?: never;
18010
- path: {
18011
- exampleId: string;
18152
+ query?: {
18153
+ cursor?: string;
18154
+ order?: "asc" | "desc";
18155
+ take?: number;
18156
+ meta?: {
18157
+ [key: string]: string;
18158
+ };
18012
18159
  };
18160
+ header?: never;
18161
+ path?: never;
18013
18162
  cookie?: never;
18014
18163
  };
18015
- requestBody: {
18016
- content: {
18017
- "application/json": Record<string, never>;
18018
- };
18019
- };
18164
+ requestBody?: never;
18020
18165
  responses: {
18021
- /** @description The example was cloned successfully */
18166
+ /** @description The list of models was retrieved successfully */
18022
18167
  200: {
18023
18168
  headers: {
18024
18169
  [name: string]: unknown;
18025
18170
  };
18026
18171
  content: {
18027
18172
  "application/json": {
18028
- /** @description A map of resource types to arrays of created resources */
18029
- resources: {
18030
- [key: string]: {
18031
- /** @description The unique identifier of the resource */
18032
- id: string;
18033
- /** @description The name of the resource */
18034
- name?: string;
18035
- /** @description The description of the resource */
18036
- description?: string;
18037
- }[];
18173
+ items: {
18174
+ /** @description The associated name */
18175
+ name?: string;
18176
+ /** @description The associated description */
18177
+ description?: string;
18178
+ /** @description Meta data information */
18179
+ meta?: {
18180
+ [key: string]: unknown;
18181
+ };
18182
+ /** @description The instance ID */
18183
+ id: string;
18184
+ /** @description The timestamp (ms) when the instance was created */
18185
+ createdAt: number;
18186
+ /** @description The timestamp (ms) when the instance was updated */
18187
+ updatedAt: number;
18188
+ /** @description The backstory of the model */
18189
+ provider: string;
18190
+ /** @description The model of the model */
18191
+ family: string;
18192
+ /** @description The maximum number of tokens the model can use */
18193
+ maxTokens: number;
18194
+ /** @description The maximum number of tokens the model can accept */
18195
+ maxInputTokens: number;
18196
+ /** @description The maximum number of tokens the model can generate */
18197
+ maxOutputTokens: number;
18198
+ }[];
18199
+ };
18200
+ "application/jsonl": {
18201
+ /**
18202
+ * @description The type of event
18203
+ * @enum {string}
18204
+ */
18205
+ type: "item";
18206
+ /** @description Instance list properties */
18207
+ data: {
18208
+ /** @description The associated name */
18209
+ name?: string;
18210
+ /** @description The associated description */
18211
+ description?: string;
18212
+ /** @description Meta data information */
18213
+ meta?: {
18214
+ [key: string]: unknown;
18215
+ };
18216
+ /** @description The instance ID */
18217
+ id: string;
18218
+ /** @description The timestamp (ms) when the instance was created */
18219
+ createdAt: number;
18220
+ /** @description The timestamp (ms) when the instance was updated */
18221
+ updatedAt: number;
18222
+ /** @description The backstory of the model */
18223
+ provider: string;
18224
+ /** @description The model of the model */
18225
+ family: string;
18226
+ /** @description The maximum number of tokens the model can use */
18227
+ maxTokens: number;
18228
+ /** @description The maximum number of tokens the model can accept */
18229
+ maxInputTokens: number;
18230
+ /** @description The maximum number of tokens the model can generate */
18231
+ maxOutputTokens: number;
18038
18232
  };
18039
18233
  };
18040
18234
  };
@@ -18050,7 +18244,7 @@ export interface operations {
18050
18244
  };
18051
18245
  };
18052
18246
  };
18053
- listPlatformExamples: {
18247
+ listPlatformSecrets: {
18054
18248
  parameters: {
18055
18249
  query?: {
18056
18250
  cursor?: string;
@@ -18066,7 +18260,7 @@ export interface operations {
18066
18260
  };
18067
18261
  requestBody?: never;
18068
18262
  responses: {
18069
- /** @description The list of examples was retrieved successfully */
18263
+ /** @description The list of secrets was retrieved successfully */
18070
18264
  200: {
18071
18265
  headers: {
18072
18266
  [name: string]: unknown;
@@ -18075,9 +18269,9 @@ export interface operations {
18075
18269
  "application/json": {
18076
18270
  items: {
18077
18271
  /** @description The associated name */
18078
- name: string;
18272
+ name?: string;
18079
18273
  /** @description The associated description */
18080
- description: string;
18274
+ description?: string;
18081
18275
  /** @description Meta data information */
18082
18276
  meta?: {
18083
18277
  [key: string]: unknown;
@@ -18089,16 +18283,10 @@ export interface operations {
18089
18283
  /** @description The timestamp (ms) when the instance was updated */
18090
18284
  updatedAt: number;
18091
18285
  /**
18092
- * @description The type of the example
18286
+ * @description The type of the secret
18093
18287
  * @enum {string}
18094
18288
  */
18095
- type: "blueprint" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
18096
- /** @description The config details of the example */
18097
- config: {
18098
- [key: string]: unknown;
18099
- };
18100
- /** @description The keywords associated with the example */
18101
- keywords?: string[];
18289
+ type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18102
18290
  }[];
18103
18291
  };
18104
18292
  "application/jsonl": {
@@ -18110,9 +18298,9 @@ export interface operations {
18110
18298
  /** @description Instance list properties */
18111
18299
  data: {
18112
18300
  /** @description The associated name */
18113
- name: string;
18301
+ name?: string;
18114
18302
  /** @description The associated description */
18115
- description: string;
18303
+ description?: string;
18116
18304
  /** @description Meta data information */
18117
18305
  meta?: {
18118
18306
  [key: string]: unknown;
@@ -18124,16 +18312,10 @@ export interface operations {
18124
18312
  /** @description The timestamp (ms) when the instance was updated */
18125
18313
  updatedAt: number;
18126
18314
  /**
18127
- * @description The type of the example
18315
+ * @description The type of the secret
18128
18316
  * @enum {string}
18129
18317
  */
18130
- type: "blueprint" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
18131
- /** @description The config details of the example */
18132
- config: {
18133
- [key: string]: unknown;
18134
- };
18135
- /** @description The keywords associated with the example */
18136
- keywords?: string[];
18318
+ type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18137
18319
  };
18138
18320
  };
18139
18321
  };
@@ -18149,59 +18331,58 @@ export interface operations {
18149
18331
  };
18150
18332
  };
18151
18333
  };
18152
- searchPlatformExamples: {
18334
+ fetchPlatformTutorial: {
18153
18335
  parameters: {
18154
18336
  query?: never;
18155
18337
  header?: never;
18156
- path?: never;
18157
- cookie?: never;
18158
- };
18159
- requestBody: {
18160
- content: {
18161
- "application/json": {
18162
- /** @description The search query to find relevant examples */
18163
- search: string;
18164
- };
18338
+ path: {
18339
+ tutorialId: string;
18165
18340
  };
18341
+ cookie?: never;
18166
18342
  };
18343
+ requestBody?: never;
18167
18344
  responses: {
18168
- /** @description The search was successful */
18345
+ /** @description The tutorial was retrieved successfully */
18169
18346
  200: {
18170
18347
  headers: {
18171
18348
  [name: string]: unknown;
18172
18349
  };
18173
18350
  content: {
18174
18351
  "application/json": {
18175
- items: {
18176
- /** @description The associated name */
18177
- name: string;
18178
- /** @description The associated description */
18179
- description: string;
18180
- /** @description Meta data information */
18181
- meta?: {
18182
- [key: string]: unknown;
18183
- };
18184
- /** @description The instance ID */
18185
- id: string;
18186
- /** @description The timestamp (ms) when the instance was created */
18187
- createdAt: number;
18188
- /** @description The timestamp (ms) when the instance was updated */
18189
- updatedAt: number;
18190
- /**
18191
- * @description The type of the example
18192
- * @enum {string}
18193
- */
18194
- type: "blueprint" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
18195
- /** @description The config details of the example */
18196
- config: {
18197
- [key: string]: unknown;
18198
- };
18199
- /** @description The keywords associated with the example */
18200
- keywords?: string[];
18201
- }[];
18352
+ /** @description The associated name */
18353
+ name: string;
18354
+ /** @description The associated description */
18355
+ description?: string;
18356
+ /** @description Meta data information */
18357
+ meta?: {
18358
+ [key: string]: unknown;
18359
+ };
18360
+ /** @description The instance ID */
18361
+ id: string;
18362
+ /** @description The timestamp (ms) when the instance was created */
18363
+ createdAt: number;
18364
+ /** @description The timestamp (ms) when the instance was updated */
18365
+ updatedAt: number;
18366
+ /** @description The category of the tutorial */
18367
+ category?: string;
18368
+ /** @description Tags associated with the tutorial */
18369
+ tags?: string[];
18370
+ /** @description The display order index */
18371
+ index?: number;
18372
+ /** @description The markdown content of the tutorial */
18373
+ content: string;
18374
+ /** @description The URL to the official tutorial page */
18375
+ link?: string;
18202
18376
  };
18203
18377
  };
18204
18378
  };
18379
+ /** @description Tutorial not found */
18380
+ 404: {
18381
+ headers: {
18382
+ [name: string]: unknown;
18383
+ };
18384
+ content?: never;
18385
+ };
18205
18386
  /** @description An error response */
18206
18387
  default: {
18207
18388
  headers: {
@@ -18213,7 +18394,7 @@ export interface operations {
18213
18394
  };
18214
18395
  };
18215
18396
  };
18216
- listPlatformModels: {
18397
+ listPlatformTutorials: {
18217
18398
  parameters: {
18218
18399
  query?: {
18219
18400
  cursor?: string;
@@ -18229,7 +18410,7 @@ export interface operations {
18229
18410
  };
18230
18411
  requestBody?: never;
18231
18412
  responses: {
18232
- /** @description The list of models was retrieved successfully */
18413
+ /** @description The list of tutorials was retrieved successfully */
18233
18414
  200: {
18234
18415
  headers: {
18235
18416
  [name: string]: unknown;
@@ -18238,9 +18419,9 @@ export interface operations {
18238
18419
  "application/json": {
18239
18420
  items: {
18240
18421
  /** @description The associated name */
18241
- name?: string;
18422
+ name: string;
18242
18423
  /** @description The associated description */
18243
- description?: string;
18424
+ description: string;
18244
18425
  /** @description Meta data information */
18245
18426
  meta?: {
18246
18427
  [key: string]: unknown;
@@ -18251,16 +18432,14 @@ export interface operations {
18251
18432
  createdAt: number;
18252
18433
  /** @description The timestamp (ms) when the instance was updated */
18253
18434
  updatedAt: number;
18254
- /** @description The backstory of the model */
18255
- provider: string;
18256
- /** @description The model of the model */
18257
- family: string;
18258
- /** @description The maximum number of tokens the model can use */
18259
- maxTokens: number;
18260
- /** @description The maximum number of tokens the model can accept */
18261
- maxInputTokens: number;
18262
- /** @description The maximum number of tokens the model can generate */
18263
- maxOutputTokens: number;
18435
+ /** @description The category of the tutorial */
18436
+ category?: string;
18437
+ /** @description Tags associated with the tutorial */
18438
+ tags: string[];
18439
+ /** @description The display order index */
18440
+ index: number;
18441
+ /** @description The URL to the official tutorial page */
18442
+ link: string;
18264
18443
  }[];
18265
18444
  };
18266
18445
  "application/jsonl": {
@@ -18272,9 +18451,9 @@ export interface operations {
18272
18451
  /** @description Instance list properties */
18273
18452
  data: {
18274
18453
  /** @description The associated name */
18275
- name?: string;
18454
+ name: string;
18276
18455
  /** @description The associated description */
18277
- description?: string;
18456
+ description: string;
18278
18457
  /** @description Meta data information */
18279
18458
  meta?: {
18280
18459
  [key: string]: unknown;
@@ -18285,16 +18464,14 @@ export interface operations {
18285
18464
  createdAt: number;
18286
18465
  /** @description The timestamp (ms) when the instance was updated */
18287
18466
  updatedAt: number;
18288
- /** @description The backstory of the model */
18289
- provider: string;
18290
- /** @description The model of the model */
18291
- family: string;
18292
- /** @description The maximum number of tokens the model can use */
18293
- maxTokens: number;
18294
- /** @description The maximum number of tokens the model can accept */
18295
- maxInputTokens: number;
18296
- /** @description The maximum number of tokens the model can generate */
18297
- maxOutputTokens: number;
18467
+ /** @description The category of the tutorial */
18468
+ category?: string;
18469
+ /** @description Tags associated with the tutorial */
18470
+ tags: string[];
18471
+ /** @description The display order index */
18472
+ index: number;
18473
+ /** @description The URL to the official tutorial page */
18474
+ link: string;
18298
18475
  };
18299
18476
  };
18300
18477
  };
@@ -18310,23 +18487,28 @@ export interface operations {
18310
18487
  };
18311
18488
  };
18312
18489
  };
18313
- listPlatformSecrets: {
18490
+ searchPlatformTutorials: {
18314
18491
  parameters: {
18315
- query?: {
18316
- cursor?: string;
18317
- order?: "asc" | "desc";
18318
- take?: number;
18319
- meta?: {
18320
- [key: string]: string;
18321
- };
18322
- };
18492
+ query?: never;
18323
18493
  header?: never;
18324
18494
  path?: never;
18325
18495
  cookie?: never;
18326
18496
  };
18327
- requestBody?: never;
18497
+ requestBody: {
18498
+ content: {
18499
+ "application/json": {
18500
+ /** @description The search query to find relevant tutorials */
18501
+ search: string;
18502
+ /**
18503
+ * @description The maximum number of results to return (1-100, default 10)
18504
+ * @default 10
18505
+ */
18506
+ take?: number;
18507
+ };
18508
+ };
18509
+ };
18328
18510
  responses: {
18329
- /** @description The list of secrets was retrieved successfully */
18511
+ /** @description The search was successful */
18330
18512
  200: {
18331
18513
  headers: {
18332
18514
  [name: string]: unknown;
@@ -18335,9 +18517,9 @@ export interface operations {
18335
18517
  "application/json": {
18336
18518
  items: {
18337
18519
  /** @description The associated name */
18338
- name?: string;
18520
+ name: string;
18339
18521
  /** @description The associated description */
18340
- description?: string;
18522
+ description: string;
18341
18523
  /** @description Meta data information */
18342
18524
  meta?: {
18343
18525
  [key: string]: unknown;
@@ -18348,42 +18530,20 @@ export interface operations {
18348
18530
  createdAt: number;
18349
18531
  /** @description The timestamp (ms) when the instance was updated */
18350
18532
  updatedAt: number;
18351
- /**
18352
- * @description The type of the secret
18353
- * @enum {string}
18354
- */
18355
- type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18533
+ /** @description The category of the tutorial */
18534
+ category?: string;
18535
+ /** @description Tags associated with the tutorial */
18536
+ tags: string[];
18537
+ /** @description The display order index */
18538
+ index: number;
18539
+ /** @description The similarity score of the search result */
18540
+ score: number;
18541
+ /** @description An excerpt from the most relevant part of the tutorial */
18542
+ excerpt: string;
18543
+ /** @description The URL to the official tutorial page */
18544
+ link: string;
18356
18545
  }[];
18357
18546
  };
18358
- "application/jsonl": {
18359
- /**
18360
- * @description The type of event
18361
- * @enum {string}
18362
- */
18363
- type: "item";
18364
- /** @description Instance list properties */
18365
- data: {
18366
- /** @description The associated name */
18367
- name?: string;
18368
- /** @description The associated description */
18369
- description?: string;
18370
- /** @description Meta data information */
18371
- meta?: {
18372
- [key: string]: unknown;
18373
- };
18374
- /** @description The instance ID */
18375
- id: string;
18376
- /** @description The timestamp (ms) when the instance was created */
18377
- createdAt: number;
18378
- /** @description The timestamp (ms) when the instance was updated */
18379
- updatedAt: number;
18380
- /**
18381
- * @description The type of the secret
18382
- * @enum {string}
18383
- */
18384
- type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18385
- };
18386
- };
18387
18547
  };
18388
18548
  };
18389
18549
  /** @description An error response */
@@ -20555,6 +20715,16 @@ export interface operations {
20555
20715
  botId?: string;
20556
20716
  /** @description The schedule of the task */
20557
20717
  schedule?: string;
20718
+ /**
20719
+ * @description The task execution status
20720
+ * @enum {string}
20721
+ */
20722
+ status?: "idle" | "running";
20723
+ /**
20724
+ * @description The task execution outcome
20725
+ * @enum {string}
20726
+ */
20727
+ outcome?: "pending" | "success" | "failure";
20558
20728
  };
20559
20729
  };
20560
20730
  };
@@ -20849,6 +21019,16 @@ export interface operations {
20849
21019
  botId?: string;
20850
21020
  /** @description The schedule of the task */
20851
21021
  schedule?: string;
21022
+ /**
21023
+ * @description The task execution status
21024
+ * @enum {string}
21025
+ */
21026
+ status?: "idle" | "running";
21027
+ /**
21028
+ * @description The task execution outcome
21029
+ * @enum {string}
21030
+ */
21031
+ outcome?: "pending" | "success" | "failure";
20852
21032
  }[];
20853
21033
  };
20854
21034
  "application/jsonl": {
@@ -20879,6 +21059,16 @@ export interface operations {
20879
21059
  botId?: string;
20880
21060
  /** @description The schedule of the task */
20881
21061
  schedule?: string;
21062
+ /**
21063
+ * @description The task execution status
21064
+ * @enum {string}
21065
+ */
21066
+ status?: "idle" | "running";
21067
+ /**
21068
+ * @description The task execution outcome
21069
+ * @enum {string}
21070
+ */
21071
+ outcome?: "pending" | "success" | "failure";
20882
21072
  };
20883
21073
  };
20884
21074
  };