@botpress/api 0.16.2 → 0.16.4

package/dist/index.js

@@ -427103,6 +427103,9 @@ var state = {
         schema: {
           type: "object",
           properties: {
+            currentTaskId: {
+              type: "string"
+            },
             tags: {
               type: "object",
               additionalProperties: {
@@ -427111,7 +427114,6 @@ var state = {
               description: "Tags for the [Conversation](#schema_conversation)"
             }
           },
-          required: ["tags"],
           title: "updateConversationBody",
           additionalProperties: false
         }
@@ -428076,7 +428078,7 @@ var state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"]
+          enum: ["conversation", "user", "bot", "integration", "task"]
         },
         id: {
           in: "path",
@@ -428115,7 +428117,7 @@ var state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"]
+          enum: ["conversation", "user", "bot", "integration", "task"]
         },
         id: {
           in: "path",
@@ -428177,7 +428179,7 @@ var state = {
           in: "path",
           type: "string",
           description: "State type",
-          enum: ["conversation", "user", "bot", "integration"]
+          enum: ["conversation", "user", "bot", "integration", "task"]
         },
         id: {
           in: "path",
@@ -428338,15 +428340,18 @@ var state = {
           properties: {
             title: {
               type: "string",
+              maxLength: 2e3,
               description: "Title describing the task"
             },
-            instruction: {
+            description: {
               type: "string",
+              maxLength: 2e4,
               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",
@@ -428379,7 +428384,7 @@ var state = {
               description: "Tags for the [Task](#schema_task)"
             }
           },
-          required: ["title", "type", "conversationId"],
+          required: ["type", "conversationId"],
           title: "createTaskBody",
           additionalProperties: false
         }
@@ -428423,7 +428428,7 @@ var state = {
               type: "string",
               description: "Title describing the task"
             },
-            instruction: {
+            description: {
               type: "string",
               description: "All the notes related to the execution of the current task"
             },
@@ -428445,7 +428450,9 @@ var state = {
                 "failed",
                 "completed",
                 "blocked",
-                "paused"
+                "paused",
+                "timeout",
+                "cancelled"
               ],
               description: "Status of the task"
             },
@@ -428539,7 +428546,7 @@ var state = {
         },
         status: {
           in: "query",
-          type: "string",
+          type: "string[]",
           description: "Status",
           enum: [
             "pending",
@@ -428547,7 +428554,9 @@ var state = {
             "failed",
             "completed",
             "blocked",
-            "paused"
+            "paused",
+            "timeout",
+            "cancelled"
           ]
         },
         type: {
@@ -429053,8 +429062,8 @@ var state = {
                 properties: {
                   type: {
                     type: "string",
-                    enum: ["conversation", "user", "bot"],
-                    description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
+                    enum: ["conversation", "user", "bot", "task"],
+                    description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
                   },
                   schema: {
                     type: "object",
@@ -429460,8 +429469,8 @@ var state = {
                 properties: {
                   type: {
                     type: "string",
-                    enum: ["conversation", "user", "bot"],
-                    description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
+                    enum: ["conversation", "user", "bot", "task"],
+                    description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
                   },
                   schema: {
                     type: "object",
@@ -431894,7 +431903,7 @@ var state = {
                     linkTemplateScript: {
                       type: "string",
                       maxLength: 2e3,
-                      description: "Signing secret of the [Bot](#schema_bot)"
+                      description: "Title describing the task"
                     }
                   },
                   additionalProperties: false
@@ -431997,12 +432006,12 @@ var state = {
                 fallbackHandlerScript: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)"
+                  description: "Title describing the task"
                 },
                 extractScript: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)"
+                  description: "Title describing the task"
                 }
               },
               additionalProperties: false
@@ -432250,7 +432259,7 @@ var state = {
                     linkTemplateScript: {
                       type: "string",
                       maxLength: 2e3,
-                      description: "Signing secret of the [Bot](#schema_bot)",
+                      description: "Title describing the task",
                       nullable: true
                     },
                     required: {
@@ -432377,13 +432386,13 @@ var state = {
                 extractScript: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true
                 },
                 fallbackHandlerScript: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true
                 }
               },
@@ -432975,6 +432984,62 @@ var 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",
@@ -433193,7 +433258,7 @@ var 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: [
@@ -433432,6 +433497,7 @@ var state = {
       getUsageResponse: true,
       listUsageHistoryResponse: true,
       changeAISpendQuotaResponse: true,
+      listActivitiesResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -433448,6 +433514,7 @@ var state = {
       Usage: true,
       Issue: true,
       IssueEvent: true,
+      Activity: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -433485,7 +433552,7 @@ var state = {
           signingSecret: {
             type: "string",
             maxLength: 2e3,
-            description: "Signing secret of the [Bot](#schema_bot)"
+            description: "Title describing the task"
           },
           integrations: {
             type: "object",
@@ -433498,27 +433565,27 @@ var 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: 2e3,
-                  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: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)"
+                  description: "Title describing the task"
                 },
                 configuration: {
                   type: "object",
@@ -433538,7 +433605,7 @@ var state = {
                 statusReason: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true
                 },
                 id: {
@@ -433684,8 +433751,8 @@ var state = {
               properties: {
                 type: {
                   type: "string",
-                  enum: ["conversation", "user", "bot"],
-                  description: "Type of the [State](#schema_state) (`conversation`, `user` or `bot`)"
+                  enum: ["conversation", "user", "bot", "task"],
+                  description: "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
                 },
                 schema: {
                   type: "object",
@@ -433758,7 +433825,7 @@ var 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"],
@@ -433767,7 +433834,7 @@ var 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",
@@ -433923,12 +433990,12 @@ var 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",
@@ -433939,7 +434006,7 @@ var state = {
                   linkTemplateScript: {
                     type: "string",
                     maxLength: 2e3,
-                    description: "Signing secret of the [Bot](#schema_bot)"
+                    description: "Title describing the task"
                   },
                   required: {
                     type: "boolean"
@@ -434549,6 +434616,56 @@ var 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: {
@@ -434667,7 +434784,7 @@ var 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",
@@ -434734,7 +434851,7 @@ var 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",
@@ -434822,12 +434939,12 @@ var 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"],
-            description: "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot` or `integration`) that the state is related to"
+            enum: ["conversation", "user", "bot", "task", "integration"],
+            description: "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",
@@ -434864,7 +434981,7 @@ var state = {
             maxLength: 64,
             description: "Title describing the task"
           },
-          instruction: {
+          description: {
             type: "string",
             maxLength: 256,
             description: "All the notes related to the execution of the current task"
@@ -434886,7 +435003,9 @@ var state = {
               "failed",
               "completed",
               "blocked",
-              "paused"
+              "paused",
+              "timeout",
+              "cancelled"
             ],
             description: "Status of the task"
           },
@@ -434939,7 +435058,7 @@ var state = {
         required: [
           "id",
           "title",
-          "instruction",
+          "description",
           "type",
           "data",
           "status",
@@ -435044,6 +435163,10 @@ var state = {
                         index: {
                           type: "integer"
                         },
+                        id: {
+                          type: "string",
+                          description: "[deprecated] ID of the column."
+                        },
                         searchable: {
                           type: "boolean",
                           description: "Indicates if the column is vectorized and searchable."
@@ -435064,7 +435187,8 @@ var 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",
@@ -435377,6 +435501,13 @@ var state = {
       name: "helper",
       operations: ["runVrl"]
     },
+    {
+      title: "Activity",
+      description: "",
+      name: "activity",
+      operations: ["listActivities"],
+      schema: "Activity"
+    },
     {
       title: "Tables",
       description: "Operations related to table management.",