@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<'Table' | 'Column' | 'Row', never, 'tables'>
5
+ 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'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "listTables": {
@@ -21,6 +21,42 @@ export const state = {
21
21
  }
22
22
  },
23
23
  "description": "Optional filters to narrow down the list by tags associated with tables."
24
+ },
25
+ "x-bot-id": {
26
+ "in": "header",
27
+ "description": "Bot id",
28
+ "type": "string",
29
+ "required": true
30
+ },
31
+ "x-integration-id": {
32
+ "in": "header",
33
+ "description": "Integration id",
34
+ "type": "string",
35
+ "required": false
36
+ },
37
+ "x-integration-alias": {
38
+ "in": "header",
39
+ "description": "Integration alias",
40
+ "type": "string",
41
+ "required": false
42
+ },
43
+ "x-integration-name": {
44
+ "in": "header",
45
+ "description": "Integration name",
46
+ "type": "string",
47
+ "required": false
48
+ },
49
+ "x-user-id": {
50
+ "in": "header",
51
+ "description": "User Id",
52
+ "type": "string",
53
+ "required": false
54
+ },
55
+ "x-user-role": {
56
+ "in": "header",
57
+ "description": "User Role",
58
+ "type": "string",
59
+ "required": false
24
60
  }
25
61
  },
26
62
  "section": "tables",
@@ -56,6 +92,42 @@ export const state = {
56
92
  "type": "string",
57
93
  "description": "The table's name or unique identifier for targeting specific table operations.",
58
94
  "in": "path"
95
+ },
96
+ "x-bot-id": {
97
+ "in": "header",
98
+ "description": "Bot id",
99
+ "type": "string",
100
+ "required": true
101
+ },
102
+ "x-integration-id": {
103
+ "in": "header",
104
+ "description": "Integration id",
105
+ "type": "string",
106
+ "required": false
107
+ },
108
+ "x-integration-alias": {
109
+ "in": "header",
110
+ "description": "Integration alias",
111
+ "type": "string",
112
+ "required": false
113
+ },
114
+ "x-integration-name": {
115
+ "in": "header",
116
+ "description": "Integration name",
117
+ "type": "string",
118
+ "required": false
119
+ },
120
+ "x-user-id": {
121
+ "in": "header",
122
+ "description": "User Id",
123
+ "type": "string",
124
+ "required": false
125
+ },
126
+ "x-user-role": {
127
+ "in": "header",
128
+ "description": "User Role",
129
+ "type": "string",
130
+ "required": false
59
131
  }
60
132
  },
61
133
  "method": "get",
@@ -104,6 +176,42 @@ export const state = {
104
176
  "type": "string",
105
177
  "description": "The table's name or unique identifier for targeting specific table operations.",
106
178
  "in": "path"
179
+ },
180
+ "x-bot-id": {
181
+ "in": "header",
182
+ "description": "Bot id",
183
+ "type": "string",
184
+ "required": true
185
+ },
186
+ "x-integration-id": {
187
+ "in": "header",
188
+ "description": "Integration id",
189
+ "type": "string",
190
+ "required": false
191
+ },
192
+ "x-integration-alias": {
193
+ "in": "header",
194
+ "description": "Integration alias",
195
+ "type": "string",
196
+ "required": false
197
+ },
198
+ "x-integration-name": {
199
+ "in": "header",
200
+ "description": "Integration name",
201
+ "type": "string",
202
+ "required": false
203
+ },
204
+ "x-user-id": {
205
+ "in": "header",
206
+ "description": "User Id",
207
+ "type": "string",
208
+ "required": false
209
+ },
210
+ "x-user-role": {
211
+ "in": "header",
212
+ "description": "User Role",
213
+ "type": "string",
214
+ "required": false
107
215
  }
108
216
  },
109
217
  "method": "post",
@@ -259,7 +367,44 @@ export const state = {
259
367
  "tags": [
260
368
  "documented"
261
369
  ],
262
- "parameters": {}
370
+ "parameters": {
371
+ "x-bot-id": {
372
+ "in": "header",
373
+ "description": "Bot id",
374
+ "type": "string",
375
+ "required": true
376
+ },
377
+ "x-integration-id": {
378
+ "in": "header",
379
+ "description": "Integration id",
380
+ "type": "string",
381
+ "required": false
382
+ },
383
+ "x-integration-alias": {
384
+ "in": "header",
385
+ "description": "Integration alias",
386
+ "type": "string",
387
+ "required": false
388
+ },
389
+ "x-integration-name": {
390
+ "in": "header",
391
+ "description": "Integration name",
392
+ "type": "string",
393
+ "required": false
394
+ },
395
+ "x-user-id": {
396
+ "in": "header",
397
+ "description": "User Id",
398
+ "type": "string",
399
+ "required": false
400
+ },
401
+ "x-user-role": {
402
+ "in": "header",
403
+ "description": "User Role",
404
+ "type": "string",
405
+ "required": false
406
+ }
407
+ }
263
408
  },
264
409
  "duplicateTable": {
265
410
  "name": "duplicateTable",
@@ -270,6 +415,42 @@ export const state = {
270
415
  "type": "string",
271
416
  "description": "The table's unique identifier",
272
417
  "in": "path"
418
+ },
419
+ "x-bot-id": {
420
+ "in": "header",
421
+ "description": "Bot id",
422
+ "type": "string",
423
+ "required": true
424
+ },
425
+ "x-integration-id": {
426
+ "in": "header",
427
+ "description": "Integration id",
428
+ "type": "string",
429
+ "required": false
430
+ },
431
+ "x-integration-alias": {
432
+ "in": "header",
433
+ "description": "Integration alias",
434
+ "type": "string",
435
+ "required": false
436
+ },
437
+ "x-integration-name": {
438
+ "in": "header",
439
+ "description": "Integration name",
440
+ "type": "string",
441
+ "required": false
442
+ },
443
+ "x-user-id": {
444
+ "in": "header",
445
+ "description": "User Id",
446
+ "type": "string",
447
+ "required": false
448
+ },
449
+ "x-user-role": {
450
+ "in": "header",
451
+ "description": "User Role",
452
+ "type": "string",
453
+ "required": false
273
454
  }
274
455
  },
275
456
  "method": "post",
@@ -350,6 +531,42 @@ export const state = {
350
531
  "default": true,
351
532
  "type": "boolean"
352
533
  }
534
+ },
535
+ "x-bot-id": {
536
+ "in": "header",
537
+ "description": "Bot id",
538
+ "type": "string",
539
+ "required": true
540
+ },
541
+ "x-integration-id": {
542
+ "in": "header",
543
+ "description": "Integration id",
544
+ "type": "string",
545
+ "required": false
546
+ },
547
+ "x-integration-alias": {
548
+ "in": "header",
549
+ "description": "Integration alias",
550
+ "type": "string",
551
+ "required": false
552
+ },
553
+ "x-integration-name": {
554
+ "in": "header",
555
+ "description": "Integration name",
556
+ "type": "string",
557
+ "required": false
558
+ },
559
+ "x-user-id": {
560
+ "in": "header",
561
+ "description": "User Id",
562
+ "type": "string",
563
+ "required": false
564
+ },
565
+ "x-user-role": {
566
+ "in": "header",
567
+ "description": "User Role",
568
+ "type": "string",
569
+ "required": false
353
570
  }
354
571
  },
355
572
  "method": "get",
@@ -440,6 +657,42 @@ export const state = {
440
657
  "type": "string",
441
658
  "description": "The table's unique identifier",
442
659
  "in": "path"
660
+ },
661
+ "x-bot-id": {
662
+ "in": "header",
663
+ "description": "Bot id",
664
+ "type": "string",
665
+ "required": true
666
+ },
667
+ "x-integration-id": {
668
+ "in": "header",
669
+ "description": "Integration id",
670
+ "type": "string",
671
+ "required": false
672
+ },
673
+ "x-integration-alias": {
674
+ "in": "header",
675
+ "description": "Integration alias",
676
+ "type": "string",
677
+ "required": false
678
+ },
679
+ "x-integration-name": {
680
+ "in": "header",
681
+ "description": "Integration name",
682
+ "type": "string",
683
+ "required": false
684
+ },
685
+ "x-user-id": {
686
+ "in": "header",
687
+ "description": "User Id",
688
+ "type": "string",
689
+ "required": false
690
+ },
691
+ "x-user-role": {
692
+ "in": "header",
693
+ "description": "User Role",
694
+ "type": "string",
695
+ "required": false
443
696
  }
444
697
  },
445
698
  "method": "get",
@@ -533,6 +786,42 @@ export const state = {
533
786
  "type": "string",
534
787
  "description": "The table's name or unique identifier for targeting specific table operations.",
535
788
  "in": "path"
789
+ },
790
+ "x-bot-id": {
791
+ "in": "header",
792
+ "description": "Bot id",
793
+ "type": "string",
794
+ "required": true
795
+ },
796
+ "x-integration-id": {
797
+ "in": "header",
798
+ "description": "Integration id",
799
+ "type": "string",
800
+ "required": false
801
+ },
802
+ "x-integration-alias": {
803
+ "in": "header",
804
+ "description": "Integration alias",
805
+ "type": "string",
806
+ "required": false
807
+ },
808
+ "x-integration-name": {
809
+ "in": "header",
810
+ "description": "Integration name",
811
+ "type": "string",
812
+ "required": false
813
+ },
814
+ "x-user-id": {
815
+ "in": "header",
816
+ "description": "User Id",
817
+ "type": "string",
818
+ "required": false
819
+ },
820
+ "x-user-role": {
821
+ "in": "header",
822
+ "description": "User Role",
823
+ "type": "string",
824
+ "required": false
536
825
  }
537
826
  },
538
827
  "requestBody": {
@@ -640,6 +929,42 @@ export const state = {
640
929
  "type": "string",
641
930
  "description": "The table's name or unique identifier for targeting specific table operations.",
642
931
  "in": "path"
932
+ },
933
+ "x-bot-id": {
934
+ "in": "header",
935
+ "description": "Bot id",
936
+ "type": "string",
937
+ "required": true
938
+ },
939
+ "x-integration-id": {
940
+ "in": "header",
941
+ "description": "Integration id",
942
+ "type": "string",
943
+ "required": false
944
+ },
945
+ "x-integration-alias": {
946
+ "in": "header",
947
+ "description": "Integration alias",
948
+ "type": "string",
949
+ "required": false
950
+ },
951
+ "x-integration-name": {
952
+ "in": "header",
953
+ "description": "Integration name",
954
+ "type": "string",
955
+ "required": false
956
+ },
957
+ "x-user-id": {
958
+ "in": "header",
959
+ "description": "User Id",
960
+ "type": "string",
961
+ "required": false
962
+ },
963
+ "x-user-role": {
964
+ "in": "header",
965
+ "description": "User Role",
966
+ "type": "string",
967
+ "required": false
643
968
  }
644
969
  },
645
970
  "requestBody": {
@@ -715,6 +1040,42 @@ export const state = {
715
1040
  "type": "string",
716
1041
  "description": "The table's name or unique identifier for targeting specific table operations.",
717
1042
  "in": "path"
1043
+ },
1044
+ "x-bot-id": {
1045
+ "in": "header",
1046
+ "description": "Bot id",
1047
+ "type": "string",
1048
+ "required": true
1049
+ },
1050
+ "x-integration-id": {
1051
+ "in": "header",
1052
+ "description": "Integration id",
1053
+ "type": "string",
1054
+ "required": false
1055
+ },
1056
+ "x-integration-alias": {
1057
+ "in": "header",
1058
+ "description": "Integration alias",
1059
+ "type": "string",
1060
+ "required": false
1061
+ },
1062
+ "x-integration-name": {
1063
+ "in": "header",
1064
+ "description": "Integration name",
1065
+ "type": "string",
1066
+ "required": false
1067
+ },
1068
+ "x-user-id": {
1069
+ "in": "header",
1070
+ "description": "User Id",
1071
+ "type": "string",
1072
+ "required": false
1073
+ },
1074
+ "x-user-role": {
1075
+ "in": "header",
1076
+ "description": "User Role",
1077
+ "type": "string",
1078
+ "required": false
718
1079
  }
719
1080
  },
720
1081
  "requestBody": {
@@ -771,6 +1132,42 @@ export const state = {
771
1132
  "type": "string",
772
1133
  "description": "The table's name or unique identifier for targeting specific table operations.",
773
1134
  "in": "path"
1135
+ },
1136
+ "x-bot-id": {
1137
+ "in": "header",
1138
+ "description": "Bot id",
1139
+ "type": "string",
1140
+ "required": true
1141
+ },
1142
+ "x-integration-id": {
1143
+ "in": "header",
1144
+ "description": "Integration id",
1145
+ "type": "string",
1146
+ "required": false
1147
+ },
1148
+ "x-integration-alias": {
1149
+ "in": "header",
1150
+ "description": "Integration alias",
1151
+ "type": "string",
1152
+ "required": false
1153
+ },
1154
+ "x-integration-name": {
1155
+ "in": "header",
1156
+ "description": "Integration name",
1157
+ "type": "string",
1158
+ "required": false
1159
+ },
1160
+ "x-user-id": {
1161
+ "in": "header",
1162
+ "description": "User Id",
1163
+ "type": "string",
1164
+ "required": false
1165
+ },
1166
+ "x-user-role": {
1167
+ "in": "header",
1168
+ "description": "User Role",
1169
+ "type": "string",
1170
+ "required": false
774
1171
  }
775
1172
  },
776
1173
  "method": "delete",
@@ -805,6 +1202,42 @@ export const state = {
805
1202
  "schema": {
806
1203
  "type": "integer"
807
1204
  }
1205
+ },
1206
+ "x-bot-id": {
1207
+ "in": "header",
1208
+ "description": "Bot id",
1209
+ "type": "string",
1210
+ "required": true
1211
+ },
1212
+ "x-integration-id": {
1213
+ "in": "header",
1214
+ "description": "Integration id",
1215
+ "type": "string",
1216
+ "required": false
1217
+ },
1218
+ "x-integration-alias": {
1219
+ "in": "header",
1220
+ "description": "Integration alias",
1221
+ "type": "string",
1222
+ "required": false
1223
+ },
1224
+ "x-integration-name": {
1225
+ "in": "header",
1226
+ "description": "Integration name",
1227
+ "type": "string",
1228
+ "required": false
1229
+ },
1230
+ "x-user-id": {
1231
+ "in": "header",
1232
+ "description": "User Id",
1233
+ "type": "string",
1234
+ "required": false
1235
+ },
1236
+ "x-user-role": {
1237
+ "in": "header",
1238
+ "description": "User Role",
1239
+ "type": "string",
1240
+ "required": false
808
1241
  }
809
1242
  },
810
1243
  "method": "get",
@@ -838,6 +1271,42 @@ export const state = {
838
1271
  "type": "string",
839
1272
  "description": "The table's name or unique identifier for targeting specific table operations.",
840
1273
  "in": "path"
1274
+ },
1275
+ "x-bot-id": {
1276
+ "in": "header",
1277
+ "description": "Bot id",
1278
+ "type": "string",
1279
+ "required": true
1280
+ },
1281
+ "x-integration-id": {
1282
+ "in": "header",
1283
+ "description": "Integration id",
1284
+ "type": "string",
1285
+ "required": false
1286
+ },
1287
+ "x-integration-alias": {
1288
+ "in": "header",
1289
+ "description": "Integration alias",
1290
+ "type": "string",
1291
+ "required": false
1292
+ },
1293
+ "x-integration-name": {
1294
+ "in": "header",
1295
+ "description": "Integration name",
1296
+ "type": "string",
1297
+ "required": false
1298
+ },
1299
+ "x-user-id": {
1300
+ "in": "header",
1301
+ "description": "User Id",
1302
+ "type": "string",
1303
+ "required": false
1304
+ },
1305
+ "x-user-role": {
1306
+ "in": "header",
1307
+ "description": "User Role",
1308
+ "type": "string",
1309
+ "required": false
841
1310
  }
842
1311
  },
843
1312
  "requestBody": {
@@ -953,6 +1422,42 @@ export const state = {
953
1422
  "type": "string",
954
1423
  "description": "The table's name or unique identifier for targeting specific table operations.",
955
1424
  "in": "path"
1425
+ },
1426
+ "x-bot-id": {
1427
+ "in": "header",
1428
+ "description": "Bot id",
1429
+ "type": "string",
1430
+ "required": true
1431
+ },
1432
+ "x-integration-id": {
1433
+ "in": "header",
1434
+ "description": "Integration id",
1435
+ "type": "string",
1436
+ "required": false
1437
+ },
1438
+ "x-integration-alias": {
1439
+ "in": "header",
1440
+ "description": "Integration alias",
1441
+ "type": "string",
1442
+ "required": false
1443
+ },
1444
+ "x-integration-name": {
1445
+ "in": "header",
1446
+ "description": "Integration name",
1447
+ "type": "string",
1448
+ "required": false
1449
+ },
1450
+ "x-user-id": {
1451
+ "in": "header",
1452
+ "description": "User Id",
1453
+ "type": "string",
1454
+ "required": false
1455
+ },
1456
+ "x-user-role": {
1457
+ "in": "header",
1458
+ "description": "User Role",
1459
+ "type": "string",
1460
+ "required": false
956
1461
  }
957
1462
  },
958
1463
  "requestBody": {
@@ -1030,6 +1535,42 @@ export const state = {
1030
1535
  "type": "string",
1031
1536
  "description": "The table's name or unique identifier for targeting specific table operations.",
1032
1537
  "in": "path"
1538
+ },
1539
+ "x-bot-id": {
1540
+ "in": "header",
1541
+ "description": "Bot id",
1542
+ "type": "string",
1543
+ "required": true
1544
+ },
1545
+ "x-integration-id": {
1546
+ "in": "header",
1547
+ "description": "Integration id",
1548
+ "type": "string",
1549
+ "required": false
1550
+ },
1551
+ "x-integration-alias": {
1552
+ "in": "header",
1553
+ "description": "Integration alias",
1554
+ "type": "string",
1555
+ "required": false
1556
+ },
1557
+ "x-integration-name": {
1558
+ "in": "header",
1559
+ "description": "Integration name",
1560
+ "type": "string",
1561
+ "required": false
1562
+ },
1563
+ "x-user-id": {
1564
+ "in": "header",
1565
+ "description": "User Id",
1566
+ "type": "string",
1567
+ "required": false
1568
+ },
1569
+ "x-user-role": {
1570
+ "in": "header",
1571
+ "description": "User Role",
1572
+ "type": "string",
1573
+ "required": false
1033
1574
  }
1034
1575
  },
1035
1576
  "requestBody": {
@@ -1091,6 +1632,42 @@ export const state = {
1091
1632
  "type": "string",
1092
1633
  "description": "The table's name or unique identifier for targeting specific table operations.",
1093
1634
  "in": "path"
1635
+ },
1636
+ "x-bot-id": {
1637
+ "in": "header",
1638
+ "description": "Bot id",
1639
+ "type": "string",
1640
+ "required": true
1641
+ },
1642
+ "x-integration-id": {
1643
+ "in": "header",
1644
+ "description": "Integration id",
1645
+ "type": "string",
1646
+ "required": false
1647
+ },
1648
+ "x-integration-alias": {
1649
+ "in": "header",
1650
+ "description": "Integration alias",
1651
+ "type": "string",
1652
+ "required": false
1653
+ },
1654
+ "x-integration-name": {
1655
+ "in": "header",
1656
+ "description": "Integration name",
1657
+ "type": "string",
1658
+ "required": false
1659
+ },
1660
+ "x-user-id": {
1661
+ "in": "header",
1662
+ "description": "User Id",
1663
+ "type": "string",
1664
+ "required": false
1665
+ },
1666
+ "x-user-role": {
1667
+ "in": "header",
1668
+ "description": "User Role",
1669
+ "type": "string",
1670
+ "required": false
1094
1671
  }
1095
1672
  },
1096
1673
  "requestBody": {
@@ -1177,6 +1754,42 @@ export const state = {
1177
1754
  "type": "string",
1178
1755
  "description": "The table's name or unique identifier for targeting specific table operations.",
1179
1756
  "in": "path"
1757
+ },
1758
+ "x-bot-id": {
1759
+ "in": "header",
1760
+ "description": "Bot id",
1761
+ "type": "string",
1762
+ "required": true
1763
+ },
1764
+ "x-integration-id": {
1765
+ "in": "header",
1766
+ "description": "Integration id",
1767
+ "type": "string",
1768
+ "required": false
1769
+ },
1770
+ "x-integration-alias": {
1771
+ "in": "header",
1772
+ "description": "Integration alias",
1773
+ "type": "string",
1774
+ "required": false
1775
+ },
1776
+ "x-integration-name": {
1777
+ "in": "header",
1778
+ "description": "Integration name",
1779
+ "type": "string",
1780
+ "required": false
1781
+ },
1782
+ "x-user-id": {
1783
+ "in": "header",
1784
+ "description": "User Id",
1785
+ "type": "string",
1786
+ "required": false
1787
+ },
1788
+ "x-user-role": {
1789
+ "in": "header",
1790
+ "description": "User Role",
1791
+ "type": "string",
1792
+ "required": false
1180
1793
  }
1181
1794
  },
1182
1795
  "requestBody": {
@@ -1268,9 +1881,47 @@ export const state = {
1268
1881
  "title": "Botpress Tables API",
1269
1882
  "description": "API for Botpress Tables",
1270
1883
  "server": "https://api.botpress.cloud",
1271
- "version": "1.51.0",
1884
+ "version": "1.52.1",
1272
1885
  "prefix": "v1"
1273
1886
  },
1887
+ "defaultParameters": {
1888
+ "x-bot-id": {
1889
+ "in": "header",
1890
+ "description": "Bot id",
1891
+ "type": "string",
1892
+ "required": true
1893
+ },
1894
+ "x-integration-id": {
1895
+ "in": "header",
1896
+ "description": "Integration id",
1897
+ "type": "string",
1898
+ "required": false
1899
+ },
1900
+ "x-integration-alias": {
1901
+ "in": "header",
1902
+ "description": "Integration alias",
1903
+ "type": "string",
1904
+ "required": false
1905
+ },
1906
+ "x-integration-name": {
1907
+ "in": "header",
1908
+ "description": "Integration name",
1909
+ "type": "string",
1910
+ "required": false
1911
+ },
1912
+ "x-user-id": {
1913
+ "in": "header",
1914
+ "description": "User Id",
1915
+ "type": "string",
1916
+ "required": false
1917
+ },
1918
+ "x-user-role": {
1919
+ "in": "header",
1920
+ "description": "User Role",
1921
+ "type": "string",
1922
+ "required": false
1923
+ }
1924
+ },
1274
1925
  "errors": [
1275
1926
  {
1276
1927
  "status": 500,
@@ -1895,5 +2546,8 @@ export const state = {
1895
2546
  ],
1896
2547
  "options": {
1897
2548
  "allowUnions": false
1898
- }
2549
+ },
2550
+ "security": [
2551
+ "BearerAuth"
2552
+ ]
1899
2553
  } satisfies State