@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.
@@ -2604,7 +2604,7 @@ export const state = {
2604
2604
  "title": "Botpress API",
2605
2605
  "description": "API for Botpress Cloud",
2606
2606
  "server": "https://api.botpress.cloud",
2607
- "version": "1.15.0",
2607
+ "version": "1.17.0",
2608
2608
  "prefix": "v1"
2609
2609
  },
2610
2610
  "errors": [
@@ -2989,6 +2989,86 @@ export const state = {
2989
2989
  },
2990
2990
  "description": "A mapping of integrations to their configuration"
2991
2991
  },
2992
+ "plugins": {
2993
+ "type": "object",
2994
+ "additionalProperties": {
2995
+ "type": "object",
2996
+ "properties": {
2997
+ "enabled": {
2998
+ "type": "boolean"
2999
+ },
3000
+ "name": {
3001
+ "type": "string",
3002
+ "maxLength": 200,
3003
+ "description": "Name of the [Plugin](#schema_plugin)"
3004
+ },
3005
+ "version": {
3006
+ "type": "string",
3007
+ "maxLength": 200,
3008
+ "description": "Version of the [Plugin](#schema_plugin)"
3009
+ },
3010
+ "configuration": {
3011
+ "type": "object",
3012
+ "additionalProperties": true
3013
+ },
3014
+ "id": {
3015
+ "type": "string",
3016
+ "minLength": 28,
3017
+ "maxLength": 36,
3018
+ "description": "ID of the [Plugin](#schema_plugin)"
3019
+ },
3020
+ "createdAt": {
3021
+ "type": "string",
3022
+ "format": "date-time",
3023
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
3024
+ },
3025
+ "updatedAt": {
3026
+ "type": "string",
3027
+ "format": "date-time",
3028
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
3029
+ },
3030
+ "title": {
3031
+ "type": "string",
3032
+ "minLength": 1,
3033
+ "maxLength": 64,
3034
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
3035
+ },
3036
+ "description": {
3037
+ "type": "string",
3038
+ "maxLength": 256,
3039
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
3040
+ },
3041
+ "iconUrl": {
3042
+ "type": "string",
3043
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
3044
+ },
3045
+ "readmeUrl": {
3046
+ "type": "string",
3047
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
3048
+ },
3049
+ "public": {
3050
+ "type": "boolean",
3051
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
3052
+ }
3053
+ },
3054
+ "required": [
3055
+ "enabled",
3056
+ "name",
3057
+ "version",
3058
+ "configuration",
3059
+ "id",
3060
+ "createdAt",
3061
+ "updatedAt",
3062
+ "title",
3063
+ "description",
3064
+ "iconUrl",
3065
+ "readmeUrl",
3066
+ "public"
3067
+ ],
3068
+ "additionalProperties": false
3069
+ },
3070
+ "description": "A mapping of plugin aliases to their configuration"
3071
+ },
2992
3072
  "user": {
2993
3073
  "type": "object",
2994
3074
  "properties": {
@@ -3366,6 +3446,7 @@ export const state = {
3366
3446
  "updatedAt",
3367
3447
  "signingSecret",
3368
3448
  "integrations",
3449
+ "plugins",
3369
3450
  "user",
3370
3451
  "conversation",
3371
3452
  "message",
@@ -3973,6 +4054,14 @@ export const state = {
3973
4054
  "additionalProperties": false
3974
4055
  }
3975
4056
  },
4057
+ "attributes": {
4058
+ "type": "object",
4059
+ "additionalProperties": {
4060
+ "type": "string",
4061
+ "maxLength": 200
4062
+ },
4063
+ "description": "Optional attributes"
4064
+ },
3976
4065
  "dev": {
3977
4066
  "type": "boolean",
3978
4067
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -4262,6 +4351,14 @@ export const state = {
4262
4351
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
4263
4352
  "additionalProperties": false
4264
4353
  },
4354
+ "attributes": {
4355
+ "type": "object",
4356
+ "additionalProperties": {
4357
+ "type": "string",
4358
+ "maxLength": 200
4359
+ },
4360
+ "description": "Optional attributes"
4361
+ },
4265
4362
  "title": {
4266
4363
  "type": "string",
4267
4364
  "minLength": 1,
@@ -4617,6 +4714,14 @@ export const state = {
4617
4714
  "description": "Conversation object configuration",
4618
4715
  "additionalProperties": false
4619
4716
  },
4717
+ "attributes": {
4718
+ "type": "object",
4719
+ "additionalProperties": {
4720
+ "type": "string",
4721
+ "maxLength": 200
4722
+ },
4723
+ "description": "Optional attributes"
4724
+ },
4620
4725
  "title": {
4621
4726
  "type": "string",
4622
4727
  "minLength": 1,
package/src/gen/state.ts CHANGED
@@ -3848,6 +3848,14 @@ export const state = {
3848
3848
  "additionalProperties": false
3849
3849
  }
3850
3850
  },
3851
+ "attributes": {
3852
+ "type": "object",
3853
+ "additionalProperties": {
3854
+ "type": "string",
3855
+ "maxLength": 200
3856
+ },
3857
+ "description": "Optional attributes"
3858
+ },
3851
3859
  "dev": {
3852
3860
  "type": "boolean",
3853
3861
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -4581,6 +4589,14 @@ export const state = {
4581
4589
  "additionalProperties": false
4582
4590
  }
4583
4591
  },
4592
+ "attributes": {
4593
+ "type": "object",
4594
+ "additionalProperties": {
4595
+ "type": "string",
4596
+ "maxLength": 200
4597
+ },
4598
+ "description": "Optional attributes"
4599
+ },
4584
4600
  "dev": {
4585
4601
  "type": "boolean",
4586
4602
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -5153,6 +5169,14 @@ export const state = {
5153
5169
  "description": "Conversation object configuration",
5154
5170
  "additionalProperties": false
5155
5171
  },
5172
+ "attributes": {
5173
+ "type": "object",
5174
+ "additionalProperties": {
5175
+ "type": "string",
5176
+ "maxLength": 200
5177
+ },
5178
+ "description": "Optional attributes"
5179
+ },
5156
5180
  "title": {
5157
5181
  "type": "string",
5158
5182
  "minLength": 1,
@@ -5543,6 +5567,14 @@ export const state = {
5543
5567
  "description": "Conversation object configuration",
5544
5568
  "additionalProperties": false
5545
5569
  },
5570
+ "attributes": {
5571
+ "type": "object",
5572
+ "additionalProperties": {
5573
+ "type": "string",
5574
+ "maxLength": 200
5575
+ },
5576
+ "description": "Optional attributes"
5577
+ },
5546
5578
  "title": {
5547
5579
  "type": "string",
5548
5580
  "minLength": 1,
@@ -5993,6 +6025,14 @@ export const state = {
5993
6025
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
5994
6026
  "additionalProperties": false
5995
6027
  },
6028
+ "attributes": {
6029
+ "type": "object",
6030
+ "additionalProperties": {
6031
+ "type": "string",
6032
+ "maxLength": 200
6033
+ },
6034
+ "description": "Optional attributes"
6035
+ },
5996
6036
  "title": {
5997
6037
  "type": "string",
5998
6038
  "minLength": 1,
@@ -6283,6 +6323,14 @@ export const state = {
6283
6323
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
6284
6324
  "additionalProperties": false
6285
6325
  },
6326
+ "attributes": {
6327
+ "type": "object",
6328
+ "additionalProperties": {
6329
+ "type": "string",
6330
+ "maxLength": 200
6331
+ },
6332
+ "description": "Optional attributes"
6333
+ },
6286
6334
  "title": {
6287
6335
  "type": "string",
6288
6336
  "minLength": 1,
@@ -6634,7 +6682,7 @@ export const state = {
6634
6682
  "type": "string",
6635
6683
  "maxLength": 500
6636
6684
  },
6637
- "description": "Tags of the [Bot](#schema_bot)"
6685
+ "description": "Optional attributes of the [Bot](#schema_bot)"
6638
6686
  },
6639
6687
  "code": {
6640
6688
  "type": "string",
@@ -6746,7 +6794,7 @@ export const state = {
6746
6794
  "type": "string",
6747
6795
  "maxLength": 500
6748
6796
  },
6749
- "description": "Tags of the [Bot](#schema_bot)"
6797
+ "description": "Optional attributes of the [Bot](#schema_bot)"
6750
6798
  },
6751
6799
  "blocked": {
6752
6800
  "type": "boolean"
@@ -7037,6 +7085,30 @@ export const state = {
7037
7085
  "additionalProperties": false
7038
7086
  }
7039
7087
  },
7088
+ "plugins": {
7089
+ "type": "object",
7090
+ "additionalProperties": {
7091
+ "type": "object",
7092
+ "properties": {
7093
+ "id": {
7094
+ "type": "string"
7095
+ },
7096
+ "enabled": {
7097
+ "type": "boolean"
7098
+ },
7099
+ "configuration": {
7100
+ "type": "object",
7101
+ "additionalProperties": true
7102
+ }
7103
+ },
7104
+ "required": [
7105
+ "id"
7106
+ ],
7107
+ "nullable": true,
7108
+ "additionalProperties": false
7109
+ },
7110
+ "description": "A mapping of plugin aliases to their configuration"
7111
+ },
7040
7112
  "subscriptions": {
7041
7113
  "type": "object",
7042
7114
  "properties": {
@@ -10682,6 +10754,14 @@ export const state = {
10682
10754
  "additionalProperties": false
10683
10755
  }
10684
10756
  },
10757
+ "attributes": {
10758
+ "type": "object",
10759
+ "additionalProperties": {
10760
+ "type": "string",
10761
+ "maxLength": 200
10762
+ },
10763
+ "description": "Optional attributes"
10764
+ },
10685
10765
  "identifier": {
10686
10766
  "type": "object",
10687
10767
  "properties": {
@@ -11264,6 +11344,14 @@ export const state = {
11264
11344
  "additionalProperties": false
11265
11345
  }
11266
11346
  },
11347
+ "attributes": {
11348
+ "type": "object",
11349
+ "additionalProperties": {
11350
+ "type": "string",
11351
+ "maxLength": 200
11352
+ },
11353
+ "description": "Optional attributes"
11354
+ },
11267
11355
  "identifier": {
11268
11356
  "type": "object",
11269
11357
  "properties": {
@@ -12120,6 +12208,15 @@ export const state = {
12120
12208
  },
12121
12209
  "additionalProperties": false
12122
12210
  },
12211
+ "attributes": {
12212
+ "type": "object",
12213
+ "additionalProperties": {
12214
+ "type": "string",
12215
+ "maxLength": 200,
12216
+ "nullable": true
12217
+ },
12218
+ "description": "Optional attributes. Set attributes to null to remove them"
12219
+ },
12123
12220
  "secrets": {
12124
12221
  "type": "object",
12125
12222
  "additionalProperties": {
@@ -12719,6 +12816,15 @@ export const state = {
12719
12816
  },
12720
12817
  "additionalProperties": false
12721
12818
  },
12819
+ "attributes": {
12820
+ "type": "object",
12821
+ "additionalProperties": {
12822
+ "type": "string",
12823
+ "maxLength": 200,
12824
+ "nullable": true
12825
+ },
12826
+ "description": "Optional attributes. Set attributes to null to remove them"
12827
+ },
12722
12828
  "secrets": {
12723
12829
  "type": "object",
12724
12830
  "additionalProperties": {
@@ -13456,6 +13562,14 @@ export const state = {
13456
13562
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
13457
13563
  "additionalProperties": false
13458
13564
  },
13565
+ "attributes": {
13566
+ "type": "object",
13567
+ "additionalProperties": {
13568
+ "type": "string",
13569
+ "maxLength": 200
13570
+ },
13571
+ "description": "Optional attributes"
13572
+ },
13459
13573
  "icon": {
13460
13574
  "type": "string",
13461
13575
  "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -13775,6 +13889,15 @@ export const state = {
13775
13889
  "nullable": true,
13776
13890
  "additionalProperties": false
13777
13891
  },
13892
+ "attributes": {
13893
+ "type": "object",
13894
+ "additionalProperties": {
13895
+ "type": "string",
13896
+ "maxLength": 200,
13897
+ "nullable": true
13898
+ },
13899
+ "description": "Optional attributes. Set attributes to null to remove them"
13900
+ },
13778
13901
  "icon": {
13779
13902
  "type": "string",
13780
13903
  "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -14234,6 +14357,14 @@ export const state = {
14234
14357
  },
14235
14358
  "additionalProperties": false
14236
14359
  },
14360
+ "attributes": {
14361
+ "type": "object",
14362
+ "additionalProperties": {
14363
+ "type": "string",
14364
+ "maxLength": 200
14365
+ },
14366
+ "description": "Optional attributes"
14367
+ },
14237
14368
  "code": {
14238
14369
  "type": "object",
14239
14370
  "properties": {
@@ -14287,7 +14418,7 @@ export const state = {
14287
14418
  },
14288
14419
  "section": "plugin",
14289
14420
  "response": {
14290
- "description": "Get an plugin",
14421
+ "description": "Get a plugin",
14291
14422
  "schema": {
14292
14423
  "type": "object",
14293
14424
  "properties": {
@@ -14317,7 +14448,7 @@ export const state = {
14317
14448
  },
14318
14449
  "section": "plugin",
14319
14450
  "response": {
14320
- "description": "Get an plugin",
14451
+ "description": "Get a plugin",
14321
14452
  "schema": {
14322
14453
  "type": "object",
14323
14454
  "properties": {
@@ -14352,7 +14483,7 @@ export const state = {
14352
14483
  },
14353
14484
  "section": "plugin",
14354
14485
  "response": {
14355
- "description": "Get an plugin",
14486
+ "description": "Get a plugin",
14356
14487
  "schema": {
14357
14488
  "type": "object",
14358
14489
  "properties": {
@@ -14644,6 +14775,15 @@ export const state = {
14644
14775
  },
14645
14776
  "additionalProperties": false
14646
14777
  },
14778
+ "attributes": {
14779
+ "type": "object",
14780
+ "additionalProperties": {
14781
+ "type": "string",
14782
+ "maxLength": 200,
14783
+ "nullable": true
14784
+ },
14785
+ "description": "Optional attributes. Set attributes to null to remove them"
14786
+ },
14647
14787
  "code": {
14648
14788
  "type": "object",
14649
14789
  "properties": {
@@ -14688,7 +14828,7 @@ export const state = {
14688
14828
  },
14689
14829
  "section": "plugin",
14690
14830
  "response": {
14691
- "description": "Update an plugin",
14831
+ "description": "Update a plugin",
14692
14832
  "schema": {
14693
14833
  "type": "object",
14694
14834
  "properties": {
@@ -14718,7 +14858,7 @@ export const state = {
14718
14858
  },
14719
14859
  "section": "plugin",
14720
14860
  "response": {
14721
- "description": "Delete an plugin",
14861
+ "description": "Delete a plugin",
14722
14862
  "schema": {
14723
14863
  "type": "object",
14724
14864
  "title": "deletePluginResponse",
@@ -18254,7 +18394,7 @@ export const state = {
18254
18394
  "title": "Botpress API",
18255
18395
  "description": "API for Botpress Cloud",
18256
18396
  "server": "https://api.botpress.cloud",
18257
- "version": "1.15.0",
18397
+ "version": "1.17.0",
18258
18398
  "prefix": "v1"
18259
18399
  },
18260
18400
  "errors": [
@@ -18814,6 +18954,86 @@ export const state = {
18814
18954
  },
18815
18955
  "description": "A mapping of integrations to their configuration"
18816
18956
  },
18957
+ "plugins": {
18958
+ "type": "object",
18959
+ "additionalProperties": {
18960
+ "type": "object",
18961
+ "properties": {
18962
+ "enabled": {
18963
+ "type": "boolean"
18964
+ },
18965
+ "name": {
18966
+ "type": "string",
18967
+ "maxLength": 200,
18968
+ "description": "Name of the [Plugin](#schema_plugin)"
18969
+ },
18970
+ "version": {
18971
+ "type": "string",
18972
+ "maxLength": 200,
18973
+ "description": "Version of the [Plugin](#schema_plugin)"
18974
+ },
18975
+ "configuration": {
18976
+ "type": "object",
18977
+ "additionalProperties": true
18978
+ },
18979
+ "id": {
18980
+ "type": "string",
18981
+ "minLength": 28,
18982
+ "maxLength": 36,
18983
+ "description": "ID of the [Plugin](#schema_plugin)"
18984
+ },
18985
+ "createdAt": {
18986
+ "type": "string",
18987
+ "format": "date-time",
18988
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
18989
+ },
18990
+ "updatedAt": {
18991
+ "type": "string",
18992
+ "format": "date-time",
18993
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
18994
+ },
18995
+ "title": {
18996
+ "type": "string",
18997
+ "minLength": 1,
18998
+ "maxLength": 64,
18999
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
19000
+ },
19001
+ "description": {
19002
+ "type": "string",
19003
+ "maxLength": 256,
19004
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
19005
+ },
19006
+ "iconUrl": {
19007
+ "type": "string",
19008
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
19009
+ },
19010
+ "readmeUrl": {
19011
+ "type": "string",
19012
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
19013
+ },
19014
+ "public": {
19015
+ "type": "boolean",
19016
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
19017
+ }
19018
+ },
19019
+ "required": [
19020
+ "enabled",
19021
+ "name",
19022
+ "version",
19023
+ "configuration",
19024
+ "id",
19025
+ "createdAt",
19026
+ "updatedAt",
19027
+ "title",
19028
+ "description",
19029
+ "iconUrl",
19030
+ "readmeUrl",
19031
+ "public"
19032
+ ],
19033
+ "additionalProperties": false
19034
+ },
19035
+ "description": "A mapping of plugin aliases to their configuration"
19036
+ },
18817
19037
  "user": {
18818
19038
  "type": "object",
18819
19039
  "properties": {
@@ -19191,6 +19411,7 @@ export const state = {
19191
19411
  "updatedAt",
19192
19412
  "signingSecret",
19193
19413
  "integrations",
19414
+ "plugins",
19194
19415
  "user",
19195
19416
  "conversation",
19196
19417
  "message",
@@ -19798,6 +20019,14 @@ export const state = {
19798
20019
  "additionalProperties": false
19799
20020
  }
19800
20021
  },
20022
+ "attributes": {
20023
+ "type": "object",
20024
+ "additionalProperties": {
20025
+ "type": "string",
20026
+ "maxLength": 200
20027
+ },
20028
+ "description": "Optional attributes"
20029
+ },
19801
20030
  "dev": {
19802
20031
  "type": "boolean",
19803
20032
  "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -20087,6 +20316,14 @@ export const state = {
20087
20316
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
20088
20317
  "additionalProperties": false
20089
20318
  },
20319
+ "attributes": {
20320
+ "type": "object",
20321
+ "additionalProperties": {
20322
+ "type": "string",
20323
+ "maxLength": 200
20324
+ },
20325
+ "description": "Optional attributes"
20326
+ },
20090
20327
  "title": {
20091
20328
  "type": "string",
20092
20329
  "minLength": 1,
@@ -20442,6 +20679,14 @@ export const state = {
20442
20679
  "description": "Conversation object configuration",
20443
20680
  "additionalProperties": false
20444
20681
  },
20682
+ "attributes": {
20683
+ "type": "object",
20684
+ "additionalProperties": {
20685
+ "type": "string",
20686
+ "maxLength": 200
20687
+ },
20688
+ "description": "Optional attributes"
20689
+ },
20445
20690
  "title": {
20446
20691
  "type": "string",
20447
20692
  "minLength": 1,