@botpress/api 1.51.0 → 1.52.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.
@@ -1,5 +1,5 @@
1
1
  import * as opapi from '@bpinternal/opapi';
2
- export type State = opapi.State<'File', never, 'files'>;
2
+ 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'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  upsertFile: {
@@ -287,7 +287,44 @@ export declare const state: {
287
287
  };
288
288
  };
289
289
  tags: string[];
290
- parameters: {};
290
+ parameters: {
291
+ "x-bot-id": {
292
+ in: "header";
293
+ description: string;
294
+ type: "string";
295
+ required: true;
296
+ };
297
+ "x-integration-id": {
298
+ in: "header";
299
+ description: string;
300
+ type: "string";
301
+ required: false;
302
+ };
303
+ "x-integration-alias": {
304
+ in: "header";
305
+ description: string;
306
+ type: "string";
307
+ required: false;
308
+ };
309
+ "x-integration-name": {
310
+ in: "header";
311
+ description: string;
312
+ type: "string";
313
+ required: false;
314
+ };
315
+ "x-user-id": {
316
+ in: "header";
317
+ description: string;
318
+ type: "string";
319
+ required: false;
320
+ };
321
+ "x-user-role": {
322
+ in: "header";
323
+ description: string;
324
+ type: "string";
325
+ required: false;
326
+ };
327
+ };
291
328
  };
292
329
  deleteFile: {
293
330
  name: string;
@@ -301,6 +338,42 @@ export declare const state: {
301
338
  description: string;
302
339
  in: "path";
303
340
  };
341
+ "x-bot-id": {
342
+ in: "header";
343
+ description: string;
344
+ type: "string";
345
+ required: true;
346
+ };
347
+ "x-integration-id": {
348
+ in: "header";
349
+ description: string;
350
+ type: "string";
351
+ required: false;
352
+ };
353
+ "x-integration-alias": {
354
+ in: "header";
355
+ description: string;
356
+ type: "string";
357
+ required: false;
358
+ };
359
+ "x-integration-name": {
360
+ in: "header";
361
+ description: string;
362
+ type: "string";
363
+ required: false;
364
+ };
365
+ "x-user-id": {
366
+ in: "header";
367
+ description: string;
368
+ type: "string";
369
+ required: false;
370
+ };
371
+ "x-user-role": {
372
+ in: "header";
373
+ description: string;
374
+ type: "string";
375
+ required: false;
376
+ };
304
377
  };
305
378
  response: {
306
379
  description: string;
@@ -354,6 +427,42 @@ export declare const state: {
354
427
  maxItems: number;
355
428
  };
356
429
  };
430
+ "x-bot-id": {
431
+ in: "header";
432
+ description: string;
433
+ type: "string";
434
+ required: true;
435
+ };
436
+ "x-integration-id": {
437
+ in: "header";
438
+ description: string;
439
+ type: "string";
440
+ required: false;
441
+ };
442
+ "x-integration-alias": {
443
+ in: "header";
444
+ description: string;
445
+ type: "string";
446
+ required: false;
447
+ };
448
+ "x-integration-name": {
449
+ in: "header";
450
+ description: string;
451
+ type: "string";
452
+ required: false;
453
+ };
454
+ "x-user-id": {
455
+ in: "header";
456
+ description: string;
457
+ type: "string";
458
+ required: false;
459
+ };
460
+ "x-user-role": {
461
+ in: "header";
462
+ description: string;
463
+ type: "string";
464
+ required: false;
465
+ };
357
466
  };
358
467
  response: {
359
468
  description: string;
@@ -495,6 +604,42 @@ export declare const state: {
495
604
  description: string;
496
605
  in: "path";
497
606
  };
607
+ "x-bot-id": {
608
+ in: "header";
609
+ description: string;
610
+ type: "string";
611
+ required: true;
612
+ };
613
+ "x-integration-id": {
614
+ in: "header";
615
+ description: string;
616
+ type: "string";
617
+ required: false;
618
+ };
619
+ "x-integration-alias": {
620
+ in: "header";
621
+ description: string;
622
+ type: "string";
623
+ required: false;
624
+ };
625
+ "x-integration-name": {
626
+ in: "header";
627
+ description: string;
628
+ type: "string";
629
+ required: false;
630
+ };
631
+ "x-user-id": {
632
+ in: "header";
633
+ description: string;
634
+ type: "string";
635
+ required: false;
636
+ };
637
+ "x-user-role": {
638
+ in: "header";
639
+ description: string;
640
+ type: "string";
641
+ required: false;
642
+ };
498
643
  };
499
644
  response: {
500
645
  description: string;
@@ -625,6 +770,42 @@ export declare const state: {
625
770
  description: string;
626
771
  in: "path";
627
772
  };
773
+ "x-bot-id": {
774
+ in: "header";
775
+ description: string;
776
+ type: "string";
777
+ required: true;
778
+ };
779
+ "x-integration-id": {
780
+ in: "header";
781
+ description: string;
782
+ type: "string";
783
+ required: false;
784
+ };
785
+ "x-integration-alias": {
786
+ in: "header";
787
+ description: string;
788
+ type: "string";
789
+ required: false;
790
+ };
791
+ "x-integration-name": {
792
+ in: "header";
793
+ description: string;
794
+ type: "string";
795
+ required: false;
796
+ };
797
+ "x-user-id": {
798
+ in: "header";
799
+ description: string;
800
+ type: "string";
801
+ required: false;
802
+ };
803
+ "x-user-role": {
804
+ in: "header";
805
+ description: string;
806
+ type: "string";
807
+ required: false;
808
+ };
628
809
  };
629
810
  requestBody: {
630
811
  description: string;
@@ -801,6 +982,42 @@ export declare const state: {
801
982
  type: "string";
802
983
  description: string;
803
984
  };
985
+ "x-bot-id": {
986
+ in: "header";
987
+ description: string;
988
+ type: "string";
989
+ required: true;
990
+ };
991
+ "x-integration-id": {
992
+ in: "header";
993
+ description: string;
994
+ type: "string";
995
+ required: false;
996
+ };
997
+ "x-integration-alias": {
998
+ in: "header";
999
+ description: string;
1000
+ type: "string";
1001
+ required: false;
1002
+ };
1003
+ "x-integration-name": {
1004
+ in: "header";
1005
+ description: string;
1006
+ type: "string";
1007
+ required: false;
1008
+ };
1009
+ "x-user-id": {
1010
+ in: "header";
1011
+ description: string;
1012
+ type: "string";
1013
+ required: false;
1014
+ };
1015
+ "x-user-role": {
1016
+ in: "header";
1017
+ description: string;
1018
+ type: "string";
1019
+ required: false;
1020
+ };
804
1021
  };
805
1022
  requestBody: {
806
1023
  description: string;
@@ -977,6 +1194,42 @@ export declare const state: {
977
1194
  type: "boolean";
978
1195
  description: string;
979
1196
  };
1197
+ "x-bot-id": {
1198
+ in: "header";
1199
+ description: string;
1200
+ type: "string";
1201
+ required: true;
1202
+ };
1203
+ "x-integration-id": {
1204
+ in: "header";
1205
+ description: string;
1206
+ type: "string";
1207
+ required: false;
1208
+ };
1209
+ "x-integration-alias": {
1210
+ in: "header";
1211
+ description: string;
1212
+ type: "string";
1213
+ required: false;
1214
+ };
1215
+ "x-integration-name": {
1216
+ in: "header";
1217
+ description: string;
1218
+ type: "string";
1219
+ required: false;
1220
+ };
1221
+ "x-user-id": {
1222
+ in: "header";
1223
+ description: string;
1224
+ type: "string";
1225
+ required: false;
1226
+ };
1227
+ "x-user-role": {
1228
+ in: "header";
1229
+ description: string;
1230
+ type: "string";
1231
+ required: false;
1232
+ };
980
1233
  };
981
1234
  response: {
982
1235
  description: string;
@@ -1127,6 +1380,42 @@ export declare const state: {
1127
1380
  description: string;
1128
1381
  in: "query";
1129
1382
  };
1383
+ "x-bot-id": {
1384
+ in: "header";
1385
+ description: string;
1386
+ type: "string";
1387
+ required: true;
1388
+ };
1389
+ "x-integration-id": {
1390
+ in: "header";
1391
+ description: string;
1392
+ type: "string";
1393
+ required: false;
1394
+ };
1395
+ "x-integration-alias": {
1396
+ in: "header";
1397
+ description: string;
1398
+ type: "string";
1399
+ required: false;
1400
+ };
1401
+ "x-integration-name": {
1402
+ in: "header";
1403
+ description: string;
1404
+ type: "string";
1405
+ required: false;
1406
+ };
1407
+ "x-user-id": {
1408
+ in: "header";
1409
+ description: string;
1410
+ type: "string";
1411
+ required: false;
1412
+ };
1413
+ "x-user-role": {
1414
+ in: "header";
1415
+ description: string;
1416
+ type: "string";
1417
+ required: false;
1418
+ };
1130
1419
  };
1131
1420
  response: {
1132
1421
  description: string;
@@ -1209,6 +1498,42 @@ export declare const state: {
1209
1498
  description: string;
1210
1499
  in: "path";
1211
1500
  };
1501
+ "x-bot-id": {
1502
+ in: "header";
1503
+ description: string;
1504
+ type: "string";
1505
+ required: true;
1506
+ };
1507
+ "x-integration-id": {
1508
+ in: "header";
1509
+ description: string;
1510
+ type: "string";
1511
+ required: false;
1512
+ };
1513
+ "x-integration-alias": {
1514
+ in: "header";
1515
+ description: string;
1516
+ type: "string";
1517
+ required: false;
1518
+ };
1519
+ "x-integration-name": {
1520
+ in: "header";
1521
+ description: string;
1522
+ type: "string";
1523
+ required: false;
1524
+ };
1525
+ "x-user-id": {
1526
+ in: "header";
1527
+ description: string;
1528
+ type: "string";
1529
+ required: false;
1530
+ };
1531
+ "x-user-role": {
1532
+ in: "header";
1533
+ description: string;
1534
+ type: "string";
1535
+ required: false;
1536
+ };
1212
1537
  };
1213
1538
  requestBody: {
1214
1539
  description: string;
@@ -1266,6 +1591,42 @@ export declare const state: {
1266
1591
  description: string;
1267
1592
  type: "string";
1268
1593
  };
1594
+ "x-bot-id": {
1595
+ in: "header";
1596
+ description: string;
1597
+ type: "string";
1598
+ required: true;
1599
+ };
1600
+ "x-integration-id": {
1601
+ in: "header";
1602
+ description: string;
1603
+ type: "string";
1604
+ required: false;
1605
+ };
1606
+ "x-integration-alias": {
1607
+ in: "header";
1608
+ description: string;
1609
+ type: "string";
1610
+ required: false;
1611
+ };
1612
+ "x-integration-name": {
1613
+ in: "header";
1614
+ description: string;
1615
+ type: "string";
1616
+ required: false;
1617
+ };
1618
+ "x-user-id": {
1619
+ in: "header";
1620
+ description: string;
1621
+ type: "string";
1622
+ required: false;
1623
+ };
1624
+ "x-user-role": {
1625
+ in: "header";
1626
+ description: string;
1627
+ type: "string";
1628
+ required: false;
1629
+ };
1269
1630
  };
1270
1631
  response: {
1271
1632
  description: string;
@@ -1313,6 +1674,42 @@ export declare const state: {
1313
1674
  description: string;
1314
1675
  in: "path";
1315
1676
  };
1677
+ "x-bot-id": {
1678
+ in: "header";
1679
+ description: string;
1680
+ type: "string";
1681
+ required: true;
1682
+ };
1683
+ "x-integration-id": {
1684
+ in: "header";
1685
+ description: string;
1686
+ type: "string";
1687
+ required: false;
1688
+ };
1689
+ "x-integration-alias": {
1690
+ in: "header";
1691
+ description: string;
1692
+ type: "string";
1693
+ required: false;
1694
+ };
1695
+ "x-integration-name": {
1696
+ in: "header";
1697
+ description: string;
1698
+ type: "string";
1699
+ required: false;
1700
+ };
1701
+ "x-user-id": {
1702
+ in: "header";
1703
+ description: string;
1704
+ type: "string";
1705
+ required: false;
1706
+ };
1707
+ "x-user-role": {
1708
+ in: "header";
1709
+ description: string;
1710
+ type: "string";
1711
+ required: false;
1712
+ };
1316
1713
  };
1317
1714
  response: {
1318
1715
  description: string;
@@ -1403,7 +1800,44 @@ export declare const state: {
1403
1800
  additionalProperties: false;
1404
1801
  };
1405
1802
  };
1406
- parameters: {};
1803
+ parameters: {
1804
+ "x-bot-id": {
1805
+ in: "header";
1806
+ description: string;
1807
+ type: "string";
1808
+ required: true;
1809
+ };
1810
+ "x-integration-id": {
1811
+ in: "header";
1812
+ description: string;
1813
+ type: "string";
1814
+ required: false;
1815
+ };
1816
+ "x-integration-alias": {
1817
+ in: "header";
1818
+ description: string;
1819
+ type: "string";
1820
+ required: false;
1821
+ };
1822
+ "x-integration-name": {
1823
+ in: "header";
1824
+ description: string;
1825
+ type: "string";
1826
+ required: false;
1827
+ };
1828
+ "x-user-id": {
1829
+ in: "header";
1830
+ description: string;
1831
+ type: "string";
1832
+ required: false;
1833
+ };
1834
+ "x-user-role": {
1835
+ in: "header";
1836
+ description: string;
1837
+ type: "string";
1838
+ required: false;
1839
+ };
1840
+ };
1407
1841
  };
1408
1842
  deleteKnowledgeBase: {
1409
1843
  name: string;
@@ -1417,6 +1851,42 @@ export declare const state: {
1417
1851
  description: string;
1418
1852
  in: "path";
1419
1853
  };
1854
+ "x-bot-id": {
1855
+ in: "header";
1856
+ description: string;
1857
+ type: "string";
1858
+ required: true;
1859
+ };
1860
+ "x-integration-id": {
1861
+ in: "header";
1862
+ description: string;
1863
+ type: "string";
1864
+ required: false;
1865
+ };
1866
+ "x-integration-alias": {
1867
+ in: "header";
1868
+ description: string;
1869
+ type: "string";
1870
+ required: false;
1871
+ };
1872
+ "x-integration-name": {
1873
+ in: "header";
1874
+ description: string;
1875
+ type: "string";
1876
+ required: false;
1877
+ };
1878
+ "x-user-id": {
1879
+ in: "header";
1880
+ description: string;
1881
+ type: "string";
1882
+ required: false;
1883
+ };
1884
+ "x-user-role": {
1885
+ in: "header";
1886
+ description: string;
1887
+ type: "string";
1888
+ required: false;
1889
+ };
1420
1890
  };
1421
1891
  response: {
1422
1892
  description: string;
@@ -1439,6 +1909,42 @@ export declare const state: {
1439
1909
  description: string;
1440
1910
  in: "path";
1441
1911
  };
1912
+ "x-bot-id": {
1913
+ in: "header";
1914
+ description: string;
1915
+ type: "string";
1916
+ required: true;
1917
+ };
1918
+ "x-integration-id": {
1919
+ in: "header";
1920
+ description: string;
1921
+ type: "string";
1922
+ required: false;
1923
+ };
1924
+ "x-integration-alias": {
1925
+ in: "header";
1926
+ description: string;
1927
+ type: "string";
1928
+ required: false;
1929
+ };
1930
+ "x-integration-name": {
1931
+ in: "header";
1932
+ description: string;
1933
+ type: "string";
1934
+ required: false;
1935
+ };
1936
+ "x-user-id": {
1937
+ in: "header";
1938
+ description: string;
1939
+ type: "string";
1940
+ required: false;
1941
+ };
1942
+ "x-user-role": {
1943
+ in: "header";
1944
+ description: string;
1945
+ type: "string";
1946
+ required: false;
1947
+ };
1442
1948
  };
1443
1949
  requestBody: {
1444
1950
  description: string;
@@ -1516,6 +2022,42 @@ export declare const state: {
1516
2022
  type: "object";
1517
2023
  schema: {};
1518
2024
  };
2025
+ "x-bot-id": {
2026
+ in: "header";
2027
+ description: string;
2028
+ type: "string";
2029
+ required: true;
2030
+ };
2031
+ "x-integration-id": {
2032
+ in: "header";
2033
+ description: string;
2034
+ type: "string";
2035
+ required: false;
2036
+ };
2037
+ "x-integration-alias": {
2038
+ in: "header";
2039
+ description: string;
2040
+ type: "string";
2041
+ required: false;
2042
+ };
2043
+ "x-integration-name": {
2044
+ in: "header";
2045
+ description: string;
2046
+ type: "string";
2047
+ required: false;
2048
+ };
2049
+ "x-user-id": {
2050
+ in: "header";
2051
+ description: string;
2052
+ type: "string";
2053
+ required: false;
2054
+ };
2055
+ "x-user-role": {
2056
+ in: "header";
2057
+ description: string;
2058
+ type: "string";
2059
+ required: false;
2060
+ };
1519
2061
  };
1520
2062
  response: {
1521
2063
  description: string;
@@ -1574,6 +2116,44 @@ export declare const state: {
1574
2116
  version: string;
1575
2117
  prefix: string;
1576
2118
  };
2119
+ defaultParameters: {
2120
+ "x-bot-id": {
2121
+ in: "header";
2122
+ description: string;
2123
+ type: "string";
2124
+ required: true;
2125
+ };
2126
+ "x-integration-id": {
2127
+ in: "header";
2128
+ description: string;
2129
+ type: "string";
2130
+ required: false;
2131
+ };
2132
+ "x-integration-alias": {
2133
+ in: "header";
2134
+ description: string;
2135
+ type: "string";
2136
+ required: false;
2137
+ };
2138
+ "x-integration-name": {
2139
+ in: "header";
2140
+ description: string;
2141
+ type: "string";
2142
+ required: false;
2143
+ };
2144
+ "x-user-id": {
2145
+ in: "header";
2146
+ description: string;
2147
+ type: "string";
2148
+ required: false;
2149
+ };
2150
+ "x-user-role": {
2151
+ in: "header";
2152
+ description: string;
2153
+ type: "string";
2154
+ required: false;
2155
+ };
2156
+ };
1577
2157
  errors: ({
1578
2158
  status: 500;
1579
2159
  type: string;
@@ -1773,4 +2353,5 @@ export declare const state: {
1773
2353
  options: {
1774
2354
  allowUnions: false;
1775
2355
  };
2356
+ security: "BearerAuth"[];
1776
2357
  };