@botpress/api 0.23.0 → 0.25.0

package/src/gen/state.ts

@@ -587,6 +587,11 @@ export const state = {
           "in": "query",
           "type": "string",
           "description": "Filter by message id"
+        },
+        "status": {
+          "in": "query",
+          "type": "string",
+          "description": "Filter by status. Allowed values: pending, ignored, processed, failed."
         }
       },
       "response": {
@@ -8105,48 +8110,44 @@ export const state = {
         "schema": {
           "type": "object",
           "properties": {
-            "data": {
-              "nullable": true
+            "name": {
+              "type": "string",
+              "description": "File name"
+            },
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 1000
+              },
+              "description": "File tags as an object of key/value pairs"
+            },
+            "index": {
+              "default": false,
+              "type": "boolean",
+              "description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota."
+            },
+            "accessPolicies": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "public_content",
+                  "integrations"
+                ]
+              },
+              "description": "File access policies. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allow read, search and list operations for any integration installed in the bot."
+            },
+            "contentType": {
+              "type": "string",
+              "description": "File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\"."
             }
           },
           "title": "createFileBody",
-          "format": "binary",
           "additionalProperties": false
         }
       },
-      "parameters": {
-        "x-name": {
-          "type": "string",
-          "description": "File name",
-          "in": "header"
-        },
-        "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, comma-separated. Add \"public_content\" to allow public access to the file content. Add \"integrations\" to allo read, search and list operations for any integration installed in the bot.",
-          "in": "header"
-        },
-        "x-index": {
-          "type": "boolean",
-          "description": "Set to a value of \"true\" to index the file in vector storage (default: false). Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota.",
-          "in": "header"
-        },
-        "Content-Type": {
-          "type": "string",
-          "description": "File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is \"application/octet-stream\".",
-          "in": "header"
-        },
-        "Content-Length": {
-          "type": "string",
-          "description": "File content length",
-          "in": "header"
-        }
-      },
-      "contentType": "*/*",
+      "contentType": "application/json",
       "section": "files",
       "response": {
         "description": "The file metadata.",
@@ -8171,7 +8172,7 @@ export const state = {
                 },
                 "size": {
                   "type": "number",
-                  "description": "File size in bytes",
+                  "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
                   "nullable": true
                 },
                 "contentType": {
@@ -8214,6 +8215,23 @@ export const state = {
                 "indexingFailureReason": {
                   "type": "string",
                   "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
+                },
+                "uploadStatus": {
+                  "type": "string",
+                  "enum": [
+                    "PENDING",
+                    "COMPLETE",
+                    "FAILED"
+                  ],
+                  "description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
+                },
+                "uploadFailureReason": {
+                  "type": "string",
+                  "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
+                },
+                "uploadUrl": {
+                  "type": "string",
+                  "description": "URL to upload the file content. File content needs to be sent to this URL via a POST request."
                 }
               },
               "required": [
@@ -8225,7 +8243,9 @@ export const state = {
                 "tags",
                 "createdAt",
                 "updatedAt",
-                "accessPolicies"
+                "accessPolicies",
+                "uploadStatus",
+                "uploadUrl"
               ],
               "additionalProperties": false
             }
@@ -8236,7 +8256,8 @@ export const state = {
           "title": "createFileResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "parameters": {}
     },
     "deleteFile": {
       "name": "deleteFile",
@@ -8314,7 +8335,7 @@ export const state = {
                   },
                   "size": {
                     "type": "number",
-                    "description": "File size in bytes",
+                    "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
                     "nullable": true
                   },
                   "contentType": {
@@ -8357,6 +8378,19 @@ export const state = {
                   "indexingFailureReason": {
                     "type": "string",
                     "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
+                  },
+                  "uploadStatus": {
+                    "type": "string",
+                    "enum": [
+                      "PENDING",
+                      "COMPLETE",
+                      "FAILED"
+                    ],
+                    "description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
+                  },
+                  "uploadFailureReason": {
+                    "type": "string",
+                    "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
                   }
                 },
                 "required": [
@@ -8368,7 +8402,8 @@ export const state = {
                   "tags",
                   "createdAt",
                   "updatedAt",
-                  "accessPolicies"
+                  "accessPolicies",
+                  "uploadStatus"
                 ]
               }
             },
@@ -8428,7 +8463,7 @@ export const state = {
                 },
                 "size": {
                   "type": "number",
-                  "description": "File size in bytes",
+                  "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
                   "nullable": true
                 },
                 "contentType": {
@@ -8471,6 +8506,19 @@ export const state = {
                 "indexingFailureReason": {
                   "type": "string",
                   "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
+                },
+                "uploadStatus": {
+                  "type": "string",
+                  "enum": [
+                    "PENDING",
+                    "COMPLETE",
+                    "FAILED"
+                  ],
+                  "description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
+                },
+                "uploadFailureReason": {
+                  "type": "string",
+                  "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
                 }
               },
               "required": [
@@ -8482,7 +8530,8 @@ export const state = {
                 "tags",
                 "createdAt",
                 "updatedAt",
-                "accessPolicies"
+                "accessPolicies",
+                "uploadStatus"
               ],
               "additionalProperties": false
             }
@@ -9547,7 +9596,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.23.0",
+    "version": "0.25.0",
     "prefix": "v1"
   },
   "errors": [
@@ -11875,7 +11924,7 @@ export const state = {
           },
           "size": {
             "type": "number",
-            "description": "File size in bytes",
+            "description": "File size in bytes. Non-null if file upload status is \"COMPLETE\".",
             "nullable": true
           },
           "contentType": {
@@ -11918,6 +11967,19 @@ export const state = {
           "indexingFailureReason": {
             "type": "string",
             "description": "Last failure reason of the file indexing if the indexing status is \"FAILED\"."
+          },
+          "uploadStatus": {
+            "type": "string",
+            "enum": [
+              "PENDING",
+              "COMPLETE",
+              "FAILED"
+            ],
+            "description": "Status of the file upload process. If the status is \"PENDING\", the file content has not been uploaded yet. \nThe status will be set to \"COMPLETE\" once the file content has been uploaded successfully. \nIf the status is \"FAILED\", the file content could not be uploaded. See \"uploadFailureReason\" for more details."
+          },
+          "uploadFailureReason": {
+            "type": "string",
+            "description": "Failure reason of the file upload if the upload status is \"FAILED\"."
           }
         },
         "required": [
@@ -11929,7 +11991,8 @@ export const state = {
           "tags",
           "createdAt",
           "updatedAt",
-          "accessPolicies"
+          "accessPolicies",
+          "uploadStatus"
         ],
         "additionalProperties": false
       }