@botpress/api 0.43.2 → 0.44.1

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 (5) hide show
  1. package/dist/index.js +337 -45
  2. package/dist/src/gen/state.d.ts +268 -13
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +337 -45
package/src/gen/state.ts CHANGED
@@ -3089,7 +3089,8 @@ export const state = {
3089
3089
  "id": {
3090
3090
  "type": "string",
3091
3091
  "minLength": 28,
3092
- "maxLength": 36
3092
+ "maxLength": 36,
3093
+ "description": "ID of the interface"
3093
3094
  },
3094
3095
  "name": {
3095
3096
  "type": "string",
@@ -3143,6 +3144,22 @@ export const state = {
3143
3144
  ],
3144
3145
  "additionalProperties": false
3145
3146
  }
3147
+ },
3148
+ "channels": {
3149
+ "type": "object",
3150
+ "additionalProperties": {
3151
+ "type": "object",
3152
+ "properties": {
3153
+ "name": {
3154
+ "type": "string",
3155
+ "maxLength": 200
3156
+ }
3157
+ },
3158
+ "required": [
3159
+ "name"
3160
+ ],
3161
+ "additionalProperties": false
3162
+ }
3146
3163
  }
3147
3164
  },
3148
3165
  "required": [
@@ -3150,7 +3167,8 @@ export const state = {
3150
3167
  "name",
3151
3168
  "entities",
3152
3169
  "actions",
3153
- "events"
3170
+ "events",
3171
+ "channels"
3154
3172
  ],
3155
3173
  "additionalProperties": false
3156
3174
  }
@@ -3747,7 +3765,8 @@ export const state = {
3747
3765
  "id": {
3748
3766
  "type": "string",
3749
3767
  "minLength": 28,
3750
- "maxLength": 36
3768
+ "maxLength": 36,
3769
+ "description": "ID of the interface"
3751
3770
  },
3752
3771
  "name": {
3753
3772
  "type": "string",
@@ -3801,6 +3820,22 @@ export const state = {
3801
3820
  ],
3802
3821
  "additionalProperties": false
3803
3822
  }
3823
+ },
3824
+ "channels": {
3825
+ "type": "object",
3826
+ "additionalProperties": {
3827
+ "type": "object",
3828
+ "properties": {
3829
+ "name": {
3830
+ "type": "string",
3831
+ "maxLength": 200
3832
+ }
3833
+ },
3834
+ "required": [
3835
+ "name"
3836
+ ],
3837
+ "additionalProperties": false
3838
+ }
3804
3839
  }
3805
3840
  },
3806
3841
  "required": [
@@ -3808,7 +3843,8 @@ export const state = {
3808
3843
  "name",
3809
3844
  "entities",
3810
3845
  "actions",
3811
- "events"
3846
+ "events",
3847
+ "channels"
3812
3848
  ],
3813
3849
  "additionalProperties": false
3814
3850
  }
@@ -8389,7 +8425,8 @@ export const state = {
8389
8425
  "id": {
8390
8426
  "type": "string",
8391
8427
  "minLength": 28,
8392
- "maxLength": 36
8428
+ "maxLength": 36,
8429
+ "description": "ID of the interface"
8393
8430
  },
8394
8431
  "entities": {
8395
8432
  "type": "object",
@@ -8438,13 +8475,26 @@ export const state = {
8438
8475
  ],
8439
8476
  "additionalProperties": false
8440
8477
  }
8478
+ },
8479
+ "channels": {
8480
+ "type": "object",
8481
+ "additionalProperties": {
8482
+ "type": "object",
8483
+ "properties": {
8484
+ "name": {
8485
+ "type": "string",
8486
+ "maxLength": 200
8487
+ }
8488
+ },
8489
+ "required": [
8490
+ "name"
8491
+ ],
8492
+ "additionalProperties": false
8493
+ }
8441
8494
  }
8442
8495
  },
8443
8496
  "required": [
8444
- "id",
8445
- "entities",
8446
- "actions",
8447
- "events"
8497
+ "id"
8448
8498
  ],
8449
8499
  "additionalProperties": false
8450
8500
  }
@@ -8941,7 +8991,8 @@ export const state = {
8941
8991
  "id": {
8942
8992
  "type": "string",
8943
8993
  "minLength": 28,
8944
- "maxLength": 36
8994
+ "maxLength": 36,
8995
+ "description": "ID of the interface"
8945
8996
  },
8946
8997
  "entities": {
8947
8998
  "type": "object",
@@ -8990,13 +9041,26 @@ export const state = {
8990
9041
  ],
8991
9042
  "additionalProperties": false
8992
9043
  }
9044
+ },
9045
+ "channels": {
9046
+ "type": "object",
9047
+ "additionalProperties": {
9048
+ "type": "object",
9049
+ "properties": {
9050
+ "name": {
9051
+ "type": "string",
9052
+ "maxLength": 200
9053
+ }
9054
+ },
9055
+ "required": [
9056
+ "name"
9057
+ ],
9058
+ "additionalProperties": false
9059
+ }
8993
9060
  }
8994
9061
  },
8995
9062
  "required": [
8996
- "id",
8997
- "entities",
8998
- "actions",
8999
- "events"
9063
+ "id"
9000
9064
  ],
9001
9065
  "nullable": true,
9002
9066
  "additionalProperties": false
@@ -9403,6 +9467,33 @@ export const state = {
9403
9467
  "maxLength": 200,
9404
9468
  "description": "Version of the [Interface](#schema_interface)"
9405
9469
  },
9470
+ "entities": {
9471
+ "type": "object",
9472
+ "additionalProperties": {
9473
+ "type": "object",
9474
+ "properties": {
9475
+ "title": {
9476
+ "type": "string",
9477
+ "maxLength": 64,
9478
+ "description": "Title of the entity"
9479
+ },
9480
+ "description": {
9481
+ "type": "string",
9482
+ "maxLength": 256,
9483
+ "description": "Description of the entity"
9484
+ },
9485
+ "schema": {
9486
+ "type": "object",
9487
+ "additionalProperties": true
9488
+ }
9489
+ },
9490
+ "required": [
9491
+ "schema"
9492
+ ],
9493
+ "description": "Entity definition",
9494
+ "additionalProperties": false
9495
+ }
9496
+ },
9406
9497
  "events": {
9407
9498
  "type": "object",
9408
9499
  "additionalProperties": {
@@ -9486,7 +9577,7 @@ export const state = {
9486
9577
  "additionalProperties": false
9487
9578
  }
9488
9579
  },
9489
- "entities": {
9580
+ "channels": {
9490
9581
  "type": "object",
9491
9582
  "additionalProperties": {
9492
9583
  "type": "object",
@@ -9494,22 +9585,34 @@ export const state = {
9494
9585
  "title": {
9495
9586
  "type": "string",
9496
9587
  "maxLength": 64,
9497
- "description": "Title of the entity"
9588
+ "description": "Title of the channel"
9498
9589
  },
9499
9590
  "description": {
9500
9591
  "type": "string",
9501
9592
  "maxLength": 256,
9502
- "description": "Description of the entity"
9593
+ "description": "Description of the channel"
9503
9594
  },
9504
- "schema": {
9595
+ "messages": {
9505
9596
  "type": "object",
9506
- "additionalProperties": true
9597
+ "additionalProperties": {
9598
+ "type": "object",
9599
+ "properties": {
9600
+ "schema": {
9601
+ "type": "object",
9602
+ "additionalProperties": true
9603
+ }
9604
+ },
9605
+ "required": [
9606
+ "schema"
9607
+ ],
9608
+ "description": "Message definition",
9609
+ "additionalProperties": false
9610
+ }
9507
9611
  }
9508
9612
  },
9509
9613
  "required": [
9510
- "schema"
9614
+ "messages"
9511
9615
  ],
9512
- "description": "Entity definition",
9513
9616
  "additionalProperties": false
9514
9617
  }
9515
9618
  },
@@ -9535,10 +9638,7 @@ export const state = {
9535
9638
  },
9536
9639
  "required": [
9537
9640
  "name",
9538
- "version",
9539
- "events",
9540
- "actions",
9541
- "entities"
9641
+ "version"
9542
9642
  ],
9543
9643
  "title": "createInterfaceBody",
9544
9644
  "additionalProperties": false
@@ -9644,6 +9744,34 @@ export const state = {
9644
9744
  "schema": {
9645
9745
  "type": "object",
9646
9746
  "properties": {
9747
+ "entities": {
9748
+ "type": "object",
9749
+ "additionalProperties": {
9750
+ "type": "object",
9751
+ "properties": {
9752
+ "title": {
9753
+ "type": "string",
9754
+ "maxLength": 64,
9755
+ "description": "Title of the entity"
9756
+ },
9757
+ "description": {
9758
+ "type": "string",
9759
+ "maxLength": 256,
9760
+ "description": "Description of the entity"
9761
+ },
9762
+ "schema": {
9763
+ "type": "object",
9764
+ "additionalProperties": true
9765
+ }
9766
+ },
9767
+ "required": [
9768
+ "schema"
9769
+ ],
9770
+ "description": "Entity definition",
9771
+ "nullable": true,
9772
+ "additionalProperties": false
9773
+ }
9774
+ },
9647
9775
  "events": {
9648
9776
  "type": "object",
9649
9777
  "additionalProperties": {
@@ -9729,7 +9857,7 @@ export const state = {
9729
9857
  "additionalProperties": false
9730
9858
  }
9731
9859
  },
9732
- "entities": {
9860
+ "channels": {
9733
9861
  "type": "object",
9734
9862
  "additionalProperties": {
9735
9863
  "type": "object",
@@ -9737,22 +9865,32 @@ export const state = {
9737
9865
  "title": {
9738
9866
  "type": "string",
9739
9867
  "maxLength": 64,
9740
- "description": "Title of the entity"
9868
+ "description": "Title of the channel"
9741
9869
  },
9742
9870
  "description": {
9743
9871
  "type": "string",
9744
9872
  "maxLength": 256,
9745
- "description": "Description of the entity"
9873
+ "description": "Description of the channel"
9746
9874
  },
9747
- "schema": {
9875
+ "messages": {
9748
9876
  "type": "object",
9749
- "additionalProperties": true
9877
+ "additionalProperties": {
9878
+ "type": "object",
9879
+ "properties": {
9880
+ "schema": {
9881
+ "type": "object",
9882
+ "additionalProperties": true
9883
+ }
9884
+ },
9885
+ "required": [
9886
+ "schema"
9887
+ ],
9888
+ "description": "Message definition",
9889
+ "nullable": true,
9890
+ "additionalProperties": false
9891
+ }
9750
9892
  }
9751
9893
  },
9752
- "required": [
9753
- "schema"
9754
- ],
9755
- "description": "Entity definition",
9756
9894
  "nullable": true,
9757
9895
  "additionalProperties": false
9758
9896
  }
@@ -10060,6 +10198,97 @@ export const state = {
10060
10198
  }
10061
10199
  }
10062
10200
  },
10201
+ "listUsageActivity": {
10202
+ "name": "listUsageActivity",
10203
+ "path": "/v1/admin/usages/{id}/activity",
10204
+ "method": "get",
10205
+ "description": "List the usage activity for a given usage type and ID. The most recent activity is listed first.",
10206
+ "parameters": {
10207
+ "type": {
10208
+ "in": "query",
10209
+ "description": "Usage type",
10210
+ "type": "string",
10211
+ "enum": [
10212
+ "invocation_timeout",
10213
+ "invocation_calls",
10214
+ "storage_count",
10215
+ "bot_count",
10216
+ "knowledgebase_vector_storage",
10217
+ "workspace_ratelimit",
10218
+ "table_row_count",
10219
+ "workspace_member_count",
10220
+ "integrations_owned_count",
10221
+ "ai_spend",
10222
+ "openai_spend",
10223
+ "bing_search_spend",
10224
+ "always_alive"
10225
+ ],
10226
+ "required": true
10227
+ },
10228
+ "id": {
10229
+ "type": "string",
10230
+ "description": "ID of a bot or a workspace, depending on the \"type\" parameter",
10231
+ "in": "path"
10232
+ },
10233
+ "nextToken": {
10234
+ "in": "query",
10235
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
10236
+ "type": "string"
10237
+ }
10238
+ },
10239
+ "response": {
10240
+ "description": "Success",
10241
+ "schema": {
10242
+ "type": "object",
10243
+ "properties": {
10244
+ "data": {
10245
+ "type": "array",
10246
+ "items": {
10247
+ "type": "object",
10248
+ "properties": {
10249
+ "timestamp": {
10250
+ "type": "string"
10251
+ },
10252
+ "value": {
10253
+ "type": "number"
10254
+ },
10255
+ "period": {
10256
+ "type": "string"
10257
+ },
10258
+ "metadata": {
10259
+ "type": "object",
10260
+ "additionalProperties": {
10261
+ "nullable": true
10262
+ }
10263
+ }
10264
+ },
10265
+ "required": [
10266
+ "timestamp",
10267
+ "value",
10268
+ "period",
10269
+ "metadata"
10270
+ ]
10271
+ }
10272
+ },
10273
+ "meta": {
10274
+ "type": "object",
10275
+ "properties": {
10276
+ "nextToken": {
10277
+ "type": "string"
10278
+ }
10279
+ },
10280
+ "additionalProperties": false
10281
+ }
10282
+ },
10283
+ "required": [
10284
+ "data",
10285
+ "meta"
10286
+ ],
10287
+ "title": "listUsageActivityResponse",
10288
+ "additionalProperties": false
10289
+ }
10290
+ }
10291
+ },
10063
10292
  "changeAISpendQuota": {
10064
10293
  "name": "changeAISpendQuota",
10065
10294
  "path": "/v1/admin/quotas/ai-spend",
@@ -12000,7 +12229,7 @@ export const state = {
12000
12229
  "title": "Botpress API",
12001
12230
  "description": "API for Botpress Cloud",
12002
12231
  "server": "https://api.botpress.cloud",
12003
- "version": "0.43.2",
12232
+ "version": "0.44.1",
12004
12233
  "prefix": "v1"
12005
12234
  },
12006
12235
  "errors": [
@@ -12304,6 +12533,7 @@ export const state = {
12304
12533
  "getUsageResponse": true,
12305
12534
  "getMultipleUsagesResponse": true,
12306
12535
  "listUsageHistoryResponse": true,
12536
+ "listUsageActivityResponse": true,
12307
12537
  "changeAISpendQuotaResponse": true,
12308
12538
  "listActivitiesResponse": true,
12309
12539
  "introspectResponse": true,
@@ -12938,7 +13168,8 @@ export const state = {
12938
13168
  "id": {
12939
13169
  "type": "string",
12940
13170
  "minLength": 28,
12941
- "maxLength": 36
13171
+ "maxLength": 36,
13172
+ "description": "ID of the interface"
12942
13173
  },
12943
13174
  "name": {
12944
13175
  "type": "string",
@@ -12992,6 +13223,22 @@ export const state = {
12992
13223
  ],
12993
13224
  "additionalProperties": false
12994
13225
  }
13226
+ },
13227
+ "channels": {
13228
+ "type": "object",
13229
+ "additionalProperties": {
13230
+ "type": "object",
13231
+ "properties": {
13232
+ "name": {
13233
+ "type": "string",
13234
+ "maxLength": 200
13235
+ }
13236
+ },
13237
+ "required": [
13238
+ "name"
13239
+ ],
13240
+ "additionalProperties": false
13241
+ }
12995
13242
  }
12996
13243
  },
12997
13244
  "required": [
@@ -12999,7 +13246,8 @@ export const state = {
12999
13246
  "name",
13000
13247
  "entities",
13001
13248
  "actions",
13002
- "events"
13249
+ "events",
13250
+ "channels"
13003
13251
  ],
13004
13252
  "additionalProperties": false
13005
13253
  }
@@ -13512,6 +13760,33 @@ export const state = {
13512
13760
  "maxLength": 200,
13513
13761
  "description": "Version of the [Interface](#schema_interface)"
13514
13762
  },
13763
+ "entities": {
13764
+ "type": "object",
13765
+ "additionalProperties": {
13766
+ "type": "object",
13767
+ "properties": {
13768
+ "title": {
13769
+ "type": "string",
13770
+ "maxLength": 64,
13771
+ "description": "Title of the entity"
13772
+ },
13773
+ "description": {
13774
+ "type": "string",
13775
+ "maxLength": 256,
13776
+ "description": "Description of the entity"
13777
+ },
13778
+ "schema": {
13779
+ "type": "object",
13780
+ "additionalProperties": true
13781
+ }
13782
+ },
13783
+ "required": [
13784
+ "schema"
13785
+ ],
13786
+ "description": "Entity definition",
13787
+ "additionalProperties": false
13788
+ }
13789
+ },
13515
13790
  "events": {
13516
13791
  "type": "object",
13517
13792
  "additionalProperties": {
@@ -13595,7 +13870,7 @@ export const state = {
13595
13870
  "additionalProperties": false
13596
13871
  }
13597
13872
  },
13598
- "entities": {
13873
+ "channels": {
13599
13874
  "type": "object",
13600
13875
  "additionalProperties": {
13601
13876
  "type": "object",
@@ -13603,22 +13878,34 @@ export const state = {
13603
13878
  "title": {
13604
13879
  "type": "string",
13605
13880
  "maxLength": 64,
13606
- "description": "Title of the entity"
13881
+ "description": "Title of the channel"
13607
13882
  },
13608
13883
  "description": {
13609
13884
  "type": "string",
13610
13885
  "maxLength": 256,
13611
- "description": "Description of the entity"
13886
+ "description": "Description of the channel"
13612
13887
  },
13613
- "schema": {
13888
+ "messages": {
13614
13889
  "type": "object",
13615
- "additionalProperties": true
13890
+ "additionalProperties": {
13891
+ "type": "object",
13892
+ "properties": {
13893
+ "schema": {
13894
+ "type": "object",
13895
+ "additionalProperties": true
13896
+ }
13897
+ },
13898
+ "required": [
13899
+ "schema"
13900
+ ],
13901
+ "description": "Message definition",
13902
+ "additionalProperties": false
13903
+ }
13616
13904
  }
13617
13905
  },
13618
13906
  "required": [
13619
- "schema"
13907
+ "messages"
13620
13908
  ],
13621
- "description": "Entity definition",
13622
13909
  "additionalProperties": false
13623
13910
  }
13624
13911
  },
@@ -13648,9 +13935,10 @@ export const state = {
13648
13935
  "updatedAt",
13649
13936
  "name",
13650
13937
  "version",
13938
+ "entities",
13651
13939
  "events",
13652
13940
  "actions",
13653
- "entities"
13941
+ "channels"
13654
13942
  ],
13655
13943
  "additionalProperties": false
13656
13944
  }
@@ -14743,6 +15031,10 @@ export const state = {
14743
15031
  "type": "number",
14744
15032
  "description": "Width of the column in the UI"
14745
15033
  },
15034
+ "schemaId": {
15035
+ "type": "string",
15036
+ "description": "ID of the schema"
15037
+ },
14746
15038
  "computed": {
14747
15039
  "type": "object",
14748
15040
  "properties": {