@botpress/api 0.18.4 → 0.18.5

package/dist/index.js

@@ -274088,6 +274088,57 @@ var state = {
               "description": "Subscriptions of the bot",
               "additionalProperties": false
             },
+            "actions": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "type": "string",
+                    "maxLength": 64,
+                    "description": "Title of the action"
+                  },
+                  "description": {
+                    "type": "string",
+                    "maxLength": 256,
+                    "description": "Description of the action"
+                  },
+                  "input": {
+                    "type": "object",
+                    "properties": {
+                      "schema": {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    },
+                    "required": [
+                      "schema"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "output": {
+                    "type": "object",
+                    "properties": {
+                      "schema": {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    },
+                    "required": [
+                      "schema"
+                    ],
+                    "additionalProperties": false
+                  }
+                },
+                "required": [
+                  "input",
+                  "output"
+                ],
+                "description": "Action definition",
+                "additionalProperties": false
+              },
+              "description": "Actions definition"
+            },
             "configuration": {
               "type": "object",
               "properties": {
@@ -274402,6 +274453,57 @@ var state = {
                 "additionalProperties": false
               }
             },
+            "actions": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "title": {
+                    "type": "string",
+                    "maxLength": 64,
+                    "description": "Title of the action"
+                  },
+                  "description": {
+                    "type": "string",
+                    "maxLength": 256,
+                    "description": "Description of the action"
+                  },
+                  "input": {
+                    "type": "object",
+                    "properties": {
+                      "schema": {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    },
+                    "required": [
+                      "schema"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "output": {
+                    "type": "object",
+                    "properties": {
+                      "schema": {
+                        "type": "object",
+                        "additionalProperties": true
+                      }
+                    },
+                    "required": [
+                      "schema"
+                    ],
+                    "additionalProperties": false
+                  }
+                },
+                "required": [
+                  "input",
+                  "output"
+                ],
+                "description": "Action definition",
+                "nullable": true,
+                "additionalProperties": false
+              }
+            },
             "states": {
               "type": "object",
               "additionalProperties": {
@@ -275458,6 +275560,45 @@ var state = {
         }
       }
     },
+    "getUpcomingInvoice": {
+      "name": "getUpcomingInvoice",
+      "description": "Get upcoming invoice for workspace",
+      "method": "get",
+      "path": "/v1/admin/workspaces/{id}/billing/upcoming-invoice",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "Workspace ID",
+          "in": "path"
+        }
+      },
+      "section": "workspace",
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string",
+              "description": "ID of the invoice."
+            },
+            "total": {
+              "type": "number",
+              "description": "Total amount to pay of the invoice."
+            }
+          },
+          "required": [
+            "id",
+            "total"
+          ],
+          "title": "getUpcomingInvoiceResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "chargeWorkspaceUnpaidInvoices": {
       "name": "chargeWorkspaceUnpaidInvoices",
       "description": "Charge unpaid invoices of a workspace.",
@@ -279355,7 +279496,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.18.4",
+    "version": "0.18.5",
     "prefix": "v1"
   },
   "errors": [
@@ -279583,6 +279724,7 @@ var state = {
       "getWorkspaceBillingDetailsResponse": true,
       "setWorkspacePaymentMethodResponse": true,
       "listWorkspaceInvoicesResponse": true,
+      "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
       "createWorkspaceResponse": true,
       "getPublicWorkspaceResponse": true,
@@ -280031,6 +280173,57 @@ var state = {
             "description": "Subscriptions of the bot",
             "additionalProperties": false
           },
+          "actions": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "object",
+              "properties": {
+                "title": {
+                  "type": "string",
+                  "maxLength": 64,
+                  "description": "Title of the action"
+                },
+                "description": {
+                  "type": "string",
+                  "maxLength": 256,
+                  "description": "Description of the action"
+                },
+                "input": {
+                  "type": "object",
+                  "properties": {
+                    "schema": {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
+                  },
+                  "required": [
+                    "schema"
+                  ],
+                  "additionalProperties": false
+                },
+                "output": {
+                  "type": "object",
+                  "properties": {
+                    "schema": {
+                      "type": "object",
+                      "additionalProperties": true
+                    }
+                  },
+                  "required": [
+                    "schema"
+                  ],
+                  "additionalProperties": false
+                }
+              },
+              "required": [
+                "input",
+                "output"
+              ],
+              "description": "Action definition",
+              "additionalProperties": false
+            },
+            "description": "Actions definition"
+          },
           "name": {
             "type": "string",
             "description": "Name of the [Bot](#schema_bot)"
@@ -280096,6 +280289,7 @@ var state = {
           "events",
           "recurringEvents",
           "subscriptions",
+          "actions",
           "name",
           "dev",
           "alwaysAlive",
@@ -281789,6 +281983,7 @@ var state = {
         "getWorkspaceBillingDetails",
         "setWorkspacePaymentMethod",
         "listWorkspaceInvoices",
+        "getUpcomingInvoice",
         "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getPublicWorkspace",

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

@@ -2365,6 +2365,50 @@ export declare const state: {
                             description: string;
                             additionalProperties: false;
                         };
+                        actions: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    input: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                    output: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
+                            description: string;
+                        };
                         configuration: {
                             type: "object";
                             properties: {
@@ -2670,6 +2714,50 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        actions: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    input: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                    output: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
                         states: {
                             type: "object";
                             additionalProperties: {
@@ -3580,6 +3668,42 @@ export declare const state: {
                 };
             };
         };
+        getUpcomingInvoice: {
+            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: {
+                        id: {
+                            type: "string";
+                            description: string;
+                        };
+                        total: {
+                            type: "number";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         chargeWorkspaceUnpaidInvoices: {
             name: string;
             description: string;
@@ -7120,6 +7244,7 @@ export declare const state: {
             getWorkspaceBillingDetailsResponse: true;
             setWorkspacePaymentMethodResponse: true;
             listWorkspaceInvoicesResponse: true;
+            getUpcomingInvoiceResponse: true;
             chargeWorkspaceUnpaidInvoicesResponse: true;
             createWorkspaceResponse: true;
             getPublicWorkspaceResponse: true;
@@ -7517,6 +7642,50 @@ export declare const state: {
                         description: string;
                         additionalProperties: false;
                     };
+                    actions: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                input: {
+                                    type: "object";
+                                    properties: {
+                                        schema: {
+                                            type: "object";
+                                            additionalProperties: true;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
+                                };
+                                output: {
+                                    type: "object";
+                                    properties: {
+                                        schema: {
+                                            type: "object";
+                                            additionalProperties: true;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                        description: string;
+                    };
                     name: {
                         type: "string";
                         description: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.18.4",
+  "version": "0.18.5",
   "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":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"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":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","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","createTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"}],"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."}]}
+{"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":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"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":["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","createTable","updateTable","renameTableColumn","deleteTable","getTableRow","findTableRows","createTableRows","deleteTableRows","updateTableRows","upsertTableRows"],"schema":"Table"}],"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."}]}