@botpress/api 1.15.0 → 1.16.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.
package/dist/index.js CHANGED
@@ -284126,7 +284126,7 @@ var state = {
284126
284126
  "title": "Botpress API",
284127
284127
  "description": "API for Botpress Cloud",
284128
284128
  "server": "https://api.botpress.cloud",
284129
- "version": "1.15.0",
284129
+ "version": "1.16.0",
284130
284130
  "prefix": "v1"
284131
284131
  },
284132
284132
  "errors": [
@@ -284511,6 +284511,86 @@ var state = {
284511
284511
  },
284512
284512
  "description": "A mapping of integrations to their configuration"
284513
284513
  },
284514
+ "plugins": {
284515
+ "type": "object",
284516
+ "additionalProperties": {
284517
+ "type": "object",
284518
+ "properties": {
284519
+ "enabled": {
284520
+ "type": "boolean"
284521
+ },
284522
+ "name": {
284523
+ "type": "string",
284524
+ "maxLength": 200,
284525
+ "description": "Name of the [Plugin](#schema_plugin)"
284526
+ },
284527
+ "version": {
284528
+ "type": "string",
284529
+ "maxLength": 200,
284530
+ "description": "Version of the [Plugin](#schema_plugin)"
284531
+ },
284532
+ "configuration": {
284533
+ "type": "object",
284534
+ "additionalProperties": true
284535
+ },
284536
+ "id": {
284537
+ "type": "string",
284538
+ "minLength": 28,
284539
+ "maxLength": 36,
284540
+ "description": "ID of the [Plugin](#schema_plugin)"
284541
+ },
284542
+ "createdAt": {
284543
+ "type": "string",
284544
+ "format": "date-time",
284545
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
284546
+ },
284547
+ "updatedAt": {
284548
+ "type": "string",
284549
+ "format": "date-time",
284550
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
284551
+ },
284552
+ "title": {
284553
+ "type": "string",
284554
+ "minLength": 1,
284555
+ "maxLength": 64,
284556
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
284557
+ },
284558
+ "description": {
284559
+ "type": "string",
284560
+ "maxLength": 256,
284561
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
284562
+ },
284563
+ "iconUrl": {
284564
+ "type": "string",
284565
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
284566
+ },
284567
+ "readmeUrl": {
284568
+ "type": "string",
284569
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
284570
+ },
284571
+ "public": {
284572
+ "type": "boolean",
284573
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
284574
+ }
284575
+ },
284576
+ "required": [
284577
+ "enabled",
284578
+ "name",
284579
+ "version",
284580
+ "configuration",
284581
+ "id",
284582
+ "createdAt",
284583
+ "updatedAt",
284584
+ "title",
284585
+ "description",
284586
+ "iconUrl",
284587
+ "readmeUrl",
284588
+ "public"
284589
+ ],
284590
+ "additionalProperties": false
284591
+ },
284592
+ "description": "A mapping of plugin aliases to their configuration"
284593
+ },
284514
284594
  "user": {
284515
284595
  "type": "object",
284516
284596
  "properties": {
@@ -284888,6 +284968,7 @@ var state = {
284888
284968
  "updatedAt",
284889
284969
  "signingSecret",
284890
284970
  "integrations",
284971
+ "plugins",
284891
284972
  "user",
284892
284973
  "conversation",
284893
284974
  "message",
@@ -292333,6 +292414,30 @@ var state2 = {
292333
292414
  "additionalProperties": false
292334
292415
  }
292335
292416
  },
292417
+ "plugins": {
292418
+ "type": "object",
292419
+ "additionalProperties": {
292420
+ "type": "object",
292421
+ "properties": {
292422
+ "id": {
292423
+ "type": "string"
292424
+ },
292425
+ "enabled": {
292426
+ "type": "boolean"
292427
+ },
292428
+ "configuration": {
292429
+ "type": "object",
292430
+ "additionalProperties": true
292431
+ }
292432
+ },
292433
+ "required": [
292434
+ "id"
292435
+ ],
292436
+ "nullable": true,
292437
+ "additionalProperties": false
292438
+ },
292439
+ "description": "A mapping of plugin aliases to their configuration"
292440
+ },
292336
292441
  "subscriptions": {
292337
292442
  "type": "object",
292338
292443
  "properties": {
@@ -299582,7 +299687,7 @@ var state2 = {
299582
299687
  },
299583
299688
  "section": "plugin",
299584
299689
  "response": {
299585
- "description": "Get an plugin",
299690
+ "description": "Get a plugin",
299586
299691
  "schema": {
299587
299692
  "type": "object",
299588
299693
  "properties": {
@@ -299612,7 +299717,7 @@ var state2 = {
299612
299717
  },
299613
299718
  "section": "plugin",
299614
299719
  "response": {
299615
- "description": "Get an plugin",
299720
+ "description": "Get a plugin",
299616
299721
  "schema": {
299617
299722
  "type": "object",
299618
299723
  "properties": {
@@ -299647,7 +299752,7 @@ var state2 = {
299647
299752
  },
299648
299753
  "section": "plugin",
299649
299754
  "response": {
299650
- "description": "Get an plugin",
299755
+ "description": "Get a plugin",
299651
299756
  "schema": {
299652
299757
  "type": "object",
299653
299758
  "properties": {
@@ -299983,7 +300088,7 @@ var state2 = {
299983
300088
  },
299984
300089
  "section": "plugin",
299985
300090
  "response": {
299986
- "description": "Update an plugin",
300091
+ "description": "Update a plugin",
299987
300092
  "schema": {
299988
300093
  "type": "object",
299989
300094
  "properties": {
@@ -300013,7 +300118,7 @@ var state2 = {
300013
300118
  },
300014
300119
  "section": "plugin",
300015
300120
  "response": {
300016
- "description": "Delete an plugin",
300121
+ "description": "Delete a plugin",
300017
300122
  "schema": {
300018
300123
  "type": "object",
300019
300124
  "title": "deletePluginResponse",
@@ -300704,7 +300809,7 @@ var state2 = {
300704
300809
  "title": "Botpress API",
300705
300810
  "description": "API for Botpress Cloud",
300706
300811
  "server": "https://api.botpress.cloud",
300707
- "version": "1.15.0",
300812
+ "version": "1.16.0",
300708
300813
  "prefix": "v1"
300709
300814
  },
300710
300815
  "errors": [
@@ -301147,6 +301252,86 @@ var state2 = {
301147
301252
  },
301148
301253
  "description": "A mapping of integrations to their configuration"
301149
301254
  },
301255
+ "plugins": {
301256
+ "type": "object",
301257
+ "additionalProperties": {
301258
+ "type": "object",
301259
+ "properties": {
301260
+ "enabled": {
301261
+ "type": "boolean"
301262
+ },
301263
+ "name": {
301264
+ "type": "string",
301265
+ "maxLength": 200,
301266
+ "description": "Name of the [Plugin](#schema_plugin)"
301267
+ },
301268
+ "version": {
301269
+ "type": "string",
301270
+ "maxLength": 200,
301271
+ "description": "Version of the [Plugin](#schema_plugin)"
301272
+ },
301273
+ "configuration": {
301274
+ "type": "object",
301275
+ "additionalProperties": true
301276
+ },
301277
+ "id": {
301278
+ "type": "string",
301279
+ "minLength": 28,
301280
+ "maxLength": 36,
301281
+ "description": "ID of the [Plugin](#schema_plugin)"
301282
+ },
301283
+ "createdAt": {
301284
+ "type": "string",
301285
+ "format": "date-time",
301286
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
301287
+ },
301288
+ "updatedAt": {
301289
+ "type": "string",
301290
+ "format": "date-time",
301291
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
301292
+ },
301293
+ "title": {
301294
+ "type": "string",
301295
+ "minLength": 1,
301296
+ "maxLength": 64,
301297
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
301298
+ },
301299
+ "description": {
301300
+ "type": "string",
301301
+ "maxLength": 256,
301302
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
301303
+ },
301304
+ "iconUrl": {
301305
+ "type": "string",
301306
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
301307
+ },
301308
+ "readmeUrl": {
301309
+ "type": "string",
301310
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
301311
+ },
301312
+ "public": {
301313
+ "type": "boolean",
301314
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
301315
+ }
301316
+ },
301317
+ "required": [
301318
+ "enabled",
301319
+ "name",
301320
+ "version",
301321
+ "configuration",
301322
+ "id",
301323
+ "createdAt",
301324
+ "updatedAt",
301325
+ "title",
301326
+ "description",
301327
+ "iconUrl",
301328
+ "readmeUrl",
301329
+ "public"
301330
+ ],
301331
+ "additionalProperties": false
301332
+ },
301333
+ "description": "A mapping of plugin aliases to their configuration"
301334
+ },
301150
301335
  "user": {
301151
301336
  "type": "object",
301152
301337
  "properties": {
@@ -301524,6 +301709,7 @@ var state2 = {
301524
301709
  "updatedAt",
301525
301710
  "signingSecret",
301526
301711
  "integrations",
301712
+ "plugins",
301527
301713
  "user",
301528
301714
  "conversation",
301529
301715
  "message",
@@ -306229,7 +306415,7 @@ var state3 = {
306229
306415
  "title": "Botpress API",
306230
306416
  "description": "API for Botpress Cloud",
306231
306417
  "server": "https://api.botpress.cloud",
306232
- "version": "1.15.0",
306418
+ "version": "1.16.0",
306233
306419
  "prefix": "v1"
306234
306420
  },
306235
306421
  "errors": [
@@ -306567,6 +306753,86 @@ var state3 = {
306567
306753
  },
306568
306754
  "description": "A mapping of integrations to their configuration"
306569
306755
  },
306756
+ "plugins": {
306757
+ "type": "object",
306758
+ "additionalProperties": {
306759
+ "type": "object",
306760
+ "properties": {
306761
+ "enabled": {
306762
+ "type": "boolean"
306763
+ },
306764
+ "name": {
306765
+ "type": "string",
306766
+ "maxLength": 200,
306767
+ "description": "Name of the [Plugin](#schema_plugin)"
306768
+ },
306769
+ "version": {
306770
+ "type": "string",
306771
+ "maxLength": 200,
306772
+ "description": "Version of the [Plugin](#schema_plugin)"
306773
+ },
306774
+ "configuration": {
306775
+ "type": "object",
306776
+ "additionalProperties": true
306777
+ },
306778
+ "id": {
306779
+ "type": "string",
306780
+ "minLength": 28,
306781
+ "maxLength": 36,
306782
+ "description": "ID of the [Plugin](#schema_plugin)"
306783
+ },
306784
+ "createdAt": {
306785
+ "type": "string",
306786
+ "format": "date-time",
306787
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
306788
+ },
306789
+ "updatedAt": {
306790
+ "type": "string",
306791
+ "format": "date-time",
306792
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
306793
+ },
306794
+ "title": {
306795
+ "type": "string",
306796
+ "minLength": 1,
306797
+ "maxLength": 64,
306798
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
306799
+ },
306800
+ "description": {
306801
+ "type": "string",
306802
+ "maxLength": 256,
306803
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
306804
+ },
306805
+ "iconUrl": {
306806
+ "type": "string",
306807
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
306808
+ },
306809
+ "readmeUrl": {
306810
+ "type": "string",
306811
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
306812
+ },
306813
+ "public": {
306814
+ "type": "boolean",
306815
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
306816
+ }
306817
+ },
306818
+ "required": [
306819
+ "enabled",
306820
+ "name",
306821
+ "version",
306822
+ "configuration",
306823
+ "id",
306824
+ "createdAt",
306825
+ "updatedAt",
306826
+ "title",
306827
+ "description",
306828
+ "iconUrl",
306829
+ "readmeUrl",
306830
+ "public"
306831
+ ],
306832
+ "additionalProperties": false
306833
+ },
306834
+ "description": "A mapping of plugin aliases to their configuration"
306835
+ },
306570
306836
  "user": {
306571
306837
  "type": "object",
306572
306838
  "properties": {
@@ -306944,6 +307210,7 @@ var state3 = {
306944
307210
  "updatedAt",
306945
307211
  "signingSecret",
306946
307212
  "integrations",
307213
+ "plugins",
306947
307214
  "user",
306948
307215
  "conversation",
306949
307216
  "message",
@@ -311128,7 +311395,7 @@ var state4 = {
311128
311395
  "title": "Botpress API",
311129
311396
  "description": "API for Botpress Cloud",
311130
311397
  "server": "https://api.botpress.cloud",
311131
- "version": "1.15.0",
311398
+ "version": "1.16.0",
311132
311399
  "prefix": "v1"
311133
311400
  },
311134
311401
  "errors": [
@@ -311473,6 +311740,86 @@ var state4 = {
311473
311740
  },
311474
311741
  "description": "A mapping of integrations to their configuration"
311475
311742
  },
311743
+ "plugins": {
311744
+ "type": "object",
311745
+ "additionalProperties": {
311746
+ "type": "object",
311747
+ "properties": {
311748
+ "enabled": {
311749
+ "type": "boolean"
311750
+ },
311751
+ "name": {
311752
+ "type": "string",
311753
+ "maxLength": 200,
311754
+ "description": "Name of the [Plugin](#schema_plugin)"
311755
+ },
311756
+ "version": {
311757
+ "type": "string",
311758
+ "maxLength": 200,
311759
+ "description": "Version of the [Plugin](#schema_plugin)"
311760
+ },
311761
+ "configuration": {
311762
+ "type": "object",
311763
+ "additionalProperties": true
311764
+ },
311765
+ "id": {
311766
+ "type": "string",
311767
+ "minLength": 28,
311768
+ "maxLength": 36,
311769
+ "description": "ID of the [Plugin](#schema_plugin)"
311770
+ },
311771
+ "createdAt": {
311772
+ "type": "string",
311773
+ "format": "date-time",
311774
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
311775
+ },
311776
+ "updatedAt": {
311777
+ "type": "string",
311778
+ "format": "date-time",
311779
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
311780
+ },
311781
+ "title": {
311782
+ "type": "string",
311783
+ "minLength": 1,
311784
+ "maxLength": 64,
311785
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
311786
+ },
311787
+ "description": {
311788
+ "type": "string",
311789
+ "maxLength": 256,
311790
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
311791
+ },
311792
+ "iconUrl": {
311793
+ "type": "string",
311794
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
311795
+ },
311796
+ "readmeUrl": {
311797
+ "type": "string",
311798
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
311799
+ },
311800
+ "public": {
311801
+ "type": "boolean",
311802
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
311803
+ }
311804
+ },
311805
+ "required": [
311806
+ "enabled",
311807
+ "name",
311808
+ "version",
311809
+ "configuration",
311810
+ "id",
311811
+ "createdAt",
311812
+ "updatedAt",
311813
+ "title",
311814
+ "description",
311815
+ "iconUrl",
311816
+ "readmeUrl",
311817
+ "public"
311818
+ ],
311819
+ "additionalProperties": false
311820
+ },
311821
+ "description": "A mapping of plugin aliases to their configuration"
311822
+ },
311476
311823
  "user": {
311477
311824
  "type": "object",
311478
311825
  "properties": {
@@ -311850,6 +312197,7 @@ var state4 = {
311850
312197
  "updatedAt",
311851
312198
  "signingSecret",
311852
312199
  "integrations",
312200
+ "plugins",
311853
312201
  "user",
311854
312202
  "conversation",
311855
312203
  "message",
@@ -321853,6 +322201,30 @@ var state5 = {
321853
322201
  "additionalProperties": false
321854
322202
  }
321855
322203
  },
322204
+ "plugins": {
322205
+ "type": "object",
322206
+ "additionalProperties": {
322207
+ "type": "object",
322208
+ "properties": {
322209
+ "id": {
322210
+ "type": "string"
322211
+ },
322212
+ "enabled": {
322213
+ "type": "boolean"
322214
+ },
322215
+ "configuration": {
322216
+ "type": "object",
322217
+ "additionalProperties": true
322218
+ }
322219
+ },
322220
+ "required": [
322221
+ "id"
322222
+ ],
322223
+ "nullable": true,
322224
+ "additionalProperties": false
322225
+ },
322226
+ "description": "A mapping of plugin aliases to their configuration"
322227
+ },
321856
322228
  "subscriptions": {
321857
322229
  "type": "object",
321858
322230
  "properties": {
@@ -329103,7 +329475,7 @@ var state5 = {
329103
329475
  },
329104
329476
  "section": "plugin",
329105
329477
  "response": {
329106
- "description": "Get an plugin",
329478
+ "description": "Get a plugin",
329107
329479
  "schema": {
329108
329480
  "type": "object",
329109
329481
  "properties": {
@@ -329133,7 +329505,7 @@ var state5 = {
329133
329505
  },
329134
329506
  "section": "plugin",
329135
329507
  "response": {
329136
- "description": "Get an plugin",
329508
+ "description": "Get a plugin",
329137
329509
  "schema": {
329138
329510
  "type": "object",
329139
329511
  "properties": {
@@ -329168,7 +329540,7 @@ var state5 = {
329168
329540
  },
329169
329541
  "section": "plugin",
329170
329542
  "response": {
329171
- "description": "Get an plugin",
329543
+ "description": "Get a plugin",
329172
329544
  "schema": {
329173
329545
  "type": "object",
329174
329546
  "properties": {
@@ -329504,7 +329876,7 @@ var state5 = {
329504
329876
  },
329505
329877
  "section": "plugin",
329506
329878
  "response": {
329507
- "description": "Update an plugin",
329879
+ "description": "Update a plugin",
329508
329880
  "schema": {
329509
329881
  "type": "object",
329510
329882
  "properties": {
@@ -329534,7 +329906,7 @@ var state5 = {
329534
329906
  },
329535
329907
  "section": "plugin",
329536
329908
  "response": {
329537
- "description": "Delete an plugin",
329909
+ "description": "Delete a plugin",
329538
329910
  "schema": {
329539
329911
  "type": "object",
329540
329912
  "title": "deletePluginResponse",
@@ -333070,7 +333442,7 @@ var state5 = {
333070
333442
  "title": "Botpress API",
333071
333443
  "description": "API for Botpress Cloud",
333072
333444
  "server": "https://api.botpress.cloud",
333073
- "version": "1.15.0",
333445
+ "version": "1.16.0",
333074
333446
  "prefix": "v1"
333075
333447
  },
333076
333448
  "errors": [
@@ -333630,6 +334002,86 @@ var state5 = {
333630
334002
  },
333631
334003
  "description": "A mapping of integrations to their configuration"
333632
334004
  },
334005
+ "plugins": {
334006
+ "type": "object",
334007
+ "additionalProperties": {
334008
+ "type": "object",
334009
+ "properties": {
334010
+ "enabled": {
334011
+ "type": "boolean"
334012
+ },
334013
+ "name": {
334014
+ "type": "string",
334015
+ "maxLength": 200,
334016
+ "description": "Name of the [Plugin](#schema_plugin)"
334017
+ },
334018
+ "version": {
334019
+ "type": "string",
334020
+ "maxLength": 200,
334021
+ "description": "Version of the [Plugin](#schema_plugin)"
334022
+ },
334023
+ "configuration": {
334024
+ "type": "object",
334025
+ "additionalProperties": true
334026
+ },
334027
+ "id": {
334028
+ "type": "string",
334029
+ "minLength": 28,
334030
+ "maxLength": 36,
334031
+ "description": "ID of the [Plugin](#schema_plugin)"
334032
+ },
334033
+ "createdAt": {
334034
+ "type": "string",
334035
+ "format": "date-time",
334036
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
334037
+ },
334038
+ "updatedAt": {
334039
+ "type": "string",
334040
+ "format": "date-time",
334041
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
334042
+ },
334043
+ "title": {
334044
+ "type": "string",
334045
+ "minLength": 1,
334046
+ "maxLength": 64,
334047
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
334048
+ },
334049
+ "description": {
334050
+ "type": "string",
334051
+ "maxLength": 256,
334052
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
334053
+ },
334054
+ "iconUrl": {
334055
+ "type": "string",
334056
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
334057
+ },
334058
+ "readmeUrl": {
334059
+ "type": "string",
334060
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
334061
+ },
334062
+ "public": {
334063
+ "type": "boolean",
334064
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
334065
+ }
334066
+ },
334067
+ "required": [
334068
+ "enabled",
334069
+ "name",
334070
+ "version",
334071
+ "configuration",
334072
+ "id",
334073
+ "createdAt",
334074
+ "updatedAt",
334075
+ "title",
334076
+ "description",
334077
+ "iconUrl",
334078
+ "readmeUrl",
334079
+ "public"
334080
+ ],
334081
+ "additionalProperties": false
334082
+ },
334083
+ "description": "A mapping of plugin aliases to their configuration"
334084
+ },
333633
334085
  "user": {
333634
334086
  "type": "object",
333635
334087
  "properties": {
@@ -334007,6 +334459,7 @@ var state5 = {
334007
334459
  "updatedAt",
334008
334460
  "signingSecret",
334009
334461
  "integrations",
334462
+ "plugins",
334010
334463
  "user",
334011
334464
  "conversation",
334012
334465
  "message",