@botpress/api 0.21.0 → 0.23.0

package/dist/index.js

@@ -276263,113 +276263,6 @@ var state = {
         }
       }
     },
-    "getWorkspaceBillingDetails": {
-      "name": "getWorkspaceBillingDetails",
-      "description": "Get billing details of workspace",
-      "method": "get",
-      "path": "/v1/admin/workspaces/{id}/billing/details",
-      "disableDefaultParameters": {
-        "x-workspace-id": true
-      },
-      "parameters": {
-        "id": {
-          "type": "string",
-          "description": "Workspace ID",
-          "in": "path"
-        }
-      },
-      "section": "workspace",
-      "response": {
-        "description": "Success",
-        "schema": {
-          "type": "object",
-          "properties": {
-            "currentPeriod": {
-              "type": "object",
-              "properties": {
-                "start": {
-                  "type": "string"
-                },
-                "end": {
-                  "type": "string"
-                },
-                "usage": {
-                  "type": "object",
-                  "properties": {
-                    "userMessages": {
-                      "type": "object",
-                      "properties": {
-                        "status": {
-                          "type": "string",
-                          "enum": [
-                            "OK",
-                            "Warning",
-                            "LimitReached"
-                          ]
-                        },
-                        "quantity": {
-                          "type": "number"
-                        },
-                        "price": {
-                          "type": "number"
-                        },
-                        "minimum": {
-                          "type": "number"
-                        },
-                        "maximum": {
-                          "type": "number"
-                        }
-                      },
-                      "required": [
-                        "status",
-                        "quantity",
-                        "price",
-                        "minimum",
-                        "maximum"
-                      ],
-                      "additionalProperties": false
-                    }
-                  },
-                  "required": [
-                    "userMessages"
-                  ],
-                  "additionalProperties": false
-                }
-              },
-              "required": [
-                "start",
-                "end",
-                "usage"
-              ],
-              "additionalProperties": false
-            },
-            "paymentMethod": {
-              "type": "object",
-              "properties": {
-                "type": {
-                  "type": "string"
-                },
-                "lastDigits": {
-                  "type": "string"
-                }
-              },
-              "required": [
-                "type",
-                "lastDigits"
-              ],
-              "nullable": true,
-              "additionalProperties": false
-            }
-          },
-          "required": [
-            "currentPeriod",
-            "paymentMethod"
-          ],
-          "title": "getWorkspaceBillingDetailsResponse",
-          "additionalProperties": false
-        }
-      }
-    },
     "setWorkspacePaymentMethod": {
       "name": "setWorkspacePaymentMethod",
       "description": "Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.",
@@ -279778,8 +279671,7 @@ var state = {
         "x-name": {
           "type": "string",
           "description": "File name",
-          "in": "header",
-          "required": true
+          "in": "header"
         },
         "x-tags": {
           "type": "string",
@@ -279793,7 +279685,7 @@ var state = {
         },
         "x-index": {
           "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.',
+          "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": {
@@ -280458,6 +280350,10 @@ var state = {
               "maximum": 30,
               "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
             },
+            "frozen": {
+              "type": "boolean",
+              "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
+            },
             "schema": {
               "type": "object",
               "additionalProperties": true,
@@ -280533,6 +280429,10 @@ var state = {
               "maximum": 30,
               "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
             },
+            "frozen": {
+              "type": "boolean",
+              "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
+            },
             "schema": {
               "type": "object",
               "additionalProperties": true,
@@ -280651,6 +280551,10 @@ var state = {
               "type": "string",
               "minLength": 1
             },
+            "frozen": {
+              "type": "boolean",
+              "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
+            },
             "schema": {
               "type": "object",
               "additionalProperties": true,
@@ -281196,7 +281100,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.21.0",
+    "version": "0.23.0",
     "prefix": "v1"
   },
   "errors": [
@@ -281430,7 +281334,6 @@ var state = {
       "listBotIssuesResponse": true,
       "deleteBotIssueResponse": true,
       "listBotIssueEventsResponse": true,
-      "getWorkspaceBillingDetailsResponse": true,
       "setWorkspacePaymentMethodResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
@@ -283299,6 +283202,10 @@ var state = {
             "maximum": 30,
             "description": "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1."
           },
+          "frozen": {
+            "type": "boolean",
+            "description": 'A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.'
+          },
           "schema": {
             "type": "object",
             "properties": {
@@ -283731,7 +283638,6 @@ var state = {
       "description": "",
       "name": "workspace",
       "operations": [
-        "getWorkspaceBillingDetails",
         "setWorkspacePaymentMethod",
         "listWorkspaceInvoices",
         "getUpcomingInvoice",

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

@@ -4237,91 +4237,6 @@ export declare const state: {
                 };
             };
         };
-        getWorkspaceBillingDetails: {
-            name: string;
-            description: string;
-            method: "get";
-            path: string;
-            disableDefaultParameters: {
-                "x-workspace-id": boolean;
-            };
-            parameters: {
-                id: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-            };
-            section: "workspace";
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
-                        currentPeriod: {
-                            type: "object";
-                            properties: {
-                                start: {
-                                    type: "string";
-                                };
-                                end: {
-                                    type: "string";
-                                };
-                                usage: {
-                                    type: "object";
-                                    properties: {
-                                        userMessages: {
-                                            type: "object";
-                                            properties: {
-                                                status: {
-                                                    type: "string";
-                                                    enum: string[];
-                                                };
-                                                quantity: {
-                                                    type: "number";
-                                                };
-                                                price: {
-                                                    type: "number";
-                                                };
-                                                minimum: {
-                                                    type: "number";
-                                                };
-                                                maximum: {
-                                                    type: "number";
-                                                };
-                                            };
-                                            required: string[];
-                                            additionalProperties: false;
-                                        };
-                                    };
-                                    required: string[];
-                                    additionalProperties: false;
-                                };
-                            };
-                            required: string[];
-                            additionalProperties: false;
-                        };
-                        paymentMethod: {
-                            type: "object";
-                            properties: {
-                                type: {
-                                    type: "string";
-                                };
-                                lastDigits: {
-                                    type: "string";
-                                };
-                            };
-                            required: string[];
-                            nullable: true;
-                            additionalProperties: false;
-                        };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
         setWorkspacePaymentMethod: {
             name: string;
             description: string;
@@ -7220,7 +7135,6 @@ export declare const state: {
                     type: "string";
                     description: string;
                     in: "header";
-                    required: true;
                 };
                 "x-tags": {
                     type: "string";
@@ -7823,6 +7737,10 @@ export declare const state: {
                             maximum: number;
                             description: string;
                         };
+                        frozen: {
+                            type: "boolean";
+                            description: string;
+                        };
                         schema: {
                             type: "object";
                             additionalProperties: true;
@@ -7891,6 +7809,10 @@ export declare const state: {
                             maximum: number;
                             description: string;
                         };
+                        frozen: {
+                            type: "boolean";
+                            description: string;
+                        };
                         schema: {
                             type: "object";
                             additionalProperties: true;
@@ -8001,6 +7923,10 @@ export declare const state: {
                             type: "string";
                             minLength: number;
                         };
+                        frozen: {
+                            type: "boolean";
+                            description: string;
+                        };
                         schema: {
                             type: "object";
                             additionalProperties: true;
@@ -8674,7 +8600,6 @@ export declare const state: {
             listBotIssuesResponse: true;
             deleteBotIssueResponse: true;
             listBotIssueEventsResponse: true;
-            getWorkspaceBillingDetailsResponse: true;
             setWorkspacePaymentMethodResponse: true;
             listWorkspaceInvoicesResponse: true;
             getUpcomingInvoiceResponse: true;
@@ -10225,6 +10150,10 @@ export declare const state: {
                         maximum: number;
                         description: string;
                     };
+                    frozen: {
+                        type: "boolean";
+                        description: string;
+                    };
                     schema: {
                         type: "object";
                         properties: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.21.0",
+  "version": "0.23.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":["getWorkspaceBillingDetails","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","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."}]}