@botpress/client 1.24.1 → 1.25.0

package/dist/index.d.ts

@@ -588,6 +588,10 @@ interface CreateEventRequestBody$1 {
      * ID of the [User](#schema_user) to link the event to.
      */
     userId?: string;
+    /**
+     * ID of the [Workflow](#schema_workflow) to link the event to.
+     */
+    workflowId?: string;
     /**
      * ID of the [Message](#schema_message) to link the event to.
      */
@@ -698,6 +702,7 @@ interface ListEventsRequestQuery$1 {
     conversationId?: string;
     userId?: string;
     messageId?: string;
+    workflowId?: string;
     status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
 }
 interface ListEventsRequestParams$1 {
@@ -795,6 +800,7 @@ interface CreateMessageRequestBody$1 {
          */
         delay?: number;
     };
+    origin?: "synthetic";
 }
 type CreateMessageInput$1 = CreateMessageRequestBody$1 & CreateMessageRequestHeaders$1 & CreateMessageRequestQuery$1 & CreateMessageRequestParams$1;
 interface CreateMessageResponse$1 {
@@ -842,6 +848,10 @@ interface CreateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -889,6 +899,7 @@ interface GetOrCreateMessageRequestBody$1 {
          */
         delay?: number;
     };
+    origin?: "synthetic";
     /**
      * Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
@@ -940,6 +951,10 @@ interface GetOrCreateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -998,6 +1013,10 @@ interface GetMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -1068,6 +1087,10 @@ interface UpdateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -1127,6 +1150,10 @@ interface ListMessagesResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     }[];
     meta: {
         /**
@@ -2266,7 +2293,7 @@ interface CreateWorkflowRequestBody$1 {
     tags?: {
         [k: string]: string;
     };
-    status: "pending" | "in_progress";
+    status: "pending" | "in_progress" | "listening";
     /**
      * Event id must be specified if the workflow is created with the status in_progress
      */
@@ -2678,7 +2705,7 @@ interface GetOrCreateWorkflowRequestBody$1 {
     tags?: {
         [k: string]: string;
     };
-    status: "pending" | "in_progress";
+    status: "pending" | "in_progress" | "listening";
     /**
      * Event id must be specified if the workflow is created with the status in_progress
      */
@@ -2903,6 +2930,7 @@ declare class Client$8 extends Client$9 {
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
+            workflowId?: string | undefined;
             messageId?: string | undefined;
             status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
@@ -2937,6 +2965,7 @@ declare class Client$8 extends Client$9 {
             tags: {
                 [k: string]: string;
             };
+            origin?: "synthetic";
         }>;
         users: (props: {
             tags?: {
@@ -5445,7 +5474,7 @@ interface CreateBotResponse$1 {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -6076,7 +6105,7 @@ interface UpdateBotResponse$1 {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -6539,7 +6568,7 @@ interface GetBotResponse$1 {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -14646,6 +14675,10 @@ interface UpsertFileResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -14768,6 +14801,10 @@ interface ListFilesResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     }[];
     meta: {
         /**
@@ -14872,6 +14909,10 @@ interface GetFileResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -14990,6 +15031,10 @@ interface UpdateFileMetadataResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -15096,6 +15141,10 @@ interface CopyFileResponse$1 {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -15518,6 +15567,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
                 id?: string;
                 name?: string;
             };
+            indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
             id: string;
@@ -17778,6 +17828,10 @@ interface CreateEventRequestBody {
      * ID of the [User](#schema_user) to link the event to.
      */
     userId?: string;
+    /**
+     * ID of the [Workflow](#schema_workflow) to link the event to.
+     */
+    workflowId?: string;
     /**
      * ID of the [Message](#schema_message) to link the event to.
      */
@@ -17888,6 +17942,7 @@ interface ListEventsRequestQuery {
     conversationId?: string;
     userId?: string;
     messageId?: string;
+    workflowId?: string;
     status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
 }
 interface ListEventsRequestParams {
@@ -17985,6 +18040,7 @@ interface CreateMessageRequestBody {
          */
         delay?: number;
     };
+    origin?: "synthetic";
 }
 type CreateMessageInput = CreateMessageRequestBody & CreateMessageRequestHeaders & CreateMessageRequestQuery & CreateMessageRequestParams;
 interface CreateMessageResponse {
@@ -18032,6 +18088,10 @@ interface CreateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18079,6 +18139,7 @@ interface GetOrCreateMessageRequestBody {
          */
         delay?: number;
     };
+    origin?: "synthetic";
     /**
      * Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.
      */
@@ -18130,6 +18191,10 @@ interface GetOrCreateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18188,6 +18253,10 @@ interface GetMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18258,6 +18327,10 @@ interface UpdateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18317,6 +18390,10 @@ interface ListMessagesResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     }[];
     meta: {
         /**
@@ -19456,7 +19533,7 @@ interface CreateWorkflowRequestBody {
     tags?: {
         [k: string]: string;
     };
-    status: "pending" | "in_progress";
+    status: "pending" | "in_progress" | "listening";
     /**
      * Event id must be specified if the workflow is created with the status in_progress
      */
@@ -19868,7 +19945,7 @@ interface GetOrCreateWorkflowRequestBody {
     tags?: {
         [k: string]: string;
     };
-    status: "pending" | "in_progress";
+    status: "pending" | "in_progress" | "listening";
     /**
      * Event id must be specified if the workflow is created with the status in_progress
      */
@@ -22427,7 +22504,7 @@ interface CreateBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -23058,7 +23135,7 @@ interface UpdateBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -23521,7 +23598,7 @@ interface GetBotResponse {
          */
         signingSecret: string;
         /**
-         * A mapping of integrations to their configuration
+         * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
          */
         integrations: {
             [k: string]: {
@@ -31288,6 +31365,10 @@ interface UpsertFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -31410,6 +31491,10 @@ interface ListFilesResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     }[];
     meta: {
         /**
@@ -31514,6 +31599,10 @@ interface GetFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -31632,6 +31721,10 @@ interface UpdateFileMetadataResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -31738,6 +31831,10 @@ interface CopyFileResponse {
              */
             name?: string;
         };
+        /**
+         * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+         */
+        indexingStack?: "v1" | "v2";
     };
 }
 
@@ -33727,7 +33824,7 @@ interface Bot {
      */
     signingSecret: string;
     /**
-     * A mapping of integrations to their configuration
+     * A mapping of integrations to their configuration. If the `x-multiple-integrations` header is present, this object is keyed by integration aliases. Otherwise, this object is keyed by integration ids.
      */
     integrations: {
         [k: string]: {
@@ -35093,6 +35190,10 @@ interface Message {
     tags: {
         [k: string]: string;
     };
+    /**
+     * Origin of the message (`synthetic`).
+     */
+    origin?: "synthetic";
 }
 /**
  * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
@@ -35566,6 +35667,10 @@ interface File {
          */
         name?: string;
     };
+    /**
+     * Indicates the indexing stack used to index this file. Present only when file has been successfully indexed. A value of "v2" denotes the latest stack, "v1" denotes the legacy stack.
+     */
+    indexingStack?: "v1" | "v2";
 }
 
 type ClientProps$1 = {
@@ -35817,6 +35922,7 @@ declare class Client extends Client$1 implements IClient {
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
+            workflowId?: string | undefined;
             messageId?: string | undefined;
             status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
@@ -35851,6 +35957,7 @@ declare class Client extends Client$1 implements IClient {
             tags: {
                 [k: string]: string;
             };
+            origin?: "synthetic";
         }>;
         users: (props: {
             tags?: {
@@ -36121,6 +36228,7 @@ declare class Client extends Client$1 implements IClient {
                 id?: string;
                 name?: string;
             };
+            indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
             id: string;