@botpress/api 0.19.3 → 0.20.0

package/dist/index.js

@@ -273873,6 +273873,10 @@ var state = {
                     "type": "string",
                     "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
                   },
+                  "public": {
+                    "type": "boolean",
+                    "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                  },
                   "ownerWorkspace": {
                     "type": "object",
                     "properties": {
@@ -273903,6 +273907,7 @@ var state = {
                   "title",
                   "description",
                   "iconUrl",
+                  "public",
                   "ownerWorkspace"
                 ]
               }
@@ -274360,6 +274365,10 @@ var state = {
                   "type": "string",
                   "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
                 },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                },
                 "secrets": {
                   "type": "array",
                   "items": {
@@ -274408,6 +274417,7 @@ var state = {
                 "description",
                 "iconUrl",
                 "readmeUrl",
+                "public",
                 "secrets",
                 "ownerWorkspace"
               ],
@@ -274860,6 +274870,10 @@ var state = {
                   "type": "string",
                   "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
                 },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                },
                 "secrets": {
                   "type": "array",
                   "items": {
@@ -274908,6 +274922,7 @@ var state = {
                 "description",
                 "iconUrl",
                 "readmeUrl",
+                "public",
                 "secrets",
                 "ownerWorkspace"
               ],
@@ -278602,6 +278617,10 @@ var state = {
               "type": "string",
               "maxLength": 256,
               "description": "Description of the integration. This is the description that will be displayed in the UI"
+            },
+            "public": {
+              "type": "boolean",
+              "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
             }
           },
           "required": [
@@ -279025,6 +279044,10 @@ var state = {
             "url": {
               "type": "string",
               "description": "URL of the integration; Only available for dev integrations"
+            },
+            "public": {
+              "type": "boolean",
+              "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
             }
           },
           "title": "updateIntegrationBody",
@@ -279127,6 +279150,10 @@ var state = {
                   "iconUrl": {
                     "type": "string",
                     "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
+                  },
+                  "public": {
+                    "type": "boolean",
+                    "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
                   }
                 },
                 "required": [
@@ -279137,7 +279164,8 @@ var state = {
                   "updatedAt",
                   "title",
                   "description",
-                  "iconUrl"
+                  "iconUrl",
+                  "public"
                 ]
               }
             },
@@ -280053,6 +280081,11 @@ var state = {
           "description": "Query expressed in natural language to retrieve matching text passages within all files using semantical search.",
           "required": true
         },
+        "contextDepth": {
+          "in": "query",
+          "type": "string",
+          "description": "The number of neighbor passages to prepend and append as surrounding context to the content of each returned passage. Default: 0, Maximum: 10"
+        },
         "limit": {
           "in": "query",
           "type": "string",
@@ -280812,7 +280845,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.19.3",
+    "version": "0.20.0",
     "prefix": "v1"
   },
   "errors": [
@@ -280925,6 +280958,11 @@ var state = {
       "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."
     }
   ],
   "refs": {
@@ -281226,6 +281264,10 @@ var state = {
                 "iconUrl": {
                   "type": "string",
                   "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
+                },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
                 }
               },
               "required": [
@@ -281242,7 +281284,8 @@ var state = {
                 "updatedAt",
                 "title",
                 "description",
-                "iconUrl"
+                "iconUrl",
+                "public"
               ],
               "additionalProperties": false
             },
@@ -282032,6 +282075,10 @@ var state = {
             "type": "string",
             "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
           },
+          "public": {
+            "type": "boolean",
+            "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+          },
           "secrets": {
             "type": "array",
             "items": {
@@ -282059,6 +282106,7 @@ var state = {
           "description",
           "iconUrl",
           "readmeUrl",
+          "public",
           "secrets"
         ],
         "additionalProperties": false

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

@@ -2162,6 +2162,10 @@ export declare const state: {
                                         type: "string";
                                         description: string;
                                     };
+                                    public: {
+                                        type: "boolean";
+                                        description: string;
+                                    };
                                     ownerWorkspace: {
                                         type: "object";
                                         properties: {
@@ -2590,6 +2594,10 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
+                                public: {
+                                    type: "boolean";
+                                    description: string;
+                                };
                                 secrets: {
                                     type: "array";
                                     items: {
@@ -3021,6 +3029,10 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
+                                public: {
+                                    type: "boolean";
+                                    description: string;
+                                };
                                 secrets: {
                                     type: "array";
                                     items: {
@@ -6187,6 +6199,10 @@ export declare const state: {
                             maxLength: number;
                             description: string;
                         };
+                        public: {
+                            type: "boolean";
+                            description: string;
+                        };
                     };
                     required: string[];
                     title: string;
@@ -6579,6 +6595,10 @@ export declare const state: {
                             type: "string";
                             description: string;
                         };
+                        public: {
+                            type: "boolean";
+                            description: string;
+                        };
                     };
                     title: string;
                     additionalProperties: false;
@@ -6679,6 +6699,10 @@ export declare const state: {
                                         type: "string";
                                         description: string;
                                     };
+                                    public: {
+                                        type: "boolean";
+                                        description: string;
+                                    };
                                 };
                                 required: string[];
                             };
@@ -7481,6 +7505,11 @@ export declare const state: {
                     description: string;
                     required: true;
                 };
+                contextDepth: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
                 limit: {
                     in: "query";
                     type: "string";
@@ -8529,6 +8558,10 @@ export declare const state: {
                                     type: "string";
                                     description: string;
                                 };
+                                public: {
+                                    type: "boolean";
+                                    description: string;
+                                };
                             };
                             required: string[];
                             additionalProperties: false;
@@ -9215,6 +9248,10 @@ export declare const state: {
                         type: "string";
                         description: string;
                     };
+                    public: {
+                        type: "boolean";
+                        description: string;
+                    };
                     secrets: {
                         type: "array";
                         items: {

package/package.json

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