@botpress/api 0.27.0 → 0.27.2

package/dist/index.js

@@ -280794,7 +280794,7 @@ var state = {
       "contentType": "application/json",
       "section": "files",
       "response": {
-        "description": "The file metadata.",
+        "description": "The created file",
         "schema": {
           "type": "object",
           "properties": {
@@ -281059,10 +281059,10 @@ var 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": {
@@ -281073,7 +281073,7 @@ var state = {
         }
       },
       "response": {
-        "description": "The metadata of the file.",
+        "description": "An object containing the file metadata and URL",
         "schema": {
           "type": "object",
           "properties": {
@@ -281160,51 +281160,26 @@ var 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": {
@@ -281232,28 +281207,104 @@ var 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": 1e3
+              "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": 1e3
+                  },
+                  "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
         }
       }
@@ -282230,7 +282281,7 @@ var 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": [
@@ -282392,7 +282443,7 @@ var state = {
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
       "createFileBody": true,
-      "updateFileMetadataBody": true,
+      "updateFileBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -282504,9 +282555,8 @@ var state = {
       "createFileResponse": true,
       "deleteFileResponse": true,
       "listFilesResponse": true,
-      "getFileMetadataResponse": true,
-      "getFileContentResponse": true,
-      "updateFileMetadataResponse": true,
+      "getFileResponse": true,
+      "updateFileResponse": true,
       "searchFilesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
@@ -284891,9 +284941,8 @@ var state = {
         "createFile",
         "deleteFile",
         "listFiles",
-        "getFileMetadata",
-        "getFileContent",
-        "updateFileMetadata",
+        "getFile",
+        "updateFile",
         "searchFiles"
       ],
       "schema": "File"

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

@@ -7327,7 +7327,7 @@ export declare const state: {
                 };
             };
         };
-        getFileMetadata: {
+        getFile: {
             name: string;
             path: string;
             description: string;
@@ -7410,34 +7410,10 @@ export declare const state: {
                             required: string[];
                             additionalProperties: false;
                         };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
-        getFileContent: {
-            name: string;
-            path: string;
-            description: string;
-            method: "get";
-            section: "files";
-            parameters: {
-                id: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-            };
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
                         url: {
                             type: "string";
                             description: string;
+                            nullable: true;
                         };
                     };
                     required: string[];
@@ -7446,7 +7422,7 @@ export declare const state: {
                 };
             };
         };
-        updateFileMetadata: {
+        updateFile: {
             name: string;
             path: string;
             description: string;
@@ -7484,13 +7460,70 @@ export declare const state: {
                 schema: {
                     type: "object";
                     properties: {
-                        tags: {
+                        file: {
                             type: "object";
-                            additionalProperties: {
-                                type: "string";
-                                maxLength: number;
+                            properties: {
+                                id: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                botId: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                name: {
+                                    type: "string";
+                                    description: string;
+                                    nullable: true;
+                                };
+                                size: {
+                                    type: "number";
+                                    description: string;
+                                    nullable: true;
+                                };
+                                contentType: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                tags: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "string";
+                                        maxLength: number;
+                                    };
+                                    description: string;
+                                };
+                                createdAt: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                updatedAt: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                accessPolicies: {
+                                    type: "array";
+                                    items: {
+                                        type: "string";
+                                    };
+                                    description: string;
+                                };
+                                index: {
+                                    type: "boolean";
+                                    description: string;
+                                };
+                                status: {
+                                    type: "string";
+                                    enum: string[];
+                                    description: string;
+                                };
+                                failedStatusReason: {
+                                    type: "string";
+                                    description: string;
+                                };
                             };
-                            description: string;
+                            required: string[];
+                            additionalProperties: false;
                         };
                     };
                     required: string[];
@@ -8494,7 +8527,7 @@ export declare const state: {
             changeAISpendQuotaBody: true;
             introspectBody: true;
             createFileBody: true;
-            updateFileMetadataBody: true;
+            updateFileBody: true;
             getOrCreateTableBody: true;
             createTableBody: true;
             duplicateTableBody: true;
@@ -8606,9 +8639,8 @@ export declare const state: {
             createFileResponse: true;
             deleteFileResponse: true;
             listFilesResponse: true;
-            getFileMetadataResponse: true;
-            getFileContentResponse: true;
-            updateFileMetadataResponse: true;
+            getFileResponse: true;
+            updateFileResponse: true;
             searchFilesResponse: true;
             listTablesResponse: true;
             getTableResponse: true;

package/package.json

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

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"Operations related to file management.","name":"files","operations":["createFile","deleteFile","listFiles","getFileMetadata","getFileContent","updateFileMetadata","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":[]},{"description":"","title":"State","name":"state","operations":["getState","setState","getOrSetState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Task","name":"task","operations":["getTask","createTask","updateTask","deleteTask","listTasks"],"schema":"Task"},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["listIntegrationApiKeys","createIntegrationApiKey","deleteIntegrationApiKey","createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["setWorkspacePaymentMethod","listWorkspaceInvoices","getUpcomingInvoice","chargeWorkspaceUnpaidInvoices","createWorkspace","getPublicWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","checkHandleAvailability","listWorkspaces","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","updateAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken","setAccountPreference","getAccountPreference"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]},{"title":"Helper","description":"","name":"helper","operations":["runVrl"]},{"title":"Activity","description":"","name":"activity","operations":["listActivities"],"schema":"Activity"},{"title":"Tables","description":"Manage and interact with table structures, including creation, updates, and querying of tables and their rows.","name":"tables","operations":["listTables","getTable","getOrCreateTable","createTable","duplicateTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"},{"title":"Files","description":"Operations related to file management.","name":"files","operations":["createFile","deleteFile","listFiles","getFile","updateFile","searchFiles"],"schema":"File"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is related with a different resource that the one referenced in the request. This is usually caused when providing two resource identifiers that aren't linked together."},{"status":409,"type":"ReferenceConstraint","description":"The resource cannot be deleted because it's referenced by another resource"},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."},{"status":400,"type":"BreakingChanges","description":"Request payload contains breaking changes which is not allowed for this resource without a version increment."}]}