@botpress/api 0.85.0 → 0.87.0

package/src/gen/state.ts

@@ -3165,7 +3165,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -6376,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",
@@ -9527,7 +9636,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10110,7 +10219,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10934,7 +11043,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -10964,7 +11073,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         },
         "timeStart": {
@@ -11096,7 +11205,7 @@ export const state = {
       "parameters": {
         "id": {
           "type": "string",
-          "description": "Integration ID",
+          "description": "Integration Version ID",
           "in": "path"
         }
       },
@@ -15843,7 +15952,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.85.0",
+    "version": "0.87.0",
     "prefix": "v1"
   },
   "errors": [
@@ -16003,6 +16112,7 @@ export const state = {
       "transferBotBody": true,
       "createBotVersionBody": true,
       "deployBotVersionBody": true,
+      "createIntegrationShareableIdBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -16112,6 +16222,9 @@ export const state = {
       "getBotVersionResponse": true,
       "createBotVersionResponse": true,
       "deployBotVersionResponse": true,
+      "createIntegrationShareableIdResponse": true,
+      "deleteIntegrationShareableIdResponse": true,
+      "getIntegrationShareableIdResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -18564,6 +18677,11 @@ export const state = {
             "format": "date-time",
             "description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
           },
+          "updatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Update date of the [Message](#schema_message) in ISO 8601 format"
+          },
           "type": {
             "type": "string",
             "maxLength": 200,
@@ -18605,6 +18723,7 @@ export const state = {
         "required": [
           "id",
           "createdAt",
+          "updatedAt",
           "type",
           "payload",
           "direction",
@@ -19582,7 +19701,10 @@ export const state = {
         "listBotVersions",
         "getBotVersion",
         "createBotVersion",
-        "deployBotVersion"
+        "deployBotVersion",
+        "createIntegrationShareableId",
+        "deleteIntegrationShareableId",
+        "getIntegrationShareableId"
       ],
       "schema": "Bot"
     },