@botpress/api 0.52.0 → 0.54.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/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}",
@@ -11852,10 +12465,320 @@ export const state = {
11852
12465
  }
11853
12466
  },
11854
12467
  "required": [
11855
- "table",
11856
- "rows"
12468
+ "table",
12469
+ "rows"
12470
+ ],
12471
+ "title": "duplicateTableResponse",
12472
+ "additionalProperties": false
12473
+ }
12474
+ }
12475
+ },
12476
+ "exportTable": {
12477
+ "name": "exportTable",
12478
+ "path": "/v1/tables/{table}/export",
12479
+ "description": "Starts an export job for the table",
12480
+ "parameters": {
12481
+ "table": {
12482
+ "type": "string",
12483
+ "description": "The table's unique identifier",
12484
+ "in": "path"
12485
+ },
12486
+ "format": {
12487
+ "in": "query",
12488
+ "type": "object",
12489
+ "description": "The format of the exported file. CSV includes only the data while JSON includes the schema.",
12490
+ "schema": {
12491
+ "type": "string",
12492
+ "enum": [
12493
+ "csv",
12494
+ "json"
12495
+ ]
12496
+ }
12497
+ },
12498
+ "compress": {
12499
+ "in": "query",
12500
+ "type": "object",
12501
+ "description": "Whether or not the export is compressed (gzipped).",
12502
+ "schema": {
12503
+ "default": true,
12504
+ "type": "boolean"
12505
+ }
12506
+ }
12507
+ },
12508
+ "method": "get",
12509
+ "section": "tables",
12510
+ "response": {
12511
+ "description": "The export job",
12512
+ "schema": {
12513
+ "type": "object",
12514
+ "properties": {
12515
+ "job": {
12516
+ "type": "object",
12517
+ "properties": {
12518
+ "id": {
12519
+ "type": "string"
12520
+ },
12521
+ "botId": {
12522
+ "type": "string"
12523
+ },
12524
+ "tableId": {
12525
+ "type": "string"
12526
+ },
12527
+ "type": {
12528
+ "type": "string",
12529
+ "enum": [
12530
+ "export",
12531
+ "import"
12532
+ ]
12533
+ },
12534
+ "status": {
12535
+ "type": "string",
12536
+ "enum": [
12537
+ "pending",
12538
+ "in_progress",
12539
+ "finalizing",
12540
+ "completed",
12541
+ "failed"
12542
+ ]
12543
+ },
12544
+ "progress": {
12545
+ "default": 0,
12546
+ "type": "number"
12547
+ },
12548
+ "inputFileId": {
12549
+ "type": "string",
12550
+ "nullable": true
12551
+ },
12552
+ "outputFileId": {
12553
+ "type": "string",
12554
+ "nullable": true
12555
+ },
12556
+ "createdAt": {
12557
+ "type": "string",
12558
+ "format": "date-time"
12559
+ },
12560
+ "updatedAt": {
12561
+ "type": "string",
12562
+ "format": "date-time"
12563
+ }
12564
+ },
12565
+ "required": [
12566
+ "id",
12567
+ "botId",
12568
+ "tableId",
12569
+ "type",
12570
+ "status",
12571
+ "inputFileId",
12572
+ "outputFileId",
12573
+ "createdAt",
12574
+ "updatedAt"
12575
+ ],
12576
+ "additionalProperties": false
12577
+ }
12578
+ },
12579
+ "required": [
12580
+ "job"
12581
+ ],
12582
+ "title": "exportTableResponse",
12583
+ "additionalProperties": false
12584
+ }
12585
+ }
12586
+ },
12587
+ "getTableJobs": {
12588
+ "name": "getTableJobs",
12589
+ "path": "/v1/tables/{table}/jobs",
12590
+ "description": "Returns a list of recent jobs for the table (export/import operations)",
12591
+ "parameters": {
12592
+ "table": {
12593
+ "type": "string",
12594
+ "description": "The table's unique identifier",
12595
+ "in": "path"
12596
+ }
12597
+ },
12598
+ "method": "get",
12599
+ "section": "tables",
12600
+ "response": {
12601
+ "description": "The most recent jobs",
12602
+ "schema": {
12603
+ "type": "object",
12604
+ "properties": {
12605
+ "jobs": {
12606
+ "type": "array",
12607
+ "items": {
12608
+ "type": "object",
12609
+ "properties": {
12610
+ "id": {
12611
+ "type": "string"
12612
+ },
12613
+ "botId": {
12614
+ "type": "string"
12615
+ },
12616
+ "tableId": {
12617
+ "type": "string"
12618
+ },
12619
+ "type": {
12620
+ "type": "string",
12621
+ "enum": [
12622
+ "export",
12623
+ "import"
12624
+ ]
12625
+ },
12626
+ "status": {
12627
+ "type": "string",
12628
+ "enum": [
12629
+ "pending",
12630
+ "in_progress",
12631
+ "finalizing",
12632
+ "completed",
12633
+ "failed"
12634
+ ]
12635
+ },
12636
+ "progress": {
12637
+ "default": 0,
12638
+ "type": "number"
12639
+ },
12640
+ "inputFileId": {
12641
+ "type": "string",
12642
+ "nullable": true
12643
+ },
12644
+ "outputFileId": {
12645
+ "type": "string",
12646
+ "nullable": true
12647
+ },
12648
+ "createdAt": {
12649
+ "type": "string",
12650
+ "format": "date-time"
12651
+ },
12652
+ "updatedAt": {
12653
+ "type": "string",
12654
+ "format": "date-time"
12655
+ }
12656
+ },
12657
+ "required": [
12658
+ "id",
12659
+ "botId",
12660
+ "tableId",
12661
+ "type",
12662
+ "status",
12663
+ "inputFileId",
12664
+ "outputFileId",
12665
+ "createdAt",
12666
+ "updatedAt"
12667
+ ]
12668
+ }
12669
+ }
12670
+ },
12671
+ "required": [
12672
+ "jobs"
12673
+ ],
12674
+ "title": "getTableJobsResponse",
12675
+ "additionalProperties": false
12676
+ }
12677
+ }
12678
+ },
12679
+ "importTable": {
12680
+ "name": "importTable",
12681
+ "path": "/v1/tables/{table}/import",
12682
+ "description": "Import the content of a file into a table. The table must already have been created with the correct schema. Data already in the table will be kept.",
12683
+ "method": "post",
12684
+ "parameters": {
12685
+ "table": {
12686
+ "type": "string",
12687
+ "description": "The table's name or unique identifier for targeting specific table operations.",
12688
+ "in": "path"
12689
+ }
12690
+ },
12691
+ "requestBody": {
12692
+ "description": "Content to import",
12693
+ "schema": {
12694
+ "type": "object",
12695
+ "properties": {
12696
+ "fileId": {
12697
+ "type": "string",
12698
+ "description": "The file ID to import. It must have been uploaded to the Files API before. Supported formats: CSV, JSON (gzipped or not)"
12699
+ }
12700
+ },
12701
+ "required": [
12702
+ "fileId"
12703
+ ],
12704
+ "title": "importTableBody",
12705
+ "additionalProperties": false
12706
+ }
12707
+ },
12708
+ "section": "tables",
12709
+ "response": {
12710
+ "description": "The import job",
12711
+ "schema": {
12712
+ "type": "object",
12713
+ "properties": {
12714
+ "job": {
12715
+ "type": "object",
12716
+ "properties": {
12717
+ "id": {
12718
+ "type": "string"
12719
+ },
12720
+ "botId": {
12721
+ "type": "string"
12722
+ },
12723
+ "tableId": {
12724
+ "type": "string"
12725
+ },
12726
+ "type": {
12727
+ "type": "string",
12728
+ "enum": [
12729
+ "export",
12730
+ "import"
12731
+ ]
12732
+ },
12733
+ "status": {
12734
+ "type": "string",
12735
+ "enum": [
12736
+ "pending",
12737
+ "in_progress",
12738
+ "finalizing",
12739
+ "completed",
12740
+ "failed"
12741
+ ]
12742
+ },
12743
+ "progress": {
12744
+ "default": 0,
12745
+ "type": "number"
12746
+ },
12747
+ "inputFileId": {
12748
+ "type": "string",
12749
+ "nullable": true
12750
+ },
12751
+ "outputFileId": {
12752
+ "type": "string",
12753
+ "nullable": true
12754
+ },
12755
+ "createdAt": {
12756
+ "type": "string",
12757
+ "format": "date-time"
12758
+ },
12759
+ "updatedAt": {
12760
+ "type": "string",
12761
+ "format": "date-time"
12762
+ }
12763
+ },
12764
+ "required": [
12765
+ "id",
12766
+ "botId",
12767
+ "tableId",
12768
+ "type",
12769
+ "status",
12770
+ "inputFileId",
12771
+ "outputFileId",
12772
+ "createdAt",
12773
+ "updatedAt"
12774
+ ],
12775
+ "additionalProperties": false
12776
+ }
12777
+ },
12778
+ "required": [
12779
+ "job"
11857
12780
  ],
11858
- "title": "duplicateTableResponse",
12781
+ "title": "importTableResponse",
11859
12782
  "additionalProperties": false
11860
12783
  }
11861
12784
  }
@@ -12461,7 +13384,7 @@ export const state = {
12461
13384
  "title": "Botpress API",
12462
13385
  "description": "API for Botpress Cloud",
12463
13386
  "server": "https://api.botpress.cloud",
12464
- "version": "0.52.0",
13387
+ "version": "0.54.0",
12465
13388
  "prefix": "v1"
12466
13389
  },
12467
13390
  "errors": [
@@ -12633,6 +13556,8 @@ export const state = {
12633
13556
  "requestIntegrationVerificationBody": true,
12634
13557
  "createInterfaceBody": true,
12635
13558
  "updateInterfaceBody": true,
13559
+ "createPluginBody": true,
13560
+ "updatePluginBody": true,
12636
13561
  "changeAISpendQuotaBody": true,
12637
13562
  "introspectBody": true,
12638
13563
  "upsertFileBody": true,
@@ -12640,6 +13565,7 @@ export const state = {
12640
13565
  "getOrCreateTableBody": true,
12641
13566
  "createTableBody": true,
12642
13567
  "duplicateTableBody": true,
13568
+ "importTableBody": true,
12643
13569
  "updateTableBody": true,
12644
13570
  "renameTableColumnBody": true,
12645
13571
  "findTableRowsBody": true,
@@ -12760,6 +13686,12 @@ export const state = {
12760
13686
  "updateInterfaceResponse": true,
12761
13687
  "deleteInterfaceResponse": true,
12762
13688
  "listInterfacesResponse": true,
13689
+ "createPluginResponse": true,
13690
+ "getPluginResponse": true,
13691
+ "getPluginByNameResponse": true,
13692
+ "updatePluginResponse": true,
13693
+ "deletePluginResponse": true,
13694
+ "listPluginsResponse": true,
12763
13695
  "getUsageResponse": true,
12764
13696
  "getMultipleUsagesResponse": true,
12765
13697
  "listUsageHistoryResponse": true,
@@ -12779,6 +13711,9 @@ export const state = {
12779
13711
  "getOrCreateTableResponse": true,
12780
13712
  "createTableResponse": true,
12781
13713
  "duplicateTableResponse": true,
13714
+ "exportTableResponse": true,
13715
+ "getTableJobsResponse": true,
13716
+ "importTableResponse": true,
12782
13717
  "updateTableResponse": true,
12783
13718
  "renameTableColumnResponse": true,
12784
13719
  "deleteTableResponse": true,
@@ -12793,6 +13728,7 @@ export const state = {
12793
13728
  "Bot": true,
12794
13729
  "Integration": true,
12795
13730
  "Interface": true,
13731
+ "Plugin": true,
12796
13732
  "Workspace": true,
12797
13733
  "WorkspaceMember": true,
12798
13734
  "Account": true,
@@ -14181,6 +15117,229 @@ export const state = {
14181
15117
  "additionalProperties": false
14182
15118
  }
14183
15119
  },
15120
+ "Plugin": {
15121
+ "section": "plugin",
15122
+ "schema": {
15123
+ "type": "object",
15124
+ "properties": {
15125
+ "id": {
15126
+ "type": "string",
15127
+ "minLength": 28,
15128
+ "maxLength": 36,
15129
+ "description": "ID of the [Plugin](#schema_plugin)"
15130
+ },
15131
+ "name": {
15132
+ "type": "string",
15133
+ "maxLength": 200,
15134
+ "description": "Name of the [Plugin](#schema_plugin)"
15135
+ },
15136
+ "version": {
15137
+ "type": "string",
15138
+ "maxLength": 200,
15139
+ "description": "Version of the [Plugin](#schema_plugin)"
15140
+ },
15141
+ "createdAt": {
15142
+ "type": "string",
15143
+ "format": "date-time",
15144
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
15145
+ },
15146
+ "updatedAt": {
15147
+ "type": "string",
15148
+ "format": "date-time",
15149
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
15150
+ },
15151
+ "configuration": {
15152
+ "type": "object",
15153
+ "properties": {
15154
+ "title": {
15155
+ "type": "string",
15156
+ "maxLength": 64,
15157
+ "description": "Title of the configuration"
15158
+ },
15159
+ "description": {
15160
+ "type": "string",
15161
+ "maxLength": 256,
15162
+ "description": "Description of the configuration"
15163
+ },
15164
+ "schema": {
15165
+ "type": "object",
15166
+ "additionalProperties": true,
15167
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
15168
+ }
15169
+ },
15170
+ "required": [
15171
+ "schema"
15172
+ ],
15173
+ "description": "Configuration definition",
15174
+ "additionalProperties": false
15175
+ },
15176
+ "states": {
15177
+ "type": "object",
15178
+ "additionalProperties": {
15179
+ "type": "object",
15180
+ "properties": {
15181
+ "type": {
15182
+ "type": "string",
15183
+ "enum": [
15184
+ "conversation",
15185
+ "user",
15186
+ "bot",
15187
+ "task"
15188
+ ],
15189
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
15190
+ },
15191
+ "schema": {
15192
+ "type": "object",
15193
+ "additionalProperties": true,
15194
+ "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."
15195
+ },
15196
+ "expiry": {
15197
+ "type": "number",
15198
+ "minimum": 1,
15199
+ "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."
15200
+ }
15201
+ },
15202
+ "required": [
15203
+ "type",
15204
+ "schema"
15205
+ ],
15206
+ "additionalProperties": false
15207
+ }
15208
+ },
15209
+ "events": {
15210
+ "type": "object",
15211
+ "additionalProperties": {
15212
+ "type": "object",
15213
+ "properties": {
15214
+ "title": {
15215
+ "type": "string",
15216
+ "maxLength": 64,
15217
+ "description": "Title of the event"
15218
+ },
15219
+ "description": {
15220
+ "type": "string",
15221
+ "maxLength": 256,
15222
+ "description": "Description of the event"
15223
+ },
15224
+ "schema": {
15225
+ "type": "object",
15226
+ "additionalProperties": true
15227
+ }
15228
+ },
15229
+ "required": [
15230
+ "schema"
15231
+ ],
15232
+ "description": "Event Definition",
15233
+ "additionalProperties": false
15234
+ }
15235
+ },
15236
+ "actions": {
15237
+ "type": "object",
15238
+ "additionalProperties": {
15239
+ "type": "object",
15240
+ "properties": {
15241
+ "title": {
15242
+ "type": "string",
15243
+ "maxLength": 64,
15244
+ "description": "Title of the action"
15245
+ },
15246
+ "description": {
15247
+ "type": "string",
15248
+ "maxLength": 256,
15249
+ "description": "Description of the action"
15250
+ },
15251
+ "billable": {
15252
+ "type": "boolean"
15253
+ },
15254
+ "cacheable": {
15255
+ "type": "boolean"
15256
+ },
15257
+ "input": {
15258
+ "type": "object",
15259
+ "properties": {
15260
+ "schema": {
15261
+ "type": "object",
15262
+ "additionalProperties": true
15263
+ }
15264
+ },
15265
+ "required": [
15266
+ "schema"
15267
+ ],
15268
+ "additionalProperties": false
15269
+ },
15270
+ "output": {
15271
+ "type": "object",
15272
+ "properties": {
15273
+ "schema": {
15274
+ "type": "object",
15275
+ "additionalProperties": true
15276
+ }
15277
+ },
15278
+ "required": [
15279
+ "schema"
15280
+ ],
15281
+ "additionalProperties": false
15282
+ }
15283
+ },
15284
+ "required": [
15285
+ "input",
15286
+ "output"
15287
+ ],
15288
+ "description": "Action definition",
15289
+ "additionalProperties": false
15290
+ }
15291
+ },
15292
+ "user": {
15293
+ "type": "object",
15294
+ "properties": {
15295
+ "tags": {
15296
+ "type": "object",
15297
+ "additionalProperties": {
15298
+ "type": "object",
15299
+ "properties": {
15300
+ "title": {
15301
+ "type": "string",
15302
+ "maxLength": 64,
15303
+ "description": "Title of the tag"
15304
+ },
15305
+ "description": {
15306
+ "type": "string",
15307
+ "maxLength": 256,
15308
+ "description": "Description of the tag"
15309
+ }
15310
+ },
15311
+ "description": "Definition of a tag that can be provided on the object",
15312
+ "additionalProperties": false
15313
+ }
15314
+ }
15315
+ },
15316
+ "required": [
15317
+ "tags"
15318
+ ],
15319
+ "description": "User object configuration",
15320
+ "additionalProperties": false
15321
+ },
15322
+ "code": {
15323
+ "type": "string"
15324
+ }
15325
+ },
15326
+ "required": [
15327
+ "id",
15328
+ "name",
15329
+ "version",
15330
+ "createdAt",
15331
+ "updatedAt",
15332
+ "configuration",
15333
+ "states",
15334
+ "events",
15335
+ "actions",
15336
+ "user",
15337
+ "code"
15338
+ ],
15339
+ "description": "Plugin definition",
15340
+ "additionalProperties": false
15341
+ }
15342
+ },
14184
15343
  "Workspace": {
14185
15344
  "section": "workspace",
14186
15345
  "schema": {
@@ -15361,7 +16520,6 @@ export const state = {
15361
16520
  }
15362
16521
  },
15363
16522
  "required": [
15364
- "$schema",
15365
16523
  "properties",
15366
16524
  "additionalProperties",
15367
16525
  "type"
@@ -15838,6 +16996,20 @@ export const state = {
15838
16996
  ],
15839
16997
  "schema": "Interface"
15840
16998
  },
16999
+ {
17000
+ "title": "Plugin",
17001
+ "description": "",
17002
+ "name": "plugin",
17003
+ "operations": [
17004
+ "createPlugin",
17005
+ "getPlugin",
17006
+ "getPluginByName",
17007
+ "updatePlugin",
17008
+ "deletePlugin",
17009
+ "listPlugins"
17010
+ ],
17011
+ "schema": "Plugin"
17012
+ },
15841
17013
  {
15842
17014
  "title": "Workspace",
15843
17015
  "description": "",
@@ -15936,6 +17108,9 @@ export const state = {
15936
17108
  "getOrCreateTable",
15937
17109
  "createTable",
15938
17110
  "duplicateTable",
17111
+ "exportTable",
17112
+ "getTableJobs",
17113
+ "importTable",
15939
17114
  "updateTable",
15940
17115
  "renameTableColumn",
15941
17116
  "deleteTable",