@botpress/api 0.31.0 → 0.32.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 (7) hide show
  1. package/dist/index.js +641 -1
  2. package/dist/src/gen/state.d.ts +568 -1
  3. package/dist/src/index.d.ts +2 -2
  4. package/package.json +1 -1
  5. package/src/gen/metadata.json +1 -1
  6. package/src/gen/openapi.json +1 -1
  7. package/src/gen/state.ts +642 -2
package/dist/index.js CHANGED
@@ -273221,6 +273221,474 @@ var state = {
273221
273221
  }
273222
273222
  }
273223
273223
  },
273224
+ "createInterface": {
273225
+ "name": "createInterface",
273226
+ "description": "Create Interface",
273227
+ "method": "post",
273228
+ "path": "/v1/admin/interfaces",
273229
+ "parameters": {},
273230
+ "requestBody": {
273231
+ "description": "Interface to create",
273232
+ "schema": {
273233
+ "type": "object",
273234
+ "properties": {
273235
+ "name": {
273236
+ "type": "string",
273237
+ "maxLength": 200,
273238
+ "description": "Name of the [Interface](#schema_interface)"
273239
+ },
273240
+ "version": {
273241
+ "type": "string",
273242
+ "maxLength": 200,
273243
+ "description": "Version of the [Interface](#schema_interface)"
273244
+ },
273245
+ "events": {
273246
+ "type": "object",
273247
+ "additionalProperties": {
273248
+ "type": "object",
273249
+ "properties": {
273250
+ "title": {
273251
+ "type": "string",
273252
+ "maxLength": 64,
273253
+ "description": "Title of the event"
273254
+ },
273255
+ "description": {
273256
+ "type": "string",
273257
+ "maxLength": 256,
273258
+ "description": "Description of the event"
273259
+ },
273260
+ "schema": {
273261
+ "type": "object",
273262
+ "additionalProperties": true
273263
+ }
273264
+ },
273265
+ "required": [
273266
+ "schema"
273267
+ ],
273268
+ "description": "Event Definition",
273269
+ "additionalProperties": false
273270
+ }
273271
+ },
273272
+ "actions": {
273273
+ "type": "object",
273274
+ "additionalProperties": {
273275
+ "type": "object",
273276
+ "properties": {
273277
+ "title": {
273278
+ "type": "string",
273279
+ "maxLength": 64,
273280
+ "description": "Title of the action"
273281
+ },
273282
+ "description": {
273283
+ "type": "string",
273284
+ "maxLength": 256,
273285
+ "description": "Description of the action"
273286
+ },
273287
+ "input": {
273288
+ "type": "object",
273289
+ "properties": {
273290
+ "schema": {
273291
+ "type": "object",
273292
+ "additionalProperties": true
273293
+ }
273294
+ },
273295
+ "required": [
273296
+ "schema"
273297
+ ],
273298
+ "additionalProperties": false
273299
+ },
273300
+ "output": {
273301
+ "type": "object",
273302
+ "properties": {
273303
+ "schema": {
273304
+ "type": "object",
273305
+ "additionalProperties": true
273306
+ }
273307
+ },
273308
+ "required": [
273309
+ "schema"
273310
+ ],
273311
+ "additionalProperties": false
273312
+ }
273313
+ },
273314
+ "required": [
273315
+ "input",
273316
+ "output"
273317
+ ],
273318
+ "description": "Action definition",
273319
+ "additionalProperties": false
273320
+ }
273321
+ },
273322
+ "entities": {
273323
+ "type": "object",
273324
+ "additionalProperties": {
273325
+ "type": "object",
273326
+ "properties": {
273327
+ "title": {
273328
+ "type": "string",
273329
+ "maxLength": 64,
273330
+ "description": "Title of the entity"
273331
+ },
273332
+ "description": {
273333
+ "type": "string",
273334
+ "maxLength": 256,
273335
+ "description": "Description of the entity"
273336
+ },
273337
+ "schema": {
273338
+ "type": "object",
273339
+ "additionalProperties": true
273340
+ }
273341
+ },
273342
+ "required": [
273343
+ "schema"
273344
+ ],
273345
+ "description": "Entity definition",
273346
+ "additionalProperties": false
273347
+ }
273348
+ }
273349
+ },
273350
+ "required": [
273351
+ "name",
273352
+ "version",
273353
+ "events",
273354
+ "actions",
273355
+ "entities"
273356
+ ],
273357
+ "title": "createInterfaceBody",
273358
+ "additionalProperties": false
273359
+ }
273360
+ },
273361
+ "section": "interface",
273362
+ "response": {
273363
+ "description": "Get an interface",
273364
+ "schema": {
273365
+ "type": "object",
273366
+ "properties": {
273367
+ "interface": {
273368
+ "$ref": "#/components/schemas/Interface"
273369
+ }
273370
+ },
273371
+ "required": [
273372
+ "interface"
273373
+ ],
273374
+ "title": "createInterfaceResponse",
273375
+ "additionalProperties": false
273376
+ }
273377
+ }
273378
+ },
273379
+ "getInterface": {
273380
+ "name": "getInterface",
273381
+ "description": "Get Interface",
273382
+ "method": "get",
273383
+ "path": "/v1/admin/interfaces/{id}",
273384
+ "parameters": {
273385
+ "id": {
273386
+ "in": "path",
273387
+ "type": "string",
273388
+ "description": "Interface id"
273389
+ }
273390
+ },
273391
+ "section": "interface",
273392
+ "response": {
273393
+ "description": "Get an interface",
273394
+ "schema": {
273395
+ "type": "object",
273396
+ "properties": {
273397
+ "interface": {
273398
+ "$ref": "#/components/schemas/Interface"
273399
+ }
273400
+ },
273401
+ "required": [
273402
+ "interface"
273403
+ ],
273404
+ "title": "getInterfaceResponse",
273405
+ "additionalProperties": false
273406
+ }
273407
+ }
273408
+ },
273409
+ "getInterfaceByName": {
273410
+ "name": "getInterfaceByName",
273411
+ "description": "Get Interface by name and version",
273412
+ "method": "get",
273413
+ "path": "/v1/admin/interfaces/{name}/{version}",
273414
+ "parameters": {
273415
+ "name": {
273416
+ "in": "path",
273417
+ "type": "string",
273418
+ "description": "Interface name"
273419
+ },
273420
+ "version": {
273421
+ "in": "path",
273422
+ "type": "string",
273423
+ "description": "Interface version"
273424
+ }
273425
+ },
273426
+ "section": "interface",
273427
+ "response": {
273428
+ "description": "Get an interface",
273429
+ "schema": {
273430
+ "type": "object",
273431
+ "properties": {
273432
+ "interface": {
273433
+ "$ref": "#/components/schemas/Interface"
273434
+ }
273435
+ },
273436
+ "required": [
273437
+ "interface"
273438
+ ],
273439
+ "title": "getInterfaceByNameResponse",
273440
+ "additionalProperties": false
273441
+ }
273442
+ }
273443
+ },
273444
+ "updateInterface": {
273445
+ "name": "updateInterface",
273446
+ "description": "Update Interface",
273447
+ "method": "put",
273448
+ "path": "/v1/admin/interfaces/{id}",
273449
+ "parameters": {
273450
+ "id": {
273451
+ "in": "path",
273452
+ "type": "string",
273453
+ "description": "Interface id"
273454
+ }
273455
+ },
273456
+ "requestBody": {
273457
+ "description": "Interface to update",
273458
+ "schema": {
273459
+ "type": "object",
273460
+ "properties": {
273461
+ "events": {
273462
+ "type": "object",
273463
+ "additionalProperties": {
273464
+ "type": "object",
273465
+ "properties": {
273466
+ "title": {
273467
+ "type": "string",
273468
+ "maxLength": 64,
273469
+ "description": "Title of the event"
273470
+ },
273471
+ "description": {
273472
+ "type": "string",
273473
+ "maxLength": 256,
273474
+ "description": "Description of the event"
273475
+ },
273476
+ "schema": {
273477
+ "type": "object",
273478
+ "additionalProperties": true
273479
+ }
273480
+ },
273481
+ "required": [
273482
+ "schema"
273483
+ ],
273484
+ "description": "Event Definition",
273485
+ "nullable": true,
273486
+ "additionalProperties": false
273487
+ }
273488
+ },
273489
+ "actions": {
273490
+ "type": "object",
273491
+ "additionalProperties": {
273492
+ "type": "object",
273493
+ "properties": {
273494
+ "title": {
273495
+ "type": "string",
273496
+ "maxLength": 64,
273497
+ "description": "Title of the action"
273498
+ },
273499
+ "description": {
273500
+ "type": "string",
273501
+ "maxLength": 256,
273502
+ "description": "Description of the action"
273503
+ },
273504
+ "input": {
273505
+ "type": "object",
273506
+ "properties": {
273507
+ "schema": {
273508
+ "type": "object",
273509
+ "additionalProperties": true
273510
+ }
273511
+ },
273512
+ "required": [
273513
+ "schema"
273514
+ ],
273515
+ "additionalProperties": false
273516
+ },
273517
+ "output": {
273518
+ "type": "object",
273519
+ "properties": {
273520
+ "schema": {
273521
+ "type": "object",
273522
+ "additionalProperties": true
273523
+ }
273524
+ },
273525
+ "required": [
273526
+ "schema"
273527
+ ],
273528
+ "additionalProperties": false
273529
+ }
273530
+ },
273531
+ "required": [
273532
+ "input",
273533
+ "output"
273534
+ ],
273535
+ "description": "Action definition",
273536
+ "nullable": true,
273537
+ "additionalProperties": false
273538
+ }
273539
+ },
273540
+ "entities": {
273541
+ "type": "object",
273542
+ "additionalProperties": {
273543
+ "type": "object",
273544
+ "properties": {
273545
+ "title": {
273546
+ "type": "string",
273547
+ "maxLength": 64,
273548
+ "description": "Title of the entity"
273549
+ },
273550
+ "description": {
273551
+ "type": "string",
273552
+ "maxLength": 256,
273553
+ "description": "Description of the entity"
273554
+ },
273555
+ "schema": {
273556
+ "type": "object",
273557
+ "additionalProperties": true
273558
+ }
273559
+ },
273560
+ "required": [
273561
+ "schema"
273562
+ ],
273563
+ "description": "Entity definition",
273564
+ "nullable": true,
273565
+ "additionalProperties": false
273566
+ }
273567
+ }
273568
+ },
273569
+ "title": "updateInterfaceBody",
273570
+ "additionalProperties": false
273571
+ }
273572
+ },
273573
+ "section": "interface",
273574
+ "response": {
273575
+ "description": "Update an interface",
273576
+ "schema": {
273577
+ "type": "object",
273578
+ "properties": {
273579
+ "interface": {
273580
+ "$ref": "#/components/schemas/Interface"
273581
+ }
273582
+ },
273583
+ "required": [
273584
+ "interface"
273585
+ ],
273586
+ "title": "updateInterfaceResponse",
273587
+ "additionalProperties": false
273588
+ }
273589
+ }
273590
+ },
273591
+ "deleteInterface": {
273592
+ "name": "deleteInterface",
273593
+ "description": "Delete Interface",
273594
+ "method": "delete",
273595
+ "path": "/v1/admin/interfaces/{id}",
273596
+ "parameters": {
273597
+ "id": {
273598
+ "in": "path",
273599
+ "type": "string",
273600
+ "description": "Interface id"
273601
+ }
273602
+ },
273603
+ "section": "interface",
273604
+ "response": {
273605
+ "description": "Delete an interface",
273606
+ "schema": {
273607
+ "type": "object",
273608
+ "title": "deleteInterfaceResponse",
273609
+ "additionalProperties": false
273610
+ }
273611
+ }
273612
+ },
273613
+ "listInterfaces": {
273614
+ "name": "listInterfaces",
273615
+ "description": "List Interfaces",
273616
+ "method": "get",
273617
+ "path": "/v1/admin/interfaces",
273618
+ "section": "interface",
273619
+ "parameters": {
273620
+ "nextToken": {
273621
+ "in": "query",
273622
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
273623
+ "type": "string"
273624
+ }
273625
+ },
273626
+ "response": {
273627
+ "description": "List interfaces",
273628
+ "schema": {
273629
+ "type": "object",
273630
+ "properties": {
273631
+ "interfaces": {
273632
+ "type": "array",
273633
+ "items": {
273634
+ "type": "object",
273635
+ "properties": {
273636
+ "id": {
273637
+ "type": "string",
273638
+ "minLength": 28,
273639
+ "maxLength": 36,
273640
+ "description": "ID of the [Interface](#schema_interface)"
273641
+ },
273642
+ "createdAt": {
273643
+ "type": "string",
273644
+ "format": "date-time",
273645
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
273646
+ },
273647
+ "updatedAt": {
273648
+ "type": "string",
273649
+ "format": "date-time",
273650
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
273651
+ },
273652
+ "name": {
273653
+ "type": "string",
273654
+ "maxLength": 200,
273655
+ "description": "Name of the [Interface](#schema_interface)"
273656
+ },
273657
+ "version": {
273658
+ "type": "string",
273659
+ "maxLength": 200,
273660
+ "description": "Version of the [Interface](#schema_interface)"
273661
+ }
273662
+ },
273663
+ "required": [
273664
+ "id",
273665
+ "createdAt",
273666
+ "updatedAt",
273667
+ "name",
273668
+ "version"
273669
+ ]
273670
+ }
273671
+ },
273672
+ "meta": {
273673
+ "type": "object",
273674
+ "properties": {
273675
+ "nextToken": {
273676
+ "type": "string",
273677
+ "description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
273678
+ }
273679
+ },
273680
+ "additionalProperties": false
273681
+ }
273682
+ },
273683
+ "required": [
273684
+ "interfaces",
273685
+ "meta"
273686
+ ],
273687
+ "title": "listInterfacesResponse",
273688
+ "additionalProperties": false
273689
+ }
273690
+ }
273691
+ },
273224
273692
  "getUsage": {
273225
273693
  "name": "getUsage",
273226
273694
  "path": "/v1/admin/usages/{id}",
@@ -275123,7 +275591,7 @@ var state = {
275123
275591
  "title": "Botpress API",
275124
275592
  "description": "API for Botpress Cloud",
275125
275593
  "server": "https://api.botpress.cloud",
275126
- "version": "0.31.0",
275594
+ "version": "0.32.0",
275127
275595
  "prefix": "v1"
275128
275596
  },
275129
275597
  "errors": [
@@ -275287,6 +275755,8 @@ var state = {
275287
275755
  "createIntegrationApiKeyBody": true,
275288
275756
  "createIntegrationBody": true,
275289
275757
  "updateIntegrationBody": true,
275758
+ "createInterfaceBody": true,
275759
+ "updateInterfaceBody": true,
275290
275760
  "changeAISpendQuotaBody": true,
275291
275761
  "introspectBody": true,
275292
275762
  "upsertFileBody": true,
@@ -275397,6 +275867,12 @@ var state = {
275397
275867
  "getIntegrationLogsResponse": true,
275398
275868
  "getIntegrationByNameResponse": true,
275399
275869
  "deleteIntegrationResponse": true,
275870
+ "createInterfaceResponse": true,
275871
+ "getInterfaceResponse": true,
275872
+ "getInterfaceByNameResponse": true,
275873
+ "updateInterfaceResponse": true,
275874
+ "deleteInterfaceResponse": true,
275875
+ "listInterfacesResponse": true,
275400
275876
  "getUsageResponse": true,
275401
275877
  "getMultipleUsagesResponse": true,
275402
275878
  "listUsageHistoryResponse": true,
@@ -275427,6 +275903,7 @@ var state = {
275427
275903
  "schemas": {
275428
275904
  "Bot": true,
275429
275905
  "Integration": true,
275906
+ "Interface": true,
275430
275907
  "Workspace": true,
275431
275908
  "WorkspaceMember": true,
275432
275909
  "Account": true,
@@ -276471,6 +276948,155 @@ var state = {
276471
276948
  "additionalProperties": false
276472
276949
  }
276473
276950
  },
276951
+ "Interface": {
276952
+ "section": "interface",
276953
+ "schema": {
276954
+ "type": "object",
276955
+ "properties": {
276956
+ "id": {
276957
+ "type": "string",
276958
+ "minLength": 28,
276959
+ "maxLength": 36,
276960
+ "description": "ID of the [Interface](#schema_interface)"
276961
+ },
276962
+ "createdAt": {
276963
+ "type": "string",
276964
+ "format": "date-time",
276965
+ "description": "Creation date of the [Interface](#schema_interface) in ISO 8601 format"
276966
+ },
276967
+ "updatedAt": {
276968
+ "type": "string",
276969
+ "format": "date-time",
276970
+ "description": "Updating date of the [Interface](#schema_interface) in ISO 8601 format"
276971
+ },
276972
+ "name": {
276973
+ "type": "string",
276974
+ "maxLength": 200,
276975
+ "description": "Name of the [Interface](#schema_interface)"
276976
+ },
276977
+ "version": {
276978
+ "type": "string",
276979
+ "maxLength": 200,
276980
+ "description": "Version of the [Interface](#schema_interface)"
276981
+ },
276982
+ "events": {
276983
+ "type": "object",
276984
+ "additionalProperties": {
276985
+ "type": "object",
276986
+ "properties": {
276987
+ "title": {
276988
+ "type": "string",
276989
+ "maxLength": 64,
276990
+ "description": "Title of the event"
276991
+ },
276992
+ "description": {
276993
+ "type": "string",
276994
+ "maxLength": 256,
276995
+ "description": "Description of the event"
276996
+ },
276997
+ "schema": {
276998
+ "type": "object",
276999
+ "additionalProperties": true
277000
+ }
277001
+ },
277002
+ "required": [
277003
+ "schema"
277004
+ ],
277005
+ "description": "Event Definition",
277006
+ "additionalProperties": false
277007
+ }
277008
+ },
277009
+ "actions": {
277010
+ "type": "object",
277011
+ "additionalProperties": {
277012
+ "type": "object",
277013
+ "properties": {
277014
+ "title": {
277015
+ "type": "string",
277016
+ "maxLength": 64,
277017
+ "description": "Title of the action"
277018
+ },
277019
+ "description": {
277020
+ "type": "string",
277021
+ "maxLength": 256,
277022
+ "description": "Description of the action"
277023
+ },
277024
+ "input": {
277025
+ "type": "object",
277026
+ "properties": {
277027
+ "schema": {
277028
+ "type": "object",
277029
+ "additionalProperties": true
277030
+ }
277031
+ },
277032
+ "required": [
277033
+ "schema"
277034
+ ],
277035
+ "additionalProperties": false
277036
+ },
277037
+ "output": {
277038
+ "type": "object",
277039
+ "properties": {
277040
+ "schema": {
277041
+ "type": "object",
277042
+ "additionalProperties": true
277043
+ }
277044
+ },
277045
+ "required": [
277046
+ "schema"
277047
+ ],
277048
+ "additionalProperties": false
277049
+ }
277050
+ },
277051
+ "required": [
277052
+ "input",
277053
+ "output"
277054
+ ],
277055
+ "description": "Action definition",
277056
+ "additionalProperties": false
277057
+ }
277058
+ },
277059
+ "entities": {
277060
+ "type": "object",
277061
+ "additionalProperties": {
277062
+ "type": "object",
277063
+ "properties": {
277064
+ "title": {
277065
+ "type": "string",
277066
+ "maxLength": 64,
277067
+ "description": "Title of the entity"
277068
+ },
277069
+ "description": {
277070
+ "type": "string",
277071
+ "maxLength": 256,
277072
+ "description": "Description of the entity"
277073
+ },
277074
+ "schema": {
277075
+ "type": "object",
277076
+ "additionalProperties": true
277077
+ }
277078
+ },
277079
+ "required": [
277080
+ "schema"
277081
+ ],
277082
+ "description": "Entity definition",
277083
+ "additionalProperties": false
277084
+ }
277085
+ }
277086
+ },
277087
+ "required": [
277088
+ "id",
277089
+ "createdAt",
277090
+ "updatedAt",
277091
+ "name",
277092
+ "version",
277093
+ "events",
277094
+ "actions",
277095
+ "entities"
277096
+ ],
277097
+ "additionalProperties": false
277098
+ }
277099
+ },
276474
277100
  "Workspace": {
276475
277101
  "section": "workspace",
276476
277102
  "schema": {
@@ -277900,6 +278526,20 @@ var state = {
277900
278526
  ],
277901
278527
  "schema": "Integration"
277902
278528
  },
278529
+ {
278530
+ "title": "Interface",
278531
+ "description": "",
278532
+ "name": "interface",
278533
+ "operations": [
278534
+ "createInterface",
278535
+ "getInterface",
278536
+ "getInterfaceByName",
278537
+ "updateInterface",
278538
+ "deleteInterface",
278539
+ "listInterfaces"
278540
+ ],
278541
+ "schema": "Interface"
278542
+ },
277903
278543
  {
277904
278544
  "title": "Workspace",
277905
278545
  "description": "",