@botpress/api 1.15.0 → 1.17.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.
Files changed (17) hide show
  1. package/dist/index.js +824 -19
  2. package/dist/src/gen/admin/state.d.ts +229 -0
  3. package/dist/src/gen/files/state.d.ts +91 -0
  4. package/dist/src/gen/runtime/state.d.ts +91 -0
  5. package/dist/src/gen/state.d.ts +229 -0
  6. package/dist/src/gen/tables/state.d.ts +91 -0
  7. package/package.json +1 -1
  8. package/src/gen/admin/openapi.json +1 -1
  9. package/src/gen/admin/state.ts +253 -8
  10. package/src/gen/files/openapi.json +1 -1
  11. package/src/gen/files/state.ts +106 -1
  12. package/src/gen/openapi.json +1 -1
  13. package/src/gen/runtime/openapi.json +1 -1
  14. package/src/gen/runtime/state.ts +106 -1
  15. package/src/gen/state.ts +253 -8
  16. package/src/gen/tables/openapi.json +1 -1
  17. package/src/gen/tables/state.ts +106 -1
package/src/gen/admin/state.ts CHANGED
@@ -1254,6 +1254,14 @@ export const state = {
1254
1254
  "additionalProperties": false
1255
1255
  }
1256
1256
  },
1257
+ "attributes": {
1258
+ "type": "object",
1259
+ "additionalProperties": {
1260
+ "type": "string",
1261
+ "maxLength": 200
1262
+ },
1263
+ "description": "Optional attributes"
1264
+ },
1257
1265
  "dev": {
1258
1266
  "type": "boolean",
1259
1267
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -1987,6 +1995,14 @@ export const state = {
1987
1995
  "additionalProperties": false
1988
1996
  }
1989
1997
  },
1998
+ "attributes": {
1999
+ "type": "object",
2000
+ "additionalProperties": {
2001
+ "type": "string",
2002
+ "maxLength": 200
2003
+ },
2004
+ "description": "Optional attributes"
2005
+ },
1990
2006
  "dev": {
1991
2007
  "type": "boolean",
1992
2008
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -2559,6 +2575,14 @@ export const state = {
2559
2575
  "description": "Conversation object configuration",
2560
2576
  "additionalProperties": false
2561
2577
  },
2578
+ "attributes": {
2579
+ "type": "object",
2580
+ "additionalProperties": {
2581
+ "type": "string",
2582
+ "maxLength": 200
2583
+ },
2584
+ "description": "Optional attributes"
2585
+ },
2562
2586
  "title": {
2563
2587
  "type": "string",
2564
2588
  "minLength": 1,
@@ -2949,6 +2973,14 @@ export const state = {
2949
2973
  "description": "Conversation object configuration",
2950
2974
  "additionalProperties": false
2951
2975
  },
2976
+ "attributes": {
2977
+ "type": "object",
2978
+ "additionalProperties": {
2979
+ "type": "string",
2980
+ "maxLength": 200
2981
+ },
2982
+ "description": "Optional attributes"
2983
+ },
2952
2984
  "title": {
2953
2985
  "type": "string",
2954
2986
  "minLength": 1,
@@ -3399,6 +3431,14 @@ export const state = {
3399
3431
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
3400
3432
  "additionalProperties": false
3401
3433
  },
3434
+ "attributes": {
3435
+ "type": "object",
3436
+ "additionalProperties": {
3437
+ "type": "string",
3438
+ "maxLength": 200
3439
+ },
3440
+ "description": "Optional attributes"
3441
+ },
3402
3442
  "title": {
3403
3443
  "type": "string",
3404
3444
  "minLength": 1,
@@ -3689,6 +3729,14 @@ export const state = {
3689
3729
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
3690
3730
  "additionalProperties": false
3691
3731
  },
3732
+ "attributes": {
3733
+ "type": "object",
3734
+ "additionalProperties": {
3735
+ "type": "string",
3736
+ "maxLength": 200
3737
+ },
3738
+ "description": "Optional attributes"
3739
+ },
3692
3740
  "title": {
3693
3741
  "type": "string",
3694
3742
  "minLength": 1,
@@ -4040,7 +4088,7 @@ export const state = {
4040
4088
  "type": "string",
4041
4089
  "maxLength": 500
4042
4090
  },
4043
- "description": "Tags of the [Bot](#schema_bot)"
4091
+ "description": "Optional attributes of the [Bot](#schema_bot)"
4044
4092
  },
4045
4093
  "code": {
4046
4094
  "type": "string",
@@ -4152,7 +4200,7 @@ export const state = {
4152
4200
  "type": "string",
4153
4201
  "maxLength": 500
4154
4202
  },
4155
- "description": "Tags of the [Bot](#schema_bot)"
4203
+ "description": "Optional attributes of the [Bot](#schema_bot)"
4156
4204
  },
4157
4205
  "blocked": {
4158
4206
  "type": "boolean"
@@ -4443,6 +4491,30 @@ export const state = {
4443
4491
  "additionalProperties": false
4444
4492
  }
4445
4493
  },
4494
+ "plugins": {
4495
+ "type": "object",
4496
+ "additionalProperties": {
4497
+ "type": "object",
4498
+ "properties": {
4499
+ "id": {
4500
+ "type": "string"
4501
+ },
4502
+ "enabled": {
4503
+ "type": "boolean"
4504
+ },
4505
+ "configuration": {
4506
+ "type": "object",
4507
+ "additionalProperties": true
4508
+ }
4509
+ },
4510
+ "required": [
4511
+ "id"
4512
+ ],
4513
+ "nullable": true,
4514
+ "additionalProperties": false
4515
+ },
4516
+ "description": "A mapping of plugin aliases to their configuration"
4517
+ },
4446
4518
  "subscriptions": {
4447
4519
  "type": "object",
4448
4520
  "properties": {
@@ -8087,6 +8159,14 @@ export const state = {
8087
8159
  "additionalProperties": false
8088
8160
  }
8089
8161
  },
8162
+ "attributes": {
8163
+ "type": "object",
8164
+ "additionalProperties": {
8165
+ "type": "string",
8166
+ "maxLength": 200
8167
+ },
8168
+ "description": "Optional attributes"
8169
+ },
8090
8170
  "identifier": {
8091
8171
  "type": "object",
8092
8172
  "properties": {
@@ -8669,6 +8749,14 @@ export const state = {
8669
8749
  "additionalProperties": false
8670
8750
  }
8671
8751
  },
8752
+ "attributes": {
8753
+ "type": "object",
8754
+ "additionalProperties": {
8755
+ "type": "string",
8756
+ "maxLength": 200
8757
+ },
8758
+ "description": "Optional attributes"
8759
+ },
8672
8760
  "identifier": {
8673
8761
  "type": "object",
8674
8762
  "properties": {
@@ -9525,6 +9613,15 @@ export const state = {
9525
9613
  },
9526
9614
  "additionalProperties": false
9527
9615
  },
9616
+ "attributes": {
9617
+ "type": "object",
9618
+ "additionalProperties": {
9619
+ "type": "string",
9620
+ "maxLength": 200,
9621
+ "nullable": true
9622
+ },
9623
+ "description": "Optional attributes. Set attributes to null to remove them"
9624
+ },
9528
9625
  "secrets": {
9529
9626
  "type": "object",
9530
9627
  "additionalProperties": {
@@ -10124,6 +10221,15 @@ export const state = {
10124
10221
  },
10125
10222
  "additionalProperties": false
10126
10223
  },
10224
+ "attributes": {
10225
+ "type": "object",
10226
+ "additionalProperties": {
10227
+ "type": "string",
10228
+ "maxLength": 200,
10229
+ "nullable": true
10230
+ },
10231
+ "description": "Optional attributes. Set attributes to null to remove them"
10232
+ },
10127
10233
  "secrets": {
10128
10234
  "type": "object",
10129
10235
  "additionalProperties": {
@@ -10861,6 +10967,14 @@ export const state = {
10861
10967
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
10862
10968
  "additionalProperties": false
10863
10969
  },
10970
+ "attributes": {
10971
+ "type": "object",
10972
+ "additionalProperties": {
10973
+ "type": "string",
10974
+ "maxLength": 200
10975
+ },
10976
+ "description": "Optional attributes"
10977
+ },
10864
10978
  "icon": {
10865
10979
  "type": "string",
10866
10980
  "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -11180,6 +11294,15 @@ export const state = {
11180
11294
  "nullable": true,
11181
11295
  "additionalProperties": false
11182
11296
  },
11297
+ "attributes": {
11298
+ "type": "object",
11299
+ "additionalProperties": {
11300
+ "type": "string",
11301
+ "maxLength": 200,
11302
+ "nullable": true
11303
+ },
11304
+ "description": "Optional attributes. Set attributes to null to remove them"
11305
+ },
11183
11306
  "icon": {
11184
11307
  "type": "string",
11185
11308
  "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -11639,6 +11762,14 @@ export const state = {
11639
11762
  },
11640
11763
  "additionalProperties": false
11641
11764
  },
11765
+ "attributes": {
11766
+ "type": "object",
11767
+ "additionalProperties": {
11768
+ "type": "string",
11769
+ "maxLength": 200
11770
+ },
11771
+ "description": "Optional attributes"
11772
+ },
11642
11773
  "code": {
11643
11774
  "type": "object",
11644
11775
  "properties": {
@@ -11692,7 +11823,7 @@ export const state = {
11692
11823
  },
11693
11824
  "section": "plugin",
11694
11825
  "response": {
11695
- "description": "Get an plugin",
11826
+ "description": "Get a plugin",
11696
11827
  "schema": {
11697
11828
  "type": "object",
11698
11829
  "properties": {
@@ -11722,7 +11853,7 @@ export const state = {
11722
11853
  },
11723
11854
  "section": "plugin",
11724
11855
  "response": {
11725
- "description": "Get an plugin",
11856
+ "description": "Get a plugin",
11726
11857
  "schema": {
11727
11858
  "type": "object",
11728
11859
  "properties": {
@@ -11757,7 +11888,7 @@ export const state = {
11757
11888
  },
11758
11889
  "section": "plugin",
11759
11890
  "response": {
11760
- "description": "Get an plugin",
11891
+ "description": "Get a plugin",
11761
11892
  "schema": {
11762
11893
  "type": "object",
11763
11894
  "properties": {
@@ -12049,6 +12180,15 @@ export const state = {
12049
12180
  },
12050
12181
  "additionalProperties": false
12051
12182
  },
12183
+ "attributes": {
12184
+ "type": "object",
12185
+ "additionalProperties": {
12186
+ "type": "string",
12187
+ "maxLength": 200,
12188
+ "nullable": true
12189
+ },
12190
+ "description": "Optional attributes. Set attributes to null to remove them"
12191
+ },
12052
12192
  "code": {
12053
12193
  "type": "object",
12054
12194
  "properties": {
@@ -12093,7 +12233,7 @@ export const state = {
12093
12233
  },
12094
12234
  "section": "plugin",
12095
12235
  "response": {
12096
- "description": "Update an plugin",
12236
+ "description": "Update a plugin",
12097
12237
  "schema": {
12098
12238
  "type": "object",
12099
12239
  "properties": {
@@ -12123,7 +12263,7 @@ export const state = {
12123
12263
  },
12124
12264
  "section": "plugin",
12125
12265
  "response": {
12126
- "description": "Delete an plugin",
12266
+ "description": "Delete a plugin",
12127
12267
  "schema": {
12128
12268
  "type": "object",
12129
12269
  "title": "deletePluginResponse",
@@ -12814,7 +12954,7 @@ export const state = {
12814
12954
  "title": "Botpress API",
12815
12955
  "description": "API for Botpress Cloud",
12816
12956
  "server": "https://api.botpress.cloud",
12817
- "version": "1.15.0",
12957
+ "version": "1.17.0",
12818
12958
  "prefix": "v1"
12819
12959
  },
12820
12960
  "errors": [
@@ -13257,6 +13397,86 @@ export const state = {
13257
13397
  },
13258
13398
  "description": "A mapping of integrations to their configuration"
13259
13399
  },
13400
+ "plugins": {
13401
+ "type": "object",
13402
+ "additionalProperties": {
13403
+ "type": "object",
13404
+ "properties": {
13405
+ "enabled": {
13406
+ "type": "boolean"
13407
+ },
13408
+ "name": {
13409
+ "type": "string",
13410
+ "maxLength": 200,
13411
+ "description": "Name of the [Plugin](#schema_plugin)"
13412
+ },
13413
+ "version": {
13414
+ "type": "string",
13415
+ "maxLength": 200,
13416
+ "description": "Version of the [Plugin](#schema_plugin)"
13417
+ },
13418
+ "configuration": {
13419
+ "type": "object",
13420
+ "additionalProperties": true
13421
+ },
13422
+ "id": {
13423
+ "type": "string",
13424
+ "minLength": 28,
13425
+ "maxLength": 36,
13426
+ "description": "ID of the [Plugin](#schema_plugin)"
13427
+ },
13428
+ "createdAt": {
13429
+ "type": "string",
13430
+ "format": "date-time",
13431
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
13432
+ },
13433
+ "updatedAt": {
13434
+ "type": "string",
13435
+ "format": "date-time",
13436
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
13437
+ },
13438
+ "title": {
13439
+ "type": "string",
13440
+ "minLength": 1,
13441
+ "maxLength": 64,
13442
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
13443
+ },
13444
+ "description": {
13445
+ "type": "string",
13446
+ "maxLength": 256,
13447
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
13448
+ },
13449
+ "iconUrl": {
13450
+ "type": "string",
13451
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
13452
+ },
13453
+ "readmeUrl": {
13454
+ "type": "string",
13455
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
13456
+ },
13457
+ "public": {
13458
+ "type": "boolean",
13459
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
13460
+ }
13461
+ },
13462
+ "required": [
13463
+ "enabled",
13464
+ "name",
13465
+ "version",
13466
+ "configuration",
13467
+ "id",
13468
+ "createdAt",
13469
+ "updatedAt",
13470
+ "title",
13471
+ "description",
13472
+ "iconUrl",
13473
+ "readmeUrl",
13474
+ "public"
13475
+ ],
13476
+ "additionalProperties": false
13477
+ },
13478
+ "description": "A mapping of plugin aliases to their configuration"
13479
+ },
13260
13480
  "user": {
13261
13481
  "type": "object",
13262
13482
  "properties": {
@@ -13634,6 +13854,7 @@ export const state = {
13634
13854
  "updatedAt",
13635
13855
  "signingSecret",
13636
13856
  "integrations",
13857
+ "plugins",
13637
13858
  "user",
13638
13859
  "conversation",
13639
13860
  "message",
@@ -14241,6 +14462,14 @@ export const state = {
14241
14462
  "additionalProperties": false
14242
14463
  }
14243
14464
  },
14465
+ "attributes": {
14466
+ "type": "object",
14467
+ "additionalProperties": {
14468
+ "type": "string",
14469
+ "maxLength": 200
14470
+ },
14471
+ "description": "Optional attributes"
14472
+ },
14244
14473
  "dev": {
14245
14474
  "type": "boolean",
14246
14475
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -14530,6 +14759,14 @@ export const state = {
14530
14759
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
14531
14760
  "additionalProperties": false
14532
14761
  },
14762
+ "attributes": {
14763
+ "type": "object",
14764
+ "additionalProperties": {
14765
+ "type": "string",
14766
+ "maxLength": 200
14767
+ },
14768
+ "description": "Optional attributes"
14769
+ },
14533
14770
  "title": {
14534
14771
  "type": "string",
14535
14772
  "minLength": 1,
@@ -14885,6 +15122,14 @@ export const state = {
14885
15122
  "description": "Conversation object configuration",
14886
15123
  "additionalProperties": false
14887
15124
  },
15125
+ "attributes": {
15126
+ "type": "object",
15127
+ "additionalProperties": {
15128
+ "type": "string",
15129
+ "maxLength": 200
15130
+ },
15131
+ "description": "Optional attributes"
15132
+ },
14888
15133
  "title": {
14889
15134
  "type": "string",
14890
15135
  "minLength": 1,