@botpress/api 1.8.0 → 1.10.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 +954 -280
  2. package/dist/src/gen/admin/state.d.ts +244 -7
  3. package/dist/src/gen/files/state.d.ts +55 -0
  4. package/dist/src/gen/runtime/state.d.ts +55 -0
  5. package/dist/src/gen/state.d.ts +244 -7
  6. package/dist/src/gen/tables/state.d.ts +55 -0
  7. package/package.json +1 -1
  8. package/src/gen/admin/openapi.json +1 -1
  9. package/src/gen/admin/state.ts +262 -15
  10. package/src/gen/files/openapi.json +1 -1
  11. package/src/gen/files/state.ts +62 -2
  12. package/src/gen/openapi.json +1 -1
  13. package/src/gen/runtime/openapi.json +1 -1
  14. package/src/gen/runtime/state.ts +62 -2
  15. package/src/gen/state.ts +262 -15
  16. package/src/gen/tables/openapi.json +1 -1
  17. package/src/gen/tables/state.ts +62 -2
package/src/gen/runtime/state.ts CHANGED
@@ -2608,7 +2608,7 @@ export const state = {
2608
2608
  "title": "Botpress API",
2609
2609
  "description": "API for Botpress Cloud",
2610
2610
  "server": "https://api.botpress.cloud",
2611
- "version": "1.8.0",
2611
+ "version": "1.10.0",
2612
2612
  "prefix": "v1"
2613
2613
  },
2614
2614
  "errors": [
@@ -3147,6 +3147,14 @@ export const state = {
3147
3147
  "schema": {
3148
3148
  "type": "object",
3149
3149
  "additionalProperties": true
3150
+ },
3151
+ "attributes": {
3152
+ "type": "object",
3153
+ "additionalProperties": {
3154
+ "type": "string",
3155
+ "maxLength": 200
3156
+ },
3157
+ "description": "Optional attributes"
3150
3158
  }
3151
3159
  },
3152
3160
  "required": [
@@ -3799,6 +3807,14 @@ export const state = {
3799
3807
  "schema": {
3800
3808
  "type": "object",
3801
3809
  "additionalProperties": true
3810
+ },
3811
+ "attributes": {
3812
+ "type": "object",
3813
+ "additionalProperties": {
3814
+ "type": "string",
3815
+ "maxLength": 200
3816
+ },
3817
+ "description": "Optional attributes"
3802
3818
  }
3803
3819
  },
3804
3820
  "required": [
@@ -4102,6 +4118,14 @@ export const state = {
4102
4118
  "schema": {
4103
4119
  "type": "object",
4104
4120
  "additionalProperties": true
4121
+ },
4122
+ "attributes": {
4123
+ "type": "object",
4124
+ "additionalProperties": {
4125
+ "type": "string",
4126
+ "maxLength": 200
4127
+ },
4128
+ "description": "Optional attributes"
4105
4129
  }
4106
4130
  },
4107
4131
  "required": [
@@ -4232,6 +4256,29 @@ export const state = {
4232
4256
  ],
4233
4257
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
4234
4258
  "additionalProperties": false
4259
+ },
4260
+ "title": {
4261
+ "type": "string",
4262
+ "minLength": 1,
4263
+ "maxLength": 64,
4264
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
4265
+ },
4266
+ "description": {
4267
+ "type": "string",
4268
+ "maxLength": 256,
4269
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
4270
+ },
4271
+ "iconUrl": {
4272
+ "type": "string",
4273
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
4274
+ },
4275
+ "readmeUrl": {
4276
+ "type": "string",
4277
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
4278
+ },
4279
+ "public": {
4280
+ "type": "boolean",
4281
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
4235
4282
  }
4236
4283
  },
4237
4284
  "required": [
@@ -4243,7 +4290,12 @@ export const state = {
4243
4290
  "entities",
4244
4291
  "events",
4245
4292
  "actions",
4246
- "channels"
4293
+ "channels",
4294
+ "title",
4295
+ "description",
4296
+ "iconUrl",
4297
+ "readmeUrl",
4298
+ "public"
4247
4299
  ],
4248
4300
  "additionalProperties": false
4249
4301
  }
@@ -4355,6 +4407,14 @@ export const state = {
4355
4407
  "schema": {
4356
4408
  "type": "object",
4357
4409
  "additionalProperties": true
4410
+ },
4411
+ "attributes": {
4412
+ "type": "object",
4413
+ "additionalProperties": {
4414
+ "type": "string",
4415
+ "maxLength": 200
4416
+ },
4417
+ "description": "Optional attributes"
4358
4418
  }
4359
4419
  },
4360
4420
  "required": [
package/src/gen/state.ts CHANGED
@@ -3691,6 +3691,14 @@ export const state = {
3691
3691
  "schema": {
3692
3692
  "type": "object",
3693
3693
  "additionalProperties": true
3694
+ },
3695
+ "attributes": {
3696
+ "type": "object",
3697
+ "additionalProperties": {
3698
+ "type": "string",
3699
+ "maxLength": 200
3700
+ },
3701
+ "description": "Optional attributes"
3694
3702
  }
3695
3703
  },
3696
3704
  "required": [
@@ -4416,6 +4424,14 @@ export const state = {
4416
4424
  "schema": {
4417
4425
  "type": "object",
4418
4426
  "additionalProperties": true
4427
+ },
4428
+ "attributes": {
4429
+ "type": "object",
4430
+ "additionalProperties": {
4431
+ "type": "string",
4432
+ "maxLength": 200
4433
+ },
4434
+ "description": "Optional attributes"
4419
4435
  }
4420
4436
  },
4421
4437
  "required": [
@@ -4936,6 +4952,14 @@ export const state = {
4936
4952
  "schema": {
4937
4953
  "type": "object",
4938
4954
  "additionalProperties": true
4955
+ },
4956
+ "attributes": {
4957
+ "type": "object",
4958
+ "additionalProperties": {
4959
+ "type": "string",
4960
+ "maxLength": 200
4961
+ },
4962
+ "description": "Optional attributes"
4939
4963
  }
4940
4964
  },
4941
4965
  "required": [
@@ -5318,6 +5342,14 @@ export const state = {
5318
5342
  "schema": {
5319
5343
  "type": "object",
5320
5344
  "additionalProperties": true
5345
+ },
5346
+ "attributes": {
5347
+ "type": "object",
5348
+ "additionalProperties": {
5349
+ "type": "string",
5350
+ "maxLength": 200
5351
+ },
5352
+ "description": "Optional attributes"
5321
5353
  }
5322
5354
  },
5323
5355
  "required": [
@@ -5674,6 +5706,14 @@ export const state = {
5674
5706
  "schema": {
5675
5707
  "type": "object",
5676
5708
  "additionalProperties": true
5709
+ },
5710
+ "attributes": {
5711
+ "type": "object",
5712
+ "additionalProperties": {
5713
+ "type": "string",
5714
+ "maxLength": 200
5715
+ },
5716
+ "description": "Optional attributes"
5677
5717
  }
5678
5718
  },
5679
5719
  "required": [
@@ -6123,12 +6163,20 @@ export const state = {
6123
6163
  "schema": {
6124
6164
  "type": "object",
6125
6165
  "additionalProperties": true
6166
+ },
6167
+ "attributes": {
6168
+ "type": "object",
6169
+ "additionalProperties": {
6170
+ "type": "string",
6171
+ "maxLength": 200,
6172
+ "nullable": true
6173
+ },
6174
+ "description": "Optional attributes. Set attributes to null to remove them"
6126
6175
  }
6127
6176
  },
6128
6177
  "required": [
6129
6178
  "schema"
6130
6179
  ],
6131
- "description": "Event Definition",
6132
6180
  "nullable": true,
6133
6181
  "additionalProperties": false
6134
6182
  }
@@ -6184,16 +6232,16 @@ export const state = {
6184
6232
  "type": "object",
6185
6233
  "additionalProperties": {
6186
6234
  "type": "string",
6187
- "maxLength": 200
6235
+ "maxLength": 200,
6236
+ "nullable": true
6188
6237
  },
6189
- "description": "Optional attributes"
6238
+ "description": "Optional attributes. Set attributes to null to remove them"
6190
6239
  }
6191
6240
  },
6192
6241
  "required": [
6193
6242
  "input",
6194
6243
  "output"
6195
6244
  ],
6196
- "description": "Action definition",
6197
6245
  "nullable": true,
6198
6246
  "additionalProperties": false
6199
6247
  }
@@ -9821,6 +9869,14 @@ export const state = {
9821
9869
  "schema": {
9822
9870
  "type": "object",
9823
9871
  "additionalProperties": true
9872
+ },
9873
+ "attributes": {
9874
+ "type": "object",
9875
+ "additionalProperties": {
9876
+ "type": "string",
9877
+ "maxLength": 200
9878
+ },
9879
+ "description": "Optional attributes"
9824
9880
  }
9825
9881
  },
9826
9882
  "required": [
@@ -10395,6 +10451,14 @@ export const state = {
10395
10451
  "schema": {
10396
10452
  "type": "object",
10397
10453
  "additionalProperties": true
10454
+ },
10455
+ "attributes": {
10456
+ "type": "object",
10457
+ "additionalProperties": {
10458
+ "type": "string",
10459
+ "maxLength": 200
10460
+ },
10461
+ "description": "Optional attributes"
10398
10462
  }
10399
10463
  },
10400
10464
  "required": [
@@ -11128,12 +11192,20 @@ export const state = {
11128
11192
  "schema": {
11129
11193
  "type": "object",
11130
11194
  "additionalProperties": true
11195
+ },
11196
+ "attributes": {
11197
+ "type": "object",
11198
+ "additionalProperties": {
11199
+ "type": "string",
11200
+ "maxLength": 200,
11201
+ "nullable": true
11202
+ },
11203
+ "description": "Optional attributes. Set attributes to null to remove them"
11131
11204
  }
11132
11205
  },
11133
11206
  "required": [
11134
11207
  "schema"
11135
11208
  ],
11136
- "description": "Event Definition",
11137
11209
  "nullable": true,
11138
11210
  "additionalProperties": false
11139
11211
  }
@@ -11719,12 +11791,20 @@ export const state = {
11719
11791
  "schema": {
11720
11792
  "type": "object",
11721
11793
  "additionalProperties": true
11794
+ },
11795
+ "attributes": {
11796
+ "type": "object",
11797
+ "additionalProperties": {
11798
+ "type": "string",
11799
+ "maxLength": 200,
11800
+ "nullable": true
11801
+ },
11802
+ "description": "Optional attributes. Set attributes to null to remove them"
11722
11803
  }
11723
11804
  },
11724
11805
  "required": [
11725
11806
  "schema"
11726
11807
  ],
11727
- "description": "Event Definition",
11728
11808
  "nullable": true,
11729
11809
  "additionalProperties": false
11730
11810
  }
@@ -12526,6 +12606,14 @@ export const state = {
12526
12606
  "schema": {
12527
12607
  "type": "object",
12528
12608
  "additionalProperties": true
12609
+ },
12610
+ "attributes": {
12611
+ "type": "object",
12612
+ "additionalProperties": {
12613
+ "type": "string",
12614
+ "maxLength": 200
12615
+ },
12616
+ "description": "Optional attributes"
12529
12617
  }
12530
12618
  },
12531
12619
  "required": [
@@ -12656,6 +12744,29 @@ export const state = {
12656
12744
  ],
12657
12745
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
12658
12746
  "additionalProperties": false
12747
+ },
12748
+ "icon": {
12749
+ "type": "string",
12750
+ "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
12751
+ },
12752
+ "readme": {
12753
+ "type": "string",
12754
+ "description": "Base64 encoded markdown of the interface readme. The readme is specific to each interface versions."
12755
+ },
12756
+ "title": {
12757
+ "type": "string",
12758
+ "minLength": 1,
12759
+ "maxLength": 64,
12760
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
12761
+ },
12762
+ "description": {
12763
+ "type": "string",
12764
+ "maxLength": 256,
12765
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
12766
+ },
12767
+ "public": {
12768
+ "type": "boolean",
12769
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
12659
12770
  }
12660
12771
  },
12661
12772
  "required": [
@@ -12812,12 +12923,20 @@ export const state = {
12812
12923
  "schema": {
12813
12924
  "type": "object",
12814
12925
  "additionalProperties": true
12926
+ },
12927
+ "attributes": {
12928
+ "type": "object",
12929
+ "additionalProperties": {
12930
+ "type": "string",
12931
+ "maxLength": 200,
12932
+ "nullable": true
12933
+ },
12934
+ "description": "Optional attributes. Set attributes to null to remove them"
12815
12935
  }
12816
12936
  },
12817
12937
  "required": [
12818
12938
  "schema"
12819
12939
  ],
12820
- "description": "Event Definition",
12821
12940
  "nullable": true,
12822
12941
  "additionalProperties": false
12823
12942
  }
@@ -12875,7 +12994,8 @@ export const state = {
12875
12994
  "type": "string",
12876
12995
  "maxLength": 200,
12877
12996
  "nullable": true
12878
- }
12997
+ },
12998
+ "description": "Optional attributes. Set attributes to null to remove them"
12879
12999
  }
12880
13000
  },
12881
13001
  "required": [
@@ -12943,6 +13063,29 @@ export const state = {
12943
13063
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
12944
13064
  "nullable": true,
12945
13065
  "additionalProperties": false
13066
+ },
13067
+ "icon": {
13068
+ "type": "string",
13069
+ "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
13070
+ },
13071
+ "readme": {
13072
+ "type": "string",
13073
+ "description": "Base64 encoded markdown of the interface readme. The readme is specific to each interface versions."
13074
+ },
13075
+ "title": {
13076
+ "type": "string",
13077
+ "minLength": 1,
13078
+ "maxLength": 64,
13079
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
13080
+ },
13081
+ "description": {
13082
+ "type": "string",
13083
+ "maxLength": 256,
13084
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
13085
+ },
13086
+ "public": {
13087
+ "type": "boolean",
13088
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
12946
13089
  }
12947
13090
  },
12948
13091
  "title": "updateInterfaceBody",
@@ -13042,6 +13185,29 @@ export const state = {
13042
13185
  "type": "string",
13043
13186
  "maxLength": 200,
13044
13187
  "description": "Version of the [Interface](#schema_interface)"
13188
+ },
13189
+ "title": {
13190
+ "type": "string",
13191
+ "minLength": 1,
13192
+ "maxLength": 64,
13193
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
13194
+ },
13195
+ "description": {
13196
+ "type": "string",
13197
+ "maxLength": 256,
13198
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
13199
+ },
13200
+ "iconUrl": {
13201
+ "type": "string",
13202
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
13203
+ },
13204
+ "readmeUrl": {
13205
+ "type": "string",
13206
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
13207
+ },
13208
+ "public": {
13209
+ "type": "boolean",
13210
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
13045
13211
  }
13046
13212
  },
13047
13213
  "required": [
@@ -13049,7 +13215,12 @@ export const state = {
13049
13215
  "createdAt",
13050
13216
  "updatedAt",
13051
13217
  "name",
13052
- "version"
13218
+ "version",
13219
+ "title",
13220
+ "description",
13221
+ "iconUrl",
13222
+ "readmeUrl",
13223
+ "public"
13053
13224
  ]
13054
13225
  }
13055
13226
  },
@@ -13170,6 +13341,14 @@ export const state = {
13170
13341
  "schema": {
13171
13342
  "type": "object",
13172
13343
  "additionalProperties": true
13344
+ },
13345
+ "attributes": {
13346
+ "type": "object",
13347
+ "additionalProperties": {
13348
+ "type": "string",
13349
+ "maxLength": 200
13350
+ },
13351
+ "description": "Optional attributes"
13173
13352
  }
13174
13353
  },
13175
13354
  "required": [
@@ -13568,12 +13747,20 @@ export const state = {
13568
13747
  "schema": {
13569
13748
  "type": "object",
13570
13749
  "additionalProperties": true
13750
+ },
13751
+ "attributes": {
13752
+ "type": "object",
13753
+ "additionalProperties": {
13754
+ "type": "string",
13755
+ "maxLength": 200,
13756
+ "nullable": true
13757
+ },
13758
+ "description": "Optional attributes. Set attributes to null to remove them"
13571
13759
  }
13572
13760
  },
13573
13761
  "required": [
13574
13762
  "schema"
13575
13763
  ],
13576
- "description": "Event Definition",
13577
13764
  "nullable": true,
13578
13765
  "additionalProperties": false
13579
13766
  }
@@ -13629,16 +13816,16 @@ export const state = {
13629
13816
  "type": "object",
13630
13817
  "additionalProperties": {
13631
13818
  "type": "string",
13632
- "maxLength": 200
13819
+ "maxLength": 200,
13820
+ "nullable": true
13633
13821
  },
13634
- "description": "Optional attributes"
13822
+ "description": "Optional attributes. Set attributes to null to remove them"
13635
13823
  }
13636
13824
  },
13637
13825
  "required": [
13638
13826
  "input",
13639
13827
  "output"
13640
13828
  ],
13641
- "description": "Action definition",
13642
13829
  "nullable": true,
13643
13830
  "additionalProperties": false
13644
13831
  }
@@ -17251,7 +17438,7 @@ export const state = {
17251
17438
  "title": "Botpress API",
17252
17439
  "description": "API for Botpress Cloud",
17253
17440
  "server": "https://api.botpress.cloud",
17254
- "version": "1.8.0",
17441
+ "version": "1.10.0",
17255
17442
  "prefix": "v1"
17256
17443
  },
17257
17444
  "errors": [
@@ -17960,6 +18147,14 @@ export const state = {
17960
18147
  "schema": {
17961
18148
  "type": "object",
17962
18149
  "additionalProperties": true
18150
+ },
18151
+ "attributes": {
18152
+ "type": "object",
18153
+ "additionalProperties": {
18154
+ "type": "string",
18155
+ "maxLength": 200
18156
+ },
18157
+ "description": "Optional attributes"
17963
18158
  }
17964
18159
  },
17965
18160
  "required": [
@@ -18612,6 +18807,14 @@ export const state = {
18612
18807
  "schema": {
18613
18808
  "type": "object",
18614
18809
  "additionalProperties": true
18810
+ },
18811
+ "attributes": {
18812
+ "type": "object",
18813
+ "additionalProperties": {
18814
+ "type": "string",
18815
+ "maxLength": 200
18816
+ },
18817
+ "description": "Optional attributes"
18615
18818
  }
18616
18819
  },
18617
18820
  "required": [
@@ -18915,6 +19118,14 @@ export const state = {
18915
19118
  "schema": {
18916
19119
  "type": "object",
18917
19120
  "additionalProperties": true
19121
+ },
19122
+ "attributes": {
19123
+ "type": "object",
19124
+ "additionalProperties": {
19125
+ "type": "string",
19126
+ "maxLength": 200
19127
+ },
19128
+ "description": "Optional attributes"
18918
19129
  }
18919
19130
  },
18920
19131
  "required": [
@@ -19045,6 +19256,29 @@ export const state = {
19045
19256
  ],
19046
19257
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
19047
19258
  "additionalProperties": false
19259
+ },
19260
+ "title": {
19261
+ "type": "string",
19262
+ "minLength": 1,
19263
+ "maxLength": 64,
19264
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
19265
+ },
19266
+ "description": {
19267
+ "type": "string",
19268
+ "maxLength": 256,
19269
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
19270
+ },
19271
+ "iconUrl": {
19272
+ "type": "string",
19273
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
19274
+ },
19275
+ "readmeUrl": {
19276
+ "type": "string",
19277
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
19278
+ },
19279
+ "public": {
19280
+ "type": "boolean",
19281
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
19048
19282
  }
19049
19283
  },
19050
19284
  "required": [
@@ -19056,7 +19290,12 @@ export const state = {
19056
19290
  "entities",
19057
19291
  "events",
19058
19292
  "actions",
19059
- "channels"
19293
+ "channels",
19294
+ "title",
19295
+ "description",
19296
+ "iconUrl",
19297
+ "readmeUrl",
19298
+ "public"
19060
19299
  ],
19061
19300
  "additionalProperties": false
19062
19301
  }
@@ -19168,6 +19407,14 @@ export const state = {
19168
19407
  "schema": {
19169
19408
  "type": "object",
19170
19409
  "additionalProperties": true
19410
+ },
19411
+ "attributes": {
19412
+ "type": "object",
19413
+ "additionalProperties": {
19414
+ "type": "string",
19415
+ "maxLength": 200
19416
+ },
19417
+ "description": "Optional attributes"
19171
19418
  }
19172
19419
  },
19173
19420
  "required": [