@botpress/api 0.27.8 → 0.27.9

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.
Files changed (5) hide show
  1. package/dist/index.js +114 -111
  2. package/dist/src/gen/state.d.ts +1 -20
  3. package/package.json +2 -2
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +68 -87
package/src/gen/state.ts CHANGED
@@ -18,7 +18,7 @@ export const state = {
18
18
  "channel": {
19
19
  "type": "string",
20
20
  "maxLength": 200,
21
- "description": "Unique identifier of the integration that was installed on the bot"
21
+ "description": "Channel name"
22
22
  },
23
23
  "tags": {
24
24
  "type": "object",
@@ -171,7 +171,7 @@ export const state = {
171
171
  "channel": {
172
172
  "type": "string",
173
173
  "maxLength": 200,
174
- "description": "Unique identifier of the integration that was installed on the bot"
174
+ "description": "Channel name"
175
175
  },
176
176
  "tags": {
177
177
  "type": "object",
@@ -461,7 +461,7 @@ export const state = {
461
461
  "type": {
462
462
  "type": "string",
463
463
  "maxLength": 200,
464
- "description": "Unique identifier of the integration that was installed on the bot"
464
+ "description": "Type of the [Event](#schema_event)."
465
465
  },
466
466
  "payload": {
467
467
  "type": "object",
@@ -649,18 +649,18 @@ export const state = {
649
649
  "type": "string",
650
650
  "minLength": 28,
651
651
  "maxLength": 36,
652
- "description": "User id"
652
+ "description": "ID of the [User](#schema_user)"
653
653
  },
654
654
  "conversationId": {
655
655
  "type": "string",
656
656
  "minLength": 28,
657
657
  "maxLength": 36,
658
- "description": "User id"
658
+ "description": "ID of the [Conversation](#schema_conversation)"
659
659
  },
660
660
  "type": {
661
661
  "type": "string",
662
662
  "maxLength": 200,
663
- "description": "Unique identifier of the integration that was installed on the bot"
663
+ "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
664
664
  },
665
665
  "tags": {
666
666
  "type": "object",
@@ -677,7 +677,7 @@ export const state = {
677
677
  "type": "string",
678
678
  "maxLength": 28,
679
679
  "minLength": 24,
680
- "description": "When the [Event](#schema_event) will be sent, in the ISO 8601 format"
680
+ "description": "When the [Message](#schema_message) will be sent, in the ISO 8601 format"
681
681
  },
682
682
  "delay": {
683
683
  "type": "number",
@@ -738,18 +738,18 @@ export const state = {
738
738
  "type": "string",
739
739
  "minLength": 28,
740
740
  "maxLength": 36,
741
- "description": "User id"
741
+ "description": "ID of the [User](#schema_user)"
742
742
  },
743
743
  "conversationId": {
744
744
  "type": "string",
745
745
  "minLength": 28,
746
746
  "maxLength": 36,
747
- "description": "User id"
747
+ "description": "ID of the [Conversation](#schema_conversation)"
748
748
  },
749
749
  "type": {
750
750
  "type": "string",
751
751
  "maxLength": 200,
752
- "description": "Unique identifier of the integration that was installed on the bot"
752
+ "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
753
753
  },
754
754
  "tags": {
755
755
  "type": "object",
@@ -766,7 +766,7 @@ export const state = {
766
766
  "type": "string",
767
767
  "maxLength": 28,
768
768
  "minLength": 24,
769
- "description": "When the [Event](#schema_event) will be sent, in the ISO 8601 format"
769
+ "description": "When the [Message](#schema_message) will be sent, in the ISO 8601 format"
770
770
  },
771
771
  "delay": {
772
772
  "type": "number",
@@ -1532,7 +1532,7 @@ export const state = {
1532
1532
  "type": {
1533
1533
  "type": "string",
1534
1534
  "maxLength": 200,
1535
- "description": "Unique identifier of the integration that was installed on the bot"
1535
+ "description": "Type of the action"
1536
1536
  },
1537
1537
  "input": {
1538
1538
  "type": "object",
@@ -1654,7 +1654,7 @@ export const state = {
1654
1654
  "type": {
1655
1655
  "type": "string",
1656
1656
  "maxLength": 200,
1657
- "description": "Unique identifier of the integration that was installed on the bot"
1657
+ "description": "Type of the task"
1658
1658
  },
1659
1659
  "data": {
1660
1660
  "type": "object",
@@ -2363,17 +2363,17 @@ export const state = {
2363
2363
  "type": "string",
2364
2364
  "minLength": 28,
2365
2365
  "maxLength": 36,
2366
- "description": "User id"
2366
+ "description": "ID of the [Integration](#schema_integration)"
2367
2367
  },
2368
2368
  "name": {
2369
2369
  "type": "string",
2370
2370
  "maxLength": 200,
2371
- "description": "Unique identifier of the integration that was installed on the bot"
2371
+ "description": "Name of the [Integration](#schema_integration)"
2372
2372
  },
2373
2373
  "version": {
2374
2374
  "type": "string",
2375
2375
  "maxLength": 200,
2376
- "description": "Unique identifier of the integration that was installed on the bot"
2376
+ "description": "Version of the [Integration](#schema_integration)"
2377
2377
  },
2378
2378
  "createdAt": {
2379
2379
  "type": "string",
@@ -2487,7 +2487,7 @@ export const state = {
2487
2487
  "type": "string",
2488
2488
  "minLength": 28,
2489
2489
  "maxLength": 36,
2490
- "description": "User id"
2490
+ "description": "ID of the [Integration](#schema_integration)"
2491
2491
  },
2492
2492
  "createdAt": {
2493
2493
  "type": "string",
@@ -2519,17 +2519,17 @@ export const state = {
2519
2519
  "url": {
2520
2520
  "type": "string",
2521
2521
  "maxLength": 2000,
2522
- "description": "Title describing the task"
2522
+ "description": "URL of the [Integration](#schema_integration)"
2523
2523
  },
2524
2524
  "name": {
2525
2525
  "type": "string",
2526
2526
  "maxLength": 200,
2527
- "description": "Unique identifier of the integration that was installed on the bot"
2527
+ "description": "Name of the [Integration](#schema_integration)"
2528
2528
  },
2529
2529
  "version": {
2530
2530
  "type": "string",
2531
2531
  "maxLength": 200,
2532
- "description": "Unique identifier of the integration that was installed on the bot"
2532
+ "description": "Version of the [Integration](#schema_integration)"
2533
2533
  },
2534
2534
  "configuration": {
2535
2535
  "type": "object",
@@ -2539,8 +2539,7 @@ export const state = {
2539
2539
  "properties": {
2540
2540
  "linkTemplateScript": {
2541
2541
  "type": "string",
2542
- "maxLength": 2000,
2543
- "description": "Title describing the task"
2542
+ "maxLength": 2000
2544
2543
  },
2545
2544
  "required": {
2546
2545
  "type": "boolean"
@@ -2998,7 +2997,7 @@ export const state = {
2998
2997
  "type": "string",
2999
2998
  "minLength": 28,
3000
2999
  "maxLength": 36,
3001
- "description": "User id"
3000
+ "description": "ID of the [Integration](#schema_integration)"
3002
3001
  },
3003
3002
  "createdAt": {
3004
3003
  "type": "string",
@@ -3030,17 +3029,17 @@ export const state = {
3030
3029
  "url": {
3031
3030
  "type": "string",
3032
3031
  "maxLength": 2000,
3033
- "description": "Title describing the task"
3032
+ "description": "URL of the [Integration](#schema_integration)"
3034
3033
  },
3035
3034
  "name": {
3036
3035
  "type": "string",
3037
3036
  "maxLength": 200,
3038
- "description": "Unique identifier of the integration that was installed on the bot"
3037
+ "description": "Name of the [Integration](#schema_integration)"
3039
3038
  },
3040
3039
  "version": {
3041
3040
  "type": "string",
3042
3041
  "maxLength": 200,
3043
- "description": "Unique identifier of the integration that was installed on the bot"
3042
+ "description": "Version of the [Integration](#schema_integration)"
3044
3043
  },
3045
3044
  "configuration": {
3046
3045
  "type": "object",
@@ -3050,8 +3049,7 @@ export const state = {
3050
3049
  "properties": {
3051
3050
  "linkTemplateScript": {
3052
3051
  "type": "string",
3053
- "maxLength": 2000,
3054
- "description": "Title describing the task"
3052
+ "maxLength": 2000
3055
3053
  },
3056
3054
  "required": {
3057
3055
  "type": "boolean"
@@ -3559,8 +3557,7 @@ export const state = {
3559
3557
  "properties": {
3560
3558
  "cron": {
3561
3559
  "type": "string",
3562
- "maxLength": 200,
3563
- "description": "Unique identifier of the integration that was installed on the bot"
3560
+ "maxLength": 200
3564
3561
  }
3565
3562
  },
3566
3563
  "required": [
@@ -3570,8 +3567,7 @@ export const state = {
3570
3567
  },
3571
3568
  "type": {
3572
3569
  "type": "string",
3573
- "maxLength": 200,
3574
- "description": "Unique identifier of the integration that was installed on the bot"
3570
+ "maxLength": 200
3575
3571
  },
3576
3572
  "payload": {
3577
3573
  "type": "object",
@@ -4065,8 +4061,7 @@ export const state = {
4065
4061
  "properties": {
4066
4062
  "cron": {
4067
4063
  "type": "string",
4068
- "maxLength": 200,
4069
- "description": "Unique identifier of the integration that was installed on the bot"
4064
+ "maxLength": 200
4070
4065
  }
4071
4066
  },
4072
4067
  "required": [
@@ -4076,8 +4071,7 @@ export const state = {
4076
4071
  },
4077
4072
  "type": {
4078
4073
  "type": "string",
4079
- "maxLength": 200,
4080
- "description": "Unique identifier of the integration that was installed on the bot"
4074
+ "maxLength": 200
4081
4075
  },
4082
4076
  "payload": {
4083
4077
  "type": "object",
@@ -4251,7 +4245,7 @@ export const state = {
4251
4245
  "type": "string",
4252
4246
  "minLength": 28,
4253
4247
  "maxLength": 36,
4254
- "description": "User id"
4248
+ "description": "Id of the [Bot](#schema_bot)"
4255
4249
  },
4256
4250
  "createdAt": {
4257
4251
  "type": "string",
@@ -6666,12 +6660,12 @@ export const state = {
6666
6660
  "name": {
6667
6661
  "type": "string",
6668
6662
  "maxLength": 200,
6669
- "description": "Unique identifier of the integration that was installed on the bot"
6663
+ "description": "Name of the [Integration](#schema_integration)"
6670
6664
  },
6671
6665
  "version": {
6672
6666
  "type": "string",
6673
6667
  "maxLength": 200,
6674
- "description": "Unique identifier of the integration that was installed on the bot"
6668
+ "description": "Version of the [Integration](#schema_integration)"
6675
6669
  },
6676
6670
  "configuration": {
6677
6671
  "type": "object",
@@ -6689,8 +6683,7 @@ export const state = {
6689
6683
  },
6690
6684
  "linkTemplateScript": {
6691
6685
  "type": "string",
6692
- "maxLength": 2000,
6693
- "description": "Title describing the task"
6686
+ "maxLength": 2000
6694
6687
  }
6695
6688
  },
6696
6689
  "additionalProperties": false
@@ -6835,13 +6828,11 @@ export const state = {
6835
6828
  "properties": {
6836
6829
  "fallbackHandlerScript": {
6837
6830
  "type": "string",
6838
- "maxLength": 2000,
6839
- "description": "Title describing the task"
6831
+ "maxLength": 2000
6840
6832
  },
6841
6833
  "extractScript": {
6842
6834
  "type": "string",
6843
- "maxLength": 2000,
6844
- "description": "Title describing the task"
6835
+ "maxLength": 2000
6845
6836
  }
6846
6837
  },
6847
6838
  "additionalProperties": false
@@ -7108,7 +7099,6 @@ export const state = {
7108
7099
  "linkTemplateScript": {
7109
7100
  "type": "string",
7110
7101
  "maxLength": 2000,
7111
- "description": "Title describing the task",
7112
7102
  "nullable": true
7113
7103
  },
7114
7104
  "required": {
@@ -7240,13 +7230,11 @@ export const state = {
7240
7230
  "extractScript": {
7241
7231
  "type": "string",
7242
7232
  "maxLength": 2000,
7243
- "description": "Title describing the task",
7244
7233
  "nullable": true
7245
7234
  },
7246
7235
  "fallbackHandlerScript": {
7247
7236
  "type": "string",
7248
7237
  "maxLength": 2000,
7249
- "description": "Title describing the task",
7250
7238
  "nullable": true
7251
7239
  }
7252
7240
  },
@@ -7542,17 +7530,17 @@ export const state = {
7542
7530
  "type": "string",
7543
7531
  "minLength": 28,
7544
7532
  "maxLength": 36,
7545
- "description": "User id"
7533
+ "description": "ID of the [Integration](#schema_integration)"
7546
7534
  },
7547
7535
  "name": {
7548
7536
  "type": "string",
7549
7537
  "maxLength": 200,
7550
- "description": "Unique identifier of the integration that was installed on the bot"
7538
+ "description": "Name of the [Integration](#schema_integration)"
7551
7539
  },
7552
7540
  "version": {
7553
7541
  "type": "string",
7554
7542
  "maxLength": 200,
7555
- "description": "Unique identifier of the integration that was installed on the bot"
7543
+ "description": "Version of the [Integration](#schema_integration)"
7556
7544
  },
7557
7545
  "createdAt": {
7558
7546
  "type": "string",
@@ -9605,7 +9593,7 @@ export const state = {
9605
9593
  "title": "Botpress API",
9606
9594
  "description": "API for Botpress Cloud",
9607
9595
  "server": "https://api.botpress.cloud",
9608
- "version": "0.27.8",
9596
+ "version": "0.27.9",
9609
9597
  "prefix": "v1"
9610
9598
  },
9611
9599
  "errors": [
@@ -9929,7 +9917,7 @@ export const state = {
9929
9917
  "type": "string",
9930
9918
  "minLength": 28,
9931
9919
  "maxLength": 36,
9932
- "description": "ID of the [Conversation](#schema_conversation)"
9920
+ "description": "Id of the [Bot](#schema_bot)"
9933
9921
  },
9934
9922
  "createdAt": {
9935
9923
  "type": "string",
@@ -9944,7 +9932,7 @@ export const state = {
9944
9932
  "signingSecret": {
9945
9933
  "type": "string",
9946
9934
  "maxLength": 2000,
9947
- "description": "Title describing the task"
9935
+ "description": "Signing secret of the [Bot](#schema_bot)"
9948
9936
  },
9949
9937
  "integrations": {
9950
9938
  "type": "object",
@@ -9957,27 +9945,24 @@ export const state = {
9957
9945
  "name": {
9958
9946
  "type": "string",
9959
9947
  "maxLength": 200,
9960
- "description": "Type of the task"
9948
+ "description": "Name of the [Integration](#schema_integration)"
9961
9949
  },
9962
9950
  "version": {
9963
9951
  "type": "string",
9964
9952
  "maxLength": 200,
9965
- "description": "Type of the task"
9953
+ "description": "Version of the [Integration](#schema_integration)"
9966
9954
  },
9967
9955
  "webhookUrl": {
9968
9956
  "type": "string",
9969
- "maxLength": 2000,
9970
- "description": "Title describing the task"
9957
+ "maxLength": 2000
9971
9958
  },
9972
9959
  "webhookId": {
9973
9960
  "type": "string",
9974
- "maxLength": 200,
9975
- "description": "Type of the task"
9961
+ "maxLength": 200
9976
9962
  },
9977
9963
  "identifier": {
9978
9964
  "type": "string",
9979
- "maxLength": 2000,
9980
- "description": "Title describing the task"
9965
+ "maxLength": 2000
9981
9966
  },
9982
9967
  "configuration": {
9983
9968
  "type": "object",
@@ -9997,14 +9982,13 @@ export const state = {
9997
9982
  "statusReason": {
9998
9983
  "type": "string",
9999
9984
  "maxLength": 2000,
10000
- "description": "Title describing the task",
10001
9985
  "nullable": true
10002
9986
  },
10003
9987
  "id": {
10004
9988
  "type": "string",
10005
9989
  "minLength": 28,
10006
9990
  "maxLength": 36,
10007
- "description": "ID of the [Conversation](#schema_conversation)"
9991
+ "description": "ID of the [Integration](#schema_integration)"
10008
9992
  },
10009
9993
  "createdAt": {
10010
9994
  "type": "string",
@@ -10240,8 +10224,7 @@ export const state = {
10240
10224
  "properties": {
10241
10225
  "cron": {
10242
10226
  "type": "string",
10243
- "maxLength": 200,
10244
- "description": "Type of the task"
10227
+ "maxLength": 200
10245
10228
  }
10246
10229
  },
10247
10230
  "required": [
@@ -10251,8 +10234,7 @@ export const state = {
10251
10234
  },
10252
10235
  "type": {
10253
10236
  "type": "string",
10254
- "maxLength": 200,
10255
- "description": "Type of the task"
10237
+ "maxLength": 200
10256
10238
  },
10257
10239
  "payload": {
10258
10240
  "type": "object",
@@ -10434,7 +10416,7 @@ export const state = {
10434
10416
  "type": "string",
10435
10417
  "minLength": 28,
10436
10418
  "maxLength": 36,
10437
- "description": "ID of the [Conversation](#schema_conversation)"
10419
+ "description": "ID of the [Integration](#schema_integration)"
10438
10420
  },
10439
10421
  "createdAt": {
10440
10422
  "type": "string",
@@ -10466,17 +10448,17 @@ export const state = {
10466
10448
  "url": {
10467
10449
  "type": "string",
10468
10450
  "maxLength": 2000,
10469
- "description": "Title describing the task"
10451
+ "description": "URL of the [Integration](#schema_integration)"
10470
10452
  },
10471
10453
  "name": {
10472
10454
  "type": "string",
10473
10455
  "maxLength": 200,
10474
- "description": "Type of the task"
10456
+ "description": "Name of the [Integration](#schema_integration)"
10475
10457
  },
10476
10458
  "version": {
10477
10459
  "type": "string",
10478
10460
  "maxLength": 200,
10479
- "description": "Type of the task"
10461
+ "description": "Version of the [Integration](#schema_integration)"
10480
10462
  },
10481
10463
  "configuration": {
10482
10464
  "type": "object",
@@ -10486,8 +10468,7 @@ export const state = {
10486
10468
  "properties": {
10487
10469
  "linkTemplateScript": {
10488
10470
  "type": "string",
10489
- "maxLength": 2000,
10490
- "description": "Title describing the task"
10471
+ "maxLength": 2000
10491
10472
  },
10492
10473
  "required": {
10493
10474
  "type": "boolean"
@@ -11274,7 +11255,7 @@ export const state = {
11274
11255
  "type": "string",
11275
11256
  "minLength": 28,
11276
11257
  "maxLength": 36,
11277
- "description": "ID of the [Conversation](#schema_conversation)"
11258
+ "description": "Id of the [User](#schema_user)"
11278
11259
  },
11279
11260
  "createdAt": {
11280
11261
  "type": "string",
@@ -11323,7 +11304,7 @@ export const state = {
11323
11304
  "type": "string",
11324
11305
  "minLength": 28,
11325
11306
  "maxLength": 36,
11326
- "description": "ID of the [Conversation](#schema_conversation)"
11307
+ "description": "Id of the [Conversation](#schema_conversation)"
11327
11308
  },
11328
11309
  "currentTaskId": {
11329
11310
  "type": "string",
@@ -11378,7 +11359,7 @@ export const state = {
11378
11359
  "type": "string",
11379
11360
  "minLength": 28,
11380
11361
  "maxLength": 36,
11381
- "description": "ID of the [Conversation](#schema_conversation)"
11362
+ "description": "Id of the [Event](#schema_event)"
11382
11363
  },
11383
11364
  "createdAt": {
11384
11365
  "type": "string",
@@ -11388,7 +11369,7 @@ export const state = {
11388
11369
  "type": {
11389
11370
  "type": "string",
11390
11371
  "maxLength": 200,
11391
- "description": "Type of the task"
11372
+ "description": "Type of the [Event](#schema_event)."
11392
11373
  },
11393
11374
  "payload": {
11394
11375
  "type": "object",
@@ -11425,8 +11406,8 @@ export const state = {
11425
11406
  "failureReason": {
11426
11407
  "type": "string",
11427
11408
  "maxLength": 2000,
11428
- "description": "Reason why the event failed to be processed",
11429
- "nullable": true
11409
+ "nullable": true,
11410
+ "description": "Reason why the event failed to be processed"
11430
11411
  }
11431
11412
  },
11432
11413
  "required": [
@@ -11450,7 +11431,7 @@ export const state = {
11450
11431
  "type": "string",
11451
11432
  "minLength": 28,
11452
11433
  "maxLength": 36,
11453
- "description": "ID of the [Conversation](#schema_conversation)"
11434
+ "description": "Id of the [Message](#schema_message)"
11454
11435
  },
11455
11436
  "createdAt": {
11456
11437
  "type": "string",
@@ -11460,7 +11441,7 @@ export const state = {
11460
11441
  "type": {
11461
11442
  "type": "string",
11462
11443
  "maxLength": 200,
11463
- "description": "Type of the task"
11444
+ "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
11464
11445
  },
11465
11446
  "payload": {
11466
11447
  "type": "object",
@@ -11479,7 +11460,7 @@ export const state = {
11479
11460
  "type": "string",
11480
11461
  "minLength": 28,
11481
11462
  "maxLength": 36,
11482
- "description": "ID of the [Conversation](#schema_conversation)"
11463
+ "description": "ID of the [User](#schema_user)"
11483
11464
  },
11484
11465
  "conversationId": {
11485
11466
  "type": "string",
@@ -11518,7 +11499,7 @@ export const state = {
11518
11499
  "type": "string",
11519
11500
  "minLength": 28,
11520
11501
  "maxLength": 36,
11521
- "description": "ID of the [Conversation](#schema_conversation)"
11502
+ "description": "Id of the [State](#schema_state)"
11522
11503
  },
11523
11504
  "createdAt": {
11524
11505
  "type": "string",
@@ -11534,7 +11515,7 @@ export const state = {
11534
11515
  "type": "string",
11535
11516
  "minLength": 28,
11536
11517
  "maxLength": 36,
11537
- "description": "ID of the [Conversation](#schema_conversation)"
11518
+ "description": "Id of the [Bot](#schema_bot)"
11538
11519
  },
11539
11520
  "conversationId": {
11540
11521
  "type": "string",
@@ -11551,7 +11532,7 @@ export const state = {
11551
11532
  "name": {
11552
11533
  "type": "string",
11553
11534
  "maxLength": 200,
11554
- "description": "Type of the task"
11535
+ "description": "Name of the [State](#schema_state) which is declared inside the bot definition"
11555
11536
  },
11556
11537
  "type": {
11557
11538
  "type": "string",
@@ -11592,7 +11573,7 @@ export const state = {
11592
11573
  "type": "string",
11593
11574
  "minLength": 28,
11594
11575
  "maxLength": 36,
11595
- "description": "ID of the [Conversation](#schema_conversation)"
11576
+ "description": "Id of the [Task](#schema_task)"
11596
11577
  },
11597
11578
  "title": {
11598
11579
  "type": "string",