@botpress/api 0.27.0 → 0.27.2

package/src/gen/state.ts

@@ -8070,7 +8070,7 @@ export const state = {
       "contentType": "application/json",
       "section": "files",
       "response": {
-        "description": "The file metadata.",
+        "description": "The created file",
         "schema": {
           "type": "object",
           "properties": {
@@ -8335,10 +8335,10 @@ export const state = {
         }
       }
     },
-    "getFileMetadata": {
-      "name": "getFileMetadata",
-      "path": "/v1/files/{id}/metadata",
-      "description": "Get file metadata",
+    "getFile": {
+      "name": "getFile",
+      "path": "/v1/files/{id}",
+      "description": "Get file",
       "method": "get",
       "section": "files",
       "parameters": {
@@ -8349,7 +8349,7 @@ export const state = {
         }
       },
       "response": {
-        "description": "The metadata of the file.",
+        "description": "An object containing the file metadata and URL",
         "schema": {
           "type": "object",
           "properties": {
@@ -8436,51 +8436,26 @@ export const state = {
                 "status"
               ],
               "additionalProperties": false
-            }
-          },
-          "required": [
-            "file"
-          ],
-          "title": "getFileMetadataResponse",
-          "additionalProperties": false
-        }
-      }
-    },
-    "getFileContent": {
-      "name": "getFileContent",
-      "path": "/v1/files/{id}/content",
-      "description": "Returns a presigned URL to download the file content.",
-      "method": "get",
-      "section": "files",
-      "parameters": {
-        "id": {
-          "type": "string",
-          "description": "File ID",
-          "in": "path"
-        }
-      },
-      "response": {
-        "description": "Returns a temporary pre-signed URL to download the file content.",
-        "schema": {
-          "type": "object",
-          "properties": {
+            },
             "url": {
               "type": "string",
-              "description": "Temporary pre-signed URL to download the file, should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe."
+              "description": "If the file is not uploaded yet, this will be set to a `null` value.\n\nIf the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.",
+              "nullable": true
             }
           },
           "required": [
+            "file",
             "url"
           ],
-          "title": "getFileContentResponse",
+          "title": "getFileResponse",
           "additionalProperties": false
         }
       }
     },
-    "updateFileMetadata": {
-      "name": "updateFileMetadata",
-      "path": "/v1/files/{id}/metadata",
-      "description": "Update file metadata",
+    "updateFile": {
+      "name": "updateFile",
+      "path": "/v1/files/{id}",
+      "description": "Update file",
       "method": "put",
       "section": "files",
       "parameters": {
@@ -8508,28 +8483,104 @@ export const state = {
           "required": [
             "tags"
           ],
-          "title": "updateFileMetadataBody",
+          "title": "updateFileBody",
           "additionalProperties": false
         }
       },
       "response": {
-        "description": "An object containing the updated metadata of the file.",
+        "description": "An object containing the updated file metadata.",
         "schema": {
           "type": "object",
           "properties": {
-            "tags": {
+            "file": {
               "type": "object",
-              "additionalProperties": {
-                "type": "string",
-                "maxLength": 1000
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "File ID"
+                },
+                "botId": {
+                  "type": "string",
+                  "description": "The ID of the bot the file belongs to"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "File name",
+                  "nullable": true
+                },
+                "size": {
+                  "type": "number",
+                  "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
+                  "nullable": true
+                },
+                "contentType": {
+                  "type": "string",
+                  "description": "MIME type of the file's content"
+                },
+                "tags": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 1000
+                  },
+                  "description": "The tags of the file as an object of key/value pairs"
+                },
+                "createdAt": {
+                  "type": "string",
+                  "description": "File creation timestamp in ISO 8601 format"
+                },
+                "updatedAt": {
+                  "type": "string",
+                  "description": "File last update timestamp in ISO 8601 format"
+                },
+                "accessPolicies": {
+                  "type": "array",
+                  "items": {
+                    "type": "string"
+                  },
+                  "description": "Access policies configured for the file."
+                },
+                "index": {
+                  "type": "boolean",
+                  "description": "Whether the file was requested to be indexed for search or not."
+                },
+                "status": {
+                  "type": "string",
+                  "enum": [
+                    "UPLOAD_PENDING",
+                    "UPLOAD_FAILED",
+                    "UPLOAD_COMPLETED",
+                    "INDEXING_PENDING",
+                    "INDEXING_FAILED",
+                    "INDEXING_COMPLETED"
+                  ],
+                  "description": "Status of the file. If the status is \"UPLOAD_PENDING\", the file content has not been uploaded yet. The status will be set to \"UPLOAD_COMPLETED\" once the file content has been uploaded successfully.\n\nIf the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to \"UPLOAD_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field of the file.\n\nHowever, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the \"INDEXING_PENDING\" status (the \"UPLOAD_COMPLETED\" status step will be skipped).\n\nOnce the indexing is completed and the file is ready to be used for searching its status will be set to \"INDEXING_COMPLETED\". If the indexing failed the status will be set to \"INDEXING_FAILED\" and the reason for the failure will be available in the `failedStatusReason` field."
+                },
+                "failedStatusReason": {
+                  "type": "string",
+                  "description": "If the file status is \"UPLOAD_FAILED\" or \"INDEXING_FAILED\" this will contain the reason of the failure."
+                }
               },
-              "description": "The updated tags of the file."
+              "required": [
+                "id",
+                "botId",
+                "name",
+                "size",
+                "contentType",
+                "tags",
+                "createdAt",
+                "updatedAt",
+                "accessPolicies",
+                "index",
+                "status"
+              ],
+              "additionalProperties": false
             }
           },
           "required": [
-            "tags"
+            "file"
           ],
-          "title": "updateFileMetadataResponse",
+          "title": "updateFileResponse",
           "additionalProperties": false
         }
       }
@@ -9506,7 +9557,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.27.0",
+    "version": "0.27.2",
     "prefix": "v1"
   },
   "errors": [
@@ -9668,7 +9719,7 @@ export const state = {
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
       "createFileBody": true,
-      "updateFileMetadataBody": true,
+      "updateFileBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -9780,9 +9831,8 @@ export const state = {
       "createFileResponse": true,
       "deleteFileResponse": true,
       "listFilesResponse": true,
-      "getFileMetadataResponse": true,
-      "getFileContentResponse": true,
-      "updateFileMetadataResponse": true,
+      "getFileResponse": true,
+      "updateFileResponse": true,
       "searchFilesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
@@ -12167,9 +12217,8 @@ export const state = {
         "createFile",
         "deleteFile",
         "listFiles",
-        "getFileMetadata",
-        "getFileContent",
-        "updateFileMetadata",
+        "getFile",
+        "updateFile",
         "searchFiles"
       ],
       "schema": "File"