@botpress/api 1.51.0 → 1.52.1

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.
@@ -2,7 +2,7 @@
2
2
  /* eslint-disable */
3
3
  /* prettier-ignore */
4
4
  import * as opapi from '@bpinternal/opapi'
5
- export type State = opapi.State<'File', never, 'files'>
5
+ export type State = opapi.State<'File', 'x-bot-id' | 'x-integration-id' | 'x-integration-alias' | 'x-integration-name' | 'x-user-id' | 'x-user-role', 'files'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "upsertFile": {
@@ -344,7 +344,44 @@ export const state = {
344
344
  "tags": [
345
345
  "documented"
346
346
  ],
347
- "parameters": {}
347
+ "parameters": {
348
+ "x-bot-id": {
349
+ "in": "header",
350
+ "description": "Bot id",
351
+ "type": "string",
352
+ "required": true
353
+ },
354
+ "x-integration-id": {
355
+ "in": "header",
356
+ "description": "Integration id",
357
+ "type": "string",
358
+ "required": false
359
+ },
360
+ "x-integration-alias": {
361
+ "in": "header",
362
+ "description": "Integration alias",
363
+ "type": "string",
364
+ "required": false
365
+ },
366
+ "x-integration-name": {
367
+ "in": "header",
368
+ "description": "Integration name",
369
+ "type": "string",
370
+ "required": false
371
+ },
372
+ "x-user-id": {
373
+ "in": "header",
374
+ "description": "User Id",
375
+ "type": "string",
376
+ "required": false
377
+ },
378
+ "x-user-role": {
379
+ "in": "header",
380
+ "description": "User Role",
381
+ "type": "string",
382
+ "required": false
383
+ }
384
+ }
348
385
  },
349
386
  "deleteFile": {
350
387
  "name": "deleteFile",
@@ -357,6 +394,42 @@ export const state = {
357
394
  "type": "string",
358
395
  "description": "File ID or Key",
359
396
  "in": "path"
397
+ },
398
+ "x-bot-id": {
399
+ "in": "header",
400
+ "description": "Bot id",
401
+ "type": "string",
402
+ "required": true
403
+ },
404
+ "x-integration-id": {
405
+ "in": "header",
406
+ "description": "Integration id",
407
+ "type": "string",
408
+ "required": false
409
+ },
410
+ "x-integration-alias": {
411
+ "in": "header",
412
+ "description": "Integration alias",
413
+ "type": "string",
414
+ "required": false
415
+ },
416
+ "x-integration-name": {
417
+ "in": "header",
418
+ "description": "Integration name",
419
+ "type": "string",
420
+ "required": false
421
+ },
422
+ "x-user-id": {
423
+ "in": "header",
424
+ "description": "User Id",
425
+ "type": "string",
426
+ "required": false
427
+ },
428
+ "x-user-role": {
429
+ "in": "header",
430
+ "description": "User Role",
431
+ "type": "string",
432
+ "required": false
360
433
  }
361
434
  },
362
435
  "response": {
@@ -421,6 +494,42 @@ export const state = {
421
494
  },
422
495
  "maxItems": 50
423
496
  }
497
+ },
498
+ "x-bot-id": {
499
+ "in": "header",
500
+ "description": "Bot id",
501
+ "type": "string",
502
+ "required": true
503
+ },
504
+ "x-integration-id": {
505
+ "in": "header",
506
+ "description": "Integration id",
507
+ "type": "string",
508
+ "required": false
509
+ },
510
+ "x-integration-alias": {
511
+ "in": "header",
512
+ "description": "Integration alias",
513
+ "type": "string",
514
+ "required": false
515
+ },
516
+ "x-integration-name": {
517
+ "in": "header",
518
+ "description": "Integration name",
519
+ "type": "string",
520
+ "required": false
521
+ },
522
+ "x-user-id": {
523
+ "in": "header",
524
+ "description": "User Id",
525
+ "type": "string",
526
+ "required": false
527
+ },
528
+ "x-user-role": {
529
+ "in": "header",
530
+ "description": "User Role",
531
+ "type": "string",
532
+ "required": false
424
533
  }
425
534
  },
426
535
  "response": {
@@ -601,6 +710,42 @@ export const state = {
601
710
  "type": "string",
602
711
  "description": "File ID or Key",
603
712
  "in": "path"
713
+ },
714
+ "x-bot-id": {
715
+ "in": "header",
716
+ "description": "Bot id",
717
+ "type": "string",
718
+ "required": true
719
+ },
720
+ "x-integration-id": {
721
+ "in": "header",
722
+ "description": "Integration id",
723
+ "type": "string",
724
+ "required": false
725
+ },
726
+ "x-integration-alias": {
727
+ "in": "header",
728
+ "description": "Integration alias",
729
+ "type": "string",
730
+ "required": false
731
+ },
732
+ "x-integration-name": {
733
+ "in": "header",
734
+ "description": "Integration name",
735
+ "type": "string",
736
+ "required": false
737
+ },
738
+ "x-user-id": {
739
+ "in": "header",
740
+ "description": "User Id",
741
+ "type": "string",
742
+ "required": false
743
+ },
744
+ "x-user-role": {
745
+ "in": "header",
746
+ "description": "User Role",
747
+ "type": "string",
748
+ "required": false
604
749
  }
605
750
  },
606
751
  "response": {
@@ -769,6 +914,42 @@ export const state = {
769
914
  "type": "string",
770
915
  "description": "File ID or Key",
771
916
  "in": "path"
917
+ },
918
+ "x-bot-id": {
919
+ "in": "header",
920
+ "description": "Bot id",
921
+ "type": "string",
922
+ "required": true
923
+ },
924
+ "x-integration-id": {
925
+ "in": "header",
926
+ "description": "Integration id",
927
+ "type": "string",
928
+ "required": false
929
+ },
930
+ "x-integration-alias": {
931
+ "in": "header",
932
+ "description": "Integration alias",
933
+ "type": "string",
934
+ "required": false
935
+ },
936
+ "x-integration-name": {
937
+ "in": "header",
938
+ "description": "Integration name",
939
+ "type": "string",
940
+ "required": false
941
+ },
942
+ "x-user-id": {
943
+ "in": "header",
944
+ "description": "User Id",
945
+ "type": "string",
946
+ "required": false
947
+ },
948
+ "x-user-role": {
949
+ "in": "header",
950
+ "description": "User Role",
951
+ "type": "string",
952
+ "required": false
772
953
  }
773
954
  },
774
955
  "requestBody": {
@@ -986,6 +1167,42 @@ export const state = {
986
1167
  "in": "header",
987
1168
  "type": "string",
988
1169
  "description": "The bot ID to copy the file to. You must have permission to create files in the destination bot. If the destination bot ID is omitted, the file will be copied to the same bot the source file belongs to."
1170
+ },
1171
+ "x-bot-id": {
1172
+ "in": "header",
1173
+ "description": "Bot id",
1174
+ "type": "string",
1175
+ "required": true
1176
+ },
1177
+ "x-integration-id": {
1178
+ "in": "header",
1179
+ "description": "Integration id",
1180
+ "type": "string",
1181
+ "required": false
1182
+ },
1183
+ "x-integration-alias": {
1184
+ "in": "header",
1185
+ "description": "Integration alias",
1186
+ "type": "string",
1187
+ "required": false
1188
+ },
1189
+ "x-integration-name": {
1190
+ "in": "header",
1191
+ "description": "Integration name",
1192
+ "type": "string",
1193
+ "required": false
1194
+ },
1195
+ "x-user-id": {
1196
+ "in": "header",
1197
+ "description": "User Id",
1198
+ "type": "string",
1199
+ "required": false
1200
+ },
1201
+ "x-user-role": {
1202
+ "in": "header",
1203
+ "description": "User Role",
1204
+ "type": "string",
1205
+ "required": false
989
1206
  }
990
1207
  },
991
1208
  "requestBody": {
@@ -1200,6 +1417,42 @@ export const state = {
1200
1417
  "in": "query",
1201
1418
  "type": "boolean",
1202
1419
  "description": "Include the surrounding context with each passage in the `context` property of each passage. Not supported when `consolidate` is set to `true`."
1420
+ },
1421
+ "x-bot-id": {
1422
+ "in": "header",
1423
+ "description": "Bot id",
1424
+ "type": "string",
1425
+ "required": true
1426
+ },
1427
+ "x-integration-id": {
1428
+ "in": "header",
1429
+ "description": "Integration id",
1430
+ "type": "string",
1431
+ "required": false
1432
+ },
1433
+ "x-integration-alias": {
1434
+ "in": "header",
1435
+ "description": "Integration alias",
1436
+ "type": "string",
1437
+ "required": false
1438
+ },
1439
+ "x-integration-name": {
1440
+ "in": "header",
1441
+ "description": "Integration name",
1442
+ "type": "string",
1443
+ "required": false
1444
+ },
1445
+ "x-user-id": {
1446
+ "in": "header",
1447
+ "description": "User Id",
1448
+ "type": "string",
1449
+ "required": false
1450
+ },
1451
+ "x-user-role": {
1452
+ "in": "header",
1453
+ "description": "User Role",
1454
+ "type": "string",
1455
+ "required": false
1203
1456
  }
1204
1457
  },
1205
1458
  "response": {
@@ -1390,6 +1643,42 @@ export const state = {
1390
1643
  "type": "number",
1391
1644
  "description": "The maximum number of passages to return per request (optional, default: 20, max: 200).",
1392
1645
  "in": "query"
1646
+ },
1647
+ "x-bot-id": {
1648
+ "in": "header",
1649
+ "description": "Bot id",
1650
+ "type": "string",
1651
+ "required": true
1652
+ },
1653
+ "x-integration-id": {
1654
+ "in": "header",
1655
+ "description": "Integration id",
1656
+ "type": "string",
1657
+ "required": false
1658
+ },
1659
+ "x-integration-alias": {
1660
+ "in": "header",
1661
+ "description": "Integration alias",
1662
+ "type": "string",
1663
+ "required": false
1664
+ },
1665
+ "x-integration-name": {
1666
+ "in": "header",
1667
+ "description": "Integration name",
1668
+ "type": "string",
1669
+ "required": false
1670
+ },
1671
+ "x-user-id": {
1672
+ "in": "header",
1673
+ "description": "User Id",
1674
+ "type": "string",
1675
+ "required": false
1676
+ },
1677
+ "x-user-role": {
1678
+ "in": "header",
1679
+ "description": "User Role",
1680
+ "type": "string",
1681
+ "required": false
1393
1682
  }
1394
1683
  },
1395
1684
  "response": {
@@ -1496,6 +1785,42 @@ export const state = {
1496
1785
  "type": "string",
1497
1786
  "description": "File ID or Key",
1498
1787
  "in": "path"
1788
+ },
1789
+ "x-bot-id": {
1790
+ "in": "header",
1791
+ "description": "Bot id",
1792
+ "type": "string",
1793
+ "required": true
1794
+ },
1795
+ "x-integration-id": {
1796
+ "in": "header",
1797
+ "description": "Integration id",
1798
+ "type": "string",
1799
+ "required": false
1800
+ },
1801
+ "x-integration-alias": {
1802
+ "in": "header",
1803
+ "description": "Integration alias",
1804
+ "type": "string",
1805
+ "required": false
1806
+ },
1807
+ "x-integration-name": {
1808
+ "in": "header",
1809
+ "description": "Integration name",
1810
+ "type": "string",
1811
+ "required": false
1812
+ },
1813
+ "x-user-id": {
1814
+ "in": "header",
1815
+ "description": "User Id",
1816
+ "type": "string",
1817
+ "required": false
1818
+ },
1819
+ "x-user-role": {
1820
+ "in": "header",
1821
+ "description": "User Role",
1822
+ "type": "string",
1823
+ "required": false
1499
1824
  }
1500
1825
  },
1501
1826
  "requestBody": {
@@ -1566,6 +1891,42 @@ export const state = {
1566
1891
  "in": "query",
1567
1892
  "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
1568
1893
  "type": "string"
1894
+ },
1895
+ "x-bot-id": {
1896
+ "in": "header",
1897
+ "description": "Bot id",
1898
+ "type": "string",
1899
+ "required": true
1900
+ },
1901
+ "x-integration-id": {
1902
+ "in": "header",
1903
+ "description": "Integration id",
1904
+ "type": "string",
1905
+ "required": false
1906
+ },
1907
+ "x-integration-alias": {
1908
+ "in": "header",
1909
+ "description": "Integration alias",
1910
+ "type": "string",
1911
+ "required": false
1912
+ },
1913
+ "x-integration-name": {
1914
+ "in": "header",
1915
+ "description": "Integration name",
1916
+ "type": "string",
1917
+ "required": false
1918
+ },
1919
+ "x-user-id": {
1920
+ "in": "header",
1921
+ "description": "User Id",
1922
+ "type": "string",
1923
+ "required": false
1924
+ },
1925
+ "x-user-role": {
1926
+ "in": "header",
1927
+ "description": "User Role",
1928
+ "type": "string",
1929
+ "required": false
1569
1930
  }
1570
1931
  },
1571
1932
  "response": {
@@ -1618,6 +1979,42 @@ export const state = {
1618
1979
  "type": "string",
1619
1980
  "description": "Tag name",
1620
1981
  "in": "path"
1982
+ },
1983
+ "x-bot-id": {
1984
+ "in": "header",
1985
+ "description": "Bot id",
1986
+ "type": "string",
1987
+ "required": true
1988
+ },
1989
+ "x-integration-id": {
1990
+ "in": "header",
1991
+ "description": "Integration id",
1992
+ "type": "string",
1993
+ "required": false
1994
+ },
1995
+ "x-integration-alias": {
1996
+ "in": "header",
1997
+ "description": "Integration alias",
1998
+ "type": "string",
1999
+ "required": false
2000
+ },
2001
+ "x-integration-name": {
2002
+ "in": "header",
2003
+ "description": "Integration name",
2004
+ "type": "string",
2005
+ "required": false
2006
+ },
2007
+ "x-user-id": {
2008
+ "in": "header",
2009
+ "description": "User Id",
2010
+ "type": "string",
2011
+ "required": false
2012
+ },
2013
+ "x-user-role": {
2014
+ "in": "header",
2015
+ "description": "User Role",
2016
+ "type": "string",
2017
+ "required": false
1621
2018
  }
1622
2019
  },
1623
2020
  "response": {
@@ -1722,7 +2119,44 @@ export const state = {
1722
2119
  "additionalProperties": false
1723
2120
  }
1724
2121
  },
1725
- "parameters": {}
2122
+ "parameters": {
2123
+ "x-bot-id": {
2124
+ "in": "header",
2125
+ "description": "Bot id",
2126
+ "type": "string",
2127
+ "required": true
2128
+ },
2129
+ "x-integration-id": {
2130
+ "in": "header",
2131
+ "description": "Integration id",
2132
+ "type": "string",
2133
+ "required": false
2134
+ },
2135
+ "x-integration-alias": {
2136
+ "in": "header",
2137
+ "description": "Integration alias",
2138
+ "type": "string",
2139
+ "required": false
2140
+ },
2141
+ "x-integration-name": {
2142
+ "in": "header",
2143
+ "description": "Integration name",
2144
+ "type": "string",
2145
+ "required": false
2146
+ },
2147
+ "x-user-id": {
2148
+ "in": "header",
2149
+ "description": "User Id",
2150
+ "type": "string",
2151
+ "required": false
2152
+ },
2153
+ "x-user-role": {
2154
+ "in": "header",
2155
+ "description": "User Role",
2156
+ "type": "string",
2157
+ "required": false
2158
+ }
2159
+ }
1726
2160
  },
1727
2161
  "deleteKnowledgeBase": {
1728
2162
  "name": "deleteKnowledgeBase",
@@ -1735,6 +2169,42 @@ export const state = {
1735
2169
  "type": "string",
1736
2170
  "description": "Knowledge base ID",
1737
2171
  "in": "path"
2172
+ },
2173
+ "x-bot-id": {
2174
+ "in": "header",
2175
+ "description": "Bot id",
2176
+ "type": "string",
2177
+ "required": true
2178
+ },
2179
+ "x-integration-id": {
2180
+ "in": "header",
2181
+ "description": "Integration id",
2182
+ "type": "string",
2183
+ "required": false
2184
+ },
2185
+ "x-integration-alias": {
2186
+ "in": "header",
2187
+ "description": "Integration alias",
2188
+ "type": "string",
2189
+ "required": false
2190
+ },
2191
+ "x-integration-name": {
2192
+ "in": "header",
2193
+ "description": "Integration name",
2194
+ "type": "string",
2195
+ "required": false
2196
+ },
2197
+ "x-user-id": {
2198
+ "in": "header",
2199
+ "description": "User Id",
2200
+ "type": "string",
2201
+ "required": false
2202
+ },
2203
+ "x-user-role": {
2204
+ "in": "header",
2205
+ "description": "User Role",
2206
+ "type": "string",
2207
+ "required": false
1738
2208
  }
1739
2209
  },
1740
2210
  "response": {
@@ -1757,6 +2227,42 @@ export const state = {
1757
2227
  "type": "string",
1758
2228
  "description": "Knowledge base ID",
1759
2229
  "in": "path"
2230
+ },
2231
+ "x-bot-id": {
2232
+ "in": "header",
2233
+ "description": "Bot id",
2234
+ "type": "string",
2235
+ "required": true
2236
+ },
2237
+ "x-integration-id": {
2238
+ "in": "header",
2239
+ "description": "Integration id",
2240
+ "type": "string",
2241
+ "required": false
2242
+ },
2243
+ "x-integration-alias": {
2244
+ "in": "header",
2245
+ "description": "Integration alias",
2246
+ "type": "string",
2247
+ "required": false
2248
+ },
2249
+ "x-integration-name": {
2250
+ "in": "header",
2251
+ "description": "Integration name",
2252
+ "type": "string",
2253
+ "required": false
2254
+ },
2255
+ "x-user-id": {
2256
+ "in": "header",
2257
+ "description": "User Id",
2258
+ "type": "string",
2259
+ "required": false
2260
+ },
2261
+ "x-user-role": {
2262
+ "in": "header",
2263
+ "description": "User Role",
2264
+ "type": "string",
2265
+ "required": false
1760
2266
  }
1761
2267
  },
1762
2268
  "requestBody": {
@@ -1842,6 +2348,42 @@ export const state = {
1842
2348
  "description": "Filter files by tags. Tags should be passed as a URL-encoded JSON object of key-value pairs that must be present in the tags of a file. An array of multiple string values for the same key are treated as an OR condition. To exclude a value, express it as an object with a nested `not` key with the string or string-array value(s) to exclude.",
1843
2349
  "type": "object",
1844
2350
  "schema": {}
2351
+ },
2352
+ "x-bot-id": {
2353
+ "in": "header",
2354
+ "description": "Bot id",
2355
+ "type": "string",
2356
+ "required": true
2357
+ },
2358
+ "x-integration-id": {
2359
+ "in": "header",
2360
+ "description": "Integration id",
2361
+ "type": "string",
2362
+ "required": false
2363
+ },
2364
+ "x-integration-alias": {
2365
+ "in": "header",
2366
+ "description": "Integration alias",
2367
+ "type": "string",
2368
+ "required": false
2369
+ },
2370
+ "x-integration-name": {
2371
+ "in": "header",
2372
+ "description": "Integration name",
2373
+ "type": "string",
2374
+ "required": false
2375
+ },
2376
+ "x-user-id": {
2377
+ "in": "header",
2378
+ "description": "User Id",
2379
+ "type": "string",
2380
+ "required": false
2381
+ },
2382
+ "x-user-role": {
2383
+ "in": "header",
2384
+ "description": "User Role",
2385
+ "type": "string",
2386
+ "required": false
1845
2387
  }
1846
2388
  },
1847
2389
  "response": {
@@ -1906,9 +2448,47 @@ export const state = {
1906
2448
  "title": "Botpress Files API",
1907
2449
  "description": "API for Botpress Files",
1908
2450
  "server": "https://api.botpress.cloud",
1909
- "version": "1.51.0",
2451
+ "version": "1.52.1",
1910
2452
  "prefix": "v1"
1911
2453
  },
2454
+ "defaultParameters": {
2455
+ "x-bot-id": {
2456
+ "in": "header",
2457
+ "description": "Bot id",
2458
+ "type": "string",
2459
+ "required": true
2460
+ },
2461
+ "x-integration-id": {
2462
+ "in": "header",
2463
+ "description": "Integration id",
2464
+ "type": "string",
2465
+ "required": false
2466
+ },
2467
+ "x-integration-alias": {
2468
+ "in": "header",
2469
+ "description": "Integration alias",
2470
+ "type": "string",
2471
+ "required": false
2472
+ },
2473
+ "x-integration-name": {
2474
+ "in": "header",
2475
+ "description": "Integration name",
2476
+ "type": "string",
2477
+ "required": false
2478
+ },
2479
+ "x-user-id": {
2480
+ "in": "header",
2481
+ "description": "User Id",
2482
+ "type": "string",
2483
+ "required": false
2484
+ },
2485
+ "x-user-role": {
2486
+ "in": "header",
2487
+ "description": "User Role",
2488
+ "type": "string",
2489
+ "required": false
2490
+ }
2491
+ },
1912
2492
  "errors": [
1913
2493
  {
1914
2494
  "status": 500,
@@ -2237,5 +2817,8 @@ export const state = {
2237
2817
  ],
2238
2818
  "options": {
2239
2819
  "allowUnions": false
2240
- }
2820
+ },
2821
+ "security": [
2822
+ "BearerAuth"
2823
+ ]
2241
2824
  } satisfies State