@botpress/api 1.49.0 → 1.51.0

package/src/gen/runtime/state.ts

@@ -61,6 +61,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getConversation": {
@@ -91,7 +94,10 @@ export const state = {
           "title": "getConversationResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "listConversations": {
       "name": "listConversations",
@@ -179,7 +185,10 @@ export const state = {
           "title": "listConversationsResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "getOrCreateConversation": {
       "name": "getOrCreateConversation",
@@ -244,6 +253,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "updateConversation": {
@@ -294,7 +306,10 @@ export const state = {
           "title": "updateConversationResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "deleteConversation": {
       "name": "deleteConversation",
@@ -316,7 +331,10 @@ export const state = {
           "title": "deleteConversationResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "listParticipants": {
       "name": "listParticipants",
@@ -365,7 +383,10 @@ export const state = {
           "title": "listParticipantsResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "addParticipant": {
       "name": "addParticipant",
@@ -414,7 +435,10 @@ export const state = {
           "title": "addParticipantResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "getParticipant": {
       "name": "getParticipant",
@@ -449,7 +473,10 @@ export const state = {
           "title": "getParticipantResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "removeParticipant": {
       "name": "removeParticipant",
@@ -476,7 +503,10 @@ export const state = {
           "title": "removeParticipantResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "createEvent": {
       "name": "createEvent",
@@ -566,6 +596,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getEvent": {
@@ -596,7 +629,10 @@ export const state = {
           "title": "getEventResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "listEvents": {
       "name": "listEvents",
@@ -677,7 +713,35 @@ export const state = {
           "title": "listEventsResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
+    },
+    "cancelScheduledEvent": {
+      "name": "cancelScheduledEvent",
+      "description": "Permanently cancels a scheduled [Event](#schema_event). The event must be in a `scheduled` state.",
+      "method": "delete",
+      "path": "/v1/chat/events/scheduled/{id}",
+      "parameters": {
+        "id": {
+          "in": "path",
+          "type": "string",
+          "description": "Event id"
+        }
+      },
+      "section": "event",
+      "response": {
+        "description": "Returns an empty object",
+        "schema": {
+          "type": "object",
+          "title": "cancelScheduledEventResponse",
+          "additionalProperties": false
+        }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "createMessage": {
       "name": "createMessage",
@@ -772,6 +836,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getOrCreateMessage": {
@@ -874,6 +941,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getMessage": {
@@ -904,7 +974,10 @@ export const state = {
           "title": "getMessageResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "updateMessage": {
       "name": "updateMessage",
@@ -959,7 +1032,10 @@ export const state = {
           "title": "updateMessageResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "listMessages": {
       "name": "listMessages",
@@ -1019,7 +1095,10 @@ export const state = {
           "title": "listMessagesResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "deleteMessage": {
       "name": "deleteMessage",
@@ -1041,7 +1120,10 @@ export const state = {
           "title": "deleteMessageResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "createUser": {
       "name": "createUser",
@@ -1103,6 +1185,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getUser": {
@@ -1133,7 +1218,10 @@ export const state = {
           "title": "getUserResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "listUsers": {
       "name": "listUsers",
@@ -1193,7 +1281,10 @@ export const state = {
           "title": "listUsersResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "getOrCreateUser": {
       "name": "getOrCreateUser",
@@ -1262,6 +1353,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "updateUser": {
@@ -1322,7 +1416,10 @@ export const state = {
           "title": "updateUserResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "deleteUser": {
       "name": "deleteUser",
@@ -1344,7 +1441,10 @@ export const state = {
           "title": "deleteUserResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "setStateExpiry": {
       "name": "setStateExpiry",
@@ -1412,7 +1512,10 @@ export const state = {
           "title": "setStateExpiryResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "getState": {
       "name": "getState",
@@ -1473,7 +1576,10 @@ export const state = {
           "title": "getStateResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "setState": {
       "name": "setState",
@@ -1547,7 +1653,10 @@ export const state = {
           "title": "setStateResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "getOrSetState": {
       "name": "getOrSetState",
@@ -1633,7 +1742,10 @@ export const state = {
           "title": "getOrSetStateResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "patchState": {
       "name": "patchState",
@@ -1699,7 +1811,10 @@ export const state = {
           "title": "patchStateResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "callAction": {
       "name": "callAction",
@@ -1762,6 +1877,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "configureIntegration": {
@@ -1813,6 +1931,9 @@ export const state = {
           "additionalProperties": false
         }
       },
+      "tags": [
+        "documented"
+      ],
       "parameters": {}
     },
     "getTask": {
@@ -2597,7 +2718,10 @@ export const state = {
           "title": "listTagValuesResponse",
           "additionalProperties": false
         }
-      }
+      },
+      "tags": [
+        "documented"
+      ]
     },
     "trackAnalytics": {
       "name": "trackAnalytics",
@@ -2643,7 +2767,7 @@ export const state = {
     "title": "Botpress Runtime API",
     "description": "API for Botpress Runtime",
     "server": "https://api.botpress.cloud",
-    "version": "1.49.0",
+    "version": "1.51.0",
     "prefix": "v1"
   },
   "errors": [
@@ -2814,6 +2938,7 @@ export const state = {
       "createEventResponse": true,
       "getEventResponse": true,
       "listEventsResponse": true,
+      "cancelScheduledEventResponse": true,
       "createMessageResponse": true,
       "getOrCreateMessageResponse": true,
       "getMessageResponse": true,
@@ -3019,7 +3144,8 @@ export const state = {
               "processed",
               "ignored",
               "failed",
-              "scheduled"
+              "scheduled",
+              "canceled"
             ]
           },
           "failureReason": {
@@ -3450,7 +3576,8 @@ export const state = {
       "operations": [
         "createEvent",
         "getEvent",
-        "listEvents"
+        "listEvents",
+        "cancelScheduledEvent"
       ],
       "schema": "Event"
     },