@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.
@@ -1093,6 +1093,14 @@ export const state = {
1093
1093
  "schema": {
1094
1094
  "type": "object",
1095
1095
  "additionalProperties": true
1096
+ },
1097
+ "attributes": {
1098
+ "type": "object",
1099
+ "additionalProperties": {
1100
+ "type": "string",
1101
+ "maxLength": 200
1102
+ },
1103
+ "description": "Optional attributes"
1096
1104
  }
1097
1105
  },
1098
1106
  "required": [
@@ -1818,6 +1826,14 @@ export const state = {
1818
1826
  "schema": {
1819
1827
  "type": "object",
1820
1828
  "additionalProperties": true
1829
+ },
1830
+ "attributes": {
1831
+ "type": "object",
1832
+ "additionalProperties": {
1833
+ "type": "string",
1834
+ "maxLength": 200
1835
+ },
1836
+ "description": "Optional attributes"
1821
1837
  }
1822
1838
  },
1823
1839
  "required": [
@@ -2338,6 +2354,14 @@ export const state = {
2338
2354
  "schema": {
2339
2355
  "type": "object",
2340
2356
  "additionalProperties": true
2357
+ },
2358
+ "attributes": {
2359
+ "type": "object",
2360
+ "additionalProperties": {
2361
+ "type": "string",
2362
+ "maxLength": 200
2363
+ },
2364
+ "description": "Optional attributes"
2341
2365
  }
2342
2366
  },
2343
2367
  "required": [
@@ -2720,6 +2744,14 @@ export const state = {
2720
2744
  "schema": {
2721
2745
  "type": "object",
2722
2746
  "additionalProperties": true
2747
+ },
2748
+ "attributes": {
2749
+ "type": "object",
2750
+ "additionalProperties": {
2751
+ "type": "string",
2752
+ "maxLength": 200
2753
+ },
2754
+ "description": "Optional attributes"
2723
2755
  }
2724
2756
  },
2725
2757
  "required": [
@@ -3076,6 +3108,14 @@ export const state = {
3076
3108
  "schema": {
3077
3109
  "type": "object",
3078
3110
  "additionalProperties": true
3111
+ },
3112
+ "attributes": {
3113
+ "type": "object",
3114
+ "additionalProperties": {
3115
+ "type": "string",
3116
+ "maxLength": 200
3117
+ },
3118
+ "description": "Optional attributes"
3079
3119
  }
3080
3120
  },
3081
3121
  "required": [
@@ -3525,12 +3565,20 @@ export const state = {
3525
3565
  "schema": {
3526
3566
  "type": "object",
3527
3567
  "additionalProperties": true
3568
+ },
3569
+ "attributes": {
3570
+ "type": "object",
3571
+ "additionalProperties": {
3572
+ "type": "string",
3573
+ "maxLength": 200,
3574
+ "nullable": true
3575
+ },
3576
+ "description": "Optional attributes. Set attributes to null to remove them"
3528
3577
  }
3529
3578
  },
3530
3579
  "required": [
3531
3580
  "schema"
3532
3581
  ],
3533
- "description": "Event Definition",
3534
3582
  "nullable": true,
3535
3583
  "additionalProperties": false
3536
3584
  }
@@ -3586,16 +3634,16 @@ export const state = {
3586
3634
  "type": "object",
3587
3635
  "additionalProperties": {
3588
3636
  "type": "string",
3589
- "maxLength": 200
3637
+ "maxLength": 200,
3638
+ "nullable": true
3590
3639
  },
3591
- "description": "Optional attributes"
3640
+ "description": "Optional attributes. Set attributes to null to remove them"
3592
3641
  }
3593
3642
  },
3594
3643
  "required": [
3595
3644
  "input",
3596
3645
  "output"
3597
3646
  ],
3598
- "description": "Action definition",
3599
3647
  "nullable": true,
3600
3648
  "additionalProperties": false
3601
3649
  }
@@ -7222,6 +7270,14 @@ export const state = {
7222
7270
  "schema": {
7223
7271
  "type": "object",
7224
7272
  "additionalProperties": true
7273
+ },
7274
+ "attributes": {
7275
+ "type": "object",
7276
+ "additionalProperties": {
7277
+ "type": "string",
7278
+ "maxLength": 200
7279
+ },
7280
+ "description": "Optional attributes"
7225
7281
  }
7226
7282
  },
7227
7283
  "required": [
@@ -7796,6 +7852,14 @@ export const state = {
7796
7852
  "schema": {
7797
7853
  "type": "object",
7798
7854
  "additionalProperties": true
7855
+ },
7856
+ "attributes": {
7857
+ "type": "object",
7858
+ "additionalProperties": {
7859
+ "type": "string",
7860
+ "maxLength": 200
7861
+ },
7862
+ "description": "Optional attributes"
7799
7863
  }
7800
7864
  },
7801
7865
  "required": [
@@ -8529,12 +8593,20 @@ export const state = {
8529
8593
  "schema": {
8530
8594
  "type": "object",
8531
8595
  "additionalProperties": true
8596
+ },
8597
+ "attributes": {
8598
+ "type": "object",
8599
+ "additionalProperties": {
8600
+ "type": "string",
8601
+ "maxLength": 200,
8602
+ "nullable": true
8603
+ },
8604
+ "description": "Optional attributes. Set attributes to null to remove them"
8532
8605
  }
8533
8606
  },
8534
8607
  "required": [
8535
8608
  "schema"
8536
8609
  ],
8537
- "description": "Event Definition",
8538
8610
  "nullable": true,
8539
8611
  "additionalProperties": false
8540
8612
  }
@@ -9120,12 +9192,20 @@ export const state = {
9120
9192
  "schema": {
9121
9193
  "type": "object",
9122
9194
  "additionalProperties": true
9195
+ },
9196
+ "attributes": {
9197
+ "type": "object",
9198
+ "additionalProperties": {
9199
+ "type": "string",
9200
+ "maxLength": 200,
9201
+ "nullable": true
9202
+ },
9203
+ "description": "Optional attributes. Set attributes to null to remove them"
9123
9204
  }
9124
9205
  },
9125
9206
  "required": [
9126
9207
  "schema"
9127
9208
  ],
9128
- "description": "Event Definition",
9129
9209
  "nullable": true,
9130
9210
  "additionalProperties": false
9131
9211
  }
@@ -9927,6 +10007,14 @@ export const state = {
9927
10007
  "schema": {
9928
10008
  "type": "object",
9929
10009
  "additionalProperties": true
10010
+ },
10011
+ "attributes": {
10012
+ "type": "object",
10013
+ "additionalProperties": {
10014
+ "type": "string",
10015
+ "maxLength": 200
10016
+ },
10017
+ "description": "Optional attributes"
9930
10018
  }
9931
10019
  },
9932
10020
  "required": [
@@ -10057,6 +10145,29 @@ export const state = {
10057
10145
  ],
10058
10146
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
10059
10147
  "additionalProperties": false
10148
+ },
10149
+ "icon": {
10150
+ "type": "string",
10151
+ "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
10152
+ },
10153
+ "readme": {
10154
+ "type": "string",
10155
+ "description": "Base64 encoded markdown of the interface readme. The readme is specific to each interface versions."
10156
+ },
10157
+ "title": {
10158
+ "type": "string",
10159
+ "minLength": 1,
10160
+ "maxLength": 64,
10161
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
10162
+ },
10163
+ "description": {
10164
+ "type": "string",
10165
+ "maxLength": 256,
10166
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
10167
+ },
10168
+ "public": {
10169
+ "type": "boolean",
10170
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
10060
10171
  }
10061
10172
  },
10062
10173
  "required": [
@@ -10213,12 +10324,20 @@ export const state = {
10213
10324
  "schema": {
10214
10325
  "type": "object",
10215
10326
  "additionalProperties": true
10327
+ },
10328
+ "attributes": {
10329
+ "type": "object",
10330
+ "additionalProperties": {
10331
+ "type": "string",
10332
+ "maxLength": 200,
10333
+ "nullable": true
10334
+ },
10335
+ "description": "Optional attributes. Set attributes to null to remove them"
10216
10336
  }
10217
10337
  },
10218
10338
  "required": [
10219
10339
  "schema"
10220
10340
  ],
10221
- "description": "Event Definition",
10222
10341
  "nullable": true,
10223
10342
  "additionalProperties": false
10224
10343
  }
@@ -10276,7 +10395,8 @@ export const state = {
10276
10395
  "type": "string",
10277
10396
  "maxLength": 200,
10278
10397
  "nullable": true
10279
- }
10398
+ },
10399
+ "description": "Optional attributes. Set attributes to null to remove them"
10280
10400
  }
10281
10401
  },
10282
10402
  "required": [
@@ -10344,6 +10464,29 @@ export const state = {
10344
10464
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
10345
10465
  "nullable": true,
10346
10466
  "additionalProperties": false
10467
+ },
10468
+ "icon": {
10469
+ "type": "string",
10470
+ "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
10471
+ },
10472
+ "readme": {
10473
+ "type": "string",
10474
+ "description": "Base64 encoded markdown of the interface readme. The readme is specific to each interface versions."
10475
+ },
10476
+ "title": {
10477
+ "type": "string",
10478
+ "minLength": 1,
10479
+ "maxLength": 64,
10480
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
10481
+ },
10482
+ "description": {
10483
+ "type": "string",
10484
+ "maxLength": 256,
10485
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
10486
+ },
10487
+ "public": {
10488
+ "type": "boolean",
10489
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
10347
10490
  }
10348
10491
  },
10349
10492
  "title": "updateInterfaceBody",
@@ -10443,6 +10586,29 @@ export const state = {
10443
10586
  "type": "string",
10444
10587
  "maxLength": 200,
10445
10588
  "description": "Version of the [Interface](#schema_interface)"
10589
+ },
10590
+ "title": {
10591
+ "type": "string",
10592
+ "minLength": 1,
10593
+ "maxLength": 64,
10594
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
10595
+ },
10596
+ "description": {
10597
+ "type": "string",
10598
+ "maxLength": 256,
10599
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
10600
+ },
10601
+ "iconUrl": {
10602
+ "type": "string",
10603
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
10604
+ },
10605
+ "readmeUrl": {
10606
+ "type": "string",
10607
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
10608
+ },
10609
+ "public": {
10610
+ "type": "boolean",
10611
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
10446
10612
  }
10447
10613
  },
10448
10614
  "required": [
@@ -10450,7 +10616,12 @@ export const state = {
10450
10616
  "createdAt",
10451
10617
  "updatedAt",
10452
10618
  "name",
10453
- "version"
10619
+ "version",
10620
+ "title",
10621
+ "description",
10622
+ "iconUrl",
10623
+ "readmeUrl",
10624
+ "public"
10454
10625
  ]
10455
10626
  }
10456
10627
  },
@@ -10571,6 +10742,14 @@ export const state = {
10571
10742
  "schema": {
10572
10743
  "type": "object",
10573
10744
  "additionalProperties": true
10745
+ },
10746
+ "attributes": {
10747
+ "type": "object",
10748
+ "additionalProperties": {
10749
+ "type": "string",
10750
+ "maxLength": 200
10751
+ },
10752
+ "description": "Optional attributes"
10574
10753
  }
10575
10754
  },
10576
10755
  "required": [
@@ -10969,12 +11148,20 @@ export const state = {
10969
11148
  "schema": {
10970
11149
  "type": "object",
10971
11150
  "additionalProperties": true
11151
+ },
11152
+ "attributes": {
11153
+ "type": "object",
11154
+ "additionalProperties": {
11155
+ "type": "string",
11156
+ "maxLength": 200,
11157
+ "nullable": true
11158
+ },
11159
+ "description": "Optional attributes. Set attributes to null to remove them"
10972
11160
  }
10973
11161
  },
10974
11162
  "required": [
10975
11163
  "schema"
10976
11164
  ],
10977
- "description": "Event Definition",
10978
11165
  "nullable": true,
10979
11166
  "additionalProperties": false
10980
11167
  }
@@ -11030,16 +11217,16 @@ export const state = {
11030
11217
  "type": "object",
11031
11218
  "additionalProperties": {
11032
11219
  "type": "string",
11033
- "maxLength": 200
11220
+ "maxLength": 200,
11221
+ "nullable": true
11034
11222
  },
11035
- "description": "Optional attributes"
11223
+ "description": "Optional attributes. Set attributes to null to remove them"
11036
11224
  }
11037
11225
  },
11038
11226
  "required": [
11039
11227
  "input",
11040
11228
  "output"
11041
11229
  ],
11042
- "description": "Action definition",
11043
11230
  "nullable": true,
11044
11231
  "additionalProperties": false
11045
11232
  }
@@ -11877,7 +12064,7 @@ export const state = {
11877
12064
  "title": "Botpress API",
11878
12065
  "description": "API for Botpress Cloud",
11879
12066
  "server": "https://api.botpress.cloud",
11880
- "version": "1.8.0",
12067
+ "version": "1.10.0",
11881
12068
  "prefix": "v1"
11882
12069
  },
11883
12070
  "errors": [
@@ -12471,6 +12658,14 @@ export const state = {
12471
12658
  "schema": {
12472
12659
  "type": "object",
12473
12660
  "additionalProperties": true
12661
+ },
12662
+ "attributes": {
12663
+ "type": "object",
12664
+ "additionalProperties": {
12665
+ "type": "string",
12666
+ "maxLength": 200
12667
+ },
12668
+ "description": "Optional attributes"
12474
12669
  }
12475
12670
  },
12476
12671
  "required": [
@@ -13123,6 +13318,14 @@ export const state = {
13123
13318
  "schema": {
13124
13319
  "type": "object",
13125
13320
  "additionalProperties": true
13321
+ },
13322
+ "attributes": {
13323
+ "type": "object",
13324
+ "additionalProperties": {
13325
+ "type": "string",
13326
+ "maxLength": 200
13327
+ },
13328
+ "description": "Optional attributes"
13126
13329
  }
13127
13330
  },
13128
13331
  "required": [
@@ -13426,6 +13629,14 @@ export const state = {
13426
13629
  "schema": {
13427
13630
  "type": "object",
13428
13631
  "additionalProperties": true
13632
+ },
13633
+ "attributes": {
13634
+ "type": "object",
13635
+ "additionalProperties": {
13636
+ "type": "string",
13637
+ "maxLength": 200
13638
+ },
13639
+ "description": "Optional attributes"
13429
13640
  }
13430
13641
  },
13431
13642
  "required": [
@@ -13556,6 +13767,29 @@ export const state = {
13556
13767
  ],
13557
13768
  "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
13558
13769
  "additionalProperties": false
13770
+ },
13771
+ "title": {
13772
+ "type": "string",
13773
+ "minLength": 1,
13774
+ "maxLength": 64,
13775
+ "description": "Title of the interface. This is the name that will be displayed in the UI"
13776
+ },
13777
+ "description": {
13778
+ "type": "string",
13779
+ "maxLength": 256,
13780
+ "description": "Description of the interface. This is the description that will be displayed in the UI"
13781
+ },
13782
+ "iconUrl": {
13783
+ "type": "string",
13784
+ "description": "URL of the icon of the interface. This is the icon that will be displayed in the UI"
13785
+ },
13786
+ "readmeUrl": {
13787
+ "type": "string",
13788
+ "description": "URL of the readme of the interface. This is the readme that will be displayed in the UI"
13789
+ },
13790
+ "public": {
13791
+ "type": "boolean",
13792
+ "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version."
13559
13793
  }
13560
13794
  },
13561
13795
  "required": [
@@ -13567,7 +13801,12 @@ export const state = {
13567
13801
  "entities",
13568
13802
  "events",
13569
13803
  "actions",
13570
- "channels"
13804
+ "channels",
13805
+ "title",
13806
+ "description",
13807
+ "iconUrl",
13808
+ "readmeUrl",
13809
+ "public"
13571
13810
  ],
13572
13811
  "additionalProperties": false
13573
13812
  }
@@ -13679,6 +13918,14 @@ export const state = {
13679
13918
  "schema": {
13680
13919
  "type": "object",
13681
13920
  "additionalProperties": true
13921
+ },
13922
+ "attributes": {
13923
+ "type": "object",
13924
+ "additionalProperties": {
13925
+ "type": "string",
13926
+ "maxLength": 200
13927
+ },
13928
+ "description": "Optional attributes"
13682
13929
  }
13683
13930
  },
13684
13931
  "required": [