@botpress/api 0.63.2 → 0.64.0

package/src/gen/state.ts

@@ -12264,6 +12264,160 @@ export const state = {
         }
       }
     },
+    "copyFile": {
+      "name": "copyFile",
+      "path": "/v1/files/{idOrKey}/{destinationKey}",
+      "description": "Copy file",
+      "method": "post",
+      "section": "files",
+      "parameters": {
+        "idOrKey": {
+          "type": "string",
+          "description": "File ID or Key",
+          "in": "path"
+        },
+        "destinationKey": {
+          "in": "path",
+          "type": "string",
+          "description": "The new key of the file. The file key must not be in use already in the destination bot."
+        },
+        "x-destination-bot-id": {
+          "in": "header",
+          "type": "string",
+          "description": "The bot ID to copy the file to. You must have permission to create files in the destination bot. If the destination bot ID is omitted, the file will be copied to the same bot the source file belongs to."
+        }
+      },
+      "requestBody": {
+        "description": "An object containing the destination bot ID and file key",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "i": {
+              "type": "boolean"
+            }
+          },
+          "title": "copyFileBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "An object containing the file metadata and URL",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "file": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "File ID"
+                },
+                "botId": {
+                  "type": "string",
+                  "description": "The ID of the bot the file belongs to"
+                },
+                "key": {
+                  "type": "string",
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
+                },
+                "url": {
+                  "type": "string",
+                  "description": "URL to retrieve the file content. This URL will be ready to use once the file is uploaded.\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."
+                },
+                "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"
+                },
+                "metadata": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "nullable": true
+                  },
+                  "description": "Metadata of the file as an object of key/value pairs. The values can be of any type."
+                },
+                "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",
+                    "enum": [
+                      "integrations",
+                      "public_content"
+                    ]
+                  },
+                  "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."
+                },
+                "expiresAt": {
+                  "type": "string",
+                  "description": "File expiry timestamp in ISO 8601 format"
+                }
+              },
+              "required": [
+                "id",
+                "botId",
+                "key",
+                "url",
+                "size",
+                "contentType",
+                "tags",
+                "metadata",
+                "createdAt",
+                "updatedAt",
+                "accessPolicies",
+                "index",
+                "status"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "file"
+          ],
+          "title": "copyFileResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "searchFiles": {
       "name": "searchFiles",
       "path": "/v1/files/search",
@@ -13747,7 +13901,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.63.2",
+    "version": "0.64.0",
     "prefix": "v1"
   },
   "errors": [
@@ -13925,6 +14079,7 @@ export const state = {
       "introspectBody": true,
       "upsertFileBody": true,
       "updateFileMetadataBody": true,
+      "copyFileBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -14069,6 +14224,7 @@ export const state = {
       "listFilesResponse": true,
       "getFileResponse": true,
       "updateFileMetadataResponse": true,
+      "copyFileResponse": true,
       "searchFilesResponse": true,
       "listFilePassagesResponse": true,
       "listTablesResponse": true,
@@ -17581,6 +17737,7 @@ export const state = {
         "listFiles",
         "getFile",
         "updateFileMetadata",
+        "copyFile",
         "searchFiles",
         "listFilePassages"
       ],