@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<'Table' | 'Column' | 'Row', never, 'tables'>;
2
+ export type State = opapi.State<'Table' | 'Column' | 'Row', 'x-bot-id' | 'x-integration-id' | 'x-integration-alias' | 'x-integration-name' | 'x-user-id' | 'x-user-role', 'tables'>;
3
3
  export declare const state: {
4
4
  operations: {
5
5
  listTables: {
@@ -19,6 +19,42 @@ export declare const state: {
19
19
  };
20
20
  description: string;
21
21
  };
22
+ "x-bot-id": {
23
+ in: "header";
24
+ description: string;
25
+ type: "string";
26
+ required: true;
27
+ };
28
+ "x-integration-id": {
29
+ in: "header";
30
+ description: string;
31
+ type: "string";
32
+ required: false;
33
+ };
34
+ "x-integration-alias": {
35
+ in: "header";
36
+ description: string;
37
+ type: "string";
38
+ required: false;
39
+ };
40
+ "x-integration-name": {
41
+ in: "header";
42
+ description: string;
43
+ type: "string";
44
+ required: false;
45
+ };
46
+ "x-user-id": {
47
+ in: "header";
48
+ description: string;
49
+ type: "string";
50
+ required: false;
51
+ };
52
+ "x-user-role": {
53
+ in: "header";
54
+ description: string;
55
+ type: "string";
56
+ required: false;
57
+ };
22
58
  };
23
59
  section: "tables";
24
60
  response: {
@@ -50,6 +86,42 @@ export declare const state: {
50
86
  description: string;
51
87
  in: "path";
52
88
  };
89
+ "x-bot-id": {
90
+ in: "header";
91
+ description: string;
92
+ type: "string";
93
+ required: true;
94
+ };
95
+ "x-integration-id": {
96
+ in: "header";
97
+ description: string;
98
+ type: "string";
99
+ required: false;
100
+ };
101
+ "x-integration-alias": {
102
+ in: "header";
103
+ description: string;
104
+ type: "string";
105
+ required: false;
106
+ };
107
+ "x-integration-name": {
108
+ in: "header";
109
+ description: string;
110
+ type: "string";
111
+ required: false;
112
+ };
113
+ "x-user-id": {
114
+ in: "header";
115
+ description: string;
116
+ type: "string";
117
+ required: false;
118
+ };
119
+ "x-user-role": {
120
+ in: "header";
121
+ description: string;
122
+ type: "string";
123
+ required: false;
124
+ };
53
125
  };
54
126
  method: "get";
55
127
  section: "tables";
@@ -91,6 +163,42 @@ export declare const state: {
91
163
  description: string;
92
164
  in: "path";
93
165
  };
166
+ "x-bot-id": {
167
+ in: "header";
168
+ description: string;
169
+ type: "string";
170
+ required: true;
171
+ };
172
+ "x-integration-id": {
173
+ in: "header";
174
+ description: string;
175
+ type: "string";
176
+ required: false;
177
+ };
178
+ "x-integration-alias": {
179
+ in: "header";
180
+ description: string;
181
+ type: "string";
182
+ required: false;
183
+ };
184
+ "x-integration-name": {
185
+ in: "header";
186
+ description: string;
187
+ type: "string";
188
+ required: false;
189
+ };
190
+ "x-user-id": {
191
+ in: "header";
192
+ description: string;
193
+ type: "string";
194
+ required: false;
195
+ };
196
+ "x-user-role": {
197
+ in: "header";
198
+ description: string;
199
+ type: "string";
200
+ required: false;
201
+ };
94
202
  };
95
203
  method: "post";
96
204
  requestBody: {
@@ -228,7 +336,44 @@ export declare const state: {
228
336
  };
229
337
  };
230
338
  tags: string[];
231
- parameters: {};
339
+ parameters: {
340
+ "x-bot-id": {
341
+ in: "header";
342
+ description: string;
343
+ type: "string";
344
+ required: true;
345
+ };
346
+ "x-integration-id": {
347
+ in: "header";
348
+ description: string;
349
+ type: "string";
350
+ required: false;
351
+ };
352
+ "x-integration-alias": {
353
+ in: "header";
354
+ description: string;
355
+ type: "string";
356
+ required: false;
357
+ };
358
+ "x-integration-name": {
359
+ in: "header";
360
+ description: string;
361
+ type: "string";
362
+ required: false;
363
+ };
364
+ "x-user-id": {
365
+ in: "header";
366
+ description: string;
367
+ type: "string";
368
+ required: false;
369
+ };
370
+ "x-user-role": {
371
+ in: "header";
372
+ description: string;
373
+ type: "string";
374
+ required: false;
375
+ };
376
+ };
232
377
  };
233
378
  duplicateTable: {
234
379
  name: string;
@@ -240,6 +385,42 @@ export declare const state: {
240
385
  description: string;
241
386
  in: "path";
242
387
  };
388
+ "x-bot-id": {
389
+ in: "header";
390
+ description: string;
391
+ type: "string";
392
+ required: true;
393
+ };
394
+ "x-integration-id": {
395
+ in: "header";
396
+ description: string;
397
+ type: "string";
398
+ required: false;
399
+ };
400
+ "x-integration-alias": {
401
+ in: "header";
402
+ description: string;
403
+ type: "string";
404
+ required: false;
405
+ };
406
+ "x-integration-name": {
407
+ in: "header";
408
+ description: string;
409
+ type: "string";
410
+ required: false;
411
+ };
412
+ "x-user-id": {
413
+ in: "header";
414
+ description: string;
415
+ type: "string";
416
+ required: false;
417
+ };
418
+ "x-user-role": {
419
+ in: "header";
420
+ description: string;
421
+ type: "string";
422
+ required: false;
423
+ };
243
424
  };
244
425
  method: "post";
245
426
  requestBody: {
@@ -312,6 +493,42 @@ export declare const state: {
312
493
  type: "boolean";
313
494
  };
314
495
  };
496
+ "x-bot-id": {
497
+ in: "header";
498
+ description: string;
499
+ type: "string";
500
+ required: true;
501
+ };
502
+ "x-integration-id": {
503
+ in: "header";
504
+ description: string;
505
+ type: "string";
506
+ required: false;
507
+ };
508
+ "x-integration-alias": {
509
+ in: "header";
510
+ description: string;
511
+ type: "string";
512
+ required: false;
513
+ };
514
+ "x-integration-name": {
515
+ in: "header";
516
+ description: string;
517
+ type: "string";
518
+ required: false;
519
+ };
520
+ "x-user-id": {
521
+ in: "header";
522
+ description: string;
523
+ type: "string";
524
+ required: false;
525
+ };
526
+ "x-user-role": {
527
+ in: "header";
528
+ description: string;
529
+ type: "string";
530
+ required: false;
531
+ };
315
532
  };
316
533
  method: "get";
317
534
  section: "tables";
@@ -381,6 +598,42 @@ export declare const state: {
381
598
  description: string;
382
599
  in: "path";
383
600
  };
601
+ "x-bot-id": {
602
+ in: "header";
603
+ description: string;
604
+ type: "string";
605
+ required: true;
606
+ };
607
+ "x-integration-id": {
608
+ in: "header";
609
+ description: string;
610
+ type: "string";
611
+ required: false;
612
+ };
613
+ "x-integration-alias": {
614
+ in: "header";
615
+ description: string;
616
+ type: "string";
617
+ required: false;
618
+ };
619
+ "x-integration-name": {
620
+ in: "header";
621
+ description: string;
622
+ type: "string";
623
+ required: false;
624
+ };
625
+ "x-user-id": {
626
+ in: "header";
627
+ description: string;
628
+ type: "string";
629
+ required: false;
630
+ };
631
+ "x-user-role": {
632
+ in: "header";
633
+ description: string;
634
+ type: "string";
635
+ required: false;
636
+ };
384
637
  };
385
638
  method: "get";
386
639
  section: "tables";
@@ -453,6 +706,42 @@ export declare const state: {
453
706
  description: string;
454
707
  in: "path";
455
708
  };
709
+ "x-bot-id": {
710
+ in: "header";
711
+ description: string;
712
+ type: "string";
713
+ required: true;
714
+ };
715
+ "x-integration-id": {
716
+ in: "header";
717
+ description: string;
718
+ type: "string";
719
+ required: false;
720
+ };
721
+ "x-integration-alias": {
722
+ in: "header";
723
+ description: string;
724
+ type: "string";
725
+ required: false;
726
+ };
727
+ "x-integration-name": {
728
+ in: "header";
729
+ description: string;
730
+ type: "string";
731
+ required: false;
732
+ };
733
+ "x-user-id": {
734
+ in: "header";
735
+ description: string;
736
+ type: "string";
737
+ required: false;
738
+ };
739
+ "x-user-role": {
740
+ in: "header";
741
+ description: string;
742
+ type: "string";
743
+ required: false;
744
+ };
456
745
  };
457
746
  requestBody: {
458
747
  description: string;
@@ -537,6 +826,42 @@ export declare const state: {
537
826
  description: string;
538
827
  in: "path";
539
828
  };
829
+ "x-bot-id": {
830
+ in: "header";
831
+ description: string;
832
+ type: "string";
833
+ required: true;
834
+ };
835
+ "x-integration-id": {
836
+ in: "header";
837
+ description: string;
838
+ type: "string";
839
+ required: false;
840
+ };
841
+ "x-integration-alias": {
842
+ in: "header";
843
+ description: string;
844
+ type: "string";
845
+ required: false;
846
+ };
847
+ "x-integration-name": {
848
+ in: "header";
849
+ description: string;
850
+ type: "string";
851
+ required: false;
852
+ };
853
+ "x-user-id": {
854
+ in: "header";
855
+ description: string;
856
+ type: "string";
857
+ required: false;
858
+ };
859
+ "x-user-role": {
860
+ in: "header";
861
+ description: string;
862
+ type: "string";
863
+ required: false;
864
+ };
540
865
  };
541
866
  requestBody: {
542
867
  description: string;
@@ -608,6 +933,42 @@ export declare const state: {
608
933
  description: string;
609
934
  in: "path";
610
935
  };
936
+ "x-bot-id": {
937
+ in: "header";
938
+ description: string;
939
+ type: "string";
940
+ required: true;
941
+ };
942
+ "x-integration-id": {
943
+ in: "header";
944
+ description: string;
945
+ type: "string";
946
+ required: false;
947
+ };
948
+ "x-integration-alias": {
949
+ in: "header";
950
+ description: string;
951
+ type: "string";
952
+ required: false;
953
+ };
954
+ "x-integration-name": {
955
+ in: "header";
956
+ description: string;
957
+ type: "string";
958
+ required: false;
959
+ };
960
+ "x-user-id": {
961
+ in: "header";
962
+ description: string;
963
+ type: "string";
964
+ required: false;
965
+ };
966
+ "x-user-role": {
967
+ in: "header";
968
+ description: string;
969
+ type: "string";
970
+ required: false;
971
+ };
611
972
  };
612
973
  requestBody: {
613
974
  description: string;
@@ -657,6 +1018,42 @@ export declare const state: {
657
1018
  description: string;
658
1019
  in: "path";
659
1020
  };
1021
+ "x-bot-id": {
1022
+ in: "header";
1023
+ description: string;
1024
+ type: "string";
1025
+ required: true;
1026
+ };
1027
+ "x-integration-id": {
1028
+ in: "header";
1029
+ description: string;
1030
+ type: "string";
1031
+ required: false;
1032
+ };
1033
+ "x-integration-alias": {
1034
+ in: "header";
1035
+ description: string;
1036
+ type: "string";
1037
+ required: false;
1038
+ };
1039
+ "x-integration-name": {
1040
+ in: "header";
1041
+ description: string;
1042
+ type: "string";
1043
+ required: false;
1044
+ };
1045
+ "x-user-id": {
1046
+ in: "header";
1047
+ description: string;
1048
+ type: "string";
1049
+ required: false;
1050
+ };
1051
+ "x-user-role": {
1052
+ in: "header";
1053
+ description: string;
1054
+ type: "string";
1055
+ required: false;
1056
+ };
660
1057
  };
661
1058
  method: "delete";
662
1059
  section: "tables";
@@ -689,6 +1086,42 @@ export declare const state: {
689
1086
  type: "integer";
690
1087
  };
691
1088
  };
1089
+ "x-bot-id": {
1090
+ in: "header";
1091
+ description: string;
1092
+ type: "string";
1093
+ required: true;
1094
+ };
1095
+ "x-integration-id": {
1096
+ in: "header";
1097
+ description: string;
1098
+ type: "string";
1099
+ required: false;
1100
+ };
1101
+ "x-integration-alias": {
1102
+ in: "header";
1103
+ description: string;
1104
+ type: "string";
1105
+ required: false;
1106
+ };
1107
+ "x-integration-name": {
1108
+ in: "header";
1109
+ description: string;
1110
+ type: "string";
1111
+ required: false;
1112
+ };
1113
+ "x-user-id": {
1114
+ in: "header";
1115
+ description: string;
1116
+ type: "string";
1117
+ required: false;
1118
+ };
1119
+ "x-user-role": {
1120
+ in: "header";
1121
+ description: string;
1122
+ type: "string";
1123
+ required: false;
1124
+ };
692
1125
  };
693
1126
  method: "get";
694
1127
  section: "tables";
@@ -718,6 +1151,42 @@ export declare const state: {
718
1151
  description: string;
719
1152
  in: "path";
720
1153
  };
1154
+ "x-bot-id": {
1155
+ in: "header";
1156
+ description: string;
1157
+ type: "string";
1158
+ required: true;
1159
+ };
1160
+ "x-integration-id": {
1161
+ in: "header";
1162
+ description: string;
1163
+ type: "string";
1164
+ required: false;
1165
+ };
1166
+ "x-integration-alias": {
1167
+ in: "header";
1168
+ description: string;
1169
+ type: "string";
1170
+ required: false;
1171
+ };
1172
+ "x-integration-name": {
1173
+ in: "header";
1174
+ description: string;
1175
+ type: "string";
1176
+ required: false;
1177
+ };
1178
+ "x-user-id": {
1179
+ in: "header";
1180
+ description: string;
1181
+ type: "string";
1182
+ required: false;
1183
+ };
1184
+ "x-user-role": {
1185
+ in: "header";
1186
+ description: string;
1187
+ type: "string";
1188
+ required: false;
1189
+ };
721
1190
  };
722
1191
  requestBody: {
723
1192
  description: string;
@@ -823,6 +1292,42 @@ export declare const state: {
823
1292
  description: string;
824
1293
  in: "path";
825
1294
  };
1295
+ "x-bot-id": {
1296
+ in: "header";
1297
+ description: string;
1298
+ type: "string";
1299
+ required: true;
1300
+ };
1301
+ "x-integration-id": {
1302
+ in: "header";
1303
+ description: string;
1304
+ type: "string";
1305
+ required: false;
1306
+ };
1307
+ "x-integration-alias": {
1308
+ in: "header";
1309
+ description: string;
1310
+ type: "string";
1311
+ required: false;
1312
+ };
1313
+ "x-integration-name": {
1314
+ in: "header";
1315
+ description: string;
1316
+ type: "string";
1317
+ required: false;
1318
+ };
1319
+ "x-user-id": {
1320
+ in: "header";
1321
+ description: string;
1322
+ type: "string";
1323
+ required: false;
1324
+ };
1325
+ "x-user-role": {
1326
+ in: "header";
1327
+ description: string;
1328
+ type: "string";
1329
+ required: false;
1330
+ };
826
1331
  };
827
1332
  requestBody: {
828
1333
  description: string;
@@ -894,6 +1399,42 @@ export declare const state: {
894
1399
  description: string;
895
1400
  in: "path";
896
1401
  };
1402
+ "x-bot-id": {
1403
+ in: "header";
1404
+ description: string;
1405
+ type: "string";
1406
+ required: true;
1407
+ };
1408
+ "x-integration-id": {
1409
+ in: "header";
1410
+ description: string;
1411
+ type: "string";
1412
+ required: false;
1413
+ };
1414
+ "x-integration-alias": {
1415
+ in: "header";
1416
+ description: string;
1417
+ type: "string";
1418
+ required: false;
1419
+ };
1420
+ "x-integration-name": {
1421
+ in: "header";
1422
+ description: string;
1423
+ type: "string";
1424
+ required: false;
1425
+ };
1426
+ "x-user-id": {
1427
+ in: "header";
1428
+ description: string;
1429
+ type: "string";
1430
+ required: false;
1431
+ };
1432
+ "x-user-role": {
1433
+ in: "header";
1434
+ description: string;
1435
+ type: "string";
1436
+ required: false;
1437
+ };
897
1438
  };
898
1439
  requestBody: {
899
1440
  description: string;
@@ -951,6 +1492,42 @@ export declare const state: {
951
1492
  description: string;
952
1493
  in: "path";
953
1494
  };
1495
+ "x-bot-id": {
1496
+ in: "header";
1497
+ description: string;
1498
+ type: "string";
1499
+ required: true;
1500
+ };
1501
+ "x-integration-id": {
1502
+ in: "header";
1503
+ description: string;
1504
+ type: "string";
1505
+ required: false;
1506
+ };
1507
+ "x-integration-alias": {
1508
+ in: "header";
1509
+ description: string;
1510
+ type: "string";
1511
+ required: false;
1512
+ };
1513
+ "x-integration-name": {
1514
+ in: "header";
1515
+ description: string;
1516
+ type: "string";
1517
+ required: false;
1518
+ };
1519
+ "x-user-id": {
1520
+ in: "header";
1521
+ description: string;
1522
+ type: "string";
1523
+ required: false;
1524
+ };
1525
+ "x-user-role": {
1526
+ in: "header";
1527
+ description: string;
1528
+ type: "string";
1529
+ required: false;
1530
+ };
954
1531
  };
955
1532
  requestBody: {
956
1533
  description: string;
@@ -1029,6 +1606,42 @@ export declare const state: {
1029
1606
  description: string;
1030
1607
  in: "path";
1031
1608
  };
1609
+ "x-bot-id": {
1610
+ in: "header";
1611
+ description: string;
1612
+ type: "string";
1613
+ required: true;
1614
+ };
1615
+ "x-integration-id": {
1616
+ in: "header";
1617
+ description: string;
1618
+ type: "string";
1619
+ required: false;
1620
+ };
1621
+ "x-integration-alias": {
1622
+ in: "header";
1623
+ description: string;
1624
+ type: "string";
1625
+ required: false;
1626
+ };
1627
+ "x-integration-name": {
1628
+ in: "header";
1629
+ description: string;
1630
+ type: "string";
1631
+ required: false;
1632
+ };
1633
+ "x-user-id": {
1634
+ in: "header";
1635
+ description: string;
1636
+ type: "string";
1637
+ required: false;
1638
+ };
1639
+ "x-user-role": {
1640
+ in: "header";
1641
+ description: string;
1642
+ type: "string";
1643
+ required: false;
1644
+ };
1032
1645
  };
1033
1646
  requestBody: {
1034
1647
  description: string;
@@ -1115,6 +1728,44 @@ export declare const state: {
1115
1728
  version: string;
1116
1729
  prefix: string;
1117
1730
  };
1731
+ defaultParameters: {
1732
+ "x-bot-id": {
1733
+ in: "header";
1734
+ description: string;
1735
+ type: "string";
1736
+ required: true;
1737
+ };
1738
+ "x-integration-id": {
1739
+ in: "header";
1740
+ description: string;
1741
+ type: "string";
1742
+ required: false;
1743
+ };
1744
+ "x-integration-alias": {
1745
+ in: "header";
1746
+ description: string;
1747
+ type: "string";
1748
+ required: false;
1749
+ };
1750
+ "x-integration-name": {
1751
+ in: "header";
1752
+ description: string;
1753
+ type: "string";
1754
+ required: false;
1755
+ };
1756
+ "x-user-id": {
1757
+ in: "header";
1758
+ description: string;
1759
+ type: "string";
1760
+ required: false;
1761
+ };
1762
+ "x-user-role": {
1763
+ in: "header";
1764
+ description: string;
1765
+ type: "string";
1766
+ required: false;
1767
+ };
1768
+ };
1118
1769
  errors: ({
1119
1770
  status: 500;
1120
1771
  type: string;
@@ -1572,4 +2223,5 @@ export declare const state: {
1572
2223
  options: {
1573
2224
  allowUnions: false;
1574
2225
  };
2226
+ security: "BearerAuth"[];
1575
2227
  };