@botpress/client 0.32.0 → 0.33.1

package/dist/index.d.ts

@@ -47,7 +47,7 @@ interface CreateConversationRequestBody {
 type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
 interface CreateConversationResponse {
     /**
-     * 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.
+     * 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.
      */
     conversation: {
         /**
@@ -58,6 +58,10 @@ interface CreateConversationResponse {
          * Id of the current [Task](#schema_task)
          */
         currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
         /**
          * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
@@ -95,7 +99,7 @@ interface GetConversationRequestBody {
 type GetConversationInput = GetConversationRequestBody & GetConversationRequestHeaders & GetConversationRequestQuery & GetConversationRequestParams;
 interface GetConversationResponse {
     /**
-     * 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.
+     * 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.
      */
     conversation: {
         /**
@@ -106,6 +110,10 @@ interface GetConversationResponse {
          * Id of the current [Task](#schema_task)
          */
         currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
         /**
          * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
@@ -158,6 +166,10 @@ interface ListConversationsResponse {
          * Id of the current [Task](#schema_task)
          */
         currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
         /**
          * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
@@ -215,7 +227,7 @@ interface GetOrCreateConversationRequestBody {
 type GetOrCreateConversationInput = GetOrCreateConversationRequestBody & GetOrCreateConversationRequestHeaders & GetOrCreateConversationRequestQuery & GetOrCreateConversationRequestParams;
 interface GetOrCreateConversationResponse {
     /**
-     * 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.
+     * 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.
      */
     conversation: {
         /**
@@ -226,6 +238,10 @@ interface GetOrCreateConversationResponse {
          * Id of the current [Task](#schema_task)
          */
         currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
         /**
          * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
@@ -270,7 +286,7 @@ interface UpdateConversationRequestBody {
 type UpdateConversationInput = UpdateConversationRequestBody & UpdateConversationRequestHeaders & UpdateConversationRequestQuery & UpdateConversationRequestParams;
 interface UpdateConversationResponse {
     /**
-     * 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.
+     * 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.
      */
     conversation: {
         /**
@@ -281,6 +297,10 @@ interface UpdateConversationResponse {
          * Id of the current [Task](#schema_task)
          */
         currentTaskId?: string;
+        /**
+         * Id of the current [Workflow](#schema_workflow)
+         */
+        currentWorkflowId?: string;
         /**
          * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
          */
@@ -553,7 +573,7 @@ interface CreateEventResponse {
          * ID of the [Message](#schema_message) to link the event to.
          */
         messageId?: string;
-        status: "pending" | "processed" | "ignored" | "failed";
+        status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
         /**
          * Reason why the event failed to be processed
          */
@@ -606,7 +626,7 @@ interface GetEventResponse {
          * ID of the [Message](#schema_message) to link the event to.
          */
         messageId?: string;
-        status: "pending" | "processed" | "ignored" | "failed";
+        status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
         /**
          * Reason why the event failed to be processed
          */
@@ -622,7 +642,7 @@ interface ListEventsRequestQuery {
     conversationId?: string;
     userId?: string;
     messageId?: string;
-    status?: string;
+    status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
 }
 interface ListEventsRequestParams {
 }
@@ -661,7 +681,7 @@ interface ListEventsResponse {
          * ID of the [Message](#schema_message) to link the event to.
          */
         messageId?: string;
-        status: "pending" | "processed" | "ignored" | "failed";
+        status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
         /**
          * Reason why the event failed to be processed
          */
@@ -1338,7 +1358,7 @@ interface SetStateExpiryRequestHeaders {
 interface SetStateExpiryRequestQuery {
 }
 interface SetStateExpiryRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
+    type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
     id: string;
     name: string;
 }
@@ -1383,9 +1403,9 @@ interface SetStateExpiryResponse {
          */
         name: string;
         /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
          */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
+        type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
         /**
          * Payload is the content of the state defined by your bot.
          */
@@ -1400,7 +1420,7 @@ interface GetStateRequestHeaders {
 interface GetStateRequestQuery {
 }
 interface GetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
+    type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
     id: string;
     name: string;
 }
@@ -1441,9 +1461,9 @@ interface GetStateResponse {
          */
         name: string;
         /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
          */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
+        type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
         /**
          * Payload is the content of the state defined by your bot.
          */
@@ -1461,7 +1481,7 @@ interface SetStateRequestHeaders {
 interface SetStateRequestQuery {
 }
 interface SetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
+    type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
     id: string;
     name: string;
 }
@@ -1512,9 +1532,9 @@ interface SetStateResponse {
          */
         name: string;
         /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
          */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
+        type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
         /**
          * Payload is the content of the state defined by your bot.
          */
@@ -1529,7 +1549,7 @@ interface GetOrSetStateRequestHeaders {
 interface GetOrSetStateRequestQuery {
 }
 interface GetOrSetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
+    type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
     id: string;
     name: string;
 }
@@ -1580,9 +1600,9 @@ interface GetOrSetStateResponse {
          */
         name: string;
         /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
          */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
+        type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
         /**
          * Payload is the content of the state defined by your bot.
          */
@@ -1600,7 +1620,7 @@ interface PatchStateRequestHeaders {
 interface PatchStateRequestQuery {
 }
 interface PatchStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
+    type: "conversation" | "user" | "bot" | "integration" | "task" | "workflow";
     id: string;
     name: string;
 }
@@ -1647,9 +1667,9 @@ interface PatchStateResponse {
          */
         name: string;
         /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
          */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
+        type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
         /**
          * Payload is the content of the state defined by your bot.
          */
@@ -2109,6 +2129,534 @@ interface ListTasksResponse {
     };
 }
 
+interface CreateWorkflowRequestHeaders {
+}
+interface CreateWorkflowRequestQuery {
+}
+interface CreateWorkflowRequestParams {
+}
+interface CreateWorkflowRequestBody {
+    /**
+     * Name of the workflow
+     */
+    name: string;
+    /**
+     * Content related to the workflow
+     */
+    input?: {
+        [k: string]: any;
+    };
+    /**
+     * Parent workflow id is the parent workflow that created this workflow
+     */
+    parentWorkflowId?: string;
+    /**
+     * Conversation id related to this workflow
+     */
+    conversationId?: string;
+    /**
+     * Specific user related to this workflow
+     */
+    userId?: string;
+    /**
+     * The timeout date where the workflow should be failed in the ISO 8601 format
+     */
+    timeoutAt?: string;
+    /**
+     * Tags for the [Workflow](#schema_workflow)
+     */
+    tags?: {
+        [k: string]: string;
+    };
+    status: "pending" | "in_progress";
+    /**
+     * Event id must be specified if the workflow is created with the status in_progress
+     */
+    eventId?: string;
+}
+type CreateWorkflowInput = CreateWorkflowRequestBody & CreateWorkflowRequestHeaders & CreateWorkflowRequestQuery & CreateWorkflowRequestParams;
+interface CreateWorkflowResponse {
+    /**
+     * Workflow definition
+     */
+    workflow: {
+        /**
+         * Id of the [Workflow](#schema_workflow)
+         */
+        id: string;
+        /**
+         * Name of the workflow
+         */
+        name: string;
+        /**
+         * Status of the [Workflow](#schema_workflow)
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+        /**
+         * Input provided to the [Workflow](#schema_workflow)
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Data returned by the [Workflow](#schema_workflow) output
+         */
+        output: {
+            [k: string]: any;
+        };
+        /**
+         * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+         */
+        parentWorkflowId?: string;
+        /**
+         * Conversation id related to this [Workflow](#schema_workflow)
+         */
+        conversationId?: string;
+        /**
+         * User id related to this [Workflow](#schema_workflow)
+         */
+        userId?: string;
+        /**
+         * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+         */
+        completedAt?: string;
+        /**
+         * If the [Workflow](#schema_workflow) fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * 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.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}
+
+interface GetWorkflowRequestHeaders {
+}
+interface GetWorkflowRequestQuery {
+}
+interface GetWorkflowRequestParams {
+    id: string;
+}
+interface GetWorkflowRequestBody {
+}
+type GetWorkflowInput = GetWorkflowRequestBody & GetWorkflowRequestHeaders & GetWorkflowRequestQuery & GetWorkflowRequestParams;
+interface GetWorkflowResponse {
+    /**
+     * Workflow definition
+     */
+    workflow: {
+        /**
+         * Id of the [Workflow](#schema_workflow)
+         */
+        id: string;
+        /**
+         * Name of the workflow
+         */
+        name: string;
+        /**
+         * Status of the [Workflow](#schema_workflow)
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+        /**
+         * Input provided to the [Workflow](#schema_workflow)
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Data returned by the [Workflow](#schema_workflow) output
+         */
+        output: {
+            [k: string]: any;
+        };
+        /**
+         * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+         */
+        parentWorkflowId?: string;
+        /**
+         * Conversation id related to this [Workflow](#schema_workflow)
+         */
+        conversationId?: string;
+        /**
+         * User id related to this [Workflow](#schema_workflow)
+         */
+        userId?: string;
+        /**
+         * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+         */
+        completedAt?: string;
+        /**
+         * If the [Workflow](#schema_workflow) fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * 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.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}
+
+interface UpdateWorkflowRequestHeaders {
+}
+interface UpdateWorkflowRequestQuery {
+}
+interface UpdateWorkflowRequestParams {
+    id: string;
+}
+interface UpdateWorkflowRequestBody {
+    /**
+     * Content related to the workflow
+     */
+    output?: {
+        [k: string]: any;
+    };
+    /**
+     * The timeout date where the workflow should be failed in the ISO 8601 format
+     */
+    timeoutAt?: string;
+    /**
+     * Status of the workflow
+     */
+    status?: "completed" | "cancelled" | "listening" | "paused" | "failed" | "in_progress";
+    /**
+     * Reason why the workflow failed
+     */
+    failureReason?: string;
+    /**
+     * Tags for the [Workflow](#schema_workflow)
+     */
+    tags?: {
+        [k: string]: string;
+    };
+    /**
+     * Specific user related to this workflow
+     */
+    userId?: string;
+    /**
+     * Event id must be specified if the workflow is updated with the status in_progress
+     */
+    eventId?: string;
+}
+type UpdateWorkflowInput = UpdateWorkflowRequestBody & UpdateWorkflowRequestHeaders & UpdateWorkflowRequestQuery & UpdateWorkflowRequestParams;
+interface UpdateWorkflowResponse {
+    /**
+     * Workflow definition
+     */
+    workflow: {
+        /**
+         * Id of the [Workflow](#schema_workflow)
+         */
+        id: string;
+        /**
+         * Name of the workflow
+         */
+        name: string;
+        /**
+         * Status of the [Workflow](#schema_workflow)
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+        /**
+         * Input provided to the [Workflow](#schema_workflow)
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Data returned by the [Workflow](#schema_workflow) output
+         */
+        output: {
+            [k: string]: any;
+        };
+        /**
+         * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+         */
+        parentWorkflowId?: string;
+        /**
+         * Conversation id related to this [Workflow](#schema_workflow)
+         */
+        conversationId?: string;
+        /**
+         * User id related to this [Workflow](#schema_workflow)
+         */
+        userId?: string;
+        /**
+         * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+         */
+        completedAt?: string;
+        /**
+         * If the [Workflow](#schema_workflow) fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * 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.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}
+
+interface DeleteWorkflowRequestHeaders {
+}
+interface DeleteWorkflowRequestQuery {
+}
+interface DeleteWorkflowRequestParams {
+    id: string;
+}
+interface DeleteWorkflowRequestBody {
+}
+type DeleteWorkflowInput = DeleteWorkflowRequestBody & DeleteWorkflowRequestHeaders & DeleteWorkflowRequestQuery & DeleteWorkflowRequestParams;
+interface DeleteWorkflowResponse {
+}
+
+interface ListWorkflowsRequestHeaders {
+}
+interface ListWorkflowsRequestQuery {
+    nextToken?: string;
+    tags?: {
+        [k: string]: string;
+    };
+    conversationId?: string;
+    userId?: string;
+    parentWorkflowId?: string;
+    statuses?: ("pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled")[];
+    name?: string;
+}
+interface ListWorkflowsRequestParams {
+}
+interface ListWorkflowsRequestBody {
+}
+type ListWorkflowsInput = ListWorkflowsRequestBody & ListWorkflowsRequestHeaders & ListWorkflowsRequestQuery & ListWorkflowsRequestParams;
+interface ListWorkflowsResponse {
+    workflows: {
+        /**
+         * Id of the [Workflow](#schema_workflow)
+         */
+        id: string;
+        /**
+         * Name of the workflow
+         */
+        name: string;
+        /**
+         * Status of the [Workflow](#schema_workflow)
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+        /**
+         * Input provided to the [Workflow](#schema_workflow)
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Data returned by the [Workflow](#schema_workflow) output
+         */
+        output: {
+            [k: string]: any;
+        };
+        /**
+         * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+         */
+        parentWorkflowId?: string;
+        /**
+         * Conversation id related to this [Workflow](#schema_workflow)
+         */
+        conversationId?: string;
+        /**
+         * User id related to this [Workflow](#schema_workflow)
+         */
+        userId?: string;
+        /**
+         * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+         */
+        completedAt?: string;
+        /**
+         * If the [Workflow](#schema_workflow) fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * 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.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    }[];
+    meta: {
+        /**
+         * 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.
+         */
+        nextToken?: string;
+    };
+}
+
+interface GetOrCreateWorkflowRequestHeaders {
+}
+interface GetOrCreateWorkflowRequestQuery {
+}
+interface GetOrCreateWorkflowRequestParams {
+}
+interface GetOrCreateWorkflowRequestBody {
+    /**
+     * Name of the workflow
+     */
+    name: string;
+    /**
+     * Content related to the workflow
+     */
+    input?: {
+        [k: string]: any;
+    };
+    /**
+     * Parent workflow id is the parent workflow that created this workflow
+     */
+    parentWorkflowId?: string;
+    /**
+     * Conversation id related to this workflow
+     */
+    conversationId?: string;
+    /**
+     * Specific user related to this workflow
+     */
+    userId?: string;
+    /**
+     * The timeout date where the workflow should be failed in the ISO 8601 format
+     */
+    timeoutAt?: string;
+    /**
+     * Tags for the [Workflow](#schema_workflow)
+     */
+    tags?: {
+        [k: string]: string;
+    };
+    status: "pending" | "in_progress";
+    /**
+     * Event id must be specified if the workflow is created with the status in_progress
+     */
+    eventId?: string;
+}
+type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
+interface GetOrCreateWorkflowResponse {
+    /**
+     * Workflow definition
+     */
+    workflow: {
+        /**
+         * Id of the [Workflow](#schema_workflow)
+         */
+        id: string;
+        /**
+         * Name of the workflow
+         */
+        name: string;
+        /**
+         * Status of the [Workflow](#schema_workflow)
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
+        /**
+         * Input provided to the [Workflow](#schema_workflow)
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Data returned by the [Workflow](#schema_workflow) output
+         */
+        output: {
+            [k: string]: any;
+        };
+        /**
+         * Parent [Workflow](#schema_workflow) id is the parent [Workflow](#schema_workflow) that created this [Workflow](#schema_workflow)
+         */
+        parentWorkflowId?: string;
+        /**
+         * Conversation id related to this [Workflow](#schema_workflow)
+         */
+        conversationId?: string;
+        /**
+         * User id related to this [Workflow](#schema_workflow)
+         */
+        userId?: string;
+        /**
+         * Creation date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Workflow](#schema_workflow) in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * The date when the [Workflow](#schema_workflow) completed in ISO 8601 format
+         */
+        completedAt?: string;
+        /**
+         * If the [Workflow](#schema_workflow) fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * The timeout date when the [Workflow](#schema_workflow) will fail in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * 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.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}
+
 interface TrackAnalyticsRequestHeaders {
 }
 interface TrackAnalyticsRequestQuery {
@@ -2394,6 +2942,9 @@ interface GetPublicIntegrationByIdResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -2414,6 +2965,11 @@ interface GetPublicIntegrationByIdResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -2753,6 +3309,9 @@ interface GetPublicIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -2773,6 +3332,11 @@ interface GetPublicIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -4489,6 +5053,40 @@ interface GetBotAnalyticsResponse {
         customEvents: {
             [k: string]: number;
         };
+        llm: {
+            calls: number;
+            errors: number;
+            inputTokens: number;
+            outputTokens: number;
+            /**
+             * The time it took for the LLM to complete its response. Values are expressed in milliseconds
+             */
+            latency: {
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+            /**
+             * LLM response generation speed expressed in output tokens per second.
+             */
+            tokensPerSecond: {
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+            /**
+             * Values are expressed in U.S. dollars
+             */
+            cost: {
+                sum: number;
+                mean: number;
+                sd: number;
+                min: number;
+                max: number;
+            };
+        };
     }[];
 }
 
@@ -5580,18 +6178,26 @@ interface CreateIntegrationRequestBody {
     };
     interfaces?: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
-            entities: {
+            entities?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            actions: {
+            actions?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            events: {
+            events?: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            channels?: {
                 [k: string]: {
                     name: string;
                 };
@@ -5679,6 +6285,9 @@ interface CreateIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -5699,6 +6308,11 @@ interface CreateIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -6222,18 +6836,26 @@ interface UpdateIntegrationRequestBody {
     };
     interfaces?: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
-            entities: {
+            entities?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            actions: {
+            actions?: {
                 [k: string]: {
                     name: string;
                 };
             };
-            events: {
+            events?: {
+                [k: string]: {
+                    name: string;
+                };
+            };
+            channels?: {
                 [k: string]: {
                     name: string;
                 };
@@ -6317,6 +6939,9 @@ interface UpdateIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -6337,6 +6962,11 @@ interface UpdateIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -6734,6 +7364,9 @@ interface GetIntegrationResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -6754,6 +7387,11 @@ interface GetIntegrationResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -7110,6 +7748,9 @@ interface GetIntegrationByNameResponse {
         version: string;
         interfaces: {
             [k: string]: {
+                /**
+                 * ID of the interface
+                 */
                 id: string;
                 /**
                  * Name of the interface
@@ -7130,6 +7771,11 @@ interface GetIntegrationByNameResponse {
                         name: string;
                     };
                 };
+                channels: {
+                    [k: string]: {
+                        name: string;
+                    };
+                };
             };
         };
         /**
@@ -7453,7 +8099,25 @@ interface CreateInterfaceRequestBody {
      * Version of the [Interface](#schema_interface)
      */
     version: string;
-    events: {
+    entities?: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        };
+    };
+    events?: {
         /**
          * Event Definition
          */
@@ -7471,7 +8135,7 @@ interface CreateInterfaceRequestBody {
             };
         };
     };
-    actions: {
+    actions?: {
         /**
          * Action definition
          */
@@ -7498,21 +8162,25 @@ interface CreateInterfaceRequestBody {
             };
         };
     };
-    entities: {
-        /**
-         * Entity definition
-         */
+    channels?: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
             };
         };
     };
@@ -7547,6 +8215,24 @@ interface CreateInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -7592,21 +8278,25 @@ interface CreateInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -7652,6 +8342,24 @@ interface GetInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -7697,21 +8405,25 @@ interface GetInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -7758,6 +8470,24 @@ interface GetInterfaceByNameResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -7803,21 +8533,25 @@ interface GetInterfaceByNameResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -7839,6 +8573,24 @@ interface UpdateInterfaceRequestParams {
     id: string;
 }
 interface UpdateInterfaceRequestBody {
+    entities?: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        } | null;
+    };
     events?: {
         /**
          * Event Definition
@@ -7884,21 +8636,25 @@ interface UpdateInterfaceRequestBody {
             };
         } | null;
     };
-    entities?: {
-        /**
-         * Entity definition
-         */
+    channels?: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages?: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                } | null;
             };
         } | null;
     };
@@ -7933,6 +8689,24 @@ interface UpdateInterfaceResponse {
          * Version of the [Interface](#schema_interface)
          */
         version: string;
+        entities: {
+            /**
+             * Entity definition
+             */
+            [k: string]: {
+                /**
+                 * Title of the entity
+                 */
+                title?: string;
+                /**
+                 * Description of the entity
+                 */
+                description?: string;
+                schema: {
+                    [k: string]: any;
+                };
+            };
+        };
         events: {
             /**
              * Event Definition
@@ -7978,21 +8752,25 @@ interface UpdateInterfaceResponse {
                 };
             };
         };
-        entities: {
-            /**
-             * Entity definition
-             */
+        channels: {
             [k: string]: {
                 /**
-                 * Title of the entity
+                 * Title of the channel
                  */
                 title?: string;
                 /**
-                 * Description of the entity
+                 * Description of the channel
                  */
                 description?: string;
-                schema: {
-                    [k: string]: any;
+                messages: {
+                    /**
+                     * Message definition
+                     */
+                    [k: string]: {
+                        schema: {
+                            [k: string]: any;
+                        };
+                    };
                 };
             };
         };
@@ -8170,6 +8948,32 @@ interface ListUsageHistoryResponse {
     }[];
 }
 
+interface ListUsageActivityRequestHeaders {
+}
+interface ListUsageActivityRequestQuery {
+    type: "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";
+    nextToken?: string;
+}
+interface ListUsageActivityRequestParams {
+    id: string;
+}
+interface ListUsageActivityRequestBody {
+}
+type ListUsageActivityInput = ListUsageActivityRequestBody & ListUsageActivityRequestHeaders & ListUsageActivityRequestQuery & ListUsageActivityRequestParams;
+interface ListUsageActivityResponse {
+    data: {
+        timestamp: string;
+        value: number;
+        period: string;
+        metadata: {
+            [k: string]: any | null;
+        };
+    }[];
+    meta: {
+        nextToken?: string;
+    };
+}
+
 interface ChangeAispendQuotaRequestHeaders {
 }
 interface ChangeAispendQuotaRequestQuery {
@@ -8847,6 +9651,10 @@ interface ListTablesResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -8988,6 +9796,10 @@ interface GetTableResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -9165,6 +9977,10 @@ interface GetOrCreateTableResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -9349,6 +10165,10 @@ interface CreateTableResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -9499,6 +10319,10 @@ interface DuplicateTableResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -9668,6 +10492,10 @@ interface UpdateTableResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -9821,6 +10649,10 @@ interface RenameTableColumnResponse {
                          * Width of the column in the UI
                          */
                         width?: number;
+                        /**
+                         * ID of the schema
+                         */
+                        schemaId?: string;
                         computed?: {
                             action: "ai" | "code" | "workflow";
                             dependencies?: string[];
@@ -10614,6 +11446,9 @@ interface Integration {
     version: string;
     interfaces: {
         [k: string]: {
+            /**
+             * ID of the interface
+             */
             id: string;
             /**
              * Name of the interface
@@ -10634,6 +11469,11 @@ interface Integration {
                     name: string;
                 };
             };
+            channels: {
+                [k: string]: {
+                    name: string;
+                };
+            };
         };
     };
     /**
@@ -10935,6 +11775,24 @@ interface Interface {
      * Version of the [Interface](#schema_interface)
      */
     version: string;
+    entities: {
+        /**
+         * Entity definition
+         */
+        [k: string]: {
+            /**
+             * Title of the entity
+             */
+            title?: string;
+            /**
+             * Description of the entity
+             */
+            description?: string;
+            schema: {
+                [k: string]: any;
+            };
+        };
+    };
     events: {
         /**
          * Event Definition
@@ -10980,21 +11838,25 @@ interface Interface {
             };
         };
     };
-    entities: {
-        /**
-         * Entity definition
-         */
+    channels: {
         [k: string]: {
             /**
-             * Title of the entity
+             * Title of the channel
              */
             title?: string;
             /**
-             * Description of the entity
+             * Description of the channel
              */
             description?: string;
-            schema: {
-                [k: string]: any;
+            messages: {
+                /**
+                 * Message definition
+                 */
+                [k: string]: {
+                    schema: {
+                        [k: string]: any;
+                    };
+                };
             };
         };
     };
@@ -11126,7 +11988,7 @@ interface User {
     pictureUrl?: string;
 }
 /**
- * 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.
+ * 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.
  */
 interface Conversation {
     /**
@@ -11137,6 +11999,10 @@ interface Conversation {
      * Id of the current [Task](#schema_task)
      */
     currentTaskId?: string;
+    /**
+     * Id of the current [Workflow](#schema_workflow)
+     */
+    currentWorkflowId?: string;
     /**
      * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
      */
@@ -11194,7 +12060,7 @@ interface Event {
      * ID of the [Message](#schema_message) to link the event to.
      */
     messageId?: string;
-    status: "pending" | "processed" | "ignored" | "failed";
+    status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
     /**
      * Reason why the event failed to be processed
      */
@@ -11274,9 +12140,9 @@ interface State {
      */
     name: string;
     /**
-     * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
+     * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task`, `integration` or `workflow`) that the state is related to
      */
-    type: "conversation" | "user" | "bot" | "task" | "integration";
+    type: "conversation" | "user" | "bot" | "task" | "integration" | "workflow";
     /**
      * Payload is the content of the state defined by your bot.
      */
@@ -11355,6 +12221,10 @@ interface Table {
                      * Width of the column in the UI
                      */
                     width?: number;
+                    /**
+                     * ID of the schema
+                     */
+                    schemaId?: string;
                     computed?: {
                         action: "ai" | "code" | "workflow";
                         dependencies?: string[];
@@ -11606,6 +12476,12 @@ declare class Client$1 {
     readonly updateTask: (input: UpdateTaskInput) => Promise<UpdateTaskResponse>;
     readonly deleteTask: (input: DeleteTaskInput) => Promise<DeleteTaskResponse>;
     readonly listTasks: (input: ListTasksInput) => Promise<ListTasksResponse>;
+    readonly createWorkflow: (input: CreateWorkflowInput) => Promise<CreateWorkflowResponse>;
+    readonly getWorkflow: (input: GetWorkflowInput) => Promise<GetWorkflowResponse>;
+    readonly updateWorkflow: (input: UpdateWorkflowInput) => Promise<UpdateWorkflowResponse>;
+    readonly deleteWorkflow: (input: DeleteWorkflowInput) => Promise<DeleteWorkflowResponse>;
+    readonly listWorkflows: (input: ListWorkflowsInput) => Promise<ListWorkflowsResponse>;
+    readonly getOrCreateWorkflow: (input: GetOrCreateWorkflowInput) => Promise<GetOrCreateWorkflowResponse>;
     readonly trackAnalytics: (input: TrackAnalyticsInput) => Promise<TrackAnalyticsResponse>;
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
@@ -11678,6 +12554,7 @@ declare class Client$1 {
     readonly getUsage: (input: GetUsageInput) => Promise<GetUsageResponse>;
     readonly getMultipleUsages: (input: GetMultipleUsagesInput) => Promise<GetMultipleUsagesResponse>;
     readonly listUsageHistory: (input: ListUsageHistoryInput) => Promise<ListUsageHistoryResponse>;
+    readonly listUsageActivity: (input: ListUsageActivityInput) => Promise<ListUsageActivityResponse>;
     readonly changeAISpendQuota: (input: ChangeAispendQuotaInput) => Promise<ChangeAispendQuotaResponse>;
     readonly listActivities: (input: ListActivitiesInput) => Promise<ListActivitiesResponse>;
     readonly introspect: (input: IntrospectInput) => Promise<IntrospectResponse>;
@@ -12035,6 +12912,7 @@ declare class Lister {
     readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
         id: string;
         currentTaskId?: string | undefined;
+        currentWorkflowId?: string | undefined;
         createdAt: string;
         updatedAt: string;
         channel: string;
@@ -12063,7 +12941,7 @@ declare class Lister {
         conversationId?: string | undefined;
         userId?: string | undefined;
         messageId?: string | undefined;
-        status: "pending" | "processed" | "ignored" | "failed";
+        status: "pending" | "processed" | "ignored" | "failed" | "scheduled";
         failureReason: string | null;
     }>;
     readonly messages: (props: ListInputs['listMessages']) => AsyncCollection<{