@botpress/api 0.43.1 → 0.44.0

package/dist/index.js

@@ -283245,6 +283245,13 @@ var state = {
         "status": {
           "in": "query",
           "type": "string",
+          "enum": [
+            "pending",
+            "ignored",
+            "processed",
+            "failed",
+            "scheduled"
+          ],
           "description": "Filter by status. Allowed values: pending, ignored, processed, failed."
         }
       },
@@ -283927,7 +283934,8 @@ var state = {
             "user",
             "bot",
             "integration",
-            "task"
+            "task",
+            "workflow"
           ]
         },
         "id": {
@@ -283994,7 +284002,8 @@ var state = {
             "user",
             "bot",
             "integration",
-            "task"
+            "task",
+            "workflow"
           ]
         },
         "id": {
@@ -284054,7 +284063,8 @@ var state = {
             "user",
             "bot",
             "integration",
-            "task"
+            "task",
+            "workflow"
           ]
         },
         "id": {
@@ -284127,7 +284137,8 @@ var state = {
             "user",
             "bot",
             "integration",
-            "task"
+            "task",
+            "workflow"
           ]
         },
         "id": {
@@ -284212,7 +284223,8 @@ var state = {
             "user",
             "bot",
             "integration",
-            "task"
+            "task",
+            "workflow"
           ]
         },
         "id": {
@@ -284664,6 +284676,393 @@ var state = {
         }
       }
     },
+    "createWorkflow": {
+      "name": "createWorkflow",
+      "description": "Creates a new [Workflow](#schema_workflow).",
+      "method": "post",
+      "path": "/v1/chat/workflows",
+      "requestBody": {
+        "description": "Workflow data",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the workflow"
+            },
+            "input": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Content related to the workflow"
+            },
+            "parentWorkflowId": {
+              "type": "string",
+              "description": "Parent workflow id is the parent workflow that created this workflow"
+            },
+            "conversationId": {
+              "type": "string",
+              "description": "Conversation id related to this workflow"
+            },
+            "userId": {
+              "type": "string",
+              "description": "Specific user related to this workflow"
+            },
+            "timeoutAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The timeout date where the workflow should be failed in the ISO 8601 format"
+            },
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 500
+              },
+              "description": "Tags for the [Workflow](#schema_workflow)"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "in_progress"
+              ]
+            },
+            "eventId": {
+              "type": "string",
+              "description": "Event id must be specified if the workflow is created with the status in_progress"
+            }
+          },
+          "required": [
+            "name",
+            "status"
+          ],
+          "title": "createWorkflowBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns a [Workflow](#schema_workflow) object if creation succeeds. Returns an [Error](#errors) otherwise",
+        "status": 201,
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workflow": {
+              "$ref": "#/components/schemas/Workflow"
+            }
+          },
+          "required": [
+            "workflow"
+          ],
+          "title": "createWorkflowResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
+    "getWorkflow": {
+      "name": "getWorkflow",
+      "description": "Retrieves the [Workflow](#schema_workflow) object for a valid identifier.",
+      "method": "get",
+      "path": "/v1/chat/workflows/{id}",
+      "parameters": {
+        "id": {
+          "in": "path",
+          "type": "string",
+          "description": "Workflow id"
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns a [Workflow](#schema_workflow) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workflow": {
+              "$ref": "#/components/schemas/Workflow"
+            }
+          },
+          "required": [
+            "workflow"
+          ],
+          "title": "getWorkflowResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "updateWorkflow": {
+      "name": "updateWorkflow",
+      "description": "Update a [Workflow](#schema_workflow) object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.",
+      "method": "put",
+      "path": "/v1/chat/workflows/{id}",
+      "parameters": {
+        "id": {
+          "in": "path",
+          "type": "string",
+          "description": "Workflow id"
+        }
+      },
+      "requestBody": {
+        "description": "Workflow data",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "output": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Content related to the workflow"
+            },
+            "timeoutAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The timeout date where the workflow should be failed in the ISO 8601 format"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "completed",
+                "cancelled",
+                "listening",
+                "paused",
+                "failed"
+              ],
+              "description": "Status of the workflow"
+            },
+            "failureReason": {
+              "type": "string",
+              "description": "Reason why the workflow failed"
+            },
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 500
+              },
+              "description": "Tags for the [Workflow](#schema_workflow)"
+            },
+            "userId": {
+              "type": "string",
+              "description": "Specific user related to this workflow"
+            }
+          },
+          "title": "updateWorkflowBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns an updated [Workflow](#schema_workflow) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workflow": {
+              "$ref": "#/components/schemas/Workflow"
+            }
+          },
+          "required": [
+            "workflow"
+          ],
+          "title": "updateWorkflowResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "deleteWorkflow": {
+      "name": "deleteWorkflow",
+      "description": "Permanently deletes a [Workflow](#schema_workflow). It cannot be undone.",
+      "method": "delete",
+      "path": "/v1/chat/workflows/{id}",
+      "parameters": {
+        "id": {
+          "in": "path",
+          "type": "string",
+          "description": "Workflow id"
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns the [Workflow](#schema_workflow) object that was deleted",
+        "schema": {
+          "type": "object",
+          "title": "deleteWorkflowResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "listWorkflows": {
+      "name": "listWorkflows",
+      "description": "Retrieves a list of [Workflow](#schema_workflow) you've previously created. The workflows are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
+      "method": "get",
+      "path": "/v1/chat/workflows",
+      "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"
+        },
+        "parentWorkflowId": {
+          "in": "query",
+          "type": "string",
+          "description": "Parent workflow id"
+        },
+        "statuses": {
+          "in": "query",
+          "type": "string[]",
+          "description": "Status",
+          "enum": [
+            "pending",
+            "in_progress",
+            "failed",
+            "completed",
+            "listening",
+            "paused",
+            "timedout",
+            "cancelled"
+          ]
+        },
+        "name": {
+          "in": "query",
+          "description": "Workflow name",
+          "type": "string"
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns a list of [Workflow](#schema_workflow) objects",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workflows": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Workflow"
+              }
+            },
+            "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": [
+            "workflows",
+            "meta"
+          ],
+          "title": "listWorkflowsResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getOrCreateWorkflow": {
+      "name": "getOrCreateWorkflow",
+      "description": "Get a workflow by tags or creates a new [Workflow](#schema_workflow) if it doesn't exists.",
+      "method": "post",
+      "path": "/v1/chat/workflows/get-or-create",
+      "requestBody": {
+        "description": "Workflow data",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the workflow"
+            },
+            "input": {
+              "type": "object",
+              "additionalProperties": true,
+              "description": "Content related to the workflow"
+            },
+            "parentWorkflowId": {
+              "type": "string",
+              "description": "Parent workflow id is the parent workflow that created this workflow"
+            },
+            "conversationId": {
+              "type": "string",
+              "description": "Conversation id related to this workflow"
+            },
+            "userId": {
+              "type": "string",
+              "description": "Specific user related to this workflow"
+            },
+            "timeoutAt": {
+              "type": "string",
+              "format": "date-time",
+              "description": "The timeout date where the workflow should be failed in the ISO 8601 format"
+            },
+            "tags": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 500
+              },
+              "description": "Tags for the [Workflow](#schema_workflow)"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "pending",
+                "in_progress"
+              ]
+            },
+            "eventId": {
+              "type": "string",
+              "description": "Event id must be specified if the workflow is created with the status in_progress"
+            }
+          },
+          "required": [
+            "name",
+            "status"
+          ],
+          "title": "getOrCreateWorkflowBody",
+          "additionalProperties": false
+        }
+      },
+      "section": "workflow",
+      "response": {
+        "description": "Returns a [Workflow](#schema_workflow) object if creation succeeds. Returns an [Error](#errors) otherwise",
+        "status": 200,
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workflow": {
+              "$ref": "#/components/schemas/Workflow"
+            }
+          },
+          "required": [
+            "workflow"
+          ],
+          "title": "getOrCreateWorkflowResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
     "trackAnalytics": {
       "name": "trackAnalytics",
       "description": "Add an event to the analytics",
@@ -292292,6 +292691,97 @@ var state = {
         }
       }
     },
+    "listUsageActivity": {
+      "name": "listUsageActivity",
+      "path": "/v1/admin/usages/{id}/activity",
+      "method": "get",
+      "description": "List the usage activity for a given usage type and ID. The most recent activity is listed first.",
+      "parameters": {
+        "type": {
+          "in": "query",
+          "description": "Usage type",
+          "type": "string",
+          "enum": [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_storage",
+            "workspace_ratelimit",
+            "table_row_count",
+            "workspace_member_count",
+            "integrations_owned_count",
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend",
+            "always_alive"
+          ],
+          "required": true
+        },
+        "id": {
+          "type": "string",
+          "description": 'ID of a bot or a workspace, depending on the "type" parameter',
+          "in": "path"
+        },
+        "nextToken": {
+          "in": "query",
+          "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          "type": "string"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "data": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "timestamp": {
+                    "type": "string"
+                  },
+                  "value": {
+                    "type": "number"
+                  },
+                  "period": {
+                    "type": "string"
+                  },
+                  "metadata": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "nullable": true
+                    }
+                  }
+                },
+                "required": [
+                  "timestamp",
+                  "value",
+                  "period",
+                  "metadata"
+                ]
+              }
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "nextToken": {
+                  "type": "string"
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "data",
+            "meta"
+          ],
+          "title": "listUsageActivityResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "changeAISpendQuota": {
       "name": "changeAISpendQuota",
       "path": "/v1/admin/quotas/ai-spend",
@@ -294232,7 +294722,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.43.1",
+    "version": "0.44.0",
     "prefix": "v1"
   },
   "errors": [
@@ -294379,6 +294869,9 @@ var state = {
       "configureIntegrationBody": true,
       "createTaskBody": true,
       "updateTaskBody": true,
+      "createWorkflowBody": true,
+      "updateWorkflowBody": true,
+      "getOrCreateWorkflowBody": true,
       "trackAnalyticsBody": true,
       "runVrlBody": true,
       "updateAccountBody": true,
@@ -294455,6 +294948,12 @@ var state = {
       "updateTaskResponse": true,
       "deleteTaskResponse": true,
       "listTasksResponse": true,
+      "createWorkflowResponse": true,
+      "getWorkflowResponse": true,
+      "updateWorkflowResponse": true,
+      "deleteWorkflowResponse": true,
+      "listWorkflowsResponse": true,
+      "getOrCreateWorkflowResponse": true,
       "trackAnalyticsResponse": true,
       "runVrlResponse": true,
       "getAccountResponse": true,
@@ -294527,6 +295026,7 @@ var state = {
       "getUsageResponse": true,
       "getMultipleUsagesResponse": true,
       "listUsageHistoryResponse": true,
+      "listUsageActivityResponse": true,
       "changeAISpendQuotaResponse": true,
       "listActivitiesResponse": true,
       "introspectResponse": true,
@@ -294570,6 +295070,7 @@ var state = {
       "Message": true,
       "State": true,
       "Task": true,
+      "Workflow": true,
       "Table": true,
       "Column": true,
       "Row": true,
@@ -296352,6 +296853,12 @@ var state = {
             "maxLength": 36,
             "description": "Id of the current [Task](#schema_task)"
           },
+          "currentWorkflowId": {
+            "type": "string",
+            "minLength": 28,
+            "maxLength": 36,
+            "description": "Id of the current [Workflow](#schema_workflow)"
+          },
           "createdAt": {
             "type": "string",
             "format": "date-time",
@@ -296386,7 +296893,7 @@ var state = {
           "integration",
           "tags"
         ],
-        "description": "The conversation object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.",
+        "description": "The [Conversation](#schema_conversation) object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.",
         "additionalProperties": false
       }
     },
@@ -296582,9 +297089,10 @@ var state = {
               "user",
               "bot",
               "task",
-              "integration"
+              "integration",
+              "workflow"
             ],
-            "description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to"
+            "description": "Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to"
           },
           "payload": {
             "type": "object",
@@ -296711,6 +297219,112 @@ var state = {
         "additionalProperties": false
       }
     },
+    "Workflow": {
+      "section": "workflow",
+      "schema": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "minLength": 28,
+            "maxLength": 36,
+            "description": "Id of the [Workflow](#schema_workflow)"
+          },
+          "name": {
+            "type": "string",
+            "maxLength": 200,
+            "description": "Name of the workflow"
+          },
+          "status": {
+            "type": "string",
+            "enum": [
+              "pending",
+              "in_progress",
+              "failed",
+              "completed",
+              "listening",
+              "paused",
+              "timedout",
+              "cancelled"
+            ],
+            "description": "Status of the [Workflow](#schema_workflow)"
+          },
+          "input": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Input provided to the [Workflow](#schema_workflow)"
+          },
+          "output": {
+            "type": "object",
+            "additionalProperties": true,
+            "description": "Data returned by the [Workflow](#schema_workflow) output"
+          },
+          "parentWorkflowId": {
+            "type": "string",
+            "minLength": 28,
+            "maxLength": 36,
+            "description": "Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)"
+          },
+          "conversationId": {
+            "type": "string",
+            "minLength": 28,
+            "maxLength": 36,
+            "description": "Conversation id related to this [Workflow](#schema_workflow)"
+          },
+          "userId": {
+            "type": "string",
+            "minLength": 28,
+            "maxLength": 36,
+            "description": "User id related to this [Workflow](#schema_workflow)"
+          },
+          "createdAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Creation date of the [Workflow](#schema_workflow) in ISO 8601 format"
+          },
+          "updatedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "Updating date of the [Workflow](#schema_workflow) in ISO 8601 format"
+          },
+          "completedAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The date when the [Workflow](#schema_workflow) completed in ISO 8601 format"
+          },
+          "failureReason": {
+            "type": "string",
+            "maxLength": 2e3,
+            "description": "If the [Workflow](#schema_workflow) fails this is the reason behind it"
+          },
+          "timeoutAt": {
+            "type": "string",
+            "format": "date-time",
+            "description": "The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format"
+          },
+          "tags": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            },
+            "description": "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Workflow](#schema_workflow). Individual keys can be unset by posting an empty value to them."
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "status",
+          "input",
+          "output",
+          "createdAt",
+          "updatedAt",
+          "timeoutAt",
+          "tags"
+        ],
+        "description": "Workflow definition",
+        "additionalProperties": false
+      }
+    },
     "Table": {
       "section": "tables",
       "schema": {
@@ -296852,6 +297466,10 @@ var state = {
                           "type": "number",
                           "description": "Width of the column in the UI"
                         },
+                        "schemaId": {
+                          "type": "string",
+                          "description": "ID of the schema"
+                        },
                         "computed": {
                           "type": "object",
                           "properties": {
@@ -297336,6 +297954,20 @@ var state = {
       ],
       "schema": "Task"
     },
+    {
+      "description": "",
+      "title": "Workflow",
+      "name": "workflow",
+      "operations": [
+        "createWorkflow",
+        "getWorkflow",
+        "updateWorkflow",
+        "deleteWorkflow",
+        "listWorkflows",
+        "getOrCreateWorkflow"
+      ],
+      "schema": "Workflow"
+    },
     {
       "title": "Bot",
       "description": "",