@botpress/api 0.53.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.
Files changed (6) hide show
  1. package/dist/index.js +318 -2
  2. package/dist/src/gen/state.d.ts +246 -0
  3. package/package.json +1 -1
  4. package/src/gen/metadata.json +1 -1
  5. package/src/gen/openapi.json +1 -1
  6. package/src/gen/state.ts +318 -2
package/src/gen/state.ts CHANGED
@@ -12473,6 +12473,316 @@ export const state = {
12473
12473
  }
12474
12474
  }
12475
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"
12780
+ ],
12781
+ "title": "importTableResponse",
12782
+ "additionalProperties": false
12783
+ }
12784
+ }
12785
+ },
12476
12786
  "updateTable": {
12477
12787
  "name": "updateTable",
12478
12788
  "path": "/v1/tables/{table}",
@@ -13074,7 +13384,7 @@ export const state = {
13074
13384
  "title": "Botpress API",
13075
13385
  "description": "API for Botpress Cloud",
13076
13386
  "server": "https://api.botpress.cloud",
13077
- "version": "0.53.0",
13387
+ "version": "0.54.0",
13078
13388
  "prefix": "v1"
13079
13389
  },
13080
13390
  "errors": [
@@ -13255,6 +13565,7 @@ export const state = {
13255
13565
  "getOrCreateTableBody": true,
13256
13566
  "createTableBody": true,
13257
13567
  "duplicateTableBody": true,
13568
+ "importTableBody": true,
13258
13569
  "updateTableBody": true,
13259
13570
  "renameTableColumnBody": true,
13260
13571
  "findTableRowsBody": true,
@@ -13400,6 +13711,9 @@ export const state = {
13400
13711
  "getOrCreateTableResponse": true,
13401
13712
  "createTableResponse": true,
13402
13713
  "duplicateTableResponse": true,
13714
+ "exportTableResponse": true,
13715
+ "getTableJobsResponse": true,
13716
+ "importTableResponse": true,
13403
13717
  "updateTableResponse": true,
13404
13718
  "renameTableColumnResponse": true,
13405
13719
  "deleteTableResponse": true,
@@ -16206,7 +16520,6 @@ export const state = {
16206
16520
  }
16207
16521
  },
16208
16522
  "required": [
16209
- "$schema",
16210
16523
  "properties",
16211
16524
  "additionalProperties",
16212
16525
  "type"
@@ -16795,6 +17108,9 @@ export const state = {
16795
17108
  "getOrCreateTable",
16796
17109
  "createTable",
16797
17110
  "duplicateTable",
17111
+ "exportTable",
17112
+ "getTableJobs",
17113
+ "importTable",
16798
17114
  "updateTable",
16799
17115
  "renameTableColumn",
16800
17116
  "deleteTable",