@botpress/api 0.52.0 → 0.53.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 +860 -1
- package/dist/src/gen/state.d.ts +756 -1
- package/dist/src/index.d.ts +2 -2
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +861 -2
package/src/gen/state.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/* prettier-ignore */
|
|
4
4
|
import * as opapi from '@bpinternal/opapi'
|
|
5
|
-
export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
|
|
5
|
+
export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
|
|
6
6
|
export const state = {
|
|
7
7
|
"operations": {
|
|
8
8
|
"createConversation": {
|
|
@@ -10133,6 +10133,619 @@ export const state = {
|
|
|
10133
10133
|
}
|
|
10134
10134
|
}
|
|
10135
10135
|
},
|
|
10136
|
+
"createPlugin": {
|
|
10137
|
+
"name": "createPlugin",
|
|
10138
|
+
"description": "Create Plugin",
|
|
10139
|
+
"method": "post",
|
|
10140
|
+
"path": "/v1/admin/plugins",
|
|
10141
|
+
"parameters": {},
|
|
10142
|
+
"requestBody": {
|
|
10143
|
+
"description": "Plugin to create",
|
|
10144
|
+
"schema": {
|
|
10145
|
+
"type": "object",
|
|
10146
|
+
"properties": {
|
|
10147
|
+
"name": {
|
|
10148
|
+
"type": "string",
|
|
10149
|
+
"maxLength": 200,
|
|
10150
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
10151
|
+
},
|
|
10152
|
+
"version": {
|
|
10153
|
+
"type": "string",
|
|
10154
|
+
"maxLength": 200,
|
|
10155
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
10156
|
+
},
|
|
10157
|
+
"configuration": {
|
|
10158
|
+
"type": "object",
|
|
10159
|
+
"properties": {
|
|
10160
|
+
"title": {
|
|
10161
|
+
"type": "string",
|
|
10162
|
+
"maxLength": 64,
|
|
10163
|
+
"description": "Title of the configuration"
|
|
10164
|
+
},
|
|
10165
|
+
"description": {
|
|
10166
|
+
"type": "string",
|
|
10167
|
+
"maxLength": 256,
|
|
10168
|
+
"description": "Description of the configuration"
|
|
10169
|
+
},
|
|
10170
|
+
"schema": {
|
|
10171
|
+
"type": "object",
|
|
10172
|
+
"additionalProperties": true,
|
|
10173
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
10174
|
+
}
|
|
10175
|
+
},
|
|
10176
|
+
"required": [
|
|
10177
|
+
"schema"
|
|
10178
|
+
],
|
|
10179
|
+
"description": "Configuration definition",
|
|
10180
|
+
"additionalProperties": false
|
|
10181
|
+
},
|
|
10182
|
+
"states": {
|
|
10183
|
+
"type": "object",
|
|
10184
|
+
"additionalProperties": {
|
|
10185
|
+
"type": "object",
|
|
10186
|
+
"properties": {
|
|
10187
|
+
"type": {
|
|
10188
|
+
"type": "string",
|
|
10189
|
+
"enum": [
|
|
10190
|
+
"conversation",
|
|
10191
|
+
"user",
|
|
10192
|
+
"bot",
|
|
10193
|
+
"task"
|
|
10194
|
+
],
|
|
10195
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
10196
|
+
},
|
|
10197
|
+
"schema": {
|
|
10198
|
+
"type": "object",
|
|
10199
|
+
"additionalProperties": true,
|
|
10200
|
+
"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."
|
|
10201
|
+
},
|
|
10202
|
+
"expiry": {
|
|
10203
|
+
"type": "number",
|
|
10204
|
+
"minimum": 1,
|
|
10205
|
+
"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."
|
|
10206
|
+
}
|
|
10207
|
+
},
|
|
10208
|
+
"required": [
|
|
10209
|
+
"type",
|
|
10210
|
+
"schema"
|
|
10211
|
+
],
|
|
10212
|
+
"additionalProperties": false
|
|
10213
|
+
}
|
|
10214
|
+
},
|
|
10215
|
+
"events": {
|
|
10216
|
+
"type": "object",
|
|
10217
|
+
"additionalProperties": {
|
|
10218
|
+
"type": "object",
|
|
10219
|
+
"properties": {
|
|
10220
|
+
"title": {
|
|
10221
|
+
"type": "string",
|
|
10222
|
+
"maxLength": 64,
|
|
10223
|
+
"description": "Title of the event"
|
|
10224
|
+
},
|
|
10225
|
+
"description": {
|
|
10226
|
+
"type": "string",
|
|
10227
|
+
"maxLength": 256,
|
|
10228
|
+
"description": "Description of the event"
|
|
10229
|
+
},
|
|
10230
|
+
"schema": {
|
|
10231
|
+
"type": "object",
|
|
10232
|
+
"additionalProperties": true
|
|
10233
|
+
}
|
|
10234
|
+
},
|
|
10235
|
+
"required": [
|
|
10236
|
+
"schema"
|
|
10237
|
+
],
|
|
10238
|
+
"description": "Event Definition",
|
|
10239
|
+
"additionalProperties": false
|
|
10240
|
+
}
|
|
10241
|
+
},
|
|
10242
|
+
"actions": {
|
|
10243
|
+
"type": "object",
|
|
10244
|
+
"additionalProperties": {
|
|
10245
|
+
"type": "object",
|
|
10246
|
+
"properties": {
|
|
10247
|
+
"title": {
|
|
10248
|
+
"type": "string",
|
|
10249
|
+
"maxLength": 64,
|
|
10250
|
+
"description": "Title of the action"
|
|
10251
|
+
},
|
|
10252
|
+
"description": {
|
|
10253
|
+
"type": "string",
|
|
10254
|
+
"maxLength": 256,
|
|
10255
|
+
"description": "Description of the action"
|
|
10256
|
+
},
|
|
10257
|
+
"billable": {
|
|
10258
|
+
"type": "boolean"
|
|
10259
|
+
},
|
|
10260
|
+
"cacheable": {
|
|
10261
|
+
"type": "boolean"
|
|
10262
|
+
},
|
|
10263
|
+
"input": {
|
|
10264
|
+
"type": "object",
|
|
10265
|
+
"properties": {
|
|
10266
|
+
"schema": {
|
|
10267
|
+
"type": "object",
|
|
10268
|
+
"additionalProperties": true
|
|
10269
|
+
}
|
|
10270
|
+
},
|
|
10271
|
+
"required": [
|
|
10272
|
+
"schema"
|
|
10273
|
+
],
|
|
10274
|
+
"additionalProperties": false
|
|
10275
|
+
},
|
|
10276
|
+
"output": {
|
|
10277
|
+
"type": "object",
|
|
10278
|
+
"properties": {
|
|
10279
|
+
"schema": {
|
|
10280
|
+
"type": "object",
|
|
10281
|
+
"additionalProperties": true
|
|
10282
|
+
}
|
|
10283
|
+
},
|
|
10284
|
+
"required": [
|
|
10285
|
+
"schema"
|
|
10286
|
+
],
|
|
10287
|
+
"additionalProperties": false
|
|
10288
|
+
}
|
|
10289
|
+
},
|
|
10290
|
+
"required": [
|
|
10291
|
+
"input",
|
|
10292
|
+
"output"
|
|
10293
|
+
],
|
|
10294
|
+
"description": "Action definition",
|
|
10295
|
+
"additionalProperties": false
|
|
10296
|
+
}
|
|
10297
|
+
},
|
|
10298
|
+
"user": {
|
|
10299
|
+
"type": "object",
|
|
10300
|
+
"properties": {
|
|
10301
|
+
"tags": {
|
|
10302
|
+
"type": "object",
|
|
10303
|
+
"additionalProperties": {
|
|
10304
|
+
"type": "object",
|
|
10305
|
+
"properties": {
|
|
10306
|
+
"title": {
|
|
10307
|
+
"type": "string",
|
|
10308
|
+
"maxLength": 64,
|
|
10309
|
+
"description": "Title of the tag"
|
|
10310
|
+
},
|
|
10311
|
+
"description": {
|
|
10312
|
+
"type": "string",
|
|
10313
|
+
"maxLength": 256,
|
|
10314
|
+
"description": "Description of the tag"
|
|
10315
|
+
}
|
|
10316
|
+
},
|
|
10317
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
10318
|
+
"additionalProperties": false
|
|
10319
|
+
}
|
|
10320
|
+
}
|
|
10321
|
+
},
|
|
10322
|
+
"required": [
|
|
10323
|
+
"tags"
|
|
10324
|
+
],
|
|
10325
|
+
"description": "User object configuration",
|
|
10326
|
+
"additionalProperties": false
|
|
10327
|
+
},
|
|
10328
|
+
"code": {
|
|
10329
|
+
"type": "string"
|
|
10330
|
+
}
|
|
10331
|
+
},
|
|
10332
|
+
"required": [
|
|
10333
|
+
"name",
|
|
10334
|
+
"version",
|
|
10335
|
+
"code"
|
|
10336
|
+
],
|
|
10337
|
+
"title": "createPluginBody",
|
|
10338
|
+
"additionalProperties": false
|
|
10339
|
+
}
|
|
10340
|
+
},
|
|
10341
|
+
"section": "plugin",
|
|
10342
|
+
"response": {
|
|
10343
|
+
"description": "Get an plugin",
|
|
10344
|
+
"schema": {
|
|
10345
|
+
"type": "object",
|
|
10346
|
+
"properties": {
|
|
10347
|
+
"plugin": {
|
|
10348
|
+
"$ref": "#/components/schemas/Plugin"
|
|
10349
|
+
}
|
|
10350
|
+
},
|
|
10351
|
+
"required": [
|
|
10352
|
+
"plugin"
|
|
10353
|
+
],
|
|
10354
|
+
"title": "createPluginResponse",
|
|
10355
|
+
"additionalProperties": false
|
|
10356
|
+
}
|
|
10357
|
+
}
|
|
10358
|
+
},
|
|
10359
|
+
"getPlugin": {
|
|
10360
|
+
"name": "getPlugin",
|
|
10361
|
+
"description": "Get Plugin",
|
|
10362
|
+
"method": "get",
|
|
10363
|
+
"path": "/v1/admin/plugins/{id}",
|
|
10364
|
+
"parameters": {
|
|
10365
|
+
"id": {
|
|
10366
|
+
"in": "path",
|
|
10367
|
+
"type": "string",
|
|
10368
|
+
"description": "Plugin id"
|
|
10369
|
+
}
|
|
10370
|
+
},
|
|
10371
|
+
"section": "plugin",
|
|
10372
|
+
"response": {
|
|
10373
|
+
"description": "Get an plugin",
|
|
10374
|
+
"schema": {
|
|
10375
|
+
"type": "object",
|
|
10376
|
+
"properties": {
|
|
10377
|
+
"plugin": {
|
|
10378
|
+
"$ref": "#/components/schemas/Plugin"
|
|
10379
|
+
}
|
|
10380
|
+
},
|
|
10381
|
+
"required": [
|
|
10382
|
+
"plugin"
|
|
10383
|
+
],
|
|
10384
|
+
"title": "getPluginResponse",
|
|
10385
|
+
"additionalProperties": false
|
|
10386
|
+
}
|
|
10387
|
+
}
|
|
10388
|
+
},
|
|
10389
|
+
"getPluginByName": {
|
|
10390
|
+
"name": "getPluginByName",
|
|
10391
|
+
"description": "Get Plugin by name and version",
|
|
10392
|
+
"method": "get",
|
|
10393
|
+
"path": "/v1/admin/plugins/{name}/{version}",
|
|
10394
|
+
"parameters": {
|
|
10395
|
+
"name": {
|
|
10396
|
+
"in": "path",
|
|
10397
|
+
"type": "string",
|
|
10398
|
+
"description": "Plugin name"
|
|
10399
|
+
},
|
|
10400
|
+
"version": {
|
|
10401
|
+
"in": "path",
|
|
10402
|
+
"type": "string",
|
|
10403
|
+
"description": "Plugin version"
|
|
10404
|
+
}
|
|
10405
|
+
},
|
|
10406
|
+
"section": "plugin",
|
|
10407
|
+
"response": {
|
|
10408
|
+
"description": "Get an plugin",
|
|
10409
|
+
"schema": {
|
|
10410
|
+
"type": "object",
|
|
10411
|
+
"properties": {
|
|
10412
|
+
"plugin": {
|
|
10413
|
+
"$ref": "#/components/schemas/Plugin"
|
|
10414
|
+
}
|
|
10415
|
+
},
|
|
10416
|
+
"required": [
|
|
10417
|
+
"plugin"
|
|
10418
|
+
],
|
|
10419
|
+
"title": "getPluginByNameResponse",
|
|
10420
|
+
"additionalProperties": false
|
|
10421
|
+
}
|
|
10422
|
+
}
|
|
10423
|
+
},
|
|
10424
|
+
"updatePlugin": {
|
|
10425
|
+
"name": "updatePlugin",
|
|
10426
|
+
"description": "Update Plugin",
|
|
10427
|
+
"method": "put",
|
|
10428
|
+
"path": "/v1/admin/plugins/{id}",
|
|
10429
|
+
"parameters": {
|
|
10430
|
+
"id": {
|
|
10431
|
+
"in": "path",
|
|
10432
|
+
"type": "string",
|
|
10433
|
+
"description": "Plugin id"
|
|
10434
|
+
}
|
|
10435
|
+
},
|
|
10436
|
+
"requestBody": {
|
|
10437
|
+
"description": "Plugin to update",
|
|
10438
|
+
"schema": {
|
|
10439
|
+
"type": "object",
|
|
10440
|
+
"properties": {
|
|
10441
|
+
"configuration": {
|
|
10442
|
+
"type": "object",
|
|
10443
|
+
"properties": {
|
|
10444
|
+
"title": {
|
|
10445
|
+
"type": "string",
|
|
10446
|
+
"maxLength": 64,
|
|
10447
|
+
"description": "Title of the configuration"
|
|
10448
|
+
},
|
|
10449
|
+
"description": {
|
|
10450
|
+
"type": "string",
|
|
10451
|
+
"maxLength": 256,
|
|
10452
|
+
"description": "Description of the configuration"
|
|
10453
|
+
},
|
|
10454
|
+
"schema": {
|
|
10455
|
+
"type": "object",
|
|
10456
|
+
"additionalProperties": true,
|
|
10457
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
10458
|
+
}
|
|
10459
|
+
},
|
|
10460
|
+
"required": [
|
|
10461
|
+
"schema"
|
|
10462
|
+
],
|
|
10463
|
+
"description": "Configuration definition",
|
|
10464
|
+
"nullable": true,
|
|
10465
|
+
"additionalProperties": false
|
|
10466
|
+
},
|
|
10467
|
+
"states": {
|
|
10468
|
+
"type": "object",
|
|
10469
|
+
"additionalProperties": {
|
|
10470
|
+
"type": "object",
|
|
10471
|
+
"properties": {
|
|
10472
|
+
"type": {
|
|
10473
|
+
"type": "string",
|
|
10474
|
+
"enum": [
|
|
10475
|
+
"conversation",
|
|
10476
|
+
"user",
|
|
10477
|
+
"bot",
|
|
10478
|
+
"task"
|
|
10479
|
+
],
|
|
10480
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
10481
|
+
},
|
|
10482
|
+
"schema": {
|
|
10483
|
+
"type": "object",
|
|
10484
|
+
"additionalProperties": true,
|
|
10485
|
+
"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."
|
|
10486
|
+
},
|
|
10487
|
+
"expiry": {
|
|
10488
|
+
"type": "number",
|
|
10489
|
+
"minimum": 1,
|
|
10490
|
+
"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."
|
|
10491
|
+
}
|
|
10492
|
+
},
|
|
10493
|
+
"required": [
|
|
10494
|
+
"type",
|
|
10495
|
+
"schema"
|
|
10496
|
+
],
|
|
10497
|
+
"nullable": true,
|
|
10498
|
+
"additionalProperties": false
|
|
10499
|
+
}
|
|
10500
|
+
},
|
|
10501
|
+
"events": {
|
|
10502
|
+
"type": "object",
|
|
10503
|
+
"additionalProperties": {
|
|
10504
|
+
"type": "object",
|
|
10505
|
+
"properties": {
|
|
10506
|
+
"title": {
|
|
10507
|
+
"type": "string",
|
|
10508
|
+
"maxLength": 64,
|
|
10509
|
+
"description": "Title of the event"
|
|
10510
|
+
},
|
|
10511
|
+
"description": {
|
|
10512
|
+
"type": "string",
|
|
10513
|
+
"maxLength": 256,
|
|
10514
|
+
"description": "Description of the event"
|
|
10515
|
+
},
|
|
10516
|
+
"schema": {
|
|
10517
|
+
"type": "object",
|
|
10518
|
+
"additionalProperties": true
|
|
10519
|
+
}
|
|
10520
|
+
},
|
|
10521
|
+
"required": [
|
|
10522
|
+
"schema"
|
|
10523
|
+
],
|
|
10524
|
+
"description": "Event Definition",
|
|
10525
|
+
"nullable": true,
|
|
10526
|
+
"additionalProperties": false
|
|
10527
|
+
}
|
|
10528
|
+
},
|
|
10529
|
+
"actions": {
|
|
10530
|
+
"type": "object",
|
|
10531
|
+
"additionalProperties": {
|
|
10532
|
+
"type": "object",
|
|
10533
|
+
"properties": {
|
|
10534
|
+
"title": {
|
|
10535
|
+
"type": "string",
|
|
10536
|
+
"maxLength": 64,
|
|
10537
|
+
"description": "Title of the action"
|
|
10538
|
+
},
|
|
10539
|
+
"description": {
|
|
10540
|
+
"type": "string",
|
|
10541
|
+
"maxLength": 256,
|
|
10542
|
+
"description": "Description of the action"
|
|
10543
|
+
},
|
|
10544
|
+
"billable": {
|
|
10545
|
+
"type": "boolean"
|
|
10546
|
+
},
|
|
10547
|
+
"cacheable": {
|
|
10548
|
+
"type": "boolean"
|
|
10549
|
+
},
|
|
10550
|
+
"input": {
|
|
10551
|
+
"type": "object",
|
|
10552
|
+
"properties": {
|
|
10553
|
+
"schema": {
|
|
10554
|
+
"type": "object",
|
|
10555
|
+
"additionalProperties": true
|
|
10556
|
+
}
|
|
10557
|
+
},
|
|
10558
|
+
"required": [
|
|
10559
|
+
"schema"
|
|
10560
|
+
],
|
|
10561
|
+
"additionalProperties": false
|
|
10562
|
+
},
|
|
10563
|
+
"output": {
|
|
10564
|
+
"type": "object",
|
|
10565
|
+
"properties": {
|
|
10566
|
+
"schema": {
|
|
10567
|
+
"type": "object",
|
|
10568
|
+
"additionalProperties": true
|
|
10569
|
+
}
|
|
10570
|
+
},
|
|
10571
|
+
"required": [
|
|
10572
|
+
"schema"
|
|
10573
|
+
],
|
|
10574
|
+
"additionalProperties": false
|
|
10575
|
+
}
|
|
10576
|
+
},
|
|
10577
|
+
"required": [
|
|
10578
|
+
"input",
|
|
10579
|
+
"output"
|
|
10580
|
+
],
|
|
10581
|
+
"description": "Action definition",
|
|
10582
|
+
"nullable": true,
|
|
10583
|
+
"additionalProperties": false
|
|
10584
|
+
}
|
|
10585
|
+
},
|
|
10586
|
+
"user": {
|
|
10587
|
+
"type": "object",
|
|
10588
|
+
"properties": {
|
|
10589
|
+
"tags": {
|
|
10590
|
+
"type": "object",
|
|
10591
|
+
"additionalProperties": {
|
|
10592
|
+
"type": "object",
|
|
10593
|
+
"properties": {
|
|
10594
|
+
"title": {
|
|
10595
|
+
"type": "string",
|
|
10596
|
+
"maxLength": 64,
|
|
10597
|
+
"description": "Title of the tag"
|
|
10598
|
+
},
|
|
10599
|
+
"description": {
|
|
10600
|
+
"type": "string",
|
|
10601
|
+
"maxLength": 256,
|
|
10602
|
+
"description": "Description of the tag"
|
|
10603
|
+
}
|
|
10604
|
+
},
|
|
10605
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
10606
|
+
"additionalProperties": false
|
|
10607
|
+
}
|
|
10608
|
+
}
|
|
10609
|
+
},
|
|
10610
|
+
"required": [
|
|
10611
|
+
"tags"
|
|
10612
|
+
],
|
|
10613
|
+
"description": "User object configuration",
|
|
10614
|
+
"nullable": true,
|
|
10615
|
+
"additionalProperties": false
|
|
10616
|
+
},
|
|
10617
|
+
"code": {
|
|
10618
|
+
"type": "string"
|
|
10619
|
+
}
|
|
10620
|
+
},
|
|
10621
|
+
"title": "updatePluginBody",
|
|
10622
|
+
"additionalProperties": false
|
|
10623
|
+
}
|
|
10624
|
+
},
|
|
10625
|
+
"section": "plugin",
|
|
10626
|
+
"response": {
|
|
10627
|
+
"description": "Update an plugin",
|
|
10628
|
+
"schema": {
|
|
10629
|
+
"type": "object",
|
|
10630
|
+
"properties": {
|
|
10631
|
+
"plugin": {
|
|
10632
|
+
"$ref": "#/components/schemas/Plugin"
|
|
10633
|
+
}
|
|
10634
|
+
},
|
|
10635
|
+
"required": [
|
|
10636
|
+
"plugin"
|
|
10637
|
+
],
|
|
10638
|
+
"title": "updatePluginResponse",
|
|
10639
|
+
"additionalProperties": false
|
|
10640
|
+
}
|
|
10641
|
+
}
|
|
10642
|
+
},
|
|
10643
|
+
"deletePlugin": {
|
|
10644
|
+
"name": "deletePlugin",
|
|
10645
|
+
"description": "Delete Plugin",
|
|
10646
|
+
"method": "delete",
|
|
10647
|
+
"path": "/v1/admin/plugins/{id}",
|
|
10648
|
+
"parameters": {
|
|
10649
|
+
"id": {
|
|
10650
|
+
"in": "path",
|
|
10651
|
+
"type": "string",
|
|
10652
|
+
"description": "Plugin id"
|
|
10653
|
+
}
|
|
10654
|
+
},
|
|
10655
|
+
"section": "plugin",
|
|
10656
|
+
"response": {
|
|
10657
|
+
"description": "Delete an plugin",
|
|
10658
|
+
"schema": {
|
|
10659
|
+
"type": "object",
|
|
10660
|
+
"title": "deletePluginResponse",
|
|
10661
|
+
"additionalProperties": false
|
|
10662
|
+
}
|
|
10663
|
+
}
|
|
10664
|
+
},
|
|
10665
|
+
"listPlugins": {
|
|
10666
|
+
"name": "listPlugins",
|
|
10667
|
+
"description": "List Plugins",
|
|
10668
|
+
"method": "get",
|
|
10669
|
+
"path": "/v1/admin/plugins",
|
|
10670
|
+
"section": "plugin",
|
|
10671
|
+
"parameters": {
|
|
10672
|
+
"nextToken": {
|
|
10673
|
+
"in": "query",
|
|
10674
|
+
"description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
10675
|
+
"type": "string"
|
|
10676
|
+
},
|
|
10677
|
+
"name": {
|
|
10678
|
+
"in": "query",
|
|
10679
|
+
"type": "string",
|
|
10680
|
+
"description": "Filter all versions of a plugin by name"
|
|
10681
|
+
}
|
|
10682
|
+
},
|
|
10683
|
+
"response": {
|
|
10684
|
+
"description": "List plugins",
|
|
10685
|
+
"schema": {
|
|
10686
|
+
"type": "object",
|
|
10687
|
+
"properties": {
|
|
10688
|
+
"plugins": {
|
|
10689
|
+
"type": "array",
|
|
10690
|
+
"items": {
|
|
10691
|
+
"type": "object",
|
|
10692
|
+
"properties": {
|
|
10693
|
+
"id": {
|
|
10694
|
+
"type": "string",
|
|
10695
|
+
"minLength": 28,
|
|
10696
|
+
"maxLength": 36,
|
|
10697
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
10698
|
+
},
|
|
10699
|
+
"createdAt": {
|
|
10700
|
+
"type": "string",
|
|
10701
|
+
"format": "date-time",
|
|
10702
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
10703
|
+
},
|
|
10704
|
+
"updatedAt": {
|
|
10705
|
+
"type": "string",
|
|
10706
|
+
"format": "date-time",
|
|
10707
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
10708
|
+
},
|
|
10709
|
+
"name": {
|
|
10710
|
+
"type": "string",
|
|
10711
|
+
"maxLength": 200,
|
|
10712
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
10713
|
+
},
|
|
10714
|
+
"version": {
|
|
10715
|
+
"type": "string",
|
|
10716
|
+
"maxLength": 200,
|
|
10717
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
10718
|
+
}
|
|
10719
|
+
},
|
|
10720
|
+
"required": [
|
|
10721
|
+
"id",
|
|
10722
|
+
"createdAt",
|
|
10723
|
+
"updatedAt",
|
|
10724
|
+
"name",
|
|
10725
|
+
"version"
|
|
10726
|
+
]
|
|
10727
|
+
}
|
|
10728
|
+
},
|
|
10729
|
+
"meta": {
|
|
10730
|
+
"type": "object",
|
|
10731
|
+
"properties": {
|
|
10732
|
+
"nextToken": {
|
|
10733
|
+
"type": "string",
|
|
10734
|
+
"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."
|
|
10735
|
+
}
|
|
10736
|
+
},
|
|
10737
|
+
"additionalProperties": false
|
|
10738
|
+
}
|
|
10739
|
+
},
|
|
10740
|
+
"required": [
|
|
10741
|
+
"plugins",
|
|
10742
|
+
"meta"
|
|
10743
|
+
],
|
|
10744
|
+
"title": "listPluginsResponse",
|
|
10745
|
+
"additionalProperties": false
|
|
10746
|
+
}
|
|
10747
|
+
}
|
|
10748
|
+
},
|
|
10136
10749
|
"getUsage": {
|
|
10137
10750
|
"name": "getUsage",
|
|
10138
10751
|
"path": "/v1/admin/usages/{id}",
|
|
@@ -12461,7 +13074,7 @@ export const state = {
|
|
|
12461
13074
|
"title": "Botpress API",
|
|
12462
13075
|
"description": "API for Botpress Cloud",
|
|
12463
13076
|
"server": "https://api.botpress.cloud",
|
|
12464
|
-
"version": "0.
|
|
13077
|
+
"version": "0.53.0",
|
|
12465
13078
|
"prefix": "v1"
|
|
12466
13079
|
},
|
|
12467
13080
|
"errors": [
|
|
@@ -12633,6 +13246,8 @@ export const state = {
|
|
|
12633
13246
|
"requestIntegrationVerificationBody": true,
|
|
12634
13247
|
"createInterfaceBody": true,
|
|
12635
13248
|
"updateInterfaceBody": true,
|
|
13249
|
+
"createPluginBody": true,
|
|
13250
|
+
"updatePluginBody": true,
|
|
12636
13251
|
"changeAISpendQuotaBody": true,
|
|
12637
13252
|
"introspectBody": true,
|
|
12638
13253
|
"upsertFileBody": true,
|
|
@@ -12760,6 +13375,12 @@ export const state = {
|
|
|
12760
13375
|
"updateInterfaceResponse": true,
|
|
12761
13376
|
"deleteInterfaceResponse": true,
|
|
12762
13377
|
"listInterfacesResponse": true,
|
|
13378
|
+
"createPluginResponse": true,
|
|
13379
|
+
"getPluginResponse": true,
|
|
13380
|
+
"getPluginByNameResponse": true,
|
|
13381
|
+
"updatePluginResponse": true,
|
|
13382
|
+
"deletePluginResponse": true,
|
|
13383
|
+
"listPluginsResponse": true,
|
|
12763
13384
|
"getUsageResponse": true,
|
|
12764
13385
|
"getMultipleUsagesResponse": true,
|
|
12765
13386
|
"listUsageHistoryResponse": true,
|
|
@@ -12793,6 +13414,7 @@ export const state = {
|
|
|
12793
13414
|
"Bot": true,
|
|
12794
13415
|
"Integration": true,
|
|
12795
13416
|
"Interface": true,
|
|
13417
|
+
"Plugin": true,
|
|
12796
13418
|
"Workspace": true,
|
|
12797
13419
|
"WorkspaceMember": true,
|
|
12798
13420
|
"Account": true,
|
|
@@ -14181,6 +14803,229 @@ export const state = {
|
|
|
14181
14803
|
"additionalProperties": false
|
|
14182
14804
|
}
|
|
14183
14805
|
},
|
|
14806
|
+
"Plugin": {
|
|
14807
|
+
"section": "plugin",
|
|
14808
|
+
"schema": {
|
|
14809
|
+
"type": "object",
|
|
14810
|
+
"properties": {
|
|
14811
|
+
"id": {
|
|
14812
|
+
"type": "string",
|
|
14813
|
+
"minLength": 28,
|
|
14814
|
+
"maxLength": 36,
|
|
14815
|
+
"description": "ID of the [Plugin](#schema_plugin)"
|
|
14816
|
+
},
|
|
14817
|
+
"name": {
|
|
14818
|
+
"type": "string",
|
|
14819
|
+
"maxLength": 200,
|
|
14820
|
+
"description": "Name of the [Plugin](#schema_plugin)"
|
|
14821
|
+
},
|
|
14822
|
+
"version": {
|
|
14823
|
+
"type": "string",
|
|
14824
|
+
"maxLength": 200,
|
|
14825
|
+
"description": "Version of the [Plugin](#schema_plugin)"
|
|
14826
|
+
},
|
|
14827
|
+
"createdAt": {
|
|
14828
|
+
"type": "string",
|
|
14829
|
+
"format": "date-time",
|
|
14830
|
+
"description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
14831
|
+
},
|
|
14832
|
+
"updatedAt": {
|
|
14833
|
+
"type": "string",
|
|
14834
|
+
"format": "date-time",
|
|
14835
|
+
"description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
|
|
14836
|
+
},
|
|
14837
|
+
"configuration": {
|
|
14838
|
+
"type": "object",
|
|
14839
|
+
"properties": {
|
|
14840
|
+
"title": {
|
|
14841
|
+
"type": "string",
|
|
14842
|
+
"maxLength": 64,
|
|
14843
|
+
"description": "Title of the configuration"
|
|
14844
|
+
},
|
|
14845
|
+
"description": {
|
|
14846
|
+
"type": "string",
|
|
14847
|
+
"maxLength": 256,
|
|
14848
|
+
"description": "Description of the configuration"
|
|
14849
|
+
},
|
|
14850
|
+
"schema": {
|
|
14851
|
+
"type": "object",
|
|
14852
|
+
"additionalProperties": true,
|
|
14853
|
+
"description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
|
|
14854
|
+
}
|
|
14855
|
+
},
|
|
14856
|
+
"required": [
|
|
14857
|
+
"schema"
|
|
14858
|
+
],
|
|
14859
|
+
"description": "Configuration definition",
|
|
14860
|
+
"additionalProperties": false
|
|
14861
|
+
},
|
|
14862
|
+
"states": {
|
|
14863
|
+
"type": "object",
|
|
14864
|
+
"additionalProperties": {
|
|
14865
|
+
"type": "object",
|
|
14866
|
+
"properties": {
|
|
14867
|
+
"type": {
|
|
14868
|
+
"type": "string",
|
|
14869
|
+
"enum": [
|
|
14870
|
+
"conversation",
|
|
14871
|
+
"user",
|
|
14872
|
+
"bot",
|
|
14873
|
+
"task"
|
|
14874
|
+
],
|
|
14875
|
+
"description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
|
|
14876
|
+
},
|
|
14877
|
+
"schema": {
|
|
14878
|
+
"type": "object",
|
|
14879
|
+
"additionalProperties": true,
|
|
14880
|
+
"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."
|
|
14881
|
+
},
|
|
14882
|
+
"expiry": {
|
|
14883
|
+
"type": "number",
|
|
14884
|
+
"minimum": 1,
|
|
14885
|
+
"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."
|
|
14886
|
+
}
|
|
14887
|
+
},
|
|
14888
|
+
"required": [
|
|
14889
|
+
"type",
|
|
14890
|
+
"schema"
|
|
14891
|
+
],
|
|
14892
|
+
"additionalProperties": false
|
|
14893
|
+
}
|
|
14894
|
+
},
|
|
14895
|
+
"events": {
|
|
14896
|
+
"type": "object",
|
|
14897
|
+
"additionalProperties": {
|
|
14898
|
+
"type": "object",
|
|
14899
|
+
"properties": {
|
|
14900
|
+
"title": {
|
|
14901
|
+
"type": "string",
|
|
14902
|
+
"maxLength": 64,
|
|
14903
|
+
"description": "Title of the event"
|
|
14904
|
+
},
|
|
14905
|
+
"description": {
|
|
14906
|
+
"type": "string",
|
|
14907
|
+
"maxLength": 256,
|
|
14908
|
+
"description": "Description of the event"
|
|
14909
|
+
},
|
|
14910
|
+
"schema": {
|
|
14911
|
+
"type": "object",
|
|
14912
|
+
"additionalProperties": true
|
|
14913
|
+
}
|
|
14914
|
+
},
|
|
14915
|
+
"required": [
|
|
14916
|
+
"schema"
|
|
14917
|
+
],
|
|
14918
|
+
"description": "Event Definition",
|
|
14919
|
+
"additionalProperties": false
|
|
14920
|
+
}
|
|
14921
|
+
},
|
|
14922
|
+
"actions": {
|
|
14923
|
+
"type": "object",
|
|
14924
|
+
"additionalProperties": {
|
|
14925
|
+
"type": "object",
|
|
14926
|
+
"properties": {
|
|
14927
|
+
"title": {
|
|
14928
|
+
"type": "string",
|
|
14929
|
+
"maxLength": 64,
|
|
14930
|
+
"description": "Title of the action"
|
|
14931
|
+
},
|
|
14932
|
+
"description": {
|
|
14933
|
+
"type": "string",
|
|
14934
|
+
"maxLength": 256,
|
|
14935
|
+
"description": "Description of the action"
|
|
14936
|
+
},
|
|
14937
|
+
"billable": {
|
|
14938
|
+
"type": "boolean"
|
|
14939
|
+
},
|
|
14940
|
+
"cacheable": {
|
|
14941
|
+
"type": "boolean"
|
|
14942
|
+
},
|
|
14943
|
+
"input": {
|
|
14944
|
+
"type": "object",
|
|
14945
|
+
"properties": {
|
|
14946
|
+
"schema": {
|
|
14947
|
+
"type": "object",
|
|
14948
|
+
"additionalProperties": true
|
|
14949
|
+
}
|
|
14950
|
+
},
|
|
14951
|
+
"required": [
|
|
14952
|
+
"schema"
|
|
14953
|
+
],
|
|
14954
|
+
"additionalProperties": false
|
|
14955
|
+
},
|
|
14956
|
+
"output": {
|
|
14957
|
+
"type": "object",
|
|
14958
|
+
"properties": {
|
|
14959
|
+
"schema": {
|
|
14960
|
+
"type": "object",
|
|
14961
|
+
"additionalProperties": true
|
|
14962
|
+
}
|
|
14963
|
+
},
|
|
14964
|
+
"required": [
|
|
14965
|
+
"schema"
|
|
14966
|
+
],
|
|
14967
|
+
"additionalProperties": false
|
|
14968
|
+
}
|
|
14969
|
+
},
|
|
14970
|
+
"required": [
|
|
14971
|
+
"input",
|
|
14972
|
+
"output"
|
|
14973
|
+
],
|
|
14974
|
+
"description": "Action definition",
|
|
14975
|
+
"additionalProperties": false
|
|
14976
|
+
}
|
|
14977
|
+
},
|
|
14978
|
+
"user": {
|
|
14979
|
+
"type": "object",
|
|
14980
|
+
"properties": {
|
|
14981
|
+
"tags": {
|
|
14982
|
+
"type": "object",
|
|
14983
|
+
"additionalProperties": {
|
|
14984
|
+
"type": "object",
|
|
14985
|
+
"properties": {
|
|
14986
|
+
"title": {
|
|
14987
|
+
"type": "string",
|
|
14988
|
+
"maxLength": 64,
|
|
14989
|
+
"description": "Title of the tag"
|
|
14990
|
+
},
|
|
14991
|
+
"description": {
|
|
14992
|
+
"type": "string",
|
|
14993
|
+
"maxLength": 256,
|
|
14994
|
+
"description": "Description of the tag"
|
|
14995
|
+
}
|
|
14996
|
+
},
|
|
14997
|
+
"description": "Definition of a tag that can be provided on the object",
|
|
14998
|
+
"additionalProperties": false
|
|
14999
|
+
}
|
|
15000
|
+
}
|
|
15001
|
+
},
|
|
15002
|
+
"required": [
|
|
15003
|
+
"tags"
|
|
15004
|
+
],
|
|
15005
|
+
"description": "User object configuration",
|
|
15006
|
+
"additionalProperties": false
|
|
15007
|
+
},
|
|
15008
|
+
"code": {
|
|
15009
|
+
"type": "string"
|
|
15010
|
+
}
|
|
15011
|
+
},
|
|
15012
|
+
"required": [
|
|
15013
|
+
"id",
|
|
15014
|
+
"name",
|
|
15015
|
+
"version",
|
|
15016
|
+
"createdAt",
|
|
15017
|
+
"updatedAt",
|
|
15018
|
+
"configuration",
|
|
15019
|
+
"states",
|
|
15020
|
+
"events",
|
|
15021
|
+
"actions",
|
|
15022
|
+
"user",
|
|
15023
|
+
"code"
|
|
15024
|
+
],
|
|
15025
|
+
"description": "Plugin definition",
|
|
15026
|
+
"additionalProperties": false
|
|
15027
|
+
}
|
|
15028
|
+
},
|
|
14184
15029
|
"Workspace": {
|
|
14185
15030
|
"section": "workspace",
|
|
14186
15031
|
"schema": {
|
|
@@ -15838,6 +16683,20 @@ export const state = {
|
|
|
15838
16683
|
],
|
|
15839
16684
|
"schema": "Interface"
|
|
15840
16685
|
},
|
|
16686
|
+
{
|
|
16687
|
+
"title": "Plugin",
|
|
16688
|
+
"description": "",
|
|
16689
|
+
"name": "plugin",
|
|
16690
|
+
"operations": [
|
|
16691
|
+
"createPlugin",
|
|
16692
|
+
"getPlugin",
|
|
16693
|
+
"getPluginByName",
|
|
16694
|
+
"updatePlugin",
|
|
16695
|
+
"deletePlugin",
|
|
16696
|
+
"listPlugins"
|
|
16697
|
+
],
|
|
16698
|
+
"schema": "Plugin"
|
|
16699
|
+
},
|
|
15841
16700
|
{
|
|
15842
16701
|
"title": "Workspace",
|
|
15843
16702
|
"description": "",
|