@botpress/client 1.24.0 → 1.24.2

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 {
@@ -2872,8 +2877,8 @@ declare class Client$8 extends Client$9 {
             } | undefined;
             channel?: string | undefined;
             integrationName?: string | undefined;
-            sortField?: ("createdAt" | "updatedAt") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "createdAt" | "updatedAt" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             participantIds?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -2903,8 +2908,9 @@ 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;
+            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -5445,7 +5451,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 +6082,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 +6545,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]: {
@@ -14204,9 +14210,9 @@ declare class Client$6 extends Client$7 {
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
             installedByBotId?: string | undefined;
-            verificationStatus?: ("unapproved" | "pending" | "approved" | "rejected") | undefined;
-            sortBy?: ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount") | undefined;
-            direction?: ("asc" | "desc") | undefined;
+            verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
+            sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
+            direction?: "asc" | "desc" | undefined;
         }) => AsyncCollection<{
             id: string;
             name: string;
@@ -14240,8 +14246,8 @@ declare class Client$6 extends Client$7 {
             tags?: {
                 [x: string]: string;
             } | undefined;
-            sortField?: ("createdAt" | "updatedAt") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "createdAt" | "updatedAt" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -14296,11 +14302,11 @@ declare class Client$6 extends Client$7 {
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
             installedByBotId?: string | undefined;
-            verificationStatus?: ("unapproved" | "pending" | "approved" | "rejected") | undefined;
-            sortBy?: ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount") | undefined;
-            direction?: ("asc" | "desc") | undefined;
+            verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
+            sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
+            direction?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
-            visibility?: ("public" | "private") | undefined;
+            visibility?: "public" | "private" | undefined;
         }) => AsyncCollection<{
             id: string;
             name: string;
@@ -14646,6 +14652,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 +14778,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 +14886,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 +15008,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 +15118,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";
     };
 }
 
@@ -15490,8 +15516,8 @@ declare class Client$4 extends Client$5 implements IClient$2 {
     get list(): {
         files: (props: {
             tags?: any;
-            sortField?: ("key" | "size" | "createdAt" | "updatedAt" | "status") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             ids?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -15518,6 +15544,7 @@ declare class Client$4 extends Client$5 implements IClient$2 {
                 id?: string;
                 name?: string;
             };
+            indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
             id: string;
@@ -17778,6 +17805,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 +17919,7 @@ interface ListEventsRequestQuery {
     conversationId?: string;
     userId?: string;
     messageId?: string;
+    workflowId?: string;
     status?: "pending" | "ignored" | "processed" | "failed" | "scheduled";
 }
 interface ListEventsRequestParams {
@@ -22427,7 +22459,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 +23090,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 +23553,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 +31320,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 +31446,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 +31554,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 +31676,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 +31786,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 +33779,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]: {
@@ -35566,6 +35618,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 = {
@@ -35786,8 +35842,8 @@ declare class Client extends Client$1 implements IClient {
             } | undefined;
             channel?: string | undefined;
             integrationName?: string | undefined;
-            sortField?: ("createdAt" | "updatedAt") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "createdAt" | "updatedAt" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             participantIds?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -35817,8 +35873,9 @@ 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;
+            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -35904,9 +35961,9 @@ declare class Client extends Client$1 implements IClient {
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
             installedByBotId?: string | undefined;
-            verificationStatus?: ("unapproved" | "pending" | "approved" | "rejected") | undefined;
-            sortBy?: ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount") | undefined;
-            direction?: ("asc" | "desc") | undefined;
+            verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
+            sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
+            direction?: "asc" | "desc" | undefined;
         }) => AsyncCollection<{
             id: string;
             name: string;
@@ -35940,8 +35997,8 @@ declare class Client extends Client$1 implements IClient {
             tags?: {
                 [x: string]: string;
             } | undefined;
-            sortField?: ("createdAt" | "updatedAt") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "createdAt" | "updatedAt" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -35988,11 +36045,11 @@ declare class Client extends Client$1 implements IClient {
             interfaceId?: string | undefined;
             interfaceName?: string | undefined;
             installedByBotId?: string | undefined;
-            verificationStatus?: ("unapproved" | "pending" | "approved" | "rejected") | undefined;
-            sortBy?: ("popularity" | "name" | "createdAt" | "updatedAt" | "installCount") | undefined;
-            direction?: ("asc" | "desc") | undefined;
+            verificationStatus?: "unapproved" | "pending" | "approved" | "rejected" | undefined;
+            sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount" | undefined;
+            direction?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
-            visibility?: ("public" | "private") | undefined;
+            visibility?: "public" | "private" | undefined;
         }) => AsyncCollection<{
             id: string;
             name: string;
@@ -36093,8 +36150,8 @@ declare class Client extends Client$1 implements IClient {
         }>;
         files: (props: {
             tags?: any;
-            sortField?: ("key" | "size" | "createdAt" | "updatedAt" | "status") | undefined;
-            sortDirection?: ("asc" | "desc") | undefined;
+            sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status" | undefined;
+            sortDirection?: "asc" | "desc" | undefined;
             ids?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
@@ -36121,6 +36178,7 @@ declare class Client extends Client$1 implements IClient {
                 id?: string;
                 name?: string;
             };
+            indexingStack?: "v1" | "v2";
         }>;
         filePassages: (props: {
             id: string;