@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/dist/index.js CHANGED
@@ -285720,7 +285720,8 @@ var state = {
285720
285720
  "id": {
285721
285721
  "type": "string",
285722
285722
  "minLength": 28,
285723
- "maxLength": 36
285723
+ "maxLength": 36,
285724
+ "description": "ID of the interface"
285724
285725
  },
285725
285726
  "name": {
285726
285727
  "type": "string",
@@ -285774,6 +285775,22 @@ var state = {
285774
285775
  ],
285775
285776
  "additionalProperties": false
285776
285777
  }
285778
+ },
285779
+ "channels": {
285780
+ "type": "object",
285781
+ "additionalProperties": {
285782
+ "type": "object",
285783
+ "properties": {
285784
+ "name": {
285785
+ "type": "string",
285786
+ "maxLength": 200
285787
+ }
285788
+ },
285789
+ "required": [
285790
+ "name"
285791
+ ],
285792
+ "additionalProperties": false
285793
+ }
285777
285794
  }
285778
285795
  },
285779
285796
  "required": [
@@ -285781,7 +285798,8 @@ var state = {
285781
285798
  "name",
285782
285799
  "entities",
285783
285800
  "actions",
285784
- "events"
285801
+ "events",
285802
+ "channels"
285785
285803
  ],
285786
285804
  "additionalProperties": false
285787
285805
  }
@@ -286378,7 +286396,8 @@ var state = {
286378
286396
  "id": {
286379
286397
  "type": "string",
286380
286398
  "minLength": 28,
286381
- "maxLength": 36
286399
+ "maxLength": 36,
286400
+ "description": "ID of the interface"
286382
286401
  },
286383
286402
  "name": {
286384
286403
  "type": "string",
@@ -286432,6 +286451,22 @@ var state = {
286432
286451
  ],
286433
286452
  "additionalProperties": false
286434
286453
  }
286454
+ },
286455
+ "channels": {
286456
+ "type": "object",
286457
+ "additionalProperties": {
286458
+ "type": "object",
286459
+ "properties": {
286460
+ "name": {
286461
+ "type": "string",
286462
+ "maxLength": 200
286463
+ }
286464
+ },
286465
+ "required": [
286466
+ "name"
286467
+ ],
286468
+ "additionalProperties": false
286469
+ }
286435
286470
  }
286436
286471
  },
286437
286472
  "required": [
@@ -286439,7 +286474,8 @@ var state = {
286439
286474
  "name",
286440
286475
  "entities",
286441
286476
  "actions",
286442
- "events"
286477
+ "events",
286478
+ "channels"
286443
286479
  ],
286444
286480
  "additionalProperties": false
286445
286481
  }
@@ -291020,7 +291056,8 @@ var state = {
291020
291056
  "id": {
291021
291057
  "type": "string",
291022
291058
  "minLength": 28,
291023
- "maxLength": 36
291059
+ "maxLength": 36,
291060
+ "description": "ID of the interface"
291024
291061
  },
291025
291062
  "entities": {
291026
291063
  "type": "object",
@@ -291069,13 +291106,26 @@ var state = {
291069
291106
  ],
291070
291107
  "additionalProperties": false
291071
291108
  }
291109
+ },
291110
+ "channels": {
291111
+ "type": "object",
291112
+ "additionalProperties": {
291113
+ "type": "object",
291114
+ "properties": {
291115
+ "name": {
291116
+ "type": "string",
291117
+ "maxLength": 200
291118
+ }
291119
+ },
291120
+ "required": [
291121
+ "name"
291122
+ ],
291123
+ "additionalProperties": false
291124
+ }
291072
291125
  }
291073
291126
  },
291074
291127
  "required": [
291075
- "id",
291076
- "entities",
291077
- "actions",
291078
- "events"
291128
+ "id"
291079
291129
  ],
291080
291130
  "additionalProperties": false
291081
291131
  }
@@ -291572,7 +291622,8 @@ var state = {
291572
291622
  "id": {
291573
291623
  "type": "string",
291574
291624
  "minLength": 28,
291575
- "maxLength": 36
291625
+ "maxLength": 36,
291626
+ "description": "ID of the interface"
291576
291627
  },
291577
291628
  "entities": {
291578
291629
  "type": "object",
@@ -291621,13 +291672,26 @@ var state = {
291621
291672
  ],
291622
291673
  "additionalProperties": false
291623
291674
  }
291675
+ },
291676
+ "channels": {
291677
+ "type": "object",
291678
+ "additionalProperties": {
291679
+ "type": "object",
291680
+ "properties": {
291681
+ "name": {
291682
+ "type": "string",
291683
+ "maxLength": 200
291684
+ }
291685
+ },
291686
+ "required": [
291687
+ "name"
291688
+ ],
291689
+ "additionalProperties": false
291690
+ }
291624
291691
  }
291625
291692
  },
291626
291693
  "required": [
291627
- "id",
291628
- "entities",
291629
- "actions",
291630
- "events"
291694
+ "id"
291631
291695
  ],
291632
291696
  "nullable": true,
291633
291697
  "additionalProperties": false
@@ -292034,6 +292098,33 @@ var state = {
292034
292098
  "maxLength": 200,
292035
292099
  "description": "Version of the [Interface](#schema_interface)"
292036
292100
  },
292101
+ "entities": {
292102
+ "type": "object",
292103
+ "additionalProperties": {
292104
+ "type": "object",
292105
+ "properties": {
292106
+ "title": {
292107
+ "type": "string",
292108
+ "maxLength": 64,
292109
+ "description": "Title of the entity"
292110
+ },
292111
+ "description": {
292112
+ "type": "string",
292113
+ "maxLength": 256,
292114
+ "description": "Description of the entity"
292115
+ },
292116
+ "schema": {
292117
+ "type": "object",
292118
+ "additionalProperties": true
292119
+ }
292120
+ },
292121
+ "required": [
292122
+ "schema"
292123
+ ],
292124
+ "description": "Entity definition",
292125
+ "additionalProperties": false
292126
+ }
292127
+ },
292037
292128
  "events": {
292038
292129
  "type": "object",
292039
292130
  "additionalProperties": {
@@ -292117,7 +292208,7 @@ var state = {
292117
292208
  "additionalProperties": false
292118
292209
  }
292119
292210
  },
292120
- "entities": {
292211
+ "channels": {
292121
292212
  "type": "object",
292122
292213
  "additionalProperties": {
292123
292214
  "type": "object",
@@ -292125,22 +292216,34 @@ var state = {
292125
292216
  "title": {
292126
292217
  "type": "string",
292127
292218
  "maxLength": 64,
292128
- "description": "Title of the entity"
292219
+ "description": "Title of the channel"
292129
292220
  },
292130
292221
  "description": {
292131
292222
  "type": "string",
292132
292223
  "maxLength": 256,
292133
- "description": "Description of the entity"
292224
+ "description": "Description of the channel"
292134
292225
  },
292135
- "schema": {
292226
+ "messages": {
292136
292227
  "type": "object",
292137
- "additionalProperties": true
292228
+ "additionalProperties": {
292229
+ "type": "object",
292230
+ "properties": {
292231
+ "schema": {
292232
+ "type": "object",
292233
+ "additionalProperties": true
292234
+ }
292235
+ },
292236
+ "required": [
292237
+ "schema"
292238
+ ],
292239
+ "description": "Message definition",
292240
+ "additionalProperties": false
292241
+ }
292138
292242
  }
292139
292243
  },
292140
292244
  "required": [
292141
- "schema"
292245
+ "messages"
292142
292246
  ],
292143
- "description": "Entity definition",
292144
292247
  "additionalProperties": false
292145
292248
  }
292146
292249
  },
@@ -292166,10 +292269,7 @@ var state = {
292166
292269
  },
292167
292270
  "required": [
292168
292271
  "name",
292169
- "version",
292170
- "events",
292171
- "actions",
292172
- "entities"
292272
+ "version"
292173
292273
  ],
292174
292274
  "title": "createInterfaceBody",
292175
292275
  "additionalProperties": false
@@ -292275,6 +292375,34 @@ var state = {
292275
292375
  "schema": {
292276
292376
  "type": "object",
292277
292377
  "properties": {
292378
+ "entities": {
292379
+ "type": "object",
292380
+ "additionalProperties": {
292381
+ "type": "object",
292382
+ "properties": {
292383
+ "title": {
292384
+ "type": "string",
292385
+ "maxLength": 64,
292386
+ "description": "Title of the entity"
292387
+ },
292388
+ "description": {
292389
+ "type": "string",
292390
+ "maxLength": 256,
292391
+ "description": "Description of the entity"
292392
+ },
292393
+ "schema": {
292394
+ "type": "object",
292395
+ "additionalProperties": true
292396
+ }
292397
+ },
292398
+ "required": [
292399
+ "schema"
292400
+ ],
292401
+ "description": "Entity definition",
292402
+ "nullable": true,
292403
+ "additionalProperties": false
292404
+ }
292405
+ },
292278
292406
  "events": {
292279
292407
  "type": "object",
292280
292408
  "additionalProperties": {
@@ -292360,7 +292488,7 @@ var state = {
292360
292488
  "additionalProperties": false
292361
292489
  }
292362
292490
  },
292363
- "entities": {
292491
+ "channels": {
292364
292492
  "type": "object",
292365
292493
  "additionalProperties": {
292366
292494
  "type": "object",
@@ -292368,22 +292496,32 @@ var state = {
292368
292496
  "title": {
292369
292497
  "type": "string",
292370
292498
  "maxLength": 64,
292371
- "description": "Title of the entity"
292499
+ "description": "Title of the channel"
292372
292500
  },
292373
292501
  "description": {
292374
292502
  "type": "string",
292375
292503
  "maxLength": 256,
292376
- "description": "Description of the entity"
292504
+ "description": "Description of the channel"
292377
292505
  },
292378
- "schema": {
292506
+ "messages": {
292379
292507
  "type": "object",
292380
- "additionalProperties": true
292508
+ "additionalProperties": {
292509
+ "type": "object",
292510
+ "properties": {
292511
+ "schema": {
292512
+ "type": "object",
292513
+ "additionalProperties": true
292514
+ }
292515
+ },
292516
+ "required": [
292517
+ "schema"
292518
+ ],
292519
+ "description": "Message definition",
292520
+ "nullable": true,
292521
+ "additionalProperties": false
292522
+ }
292381
292523
  }
292382
292524
  },
292383
- "required": [
292384
- "schema"
292385
- ],
292386
- "description": "Entity definition",
292387
292525
  "nullable": true,
292388
292526
  "additionalProperties": false
292389
292527
  }
@@ -292691,6 +292829,97 @@ var state = {
292691
292829
  }
292692
292830
  }
292693
292831
  },
292832
+ "listUsageActivity": {
292833
+ "name": "listUsageActivity",
292834
+ "path": "/v1/admin/usages/{id}/activity",
292835
+ "method": "get",
292836
+ "description": "List the usage activity for a given usage type and ID. The most recent activity is listed first.",
292837
+ "parameters": {
292838
+ "type": {
292839
+ "in": "query",
292840
+ "description": "Usage type",
292841
+ "type": "string",
292842
+ "enum": [
292843
+ "invocation_timeout",
292844
+ "invocation_calls",
292845
+ "storage_count",
292846
+ "bot_count",
292847
+ "knowledgebase_vector_storage",
292848
+ "workspace_ratelimit",
292849
+ "table_row_count",
292850
+ "workspace_member_count",
292851
+ "integrations_owned_count",
292852
+ "ai_spend",
292853
+ "openai_spend",
292854
+ "bing_search_spend",
292855
+ "always_alive"
292856
+ ],
292857
+ "required": true
292858
+ },
292859
+ "id": {
292860
+ "type": "string",
292861
+ "description": 'ID of a bot or a workspace, depending on the "type" parameter',
292862
+ "in": "path"
292863
+ },
292864
+ "nextToken": {
292865
+ "in": "query",
292866
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
292867
+ "type": "string"
292868
+ }
292869
+ },
292870
+ "response": {
292871
+ "description": "Success",
292872
+ "schema": {
292873
+ "type": "object",
292874
+ "properties": {
292875
+ "data": {
292876
+ "type": "array",
292877
+ "items": {
292878
+ "type": "object",
292879
+ "properties": {
292880
+ "timestamp": {
292881
+ "type": "string"
292882
+ },
292883
+ "value": {
292884
+ "type": "number"
292885
+ },
292886
+ "period": {
292887
+ "type": "string"
292888
+ },
292889
+ "metadata": {
292890
+ "type": "object",
292891
+ "additionalProperties": {
292892
+ "nullable": true
292893
+ }
292894
+ }
292895
+ },
292896
+ "required": [
292897
+ "timestamp",
292898
+ "value",
292899
+ "period",
292900
+ "metadata"
292901
+ ]
292902
+ }
292903
+ },
292904
+ "meta": {
292905
+ "type": "object",
292906
+ "properties": {
292907
+ "nextToken": {
292908
+ "type": "string"
292909
+ }
292910
+ },
292911
+ "additionalProperties": false
292912
+ }
292913
+ },
292914
+ "required": [
292915
+ "data",
292916
+ "meta"
292917
+ ],
292918
+ "title": "listUsageActivityResponse",
292919
+ "additionalProperties": false
292920
+ }
292921
+ }
292922
+ },
292694
292923
  "changeAISpendQuota": {
292695
292924
  "name": "changeAISpendQuota",
292696
292925
  "path": "/v1/admin/quotas/ai-spend",
@@ -294631,7 +294860,7 @@ var state = {
294631
294860
  "title": "Botpress API",
294632
294861
  "description": "API for Botpress Cloud",
294633
294862
  "server": "https://api.botpress.cloud",
294634
- "version": "0.43.2",
294863
+ "version": "0.44.1",
294635
294864
  "prefix": "v1"
294636
294865
  },
294637
294866
  "errors": [
@@ -294935,6 +295164,7 @@ var state = {
294935
295164
  "getUsageResponse": true,
294936
295165
  "getMultipleUsagesResponse": true,
294937
295166
  "listUsageHistoryResponse": true,
295167
+ "listUsageActivityResponse": true,
294938
295168
  "changeAISpendQuotaResponse": true,
294939
295169
  "listActivitiesResponse": true,
294940
295170
  "introspectResponse": true,
@@ -295569,7 +295799,8 @@ var state = {
295569
295799
  "id": {
295570
295800
  "type": "string",
295571
295801
  "minLength": 28,
295572
- "maxLength": 36
295802
+ "maxLength": 36,
295803
+ "description": "ID of the interface"
295573
295804
  },
295574
295805
  "name": {
295575
295806
  "type": "string",
@@ -295623,6 +295854,22 @@ var state = {
295623
295854
  ],
295624
295855
  "additionalProperties": false
295625
295856
  }
295857
+ },
295858
+ "channels": {
295859
+ "type": "object",
295860
+ "additionalProperties": {
295861
+ "type": "object",
295862
+ "properties": {
295863
+ "name": {
295864
+ "type": "string",
295865
+ "maxLength": 200
295866
+ }
295867
+ },
295868
+ "required": [
295869
+ "name"
295870
+ ],
295871
+ "additionalProperties": false
295872
+ }
295626
295873
  }
295627
295874
  },
295628
295875
  "required": [
@@ -295630,7 +295877,8 @@ var state = {
295630
295877
  "name",
295631
295878
  "entities",
295632
295879
  "actions",
295633
- "events"
295880
+ "events",
295881
+ "channels"
295634
295882
  ],
295635
295883
  "additionalProperties": false
295636
295884
  }
@@ -296143,6 +296391,33 @@ var state = {
296143
296391
  "maxLength": 200,
296144
296392
  "description": "Version of the [Interface](#schema_interface)"
296145
296393
  },
296394
+ "entities": {
296395
+ "type": "object",
296396
+ "additionalProperties": {
296397
+ "type": "object",
296398
+ "properties": {
296399
+ "title": {
296400
+ "type": "string",
296401
+ "maxLength": 64,
296402
+ "description": "Title of the entity"
296403
+ },
296404
+ "description": {
296405
+ "type": "string",
296406
+ "maxLength": 256,
296407
+ "description": "Description of the entity"
296408
+ },
296409
+ "schema": {
296410
+ "type": "object",
296411
+ "additionalProperties": true
296412
+ }
296413
+ },
296414
+ "required": [
296415
+ "schema"
296416
+ ],
296417
+ "description": "Entity definition",
296418
+ "additionalProperties": false
296419
+ }
296420
+ },
296146
296421
  "events": {
296147
296422
  "type": "object",
296148
296423
  "additionalProperties": {
@@ -296226,7 +296501,7 @@ var state = {
296226
296501
  "additionalProperties": false
296227
296502
  }
296228
296503
  },
296229
- "entities": {
296504
+ "channels": {
296230
296505
  "type": "object",
296231
296506
  "additionalProperties": {
296232
296507
  "type": "object",
@@ -296234,22 +296509,34 @@ var state = {
296234
296509
  "title": {
296235
296510
  "type": "string",
296236
296511
  "maxLength": 64,
296237
- "description": "Title of the entity"
296512
+ "description": "Title of the channel"
296238
296513
  },
296239
296514
  "description": {
296240
296515
  "type": "string",
296241
296516
  "maxLength": 256,
296242
- "description": "Description of the entity"
296517
+ "description": "Description of the channel"
296243
296518
  },
296244
- "schema": {
296519
+ "messages": {
296245
296520
  "type": "object",
296246
- "additionalProperties": true
296521
+ "additionalProperties": {
296522
+ "type": "object",
296523
+ "properties": {
296524
+ "schema": {
296525
+ "type": "object",
296526
+ "additionalProperties": true
296527
+ }
296528
+ },
296529
+ "required": [
296530
+ "schema"
296531
+ ],
296532
+ "description": "Message definition",
296533
+ "additionalProperties": false
296534
+ }
296247
296535
  }
296248
296536
  },
296249
296537
  "required": [
296250
- "schema"
296538
+ "messages"
296251
296539
  ],
296252
- "description": "Entity definition",
296253
296540
  "additionalProperties": false
296254
296541
  }
296255
296542
  },
@@ -296279,9 +296566,10 @@ var state = {
296279
296566
  "updatedAt",
296280
296567
  "name",
296281
296568
  "version",
296569
+ "entities",
296282
296570
  "events",
296283
296571
  "actions",
296284
- "entities"
296572
+ "channels"
296285
296573
  ],
296286
296574
  "additionalProperties": false
296287
296575
  }
@@ -297374,6 +297662,10 @@ var state = {
297374
297662
  "type": "number",
297375
297663
  "description": "Width of the column in the UI"
297376
297664
  },
297665
+ "schemaId": {
297666
+ "type": "string",
297667
+ "description": "ID of the schema"
297668
+ },
297377
297669
  "computed": {
297378
297670
  "type": "object",
297379
297671
  "properties": {