@botpress/api 0.16.2 → 0.16.4

package/src/gen/state.ts

@@ -11,6 +11,7 @@ export type State = opapi.State<
   | "Usage"
   | "Issue"
   | "IssueEvent"
+  | "Activity"
   | "User"
   | "Conversation"
   | "Event"
@@ -39,6 +40,7 @@ export type State = opapi.State<
   | "usage"
   | "quotas"
   | "helper"
+  | "activity"
   | "tables"
 >;
 export const state = {
@@ -265,6 +267,9 @@ export const state = {
         schema: {
           type: "object",
           properties: {
+            currentTaskId: {
+              type: "string",
+            },
             tags: {
               type: "object",
               additionalProperties: {
@@ -273,7 +278,6 @@ export const state = {
               description: "Tags for the [Conversation](#schema_conversation)",
             },
           },
-          required: ["tags"],
           title: "updateConversationBody",
           additionalProperties: false,
         },
@@ -1303,7 +1307,7 @@ export const state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"],
+          enum: ["conversation", "user", "bot", "integration", "task"],
         },
         id: {
           in: "path",
@@ -1344,7 +1348,7 @@ export const state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"],
+          enum: ["conversation", "user", "bot", "integration", "task"],
         },
         id: {
           in: "path",
@@ -1410,7 +1414,7 @@ export const state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"],
+          enum: ["conversation", "user", "bot", "integration", "task"],
         },
         id: {
           in: "path",
@@ -1578,16 +1582,20 @@ export const state = {
           properties: {
             title: {
               type: "string",
+              maxLength: 2000,
               description: "Title describing the task",
             },
-            instruction: {
+            description: {
               type: "string",
+              maxLength: 20000,
               description:
                 "All the notes related to the execution of the current task",
             },
             type: {
               type: "string",
-              description: "Type of the task",
+              maxLength: 200,
+              description:
+                "Unique identifier of the integration that was installed on the bot",
             },
             data: {
               type: "object",
@@ -1622,7 +1630,7 @@ export const state = {
               description: "Tags for the [Task](#schema_task)",
             },
           },
-          required: ["title", "type", "conversationId"],
+          required: ["type", "conversationId"],
           title: "createTaskBody",
           additionalProperties: false,
         },
@@ -1668,7 +1676,7 @@ export const state = {
               type: "string",
               description: "Title describing the task",
             },
-            instruction: {
+            description: {
               type: "string",
               description:
                 "All the notes related to the execution of the current task",
@@ -1693,6 +1701,8 @@ export const state = {
                 "completed",
                 "blocked",
                 "paused",
+                "timeout",
+                "cancelled",
               ],
               description: "Status of the task",
             },
@@ -1790,7 +1800,7 @@ export const state = {
         },
         status: {
           in: "query",
-          type: "string",
+          type: "string[]",
           description: "Status",
           enum: [
             "pending",
@@ -1799,6 +1809,8 @@ export const state = {
             "completed",
             "blocked",
             "paused",
+            "timeout",
+            "cancelled",
           ],
         },
         type: {
@@ -2319,9 +2331,9 @@ export const state = {
                 properties: {
                   type: {
                     type: "string",
-                    enum: ["conversation", "user", "bot"],
+                    enum: ["conversation", "user", "bot", "task"],
                     description:
-                      "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
+                      "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
                   },
                   schema: {
                     type: "object",
@@ -2746,9 +2758,9 @@ export const state = {
                 properties: {
                   type: {
                     type: "string",
-                    enum: ["conversation", "user", "bot"],
+                    enum: ["conversation", "user", "bot", "task"],
                     description:
-                      "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
+                      "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
                   },
                   schema: {
                     type: "object",
@@ -5215,7 +5227,7 @@ export const state = {
                     linkTemplateScript: {
                       type: "string",
                       maxLength: 2000,
-                      description: "Signing secret of the [Bot](#schema_bot)",
+                      description: "Title describing the task",
                     },
                   },
                   additionalProperties: false,
@@ -5320,12 +5332,12 @@ export const state = {
                 fallbackHandlerScript: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                 },
                 extractScript: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                 },
               },
               additionalProperties: false,
@@ -5588,7 +5600,7 @@ export const state = {
                     linkTemplateScript: {
                       type: "string",
                       maxLength: 2000,
-                      description: "Signing secret of the [Bot](#schema_bot)",
+                      description: "Title describing the task",
                       nullable: true,
                     },
                     required: {
@@ -5719,13 +5731,13 @@ export const state = {
                 extractScript: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true,
                 },
                 fallbackHandlerScript: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true,
                 },
               },
@@ -6342,6 +6354,64 @@ export const state = {
       },
       parameters: {},
     },
+    listActivities: {
+      name: "listActivities",
+      description: "List activities of a task",
+      method: "get",
+      section: "activity",
+      path: "/v1/admin/activities",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        nextToken: {
+          in: "query",
+          description:
+            "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          type: "string",
+        },
+        taskId: {
+          in: "query",
+          description: "ID of the task to list activities for",
+          type: "string",
+          required: true,
+        },
+        botId: {
+          in: "query",
+          description: "ID of the bot to list activities for",
+          type: "string",
+          required: true,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            activities: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Activity",
+              },
+            },
+            meta: {
+              type: "object",
+              properties: {
+                nextToken: {
+                  type: "string",
+                  description:
+                    "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.",
+                },
+              },
+              additionalProperties: false,
+            },
+          },
+          required: ["activities", "meta"],
+          title: "listActivitiesResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -6563,7 +6633,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.16.2",
+    version: "0.16.4",
     prefix: "v1",
   },
   errors: [
@@ -6811,6 +6881,7 @@ export const state = {
       getUsageResponse: true,
       listUsageHistoryResponse: true,
       changeAISpendQuotaResponse: true,
+      listActivitiesResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -6827,6 +6898,7 @@ export const state = {
       Usage: true,
       Issue: true,
       IssueEvent: true,
+      Activity: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -6866,7 +6938,7 @@ export const state = {
           signingSecret: {
             type: "string",
             maxLength: 2000,
-            description: "Signing secret of the [Bot](#schema_bot)",
+            description: "Title describing the task",
           },
           integrations: {
             type: "object",
@@ -6879,30 +6951,27 @@ export const state = {
                 name: {
                   type: "string",
                   maxLength: 200,
-                  description:
-                    "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+                  description: "Type of the task",
                 },
                 version: {
                   type: "string",
                   maxLength: 200,
-                  description:
-                    "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+                  description: "Type of the task",
                 },
                 webhookUrl: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                 },
                 webhookId: {
                   type: "string",
                   maxLength: 200,
-                  description:
-                    "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+                  description: "Type of the task",
                 },
                 identifier: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                 },
                 configuration: {
                   type: "object",
@@ -6922,7 +6991,7 @@ export const state = {
                 statusReason: {
                   type: "string",
                   maxLength: 2000,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true,
                 },
                 id: {
@@ -7076,9 +7145,9 @@ export const state = {
               properties: {
                 type: {
                   type: "string",
-                  enum: ["conversation", "user", "bot"],
+                  enum: ["conversation", "user", "bot", "task"],
                   description:
-                    "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)",
+                    "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)",
                 },
                 schema: {
                   type: "object",
@@ -7154,8 +7223,7 @@ export const state = {
                     cron: {
                       type: "string",
                       maxLength: 200,
-                      description:
-                        "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+                      description: "Type of the task",
                     },
                   },
                   required: ["cron"],
@@ -7164,8 +7232,7 @@ export const state = {
                 type: {
                   type: "string",
                   maxLength: 200,
-                  description:
-                    "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+                  description: "Type of the task",
                 },
                 payload: {
                   type: "object",
@@ -7332,14 +7399,12 @@ export const state = {
           name: {
             type: "string",
             maxLength: 200,
-            description:
-              "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+            description: "Type of the task",
           },
           version: {
             type: "string",
             maxLength: 200,
-            description:
-              "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+            description: "Type of the task",
           },
           configuration: {
             type: "object",
@@ -7350,7 +7415,7 @@ export const state = {
                   linkTemplateScript: {
                     type: "string",
                     maxLength: 2000,
-                    description: "Signing secret of the [Bot](#schema_bot)",
+                    description: "Title describing the task",
                   },
                   required: {
                     type: "boolean",
@@ -7979,6 +8044,56 @@ export const state = {
         additionalProperties: false,
       },
     },
+    Activity: {
+      section: "activity",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+          },
+          description: {
+            type: "string",
+          },
+          taskId: {
+            type: "string",
+          },
+          category: {
+            type: "string",
+            enum: [
+              "unknown",
+              "capture",
+              "bot_message",
+              "user_message",
+              "agent_message",
+              "event",
+              "action",
+              "task_status",
+              "subtask_status",
+              "exception",
+            ],
+          },
+          data: {
+            type: "object",
+            additionalProperties: true,
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time",
+            description: "Creation date of the activity in ISO 8601 format",
+          },
+        },
+        required: [
+          "id",
+          "description",
+          "taskId",
+          "category",
+          "data",
+          "createdAt",
+        ],
+        additionalProperties: false,
+      },
+    },
     User: {
       section: "user",
       schema: {
@@ -8108,8 +8223,7 @@ export const state = {
           type: {
             type: "string",
             maxLength: 200,
-            description:
-              "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+            description: "Type of the task",
           },
           payload: {
             type: "object",
@@ -8180,8 +8294,7 @@ export const state = {
           type: {
             type: "string",
             maxLength: 200,
-            description:
-              "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+            description: "Type of the task",
           },
           payload: {
             type: "object",
@@ -8274,14 +8387,13 @@ export const state = {
           name: {
             type: "string",
             maxLength: 200,
-            description:
-              "Type of the [Message](#schema_message) represents the resource type that the message is related to",
+            description: "Type of the task",
           },
           type: {
             type: "string",
-            enum: ["conversation", "user", "bot", "integration"],
+            enum: ["conversation", "user", "bot", "task", "integration"],
             description:
-              "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot` or `integration`) that the state is related to",
+              "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to",
           },
           payload: {
             type: "object",
@@ -8320,7 +8432,7 @@ export const state = {
             maxLength: 64,
             description: "Title describing the task",
           },
-          instruction: {
+          description: {
             type: "string",
             maxLength: 256,
             description:
@@ -8344,6 +8456,8 @@ export const state = {
               "completed",
               "blocked",
               "paused",
+              "timeout",
+              "cancelled",
             ],
             description: "Status of the task",
           },
@@ -8399,7 +8513,7 @@ export const state = {
         required: [
           "id",
           "title",
-          "instruction",
+          "description",
           "type",
           "data",
           "status",
@@ -8508,6 +8622,10 @@ export const state = {
                         index: {
                           type: "integer",
                         },
+                        id: {
+                          type: "string",
+                          description: "[deprecated] ID of the column.",
+                        },
                         searchable: {
                           type: "boolean",
                           description:
@@ -8530,7 +8648,9 @@ export const state = {
               },
               additionalProperties: {
                 type: "boolean",
-                enum: [false],
+                enum: [true],
+                description:
+                  "Additional properties can be provided, but they will be ignored if no column matches.",
               },
               required: {
                 type: "array",
@@ -8848,6 +8968,13 @@ export const state = {
       name: "helper",
       operations: ["runVrl"],
     },
+    {
+      title: "Activity",
+      description: "",
+      name: "activity",
+      operations: ["listActivities"],
+      schema: "Activity",
+    },
     {
       title: "Tables",
       description: "Operations related to table management.",