@botpress/api 1.13.1 → 1.15.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 (19) hide show
  1. package/dist/index.js +212 -5
  2. package/dist/src/gen/admin/state.d.ts +16 -0
  3. package/dist/src/gen/files/state.d.ts +67 -0
  4. package/dist/src/gen/runtime/state.d.ts +8 -0
  5. package/dist/src/gen/state.d.ts +75 -0
  6. package/dist/src/gen/tables/state.d.ts +8 -0
  7. package/package.json +1 -1
  8. package/src/gen/admin/openapi.json +1 -1
  9. package/src/gen/admin/state.ts +18 -1
  10. package/src/gen/files/metadata.json +1 -1
  11. package/src/gen/files/openapi.json +1 -1
  12. package/src/gen/files/state.ts +83 -1
  13. package/src/gen/metadata.json +1 -1
  14. package/src/gen/openapi.json +1 -1
  15. package/src/gen/runtime/openapi.json +1 -1
  16. package/src/gen/runtime/state.ts +10 -1
  17. package/src/gen/state.ts +91 -1
  18. package/src/gen/tables/openapi.json +1 -1
  19. package/src/gen/tables/state.ts +10 -1
package/dist/index.js CHANGED
@@ -284126,7 +284126,7 @@ var state = {
284126
284126
  "title": "Botpress API",
284127
284127
  "description": "API for Botpress Cloud",
284128
284128
  "server": "https://api.botpress.cloud",
284129
- "version": "1.13.1",
284129
+ "version": "1.15.0",
284130
284130
  "prefix": "v1"
284131
284131
  },
284132
284132
  "errors": [
@@ -284433,6 +284433,14 @@ var state = {
284433
284433
  "maxLength": 2e3,
284434
284434
  "nullable": true
284435
284435
  },
284436
+ "disabledChannels": {
284437
+ "type": "array",
284438
+ "items": {
284439
+ "type": "string",
284440
+ "description": "Channel name"
284441
+ },
284442
+ "description": "Disabled channels for this integration"
284443
+ },
284436
284444
  "id": {
284437
284445
  "type": "string",
284438
284446
  "minLength": 28,
@@ -284489,6 +284497,7 @@ var state = {
284489
284497
  "configuration",
284490
284498
  "status",
284491
284499
  "statusReason",
284500
+ "disabledChannels",
284492
284501
  "id",
284493
284502
  "createdAt",
284494
284503
  "updatedAt",
@@ -292310,6 +292319,14 @@ var state2 = {
292310
292319
  "configuration": {
292311
292320
  "type": "object",
292312
292321
  "additionalProperties": true
292322
+ },
292323
+ "disabledChannels": {
292324
+ "type": "array",
292325
+ "items": {
292326
+ "type": "string",
292327
+ "description": "Channel name"
292328
+ },
292329
+ "description": "Disabled channels for this integration"
292313
292330
  }
292314
292331
  },
292315
292332
  "nullable": true,
@@ -300687,7 +300704,7 @@ var state2 = {
300687
300704
  "title": "Botpress API",
300688
300705
  "description": "API for Botpress Cloud",
300689
300706
  "server": "https://api.botpress.cloud",
300690
- "version": "1.13.1",
300707
+ "version": "1.15.0",
300691
300708
  "prefix": "v1"
300692
300709
  },
300693
300710
  "errors": [
@@ -301052,6 +301069,14 @@ var state2 = {
301052
301069
  "maxLength": 2e3,
301053
301070
  "nullable": true
301054
301071
  },
301072
+ "disabledChannels": {
301073
+ "type": "array",
301074
+ "items": {
301075
+ "type": "string",
301076
+ "description": "Channel name"
301077
+ },
301078
+ "description": "Disabled channels for this integration"
301079
+ },
301055
301080
  "id": {
301056
301081
  "type": "string",
301057
301082
  "minLength": 28,
@@ -301108,6 +301133,7 @@ var state2 = {
301108
301133
  "configuration",
301109
301134
  "status",
301110
301135
  "statusReason",
301136
+ "disabledChannels",
301111
301137
  "id",
301112
301138
  "createdAt",
301113
301139
  "updatedAt",
@@ -305830,6 +305856,76 @@ var state3 = {
305830
305856
  }
305831
305857
  }
305832
305858
  },
305859
+ "setFilePassages": {
305860
+ "name": "setFilePassages",
305861
+ "path": "/v1/files/{id}/passages",
305862
+ "description": 'Sets the indexed file passages asynchronously. All existing indexed passages will be deleted as soon as the indexing begins. This endpoint will return immediately and set the file status to "indexing_pending". Once the new passages are indexed the file status will be set to "indexing_completed", or "indexing_failed" if the passages failed to be indexed.',
305863
+ "method": "put",
305864
+ "section": "files",
305865
+ "parameters": {
305866
+ "id": {
305867
+ "type": "string",
305868
+ "description": "File ID or Key",
305869
+ "in": "path"
305870
+ }
305871
+ },
305872
+ "requestBody": {
305873
+ "description": "List of passages to index for the file. These will replacing all the existing passages. Indexing of the new passages will be done asynchronously in the background. You can check the file status to see when the indexing is complete.",
305874
+ "schema": {
305875
+ "type": "object",
305876
+ "properties": {
305877
+ "passages": {
305878
+ "type": "array",
305879
+ "items": {
305880
+ "type": "object",
305881
+ "properties": {
305882
+ "content": {
305883
+ "type": "string",
305884
+ "description": "The content of the passage, supports Markdown formatting."
305885
+ },
305886
+ "type": {
305887
+ "default": "paragraph",
305888
+ "type": "string",
305889
+ "enum": [
305890
+ "title",
305891
+ "subtitle",
305892
+ "paragraph",
305893
+ "blockquote",
305894
+ "list",
305895
+ "table",
305896
+ "code",
305897
+ "image"
305898
+ ],
305899
+ "description": "The type should match the Markdown format used for the passage content."
305900
+ },
305901
+ "pageNumber": {
305902
+ "type": "integer"
305903
+ }
305904
+ },
305905
+ "required": [
305906
+ "content"
305907
+ ]
305908
+ },
305909
+ "description": "Note: The passages should appear in the array in the same order as they appear in the original document."
305910
+ }
305911
+ },
305912
+ "required": [
305913
+ "passages"
305914
+ ],
305915
+ "title": "setFilePassagesBody",
305916
+ "additionalProperties": false
305917
+ }
305918
+ },
305919
+ "contentType": "application/json",
305920
+ "response": {
305921
+ "description": "Empty response.",
305922
+ "schema": {
305923
+ "type": "object",
305924
+ "title": "setFilePassagesResponse",
305925
+ "additionalProperties": false
305926
+ }
305927
+ }
305928
+ },
305833
305929
  "listFileTags": {
305834
305930
  "name": "listFileTags",
305835
305931
  "path": "/v1/files/tags",
@@ -306133,7 +306229,7 @@ var state3 = {
306133
306229
  "title": "Botpress API",
306134
306230
  "description": "API for Botpress Cloud",
306135
306231
  "server": "https://api.botpress.cloud",
306136
- "version": "1.13.1",
306232
+ "version": "1.15.0",
306137
306233
  "prefix": "v1"
306138
306234
  },
306139
306235
  "errors": [
@@ -306264,6 +306360,7 @@ var state3 = {
306264
306360
  "upsertFileBody": true,
306265
306361
  "updateFileMetadataBody": true,
306266
306362
  "copyFileBody": true,
306363
+ "setFilePassagesBody": true,
306267
306364
  "createKnowledgeBaseBody": true,
306268
306365
  "updateKnowledgeBaseBody": true
306269
306366
  },
@@ -306276,6 +306373,7 @@ var state3 = {
306276
306373
  "copyFileResponse": true,
306277
306374
  "searchFilesResponse": true,
306278
306375
  "listFilePassagesResponse": true,
306376
+ "setFilePassagesResponse": true,
306279
306377
  "listFileTagsResponse": true,
306280
306378
  "listFileTagValuesResponse": true,
306281
306379
  "createKnowledgeBaseResponse": true,
@@ -306391,6 +306489,14 @@ var state3 = {
306391
306489
  "maxLength": 2e3,
306392
306490
  "nullable": true
306393
306491
  },
306492
+ "disabledChannels": {
306493
+ "type": "array",
306494
+ "items": {
306495
+ "type": "string",
306496
+ "description": "Channel name"
306497
+ },
306498
+ "description": "Disabled channels for this integration"
306499
+ },
306394
306500
  "id": {
306395
306501
  "type": "string",
306396
306502
  "minLength": 28,
@@ -306447,6 +306553,7 @@ var state3 = {
306447
306553
  "configuration",
306448
306554
  "status",
306449
306555
  "statusReason",
306556
+ "disabledChannels",
306450
306557
  "id",
306451
306558
  "createdAt",
306452
306559
  "updatedAt",
@@ -309787,6 +309894,7 @@ var state3 = {
309787
309894
  "copyFile",
309788
309895
  "searchFiles",
309789
309896
  "listFilePassages",
309897
+ "setFilePassages",
309790
309898
  "listFileTags",
309791
309899
  "listFileTagValues",
309792
309900
  "createKnowledgeBase",
@@ -311020,7 +311128,7 @@ var state4 = {
311020
311128
  "title": "Botpress API",
311021
311129
  "description": "API for Botpress Cloud",
311022
311130
  "server": "https://api.botpress.cloud",
311023
- "version": "1.13.1",
311131
+ "version": "1.15.0",
311024
311132
  "prefix": "v1"
311025
311133
  },
311026
311134
  "errors": [
@@ -311287,6 +311395,14 @@ var state4 = {
311287
311395
  "maxLength": 2e3,
311288
311396
  "nullable": true
311289
311397
  },
311398
+ "disabledChannels": {
311399
+ "type": "array",
311400
+ "items": {
311401
+ "type": "string",
311402
+ "description": "Channel name"
311403
+ },
311404
+ "description": "Disabled channels for this integration"
311405
+ },
311290
311406
  "id": {
311291
311407
  "type": "string",
311292
311408
  "minLength": 28,
@@ -311343,6 +311459,7 @@ var state4 = {
311343
311459
  "configuration",
311344
311460
  "status",
311345
311461
  "statusReason",
311462
+ "disabledChannels",
311346
311463
  "id",
311347
311464
  "createdAt",
311348
311465
  "updatedAt",
@@ -321722,6 +321839,14 @@ var state5 = {
321722
321839
  "configuration": {
321723
321840
  "type": "object",
321724
321841
  "additionalProperties": true
321842
+ },
321843
+ "disabledChannels": {
321844
+ "type": "array",
321845
+ "items": {
321846
+ "type": "string",
321847
+ "description": "Channel name"
321848
+ },
321849
+ "description": "Disabled channels for this integration"
321725
321850
  }
321726
321851
  },
321727
321852
  "nullable": true,
@@ -331366,6 +331491,76 @@ var state5 = {
331366
331491
  }
331367
331492
  }
331368
331493
  },
331494
+ "setFilePassages": {
331495
+ "name": "setFilePassages",
331496
+ "path": "/v1/files/{id}/passages",
331497
+ "description": 'Sets the indexed file passages asynchronously. All existing indexed passages will be deleted as soon as the indexing begins. This endpoint will return immediately and set the file status to "indexing_pending". Once the new passages are indexed the file status will be set to "indexing_completed", or "indexing_failed" if the passages failed to be indexed.',
331498
+ "method": "put",
331499
+ "section": "files",
331500
+ "parameters": {
331501
+ "id": {
331502
+ "type": "string",
331503
+ "description": "File ID or Key",
331504
+ "in": "path"
331505
+ }
331506
+ },
331507
+ "requestBody": {
331508
+ "description": "List of passages to index for the file. These will replacing all the existing passages. Indexing of the new passages will be done asynchronously in the background. You can check the file status to see when the indexing is complete.",
331509
+ "schema": {
331510
+ "type": "object",
331511
+ "properties": {
331512
+ "passages": {
331513
+ "type": "array",
331514
+ "items": {
331515
+ "type": "object",
331516
+ "properties": {
331517
+ "content": {
331518
+ "type": "string",
331519
+ "description": "The content of the passage, supports Markdown formatting."
331520
+ },
331521
+ "type": {
331522
+ "default": "paragraph",
331523
+ "type": "string",
331524
+ "enum": [
331525
+ "title",
331526
+ "subtitle",
331527
+ "paragraph",
331528
+ "blockquote",
331529
+ "list",
331530
+ "table",
331531
+ "code",
331532
+ "image"
331533
+ ],
331534
+ "description": "The type should match the Markdown format used for the passage content."
331535
+ },
331536
+ "pageNumber": {
331537
+ "type": "integer"
331538
+ }
331539
+ },
331540
+ "required": [
331541
+ "content"
331542
+ ]
331543
+ },
331544
+ "description": "Note: The passages should appear in the array in the same order as they appear in the original document."
331545
+ }
331546
+ },
331547
+ "required": [
331548
+ "passages"
331549
+ ],
331550
+ "title": "setFilePassagesBody",
331551
+ "additionalProperties": false
331552
+ }
331553
+ },
331554
+ "contentType": "application/json",
331555
+ "response": {
331556
+ "description": "Empty response.",
331557
+ "schema": {
331558
+ "type": "object",
331559
+ "title": "setFilePassagesResponse",
331560
+ "additionalProperties": false
331561
+ }
331562
+ }
331563
+ },
331369
331564
  "listFileTags": {
331370
331565
  "name": "listFileTags",
331371
331566
  "path": "/v1/files/tags",
@@ -332875,7 +333070,7 @@ var state5 = {
332875
333070
  "title": "Botpress API",
332876
333071
  "description": "API for Botpress Cloud",
332877
333072
  "server": "https://api.botpress.cloud",
332878
- "version": "1.13.1",
333073
+ "version": "1.15.0",
332879
333074
  "prefix": "v1"
332880
333075
  },
332881
333076
  "errors": [
@@ -333058,6 +333253,7 @@ var state5 = {
333058
333253
  "upsertFileBody": true,
333059
333254
  "updateFileMetadataBody": true,
333060
333255
  "copyFileBody": true,
333256
+ "setFilePassagesBody": true,
333061
333257
  "createKnowledgeBaseBody": true,
333062
333258
  "updateKnowledgeBaseBody": true,
333063
333259
  "getOrCreateTableBody": true,
@@ -333223,6 +333419,7 @@ var state5 = {
333223
333419
  "copyFileResponse": true,
333224
333420
  "searchFilesResponse": true,
333225
333421
  "listFilePassagesResponse": true,
333422
+ "setFilePassagesResponse": true,
333226
333423
  "listFileTagsResponse": true,
333227
333424
  "listFileTagValuesResponse": true,
333228
333425
  "createKnowledgeBaseResponse": true,
@@ -333355,6 +333552,14 @@ var state5 = {
333355
333552
  "maxLength": 2e3,
333356
333553
  "nullable": true
333357
333554
  },
333555
+ "disabledChannels": {
333556
+ "type": "array",
333557
+ "items": {
333558
+ "type": "string",
333559
+ "description": "Channel name"
333560
+ },
333561
+ "description": "Disabled channels for this integration"
333562
+ },
333358
333563
  "id": {
333359
333564
  "type": "string",
333360
333565
  "minLength": 28,
@@ -333411,6 +333616,7 @@ var state5 = {
333411
333616
  "configuration",
333412
333617
  "status",
333413
333618
  "statusReason",
333619
+ "disabledChannels",
333414
333620
  "id",
333415
333621
  "createdAt",
333416
333622
  "updatedAt",
@@ -336927,6 +337133,7 @@ var state5 = {
336927
337133
  "copyFile",
336928
337134
  "searchFiles",
336929
337135
  "listFilePassages",
337136
+ "setFilePassages",
336930
337137
  "listFileTags",
336931
337138
  "listFileTagValues",
336932
337139
  "createKnowledgeBase",
package/dist/src/gen/admin/state.d.ts CHANGED
@@ -3875,6 +3875,14 @@ export declare const state: {
3875
3875
  type: "object";
3876
3876
  additionalProperties: true;
3877
3877
  };
3878
+ disabledChannels: {
3879
+ type: "array";
3880
+ items: {
3881
+ type: "string";
3882
+ description: string;
3883
+ };
3884
+ description: string;
3885
+ };
3878
3886
  };
3879
3887
  nullable: true;
3880
3888
  additionalProperties: false;
@@ -11552,6 +11560,14 @@ export declare const state: {
11552
11560
  maxLength: number;
11553
11561
  nullable: true;
11554
11562
  };
11563
+ disabledChannels: {
11564
+ type: "array";
11565
+ items: {
11566
+ type: "string";
11567
+ description: string;
11568
+ };
11569
+ description: string;
11570
+ };
11555
11571
  id: {
11556
11572
  type: "string";
11557
11573
  minLength: number;
package/dist/src/gen/files/state.d.ts CHANGED
@@ -1056,6 +1056,63 @@ export declare const state: {
1056
1056
  };
1057
1057
  };
1058
1058
  };
1059
+ setFilePassages: {
1060
+ name: string;
1061
+ path: string;
1062
+ description: string;
1063
+ method: "put";
1064
+ section: "files";
1065
+ parameters: {
1066
+ id: {
1067
+ type: "string";
1068
+ description: string;
1069
+ in: "path";
1070
+ };
1071
+ };
1072
+ requestBody: {
1073
+ description: string;
1074
+ schema: {
1075
+ type: "object";
1076
+ properties: {
1077
+ passages: {
1078
+ type: "array";
1079
+ items: {
1080
+ type: "object";
1081
+ properties: {
1082
+ content: {
1083
+ type: "string";
1084
+ description: string;
1085
+ };
1086
+ type: {
1087
+ default: string;
1088
+ type: "string";
1089
+ enum: string[];
1090
+ description: string;
1091
+ };
1092
+ pageNumber: {
1093
+ type: "integer";
1094
+ };
1095
+ };
1096
+ required: string[];
1097
+ };
1098
+ description: string;
1099
+ };
1100
+ };
1101
+ required: string[];
1102
+ title: string;
1103
+ additionalProperties: false;
1104
+ };
1105
+ };
1106
+ contentType: "application/json";
1107
+ response: {
1108
+ description: string;
1109
+ schema: {
1110
+ type: "object";
1111
+ title: string;
1112
+ additionalProperties: false;
1113
+ };
1114
+ };
1115
+ };
1059
1116
  listFileTags: {
1060
1117
  name: string;
1061
1118
  path: string;
@@ -1386,6 +1443,7 @@ export declare const state: {
1386
1443
  upsertFileBody: true;
1387
1444
  updateFileMetadataBody: true;
1388
1445
  copyFileBody: true;
1446
+ setFilePassagesBody: true;
1389
1447
  createKnowledgeBaseBody: true;
1390
1448
  updateKnowledgeBaseBody: true;
1391
1449
  };
@@ -1398,6 +1456,7 @@ export declare const state: {
1398
1456
  copyFileResponse: true;
1399
1457
  searchFilesResponse: true;
1400
1458
  listFilePassagesResponse: true;
1459
+ setFilePassagesResponse: true;
1401
1460
  listFileTagsResponse: true;
1402
1461
  listFileTagValuesResponse: true;
1403
1462
  createKnowledgeBaseResponse: true;
@@ -1506,6 +1565,14 @@ export declare const state: {
1506
1565
  maxLength: number;
1507
1566
  nullable: true;
1508
1567
  };
1568
+ disabledChannels: {
1569
+ type: "array";
1570
+ items: {
1571
+ type: "string";
1572
+ description: string;
1573
+ };
1574
+ description: string;
1575
+ };
1509
1576
  id: {
1510
1577
  type: "string";
1511
1578
  minLength: number;
package/dist/src/gen/runtime/state.d.ts CHANGED
@@ -2579,6 +2579,14 @@ export declare const state: {
2579
2579
  maxLength: number;
2580
2580
  nullable: true;
2581
2581
  };
2582
+ disabledChannels: {
2583
+ type: "array";
2584
+ items: {
2585
+ type: "string";
2586
+ description: string;
2587
+ };
2588
+ description: string;
2589
+ };
2582
2590
  id: {
2583
2591
  type: "string";
2584
2592
  minLength: number;
package/dist/src/gen/state.d.ts CHANGED
@@ -6224,6 +6224,14 @@ export declare const state: {
6224
6224
  type: "object";
6225
6225
  additionalProperties: true;
6226
6226
  };
6227
+ disabledChannels: {
6228
+ type: "array";
6229
+ items: {
6230
+ type: "string";
6231
+ description: string;
6232
+ };
6233
+ description: string;
6234
+ };
6227
6235
  };
6228
6236
  nullable: true;
6229
6237
  additionalProperties: false;
@@ -14670,6 +14678,63 @@ export declare const state: {
14670
14678
  };
14671
14679
  };
14672
14680
  };
14681
+ setFilePassages: {
14682
+ name: string;
14683
+ path: string;
14684
+ description: string;
14685
+ method: "put";
14686
+ section: "files";
14687
+ parameters: {
14688
+ id: {
14689
+ type: "string";
14690
+ description: string;
14691
+ in: "path";
14692
+ };
14693
+ };
14694
+ requestBody: {
14695
+ description: string;
14696
+ schema: {
14697
+ type: "object";
14698
+ properties: {
14699
+ passages: {
14700
+ type: "array";
14701
+ items: {
14702
+ type: "object";
14703
+ properties: {
14704
+ content: {
14705
+ type: "string";
14706
+ description: string;
14707
+ };
14708
+ type: {
14709
+ default: string;
14710
+ type: "string";
14711
+ enum: string[];
14712
+ description: string;
14713
+ };
14714
+ pageNumber: {
14715
+ type: "integer";
14716
+ };
14717
+ };
14718
+ required: string[];
14719
+ };
14720
+ description: string;
14721
+ };
14722
+ };
14723
+ required: string[];
14724
+ title: string;
14725
+ additionalProperties: false;
14726
+ };
14727
+ };
14728
+ contentType: "application/json";
14729
+ response: {
14730
+ description: string;
14731
+ schema: {
14732
+ type: "object";
14733
+ title: string;
14734
+ additionalProperties: false;
14735
+ };
14736
+ };
14737
+ };
14673
14738
  listFileTags: {
14674
14739
  name: string;
14675
14740
  path: string;
@@ -16133,6 +16198,7 @@ export declare const state: {
16133
16198
  upsertFileBody: true;
16134
16199
  updateFileMetadataBody: true;
16135
16200
  copyFileBody: true;
16201
+ setFilePassagesBody: true;
16136
16202
  createKnowledgeBaseBody: true;
16137
16203
  updateKnowledgeBaseBody: true;
16138
16204
  getOrCreateTableBody: true;
@@ -16298,6 +16364,7 @@ export declare const state: {
16298
16364
  copyFileResponse: true;
16299
16365
  searchFilesResponse: true;
16300
16366
  listFilePassagesResponse: true;
16367
+ setFilePassagesResponse: true;
16301
16368
  listFileTagsResponse: true;
16302
16369
  listFileTagValuesResponse: true;
16303
16370
  createKnowledgeBaseResponse: true;
@@ -16423,6 +16490,14 @@ export declare const state: {
16423
16490
  maxLength: number;
16424
16491
  nullable: true;
16425
16492
  };
16493
+ disabledChannels: {
16494
+ type: "array";
16495
+ items: {
16496
+ type: "string";
16497
+ description: string;
16498
+ };
16499
+ description: string;
16500
+ };
16426
16501
  id: {
16427
16502
  type: "string";
16428
16503
  minLength: number;
package/dist/src/gen/tables/state.d.ts CHANGED
@@ -1271,6 +1271,14 @@ export declare const state: {
1271
1271
  maxLength: number;
1272
1272
  nullable: true;
1273
1273
  };
1274
+ disabledChannels: {
1275
+ type: "array";
1276
+ items: {
1277
+ type: "string";
1278
+ description: string;
1279
+ };
1280
+ description: string;
1281
+ };
1274
1282
  id: {
1275
1283
  type: "string";
1276
1284
  minLength: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.13.1",
3
+ "version": "1.15.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "scripts": {