@botpress/api 0.84.0 → 0.86.0

package/src/gen/state.ts

@@ -885,7 +885,7 @@ export const state = {
     },
     "updateMessage": {
       "name": "updateMessage",
-      "description": "Update a message",
+      "description": "Updates a message tags and payload. The message type cannot be changed. Calling this operation from an integration, to update an incoming message, will not invoke the bot. The other way around it also true; Calling this operation from the bot, to update an outgoing message, will not invoke the integration.",
       "method": "put",
       "path": "/v1/chat/messages/{id}",
       "parameters": {
@@ -907,6 +907,11 @@ export const state = {
                 "type": "string"
               },
               "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."
+            },
+            "payload": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
             }
           },
           "required": [
@@ -3160,7 +3165,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -6371,6 +6376,115 @@ export const state = {
         }
       }
     },
+    "createIntegrationShareableId": {
+      "name": "createIntegrationShareableId",
+      "description": "(Experimental) Generate a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "method": "post",
+      "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
+      "section": "bot",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "integrationId": {
+          "type": "string",
+          "description": "Integration Version ID",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Empty body",
+        "schema": {
+          "type": "object",
+          "title": "createIntegrationShareableIdBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "shareableId": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "shareableId"
+          ],
+          "title": "createIntegrationShareableIdResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "deleteIntegrationShareableId": {
+      "name": "deleteIntegrationShareableId",
+      "description": "(Experimental) Delete a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "method": "delete",
+      "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
+      "section": "bot",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "integrationId": {
+          "type": "string",
+          "description": "Integration Version ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "deleteIntegrationShareableIdResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getIntegrationShareableId": {
+      "name": "getIntegrationShareableId",
+      "description": "(Experimental) Get an existing shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "method": "get",
+      "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
+      "section": "bot",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "integrationId": {
+          "type": "string",
+          "description": "Integration Version ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Shareable ID and expiration indicator",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "shareableId": {
+              "type": "string"
+            },
+            "isExpired": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "shareableId",
+            "isExpired"
+          ],
+          "title": "getIntegrationShareableIdResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceInvoices": {
       "name": "listWorkspaceInvoices",
       "description": "List invoices billed to workspace",
@@ -9522,7 +9636,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10105,7 +10219,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10929,7 +11043,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10959,7 +11073,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         },
         "timeStart": {
@@ -11091,7 +11205,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -15838,7 +15952,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.84.0",
+    "version": "0.86.0",
     "prefix": "v1"
   },
   "errors": [
@@ -15998,6 +16112,7 @@ export const state = {
       "transferBotBody": true,
       "createBotVersionBody": true,
       "deployBotVersionBody": true,
+      "createIntegrationShareableIdBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -16107,6 +16222,9 @@ export const state = {
       "getBotVersionResponse": true,
       "createBotVersionResponse": true,
       "deployBotVersionResponse": true,
+      "createIntegrationShareableIdResponse": true,
+      "deleteIntegrationShareableIdResponse": true,
+      "getIntegrationShareableIdResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -19577,7 +19695,10 @@ export const state = {
         "listBotVersions",
         "getBotVersion",
         "createBotVersion",
-        "deployBotVersion"
+        "deployBotVersion",
+        "createIntegrationShareableId",
+        "deleteIntegrationShareableId",
+        "getIntegrationShareableId"
       ],
       "schema": "Bot"
     },