@chatbotkit/sdk 1.23.0 → 1.25.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 (41) 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/types/api/v1.d.ts +529 -309
  20. package/dist/cjs/types/report.d.ts +17 -1
  21. package/dist/esm/platform/doc/index.d.ts +8 -0
  22. package/dist/esm/platform/doc/index.js +17 -0
  23. package/dist/esm/platform/doc/v1.d.ts +19 -0
  24. package/dist/esm/platform/doc/v1.js +21 -0
  25. package/dist/esm/platform/example/index.d.ts +1 -0
  26. package/dist/esm/platform/example/index.js +4 -1
  27. package/dist/esm/platform/example/v1.d.ts +2 -0
  28. package/dist/esm/platform/example/v1.js +7 -0
  29. package/dist/esm/platform/index.d.ts +6 -2
  30. package/dist/esm/platform/index.js +6 -2
  31. package/dist/esm/platform/manual/index.d.ts +8 -0
  32. package/dist/esm/platform/manual/index.js +17 -0
  33. package/dist/esm/platform/manual/v1.d.ts +19 -0
  34. package/dist/esm/platform/manual/v1.js +21 -0
  35. package/dist/esm/platform/tutorial/index.d.ts +8 -0
  36. package/dist/esm/platform/tutorial/index.js +17 -0
  37. package/dist/esm/platform/tutorial/v1.d.ts +19 -0
  38. package/dist/esm/platform/tutorial/v1.js +21 -0
  39. package/dist/esm/types/api/v1.d.ts +529 -309
  40. package/dist/esm/types/report.d.ts +17 -1
  41. package/package.json +159 -9
@@ -60,6 +60,30 @@ export interface paths {
60
60
  patch?: never;
61
61
  trace?: never;
62
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"];
81
+ delete?: never;
82
+ options?: never;
83
+ head?: never;
84
+ patch?: never;
85
+ trace?: never;
86
+ };
63
87
  "/blueprint/{blueprintId}/clone": {
64
88
  parameters: {
65
89
  query?: 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}
@@ -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;
@@ -5009,7 +5108,13 @@ export interface operations {
5009
5108
  };
5010
5109
  requestBody: {
5011
5110
  content: {
5012
- "application/json": Record<string, never>;
5111
+ "application/json": {
5112
+ /**
5113
+ * @description If true, deletes all resources associated with the blueprint. If false or omitted, only the blueprint is deleted.
5114
+ * @default false
5115
+ */
5116
+ deleteResources?: boolean;
5117
+ };
5013
5118
  };
5014
5119
  };
5015
5120
  responses: {
@@ -6729,6 +6834,16 @@ export interface operations {
6729
6834
  botId?: string;
6730
6835
  /** @description The schedule of the task */
6731
6836
  schedule?: string;
6837
+ /**
6838
+ * @description The task execution status
6839
+ * @enum {string}
6840
+ */
6841
+ status?: "idle" | "running";
6842
+ /**
6843
+ * @description The task execution outcome
6844
+ * @enum {string}
6845
+ */
6846
+ outcome?: "pending" | "success" | "failure";
6732
6847
  }[];
6733
6848
  };
6734
6849
  "application/jsonl": {
@@ -6759,6 +6874,16 @@ export interface operations {
6759
6874
  botId?: string;
6760
6875
  /** @description The schedule of the task */
6761
6876
  schedule?: string;
6877
+ /**
6878
+ * @description The task execution status
6879
+ * @enum {string}
6880
+ */
6881
+ status?: "idle" | "running";
6882
+ /**
6883
+ * @description The task execution outcome
6884
+ * @enum {string}
6885
+ */
6886
+ outcome?: "pending" | "success" | "failure";
6762
6887
  };
6763
6888
  };
6764
6889
  };
@@ -17163,6 +17288,7 @@ export interface operations {
17163
17288
  createdAt: number;
17164
17289
  /** @description The timestamp (ms) when the instance was updated */
17165
17290
  updatedAt: number;
17291
+ instruction: string;
17166
17292
  icon: string;
17167
17293
  /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */
17168
17294
  schema: {
@@ -17182,6 +17308,7 @@ export interface operations {
17182
17308
  /** @description Required property names */
17183
17309
  required?: string[];
17184
17310
  };
17311
+ tags?: string[];
17185
17312
  setup?: string;
17186
17313
  commentary?: string;
17187
17314
  }[];
@@ -17208,6 +17335,7 @@ export interface operations {
17208
17335
  createdAt: number;
17209
17336
  /** @description The timestamp (ms) when the instance was updated */
17210
17337
  updatedAt: number;
17338
+ instruction: string;
17211
17339
  icon: string;
17212
17340
  /** @description A JSON Schema object type definition (https://json-schema.org/). Represents an object schema with properties and validation rules. */
17213
17341
  schema: {
@@ -17227,6 +17355,7 @@ export interface operations {
17227
17355
  /** @description Required property names */
17228
17356
  required?: string[];
17229
17357
  };
17358
+ tags?: string[];
17230
17359
  setup?: string;
17231
17360
  commentary?: string;
17232
17361
  };
@@ -17325,7 +17454,7 @@ export interface operations {
17325
17454
  };
17326
17455
  };
17327
17456
  };
17328
- fetchPlatformContentDoc: {
17457
+ fetchPlatformDoc: {
17329
17458
  parameters: {
17330
17459
  query?: never;
17331
17460
  header?: never;
@@ -17366,7 +17495,7 @@ export interface operations {
17366
17495
  /** @description The markdown content of the doc */
17367
17496
  content: string;
17368
17497
  /** @description The URL to the official documentation page */
17369
- url?: string;
17498
+ link?: string;
17370
17499
  };
17371
17500
  };
17372
17501
  };
@@ -17388,7 +17517,7 @@ export interface operations {
17388
17517
  };
17389
17518
  };
17390
17519
  };
17391
- listPlatformContentDocs: {
17520
+ listPlatformDocs: {
17392
17521
  parameters: {
17393
17522
  query?: {
17394
17523
  cursor?: string;
@@ -17415,7 +17544,7 @@ export interface operations {
17415
17544
  /** @description The associated name */
17416
17545
  name: string;
17417
17546
  /** @description The associated description */
17418
- description?: string;
17547
+ description: string;
17419
17548
  /** @description Meta data information */
17420
17549
  meta?: {
17421
17550
  [key: string]: unknown;
@@ -17429,11 +17558,11 @@ export interface operations {
17429
17558
  /** @description The category of the doc */
17430
17559
  category?: string;
17431
17560
  /** @description Tags associated with the doc */
17432
- tags?: string[];
17561
+ tags: string[];
17433
17562
  /** @description The display order index */
17434
- index?: number;
17563
+ index: number;
17435
17564
  /** @description The URL to the official documentation page */
17436
- url?: string;
17565
+ link: string;
17437
17566
  }[];
17438
17567
  };
17439
17568
  "application/jsonl": {
@@ -17447,7 +17576,7 @@ export interface operations {
17447
17576
  /** @description The associated name */
17448
17577
  name: string;
17449
17578
  /** @description The associated description */
17450
- description?: string;
17579
+ description: string;
17451
17580
  /** @description Meta data information */
17452
17581
  meta?: {
17453
17582
  [key: string]: unknown;
@@ -17461,11 +17590,11 @@ export interface operations {
17461
17590
  /** @description The category of the doc */
17462
17591
  category?: string;
17463
17592
  /** @description Tags associated with the doc */
17464
- tags?: string[];
17593
+ tags: string[];
17465
17594
  /** @description The display order index */
17466
- index?: number;
17595
+ index: number;
17467
17596
  /** @description The URL to the official documentation page */
17468
- url?: string;
17597
+ link: string;
17469
17598
  };
17470
17599
  };
17471
17600
  };
@@ -17481,7 +17610,7 @@ export interface operations {
17481
17610
  };
17482
17611
  };
17483
17612
  };
17484
- searchPlatformContentDocs: {
17613
+ searchPlatformDocs: {
17485
17614
  parameters: {
17486
17615
  query?: never;
17487
17616
  header?: never;
@@ -17535,7 +17664,7 @@ export interface operations {
17535
17664
  /** @description An excerpt from the most relevant part of the doc */
17536
17665
  excerpt: string;
17537
17666
  /** @description The URL to the official documentation page */
17538
- url: string;
17667
+ link: string;
17539
17668
  }[];
17540
17669
  };
17541
17670
  };
@@ -17551,52 +17680,98 @@ export interface operations {
17551
17680
  };
17552
17681
  };
17553
17682
  };
17554
- fetchPlatformContentManual: {
17683
+ clonePlatformExample: {
17555
17684
  parameters: {
17556
17685
  query?: never;
17557
17686
  header?: never;
17558
17687
  path: {
17559
- manualId: string;
17688
+ exampleId: string;
17689
+ };
17690
+ cookie?: never;
17691
+ };
17692
+ requestBody: {
17693
+ content: {
17694
+ "application/json": Record<string, never>;
17695
+ };
17696
+ };
17697
+ responses: {
17698
+ /** @description The example was cloned successfully */
17699
+ 200: {
17700
+ headers: {
17701
+ [name: string]: unknown;
17702
+ };
17703
+ content: {
17704
+ "application/json": {
17705
+ /** @description A map of resource types to arrays of created resources */
17706
+ resources: {
17707
+ [key: string]: {
17708
+ /** @description The unique identifier of the resource */
17709
+ id: string;
17710
+ /** @description The name of the resource */
17711
+ name?: string;
17712
+ /** @description The description of the resource */
17713
+ description?: string;
17714
+ }[];
17715
+ };
17716
+ };
17717
+ };
17718
+ };
17719
+ /** @description An error response */
17720
+ default: {
17721
+ headers: {
17722
+ [name: string]: unknown;
17723
+ };
17724
+ content: {
17725
+ "application/json": unknown;
17726
+ };
17727
+ };
17728
+ };
17729
+ };
17730
+ fetchPlatformExample: {
17731
+ parameters: {
17732
+ query?: never;
17733
+ header?: never;
17734
+ path: {
17735
+ exampleId: string;
17560
17736
  };
17561
17737
  cookie?: never;
17562
17738
  };
17563
17739
  requestBody?: never;
17564
17740
  responses: {
17565
- /** @description The manual was retrieved successfully */
17741
+ /** @description The example was fetched successfully */
17566
17742
  200: {
17567
17743
  headers: {
17568
17744
  [name: string]: unknown;
17569
17745
  };
17570
17746
  content: {
17571
17747
  "application/json": {
17572
- /** @description The associated name */
17748
+ /** @description The ID (slug) of the example */
17749
+ id: string;
17750
+ /** @description The name of the example */
17573
17751
  name: string;
17574
- /** @description The associated description */
17575
- description?: string;
17576
- /** @description Meta data information */
17577
- meta?: {
17752
+ /** @description The description of the example */
17753
+ description: string;
17754
+ /**
17755
+ * @description The type of the example
17756
+ * @enum {string}
17757
+ */
17758
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17759
+ /** @description The full configuration details of the example */
17760
+ config: {
17578
17761
  [key: string]: unknown;
17579
17762
  };
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 */
17763
+ /** @description The URL to the official example page */
17764
+ link: string;
17765
+ /** @description Tags associated with the example */
17589
17766
  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;
17767
+ /** @description The creation timestamp */
17768
+ createdAt?: number;
17769
+ /** @description The last update timestamp */
17770
+ updatedAt?: number;
17596
17771
  };
17597
17772
  };
17598
17773
  };
17599
- /** @description Manual not found */
17774
+ /** @description The example was not found */
17600
17775
  404: {
17601
17776
  headers: {
17602
17777
  [name: string]: unknown;
@@ -17614,7 +17789,7 @@ export interface operations {
17614
17789
  };
17615
17790
  };
17616
17791
  };
17617
- listPlatformContentManuals: {
17792
+ listPlatformExamples: {
17618
17793
  parameters: {
17619
17794
  query?: {
17620
17795
  cursor?: string;
@@ -17630,7 +17805,7 @@ export interface operations {
17630
17805
  };
17631
17806
  requestBody?: never;
17632
17807
  responses: {
17633
- /** @description The list of manuals was retrieved successfully */
17808
+ /** @description The list of examples was retrieved successfully */
17634
17809
  200: {
17635
17810
  headers: {
17636
17811
  [name: string]: unknown;
@@ -17641,7 +17816,7 @@ export interface operations {
17641
17816
  /** @description The associated name */
17642
17817
  name: string;
17643
17818
  /** @description The associated description */
17644
- description?: string;
17819
+ description: string;
17645
17820
  /** @description Meta data information */
17646
17821
  meta?: {
17647
17822
  [key: string]: unknown;
@@ -17652,14 +17827,15 @@ export interface operations {
17652
17827
  createdAt: number;
17653
17828
  /** @description The timestamp (ms) when the instance was updated */
17654
17829
  updatedAt: number;
17655
- /** @description The category of the manual */
17656
- category?: string;
17657
- /** @description Tags associated with the manual */
17830
+ /**
17831
+ * @description The type of the example
17832
+ * @enum {string}
17833
+ */
17834
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17835
+ /** @description Tags associated with the example */
17658
17836
  tags?: string[];
17659
- /** @description The display order index */
17660
- index?: number;
17661
- /** @description The URL to the official documentation page */
17662
- url?: string;
17837
+ /** @description The URL to the official example page */
17838
+ link: string;
17663
17839
  }[];
17664
17840
  };
17665
17841
  "application/jsonl": {
@@ -17673,7 +17849,7 @@ export interface operations {
17673
17849
  /** @description The associated name */
17674
17850
  name: string;
17675
17851
  /** @description The associated description */
17676
- description?: string;
17852
+ description: string;
17677
17853
  /** @description Meta data information */
17678
17854
  meta?: {
17679
17855
  [key: string]: unknown;
@@ -17684,14 +17860,15 @@ export interface operations {
17684
17860
  createdAt: number;
17685
17861
  /** @description The timestamp (ms) when the instance was updated */
17686
17862
  updatedAt: number;
17687
- /** @description The category of the manual */
17688
- category?: string;
17689
- /** @description Tags associated with the manual */
17863
+ /**
17864
+ * @description The type of the example
17865
+ * @enum {string}
17866
+ */
17867
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17868
+ /** @description Tags associated with the example */
17690
17869
  tags?: string[];
17691
- /** @description The display order index */
17692
- index?: number;
17693
- /** @description The URL to the official documentation page */
17694
- url?: string;
17870
+ /** @description The URL to the official example page */
17871
+ link: string;
17695
17872
  };
17696
17873
  };
17697
17874
  };
@@ -17707,7 +17884,7 @@ export interface operations {
17707
17884
  };
17708
17885
  };
17709
17886
  };
17710
- searchPlatformContentManuals: {
17887
+ searchPlatformExamples: {
17711
17888
  parameters: {
17712
17889
  query?: never;
17713
17890
  header?: never;
@@ -17717,7 +17894,7 @@ export interface operations {
17717
17894
  requestBody: {
17718
17895
  content: {
17719
17896
  "application/json": {
17720
- /** @description The search query to find relevant manuals */
17897
+ /** @description The search query to find relevant examples */
17721
17898
  search: string;
17722
17899
  /**
17723
17900
  * @description The maximum number of results to return (1-100, default 10)
@@ -17750,18 +17927,15 @@ export interface operations {
17750
17927
  createdAt: number;
17751
17928
  /** @description The timestamp (ms) when the instance was updated */
17752
17929
  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;
17930
+ /**
17931
+ * @description The type of the example
17932
+ * @enum {string}
17933
+ */
17934
+ type: "blueprint" | "project" | "widget" | "slack" | "discord" | "whatsapp" | "messenger" | "telegram" | "twilio" | "email" | "trigger";
17935
+ /** @description Tags associated with the example */
17936
+ tags?: string[];
17937
+ /** @description The URL to the official example page */
17938
+ link: string;
17765
17939
  }[];
17766
17940
  };
17767
17941
  };
@@ -17777,18 +17951,18 @@ export interface operations {
17777
17951
  };
17778
17952
  };
17779
17953
  };
17780
- fetchPlatformContentTutorial: {
17954
+ fetchPlatformManual: {
17781
17955
  parameters: {
17782
17956
  query?: never;
17783
17957
  header?: never;
17784
17958
  path: {
17785
- tutorialId: string;
17959
+ manualId: string;
17786
17960
  };
17787
17961
  cookie?: never;
17788
17962
  };
17789
17963
  requestBody?: never;
17790
17964
  responses: {
17791
- /** @description The tutorial was retrieved successfully */
17965
+ /** @description The manual was retrieved successfully */
17792
17966
  200: {
17793
17967
  headers: {
17794
17968
  [name: string]: unknown;
@@ -17809,20 +17983,20 @@ export interface operations {
17809
17983
  createdAt: number;
17810
17984
  /** @description The timestamp (ms) when the instance was updated */
17811
17985
  updatedAt: number;
17812
- /** @description The category of the tutorial */
17986
+ /** @description The category of the manual */
17813
17987
  category?: string;
17814
- /** @description Tags associated with the tutorial */
17988
+ /** @description Tags associated with the manual */
17815
17989
  tags?: string[];
17816
17990
  /** @description The display order index */
17817
17991
  index?: number;
17818
- /** @description The markdown content of the tutorial */
17992
+ /** @description The markdown content of the manual */
17819
17993
  content: string;
17820
- /** @description The URL to the official tutorial page */
17821
- url?: string;
17994
+ /** @description The URL to the official documentation page */
17995
+ link?: string;
17822
17996
  };
17823
17997
  };
17824
17998
  };
17825
- /** @description Tutorial not found */
17999
+ /** @description Manual not found */
17826
18000
  404: {
17827
18001
  headers: {
17828
18002
  [name: string]: unknown;
@@ -17840,7 +18014,7 @@ export interface operations {
17840
18014
  };
17841
18015
  };
17842
18016
  };
17843
- listPlatformContentTutorials: {
18017
+ listPlatformManuals: {
17844
18018
  parameters: {
17845
18019
  query?: {
17846
18020
  cursor?: string;
@@ -17856,7 +18030,7 @@ export interface operations {
17856
18030
  };
17857
18031
  requestBody?: never;
17858
18032
  responses: {
17859
- /** @description The list of tutorials was retrieved successfully */
18033
+ /** @description The list of manuals was retrieved successfully */
17860
18034
  200: {
17861
18035
  headers: {
17862
18036
  [name: string]: unknown;
@@ -17867,7 +18041,7 @@ export interface operations {
17867
18041
  /** @description The associated name */
17868
18042
  name: string;
17869
18043
  /** @description The associated description */
17870
- description?: string;
18044
+ description: string;
17871
18045
  /** @description Meta data information */
17872
18046
  meta?: {
17873
18047
  [key: string]: unknown;
@@ -17878,14 +18052,14 @@ export interface operations {
17878
18052
  createdAt: number;
17879
18053
  /** @description The timestamp (ms) when the instance was updated */
17880
18054
  updatedAt: number;
17881
- /** @description The category of the tutorial */
18055
+ /** @description The category of the manual */
17882
18056
  category?: string;
17883
- /** @description Tags associated with the tutorial */
17884
- tags?: string[];
18057
+ /** @description Tags associated with the manual */
18058
+ tags: string[];
17885
18059
  /** @description The display order index */
17886
- index?: number;
17887
- /** @description The URL to the official tutorial page */
17888
- url?: string;
18060
+ index: number;
18061
+ /** @description The URL to the official documentation page */
18062
+ link: string;
17889
18063
  }[];
17890
18064
  };
17891
18065
  "application/jsonl": {
@@ -17899,7 +18073,7 @@ export interface operations {
17899
18073
  /** @description The associated name */
17900
18074
  name: string;
17901
18075
  /** @description The associated description */
17902
- description?: string;
18076
+ description: string;
17903
18077
  /** @description Meta data information */
17904
18078
  meta?: {
17905
18079
  [key: string]: unknown;
@@ -17910,14 +18084,14 @@ export interface operations {
17910
18084
  createdAt: number;
17911
18085
  /** @description The timestamp (ms) when the instance was updated */
17912
18086
  updatedAt: number;
17913
- /** @description The category of the tutorial */
18087
+ /** @description The category of the manual */
17914
18088
  category?: string;
17915
- /** @description Tags associated with the tutorial */
17916
- tags?: string[];
18089
+ /** @description Tags associated with the manual */
18090
+ tags: string[];
17917
18091
  /** @description The display order index */
17918
- index?: number;
17919
- /** @description The URL to the official tutorial page */
17920
- url?: string;
18092
+ index: number;
18093
+ /** @description The URL to the official documentation page */
18094
+ link: string;
17921
18095
  };
17922
18096
  };
17923
18097
  };
@@ -17933,7 +18107,7 @@ export interface operations {
17933
18107
  };
17934
18108
  };
17935
18109
  };
17936
- searchPlatformContentTutorials: {
18110
+ searchPlatformManuals: {
17937
18111
  parameters: {
17938
18112
  query?: never;
17939
18113
  header?: never;
@@ -17943,7 +18117,7 @@ export interface operations {
17943
18117
  requestBody: {
17944
18118
  content: {
17945
18119
  "application/json": {
17946
- /** @description The search query to find relevant tutorials */
18120
+ /** @description The search query to find relevant manuals */
17947
18121
  search: string;
17948
18122
  /**
17949
18123
  * @description The maximum number of results to return (1-100, default 10)
@@ -17976,18 +18150,18 @@ export interface operations {
17976
18150
  createdAt: number;
17977
18151
  /** @description The timestamp (ms) when the instance was updated */
17978
18152
  updatedAt: number;
17979
- /** @description The category of the tutorial */
18153
+ /** @description The category of the manual */
17980
18154
  category?: string;
17981
- /** @description Tags associated with the tutorial */
18155
+ /** @description Tags associated with the manual */
17982
18156
  tags: string[];
17983
18157
  /** @description The display order index */
17984
18158
  index: number;
17985
18159
  /** @description The similarity score of the search result */
17986
18160
  score: number;
17987
- /** @description An excerpt from the most relevant part of the tutorial */
18161
+ /** @description An excerpt from the most relevant part of the manual */
17988
18162
  excerpt: string;
17989
- /** @description The URL to the official tutorial page */
17990
- url: string;
18163
+ /** @description The URL to the official documentation page */
18164
+ link: string;
17991
18165
  }[];
17992
18166
  };
17993
18167
  };
@@ -18003,38 +18177,88 @@ export interface operations {
18003
18177
  };
18004
18178
  };
18005
18179
  };
18006
- clonePlatformExample: {
18180
+ listPlatformModels: {
18007
18181
  parameters: {
18008
- query?: never;
18009
- header?: never;
18010
- path: {
18011
- exampleId: string;
18182
+ query?: {
18183
+ cursor?: string;
18184
+ order?: "asc" | "desc";
18185
+ take?: number;
18186
+ meta?: {
18187
+ [key: string]: string;
18188
+ };
18012
18189
  };
18190
+ header?: never;
18191
+ path?: never;
18013
18192
  cookie?: never;
18014
18193
  };
18015
- requestBody: {
18016
- content: {
18017
- "application/json": Record<string, never>;
18018
- };
18019
- };
18194
+ requestBody?: never;
18020
18195
  responses: {
18021
- /** @description The example was cloned successfully */
18196
+ /** @description The list of models was retrieved successfully */
18022
18197
  200: {
18023
18198
  headers: {
18024
18199
  [name: string]: unknown;
18025
18200
  };
18026
18201
  content: {
18027
18202
  "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
- }[];
18203
+ items: {
18204
+ /** @description The associated name */
18205
+ name?: string;
18206
+ /** @description The associated description */
18207
+ description?: string;
18208
+ /** @description Meta data information */
18209
+ meta?: {
18210
+ [key: string]: unknown;
18211
+ };
18212
+ /** @description The instance ID */
18213
+ id: string;
18214
+ /** @description The timestamp (ms) when the instance was created */
18215
+ createdAt: number;
18216
+ /** @description The timestamp (ms) when the instance was updated */
18217
+ updatedAt: number;
18218
+ /** @description The backstory of the model */
18219
+ provider: string;
18220
+ /** @description The model of the model */
18221
+ family: string;
18222
+ /** @description The maximum number of tokens the model can use */
18223
+ maxTokens: number;
18224
+ /** @description The maximum number of tokens the model can accept */
18225
+ maxInputTokens: number;
18226
+ /** @description The maximum number of tokens the model can generate */
18227
+ maxOutputTokens: number;
18228
+ }[];
18229
+ };
18230
+ "application/jsonl": {
18231
+ /**
18232
+ * @description The type of event
18233
+ * @enum {string}
18234
+ */
18235
+ type: "item";
18236
+ /** @description Instance list properties */
18237
+ data: {
18238
+ /** @description The associated name */
18239
+ name?: string;
18240
+ /** @description The associated description */
18241
+ description?: string;
18242
+ /** @description Meta data information */
18243
+ meta?: {
18244
+ [key: string]: unknown;
18245
+ };
18246
+ /** @description The instance ID */
18247
+ id: string;
18248
+ /** @description The timestamp (ms) when the instance was created */
18249
+ createdAt: number;
18250
+ /** @description The timestamp (ms) when the instance was updated */
18251
+ updatedAt: number;
18252
+ /** @description The backstory of the model */
18253
+ provider: string;
18254
+ /** @description The model of the model */
18255
+ family: string;
18256
+ /** @description The maximum number of tokens the model can use */
18257
+ maxTokens: number;
18258
+ /** @description The maximum number of tokens the model can accept */
18259
+ maxInputTokens: number;
18260
+ /** @description The maximum number of tokens the model can generate */
18261
+ maxOutputTokens: number;
18038
18262
  };
18039
18263
  };
18040
18264
  };
@@ -18050,7 +18274,7 @@ export interface operations {
18050
18274
  };
18051
18275
  };
18052
18276
  };
18053
- listPlatformExamples: {
18277
+ listPlatformSecrets: {
18054
18278
  parameters: {
18055
18279
  query?: {
18056
18280
  cursor?: string;
@@ -18066,7 +18290,7 @@ export interface operations {
18066
18290
  };
18067
18291
  requestBody?: never;
18068
18292
  responses: {
18069
- /** @description The list of examples was retrieved successfully */
18293
+ /** @description The list of secrets was retrieved successfully */
18070
18294
  200: {
18071
18295
  headers: {
18072
18296
  [name: string]: unknown;
@@ -18075,9 +18299,9 @@ export interface operations {
18075
18299
  "application/json": {
18076
18300
  items: {
18077
18301
  /** @description The associated name */
18078
- name: string;
18302
+ name?: string;
18079
18303
  /** @description The associated description */
18080
- description: string;
18304
+ description?: string;
18081
18305
  /** @description Meta data information */
18082
18306
  meta?: {
18083
18307
  [key: string]: unknown;
@@ -18089,16 +18313,10 @@ export interface operations {
18089
18313
  /** @description The timestamp (ms) when the instance was updated */
18090
18314
  updatedAt: number;
18091
18315
  /**
18092
- * @description The type of the example
18316
+ * @description The type of the secret
18093
18317
  * @enum {string}
18094
18318
  */
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[];
18319
+ type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18102
18320
  }[];
18103
18321
  };
18104
18322
  "application/jsonl": {
@@ -18110,9 +18328,9 @@ export interface operations {
18110
18328
  /** @description Instance list properties */
18111
18329
  data: {
18112
18330
  /** @description The associated name */
18113
- name: string;
18331
+ name?: string;
18114
18332
  /** @description The associated description */
18115
- description: string;
18333
+ description?: string;
18116
18334
  /** @description Meta data information */
18117
18335
  meta?: {
18118
18336
  [key: string]: unknown;
@@ -18124,16 +18342,10 @@ export interface operations {
18124
18342
  /** @description The timestamp (ms) when the instance was updated */
18125
18343
  updatedAt: number;
18126
18344
  /**
18127
- * @description The type of the example
18345
+ * @description The type of the secret
18128
18346
  * @enum {string}
18129
18347
  */
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[];
18348
+ type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18137
18349
  };
18138
18350
  };
18139
18351
  };
@@ -18149,59 +18361,58 @@ export interface operations {
18149
18361
  };
18150
18362
  };
18151
18363
  };
18152
- searchPlatformExamples: {
18364
+ fetchPlatformTutorial: {
18153
18365
  parameters: {
18154
18366
  query?: never;
18155
18367
  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
- };
18368
+ path: {
18369
+ tutorialId: string;
18165
18370
  };
18371
+ cookie?: never;
18166
18372
  };
18373
+ requestBody?: never;
18167
18374
  responses: {
18168
- /** @description The search was successful */
18375
+ /** @description The tutorial was retrieved successfully */
18169
18376
  200: {
18170
18377
  headers: {
18171
18378
  [name: string]: unknown;
18172
18379
  };
18173
18380
  content: {
18174
18381
  "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
- }[];
18382
+ /** @description The associated name */
18383
+ name: string;
18384
+ /** @description The associated description */
18385
+ description?: string;
18386
+ /** @description Meta data information */
18387
+ meta?: {
18388
+ [key: string]: unknown;
18389
+ };
18390
+ /** @description The instance ID */
18391
+ id: string;
18392
+ /** @description The timestamp (ms) when the instance was created */
18393
+ createdAt: number;
18394
+ /** @description The timestamp (ms) when the instance was updated */
18395
+ updatedAt: number;
18396
+ /** @description The category of the tutorial */
18397
+ category?: string;
18398
+ /** @description Tags associated with the tutorial */
18399
+ tags?: string[];
18400
+ /** @description The display order index */
18401
+ index?: number;
18402
+ /** @description The markdown content of the tutorial */
18403
+ content: string;
18404
+ /** @description The URL to the official tutorial page */
18405
+ link?: string;
18202
18406
  };
18203
18407
  };
18204
18408
  };
18409
+ /** @description Tutorial not found */
18410
+ 404: {
18411
+ headers: {
18412
+ [name: string]: unknown;
18413
+ };
18414
+ content?: never;
18415
+ };
18205
18416
  /** @description An error response */
18206
18417
  default: {
18207
18418
  headers: {
@@ -18213,7 +18424,7 @@ export interface operations {
18213
18424
  };
18214
18425
  };
18215
18426
  };
18216
- listPlatformModels: {
18427
+ listPlatformTutorials: {
18217
18428
  parameters: {
18218
18429
  query?: {
18219
18430
  cursor?: string;
@@ -18229,7 +18440,7 @@ export interface operations {
18229
18440
  };
18230
18441
  requestBody?: never;
18231
18442
  responses: {
18232
- /** @description The list of models was retrieved successfully */
18443
+ /** @description The list of tutorials was retrieved successfully */
18233
18444
  200: {
18234
18445
  headers: {
18235
18446
  [name: string]: unknown;
@@ -18238,9 +18449,9 @@ export interface operations {
18238
18449
  "application/json": {
18239
18450
  items: {
18240
18451
  /** @description The associated name */
18241
- name?: string;
18452
+ name: string;
18242
18453
  /** @description The associated description */
18243
- description?: string;
18454
+ description: string;
18244
18455
  /** @description Meta data information */
18245
18456
  meta?: {
18246
18457
  [key: string]: unknown;
@@ -18251,16 +18462,14 @@ export interface operations {
18251
18462
  createdAt: number;
18252
18463
  /** @description The timestamp (ms) when the instance was updated */
18253
18464
  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;
18465
+ /** @description The category of the tutorial */
18466
+ category?: string;
18467
+ /** @description Tags associated with the tutorial */
18468
+ tags: string[];
18469
+ /** @description The display order index */
18470
+ index: number;
18471
+ /** @description The URL to the official tutorial page */
18472
+ link: string;
18264
18473
  }[];
18265
18474
  };
18266
18475
  "application/jsonl": {
@@ -18272,9 +18481,9 @@ export interface operations {
18272
18481
  /** @description Instance list properties */
18273
18482
  data: {
18274
18483
  /** @description The associated name */
18275
- name?: string;
18484
+ name: string;
18276
18485
  /** @description The associated description */
18277
- description?: string;
18486
+ description: string;
18278
18487
  /** @description Meta data information */
18279
18488
  meta?: {
18280
18489
  [key: string]: unknown;
@@ -18285,16 +18494,14 @@ export interface operations {
18285
18494
  createdAt: number;
18286
18495
  /** @description The timestamp (ms) when the instance was updated */
18287
18496
  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;
18497
+ /** @description The category of the tutorial */
18498
+ category?: string;
18499
+ /** @description Tags associated with the tutorial */
18500
+ tags: string[];
18501
+ /** @description The display order index */
18502
+ index: number;
18503
+ /** @description The URL to the official tutorial page */
18504
+ link: string;
18298
18505
  };
18299
18506
  };
18300
18507
  };
@@ -18310,23 +18517,28 @@ export interface operations {
18310
18517
  };
18311
18518
  };
18312
18519
  };
18313
- listPlatformSecrets: {
18520
+ searchPlatformTutorials: {
18314
18521
  parameters: {
18315
- query?: {
18316
- cursor?: string;
18317
- order?: "asc" | "desc";
18318
- take?: number;
18319
- meta?: {
18320
- [key: string]: string;
18321
- };
18322
- };
18522
+ query?: never;
18323
18523
  header?: never;
18324
18524
  path?: never;
18325
18525
  cookie?: never;
18326
18526
  };
18327
- requestBody?: never;
18527
+ requestBody: {
18528
+ content: {
18529
+ "application/json": {
18530
+ /** @description The search query to find relevant tutorials */
18531
+ search: string;
18532
+ /**
18533
+ * @description The maximum number of results to return (1-100, default 10)
18534
+ * @default 10
18535
+ */
18536
+ take?: number;
18537
+ };
18538
+ };
18539
+ };
18328
18540
  responses: {
18329
- /** @description The list of secrets was retrieved successfully */
18541
+ /** @description The search was successful */
18330
18542
  200: {
18331
18543
  headers: {
18332
18544
  [name: string]: unknown;
@@ -18335,9 +18547,9 @@ export interface operations {
18335
18547
  "application/json": {
18336
18548
  items: {
18337
18549
  /** @description The associated name */
18338
- name?: string;
18550
+ name: string;
18339
18551
  /** @description The associated description */
18340
- description?: string;
18552
+ description: string;
18341
18553
  /** @description Meta data information */
18342
18554
  meta?: {
18343
18555
  [key: string]: unknown;
@@ -18348,42 +18560,20 @@ export interface operations {
18348
18560
  createdAt: number;
18349
18561
  /** @description The timestamp (ms) when the instance was updated */
18350
18562
  updatedAt: number;
18351
- /**
18352
- * @description The type of the secret
18353
- * @enum {string}
18354
- */
18355
- type: "plain" | "basic" | "bearer" | "oauth" | "template" | "reference";
18563
+ /** @description The category of the tutorial */
18564
+ category?: string;
18565
+ /** @description Tags associated with the tutorial */
18566
+ tags: string[];
18567
+ /** @description The display order index */
18568
+ index: number;
18569
+ /** @description The similarity score of the search result */
18570
+ score: number;
18571
+ /** @description An excerpt from the most relevant part of the tutorial */
18572
+ excerpt: string;
18573
+ /** @description The URL to the official tutorial page */
18574
+ link: string;
18356
18575
  }[];
18357
18576
  };
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
18577
  };
18388
18578
  };
18389
18579
  /** @description An error response */
@@ -20555,6 +20745,16 @@ export interface operations {
20555
20745
  botId?: string;
20556
20746
  /** @description The schedule of the task */
20557
20747
  schedule?: string;
20748
+ /**
20749
+ * @description The task execution status
20750
+ * @enum {string}
20751
+ */
20752
+ status?: "idle" | "running";
20753
+ /**
20754
+ * @description The task execution outcome
20755
+ * @enum {string}
20756
+ */
20757
+ outcome?: "pending" | "success" | "failure";
20558
20758
  };
20559
20759
  };
20560
20760
  };
@@ -20849,6 +21049,16 @@ export interface operations {
20849
21049
  botId?: string;
20850
21050
  /** @description The schedule of the task */
20851
21051
  schedule?: string;
21052
+ /**
21053
+ * @description The task execution status
21054
+ * @enum {string}
21055
+ */
21056
+ status?: "idle" | "running";
21057
+ /**
21058
+ * @description The task execution outcome
21059
+ * @enum {string}
21060
+ */
21061
+ outcome?: "pending" | "success" | "failure";
20852
21062
  }[];
20853
21063
  };
20854
21064
  "application/jsonl": {
@@ -20879,6 +21089,16 @@ export interface operations {
20879
21089
  botId?: string;
20880
21090
  /** @description The schedule of the task */
20881
21091
  schedule?: string;
21092
+ /**
21093
+ * @description The task execution status
21094
+ * @enum {string}
21095
+ */
21096
+ status?: "idle" | "running";
21097
+ /**
21098
+ * @description The task execution outcome
21099
+ * @enum {string}
21100
+ */
21101
+ outcome?: "pending" | "success" | "failure";
20882
21102
  };
20883
21103
  };
20884
21104
  };