@botpress/client 1.24.2 → 1.26.0

package/dist/index.d.ts

@@ -12,6 +12,7 @@ type ClientConfig = {
     headers: Headers;
     withCredentials: boolean;
     timeout: number;
+    debug: boolean;
 };
 
 type CommonClientProps = {
@@ -19,6 +20,7 @@ type CommonClientProps = {
     timeout?: number;
     headers?: Headers;
     retry?: RetryConfig;
+    debug?: boolean;
 };
 type Cast<T, U> = T extends U ? T : U;
 type AsyncFunc = (...args: any[]) => Promise<any>;
@@ -800,6 +802,7 @@ interface CreateMessageRequestBody$1 {
          */
         delay?: number;
     };
+    origin?: "synthetic";
 }
 type CreateMessageInput$1 = CreateMessageRequestBody$1 & CreateMessageRequestHeaders$1 & CreateMessageRequestQuery$1 & CreateMessageRequestParams$1;
 interface CreateMessageResponse$1 {
@@ -847,6 +850,10 @@ interface CreateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -894,6 +901,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.
      */
@@ -945,6 +953,10 @@ interface GetOrCreateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -1003,6 +1015,10 @@ interface GetMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -1073,6 +1089,10 @@ interface UpdateMessageResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -1132,6 +1152,10 @@ interface ListMessagesResponse$1 {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     }[];
     meta: {
         /**
@@ -2271,7 +2295,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
      */
@@ -2683,7 +2707,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
      */
@@ -2866,6 +2890,7 @@ type ClientProps$8 = CommonClientProps & {
     token: string;
     botId: string;
     integrationId?: string;
+    integrationAlias?: string;
 };
 declare class Client$8 extends Client$9 {
     readonly config: Readonly<ClientConfig>;
@@ -2905,12 +2930,12 @@ declare class Client$8 extends Client$9 {
             pictureUrl?: string;
         }>;
         events: (props: {
+            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
             workflowId?: string | undefined;
             messageId?: string | undefined;
-            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -2943,6 +2968,7 @@ declare class Client$8 extends Client$9 {
             tags: {
                 [k: string]: string;
             };
+            origin?: "synthetic";
         }>;
         users: (props: {
             tags?: {
@@ -2960,13 +2986,13 @@ declare class Client$8 extends Client$9 {
             pictureUrl?: string;
         }>;
         tasks: (props: {
+            status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
             tags?: {
                 [x: string]: string;
             } | undefined;
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
-            status?: ("pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[] | undefined;
             parentTaskId?: string | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -15509,6 +15535,7 @@ type ClientProps$4 = CommonClientProps & {
     token: string;
     botId: string;
     integrationId?: string;
+    integrationAlias?: string;
 };
 declare class Client$4 extends Client$5 implements IClient$2 {
     readonly config: Readonly<ClientConfig>;
@@ -17263,6 +17290,7 @@ type ClientProps$2 = CommonClientProps & {
     token: string;
     botId: string;
     integrationId?: string;
+    integrationAlias?: string;
 };
 declare class Client$2 extends Client$3 {
     readonly config: Readonly<ClientConfig>;
@@ -18017,6 +18045,7 @@ interface CreateMessageRequestBody {
          */
         delay?: number;
     };
+    origin?: "synthetic";
 }
 type CreateMessageInput = CreateMessageRequestBody & CreateMessageRequestHeaders & CreateMessageRequestQuery & CreateMessageRequestParams;
 interface CreateMessageResponse {
@@ -18064,6 +18093,10 @@ interface CreateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18111,6 +18144,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.
      */
@@ -18162,6 +18196,10 @@ interface GetOrCreateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18220,6 +18258,10 @@ interface GetMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18290,6 +18332,10 @@ interface UpdateMessageResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     };
 }
 
@@ -18349,6 +18395,10 @@ interface ListMessagesResponse {
         tags: {
             [k: string]: string;
         };
+        /**
+         * Origin of the message (`synthetic`).
+         */
+        origin?: "synthetic";
     }[];
     meta: {
         /**
@@ -19488,7 +19538,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
      */
@@ -19900,7 +19950,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
      */
@@ -35145,6 +35195,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.
@@ -35828,6 +35882,7 @@ type ClientInputs = Inputs<IClient>;
 type ClientOutputs = Outputs<IClient>;
 type ClientProps = CommonClientProps & {
     integrationId?: string;
+    integrationAlias?: string;
     workspaceId?: string;
     botId?: string;
     token?: string;
@@ -35870,12 +35925,12 @@ declare class Client extends Client$1 implements IClient {
             pictureUrl?: string;
         }>;
         events: (props: {
+            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
             workflowId?: string | undefined;
             messageId?: string | undefined;
-            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -35908,6 +35963,7 @@ declare class Client extends Client$1 implements IClient {
             tags: {
                 [k: string]: string;
             };
+            origin?: "synthetic";
         }>;
         users: (props: {
             tags?: {
@@ -35925,13 +35981,13 @@ declare class Client extends Client$1 implements IClient {
             pictureUrl?: string;
         }>;
         tasks: (props: {
+            status?: ("timeout" | "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "cancelled")[] | undefined;
             tags?: {
                 [x: string]: string;
             } | undefined;
             type?: string | undefined;
             userId?: string | undefined;
             conversationId?: string | undefined;
-            status?: ("pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled")[] | undefined;
             parentTaskId?: string | undefined;
         }) => AsyncCollection<{
             id: string;