@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.
@@ -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<'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag'>
5
+ export type State = opapi.State<'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow', 'x-bot-id' | 'x-integration-id' | 'x-integration-alias', 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'tag'>
6
6
  export const state = {
7
7
  "operations": {
8
8
  "createConversation": {
@@ -64,7 +64,26 @@ export const state = {
64
64
  "tags": [
65
65
  "documented"
66
66
  ],
67
- "parameters": {}
67
+ "parameters": {
68
+ "x-bot-id": {
69
+ "in": "header",
70
+ "description": "Bot id",
71
+ "type": "string",
72
+ "required": true
73
+ },
74
+ "x-integration-id": {
75
+ "in": "header",
76
+ "description": "Integration id",
77
+ "type": "string",
78
+ "required": false
79
+ },
80
+ "x-integration-alias": {
81
+ "in": "header",
82
+ "description": "Integration alias",
83
+ "type": "string",
84
+ "required": false
85
+ }
86
+ }
68
87
  },
69
88
  "getConversation": {
70
89
  "name": "getConversation",
@@ -76,6 +95,24 @@ export const state = {
76
95
  "in": "path",
77
96
  "type": "string",
78
97
  "description": "Conversation id"
98
+ },
99
+ "x-bot-id": {
100
+ "in": "header",
101
+ "description": "Bot id",
102
+ "type": "string",
103
+ "required": true
104
+ },
105
+ "x-integration-id": {
106
+ "in": "header",
107
+ "description": "Integration id",
108
+ "type": "string",
109
+ "required": false
110
+ },
111
+ "x-integration-alias": {
112
+ "in": "header",
113
+ "description": "Integration alias",
114
+ "type": "string",
115
+ "required": false
79
116
  }
80
117
  },
81
118
  "section": "conversation",
@@ -153,6 +190,24 @@ export const state = {
153
190
  "in": "query",
154
191
  "type": "string",
155
192
  "description": "Filter by integration channel name"
193
+ },
194
+ "x-bot-id": {
195
+ "in": "header",
196
+ "description": "Bot id",
197
+ "type": "string",
198
+ "required": true
199
+ },
200
+ "x-integration-id": {
201
+ "in": "header",
202
+ "description": "Integration id",
203
+ "type": "string",
204
+ "required": false
205
+ },
206
+ "x-integration-alias": {
207
+ "in": "header",
208
+ "description": "Integration alias",
209
+ "type": "string",
210
+ "required": false
156
211
  }
157
212
  },
158
213
  "section": "conversation",
@@ -256,7 +311,26 @@ export const state = {
256
311
  "tags": [
257
312
  "documented"
258
313
  ],
259
- "parameters": {}
314
+ "parameters": {
315
+ "x-bot-id": {
316
+ "in": "header",
317
+ "description": "Bot id",
318
+ "type": "string",
319
+ "required": true
320
+ },
321
+ "x-integration-id": {
322
+ "in": "header",
323
+ "description": "Integration id",
324
+ "type": "string",
325
+ "required": false
326
+ },
327
+ "x-integration-alias": {
328
+ "in": "header",
329
+ "description": "Integration alias",
330
+ "type": "string",
331
+ "required": false
332
+ }
333
+ }
260
334
  },
261
335
  "updateConversation": {
262
336
  "name": "updateConversation",
@@ -268,6 +342,24 @@ export const state = {
268
342
  "in": "path",
269
343
  "type": "string",
270
344
  "description": "Conversation id"
345
+ },
346
+ "x-bot-id": {
347
+ "in": "header",
348
+ "description": "Bot id",
349
+ "type": "string",
350
+ "required": true
351
+ },
352
+ "x-integration-id": {
353
+ "in": "header",
354
+ "description": "Integration id",
355
+ "type": "string",
356
+ "required": false
357
+ },
358
+ "x-integration-alias": {
359
+ "in": "header",
360
+ "description": "Integration alias",
361
+ "type": "string",
362
+ "required": false
271
363
  }
272
364
  },
273
365
  "requestBody": {
@@ -321,6 +413,24 @@ export const state = {
321
413
  "in": "path",
322
414
  "type": "string",
323
415
  "description": "Conversation id"
416
+ },
417
+ "x-bot-id": {
418
+ "in": "header",
419
+ "description": "Bot id",
420
+ "type": "string",
421
+ "required": true
422
+ },
423
+ "x-integration-id": {
424
+ "in": "header",
425
+ "description": "Integration id",
426
+ "type": "string",
427
+ "required": false
428
+ },
429
+ "x-integration-alias": {
430
+ "in": "header",
431
+ "description": "Integration alias",
432
+ "type": "string",
433
+ "required": false
324
434
  }
325
435
  },
326
436
  "section": "conversation",
@@ -351,6 +461,24 @@ export const state = {
351
461
  "in": "path",
352
462
  "type": "string",
353
463
  "description": "Conversation id"
464
+ },
465
+ "x-bot-id": {
466
+ "in": "header",
467
+ "description": "Bot id",
468
+ "type": "string",
469
+ "required": true
470
+ },
471
+ "x-integration-id": {
472
+ "in": "header",
473
+ "description": "Integration id",
474
+ "type": "string",
475
+ "required": false
476
+ },
477
+ "x-integration-alias": {
478
+ "in": "header",
479
+ "description": "Integration alias",
480
+ "type": "string",
481
+ "required": false
354
482
  }
355
483
  },
356
484
  "section": "conversation",
@@ -398,6 +526,24 @@ export const state = {
398
526
  "in": "path",
399
527
  "type": "string",
400
528
  "description": "Conversation id"
529
+ },
530
+ "x-bot-id": {
531
+ "in": "header",
532
+ "description": "Bot id",
533
+ "type": "string",
534
+ "required": true
535
+ },
536
+ "x-integration-id": {
537
+ "in": "header",
538
+ "description": "Integration id",
539
+ "type": "string",
540
+ "required": false
541
+ },
542
+ "x-integration-alias": {
543
+ "in": "header",
544
+ "description": "Integration alias",
545
+ "type": "string",
546
+ "required": false
401
547
  }
402
548
  },
403
549
  "requestBody": {
@@ -455,6 +601,24 @@ export const state = {
455
601
  "in": "path",
456
602
  "type": "string",
457
603
  "description": "User id"
604
+ },
605
+ "x-bot-id": {
606
+ "in": "header",
607
+ "description": "Bot id",
608
+ "type": "string",
609
+ "required": true
610
+ },
611
+ "x-integration-id": {
612
+ "in": "header",
613
+ "description": "Integration id",
614
+ "type": "string",
615
+ "required": false
616
+ },
617
+ "x-integration-alias": {
618
+ "in": "header",
619
+ "description": "Integration alias",
620
+ "type": "string",
621
+ "required": false
458
622
  }
459
623
  },
460
624
  "section": "conversation",
@@ -493,6 +657,24 @@ export const state = {
493
657
  "in": "path",
494
658
  "type": "string",
495
659
  "description": "User id"
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
496
678
  }
497
679
  },
498
680
  "section": "conversation",
@@ -599,7 +781,26 @@ export const state = {
599
781
  "tags": [
600
782
  "documented"
601
783
  ],
602
- "parameters": {}
784
+ "parameters": {
785
+ "x-bot-id": {
786
+ "in": "header",
787
+ "description": "Bot id",
788
+ "type": "string",
789
+ "required": true
790
+ },
791
+ "x-integration-id": {
792
+ "in": "header",
793
+ "description": "Integration id",
794
+ "type": "string",
795
+ "required": false
796
+ },
797
+ "x-integration-alias": {
798
+ "in": "header",
799
+ "description": "Integration alias",
800
+ "type": "string",
801
+ "required": false
802
+ }
803
+ }
603
804
  },
604
805
  "getEvent": {
605
806
  "name": "getEvent",
@@ -611,6 +812,24 @@ export const state = {
611
812
  "in": "path",
612
813
  "type": "string",
613
814
  "description": "Event id"
815
+ },
816
+ "x-bot-id": {
817
+ "in": "header",
818
+ "description": "Bot id",
819
+ "type": "string",
820
+ "required": true
821
+ },
822
+ "x-integration-id": {
823
+ "in": "header",
824
+ "description": "Integration id",
825
+ "type": "string",
826
+ "required": false
827
+ },
828
+ "x-integration-alias": {
829
+ "in": "header",
830
+ "description": "Integration alias",
831
+ "type": "string",
832
+ "required": false
614
833
  }
615
834
  },
616
835
  "section": "event",
@@ -682,6 +901,24 @@ export const state = {
682
901
  "scheduled"
683
902
  ],
684
903
  "description": "Filter by status. Allowed values: pending, ignored, processed, failed."
904
+ },
905
+ "x-bot-id": {
906
+ "in": "header",
907
+ "description": "Bot id",
908
+ "type": "string",
909
+ "required": true
910
+ },
911
+ "x-integration-id": {
912
+ "in": "header",
913
+ "description": "Integration id",
914
+ "type": "string",
915
+ "required": false
916
+ },
917
+ "x-integration-alias": {
918
+ "in": "header",
919
+ "description": "Integration alias",
920
+ "type": "string",
921
+ "required": false
685
922
  }
686
923
  },
687
924
  "response": {
@@ -728,6 +965,24 @@ export const state = {
728
965
  "in": "path",
729
966
  "type": "string",
730
967
  "description": "Event id"
968
+ },
969
+ "x-bot-id": {
970
+ "in": "header",
971
+ "description": "Bot id",
972
+ "type": "string",
973
+ "required": true
974
+ },
975
+ "x-integration-id": {
976
+ "in": "header",
977
+ "description": "Integration id",
978
+ "type": "string",
979
+ "required": false
980
+ },
981
+ "x-integration-alias": {
982
+ "in": "header",
983
+ "description": "Integration alias",
984
+ "type": "string",
985
+ "required": false
731
986
  }
732
987
  },
733
988
  "section": "event",
@@ -839,7 +1094,26 @@ export const state = {
839
1094
  "tags": [
840
1095
  "documented"
841
1096
  ],
842
- "parameters": {}
1097
+ "parameters": {
1098
+ "x-bot-id": {
1099
+ "in": "header",
1100
+ "description": "Bot id",
1101
+ "type": "string",
1102
+ "required": true
1103
+ },
1104
+ "x-integration-id": {
1105
+ "in": "header",
1106
+ "description": "Integration id",
1107
+ "type": "string",
1108
+ "required": false
1109
+ },
1110
+ "x-integration-alias": {
1111
+ "in": "header",
1112
+ "description": "Integration alias",
1113
+ "type": "string",
1114
+ "required": false
1115
+ }
1116
+ }
843
1117
  },
844
1118
  "getOrCreateMessage": {
845
1119
  "name": "getOrCreateMessage",
@@ -944,7 +1218,26 @@ export const state = {
944
1218
  "tags": [
945
1219
  "documented"
946
1220
  ],
947
- "parameters": {}
1221
+ "parameters": {
1222
+ "x-bot-id": {
1223
+ "in": "header",
1224
+ "description": "Bot id",
1225
+ "type": "string",
1226
+ "required": true
1227
+ },
1228
+ "x-integration-id": {
1229
+ "in": "header",
1230
+ "description": "Integration id",
1231
+ "type": "string",
1232
+ "required": false
1233
+ },
1234
+ "x-integration-alias": {
1235
+ "in": "header",
1236
+ "description": "Integration alias",
1237
+ "type": "string",
1238
+ "required": false
1239
+ }
1240
+ }
948
1241
  },
949
1242
  "getMessage": {
950
1243
  "name": "getMessage",
@@ -956,6 +1249,24 @@ export const state = {
956
1249
  "in": "path",
957
1250
  "type": "string",
958
1251
  "description": "Id of the Message"
1252
+ },
1253
+ "x-bot-id": {
1254
+ "in": "header",
1255
+ "description": "Bot id",
1256
+ "type": "string",
1257
+ "required": true
1258
+ },
1259
+ "x-integration-id": {
1260
+ "in": "header",
1261
+ "description": "Integration id",
1262
+ "type": "string",
1263
+ "required": false
1264
+ },
1265
+ "x-integration-alias": {
1266
+ "in": "header",
1267
+ "description": "Integration alias",
1268
+ "type": "string",
1269
+ "required": false
959
1270
  }
960
1271
  },
961
1272
  "section": "message",
@@ -989,6 +1300,24 @@ export const state = {
989
1300
  "in": "path",
990
1301
  "type": "string",
991
1302
  "description": "Message id"
1303
+ },
1304
+ "x-bot-id": {
1305
+ "in": "header",
1306
+ "description": "Bot id",
1307
+ "type": "string",
1308
+ "required": true
1309
+ },
1310
+ "x-integration-id": {
1311
+ "in": "header",
1312
+ "description": "Integration id",
1313
+ "type": "string",
1314
+ "required": false
1315
+ },
1316
+ "x-integration-alias": {
1317
+ "in": "header",
1318
+ "description": "Integration alias",
1319
+ "type": "string",
1320
+ "required": false
992
1321
  }
993
1322
  },
994
1323
  "section": "message",
@@ -1063,6 +1392,24 @@ export const state = {
1063
1392
  }
1064
1393
  },
1065
1394
  "description": "Filter by tags"
1395
+ },
1396
+ "x-bot-id": {
1397
+ "in": "header",
1398
+ "description": "Bot id",
1399
+ "type": "string",
1400
+ "required": true
1401
+ },
1402
+ "x-integration-id": {
1403
+ "in": "header",
1404
+ "description": "Integration id",
1405
+ "type": "string",
1406
+ "required": false
1407
+ },
1408
+ "x-integration-alias": {
1409
+ "in": "header",
1410
+ "description": "Integration alias",
1411
+ "type": "string",
1412
+ "required": false
1066
1413
  }
1067
1414
  },
1068
1415
  "section": "message",
@@ -1110,6 +1457,24 @@ export const state = {
1110
1457
  "in": "path",
1111
1458
  "type": "string",
1112
1459
  "description": "Message id"
1460
+ },
1461
+ "x-bot-id": {
1462
+ "in": "header",
1463
+ "description": "Bot id",
1464
+ "type": "string",
1465
+ "required": true
1466
+ },
1467
+ "x-integration-id": {
1468
+ "in": "header",
1469
+ "description": "Integration id",
1470
+ "type": "string",
1471
+ "required": false
1472
+ },
1473
+ "x-integration-alias": {
1474
+ "in": "header",
1475
+ "description": "Integration alias",
1476
+ "type": "string",
1477
+ "required": false
1113
1478
  }
1114
1479
  },
1115
1480
  "section": "message",
@@ -1188,7 +1553,26 @@ export const state = {
1188
1553
  "tags": [
1189
1554
  "documented"
1190
1555
  ],
1191
- "parameters": {}
1556
+ "parameters": {
1557
+ "x-bot-id": {
1558
+ "in": "header",
1559
+ "description": "Bot id",
1560
+ "type": "string",
1561
+ "required": true
1562
+ },
1563
+ "x-integration-id": {
1564
+ "in": "header",
1565
+ "description": "Integration id",
1566
+ "type": "string",
1567
+ "required": false
1568
+ },
1569
+ "x-integration-alias": {
1570
+ "in": "header",
1571
+ "description": "Integration alias",
1572
+ "type": "string",
1573
+ "required": false
1574
+ }
1575
+ }
1192
1576
  },
1193
1577
  "getUser": {
1194
1578
  "name": "getUser",
@@ -1200,6 +1584,24 @@ export const state = {
1200
1584
  "in": "path",
1201
1585
  "type": "string",
1202
1586
  "description": "User ID"
1587
+ },
1588
+ "x-bot-id": {
1589
+ "in": "header",
1590
+ "description": "Bot id",
1591
+ "type": "string",
1592
+ "required": true
1593
+ },
1594
+ "x-integration-id": {
1595
+ "in": "header",
1596
+ "description": "Integration id",
1597
+ "type": "string",
1598
+ "required": false
1599
+ },
1600
+ "x-integration-alias": {
1601
+ "in": "header",
1602
+ "description": "Integration alias",
1603
+ "type": "string",
1604
+ "required": false
1203
1605
  }
1204
1606
  },
1205
1607
  "section": "user",
@@ -1249,6 +1651,24 @@ export const state = {
1249
1651
  }
1250
1652
  },
1251
1653
  "description": "Filter by tags"
1654
+ },
1655
+ "x-bot-id": {
1656
+ "in": "header",
1657
+ "description": "Bot id",
1658
+ "type": "string",
1659
+ "required": true
1660
+ },
1661
+ "x-integration-id": {
1662
+ "in": "header",
1663
+ "description": "Integration id",
1664
+ "type": "string",
1665
+ "required": false
1666
+ },
1667
+ "x-integration-alias": {
1668
+ "in": "header",
1669
+ "description": "Integration alias",
1670
+ "type": "string",
1671
+ "required": false
1252
1672
  }
1253
1673
  },
1254
1674
  "section": "user",
@@ -1356,7 +1776,26 @@ export const state = {
1356
1776
  "tags": [
1357
1777
  "documented"
1358
1778
  ],
1359
- "parameters": {}
1779
+ "parameters": {
1780
+ "x-bot-id": {
1781
+ "in": "header",
1782
+ "description": "Bot id",
1783
+ "type": "string",
1784
+ "required": true
1785
+ },
1786
+ "x-integration-id": {
1787
+ "in": "header",
1788
+ "description": "Integration id",
1789
+ "type": "string",
1790
+ "required": false
1791
+ },
1792
+ "x-integration-alias": {
1793
+ "in": "header",
1794
+ "description": "Integration alias",
1795
+ "type": "string",
1796
+ "required": false
1797
+ }
1798
+ }
1360
1799
  },
1361
1800
  "updateUser": {
1362
1801
  "name": "updateUser",
@@ -1368,6 +1807,24 @@ export const state = {
1368
1807
  "in": "path",
1369
1808
  "type": "string",
1370
1809
  "description": "User ID"
1810
+ },
1811
+ "x-bot-id": {
1812
+ "in": "header",
1813
+ "description": "Bot id",
1814
+ "type": "string",
1815
+ "required": true
1816
+ },
1817
+ "x-integration-id": {
1818
+ "in": "header",
1819
+ "description": "Integration id",
1820
+ "type": "string",
1821
+ "required": false
1822
+ },
1823
+ "x-integration-alias": {
1824
+ "in": "header",
1825
+ "description": "Integration alias",
1826
+ "type": "string",
1827
+ "required": false
1371
1828
  }
1372
1829
  },
1373
1830
  "requestBody": {
@@ -1431,6 +1888,24 @@ export const state = {
1431
1888
  "in": "path",
1432
1889
  "type": "string",
1433
1890
  "description": "User ID"
1891
+ },
1892
+ "x-bot-id": {
1893
+ "in": "header",
1894
+ "description": "Bot id",
1895
+ "type": "string",
1896
+ "required": true
1897
+ },
1898
+ "x-integration-id": {
1899
+ "in": "header",
1900
+ "description": "Integration id",
1901
+ "type": "string",
1902
+ "required": false
1903
+ },
1904
+ "x-integration-alias": {
1905
+ "in": "header",
1906
+ "description": "Integration alias",
1907
+ "type": "string",
1908
+ "required": false
1434
1909
  }
1435
1910
  },
1436
1911
  "section": "user",
@@ -1474,6 +1949,24 @@ export const state = {
1474
1949
  "in": "path",
1475
1950
  "type": "string",
1476
1951
  "description": "Name of the State which is declared inside the bot definition"
1952
+ },
1953
+ "x-bot-id": {
1954
+ "in": "header",
1955
+ "description": "Bot id",
1956
+ "type": "string",
1957
+ "required": true
1958
+ },
1959
+ "x-integration-id": {
1960
+ "in": "header",
1961
+ "description": "Integration id",
1962
+ "type": "string",
1963
+ "required": false
1964
+ },
1965
+ "x-integration-alias": {
1966
+ "in": "header",
1967
+ "description": "Integration alias",
1968
+ "type": "string",
1969
+ "required": false
1477
1970
  }
1478
1971
  },
1479
1972
  "requestBody": {
@@ -1545,6 +2038,24 @@ export const state = {
1545
2038
  "in": "path",
1546
2039
  "type": "string",
1547
2040
  "description": "Name of the State which is declared inside the bot definition"
2041
+ },
2042
+ "x-bot-id": {
2043
+ "in": "header",
2044
+ "description": "Bot id",
2045
+ "type": "string",
2046
+ "required": true
2047
+ },
2048
+ "x-integration-id": {
2049
+ "in": "header",
2050
+ "description": "Integration id",
2051
+ "type": "string",
2052
+ "required": false
2053
+ },
2054
+ "x-integration-alias": {
2055
+ "in": "header",
2056
+ "description": "Integration alias",
2057
+ "type": "string",
2058
+ "required": false
1548
2059
  }
1549
2060
  },
1550
2061
  "section": "state",
@@ -1609,6 +2120,24 @@ export const state = {
1609
2120
  "in": "path",
1610
2121
  "type": "string",
1611
2122
  "description": "Name of the State which is declared inside the bot definition"
2123
+ },
2124
+ "x-bot-id": {
2125
+ "in": "header",
2126
+ "description": "Bot id",
2127
+ "type": "string",
2128
+ "required": true
2129
+ },
2130
+ "x-integration-id": {
2131
+ "in": "header",
2132
+ "description": "Integration id",
2133
+ "type": "string",
2134
+ "required": false
2135
+ },
2136
+ "x-integration-alias": {
2137
+ "in": "header",
2138
+ "description": "Integration alias",
2139
+ "type": "string",
2140
+ "required": false
1612
2141
  }
1613
2142
  },
1614
2143
  "requestBody": {
@@ -1686,6 +2215,24 @@ export const state = {
1686
2215
  "in": "path",
1687
2216
  "type": "string",
1688
2217
  "description": "Name of the State which is declared inside the bot definition"
2218
+ },
2219
+ "x-bot-id": {
2220
+ "in": "header",
2221
+ "description": "Bot id",
2222
+ "type": "string",
2223
+ "required": true
2224
+ },
2225
+ "x-integration-id": {
2226
+ "in": "header",
2227
+ "description": "Integration id",
2228
+ "type": "string",
2229
+ "required": false
2230
+ },
2231
+ "x-integration-alias": {
2232
+ "in": "header",
2233
+ "description": "Integration alias",
2234
+ "type": "string",
2235
+ "required": false
1689
2236
  }
1690
2237
  },
1691
2238
  "requestBody": {
@@ -1775,6 +2322,24 @@ export const state = {
1775
2322
  "in": "path",
1776
2323
  "type": "string",
1777
2324
  "description": "Name of the State which is declared inside the bot definition"
2325
+ },
2326
+ "x-bot-id": {
2327
+ "in": "header",
2328
+ "description": "Bot id",
2329
+ "type": "string",
2330
+ "required": true
2331
+ },
2332
+ "x-integration-id": {
2333
+ "in": "header",
2334
+ "description": "Integration id",
2335
+ "type": "string",
2336
+ "required": false
2337
+ },
2338
+ "x-integration-alias": {
2339
+ "in": "header",
2340
+ "description": "Integration alias",
2341
+ "type": "string",
2342
+ "required": false
1778
2343
  }
1779
2344
  },
1780
2345
  "requestBody": {
@@ -1880,7 +2445,26 @@ export const state = {
1880
2445
  "tags": [
1881
2446
  "documented"
1882
2447
  ],
1883
- "parameters": {}
2448
+ "parameters": {
2449
+ "x-bot-id": {
2450
+ "in": "header",
2451
+ "description": "Bot id",
2452
+ "type": "string",
2453
+ "required": true
2454
+ },
2455
+ "x-integration-id": {
2456
+ "in": "header",
2457
+ "description": "Integration id",
2458
+ "type": "string",
2459
+ "required": false
2460
+ },
2461
+ "x-integration-alias": {
2462
+ "in": "header",
2463
+ "description": "Integration alias",
2464
+ "type": "string",
2465
+ "required": false
2466
+ }
2467
+ }
1884
2468
  },
1885
2469
  "configureIntegration": {
1886
2470
  "name": "configureIntegration",
@@ -1934,7 +2518,26 @@ export const state = {
1934
2518
  "tags": [
1935
2519
  "documented"
1936
2520
  ],
1937
- "parameters": {}
2521
+ "parameters": {
2522
+ "x-bot-id": {
2523
+ "in": "header",
2524
+ "description": "Bot id",
2525
+ "type": "string",
2526
+ "required": true
2527
+ },
2528
+ "x-integration-id": {
2529
+ "in": "header",
2530
+ "description": "Integration id",
2531
+ "type": "string",
2532
+ "required": false
2533
+ },
2534
+ "x-integration-alias": {
2535
+ "in": "header",
2536
+ "description": "Integration alias",
2537
+ "type": "string",
2538
+ "required": false
2539
+ }
2540
+ }
1938
2541
  },
1939
2542
  "getTask": {
1940
2543
  "name": "getTask",
@@ -1946,6 +2549,24 @@ export const state = {
1946
2549
  "in": "path",
1947
2550
  "type": "string",
1948
2551
  "description": "Task id"
2552
+ },
2553
+ "x-bot-id": {
2554
+ "in": "header",
2555
+ "description": "Bot id",
2556
+ "type": "string",
2557
+ "required": true
2558
+ },
2559
+ "x-integration-id": {
2560
+ "in": "header",
2561
+ "description": "Integration id",
2562
+ "type": "string",
2563
+ "required": false
2564
+ },
2565
+ "x-integration-alias": {
2566
+ "in": "header",
2567
+ "description": "Integration alias",
2568
+ "type": "string",
2569
+ "required": false
1949
2570
  }
1950
2571
  },
1951
2572
  "section": "task",
@@ -2048,7 +2669,26 @@ export const state = {
2048
2669
  "additionalProperties": false
2049
2670
  }
2050
2671
  },
2051
- "parameters": {}
2672
+ "parameters": {
2673
+ "x-bot-id": {
2674
+ "in": "header",
2675
+ "description": "Bot id",
2676
+ "type": "string",
2677
+ "required": true
2678
+ },
2679
+ "x-integration-id": {
2680
+ "in": "header",
2681
+ "description": "Integration id",
2682
+ "type": "string",
2683
+ "required": false
2684
+ },
2685
+ "x-integration-alias": {
2686
+ "in": "header",
2687
+ "description": "Integration alias",
2688
+ "type": "string",
2689
+ "required": false
2690
+ }
2691
+ }
2052
2692
  },
2053
2693
  "updateTask": {
2054
2694
  "name": "updateTask",
@@ -2060,6 +2700,24 @@ export const state = {
2060
2700
  "in": "path",
2061
2701
  "type": "string",
2062
2702
  "description": "Task id"
2703
+ },
2704
+ "x-bot-id": {
2705
+ "in": "header",
2706
+ "description": "Bot id",
2707
+ "type": "string",
2708
+ "required": true
2709
+ },
2710
+ "x-integration-id": {
2711
+ "in": "header",
2712
+ "description": "Integration id",
2713
+ "type": "string",
2714
+ "required": false
2715
+ },
2716
+ "x-integration-alias": {
2717
+ "in": "header",
2718
+ "description": "Integration alias",
2719
+ "type": "string",
2720
+ "required": false
2063
2721
  }
2064
2722
  },
2065
2723
  "requestBody": {
@@ -2140,6 +2798,24 @@ export const state = {
2140
2798
  "in": "path",
2141
2799
  "type": "string",
2142
2800
  "description": "Task id"
2801
+ },
2802
+ "x-bot-id": {
2803
+ "in": "header",
2804
+ "description": "Bot id",
2805
+ "type": "string",
2806
+ "required": true
2807
+ },
2808
+ "x-integration-id": {
2809
+ "in": "header",
2810
+ "description": "Integration id",
2811
+ "type": "string",
2812
+ "required": false
2813
+ },
2814
+ "x-integration-alias": {
2815
+ "in": "header",
2816
+ "description": "Integration alias",
2817
+ "type": "string",
2818
+ "required": false
2143
2819
  }
2144
2820
  },
2145
2821
  "section": "task",
@@ -2208,6 +2884,24 @@ export const state = {
2208
2884
  "in": "query",
2209
2885
  "type": "string",
2210
2886
  "description": "Type"
2887
+ },
2888
+ "x-bot-id": {
2889
+ "in": "header",
2890
+ "description": "Bot id",
2891
+ "type": "string",
2892
+ "required": true
2893
+ },
2894
+ "x-integration-id": {
2895
+ "in": "header",
2896
+ "description": "Integration id",
2897
+ "type": "string",
2898
+ "required": false
2899
+ },
2900
+ "x-integration-alias": {
2901
+ "in": "header",
2902
+ "description": "Integration alias",
2903
+ "type": "string",
2904
+ "required": false
2211
2905
  }
2212
2906
  },
2213
2907
  "section": "task",
@@ -2325,7 +3019,26 @@ export const state = {
2325
3019
  "additionalProperties": false
2326
3020
  }
2327
3021
  },
2328
- "parameters": {}
3022
+ "parameters": {
3023
+ "x-bot-id": {
3024
+ "in": "header",
3025
+ "description": "Bot id",
3026
+ "type": "string",
3027
+ "required": true
3028
+ },
3029
+ "x-integration-id": {
3030
+ "in": "header",
3031
+ "description": "Integration id",
3032
+ "type": "string",
3033
+ "required": false
3034
+ },
3035
+ "x-integration-alias": {
3036
+ "in": "header",
3037
+ "description": "Integration alias",
3038
+ "type": "string",
3039
+ "required": false
3040
+ }
3041
+ }
2329
3042
  },
2330
3043
  "getWorkflow": {
2331
3044
  "name": "getWorkflow",
@@ -2337,6 +3050,24 @@ export const state = {
2337
3050
  "in": "path",
2338
3051
  "type": "string",
2339
3052
  "description": "Workflow id"
3053
+ },
3054
+ "x-bot-id": {
3055
+ "in": "header",
3056
+ "description": "Bot id",
3057
+ "type": "string",
3058
+ "required": true
3059
+ },
3060
+ "x-integration-id": {
3061
+ "in": "header",
3062
+ "description": "Integration id",
3063
+ "type": "string",
3064
+ "required": false
3065
+ },
3066
+ "x-integration-alias": {
3067
+ "in": "header",
3068
+ "description": "Integration alias",
3069
+ "type": "string",
3070
+ "required": false
2340
3071
  }
2341
3072
  },
2342
3073
  "section": "workflow",
@@ -2367,6 +3098,24 @@ export const state = {
2367
3098
  "in": "path",
2368
3099
  "type": "string",
2369
3100
  "description": "Workflow id"
3101
+ },
3102
+ "x-bot-id": {
3103
+ "in": "header",
3104
+ "description": "Bot id",
3105
+ "type": "string",
3106
+ "required": true
3107
+ },
3108
+ "x-integration-id": {
3109
+ "in": "header",
3110
+ "description": "Integration id",
3111
+ "type": "string",
3112
+ "required": false
3113
+ },
3114
+ "x-integration-alias": {
3115
+ "in": "header",
3116
+ "description": "Integration alias",
3117
+ "type": "string",
3118
+ "required": false
2370
3119
  }
2371
3120
  },
2372
3121
  "requestBody": {
@@ -2449,6 +3198,24 @@ export const state = {
2449
3198
  "in": "path",
2450
3199
  "type": "string",
2451
3200
  "description": "Workflow id"
3201
+ },
3202
+ "x-bot-id": {
3203
+ "in": "header",
3204
+ "description": "Bot id",
3205
+ "type": "string",
3206
+ "required": true
3207
+ },
3208
+ "x-integration-id": {
3209
+ "in": "header",
3210
+ "description": "Integration id",
3211
+ "type": "string",
3212
+ "required": false
3213
+ },
3214
+ "x-integration-alias": {
3215
+ "in": "header",
3216
+ "description": "Integration alias",
3217
+ "type": "string",
3218
+ "required": false
2452
3219
  }
2453
3220
  },
2454
3221
  "section": "workflow",
@@ -2517,6 +3284,24 @@ export const state = {
2517
3284
  "in": "query",
2518
3285
  "description": "Workflow name",
2519
3286
  "type": "string"
3287
+ },
3288
+ "x-bot-id": {
3289
+ "in": "header",
3290
+ "description": "Bot id",
3291
+ "type": "string",
3292
+ "required": true
3293
+ },
3294
+ "x-integration-id": {
3295
+ "in": "header",
3296
+ "description": "Integration id",
3297
+ "type": "string",
3298
+ "required": false
3299
+ },
3300
+ "x-integration-alias": {
3301
+ "in": "header",
3302
+ "description": "Integration alias",
3303
+ "type": "string",
3304
+ "required": false
2520
3305
  }
2521
3306
  },
2522
3307
  "section": "workflow",
@@ -2650,7 +3435,26 @@ export const state = {
2650
3435
  "additionalProperties": false
2651
3436
  }
2652
3437
  },
2653
- "parameters": {}
3438
+ "parameters": {
3439
+ "x-bot-id": {
3440
+ "in": "header",
3441
+ "description": "Bot id",
3442
+ "type": "string",
3443
+ "required": true
3444
+ },
3445
+ "x-integration-id": {
3446
+ "in": "header",
3447
+ "description": "Integration id",
3448
+ "type": "string",
3449
+ "required": false
3450
+ },
3451
+ "x-integration-alias": {
3452
+ "in": "header",
3453
+ "description": "Integration alias",
3454
+ "type": "string",
3455
+ "required": false
3456
+ }
3457
+ }
2654
3458
  },
2655
3459
  "listTagValues": {
2656
3460
  "name": "listTagValues",
@@ -2679,6 +3483,24 @@ export const state = {
2679
3483
  "conversation",
2680
3484
  "message"
2681
3485
  ]
3486
+ },
3487
+ "x-bot-id": {
3488
+ "in": "header",
3489
+ "description": "Bot id",
3490
+ "type": "string",
3491
+ "required": true
3492
+ },
3493
+ "x-integration-id": {
3494
+ "in": "header",
3495
+ "description": "Integration id",
3496
+ "type": "string",
3497
+ "required": false
3498
+ },
3499
+ "x-integration-alias": {
3500
+ "in": "header",
3501
+ "description": "Integration alias",
3502
+ "type": "string",
3503
+ "required": false
2682
3504
  }
2683
3505
  },
2684
3506
  "response": {
@@ -2760,16 +3582,55 @@ export const state = {
2760
3582
  "additionalProperties": false
2761
3583
  }
2762
3584
  },
2763
- "parameters": {}
3585
+ "parameters": {
3586
+ "x-bot-id": {
3587
+ "in": "header",
3588
+ "description": "Bot id",
3589
+ "type": "string",
3590
+ "required": true
3591
+ },
3592
+ "x-integration-id": {
3593
+ "in": "header",
3594
+ "description": "Integration id",
3595
+ "type": "string",
3596
+ "required": false
3597
+ },
3598
+ "x-integration-alias": {
3599
+ "in": "header",
3600
+ "description": "Integration alias",
3601
+ "type": "string",
3602
+ "required": false
3603
+ }
3604
+ }
2764
3605
  }
2765
3606
  },
2766
3607
  "metadata": {
2767
3608
  "title": "Botpress Runtime API",
2768
3609
  "description": "API for Botpress Runtime",
2769
3610
  "server": "https://api.botpress.cloud",
2770
- "version": "1.51.0",
3611
+ "version": "1.52.0",
2771
3612
  "prefix": "v1"
2772
3613
  },
3614
+ "defaultParameters": {
3615
+ "x-bot-id": {
3616
+ "in": "header",
3617
+ "description": "Bot id",
3618
+ "type": "string",
3619
+ "required": true
3620
+ },
3621
+ "x-integration-id": {
3622
+ "in": "header",
3623
+ "description": "Integration id",
3624
+ "type": "string",
3625
+ "required": false
3626
+ },
3627
+ "x-integration-alias": {
3628
+ "in": "header",
3629
+ "description": "Integration alias",
3630
+ "type": "string",
3631
+ "required": false
3632
+ }
3633
+ },
2773
3634
  "errors": [
2774
3635
  {
2775
3636
  "status": 500,
@@ -3660,5 +4521,8 @@ export const state = {
3660
4521
  ],
3661
4522
  "options": {
3662
4523
  "allowUnions": false
3663
- }
4524
+ },
4525
+ "security": [
4526
+ "BearerAuth"
4527
+ ]
3664
4528
  } satisfies State