@botpress/api 0.25.1 → 0.26.0

package/dist/index.js

@@ -7103,9 +7103,9 @@ var require_safe = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/cli.js
+// ../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/cli.js
 var require_cli = __commonJS({
-  "../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/cli.js"(exports) {
+  "../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/cli.js"(exports) {
     "use strict";
     exports.levels = {
       error: 0,
@@ -7134,9 +7134,9 @@ var require_cli = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/npm.js
+// ../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/npm.js
 var require_npm = __commonJS({
-  "../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/npm.js"(exports) {
+  "../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/npm.js"(exports) {
     "use strict";
     exports.levels = {
       error: 0,
@@ -7159,9 +7159,9 @@ var require_npm = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/syslog.js
+// ../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/syslog.js
 var require_syslog = __commonJS({
-  "../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/syslog.js"(exports) {
+  "../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/syslog.js"(exports) {
     "use strict";
     exports.levels = {
       emerg: 0,
@@ -7186,9 +7186,9 @@ var require_syslog = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/index.js
+// ../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/index.js
 var require_config = __commonJS({
-  "../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/config/index.js"(exports) {
+  "../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/config/index.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "cli", {
       value: require_cli()
@@ -7202,9 +7202,9 @@ var require_config = __commonJS({
   }
 });
 
-// ../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/index.js
+// ../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/index.js
 var require_triple_beam = __commonJS({
-  "../../node_modules/.pnpm/triple-beam@1.3.0/node_modules/triple-beam/index.js"(exports) {
+  "../../node_modules/.pnpm/triple-beam@1.4.1/node_modules/triple-beam/index.js"(exports) {
     "use strict";
     Object.defineProperty(exports, "LEVEL", {
       value: Symbol.for("level")
@@ -277638,142 +277638,6 @@ var state = {
         }
       }
     },
-    "changeWorkspacePlan": {
-      "name": "changeWorkspacePlan",
-      "description": "Change workspace billing plan",
-      "section": "workspace",
-      "method": "put",
-      "path": "/v1/admin/workspaces/{id}/change-plan",
-      "disableDefaultParameters": {
-        "x-workspace-id": true
-      },
-      "parameters": {
-        "id": {
-          "type": "string",
-          "description": "Workspace ID",
-          "in": "path"
-        }
-      },
-      "requestBody": {
-        "description": "Billing plan to change the workspace to",
-        "schema": {
-          "type": "object",
-          "properties": {
-            "plan": {
-              "type": "string",
-              "enum": [
-                "free",
-                "premium"
-              ]
-            }
-          },
-          "required": [
-            "plan"
-          ],
-          "title": "changeWorkspacePlanBody",
-          "additionalProperties": false
-        }
-      },
-      "response": {
-        "description": "Success",
-        "schema": {
-          "type": "object",
-          "properties": {
-            "id": {
-              "type": "string"
-            },
-            "name": {
-              "type": "string"
-            },
-            "ownerId": {
-              "type": "string"
-            },
-            "createdAt": {
-              "type": "string"
-            },
-            "updatedAt": {
-              "type": "string"
-            },
-            "botCount": {
-              "type": "number"
-            },
-            "accountType": {
-              "type": "string",
-              "enum": [
-                "free",
-                "premium"
-              ]
-            },
-            "billingVersion": {
-              "type": "string",
-              "enum": [
-                "v1",
-                "v2"
-              ]
-            },
-            "plan": {
-              "type": "string",
-              "enum": [
-                "community",
-                "team",
-                "enterprise"
-              ]
-            },
-            "blocked": {
-              "type": "boolean"
-            },
-            "spendingLimit": {
-              "type": "number"
-            },
-            "about": {
-              "default": "",
-              "type": "string"
-            },
-            "profilePicture": {
-              "default": "",
-              "type": "string"
-            },
-            "contactEmail": {
-              "default": "",
-              "type": "string"
-            },
-            "website": {
-              "default": "",
-              "type": "string"
-            },
-            "socialAccounts": {
-              "default": [],
-              "type": "array",
-              "items": {
-                "type": "string"
-              }
-            },
-            "isPublic": {
-              "type": "boolean"
-            },
-            "handle": {
-              "default": "",
-              "type": "string"
-            }
-          },
-          "required": [
-            "id",
-            "name",
-            "ownerId",
-            "createdAt",
-            "updatedAt",
-            "botCount",
-            "accountType",
-            "billingVersion",
-            "plan",
-            "blocked",
-            "spendingLimit"
-          ],
-          "title": "changeWorkspacePlanResponse",
-          "additionalProperties": false
-        }
-      }
-    },
     "deleteWorkspace": {
       "name": "deleteWorkspace",
       "description": "Delete workspace",
@@ -277871,14 +277735,12 @@ var state = {
                       "DELETE_BOT",
                       "DEPLOY_BOT",
                       "TRANSFER_BOT",
-                      "DOWNGRADE_WORKSPACE_PLAN",
                       "DOWNLOAD_BOT_ARCHIVE",
                       "UPDATE_BOT",
                       "UPDATE_BOT_CHANNEL",
                       "UPDATE_BOT_CONFIG",
                       "UPDATE_PAYMENT_METHOD",
                       "UPDATE_WORKSPACE",
-                      "UPGRADE_WORKSPACE_PLAN",
                       "SET_SPENDING_LIMIT",
                       "SET_AI_SPENDING_LIMIT"
                     ]
@@ -280163,9 +280025,10 @@ var state = {
               "type": "object",
               "additionalProperties": {
                 "type": "string",
-                "maxLength": 1e3
+                "maxLength": 1e3,
+                "nullable": true
               },
-              "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."
+              "description": "The file tags to update as an object of key/value pairs with string (text) values. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`."
             }
           },
           "required": [
@@ -281162,7 +281025,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.25.1",
+    "version": "0.26.0",
     "prefix": "v1"
   },
   "errors": [
@@ -281315,7 +281178,6 @@ var state = {
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
       "checkHandleAvailabilityBody": true,
-      "changeWorkspacePlanBody": true,
       "createWorkspaceMemberBody": true,
       "updateWorkspaceMemberBody": true,
       "createIntegrationApiKeyBody": true,
@@ -281411,7 +281273,6 @@ var state = {
       "updateWorkspaceResponse": true,
       "checkHandleAvailabilityResponse": true,
       "listWorkspacesResponse": true,
-      "changeWorkspacePlanResponse": true,
       "deleteWorkspaceResponse": true,
       "getAuditRecordsResponse": true,
       "listWorkspaceMembersResponse": true,
@@ -283735,7 +283596,6 @@ var state = {
         "updateWorkspace",
         "checkHandleAvailability",
         "listWorkspaces",
-        "changeWorkspacePlan",
         "deleteWorkspace",
         "getAuditRecords"
       ],

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

@@ -5352,115 +5352,6 @@ export declare const state: {
                 };
             };
         };
-        changeWorkspacePlan: {
-            name: string;
-            description: string;
-            section: "workspace";
-            method: "put";
-            path: string;
-            disableDefaultParameters: {
-                "x-workspace-id": boolean;
-            };
-            parameters: {
-                id: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-            };
-            requestBody: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
-                        plan: {
-                            type: "string";
-                            enum: string[];
-                        };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
-                        id: {
-                            type: "string";
-                        };
-                        name: {
-                            type: "string";
-                        };
-                        ownerId: {
-                            type: "string";
-                        };
-                        createdAt: {
-                            type: "string";
-                        };
-                        updatedAt: {
-                            type: "string";
-                        };
-                        botCount: {
-                            type: "number";
-                        };
-                        accountType: {
-                            type: "string";
-                            enum: string[];
-                        };
-                        billingVersion: {
-                            type: "string";
-                            enum: string[];
-                        };
-                        plan: {
-                            type: "string";
-                            enum: string[];
-                        };
-                        blocked: {
-                            type: "boolean";
-                        };
-                        spendingLimit: {
-                            type: "number";
-                        };
-                        about: {
-                            default: string;
-                            type: "string";
-                        };
-                        profilePicture: {
-                            default: string;
-                            type: "string";
-                        };
-                        contactEmail: {
-                            default: string;
-                            type: "string";
-                        };
-                        website: {
-                            default: string;
-                            type: "string";
-                        };
-                        socialAccounts: {
-                            default: never[];
-                            type: "array";
-                            items: {
-                                type: "string";
-                            };
-                        };
-                        isPublic: {
-                            type: "boolean";
-                        };
-                        handle: {
-                            default: string;
-                            type: "string";
-                        };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
         deleteWorkspace: {
             name: string;
             description: string;
@@ -7552,6 +7443,7 @@ export declare const state: {
                             additionalProperties: {
                                 type: "string";
                                 maxLength: number;
+                                nullable: true;
                             };
                             description: string;
                         };
@@ -8560,7 +8452,6 @@ export declare const state: {
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
             checkHandleAvailabilityBody: true;
-            changeWorkspacePlanBody: true;
             createWorkspaceMemberBody: true;
             updateWorkspaceMemberBody: true;
             createIntegrationApiKeyBody: true;
@@ -8656,7 +8547,6 @@ export declare const state: {
             updateWorkspaceResponse: true;
             checkHandleAvailabilityResponse: true;
             listWorkspacesResponse: true;
-            changeWorkspacePlanResponse: true;
             deleteWorkspaceResponse: true;
             getAuditRecordsResponse: true;
             listWorkspaceMembersResponse: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.25.1",
+  "version": "0.26.0",
   "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","changeWorkspacePlan","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","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."}]}