@botpress/api 0.16.0 → 0.16.2

package/src/gen/state.ts

@@ -16,6 +16,7 @@ export type State = opapi.State<
   | "Event"
   | "Message"
   | "State"
+  | "Task"
   | "File"
   | "Table"
   | "Column"
@@ -29,6 +30,7 @@ export type State = opapi.State<
   | "state"
   | "hub"
   | "action"
+  | "task"
   | "bot"
   | "integration"
   | "workspace"
@@ -1533,6 +1535,308 @@ export const state = {
       },
       parameters: {},
     },
+    getTask: {
+      name: "getTask",
+      description:
+        "Retrieves the [Task](#schema_task) object for a valid identifier.",
+      method: "get",
+      path: "/v1/chat/tasks/{id}",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Task id",
+        },
+      },
+      section: "task",
+      response: {
+        description:
+          "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        schema: {
+          type: "object",
+          properties: {
+            task: {
+              $ref: "#/components/schemas/Task",
+            },
+          },
+          required: ["task"],
+          title: "getTaskResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    createTask: {
+      name: "createTask",
+      description:
+        "Creates a new [Task](#schema_task). When creating a new [Task](#schema_task), the required tags must be provided. See the specific integration for more details.",
+      method: "post",
+      path: "/v1/chat/tasks",
+      requestBody: {
+        description: "Task data",
+        schema: {
+          type: "object",
+          properties: {
+            title: {
+              type: "string",
+              description: "Title describing the task",
+            },
+            instruction: {
+              type: "string",
+              description:
+                "All the notes related to the execution of the current task",
+            },
+            type: {
+              type: "string",
+              description: "Type of the task",
+            },
+            data: {
+              type: "object",
+              additionalProperties: true,
+              description: "Content related to the task",
+            },
+            parentTaskId: {
+              type: "string",
+              description:
+                "Parent task id is the parent task that created this task",
+            },
+            conversationId: {
+              type: "string",
+              description: "Conversation id related to this task",
+            },
+            userId: {
+              type: "string",
+              description: "Specific user related to this task",
+            },
+            timeoutAt: {
+              type: "string",
+              format: "date-time",
+              description:
+                "The timeout date where the task should be failed in the ISO 8601 format",
+            },
+            tags: {
+              type: "object",
+              additionalProperties: {
+                type: "string",
+                maxLength: 500,
+              },
+              description: "Tags for the [Task](#schema_task)",
+            },
+          },
+          required: ["title", "type", "conversationId"],
+          title: "createTaskBody",
+          additionalProperties: false,
+        },
+      },
+      section: "task",
+      response: {
+        description:
+          "Returns a [Task](#schema_task) object if creation succeeds. Returns [an error](#errors) otherwise",
+        status: 201,
+        schema: {
+          type: "object",
+          properties: {
+            task: {
+              $ref: "#/components/schemas/Task",
+            },
+          },
+          required: ["task"],
+          title: "createTaskResponse",
+          additionalProperties: false,
+        },
+      },
+      parameters: {},
+    },
+    updateTask: {
+      name: "updateTask",
+      description:
+        "Update a [Task](#schema_task) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
+      method: "put",
+      path: "/v1/chat/tasks/{id}",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Task id",
+        },
+      },
+      requestBody: {
+        description: "Task data",
+        schema: {
+          type: "object",
+          properties: {
+            title: {
+              type: "string",
+              description: "Title describing the task",
+            },
+            instruction: {
+              type: "string",
+              description:
+                "All the notes related to the execution of the current task",
+            },
+            data: {
+              type: "object",
+              additionalProperties: true,
+              description: "Content related to the task",
+            },
+            timeoutAt: {
+              type: "string",
+              format: "date-time",
+              description:
+                "The timeout date where the task should be failed in the ISO 8601 format",
+            },
+            status: {
+              type: "string",
+              enum: [
+                "pending",
+                "in_progress",
+                "failed",
+                "completed",
+                "blocked",
+                "paused",
+              ],
+              description: "Status of the task",
+            },
+            tags: {
+              type: "object",
+              additionalProperties: {
+                type: "string",
+                maxLength: 500,
+              },
+              description: "Tags for the [Task](#schema_task)",
+            },
+          },
+          title: "updateTaskBody",
+          additionalProperties: false,
+        },
+      },
+      section: "task",
+      response: {
+        description:
+          "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        schema: {
+          type: "object",
+          properties: {
+            task: {
+              $ref: "#/components/schemas/Task",
+            },
+          },
+          required: ["task"],
+          title: "updateTaskResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    deleteTask: {
+      name: "deleteTask",
+      description:
+        "Permanently deletes a [Task](#schema_task). It cannot be undone.",
+      method: "delete",
+      path: "/v1/chat/tasks/{id}",
+      parameters: {
+        id: {
+          in: "path",
+          type: "string",
+          description: "Task id",
+        },
+      },
+      section: "task",
+      response: {
+        description: "Returns the [Task](#schema_task) object that was deleted",
+        schema: {
+          type: "object",
+          title: "deleteTaskResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    listTasks: {
+      name: "listTasks",
+      description:
+        "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
+      method: "get",
+      path: "/v1/chat/tasks",
+      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",
+        },
+        tags: {
+          in: "query",
+          type: "object",
+          schema: {
+            type: "object",
+            additionalProperties: {
+              type: "string",
+            },
+          },
+          description: "Filter by tags",
+        },
+        conversationId: {
+          in: "query",
+          type: "string",
+          description: "Conversation id",
+        },
+        userId: {
+          in: "query",
+          type: "string",
+          description: "User id",
+        },
+        parentTaskId: {
+          in: "query",
+          type: "string",
+          description: "Parent task id",
+        },
+        status: {
+          in: "query",
+          type: "string",
+          description: "Status",
+          enum: [
+            "pending",
+            "in_progress",
+            "failed",
+            "completed",
+            "blocked",
+            "paused",
+          ],
+        },
+        type: {
+          in: "query",
+          type: "string",
+          description: "Type",
+        },
+      },
+      section: "task",
+      response: {
+        description: "Returns a list of [Task](#schema_task) objects",
+        schema: {
+          type: "object",
+          properties: {
+            tasks: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Task",
+              },
+            },
+            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: ["tasks", "meta"],
+          title: "listTasksResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     runVrl: {
       name: "runVrl",
       description: "Run a VRL script",
@@ -3584,6 +3888,10 @@ export const state = {
             isPublic: {
               type: "boolean",
             },
+            handle: {
+              default: "",
+              type: "string",
+            },
           },
           required: [
             "id",
@@ -3687,6 +3995,10 @@ export const state = {
             isPublic: {
               type: "boolean",
             },
+            handle: {
+              default: "",
+              type: "string",
+            },
           },
           required: [
             "id",
@@ -4096,6 +4408,12 @@ export const state = {
             isPublic: {
               type: "boolean",
             },
+            handle: {
+              type: "string",
+              minLength: 1,
+              maxLength: 64,
+              pattern: "^[0-9a-z][a-z0-9-]+[0-9a-z]$",
+            },
           },
           additionalProperties: false,
           title: "updateWorkspaceBody",
@@ -4168,6 +4486,10 @@ export const state = {
             isPublic: {
               type: "boolean",
             },
+            handle: {
+              default: "",
+              type: "string",
+            },
           },
           required: [
             "id",
@@ -4187,6 +4509,57 @@ export const state = {
         },
       },
     },
+    checkHandleAvailability: {
+      name: "checkHandleAvailability",
+      description: "Check if a workspace handle is available",
+      section: "workspace",
+      method: "put",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      path: "/v1/admin/workspaces/handle-availability",
+      requestBody: {
+        description: "Workspace handle availability",
+        schema: {
+          type: "object",
+          properties: {
+            handle: {
+              type: "string",
+              minLength: 1,
+              maxLength: 50,
+              pattern: "^[a-z0-9-_]+$",
+            },
+          },
+          required: ["handle"],
+          title: "checkHandleAvailabilityBody",
+          additionalProperties: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            available: {
+              type: "boolean",
+            },
+            suggestions: {
+              type: "array",
+              items: {
+                type: "string",
+              },
+            },
+            usedBy: {
+              type: "string",
+            },
+          },
+          required: ["available", "suggestions"],
+          title: "checkHandleAvailabilityResponse",
+          additionalProperties: false,
+        },
+      },
+      parameters: {},
+    },
     listWorkspaces: {
       name: "listWorkspaces",
       description: "List workspaces the user has access to",
@@ -4276,6 +4649,10 @@ export const state = {
                   isPublic: {
                     type: "boolean",
                   },
+                  handle: {
+                    default: "",
+                    type: "string",
+                  },
                 },
                 required: [
                   "id",
@@ -4409,6 +4786,10 @@ export const state = {
             isPublic: {
               type: "boolean",
             },
+            handle: {
+              default: "",
+              type: "string",
+            },
           },
           required: [
             "id",
@@ -6182,7 +6563,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.16.0",
+    version: "0.16.2",
     prefix: "v1",
   },
   errors: [
@@ -6319,6 +6700,8 @@ export const state = {
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
+      createTaskBody: true,
+      updateTaskBody: true,
       runVrlBody: true,
       createPersonalAccessTokenBody: true,
       setAccountPreferenceBody: true,
@@ -6329,6 +6712,7 @@ export const state = {
       chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
+      checkHandleAvailabilityBody: true,
       changeWorkspacePlanBody: true,
       createWorkspaceMemberBody: true,
       updateWorkspaceMemberBody: true,
@@ -6369,6 +6753,11 @@ export const state = {
       patchStateResponse: true,
       callActionResponse: true,
       configureIntegrationResponse: true,
+      getTaskResponse: true,
+      createTaskResponse: true,
+      updateTaskResponse: true,
+      deleteTaskResponse: true,
+      listTasksResponse: true,
       runVrlResponse: true,
       getAccountResponse: true,
       listPersonalAccessTokensResponse: true,
@@ -6403,6 +6792,7 @@ export const state = {
       getWorkspaceQuotaResponse: true,
       listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
+      checkHandleAvailabilityResponse: true,
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
       deleteWorkspaceResponse: true,
@@ -6442,6 +6832,7 @@ export const state = {
       Event: true,
       Message: true,
       State: true,
+      Task: true,
       File: true,
       Table: true,
       Column: true,
@@ -7364,6 +7755,10 @@ export const state = {
           isPublic: {
             type: "boolean",
           },
+          handle: {
+            default: "",
+            type: "string",
+          },
         },
         required: [
           "id",
@@ -7643,6 +8038,12 @@ export const state = {
             maxLength: 36,
             description: "ID of the [Conversation](#schema_conversation)",
           },
+          currentTaskId: {
+            type: "string",
+            minLength: 28,
+            maxLength: 36,
+            description: "Id of the current [Task](#schema_task)",
+          },
           createdAt: {
             type: "string",
             format: "date-time",
@@ -7738,10 +8139,23 @@ export const state = {
           },
           status: {
             type: "string",
-            description: "Status of the event (e.g. `ignored`, `processed`)",
+            enum: ["pending", "processed", "ignored", "failed"],
+          },
+          failureReason: {
+            type: "string",
+            maxLength: 2000,
+            description: "Reason why the event failed to be processed",
+            nullable: true,
           },
         },
-        required: ["id", "createdAt", "type", "payload", "status"],
+        required: [
+          "id",
+          "createdAt",
+          "type",
+          "payload",
+          "status",
+          "failureReason",
+        ],
         description: "The event object represents an action or an occurrence.",
         additionalProperties: false,
       },
@@ -7890,6 +8304,114 @@ export const state = {
         additionalProperties: false,
       },
     },
+    Task: {
+      section: "task",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            minLength: 28,
+            maxLength: 36,
+            description: "ID of the [Conversation](#schema_conversation)",
+          },
+          title: {
+            type: "string",
+            maxLength: 64,
+            description: "Title describing the task",
+          },
+          instruction: {
+            type: "string",
+            maxLength: 256,
+            description:
+              "All the notes related to the execution of the current task",
+          },
+          type: {
+            type: "string",
+            description: "Type of the task",
+          },
+          data: {
+            type: "object",
+            additionalProperties: true,
+            description: "Content related to the task",
+          },
+          status: {
+            type: "string",
+            enum: [
+              "pending",
+              "in_progress",
+              "failed",
+              "completed",
+              "blocked",
+              "paused",
+            ],
+            description: "Status of the task",
+          },
+          parentTaskId: {
+            type: "string",
+            minLength: 28,
+            maxLength: 36,
+            description:
+              "Parent task id is the parent task that created this task",
+          },
+          conversationId: {
+            type: "string",
+            minLength: 28,
+            maxLength: 36,
+            description: "Conversation id related to this task",
+          },
+          userId: {
+            type: "string",
+            minLength: 28,
+            maxLength: 36,
+            description: "Specific user related to this task",
+          },
+          timeoutAt: {
+            type: "string",
+            format: "date-time",
+            description:
+              "The timeout date where the task should be failed in the ISO 8601 format",
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time",
+            description: "Creation date of the task in ISO 8601 format",
+          },
+          updatedAt: {
+            type: "string",
+            format: "date-time",
+            description: "Updating date of the task in ISO 8601 format",
+          },
+          failureReason: {
+            type: "string",
+            maxLength: 2000,
+            description: "If the task fails this is the reason behind it",
+          },
+          tags: {
+            type: "object",
+            additionalProperties: {
+              type: "string",
+            },
+            description:
+              "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.",
+          },
+        },
+        required: [
+          "id",
+          "title",
+          "instruction",
+          "type",
+          "data",
+          "status",
+          "timeoutAt",
+          "createdAt",
+          "updatedAt",
+          "tags",
+        ],
+        description: "Task definition",
+        additionalProperties: false,
+      },
+    },
     File: {
       section: "file",
       schema: {
@@ -7954,58 +8476,76 @@ export const state = {
             description:
               "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.",
           },
-          columns: {
-            type: "array",
-            items: {
-              type: "object",
+          schema: {
+            type: "object",
+            properties: {
+              $schema: {
+                type: "string",
+              },
               properties: {
-                id: {
-                  type: "string",
-                  description: "Unique identifier for the column.",
-                },
-                name: {
-                  type: "string",
-                  minLength: 1,
-                  maxLength: 30,
-                  description:
-                    "Name of the column, must be within length limits.",
-                },
-                description: {
-                  type: "string",
-                  description: "Optional descriptive text about the column.",
-                },
-                searchable: {
-                  type: "boolean",
-                  description:
-                    "Indicates if the column is vectorized and searchable.",
-                },
-                type: {
-                  type: "string",
-                  enum: ["string", "number", "boolean", "date", "object"],
-                  description:
-                    'Specifies the data type of the column. Use "object" for complex data structures.',
+                type: "object",
+                additionalProperties: {
+                  type: "object",
+                  properties: {
+                    type: {
+                      type: "string",
+                      enum: ["string", "number", "boolean", "object", "null"],
+                    },
+                    format: {
+                      type: "string",
+                      enum: ["date-time"],
+                    },
+                    description: {
+                      type: "string",
+                    },
+                    nullable: {
+                      default: true,
+                      type: "boolean",
+                    },
+                    "x-zui": {
+                      type: "object",
+                      properties: {
+                        index: {
+                          type: "integer",
+                        },
+                        searchable: {
+                          type: "boolean",
+                          description:
+                            "Indicates if the column is vectorized and searchable.",
+                        },
+                        typings: {
+                          type: "string",
+                          description:
+                            'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
+                        },
+                      },
+                      required: ["index"],
+                      additionalProperties: false,
+                    },
+                  },
+                  required: ["type", "x-zui"],
+                  additionalProperties: false,
                 },
-                typings: {
+                description: "List of keys/columns in the table.",
+              },
+              additionalProperties: {
+                type: "boolean",
+                enum: [false],
+              },
+              required: {
+                type: "array",
+                items: {
                   type: "string",
-                  description:
-                    'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
-                },
-                schema: {
-                  type: "object",
-                  properties: {},
-                  additionalProperties: true,
                 },
+                description: "Array of required properties.",
+              },
+              type: {
+                type: "string",
+                enum: ["object"],
               },
-              required: ["name", "type"],
             },
-            maxItems: 20,
-            description: "Array of columns in the table.",
-          },
-          schema: {
-            type: "object",
-            additionalProperties: true,
-            description:
-              "Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.",
+            required: ["$schema", "properties", "additionalProperties", "type"],
+            additionalProperties: false,
           },
           tags: {
             type: "object",
@@ -8024,7 +8564,7 @@ export const state = {
             description: "Timestamp of the last table update.",
           },
         },
-        required: ["id", "name", "columns", "schema"],
+        required: ["id", "name", "schema"],
         additionalProperties: false,
       },
     },
@@ -8190,6 +8730,19 @@ export const state = {
       name: "action",
       operations: ["callAction"],
     },
+    {
+      description: "",
+      title: "Task",
+      name: "task",
+      operations: [
+        "getTask",
+        "createTask",
+        "updateTask",
+        "deleteTask",
+        "listTasks",
+      ],
+      schema: "Task",
+    },
     {
       title: "Bot",
       description: "",
@@ -8242,6 +8795,7 @@ export const state = {
         "getWorkspaceQuota",
         "listWorkspaceQuotas",
         "updateWorkspace",
+        "checkHandleAvailability",
         "listWorkspaces",
         "changeWorkspacePlan",
         "deleteWorkspace",