@botpress/api 0.18.5 → 0.19.0

package/src/gen/state.ts

@@ -2,7 +2,7 @@
 /* eslint-disable */
 /* prettier-ignore */
 import * as opapi from '@bpinternal/opapi'
-export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'File' | 'Table' | 'Column' | 'Row', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables'>
+export type State = opapi.State<'Bot' | 'Integration' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>
 export const state = {
   "operations": {
     "createConversation": {
@@ -7103,54 +7103,130 @@ export const state = {
     },
     "createFile": {
       "name": "createFile",
-      "description": "Create File",
+      "path": "/v1/files",
+      "description": "Creates a file.",
       "method": "post",
-      "path": "/v1/storage/files",
-      "section": "file",
       "requestBody": {
-        "description": "Create File",
+        "description": "The file to upload.",
         "schema": {
           "type": "object",
           "properties": {
-            "botId": {
-              "type": "string",
-              "format": "uuid",
-              "description": "ID of the bot the file will be used for"
-            },
-            "contents": {
-              "type": "string",
-              "description": "Base64-encoded file contents"
-            },
-            "name": {
-              "type": "string",
-              "description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
-            },
-            "accessType": {
-              "type": "string",
-              "enum": [
-                "private",
-                "public"
-              ],
-              "description": "Accepted values: private, public"
+            "data": {
+              "nullable": true
             }
           },
-          "required": [
-            "botId",
-            "contents",
-            "name",
-            "accessType"
-          ],
           "title": "createFileBody",
+          "format": "binary",
           "additionalProperties": false
         }
       },
+      "parameters": {
+        "x-filename": {
+          "type": "string",
+          "description": "File name",
+          "in": "header",
+          "required": true
+        },
+        "x-tags": {
+          "type": "string",
+          "description": "File tags as URL-encoded JSON string representing an object of key-value pairs.",
+          "in": "header"
+        },
+        "x-access-policies": {
+          "type": "string",
+          "description": "File access policies",
+          "in": "header"
+        },
+        "Content-Type": {
+          "type": "string",
+          "description": "File content type",
+          "in": "header"
+        },
+        "Content-Length": {
+          "type": "string",
+          "description": "File content length",
+          "in": "header"
+        },
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
+        }
+      },
+      "contentType": "*/*",
+      "section": "files",
       "response": {
-        "description": "Success",
+        "description": "The file metadata.",
         "schema": {
           "type": "object",
           "properties": {
             "file": {
-              "$ref": "#/components/schemas/File"
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "filename": {
+                  "type": "string"
+                },
+                "bytes": {
+                  "type": "number",
+                  "nullable": true
+                },
+                "tags": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 1000
+                  },
+                  "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
+                },
+                "createdAt": {
+                  "type": "string"
+                },
+                "updatedAt": {
+                  "type": "string"
+                },
+                "accessPolicies": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "filename",
+                "bytes",
+                "tags",
+                "createdAt",
+                "updatedAt",
+                "accessPolicies"
+              ],
+              "additionalProperties": false
             }
           },
           "required": [
@@ -7159,128 +7235,397 @@ export const state = {
           "title": "createFileResponse",
           "additionalProperties": false
         }
-      },
-      "parameters": {}
+      }
     },
-    "getFile": {
-      "name": "getFile",
-      "description": "Get File",
-      "method": "get",
-      "path": "/v1/storage/files/{id}",
-      "section": "file",
+    "deleteFile": {
+      "name": "deleteFile",
+      "path": "/v1/files/{id}",
+      "description": "Deletes a file.",
+      "method": "delete",
+      "section": "files",
       "parameters": {
         "id": {
           "type": "string",
           "description": "File ID",
           "in": "path"
+        },
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
         }
       },
       "response": {
-        "description": "Success",
+        "description": "Empty response.",
+        "schema": {
+          "type": "object",
+          "title": "deleteFileResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "listFiles": {
+      "name": "listFiles",
+      "path": "/v1/files/bot/{botId}",
+      "description": "List files for bot",
+      "method": "get",
+      "section": "files",
+      "parameters": {
+        "nextToken": {
+          "in": "query",
+          "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          "type": "string"
+        },
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
+        },
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "tags": {
+          "in": "query",
+          "type": "string",
+          "description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
+        }
+      },
+      "response": {
+        "description": "Returns the list of files related to the bot.",
         "schema": {
           "type": "object",
           "properties": {
-            "file": {
-              "$ref": "#/components/schemas/File"
+            "files": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "botId": {
+                    "type": "string"
+                  },
+                  "filename": {
+                    "type": "string"
+                  },
+                  "bytes": {
+                    "type": "number",
+                    "nullable": true
+                  },
+                  "createdAt": {
+                    "type": "string"
+                  },
+                  "updatedAt": {
+                    "type": "string"
+                  },
+                  "accessPolicies": {
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  }
+                },
+                "required": [
+                  "id",
+                  "botId",
+                  "filename",
+                  "bytes",
+                  "createdAt",
+                  "updatedAt",
+                  "accessPolicies"
+                ]
+              }
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "nextToken": {
+                  "type": "string",
+                  "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."
+                }
+              },
+              "additionalProperties": false
             }
           },
           "required": [
-            "file"
+            "files",
+            "meta"
           ],
-          "title": "getFileResponse",
+          "title": "listFilesResponse",
           "additionalProperties": false
         }
       }
     },
-    "downloadFile": {
-      "name": "downloadFile",
-      "description": "Download File",
+    "getFileMetadata": {
+      "name": "getFileMetadata",
+      "path": "/v1/files/{id}/metadata",
+      "description": "Get file metadata",
       "method": "get",
-      "path": "/v1/storage/files/{id}/download",
-      "section": "file",
+      "section": "files",
       "parameters": {
         "id": {
           "type": "string",
           "description": "File ID",
           "in": "path"
+        },
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
         }
       },
       "response": {
-        "description": "Raw file contents",
+        "description": "The metadata of the file.",
         "schema": {
-          "nullable": true,
-          "title": "downloadFileResponse"
+          "type": "object",
+          "properties": {
+            "file": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string"
+                },
+                "botId": {
+                  "type": "string"
+                },
+                "filename": {
+                  "type": "string"
+                },
+                "bytes": {
+                  "type": "number",
+                  "nullable": true
+                },
+                "tags": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 1000
+                  },
+                  "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
+                },
+                "createdAt": {
+                  "type": "string"
+                },
+                "updatedAt": {
+                  "type": "string"
+                },
+                "accessPolicies": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  }
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "filename",
+                "bytes",
+                "tags",
+                "createdAt",
+                "updatedAt",
+                "accessPolicies"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "file"
+          ],
+          "title": "getFileMetadataResponse",
+          "additionalProperties": false
         }
       }
     },
-    "deleteFile": {
-      "name": "deleteFile",
-      "description": "Delete File",
-      "method": "delete",
-      "path": "/v1/storage/files/{id}",
-      "section": "file",
+    "getFileContent": {
+      "name": "getFileContent",
+      "path": "/v1/files/{id}/content",
+      "description": "Gets a file content",
+      "method": "get",
+      "section": "files",
       "parameters": {
         "id": {
           "type": "string",
           "description": "File ID",
           "in": "path"
+        },
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
+          "type": "string",
+          "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
         }
       },
       "response": {
-        "description": "Success",
+        "description": "Redirects to a presigned URL to download the file content.",
+        "status": 302,
         "schema": {
           "type": "object",
-          "title": "deleteFileResponse",
+          "properties": {
+            "data": {
+              "nullable": true
+            }
+          },
+          "title": "getFileContentResponse",
+          "format": "binary",
           "additionalProperties": false
         }
       }
     },
-    "listFiles": {
-      "name": "listFiles",
-      "description": "List Files",
-      "method": "get",
-      "path": "/v1/storage/files",
-      "section": "file",
+    "updateFileMetadata": {
+      "name": "updateFileMetadata",
+      "path": "/v1/files/{id}/metadata",
+      "description": "Update file metadata",
+      "method": "put",
+      "section": "files",
       "parameters": {
-        "nextToken": {
-          "in": "query",
-          "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
-          "type": "string"
+        "id": {
+          "type": "string",
+          "description": "File ID",
+          "in": "path"
         },
-        "botId": {
-          "in": "query",
+        "x-bot-id": {
+          "in": "header",
+          "description": "Bot id",
           "type": "string",
-          "description": "Bot ID",
           "required": true
+        },
+        "x-integration-id": {
+          "in": "header",
+          "description": "Integration id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-id": {
+          "in": "header",
+          "description": "User id",
+          "type": "string",
+          "required": false
+        },
+        "x-user-role": {
+          "in": "header",
+          "description": "User role",
+          "type": "string",
+          "required": false
+        }
+      },
+      "requestBody": {
+        "description": "File metadata to update.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 1000
+              },
+              "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
+            }
+          },
+          "required": [
+            "tags"
+          ],
+          "title": "updateFileMetadataBody",
+          "additionalProperties": false
         }
       },
       "response": {
-        "description": "Success",
+        "description": "An object containing the updated metadata of the file.",
         "schema": {
           "type": "object",
           "properties": {
-            "files": {
-              "type": "array",
-              "items": {
-                "$ref": "#/components/schemas/File"
-              }
-            },
-            "meta": {
+            "tags": {
               "type": "object",
-              "properties": {
-                "nextToken": {
-                  "type": "string",
-                  "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."
-                }
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 1000
               },
-              "additionalProperties": false
+              "description": "The tags to update as an object of key/value pairs. A tag key can be set to a null value to delete it."
             }
           },
           "required": [
-            "files",
-            "meta"
+            "tags"
           ],
-          "title": "listFilesResponse",
+          "title": "updateFileMetadataResponse",
           "additionalProperties": false
         }
       }
@@ -7993,7 +8338,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.18.5",
+    "version": "0.19.0",
     "prefix": "v1"
   },
   "errors": [
@@ -8149,6 +8494,7 @@ export const state = {
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
       "createFileBody": true,
+      "updateFileMetadataBody": true,
       "createTableBody": true,
       "updateTableBody": true,
       "renameTableColumnBody": true,
@@ -8254,10 +8600,11 @@ export const state = {
       "listActivitiesResponse": true,
       "introspectResponse": true,
       "createFileResponse": true,
-      "getFileResponse": true,
-      "downloadFileResponse": true,
       "deleteFileResponse": true,
       "listFilesResponse": true,
+      "getFileMetadataResponse": true,
+      "getFileContentResponse": true,
+      "updateFileMetadataResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
       "createTableResponse": true,
@@ -8287,10 +8634,10 @@ export const state = {
       "Message": true,
       "State": true,
       "Task": true,
-      "File": true,
       "Table": true,
       "Column": true,
-      "Row": true
+      "Row": true,
+      "File": true
     }
   },
   "schemas": {
@@ -10049,56 +10396,6 @@ export const state = {
         "additionalProperties": false
       }
     },
-    "File": {
-      "section": "file",
-      "schema": {
-        "type": "object",
-        "properties": {
-          "botId": {
-            "type": "string",
-            "format": "uuid",
-            "description": "ID of the bot the file will be used for"
-          },
-          "name": {
-            "type": "string",
-            "description": "Optional arbitrary file name (e.g. my-image.jpg), will be used for display purposes only."
-          },
-          "accessType": {
-            "type": "string",
-            "enum": [
-              "private",
-              "public"
-            ],
-            "description": "Accepted values: private, public"
-          },
-          "id": {
-            "type": "string",
-            "description": "ID of the [File](#schema_file)"
-          },
-          "createdAt": {
-            "type": "string",
-            "description": "Creation date of the [File](#schema_file) in ISO 8601 format"
-          },
-          "size": {
-            "type": "number",
-            "description": "Size of the file in bytes"
-          },
-          "publicUrl": {
-            "type": "string",
-            "description": "Public URL to the file contents, available only if the access type is public. If the file is private, use the Download endpoint to retrieve the file contents."
-          }
-        },
-        "required": [
-          "botId",
-          "name",
-          "accessType",
-          "id",
-          "createdAt",
-          "size"
-        ],
-        "additionalProperties": false
-      }
-    },
     "Table": {
       "section": "tables",
       "schema": {
@@ -10321,6 +10618,58 @@ export const state = {
         ],
         "additionalProperties": true
       }
+    },
+    "File": {
+      "section": "files",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "botId": {
+            "type": "string"
+          },
+          "filename": {
+            "type": "string"
+          },
+          "bytes": {
+            "type": "number",
+            "nullable": true
+          },
+          "tags": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 1000
+            },
+            "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
+          },
+          "createdAt": {
+            "type": "string"
+          },
+          "updatedAt": {
+            "type": "string"
+          },
+          "accessPolicies": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "id",
+          "botId",
+          "filename",
+          "bytes",
+          "tags",
+          "createdAt",
+          "updatedAt",
+          "accessPolicies"
+        ],
+        "additionalProperties": false
+      }
     }
   },
   "sections": [
@@ -10385,14 +10734,7 @@ export const state = {
       "description": "",
       "title": "File",
       "name": "file",
-      "operations": [
-        "createFile",
-        "getFile",
-        "downloadFile",
-        "deleteFile",
-        "listFiles"
-      ],
-      "schema": "File"
+      "operations": []
     },
     {
       "description": "",
@@ -10579,6 +10921,20 @@ export const state = {
         "upsertTableRows"
       ],
       "schema": "Table"
+    },
+    {
+      "title": "Files",
+      "description": "Operations related to file management.",
+      "name": "files",
+      "operations": [
+        "createFile",
+        "deleteFile",
+        "listFiles",
+        "getFileMetadata",
+        "getFileContent",
+        "updateFileMetadata"
+      ],
+      "schema": "File"
     }
   ],
   "options": {