From b48de46b3f0f5cfa846b3ecbcf86a3fe9bd4c009 Mon Sep 17 00:00:00 2001 From: Pascal Breton <179493770+pascal-botpress@users.noreply.github.com> Date: Fri, 3 Jul 2026 13:05:28 -0400 Subject: [PATCH] chore(api): update botpress/api and regen --- admin-openapi.json | 998 +++++++++++++++++++++++++++++++--------- files-openapi.json | 68 ++- package.json | 2 +- pnpm-lock.yaml | 18 +- runtime-openapi.json | 1024 ++++++++++++++++++++++++++++++++++++++++-- tables-openapi.json | 2 +- 6 files changed, 1851 insertions(+), 261 deletions(-) diff --git a/admin-openapi.json b/admin-openapi.json index cb7c6bc3..33a7a001 100644 --- a/admin-openapi.json +++ b/admin-openapi.json @@ -8,7 +8,7 @@ "info": { "title": "Botpress Admin API", "description": "API for Botpress Cloud Manager", - "version": "1.82.0" + "version": "1.112.0" }, "paths": { "/v1/admin/helper/vrl": { @@ -371,6 +371,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "limit", "in": "query", @@ -604,6 +612,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "name", "in": "query", @@ -870,6 +886,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "name", "in": "query", @@ -1078,6 +1102,28 @@ } } }, + { + "name": "integrationNames", + "in": "query", + "description": "Filter bots that have ALL of these integrations installed (by definition name)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, + { + "name": "pluginNames", + "in": "query", + "description": "Filter bots that have ALL of these plugins installed (by definition name)", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + }, { "name": "nextToken", "in": "query", @@ -1086,6 +1132,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "sortField", "in": "query", @@ -1213,15 +1267,6 @@ "type": "string" } }, - { - "name": "shouldMergePlugins", - "in": "query", - "description": "UNUSED. Please ignore this field. It will be removed in the near future.", - "required": false, - "schema": { - "type": "boolean" - } - }, { "name": "x-workspace-id", "in": "header", @@ -1725,6 +1770,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-workspace-id", "in": "header", @@ -1903,6 +1956,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-workspace-id", "in": "header", @@ -3085,6 +3146,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "handle", "in": "query", @@ -3659,6 +3728,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "workspaceIds", "in": "query", @@ -3721,6 +3798,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "id", "in": "path", @@ -3858,6 +3943,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-workspace-id", "in": "header", @@ -4287,6 +4380,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "limit", "in": "query", @@ -5028,6 +5129,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "name", "in": "query", @@ -5355,6 +5464,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "name", "in": "query", @@ -6052,6 +6169,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-workspace-id", "in": "header", @@ -6154,6 +6279,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-workspace-id", "in": "header", @@ -6251,6 +6384,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "taskId", "in": "query", @@ -6624,10 +6765,6 @@ "type": "string", "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI" }, - "readmeUrl": { - "type": "string", - "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI" - }, "public": { "type": "boolean", "description": "[DEPRECATED] Indicates if the plugin is public. Please use the \"visibility\" parameter instead.", @@ -6662,7 +6799,6 @@ "title", "description", "iconUrl", - "readmeUrl", "public", "visibility", "lifecycleStatus" @@ -6913,7 +7049,103 @@ "additionalProperties": false }, "nullable": true, - "description": "Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events." + "deprecated": true, + "description": "[DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events." + }, + "integrations": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific integrations. Keyed by integration alias." + }, + "plugins": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific plugins. Keyed by plugin alias." + }, + "bot": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false } }, "required": [ @@ -7055,6 +7287,15 @@ ] }, "description": "Media files associated with the [Bot](#schema_bot)" + }, + "type": { + "type": "string", + "enum": [ + "studio", + "adk", + "desk" + ], + "description": "Type of the [Bot](#schema_bot)" } }, "required": [ @@ -7079,7 +7320,8 @@ "secrets", "alwaysAlive", "status", - "medias" + "medias", + "type" ], "additionalProperties": false }, @@ -7678,14 +7920,6 @@ "additionalProperties": false } }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "dev": { "type": "boolean", "description": "Indicates if the integration is a development integration; Dev integrations run locally" @@ -7747,6 +7981,14 @@ "type": "string" }, "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the integration definition" } }, "required": [ @@ -7993,14 +8235,6 @@ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -8023,6 +8257,14 @@ "public": { "type": "boolean", "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the interface definition" } }, "required": [ @@ -8382,14 +8624,6 @@ "description": "Message object configuration", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -8430,6 +8664,14 @@ "deprecated" ], "description": "The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the plugin definition" } }, "required": [ @@ -8492,7 +8734,8 @@ "community", "team", "enterprise", - "plus" + "plus", + "managed" ] }, "blocked": { @@ -9267,7 +9510,8 @@ "attributes": { "type": "object", "additionalProperties": { - "type": "string" + "type": "string", + "maxLength": 200 }, "description": "Optional key-value attributes from the integration definition" } @@ -9913,14 +10157,6 @@ "additionalProperties": false } }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "dev": { "type": "boolean", "description": "Indicates if the integration is a development integration; Dev integrations run locally" @@ -9983,6 +10219,14 @@ }, "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing." }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the integration definition" + }, "ownerWorkspace": { "type": "object", "properties": { @@ -10666,14 +10910,6 @@ "additionalProperties": false } }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "dev": { "type": "boolean", "description": "Indicates if the integration is a development integration; Dev integrations run locally" @@ -10736,6 +10972,14 @@ }, "description": "Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing." }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the integration definition" + }, "ownerWorkspace": { "type": "object", "properties": { @@ -10870,10 +11114,6 @@ "type": "string", "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI" }, - "readmeUrl": { - "type": "string", - "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI" - }, "public": { "type": "boolean", "description": "[DEPRECATED] Indicates if the plugin is public. Please use the \"visibility\" parameter instead.", @@ -10906,7 +11146,6 @@ "title", "description", "iconUrl", - "readmeUrl", "public", "visibility", "lifecycleStatus" @@ -11280,14 +11519,6 @@ "description": "Message object configuration", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -11328,6 +11559,14 @@ "deprecated" ], "description": "The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the plugin definition" } }, "required": [ @@ -11710,14 +11949,6 @@ "description": "Message object configuration", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -11758,6 +11989,14 @@ "deprecated" ], "description": "The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the plugin definition" } }, "required": [ @@ -12140,14 +12379,6 @@ "description": "Message object configuration", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -12188,6 +12419,14 @@ "deprecated" ], "description": "The lifecycle status of the plugin. When a plugin is deprecated, it can no longer be installed." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the plugin definition" } }, "required": [ @@ -12561,14 +12800,6 @@ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -12591,6 +12822,14 @@ "public": { "type": "boolean", "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the interface definition" } }, "required": [ @@ -12841,14 +13080,6 @@ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "title": { "type": "string", "minLength": 1, @@ -12871,6 +13102,14 @@ "public": { "type": "boolean", "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the interface definition" } }, "required": [ @@ -13015,6 +13254,15 @@ "type": "string" }, "description": "Tags of [Bot](#schema_bot)" + }, + "type": { + "type": "string", + "enum": [ + "studio", + "adk", + "desk" + ], + "description": "Type of the [Bot](#schema_bot)" } }, "required": [ @@ -13022,7 +13270,8 @@ "createdAt", "updatedAt", "name", - "tags" + "tags", + "type" ] } }, @@ -13168,7 +13417,7 @@ }, "endDateTimeUtc": { "type": "string", - "description": "ISO 8601 date string of the end (inclusive) of the period" + "description": "ISO 8601 date string of the end (exclusive) of the period" }, "returningUsers": { "type": "integer" @@ -13192,6 +13441,10 @@ "events": { "type": "integer" }, + "conversationsCreated": { + "type": "integer", + "description": "Number of conversations created during the period" + }, "eventTypes": { "type": "object", "additionalProperties": { @@ -13204,6 +13457,120 @@ "type": "number" } }, + "workflows": { + "type": "object", + "properties": { + "created": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "timedout": { + "type": "integer" + }, + "cancelled": { + "type": "integer" + }, + "duration": { + "type": "object", + "properties": { + "count": { + "type": "integer" + }, + "sum": { + "type": "number" + }, + "mean": { + "type": "number" + }, + "min": { + "type": "number" + }, + "max": { + "type": "number" + } + }, + "required": [ + "count", + "sum", + "mean", + "min", + "max" + ] + }, + "byName": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "created": { + "type": "integer" + }, + "completed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "timedout": { + "type": "integer" + }, + "cancelled": { + "type": "integer" + }, + "duration": { + "type": "object", + "properties": { + "count": { + "type": "integer" + }, + "sum": { + "type": "number" + }, + "mean": { + "type": "number" + }, + "min": { + "type": "number" + }, + "max": { + "type": "number" + } + }, + "required": [ + "count", + "sum", + "mean", + "min", + "max" + ] + } + }, + "required": [ + "created", + "completed", + "failed", + "timedout", + "cancelled", + "duration" + ] + } + } + }, + "required": [ + "created", + "completed", + "failed", + "timedout", + "cancelled", + "duration", + "byName" + ] + }, "llm": { "type": "object", "properties": { @@ -13317,8 +13684,10 @@ "userMessages", "botMessages", "events", + "conversationsCreated", "eventTypes", "customEvents", + "workflows", "llm" ] } @@ -14319,7 +14688,8 @@ "community", "team", "enterprise", - "plus" + "plus", + "managed" ] }, "blocked": { @@ -14480,7 +14850,8 @@ "community", "team", "enterprise", - "plus" + "plus", + "managed" ] }, "blocked": { @@ -14800,7 +15171,8 @@ "community", "team", "enterprise", - "plus" + "plus", + "managed" ] }, "blocked": { @@ -14937,7 +15309,8 @@ "community", "team", "enterprise", - "plus" + "plus", + "managed" ] }, "blocked": { @@ -15788,7 +16161,8 @@ "attributes": { "type": "object", "additionalProperties": { - "type": "string" + "type": "string", + "maxLength": 200 }, "description": "Optional key-value attributes from the integration definition" } @@ -16299,10 +16673,6 @@ "type": "string", "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI" }, - "readmeUrl": { - "type": "string", - "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI" - }, "public": { "type": "boolean", "description": "[DEPRECATED] Indicates if the plugin is public. Please use the \"visibility\" parameter instead.", @@ -16335,7 +16705,6 @@ "title", "description", "iconUrl", - "readmeUrl", "public", "visibility", "lifecycleStatus" @@ -16865,25 +17234,6 @@ "additionalProperties": false } }, - "subscriptions": { - "type": "object", - "properties": { - "events": { - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": false - }, - "nullable": true, - "description": "Events that the bot is currently subscribed on (ex: \"slack:reactionAdded\"). If null, the bot is subscribed to all events." - } - }, - "required": [ - "events" - ], - "description": "Subscriptions of the bot", - "additionalProperties": false - }, "actions": { "type": "object", "additionalProperties": { @@ -17051,6 +17401,123 @@ }, "description": "Optional attributes of the [Bot](#schema_bot)" }, + "maxExecutionTime": { + "type": "integer", + "description": "Maximum execution time (in seconds)." + }, + "subscriptions": { + "type": "object", + "properties": { + "integrations": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific integrations. Keyed by integration alias." + }, + "plugins": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific plugins. Keyed by plugin alias." + }, + "bot": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "events": { + "type": "object", + "additionalProperties": { + "type": "object", + "nullable": true, + "additionalProperties": false + }, + "nullable": true, + "deprecated": true, + "description": "[DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events." + } + }, + "description": "Subscriptions of the bot", + "additionalProperties": false + }, "code": { "type": "string", "description": "JavaScript code of the bot" @@ -17099,6 +17566,13 @@ "dev": { "type": "boolean", "description": "Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations" + }, + "type": { + "type": "string", + "enum": [ + "studio", + "adk" + ] } }, "title": "createBotBody", @@ -17143,25 +17617,26 @@ }, "additionalProperties": false }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 500 - }, - "description": "Optional attributes of the [Bot](#schema_bot)" - }, - "blocked": { - "type": "boolean" - }, "maxExecutionTime": { "type": "integer", "description": "Maximum execution time (in seconds)." }, + "blocked": { + "type": "boolean" + }, "alwaysAlive": { "type": "boolean", "description": "Indicates if the [Bot](#schema_bot) should be in always alive mode" }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 500, + "nullable": true + }, + "description": "Optional attributes of the [Bot](#schema_bot). Set to null or empty string to remove." + }, "user": { "type": "object", "properties": { @@ -17518,6 +17993,101 @@ "subscriptions": { "type": "object", "properties": { + "integrations": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific integrations. Keyed by integration alias." + }, + "plugins": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, + "description": "Subscriptions for events coming from specific plugins. Keyed by plugin alias." + }, + "bot": { + "type": "object", + "properties": { + "events": { + "type": "object", + "properties": { + "include": { + "type": "array", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Event filter for a source. Provide exactly one of `include` (deliver only the listed event types) or `exclude` (deliver all but the listed types); they are mutually exclusive, and providing both or neither is rejected. Set the entire `events` record to `null` to remove all filters for this source.", + "nullable": true, + "additionalProperties": false + } + }, + "required": [ + "events" + ], + "additionalProperties": false + }, "events": { "type": "object", "additionalProperties": { @@ -17525,12 +18095,12 @@ "nullable": true, "additionalProperties": false }, - "nullable": true + "nullable": true, + "deprecated": true, + "description": "[DEPRECATED] Use `integrations`, `plugins`, and `bot` instead. Mapped onto the new per-source fields incrementally (each entry adds or removes its own event type). Cannot be combined with the new fields in the same request. If null, the bot is subscribed to all events." } }, - "required": [ - "events" - ], + "description": "Subscriptions of the bot", "additionalProperties": false }, "code": { @@ -17581,9 +18151,12 @@ "type": "string" } }, - "shouldMergePlugins": { - "type": "boolean", - "description": "UNUSED. Please ignore this field. It will be removed in the near future." + "type": { + "type": "string", + "enum": [ + "studio", + "adk" + ] } }, "title": "updateBotBody", @@ -17796,6 +18369,12 @@ "properties": { "name": { "type": "string" + }, + "billingVersion": { + "type": "string", + "enum": [ + "v4" + ] } }, "required": [ @@ -17918,6 +18497,9 @@ "administrator", "owner" ] + }, + "sendEmail": { + "type": "boolean" } }, "required": [ @@ -18222,14 +18804,6 @@ "additionalProperties": false } }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "identifier": { "type": "object", "properties": { @@ -18566,6 +19140,14 @@ "items": { "type": "string" } + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the integration definition" } }, "required": [ @@ -18822,14 +19404,6 @@ "additionalProperties": false } }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "identifier": { "type": "object", "properties": { @@ -19166,6 +19740,14 @@ "items": { "type": "string" } + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the integration definition" } }, "required": [ @@ -19273,9 +19855,10 @@ "required": [ "enabled" ], + "nullable": true, "additionalProperties": false }, - "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name." + "description": "**EXPERIMENTAL** extra integration operations enabled for this integration. Keys map to operation names. A value of `null` or `{ enabled: false }` removes the operation; `{ enabled: true }` enables it. Operations that are not provided are left unchanged." }, "sdkVersion": { "type": "string", @@ -19712,7 +20295,7 @@ "maxLength": 200, "nullable": true }, - "description": "Optional attributes. Set attributes to null to remove them" + "description": "Optional key-value attributes. Set attributes to null to remove them" }, "secrets": { "type": "object", @@ -19885,9 +20468,10 @@ "required": [ "enabled" ], + "nullable": true, "additionalProperties": false }, - "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name." + "description": "**EXPERIMENTAL** extra integration operations enabled for this integration. Keys map to operation names. A value of `null` or `{ enabled: false }` removes the operation; `{ enabled: true }` enables it. Operations that are not provided are left unchanged." }, "sdkVersion": { "type": "string", @@ -20324,7 +20908,7 @@ "maxLength": 200, "nullable": true }, - "description": "Optional attributes. Set attributes to null to remove them" + "description": "Optional key-value attributes. Set attributes to null to remove them" }, "secrets": { "type": "object", @@ -20611,14 +21195,6 @@ "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "sdkVersion": { "type": "string", "maxLength": 200 @@ -20645,6 +21221,14 @@ "public": { "type": "boolean", "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the interface definition" } }, "required": [ @@ -20851,15 +21435,6 @@ "nullable": true, "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200, - "nullable": true - }, - "description": "Optional attributes. Set attributes to null to remove them" - }, "sdkVersion": { "type": "string", "maxLength": 200 @@ -20886,6 +21461,15 @@ "public": { "type": "boolean", "description": "Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version." + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200, + "nullable": true + }, + "description": "Optional key-value attributes. Set attributes to null to remove them" } }, "title": "updateInterfaceBody", @@ -21157,14 +21741,6 @@ "description": "Message object configuration", "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200 - }, - "description": "Optional attributes" - }, "sdkVersion": { "type": "string", "maxLength": 200 @@ -21269,6 +21845,14 @@ } }, "additionalProperties": false + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "Optional key-value attributes from the plugin definition" } }, "required": [ @@ -21539,15 +22123,6 @@ ], "additionalProperties": false }, - "attributes": { - "type": "object", - "additionalProperties": { - "type": "string", - "maxLength": 200, - "nullable": true - }, - "description": "Optional attributes. Set attributes to null to remove them" - }, "sdkVersion": { "type": "string", "maxLength": 200 @@ -21650,6 +22225,15 @@ } }, "additionalProperties": false + }, + "attributes": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200, + "nullable": true + }, + "description": "Optional key-value attributes. Set attributes to null to remove them" } }, "title": "updatePluginBody", diff --git a/files-openapi.json b/files-openapi.json index 2d4dcf35..87d9eba7 100644 --- a/files-openapi.json +++ b/files-openapi.json @@ -8,7 +8,7 @@ "info": { "title": "Botpress Files API", "description": "API for Botpress Files", - "version": "1.82.0" + "version": "1.112.0" }, "paths": { "/v1/files": { @@ -103,6 +103,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "sortField", "in": "query", @@ -742,6 +750,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "id", "in": "path", @@ -934,6 +950,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "x-bot-id", "in": "header", @@ -1020,6 +1044,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "tag", "in": "path", @@ -1195,6 +1227,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "tags", "in": "query", @@ -2781,6 +2821,11 @@ "type": "string", "description": "Name of the knowledge base." }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the knowledge base." + }, "tags": { "type": "object", "additionalProperties": { @@ -2835,6 +2880,11 @@ "type": "string", "description": "Name of the knowledge base." }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the knowledge base." + }, "tags": { "type": "object", "additionalProperties": { @@ -2879,6 +2929,11 @@ "type": "string", "description": "Name of the knowledge base." }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the knowledge base." + }, "createdAt": { "type": "string", "description": "Knowledge base creation timestamp in ISO 8601 format" @@ -3229,6 +3284,11 @@ "type": "string", "description": "Name of the knowledge base." }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the knowledge base." + }, "tags": { "type": "object", "additionalProperties": { @@ -3256,6 +3316,12 @@ "type": "string", "description": "New name of the knowledge base." }, + "description": { + "type": "string", + "maxLength": 1000, + "description": "Description of the knowledge base. Omit to keep the existing description; set to `null` to clear it.", + "nullable": true + }, "tags": { "type": "object", "additionalProperties": { diff --git a/package.json b/package.json index 20fddbd1..e2ebe8b4 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ "generate-api-reference": "ts-node generate-api-reference.ts" }, "dependencies": { - "@botpress/api": "1.82.0", + "@botpress/api": "1.112.0", "glob": "11.0.1", "mintlify": "^4.0.461", "optional": "^0.1.4" diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 3011e223..7aed69f6 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -9,8 +9,8 @@ importers: .: dependencies: '@botpress/api': - specifier: 1.82.0 - version: 1.82.0(openapi-types@12.1.3) + specifier: 1.112.0 + version: 1.112.0(openapi-types@12.1.3) glob: specifier: 11.0.1 version: 11.0.1 @@ -81,8 +81,8 @@ packages: resolution: {integrity: sha512-E/jKbPoca1tfUPj3iSbitDZTGnq6FUFjkH6L8U2oDwSuwK1WhnnVtCG7oFOTg/DDnyoXbQYUiUiGOibHqaGVnw==} engines: {node: '>= 16'} - '@botpress/api@1.82.0': - resolution: {integrity: sha512-X1l1Vq+t/ZVMqPeKexHf9vrPkIRmN7ct4sEOo5eAcRKSxb3Ksvxbo/XmDvZQEb0sxl4AcMSVOuo0WenUBJ9gWw==} + '@botpress/api@1.112.0': + resolution: {integrity: sha512-NVDac3QShUKkAJG+faYFNP8yUDOPLfqZ/IdcJA/5nuRU18If+SJfnfGN6cnlyggrFs1SKxOfsXC64hN67pEtXw==} '@bpinternal/opapi@1.0.0': resolution: {integrity: sha512-r38k8SZSyu0s4YKukTrHaBeb8tlL8vgJiNdawnN2cmxbqkSdsss2pWnZQU2fsSLijhcfV0tUvGCf8GfgZviYBA==} @@ -4406,7 +4406,7 @@ snapshots: ajv-errors: 3.0.0(ajv@8.18.0) ajv-formats: 2.1.1(ajv@8.18.0) avsc: 5.7.9 - js-yaml: 4.1.0 + js-yaml: 4.1.1 jsonpath-plus: 10.4.0 node-fetch: 2.6.7 transitivePeerDependencies: @@ -4433,7 +4433,7 @@ snapshots: call-me-maybe: 1.0.2 js-yaml: 4.1.1 - '@botpress/api@1.82.0(openapi-types@12.1.3)': + '@botpress/api@1.112.0(openapi-types@12.1.3)': dependencies: '@bpinternal/opapi': 1.0.0(openapi-types@12.1.3) transitivePeerDependencies: @@ -5231,7 +5231,7 @@ snapshots: extract-zip: 2.0.1 progress: 2.0.3 proxy-agent: 6.5.0 - semver: 7.7.2 + semver: 7.7.4 tar-fs: 3.1.2 unbzip2-stream: 1.4.3 yargs: 17.7.2 @@ -6318,7 +6318,7 @@ snapshots: dependencies: env-paths: 2.2.1 import-fresh: 3.3.1 - js-yaml: 4.1.0 + js-yaml: 4.1.1 parse-json: 5.2.0 optionalDependencies: typescript: 5.9.3 @@ -9186,7 +9186,7 @@ snapshots: dependencies: color: 4.2.3 detect-libc: 2.1.2 - semver: 7.7.2 + semver: 7.7.4 optionalDependencies: '@img/sharp-darwin-arm64': 0.33.5 '@img/sharp-darwin-x64': 0.33.5 diff --git a/runtime-openapi.json b/runtime-openapi.json index f5ca6e6f..3c6afb10 100644 --- a/runtime-openapi.json +++ b/runtime-openapi.json @@ -8,7 +8,7 @@ "info": { "title": "Botpress Runtime API", "description": "API for Botpress Runtime", - "version": "1.82.0" + "version": "1.112.0" }, "paths": { "/v1/chat/conversations": { @@ -16,6 +16,15 @@ "operationId": "createConversation", "description": "Creates a new [Conversation](#schema_conversation). When creating a new [Conversation](#schema_conversation), the required tags must be provided. See the specific integration for more details.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -42,6 +51,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -76,6 +94,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "sortField", "in": "query", @@ -154,6 +180,31 @@ "type": "string" } }, + { + "name": "minMessageCount", + "in": "query", + "description": "Filter conversations with a message count greater than or equal to this value (inclusive)", + "schema": { + "type": "integer" + } + }, + { + "name": "maxMessageCount", + "in": "query", + "description": "Filter conversations with a message count less than or equal to this value (inclusive)", + "schema": { + "type": "integer" + } + }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -180,6 +231,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -214,6 +274,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -240,6 +309,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -272,6 +350,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -298,6 +385,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -333,6 +429,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -359,6 +464,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -384,6 +498,15 @@ "operationId": "getOrCreateConversation", "description": "Retrieves the [Conversation](#schema_conversation) object containing given tags. If the conversation does not exist, it will be created. Tags will be updated if they are set in the request body.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -410,6 +533,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -446,6 +578,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "id", "in": "path", @@ -455,6 +595,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -481,6 +630,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -513,6 +671,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -539,6 +706,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -585,6 +761,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -611,6 +796,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -652,6 +846,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -678,6 +881,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -703,6 +915,15 @@ "operationId": "createEvent", "description": "Creates a new [Event](#schema_event). When creating a new [Event](#schema_event), the required tags must be provided. See the specific integration for more details.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -729,6 +950,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -763,6 +993,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "type", "in": "query", @@ -818,6 +1056,15 @@ ] } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -844,6 +1091,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -878,6 +1134,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -904,6 +1169,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -938,6 +1212,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -964,6 +1247,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -989,6 +1281,15 @@ "operationId": "createMessage", "description": "Creates a new [Message](#schema_message). When creating a new [Message](#schema_message), the required tags must be provided. See the specific integration for more details.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1015,6 +1316,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1049,6 +1359,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "conversationId", "in": "query", @@ -1084,6 +1402,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1110,6 +1437,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1135,6 +1471,15 @@ "operationId": "getOrCreateMessage", "description": "Retrieves the [Message](#schema_message) object for given discriminating tags. If the message does not exist, it will be created. If the message already exists, its tags and payload will be updated with the provided values if they are defined.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1161,6 +1506,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1198,6 +1552,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1224,6 +1587,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1256,6 +1628,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1282,6 +1663,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1317,6 +1707,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1343,6 +1742,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1368,6 +1776,15 @@ "operationId": "initializeIncomingMessage", "description": "Initializes a user, conversation and sends a message to the conversation.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1394,6 +1811,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1424,6 +1850,15 @@ "operationId": "importMessages", "description": "Imports messages if no matching messages already exist. On partial failure, returns an [Error](#errors) with both `resolvedMessages` and `failedMessages` arrays.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1450,6 +1885,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1480,6 +1924,15 @@ "operationId": "createUser", "description": "Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1506,6 +1959,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1540,6 +2002,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "conversationId", "in": "query", @@ -1611,6 +2081,15 @@ ] } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1637,6 +2116,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1671,6 +2159,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1697,6 +2194,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1729,6 +2235,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1755,6 +2270,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1790,6 +2314,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1816,6 +2349,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1841,6 +2383,15 @@ "operationId": "getOrCreateUser", "description": "Retrieves the [User](#schema_user) object for given discriminating tags. If the user does not exist, it will be created. If the user already exists, its name, pictureUrl, attributes, and tags will be updated with the provided values.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1867,6 +2418,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1929,6 +2489,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -1955,6 +2524,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -1981,7 +2559,7 @@ "/v1/chat/states/{type}/{id}/{name}": { "get": { "operationId": "getState", - "description": "Retrieves the [State](#schema_state) object for a valid identifiers.", + "description": "Retrieves the [State](#schema_state) object for a valid identifier.", "parameters": [ { "name": "type", @@ -2017,6 +2595,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2043,6 +2630,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2100,6 +2696,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2126,6 +2731,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2186,6 +2800,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2212,6 +2835,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2274,6 +2906,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2300,6 +2941,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2328,6 +2978,15 @@ "operationId": "callAction", "description": "Call an action", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2347,9 +3006,18 @@ } }, { - "name": "x-integration-alias", + "name": "x-integration-alias", + "in": "header", + "description": "Integration alias", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "x-real-ip", "in": "header", - "description": "Integration alias", + "description": "Caller's IP address. Injected by the edge proxy.", "required": false, "schema": { "type": "string" @@ -2382,6 +3050,15 @@ "operationId": "configureIntegration", "description": "An integration can call this endpoint to configure itself", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2408,6 +3085,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2436,6 +3122,15 @@ "operationId": "createWorkflow", "description": "Creates a new [Workflow](#schema_workflow).", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2462,6 +3157,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2497,6 +3201,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "tags", "in": "query", @@ -2561,6 +3273,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2587,6 +3308,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2622,6 +3352,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2648,6 +3387,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2681,6 +3429,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2707,6 +3464,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2743,6 +3509,15 @@ "type": "string" } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2769,6 +3544,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2793,8 +3577,17 @@ "/v1/chat/workflows/get-or-create": { "post": { "operationId": "getOrCreateWorkflow", - "description": "Get a workflow by tags or creates a new [Workflow](#schema_workflow) if it doesn't exists.", + "description": "Get a workflow by tags, or creates a new [Workflow](#schema_workflow) if it doesn't exist. If the workflow already exists, its tags, timeoutAt, and userId will be updated with the provided values, unless the workflow is in a finished state.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2821,6 +3614,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2848,7 +3650,7 @@ "/v1/chat/tags/{key}/values": { "get": { "operationId": "listTagValues", - "description": "Get a bot tag values", + "description": "[REMOVED] This endpoint is no longer functional and will return HTTP 410 Gone. Do not use.", "parameters": [ { "name": "nextToken", @@ -2858,6 +3660,14 @@ "type": "string" } }, + { + "name": "pageSize", + "in": "query", + "description": "Number of items to return per page (default 20, max 100)", + "schema": { + "type": "integer" + } + }, { "name": "key", "in": "path", @@ -2881,6 +3691,15 @@ ] } }, + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2907,6 +3726,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2920,11 +3748,13 @@ "tags": [ "Endpoints" ], + "deprecated": true, "x-mint": { "metadata": { "title": "listTagValues" } - } + }, + "x-hidden": true } }, "/v1/chat/analytics": { @@ -2932,6 +3762,15 @@ "operationId": "trackAnalytics", "description": "Add an event to the analytics", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -2958,6 +3797,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -2987,6 +3835,15 @@ "operationId": "captureObservation", "description": "Capture a bot runtime observation. Does not support integration observations yet.", "parameters": [ + { + "name": "x-bp-authenticated-principal", + "in": "header", + "description": "Authenticated principal. Injected by the authentication middleware.", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "x-bot-id", "in": "header", @@ -3013,6 +3870,15 @@ "schema": { "type": "string" } + }, + { + "name": "x-real-ip", + "in": "header", + "description": "Caller's IP address. Injected by the edge proxy.", + "required": false, + "schema": { + "type": "string" + } } ], "responses": { @@ -3118,12 +3984,6 @@ "deprecated": true, "description": "Unused. This field will be removed in the future." }, - "currentWorkflowId": { - "type": "string", - "minLength": 28, - "maxLength": 36, - "description": "Id of the current [Workflow](#schema_workflow)" - }, "createdAt": { "type": "string", "format": "date-time", @@ -3152,6 +4012,14 @@ "messageCount": { "type": "number", "description": "Number of messages in the conversation" + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." } }, "required": [ @@ -3372,6 +4240,16 @@ "type": "object", "additionalProperties": true, "description": "Payload is the content of the state defined by your bot." + }, + "expiry": { + "type": "number", + "minimum": 1, + "description": "Expiry of the state in milliseconds. The state will expire if it is idle for the configured value. Absent if no expiry is set." + }, + "expiresAt": { + "type": "string", + "format": "date-time", + "description": "Expiration date of the ${ref.state} in ISO 8601 format. Absent if no expiry is set." } }, "required": [ @@ -4151,7 +5029,7 @@ } }, "getStateResponse": { - "description": "Returns the [State](#schema_state) object if a valid identifiers were provided. Returns [an error](#errors) otherwise", + "description": "Returns the [State](#schema_state) object if a valid identifier was provided. Returns [an error](#errors) otherwise", "content": { "application/json": { "schema": { @@ -4410,7 +5288,7 @@ } }, "getOrCreateWorkflowResponse": { - "description": "Returns a [Workflow](#schema_workflow) object if creation succeeds. Returns an [Error](#errors) otherwise", + "description": "Returns a new or updated [Workflow](#schema_workflow) object if the operation succeeds. Returns an [Error](#errors) otherwise", "content": { "application/json": { "schema": { @@ -4418,10 +5296,23 @@ "properties": { "workflow": { "$ref": "#/components/schemas/Workflow" + }, + "meta": { + "type": "object", + "properties": { + "created": { + "type": "boolean" + } + }, + "required": [ + "created" + ], + "additionalProperties": false } }, "required": [ - "workflow" + "workflow", + "meta" ], "title": "getOrCreateWorkflowResponse", "additionalProperties": false @@ -4430,7 +5321,7 @@ } }, "listTagValuesResponse": { - "description": "Empty response", + "description": "This endpoint always returns HTTP 410 Gone.", "content": { "application/json": { "schema": { @@ -4522,6 +5413,14 @@ "maxLength": 200, "description": "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.", "deprecated": true + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." } }, "required": [ @@ -4550,9 +5449,10 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 500 + "maxLength": 500, + "nullable": true }, - "description": "Tags for the [Conversation](#schema_conversation)" + "description": "Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove." }, "integrationName": { "type": "string", @@ -4560,6 +5460,15 @@ "description": "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.", "deprecated": true }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200, + "nullable": true + }, + "description": "**EXPERIMENTAL** - Optional shared properties. Set individual properties to null or empty string to remove them." + }, "discriminateByTags": { "type": "array", "items": { @@ -4594,9 +5503,20 @@ "tags": { "type": "object", "additionalProperties": { - "type": "string" + "type": "string", + "maxLength": 500, + "nullable": true }, - "description": "Tags for the [Conversation](#schema_conversation)" + "description": "Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200, + "nullable": true + }, + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them." } }, "title": "updateConversationBody", @@ -4804,9 +5724,10 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 500 + "maxLength": 500, + "nullable": true }, - "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them." + "description": "Tags for the message. Set to null or empty string to remove." }, "schedule": { "type": "object", @@ -4862,9 +5783,11 @@ "tags": { "type": "object", "additionalProperties": { - "type": "string" + "type": "string", + "maxLength": 500, + "nullable": true }, - "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them." + "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Set to null or empty string to remove." }, "payload": { "type": "object", @@ -4872,9 +5795,6 @@ "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location" } }, - "required": [ - "tags" - ], "title": "updateMessageBody", "additionalProperties": false } @@ -4924,7 +5844,7 @@ "type": "string", "maxLength": 200 }, - "description": "EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." }, "attributes": { "type": "object", @@ -4975,6 +5895,14 @@ "description": "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.", "deprecated": true }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "maxLength": 200 + }, + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." + }, "discriminateByTags": { "type": "array", "items": { @@ -5159,7 +6087,7 @@ "type": "string", "maxLength": 200 }, - "description": "EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." }, "attributes": { "type": "object", @@ -5191,9 +6119,10 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 500 + "maxLength": 500, + "nullable": true }, - "description": "Tags for the [User](#schema_user)" + "description": "Tags for the user. Set to null or empty string to remove." }, "integrationName": { "type": "string", @@ -5215,18 +6144,20 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 200 + "maxLength": 200, + "nullable": true }, - "description": "EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations." + "description": "**EXPERIMENTAL** - Optional shared properties. Set individual properties to null or empty string to remove them." }, "attributes": { "type": "object", "additionalProperties": { "type": "string", - "maxLength": 200 + "maxLength": 200, + "nullable": true }, - "description": "DEPRECATED - Use properties instead.", - "deprecated": true + "deprecated": true, + "description": "DEPRECATED - Use properties instead." }, "discriminateByTags": { "type": "array", @@ -5257,9 +6188,10 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 500 + "maxLength": 500, + "nullable": true }, - "description": "Tags for the [User](#schema_user)" + "description": "Tags for the [User](#schema_user). Set to null or empty string to remove." }, "name": { "type": "string", @@ -5290,7 +6222,7 @@ "maxLength": 200, "nullable": true }, - "description": "EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them." + "description": "**EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them." } }, "title": "updateUserBody", @@ -5393,6 +6325,13 @@ "type": "object", "additionalProperties": true, "description": "Payload is the content of the state defined by your bot." + }, + "expiry": { + "type": "number", + "minimum": 1, + "maximum": 2592000000, + "nullable": true, + "description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire." } }, "required": [ @@ -5573,9 +6512,10 @@ "type": "object", "additionalProperties": { "type": "string", - "maxLength": 500 + "maxLength": 500, + "nullable": true }, - "description": "Tags for the [Workflow](#schema_workflow)" + "description": "Tags for the [Workflow](#schema_workflow). Set to null or empty string to remove." }, "userId": { "type": "string", diff --git a/tables-openapi.json b/tables-openapi.json index 1387f926..0f7b9122 100644 --- a/tables-openapi.json +++ b/tables-openapi.json @@ -8,7 +8,7 @@ "info": { "title": "Botpress Tables API", "description": "API for Botpress Tables", - "version": "1.82.0" + "version": "1.112.0" }, "paths": { "/v1/tables": {