@botpress/api 0.53.0 → 0.54.0

package/dist/index.js

@@ -294210,6 +294210,316 @@ var state = {
         }
       }
     },
+    "exportTable": {
+      "name": "exportTable",
+      "path": "/v1/tables/{table}/export",
+      "description": "Starts an export job for the table",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's unique identifier",
+          "in": "path"
+        },
+        "format": {
+          "in": "query",
+          "type": "object",
+          "description": "The format of the exported file. CSV includes only the data while JSON includes the schema.",
+          "schema": {
+            "type": "string",
+            "enum": [
+              "csv",
+              "json"
+            ]
+          }
+        },
+        "compress": {
+          "in": "query",
+          "type": "object",
+          "description": "Whether or not the export is compressed (gzipped).",
+          "schema": {
+            "default": true,
+            "type": "boolean"
+          }
+        }
+      },
+      "method": "get",
+      "section": "tables",
+      "response": {
+        "description": "The export job",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "job": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "tableId": {
+                  "type": "string"
+                },
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "export",
+                    "import"
+                  ]
+                },
+                "status": {
+                  "type": "string",
+                  "enum": [
+                    "pending",
+                    "in_progress",
+                    "finalizing",
+                    "completed",
+                    "failed"
+                  ]
+                },
+                "progress": {
+                  "default": 0,
+                  "type": "number"
+                },
+                "inputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "outputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "createdAt": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "updatedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "tableId",
+                "type",
+                "status",
+                "inputFileId",
+                "outputFileId",
+                "createdAt",
+                "updatedAt"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "job"
+          ],
+          "title": "exportTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getTableJobs": {
+      "name": "getTableJobs",
+      "path": "/v1/tables/{table}/jobs",
+      "description": "Returns a list of recent jobs for the table (export/import operations)",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's unique identifier",
+          "in": "path"
+        }
+      },
+      "method": "get",
+      "section": "tables",
+      "response": {
+        "description": "The most recent jobs",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "jobs": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "botId": {
+                    "type": "string"
+                  },
+                  "tableId": {
+                    "type": "string"
+                  },
+                  "type": {
+                    "type": "string",
+                    "enum": [
+                      "export",
+                      "import"
+                    ]
+                  },
+                  "status": {
+                    "type": "string",
+                    "enum": [
+                      "pending",
+                      "in_progress",
+                      "finalizing",
+                      "completed",
+                      "failed"
+                    ]
+                  },
+                  "progress": {
+                    "default": 0,
+                    "type": "number"
+                  },
+                  "inputFileId": {
+                    "type": "string",
+                    "nullable": true
+                  },
+                  "outputFileId": {
+                    "type": "string",
+                    "nullable": true
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  "updatedAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  }
+                },
+                "required": [
+                  "id",
+                  "botId",
+                  "tableId",
+                  "type",
+                  "status",
+                  "inputFileId",
+                  "outputFileId",
+                  "createdAt",
+                  "updatedAt"
+                ]
+              }
+            }
+          },
+          "required": [
+            "jobs"
+          ],
+          "title": "getTableJobsResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "importTable": {
+      "name": "importTable",
+      "path": "/v1/tables/{table}/import",
+      "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.",
+      "method": "post",
+      "parameters": {
+        "table": {
+          "type": "string",
+          "description": "The table's name or unique identifier for targeting specific table operations.",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Content to import",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "fileId": {
+              "type": "string",
+              "description": "The file ID to import. It must have been uploaded to the Files API before. Supported formats: CSV, JSON (gzipped or not)"
+            }
+          },
+          "required": [
+            "fileId"
+          ],
+          "title": "importTableBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "tables",
+      "response": {
+        "description": "The import job",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "job": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "tableId": {
+                  "type": "string"
+                },
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "export",
+                    "import"
+                  ]
+                },
+                "status": {
+                  "type": "string",
+                  "enum": [
+                    "pending",
+                    "in_progress",
+                    "finalizing",
+                    "completed",
+                    "failed"
+                  ]
+                },
+                "progress": {
+                  "default": 0,
+                  "type": "number"
+                },
+                "inputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "outputFileId": {
+                  "type": "string",
+                  "nullable": true
+                },
+                "createdAt": {
+                  "type": "string",
+                  "format": "date-time"
+                },
+                "updatedAt": {
+                  "type": "string",
+                  "format": "date-time"
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "tableId",
+                "type",
+                "status",
+                "inputFileId",
+                "outputFileId",
+                "createdAt",
+                "updatedAt"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "job"
+          ],
+          "title": "importTableResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "updateTable": {
       "name": "updateTable",
       "path": "/v1/tables/{table}",
@@ -294811,7 +295121,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.53.0",
+    "version": "0.54.0",
     "prefix": "v1"
   },
   "errors": [
@@ -294992,6 +295302,7 @@ var state = {
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
+      "importTableBody": true,
       "updateTableBody": true,
       "renameTableColumnBody": true,
       "findTableRowsBody": true,
@@ -295137,6 +295448,9 @@ var state = {
       "getOrCreateTableResponse": true,
       "createTableResponse": true,
       "duplicateTableResponse": true,
+      "exportTableResponse": true,
+      "getTableJobsResponse": true,
+      "importTableResponse": true,
       "updateTableResponse": true,
       "renameTableColumnResponse": true,
       "deleteTableResponse": true,
@@ -297943,7 +298257,6 @@ var state = {
               }
             },
             "required": [
-              "$schema",
               "properties",
               "additionalProperties",
               "type"
@@ -298532,6 +298845,9 @@ var state = {
         "getOrCreateTable",
         "createTable",
         "duplicateTable",
+        "exportTable",
+        "getTableJobs",
+        "importTable",
         "updateTable",
         "renameTableColumn",
         "deleteTable",

package/dist/src/gen/state.d.ts

@@ -10938,6 +10938,248 @@ export declare const state: {
                 };
             };
         };
+        exportTable: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                format: {
+                    in: "query";
+                    type: "object";
+                    description: string;
+                    schema: {
+                        type: "string";
+                        enum: string[];
+                    };
+                };
+                compress: {
+                    in: "query";
+                    type: "object";
+                    description: string;
+                    schema: {
+                        default: boolean;
+                        type: "boolean";
+                    };
+                };
+            };
+            method: "get";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        job: {
+                            type: "object";
+                            properties: {
+                                id: {
+                                    type: "string";
+                                };
+                                botId: {
+                                    type: "string";
+                                };
+                                tableId: {
+                                    type: "string";
+                                };
+                                type: {
+                                    type: "string";
+                                    enum: string[];
+                                };
+                                status: {
+                                    type: "string";
+                                    enum: string[];
+                                };
+                                progress: {
+                                    default: number;
+                                    type: "number";
+                                };
+                                inputFileId: {
+                                    type: "string";
+                                    nullable: true;
+                                };
+                                outputFileId: {
+                                    type: "string";
+                                    nullable: true;
+                                };
+                                createdAt: {
+                                    type: "string";
+                                    format: string;
+                                };
+                                updatedAt: {
+                                    type: "string";
+                                    format: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getTableJobs: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            method: "get";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        jobs: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    botId: {
+                                        type: "string";
+                                    };
+                                    tableId: {
+                                        type: "string";
+                                    };
+                                    type: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
+                                    status: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
+                                    progress: {
+                                        default: number;
+                                        type: "number";
+                                    };
+                                    inputFileId: {
+                                        type: "string";
+                                        nullable: true;
+                                    };
+                                    outputFileId: {
+                                        type: "string";
+                                        nullable: true;
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    updatedAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        importTable: {
+            name: string;
+            path: string;
+            description: string;
+            method: "post";
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        fileId: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        job: {
+                            type: "object";
+                            properties: {
+                                id: {
+                                    type: "string";
+                                };
+                                botId: {
+                                    type: "string";
+                                };
+                                tableId: {
+                                    type: "string";
+                                };
+                                type: {
+                                    type: "string";
+                                    enum: string[];
+                                };
+                                status: {
+                                    type: "string";
+                                    enum: string[];
+                                };
+                                progress: {
+                                    default: number;
+                                    type: "number";
+                                };
+                                inputFileId: {
+                                    type: "string";
+                                    nullable: true;
+                                };
+                                outputFileId: {
+                                    type: "string";
+                                    nullable: true;
+                                };
+                                createdAt: {
+                                    type: "string";
+                                    format: string;
+                                };
+                                updatedAt: {
+                                    type: "string";
+                                    format: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         updateTable: {
             name: string;
             path: string;
@@ -11609,6 +11851,7 @@ export declare const state: {
             getOrCreateTableBody: true;
             createTableBody: true;
             duplicateTableBody: true;
+            importTableBody: true;
             updateTableBody: true;
             renameTableColumnBody: true;
             findTableRowsBody: true;
@@ -11754,6 +11997,9 @@ export declare const state: {
             getOrCreateTableResponse: true;
             createTableResponse: true;
             duplicateTableResponse: true;
+            exportTableResponse: true;
+            getTableJobsResponse: true;
+            importTableResponse: true;
             updateTableResponse: true;
             renameTableColumnResponse: true;
             deleteTableResponse: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {