@botpress/api 1.50.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": {
@@ -61,7 +61,29 @@ export const state = {
61
61
  "additionalProperties": false
62
62
  }
63
63
  },
64
- "parameters": {}
64
+ "tags": [
65
+ "documented"
66
+ ],
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
+ }
65
87
  },
66
88
  "getConversation": {
67
89
  "name": "getConversation",
@@ -73,6 +95,24 @@ export const state = {
73
95
  "in": "path",
74
96
  "type": "string",
75
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
76
116
  }
77
117
  },
78
118
  "section": "conversation",
@@ -91,7 +131,10 @@ export const state = {
91
131
  "title": "getConversationResponse",
92
132
  "additionalProperties": false
93
133
  }
94
- }
134
+ },
135
+ "tags": [
136
+ "documented"
137
+ ]
95
138
  },
96
139
  "listConversations": {
97
140
  "name": "listConversations",
@@ -147,6 +190,24 @@ export const state = {
147
190
  "in": "query",
148
191
  "type": "string",
149
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
150
211
  }
151
212
  },
152
213
  "section": "conversation",
@@ -179,7 +240,10 @@ export const state = {
179
240
  "title": "listConversationsResponse",
180
241
  "additionalProperties": false
181
242
  }
182
- }
243
+ },
244
+ "tags": [
245
+ "documented"
246
+ ]
183
247
  },
184
248
  "getOrCreateConversation": {
185
249
  "name": "getOrCreateConversation",
@@ -244,7 +308,29 @@ export const state = {
244
308
  "additionalProperties": false
245
309
  }
246
310
  },
247
- "parameters": {}
311
+ "tags": [
312
+ "documented"
313
+ ],
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
+ }
248
334
  },
249
335
  "updateConversation": {
250
336
  "name": "updateConversation",
@@ -256,6 +342,24 @@ export const state = {
256
342
  "in": "path",
257
343
  "type": "string",
258
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
259
363
  }
260
364
  },
261
365
  "requestBody": {
@@ -294,7 +398,10 @@ export const state = {
294
398
  "title": "updateConversationResponse",
295
399
  "additionalProperties": false
296
400
  }
297
- }
401
+ },
402
+ "tags": [
403
+ "documented"
404
+ ]
298
405
  },
299
406
  "deleteConversation": {
300
407
  "name": "deleteConversation",
@@ -306,6 +413,24 @@ export const state = {
306
413
  "in": "path",
307
414
  "type": "string",
308
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
309
434
  }
310
435
  },
311
436
  "section": "conversation",
@@ -316,7 +441,10 @@ export const state = {
316
441
  "title": "deleteConversationResponse",
317
442
  "additionalProperties": false
318
443
  }
319
- }
444
+ },
445
+ "tags": [
446
+ "documented"
447
+ ]
320
448
  },
321
449
  "listParticipants": {
322
450
  "name": "listParticipants",
@@ -333,6 +461,24 @@ export const state = {
333
461
  "in": "path",
334
462
  "type": "string",
335
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
336
482
  }
337
483
  },
338
484
  "section": "conversation",
@@ -365,7 +511,10 @@ export const state = {
365
511
  "title": "listParticipantsResponse",
366
512
  "additionalProperties": false
367
513
  }
368
- }
514
+ },
515
+ "tags": [
516
+ "documented"
517
+ ]
369
518
  },
370
519
  "addParticipant": {
371
520
  "name": "addParticipant",
@@ -377,6 +526,24 @@ export const state = {
377
526
  "in": "path",
378
527
  "type": "string",
379
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
380
547
  }
381
548
  },
382
549
  "requestBody": {
@@ -414,7 +581,10 @@ export const state = {
414
581
  "title": "addParticipantResponse",
415
582
  "additionalProperties": false
416
583
  }
417
- }
584
+ },
585
+ "tags": [
586
+ "documented"
587
+ ]
418
588
  },
419
589
  "getParticipant": {
420
590
  "name": "getParticipant",
@@ -431,6 +601,24 @@ export const state = {
431
601
  "in": "path",
432
602
  "type": "string",
433
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
434
622
  }
435
623
  },
436
624
  "section": "conversation",
@@ -449,7 +637,10 @@ export const state = {
449
637
  "title": "getParticipantResponse",
450
638
  "additionalProperties": false
451
639
  }
452
- }
640
+ },
641
+ "tags": [
642
+ "documented"
643
+ ]
453
644
  },
454
645
  "removeParticipant": {
455
646
  "name": "removeParticipant",
@@ -466,6 +657,24 @@ export const state = {
466
657
  "in": "path",
467
658
  "type": "string",
468
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
469
678
  }
470
679
  },
471
680
  "section": "conversation",
@@ -476,7 +685,10 @@ export const state = {
476
685
  "title": "removeParticipantResponse",
477
686
  "additionalProperties": false
478
687
  }
479
- }
688
+ },
689
+ "tags": [
690
+ "documented"
691
+ ]
480
692
  },
481
693
  "createEvent": {
482
694
  "name": "createEvent",
@@ -566,7 +778,29 @@ export const state = {
566
778
  "additionalProperties": false
567
779
  }
568
780
  },
569
- "parameters": {}
781
+ "tags": [
782
+ "documented"
783
+ ],
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
+ }
570
804
  },
571
805
  "getEvent": {
572
806
  "name": "getEvent",
@@ -578,6 +812,24 @@ export const state = {
578
812
  "in": "path",
579
813
  "type": "string",
580
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
581
833
  }
582
834
  },
583
835
  "section": "event",
@@ -596,7 +848,10 @@ export const state = {
596
848
  "title": "getEventResponse",
597
849
  "additionalProperties": false
598
850
  }
599
- }
851
+ },
852
+ "tags": [
853
+ "documented"
854
+ ]
600
855
  },
601
856
  "listEvents": {
602
857
  "name": "listEvents",
@@ -646,6 +901,24 @@ export const state = {
646
901
  "scheduled"
647
902
  ],
648
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
649
922
  }
650
923
  },
651
924
  "response": {
@@ -677,7 +950,10 @@ export const state = {
677
950
  "title": "listEventsResponse",
678
951
  "additionalProperties": false
679
952
  }
680
- }
953
+ },
954
+ "tags": [
955
+ "documented"
956
+ ]
681
957
  },
682
958
  "cancelScheduledEvent": {
683
959
  "name": "cancelScheduledEvent",
@@ -689,6 +965,24 @@ export const state = {
689
965
  "in": "path",
690
966
  "type": "string",
691
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
692
986
  }
693
987
  },
694
988
  "section": "event",
@@ -699,7 +993,10 @@ export const state = {
699
993
  "title": "cancelScheduledEventResponse",
700
994
  "additionalProperties": false
701
995
  }
702
- }
996
+ },
997
+ "tags": [
998
+ "documented"
999
+ ]
703
1000
  },
704
1001
  "createMessage": {
705
1002
  "name": "createMessage",
@@ -794,7 +1091,29 @@ export const state = {
794
1091
  "additionalProperties": false
795
1092
  }
796
1093
  },
797
- "parameters": {}
1094
+ "tags": [
1095
+ "documented"
1096
+ ],
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
+ }
798
1117
  },
799
1118
  "getOrCreateMessage": {
800
1119
  "name": "getOrCreateMessage",
@@ -896,7 +1215,29 @@ export const state = {
896
1215
  "additionalProperties": false
897
1216
  }
898
1217
  },
899
- "parameters": {}
1218
+ "tags": [
1219
+ "documented"
1220
+ ],
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
+ }
900
1241
  },
901
1242
  "getMessage": {
902
1243
  "name": "getMessage",
@@ -908,6 +1249,24 @@ export const state = {
908
1249
  "in": "path",
909
1250
  "type": "string",
910
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
911
1270
  }
912
1271
  },
913
1272
  "section": "message",
@@ -926,7 +1285,10 @@ export const state = {
926
1285
  "title": "getMessageResponse",
927
1286
  "additionalProperties": false
928
1287
  }
929
- }
1288
+ },
1289
+ "tags": [
1290
+ "documented"
1291
+ ]
930
1292
  },
931
1293
  "updateMessage": {
932
1294
  "name": "updateMessage",
@@ -938,6 +1300,24 @@ export const state = {
938
1300
  "in": "path",
939
1301
  "type": "string",
940
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
941
1321
  }
942
1322
  },
943
1323
  "section": "message",
@@ -981,7 +1361,10 @@ export const state = {
981
1361
  "title": "updateMessageResponse",
982
1362
  "additionalProperties": false
983
1363
  }
984
- }
1364
+ },
1365
+ "tags": [
1366
+ "documented"
1367
+ ]
985
1368
  },
986
1369
  "listMessages": {
987
1370
  "name": "listMessages",
@@ -1009,6 +1392,24 @@ export const state = {
1009
1392
  }
1010
1393
  },
1011
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
1012
1413
  }
1013
1414
  },
1014
1415
  "section": "message",
@@ -1041,7 +1442,10 @@ export const state = {
1041
1442
  "title": "listMessagesResponse",
1042
1443
  "additionalProperties": false
1043
1444
  }
1044
- }
1445
+ },
1446
+ "tags": [
1447
+ "documented"
1448
+ ]
1045
1449
  },
1046
1450
  "deleteMessage": {
1047
1451
  "name": "deleteMessage",
@@ -1053,6 +1457,24 @@ export const state = {
1053
1457
  "in": "path",
1054
1458
  "type": "string",
1055
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
1056
1478
  }
1057
1479
  },
1058
1480
  "section": "message",
@@ -1063,7 +1485,10 @@ export const state = {
1063
1485
  "title": "deleteMessageResponse",
1064
1486
  "additionalProperties": false
1065
1487
  }
1066
- }
1488
+ },
1489
+ "tags": [
1490
+ "documented"
1491
+ ]
1067
1492
  },
1068
1493
  "createUser": {
1069
1494
  "name": "createUser",
@@ -1125,7 +1550,29 @@ export const state = {
1125
1550
  "additionalProperties": false
1126
1551
  }
1127
1552
  },
1128
- "parameters": {}
1553
+ "tags": [
1554
+ "documented"
1555
+ ],
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
+ }
1129
1576
  },
1130
1577
  "getUser": {
1131
1578
  "name": "getUser",
@@ -1137,6 +1584,24 @@ export const state = {
1137
1584
  "in": "path",
1138
1585
  "type": "string",
1139
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
1140
1605
  }
1141
1606
  },
1142
1607
  "section": "user",
@@ -1155,7 +1620,10 @@ export const state = {
1155
1620
  "title": "getUserResponse",
1156
1621
  "additionalProperties": false
1157
1622
  }
1158
- }
1623
+ },
1624
+ "tags": [
1625
+ "documented"
1626
+ ]
1159
1627
  },
1160
1628
  "listUsers": {
1161
1629
  "name": "listUsers",
@@ -1183,6 +1651,24 @@ export const state = {
1183
1651
  }
1184
1652
  },
1185
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
1186
1672
  }
1187
1673
  },
1188
1674
  "section": "user",
@@ -1215,7 +1701,10 @@ export const state = {
1215
1701
  "title": "listUsersResponse",
1216
1702
  "additionalProperties": false
1217
1703
  }
1218
- }
1704
+ },
1705
+ "tags": [
1706
+ "documented"
1707
+ ]
1219
1708
  },
1220
1709
  "getOrCreateUser": {
1221
1710
  "name": "getOrCreateUser",
@@ -1284,7 +1773,29 @@ export const state = {
1284
1773
  "additionalProperties": false
1285
1774
  }
1286
1775
  },
1287
- "parameters": {}
1776
+ "tags": [
1777
+ "documented"
1778
+ ],
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
+ }
1288
1799
  },
1289
1800
  "updateUser": {
1290
1801
  "name": "updateUser",
@@ -1296,6 +1807,24 @@ export const state = {
1296
1807
  "in": "path",
1297
1808
  "type": "string",
1298
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
1299
1828
  }
1300
1829
  },
1301
1830
  "requestBody": {
@@ -1344,7 +1873,10 @@ export const state = {
1344
1873
  "title": "updateUserResponse",
1345
1874
  "additionalProperties": false
1346
1875
  }
1347
- }
1876
+ },
1877
+ "tags": [
1878
+ "documented"
1879
+ ]
1348
1880
  },
1349
1881
  "deleteUser": {
1350
1882
  "name": "deleteUser",
@@ -1356,6 +1888,24 @@ export const state = {
1356
1888
  "in": "path",
1357
1889
  "type": "string",
1358
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
1359
1909
  }
1360
1910
  },
1361
1911
  "section": "user",
@@ -1366,7 +1916,10 @@ export const state = {
1366
1916
  "title": "deleteUserResponse",
1367
1917
  "additionalProperties": false
1368
1918
  }
1369
- }
1919
+ },
1920
+ "tags": [
1921
+ "documented"
1922
+ ]
1370
1923
  },
1371
1924
  "setStateExpiry": {
1372
1925
  "name": "setStateExpiry",
@@ -1396,6 +1949,24 @@ export const state = {
1396
1949
  "in": "path",
1397
1950
  "type": "string",
1398
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
1399
1970
  }
1400
1971
  },
1401
1972
  "requestBody": {
@@ -1434,7 +2005,10 @@ export const state = {
1434
2005
  "title": "setStateExpiryResponse",
1435
2006
  "additionalProperties": false
1436
2007
  }
1437
- }
2008
+ },
2009
+ "tags": [
2010
+ "documented"
2011
+ ]
1438
2012
  },
1439
2013
  "getState": {
1440
2014
  "name": "getState",
@@ -1464,6 +2038,24 @@ export const state = {
1464
2038
  "in": "path",
1465
2039
  "type": "string",
1466
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
1467
2059
  }
1468
2060
  },
1469
2061
  "section": "state",
@@ -1495,7 +2087,10 @@ export const state = {
1495
2087
  "title": "getStateResponse",
1496
2088
  "additionalProperties": false
1497
2089
  }
1498
- }
2090
+ },
2091
+ "tags": [
2092
+ "documented"
2093
+ ]
1499
2094
  },
1500
2095
  "setState": {
1501
2096
  "name": "setState",
@@ -1525,6 +2120,24 @@ export const state = {
1525
2120
  "in": "path",
1526
2121
  "type": "string",
1527
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
1528
2141
  }
1529
2142
  },
1530
2143
  "requestBody": {
@@ -1569,7 +2182,10 @@ export const state = {
1569
2182
  "title": "setStateResponse",
1570
2183
  "additionalProperties": false
1571
2184
  }
1572
- }
2185
+ },
2186
+ "tags": [
2187
+ "documented"
2188
+ ]
1573
2189
  },
1574
2190
  "getOrSetState": {
1575
2191
  "name": "getOrSetState",
@@ -1599,6 +2215,24 @@ export const state = {
1599
2215
  "in": "path",
1600
2216
  "type": "string",
1601
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
1602
2236
  }
1603
2237
  },
1604
2238
  "requestBody": {
@@ -1655,7 +2289,10 @@ export const state = {
1655
2289
  "title": "getOrSetStateResponse",
1656
2290
  "additionalProperties": false
1657
2291
  }
1658
- }
2292
+ },
2293
+ "tags": [
2294
+ "documented"
2295
+ ]
1659
2296
  },
1660
2297
  "patchState": {
1661
2298
  "name": "patchState",
@@ -1685,6 +2322,24 @@ export const state = {
1685
2322
  "in": "path",
1686
2323
  "type": "string",
1687
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
1688
2343
  }
1689
2344
  },
1690
2345
  "requestBody": {
@@ -1721,7 +2376,10 @@ export const state = {
1721
2376
  "title": "patchStateResponse",
1722
2377
  "additionalProperties": false
1723
2378
  }
1724
- }
2379
+ },
2380
+ "tags": [
2381
+ "documented"
2382
+ ]
1725
2383
  },
1726
2384
  "callAction": {
1727
2385
  "name": "callAction",
@@ -1784,7 +2442,29 @@ export const state = {
1784
2442
  "additionalProperties": false
1785
2443
  }
1786
2444
  },
1787
- "parameters": {}
2445
+ "tags": [
2446
+ "documented"
2447
+ ],
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
+ }
1788
2468
  },
1789
2469
  "configureIntegration": {
1790
2470
  "name": "configureIntegration",
@@ -1835,7 +2515,29 @@ export const state = {
1835
2515
  "additionalProperties": false
1836
2516
  }
1837
2517
  },
1838
- "parameters": {}
2518
+ "tags": [
2519
+ "documented"
2520
+ ],
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
+ }
1839
2541
  },
1840
2542
  "getTask": {
1841
2543
  "name": "getTask",
@@ -1847,6 +2549,24 @@ export const state = {
1847
2549
  "in": "path",
1848
2550
  "type": "string",
1849
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
1850
2570
  }
1851
2571
  },
1852
2572
  "section": "task",
@@ -1949,7 +2669,26 @@ export const state = {
1949
2669
  "additionalProperties": false
1950
2670
  }
1951
2671
  },
1952
- "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
+ }
1953
2692
  },
1954
2693
  "updateTask": {
1955
2694
  "name": "updateTask",
@@ -1961,6 +2700,24 @@ export const state = {
1961
2700
  "in": "path",
1962
2701
  "type": "string",
1963
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
1964
2721
  }
1965
2722
  },
1966
2723
  "requestBody": {
@@ -2041,6 +2798,24 @@ export const state = {
2041
2798
  "in": "path",
2042
2799
  "type": "string",
2043
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
2044
2819
  }
2045
2820
  },
2046
2821
  "section": "task",
@@ -2109,6 +2884,24 @@ export const state = {
2109
2884
  "in": "query",
2110
2885
  "type": "string",
2111
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
2112
2905
  }
2113
2906
  },
2114
2907
  "section": "task",
@@ -2226,7 +3019,26 @@ export const state = {
2226
3019
  "additionalProperties": false
2227
3020
  }
2228
3021
  },
2229
- "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
+ }
2230
3042
  },
2231
3043
  "getWorkflow": {
2232
3044
  "name": "getWorkflow",
@@ -2238,6 +3050,24 @@ export const state = {
2238
3050
  "in": "path",
2239
3051
  "type": "string",
2240
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
2241
3071
  }
2242
3072
  },
2243
3073
  "section": "workflow",
@@ -2268,6 +3098,24 @@ export const state = {
2268
3098
  "in": "path",
2269
3099
  "type": "string",
2270
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
2271
3119
  }
2272
3120
  },
2273
3121
  "requestBody": {
@@ -2350,6 +3198,24 @@ export const state = {
2350
3198
  "in": "path",
2351
3199
  "type": "string",
2352
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
2353
3219
  }
2354
3220
  },
2355
3221
  "section": "workflow",
@@ -2418,6 +3284,24 @@ export const state = {
2418
3284
  "in": "query",
2419
3285
  "description": "Workflow name",
2420
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
2421
3305
  }
2422
3306
  },
2423
3307
  "section": "workflow",
@@ -2551,7 +3435,26 @@ export const state = {
2551
3435
  "additionalProperties": false
2552
3436
  }
2553
3437
  },
2554
- "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
+ }
2555
3458
  },
2556
3459
  "listTagValues": {
2557
3460
  "name": "listTagValues",
@@ -2580,6 +3483,24 @@ export const state = {
2580
3483
  "conversation",
2581
3484
  "message"
2582
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
2583
3504
  }
2584
3505
  },
2585
3506
  "response": {
@@ -2619,7 +3540,10 @@ export const state = {
2619
3540
  "title": "listTagValuesResponse",
2620
3541
  "additionalProperties": false
2621
3542
  }
2622
- }
3543
+ },
3544
+ "tags": [
3545
+ "documented"
3546
+ ]
2623
3547
  },
2624
3548
  "trackAnalytics": {
2625
3549
  "name": "trackAnalytics",
@@ -2658,16 +3582,55 @@ export const state = {
2658
3582
  "additionalProperties": false
2659
3583
  }
2660
3584
  },
2661
- "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
+ }
2662
3605
  }
2663
3606
  },
2664
3607
  "metadata": {
2665
3608
  "title": "Botpress Runtime API",
2666
3609
  "description": "API for Botpress Runtime",
2667
3610
  "server": "https://api.botpress.cloud",
2668
- "version": "1.50.0",
3611
+ "version": "1.52.0",
2669
3612
  "prefix": "v1"
2670
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
+ },
2671
3634
  "errors": [
2672
3635
  {
2673
3636
  "status": 500,
@@ -3558,5 +4521,8 @@ export const state = {
3558
4521
  ],
3559
4522
  "options": {
3560
4523
  "allowUnions": false
3561
- }
4524
+ },
4525
+ "security": [
4526
+ "BearerAuth"
4527
+ ]
3562
4528
  } satisfies State