@botpress/api 0.16.2 → 0.16.3

package/dist/index.js

@@ -428338,15 +428338,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 +428382,7 @@ var state = {
               description: "Tags for the [Task](#schema_task)"
             }
           },
-          required: ["title", "type", "conversationId"],
+          required: ["type", "conversationId"],
           title: "createTaskBody",
           additionalProperties: false
         }
@@ -428423,7 +428426,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 +428448,9 @@ var state = {
                 "failed",
                 "completed",
                 "blocked",
-                "paused"
+                "paused",
+                "timeout",
+                "cancelled"
               ],
               description: "Status of the task"
             },
@@ -428539,7 +428544,7 @@ var state = {
         },
         status: {
           in: "query",
-          type: "string",
+          type: "string[]",
           description: "Status",
           enum: [
             "pending",
@@ -428547,7 +428552,9 @@ var state = {
             "failed",
             "completed",
             "blocked",
-            "paused"
+            "paused",
+            "timeout",
+            "cancelled"
           ]
         },
         type: {
@@ -431894,7 +431901,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 +432004,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 +432257,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 +432384,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 +432982,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 +433256,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.16.2",
+    version: "0.16.3",
     prefix: "v1"
   },
   errors: [
@@ -433432,6 +433495,7 @@ var state = {
       getUsageResponse: true,
       listUsageHistoryResponse: true,
       changeAISpendQuotaResponse: true,
+      listActivitiesResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -433448,6 +433512,7 @@ var state = {
       Usage: true,
       Issue: true,
       IssueEvent: true,
+      Activity: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -433485,7 +433550,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 +433563,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 +433603,7 @@ var state = {
                 statusReason: {
                   type: "string",
                   maxLength: 2e3,
-                  description: "Signing secret of the [Bot](#schema_bot)",
+                  description: "Title describing the task",
                   nullable: true
                 },
                 id: {
@@ -433758,7 +433823,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 +433832,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 +433988,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 +434004,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 +434614,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 +434782,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 +434849,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,7 +434937,7 @@ 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",
@@ -434864,7 +434979,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 +435001,9 @@ var state = {
               "failed",
               "completed",
               "blocked",
-              "paused"
+              "paused",
+              "timeout",
+              "cancelled"
             ],
             description: "Status of the task"
           },
@@ -434939,7 +435056,7 @@ var state = {
         required: [
           "id",
           "title",
-          "instruction",
+          "description",
           "type",
           "data",
           "status",
@@ -435064,7 +435181,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 +435495,13 @@ var state = {
       name: "helper",
       operations: ["runVrl"]
     },
+    {
+      title: "Activity",
+      description: "",
+      name: "activity",
+      operations: ["listActivities"],
+      schema: "Activity"
+    },
     {
       title: "Tables",
       description: "Operations related to table management.",

package/dist/src/gen/state.d.ts

@@ -1,5 +1,5 @@
 import * as opapi from "@bpinternal/opapi";
-export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables">;
+export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables">;
 export declare const state: {
     operations: {
         createConversation: {
@@ -1444,14 +1444,17 @@ export declare const state: {
                     properties: {
                         title: {
                             type: "string";
+                            maxLength: number;
                             description: string;
                         };
-                        instruction: {
+                        description: {
                             type: "string";
+                            maxLength: number;
                             description: string;
                         };
                         type: {
                             type: "string";
+                            maxLength: number;
                             description: string;
                         };
                         data: {
@@ -1529,7 +1532,7 @@ export declare const state: {
                             type: "string";
                             description: string;
                         };
-                        instruction: {
+                        description: {
                             type: "string";
                             description: string;
                         };
@@ -1638,7 +1641,7 @@ export declare const state: {
                 };
                 status: {
                     in: "query";
-                    type: "string";
+                    type: "string[]";
                     description: string;
                     enum: string[];
                 };
@@ -5771,6 +5774,62 @@ export declare const state: {
             };
             parameters: {};
         };
+        listActivities: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "activity";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                taskId: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                botId: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        activities: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         introspect: {
             name: string;
             description: string;
@@ -6166,6 +6225,7 @@ export declare const state: {
             getUsageResponse: true;
             listUsageHistoryResponse: true;
             changeAISpendQuotaResponse: true;
+            listActivitiesResponse: true;
             introspectResponse: true;
             createFileResponse: true;
             getFileResponse: true;
@@ -6182,6 +6242,7 @@ export declare const state: {
             Usage: true;
             Issue: true;
             IssueEvent: true;
+            Activity: true;
             User: true;
             Conversation: true;
             Event: true;
@@ -7173,6 +7234,38 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Activity: {
+            section: "activity";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    description: {
+                        type: "string";
+                    };
+                    taskId: {
+                        type: "string";
+                    };
+                    category: {
+                        type: "string";
+                        enum: string[];
+                    };
+                    data: {
+                        type: "object";
+                        additionalProperties: true;
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {
@@ -7457,7 +7550,7 @@ export declare const state: {
                         maxLength: number;
                         description: string;
                     };
-                    instruction: {
+                    description: {
                         type: "string";
                         maxLength: number;
                         description: string;
@@ -7640,6 +7733,7 @@ export declare const state: {
                             additionalProperties: {
                                 type: "boolean";
                                 enum: boolean[];
+                                description: string;
                             };
                             required: {
                                 type: "array";
@@ -7846,6 +7940,12 @@ export declare const state: {
         name: "helper";
         operations: string[];
         schema?: undefined;
+    } | {
+        title: string;
+        description: string;
+        name: "activity";
+        operations: string[];
+        schema: string;
     } | {
         title: string;
         description: string;

package/dist/src/index.d.ts

@@ -1,7 +1,7 @@
 export * from './gen/state';
 export declare const api: {
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
-    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables", Path, "zod-schema">) => void;
+    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row") => import("@bpinternal/opapi").OpenApiZodAny;
+    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables", Path, "zod-schema">) => void;
     exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
     exportTypesBySection: (dir?: string | undefined) => Promise<void>;
     exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.16.2",
+  "version": "0.16.3",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {