@botpress/api 1.25.0 → 1.26.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.
- package/dist/index.js +1525 -615
- package/dist/src/gen/admin/state.d.ts +397 -0
- package/dist/src/gen/state.d.ts +397 -0
- package/package.json +1 -1
- package/src/gen/admin/metadata.json +1 -1
- package/src/gen/admin/openapi.json +1 -1
- package/src/gen/admin/state.ts +456 -1
- package/src/gen/files/openapi.json +1 -1
- package/src/gen/files/state.ts +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/runtime/openapi.json +1 -1
- package/src/gen/runtime/state.ts +1 -1
- package/src/gen/state.ts +456 -1
- package/src/gen/tables/openapi.json +1 -1
- package/src/gen/tables/state.ts +1 -1
package/src/gen/runtime/state.ts
CHANGED
package/src/gen/state.ts
CHANGED
|
@@ -5256,6 +5256,413 @@ export const state = {
|
|
|
5256
5256
|
}
|
|
5257
5257
|
}
|
|
5258
5258
|
},
|
|
5259
|
+
"getDereferencedPublicPluginById": {
|
|
5260
|
+
"name": "getDereferencedPublicPluginById",
|
|
5261
|
+
"description": "Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
5262
|
+
"method": "get",
|
|
5263
|
+
"section": "hub",
|
|
5264
|
+
"path": "/v1/admin/hub/plugins/{id}/dereferenced",
|
|
5265
|
+
"disableDefaultParameters": {
|
|
5266
|
+
"x-workspace-id": true
|
|
5267
|
+
},
|
|
5268
|
+
"parameters": {
|
|
5269
|
+
"id": {
|
|
5270
|
+
"type": "string",
|
|
5271
|
+
"description": "Plugin ID",
|
|
5272
|
+
"in": "path"
|
|
5273
|
+
},
|
|
5274
|
+
"interfaces": {
|
|
5275
|
+
"in": "query",
|
|
5276
|
+
"type": "object",
|
|
5277
|
+
"schema": {
|
|
5278
|
+
"type": "object",
|
|
5279
|
+
"additionalProperties": {
|
|
5280
|
+
"type": "string",
|
|
5281
|
+
"description": "integration id"
|
|
5282
|
+
},
|
|
5283
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
5284
|
+
},
|
|
5285
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
5286
|
+
"required": true
|
|
5287
|
+
}
|
|
5288
|
+
},
|
|
5289
|
+
"response": {
|
|
5290
|
+
"description": "Success",
|
|
5291
|
+
"schema": {
|
|
5292
|
+
"type": "object",
|
|
5293
|
+
"properties": {
|
|
5294
|
+
"plugin": {
|
|
5295
|
+
"type": "object",
|
|
5296
|
+
"properties": {
|
|
5297
|
+
"id": {
|
|
5298
|
+
"type": "string",
|
|
5299
|
+
"minLength": 28,
|
|
5300
|
+
"maxLength": 36,
|
|
5301
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
5302
|
+
},
|
|
5303
|
+
"name": {
|
|
5304
|
+
"type": "string",
|
|
5305
|
+
"maxLength": 200,
|
|
5306
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
5307
|
+
},
|
|
5308
|
+
"version": {
|
|
5309
|
+
"type": "string",
|
|
5310
|
+
"maxLength": 200,
|
|
5311
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
5312
|
+
},
|
|
5313
|
+
"createdAt": {
|
|
5314
|
+
"type": "string",
|
|
5315
|
+
"format": "date-time",
|
|
5316
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
5317
|
+
},
|
|
5318
|
+
"updatedAt": {
|
|
5319
|
+
"type": "string",
|
|
5320
|
+
"format": "date-time",
|
|
5321
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
5322
|
+
},
|
|
5323
|
+
"configuration": {
|
|
5324
|
+
"type": "object",
|
|
5325
|
+
"properties": {
|
|
5326
|
+
"title": {
|
|
5327
|
+
"type": "string",
|
|
5328
|
+
"maxLength": 64,
|
|
5329
|
+
"description": "Title of the configuration"
|
|
5330
|
+
},
|
|
5331
|
+
"description": {
|
|
5332
|
+
"type": "string",
|
|
5333
|
+
"maxLength": 256,
|
|
5334
|
+
"description": "Description of the configuration"
|
|
5335
|
+
},
|
|
5336
|
+
"schema": {
|
|
5337
|
+
"type": "object",
|
|
5338
|
+
"additionalProperties": true,
|
|
5339
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
5340
|
+
}
|
|
5341
|
+
},
|
|
5342
|
+
"required": [
|
|
5343
|
+
"schema"
|
|
5344
|
+
],
|
|
5345
|
+
"description": "Configuration definition",
|
|
5346
|
+
"additionalProperties": false
|
|
5347
|
+
},
|
|
5348
|
+
"states": {
|
|
5349
|
+
"type": "object",
|
|
5350
|
+
"additionalProperties": {
|
|
5351
|
+
"type": "object",
|
|
5352
|
+
"properties": {
|
|
5353
|
+
"type": {
|
|
5354
|
+
"type": "string",
|
|
5355
|
+
"enum": [
|
|
5356
|
+
"conversation",
|
|
5357
|
+
"user",
|
|
5358
|
+
"bot",
|
|
5359
|
+
"task"
|
|
5360
|
+
],
|
|
5361
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
5362
|
+
},
|
|
5363
|
+
"schema": {
|
|
5364
|
+
"type": "object",
|
|
5365
|
+
"additionalProperties": true,
|
|
5366
|
+
"description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
|
|
5367
|
+
},
|
|
5368
|
+
"expiry": {
|
|
5369
|
+
"type": "number",
|
|
5370
|
+
"minimum": 1,
|
|
5371
|
+
"description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
|
|
5372
|
+
}
|
|
5373
|
+
},
|
|
5374
|
+
"required": [
|
|
5375
|
+
"type",
|
|
5376
|
+
"schema"
|
|
5377
|
+
],
|
|
5378
|
+
"additionalProperties": false
|
|
5379
|
+
}
|
|
5380
|
+
},
|
|
5381
|
+
"events": {
|
|
5382
|
+
"type": "object",
|
|
5383
|
+
"additionalProperties": {
|
|
5384
|
+
"type": "object",
|
|
5385
|
+
"properties": {
|
|
5386
|
+
"title": {
|
|
5387
|
+
"type": "string",
|
|
5388
|
+
"maxLength": 64,
|
|
5389
|
+
"description": "Title of the event"
|
|
5390
|
+
},
|
|
5391
|
+
"description": {
|
|
5392
|
+
"type": "string",
|
|
5393
|
+
"maxLength": 256,
|
|
5394
|
+
"description": "Description of the event"
|
|
5395
|
+
},
|
|
5396
|
+
"schema": {
|
|
5397
|
+
"type": "object",
|
|
5398
|
+
"additionalProperties": true
|
|
5399
|
+
},
|
|
5400
|
+
"attributes": {
|
|
5401
|
+
"type": "object",
|
|
5402
|
+
"additionalProperties": {
|
|
5403
|
+
"type": "string",
|
|
5404
|
+
"maxLength": 200
|
|
5405
|
+
},
|
|
5406
|
+
"description": "Optional attributes"
|
|
5407
|
+
}
|
|
5408
|
+
},
|
|
5409
|
+
"required": [
|
|
5410
|
+
"schema"
|
|
5411
|
+
],
|
|
5412
|
+
"description": "Event Definition",
|
|
5413
|
+
"additionalProperties": false
|
|
5414
|
+
}
|
|
5415
|
+
},
|
|
5416
|
+
"actions": {
|
|
5417
|
+
"type": "object",
|
|
5418
|
+
"additionalProperties": {
|
|
5419
|
+
"type": "object",
|
|
5420
|
+
"properties": {
|
|
5421
|
+
"title": {
|
|
5422
|
+
"type": "string",
|
|
5423
|
+
"maxLength": 64,
|
|
5424
|
+
"description": "Title of the action"
|
|
5425
|
+
},
|
|
5426
|
+
"description": {
|
|
5427
|
+
"type": "string",
|
|
5428
|
+
"maxLength": 256,
|
|
5429
|
+
"description": "Description of the action"
|
|
5430
|
+
},
|
|
5431
|
+
"billable": {
|
|
5432
|
+
"type": "boolean"
|
|
5433
|
+
},
|
|
5434
|
+
"cacheable": {
|
|
5435
|
+
"type": "boolean"
|
|
5436
|
+
},
|
|
5437
|
+
"input": {
|
|
5438
|
+
"type": "object",
|
|
5439
|
+
"properties": {
|
|
5440
|
+
"schema": {
|
|
5441
|
+
"type": "object",
|
|
5442
|
+
"additionalProperties": true
|
|
5443
|
+
}
|
|
5444
|
+
},
|
|
5445
|
+
"required": [
|
|
5446
|
+
"schema"
|
|
5447
|
+
],
|
|
5448
|
+
"additionalProperties": false
|
|
5449
|
+
},
|
|
5450
|
+
"output": {
|
|
5451
|
+
"type": "object",
|
|
5452
|
+
"properties": {
|
|
5453
|
+
"schema": {
|
|
5454
|
+
"type": "object",
|
|
5455
|
+
"additionalProperties": true
|
|
5456
|
+
}
|
|
5457
|
+
},
|
|
5458
|
+
"required": [
|
|
5459
|
+
"schema"
|
|
5460
|
+
],
|
|
5461
|
+
"additionalProperties": false
|
|
5462
|
+
},
|
|
5463
|
+
"attributes": {
|
|
5464
|
+
"type": "object",
|
|
5465
|
+
"additionalProperties": {
|
|
5466
|
+
"type": "string",
|
|
5467
|
+
"maxLength": 200
|
|
5468
|
+
},
|
|
5469
|
+
"description": "Optional attributes"
|
|
5470
|
+
}
|
|
5471
|
+
},
|
|
5472
|
+
"required": [
|
|
5473
|
+
"input",
|
|
5474
|
+
"output"
|
|
5475
|
+
],
|
|
5476
|
+
"description": "Action definition",
|
|
5477
|
+
"additionalProperties": false
|
|
5478
|
+
}
|
|
5479
|
+
},
|
|
5480
|
+
"dependencies": {
|
|
5481
|
+
"type": "object",
|
|
5482
|
+
"properties": {
|
|
5483
|
+
"interfaces": {
|
|
5484
|
+
"type": "object",
|
|
5485
|
+
"additionalProperties": {
|
|
5486
|
+
"type": "object",
|
|
5487
|
+
"properties": {
|
|
5488
|
+
"id": {
|
|
5489
|
+
"type": "string",
|
|
5490
|
+
"minLength": 28,
|
|
5491
|
+
"maxLength": 36
|
|
5492
|
+
},
|
|
5493
|
+
"name": {
|
|
5494
|
+
"type": "string",
|
|
5495
|
+
"maxLength": 200
|
|
5496
|
+
},
|
|
5497
|
+
"version": {
|
|
5498
|
+
"type": "string",
|
|
5499
|
+
"maxLength": 200
|
|
5500
|
+
}
|
|
5501
|
+
},
|
|
5502
|
+
"required": [
|
|
5503
|
+
"id",
|
|
5504
|
+
"name",
|
|
5505
|
+
"version"
|
|
5506
|
+
],
|
|
5507
|
+
"additionalProperties": false
|
|
5508
|
+
}
|
|
5509
|
+
},
|
|
5510
|
+
"integrations": {
|
|
5511
|
+
"type": "object",
|
|
5512
|
+
"additionalProperties": {
|
|
5513
|
+
"type": "object",
|
|
5514
|
+
"properties": {
|
|
5515
|
+
"id": {
|
|
5516
|
+
"type": "string",
|
|
5517
|
+
"minLength": 28,
|
|
5518
|
+
"maxLength": 36
|
|
5519
|
+
},
|
|
5520
|
+
"name": {
|
|
5521
|
+
"type": "string",
|
|
5522
|
+
"maxLength": 200
|
|
5523
|
+
},
|
|
5524
|
+
"version": {
|
|
5525
|
+
"type": "string",
|
|
5526
|
+
"maxLength": 200
|
|
5527
|
+
}
|
|
5528
|
+
},
|
|
5529
|
+
"required": [
|
|
5530
|
+
"id",
|
|
5531
|
+
"name",
|
|
5532
|
+
"version"
|
|
5533
|
+
],
|
|
5534
|
+
"additionalProperties": false
|
|
5535
|
+
}
|
|
5536
|
+
}
|
|
5537
|
+
},
|
|
5538
|
+
"required": [
|
|
5539
|
+
"interfaces",
|
|
5540
|
+
"integrations"
|
|
5541
|
+
],
|
|
5542
|
+
"additionalProperties": false
|
|
5543
|
+
},
|
|
5544
|
+
"user": {
|
|
5545
|
+
"type": "object",
|
|
5546
|
+
"properties": {
|
|
5547
|
+
"tags": {
|
|
5548
|
+
"type": "object",
|
|
5549
|
+
"additionalProperties": {
|
|
5550
|
+
"type": "object",
|
|
5551
|
+
"properties": {
|
|
5552
|
+
"title": {
|
|
5553
|
+
"type": "string",
|
|
5554
|
+
"maxLength": 64,
|
|
5555
|
+
"description": "Title of the tag"
|
|
5556
|
+
},
|
|
5557
|
+
"description": {
|
|
5558
|
+
"type": "string",
|
|
5559
|
+
"maxLength": 256,
|
|
5560
|
+
"description": "Description of the tag"
|
|
5561
|
+
}
|
|
5562
|
+
},
|
|
5563
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
5564
|
+
"additionalProperties": false
|
|
5565
|
+
}
|
|
5566
|
+
}
|
|
5567
|
+
},
|
|
5568
|
+
"required": [
|
|
5569
|
+
"tags"
|
|
5570
|
+
],
|
|
5571
|
+
"description": "User object configuration",
|
|
5572
|
+
"additionalProperties": false
|
|
5573
|
+
},
|
|
5574
|
+
"conversation": {
|
|
5575
|
+
"type": "object",
|
|
5576
|
+
"properties": {
|
|
5577
|
+
"tags": {
|
|
5578
|
+
"type": "object",
|
|
5579
|
+
"additionalProperties": {
|
|
5580
|
+
"type": "object",
|
|
5581
|
+
"properties": {
|
|
5582
|
+
"title": {
|
|
5583
|
+
"type": "string",
|
|
5584
|
+
"maxLength": 64,
|
|
5585
|
+
"description": "Title of the tag"
|
|
5586
|
+
},
|
|
5587
|
+
"description": {
|
|
5588
|
+
"type": "string",
|
|
5589
|
+
"maxLength": 256,
|
|
5590
|
+
"description": "Description of the tag"
|
|
5591
|
+
}
|
|
5592
|
+
},
|
|
5593
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
5594
|
+
"additionalProperties": false
|
|
5595
|
+
}
|
|
5596
|
+
}
|
|
5597
|
+
},
|
|
5598
|
+
"required": [
|
|
5599
|
+
"tags"
|
|
5600
|
+
],
|
|
5601
|
+
"description": "Conversation object configuration",
|
|
5602
|
+
"additionalProperties": false
|
|
5603
|
+
},
|
|
5604
|
+
"attributes": {
|
|
5605
|
+
"type": "object",
|
|
5606
|
+
"additionalProperties": {
|
|
5607
|
+
"type": "string",
|
|
5608
|
+
"maxLength": 200
|
|
5609
|
+
},
|
|
5610
|
+
"description": "Optional attributes"
|
|
5611
|
+
},
|
|
5612
|
+
"title": {
|
|
5613
|
+
"type": "string",
|
|
5614
|
+
"minLength": 1,
|
|
5615
|
+
"maxLength": 64,
|
|
5616
|
+
"description": "Title of the plugin. This is the name that will be displayed in the UI"
|
|
5617
|
+
},
|
|
5618
|
+
"description": {
|
|
5619
|
+
"type": "string",
|
|
5620
|
+
"maxLength": 256,
|
|
5621
|
+
"description": "Description of the plugin. This is the description that will be displayed in the UI"
|
|
5622
|
+
},
|
|
5623
|
+
"iconUrl": {
|
|
5624
|
+
"type": "string",
|
|
5625
|
+
"description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
|
|
5626
|
+
},
|
|
5627
|
+
"readmeUrl": {
|
|
5628
|
+
"type": "string",
|
|
5629
|
+
"description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
|
|
5630
|
+
},
|
|
5631
|
+
"public": {
|
|
5632
|
+
"type": "boolean",
|
|
5633
|
+
"description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
|
|
5634
|
+
}
|
|
5635
|
+
},
|
|
5636
|
+
"required": [
|
|
5637
|
+
"id",
|
|
5638
|
+
"name",
|
|
5639
|
+
"version",
|
|
5640
|
+
"createdAt",
|
|
5641
|
+
"updatedAt",
|
|
5642
|
+
"configuration",
|
|
5643
|
+
"states",
|
|
5644
|
+
"events",
|
|
5645
|
+
"actions",
|
|
5646
|
+
"dependencies",
|
|
5647
|
+
"user",
|
|
5648
|
+
"conversation",
|
|
5649
|
+
"title",
|
|
5650
|
+
"description",
|
|
5651
|
+
"iconUrl",
|
|
5652
|
+
"readmeUrl",
|
|
5653
|
+
"public"
|
|
5654
|
+
],
|
|
5655
|
+
"additionalProperties": false
|
|
5656
|
+
}
|
|
5657
|
+
},
|
|
5658
|
+
"required": [
|
|
5659
|
+
"plugin"
|
|
5660
|
+
],
|
|
5661
|
+
"title": "getDereferencedPublicPluginByIdResponse",
|
|
5662
|
+
"additionalProperties": false
|
|
5663
|
+
}
|
|
5664
|
+
}
|
|
5665
|
+
},
|
|
5259
5666
|
"getPublicPlugin": {
|
|
5260
5667
|
"name": "getPublicPlugin",
|
|
5261
5668
|
"description": "Get public plugin by name and version",
|
|
@@ -14696,6 +15103,50 @@ export const state = {
|
|
|
14696
15103
|
}
|
|
14697
15104
|
}
|
|
14698
15105
|
},
|
|
15106
|
+
"getDereferencedPlugin": {
|
|
15107
|
+
"name": "getDereferencedPlugin",
|
|
15108
|
+
"description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
|
|
15109
|
+
"method": "get",
|
|
15110
|
+
"section": "plugin",
|
|
15111
|
+
"path": "/v1/admin/plugins/{id}/dereferenced",
|
|
15112
|
+
"parameters": {
|
|
15113
|
+
"id": {
|
|
15114
|
+
"type": "string",
|
|
15115
|
+
"description": "Plugin ID",
|
|
15116
|
+
"in": "path"
|
|
15117
|
+
},
|
|
15118
|
+
"interfaces": {
|
|
15119
|
+
"in": "query",
|
|
15120
|
+
"type": "object",
|
|
15121
|
+
"schema": {
|
|
15122
|
+
"type": "object",
|
|
15123
|
+
"additionalProperties": {
|
|
15124
|
+
"type": "string",
|
|
15125
|
+
"description": "integration id"
|
|
15126
|
+
},
|
|
15127
|
+
"description": "Mapping of interface aliases to integration IDs"
|
|
15128
|
+
},
|
|
15129
|
+
"description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
|
|
15130
|
+
"required": true
|
|
15131
|
+
}
|
|
15132
|
+
},
|
|
15133
|
+
"response": {
|
|
15134
|
+
"description": "Get a dereferenced plugin",
|
|
15135
|
+
"schema": {
|
|
15136
|
+
"type": "object",
|
|
15137
|
+
"properties": {
|
|
15138
|
+
"plugin": {
|
|
15139
|
+
"$ref": "#/components/schemas/Plugin"
|
|
15140
|
+
}
|
|
15141
|
+
},
|
|
15142
|
+
"required": [
|
|
15143
|
+
"plugin"
|
|
15144
|
+
],
|
|
15145
|
+
"title": "getDereferencedPluginResponse",
|
|
15146
|
+
"additionalProperties": false
|
|
15147
|
+
}
|
|
15148
|
+
}
|
|
15149
|
+
},
|
|
14699
15150
|
"getPluginByName": {
|
|
14700
15151
|
"name": "getPluginByName",
|
|
14701
15152
|
"description": "Get Plugin by name and version",
|
|
@@ -18756,7 +19207,7 @@ export const state = {
|
|
|
18756
19207
|
"title": "Botpress API",
|
|
18757
19208
|
"description": "API for Botpress Cloud",
|
|
18758
19209
|
"server": "https://api.botpress.cloud",
|
|
18759
|
-
"version": "1.
|
|
19210
|
+
"version": "1.26.0",
|
|
18760
19211
|
"prefix": "v1"
|
|
18761
19212
|
},
|
|
18762
19213
|
"errors": [
|
|
@@ -19016,6 +19467,7 @@ export const state = {
|
|
|
19016
19467
|
"getPublicIntegrationResponse": true,
|
|
19017
19468
|
"listPublicPluginsResponse": true,
|
|
19018
19469
|
"getPublicPluginByIdResponse": true,
|
|
19470
|
+
"getDereferencedPublicPluginByIdResponse": true,
|
|
19019
19471
|
"getPublicPluginResponse": true,
|
|
19020
19472
|
"getPublicPluginCodeResponse": true,
|
|
19021
19473
|
"listPublicInterfacesResponse": true,
|
|
@@ -19091,6 +19543,7 @@ export const state = {
|
|
|
19091
19543
|
"listInterfacesResponse": true,
|
|
19092
19544
|
"createPluginResponse": true,
|
|
19093
19545
|
"getPluginResponse": true,
|
|
19546
|
+
"getDereferencedPluginResponse": true,
|
|
19094
19547
|
"getPluginByNameResponse": true,
|
|
19095
19548
|
"updatePluginResponse": true,
|
|
19096
19549
|
"deletePluginResponse": true,
|
|
@@ -22715,6 +23168,7 @@ export const state = {
|
|
|
22715
23168
|
"getPublicIntegration",
|
|
22716
23169
|
"listPublicPlugins",
|
|
22717
23170
|
"getPublicPluginById",
|
|
23171
|
+
"getDereferencedPublicPluginById",
|
|
22718
23172
|
"getPublicPlugin",
|
|
22719
23173
|
"getPublicPluginCode",
|
|
22720
23174
|
"listPublicInterfaces",
|
|
@@ -22842,6 +23296,7 @@ export const state = {
|
|
|
22842
23296
|
"operations": [
|
|
22843
23297
|
"createPlugin",
|
|
22844
23298
|
"getPlugin",
|
|
23299
|
+
"getDereferencedPlugin",
|
|
22845
23300
|
"getPluginByName",
|
|
22846
23301
|
"updatePlugin",
|
|
22847
23302
|
"deletePlugin",
|