@botpress/client 1.40.0 → 1.41.0

package/dist/index.d.ts

@@ -96,6 +96,12 @@ interface CreateConversationRequestBody$1 {
      * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
      */
     integrationName?: string;
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
 }
 type CreateConversationInput$1 = CreateConversationRequestBody$1 & CreateConversationRequestHeaders$1 & CreateConversationRequestQuery$1 & CreateConversationRequestParams$1;
 interface CreateConversationResponse$1 {
@@ -142,6 +148,12 @@ interface CreateConversationResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -199,6 +211,12 @@ interface GetConversationResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -216,6 +234,8 @@ interface ListConversationsRequestQuery$1 {
     channel?: string;
     afterDate?: string;
     beforeDate?: string;
+    minMessageCount?: number;
+    maxMessageCount?: number;
 }
 interface ListConversationsRequestParams$1 {
 }
@@ -263,6 +283,12 @@ interface ListConversationsResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     }[];
     meta: {
         /**
@@ -294,6 +320,12 @@ interface GetOrCreateConversationRequestBody$1 {
      * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
      */
     integrationName?: string;
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
     /**
      * Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation 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.
      */
@@ -344,6 +376,12 @@ interface GetOrCreateConversationResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
     meta: {
         created: boolean;
@@ -369,6 +407,12 @@ interface UpdateConversationRequestBody$1 {
     tags?: {
         [k: string]: string;
     };
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
+     */
+    properties?: {
+        [k: string]: string | null;
+    };
 }
 type UpdateConversationInput$1 = UpdateConversationRequestBody$1 & UpdateConversationRequestHeaders$1 & UpdateConversationRequestQuery$1 & UpdateConversationRequestParams$1;
 interface UpdateConversationResponse$1 {
@@ -415,6 +459,12 @@ interface UpdateConversationResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -1295,7 +1345,7 @@ interface InitializeIncomingMessageRequestBody$1 {
          */
         pictureUrl?: string;
         /**
-         * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
          */
         properties?: {
             [k: string]: string;
@@ -1329,6 +1379,12 @@ interface InitializeIncomingMessageRequestBody$1 {
          * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
          */
         integrationName?: string;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * 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.
          */
@@ -1446,6 +1502,12 @@ interface InitializeIncomingMessageResponse$1 {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
     /**
      * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -1620,7 +1682,7 @@ interface CreateUserRequestBody$1 {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
      */
     properties?: {
         [k: string]: string;
@@ -1831,7 +1893,7 @@ interface GetOrCreateUserRequestBody$1 {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
      */
     properties?: {
         [k: string]: string;
@@ -1928,7 +1990,7 @@ interface UpdateUserRequestBody$1 {
         [k: string]: string | null;
     };
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
      */
     properties?: {
         [k: string]: string | null;
@@ -3123,6 +3185,8 @@ declare class Client$a extends Client$b {
             participantIds?: string[] | undefined;
             afterDate?: string | undefined;
             beforeDate?: string | undefined;
+            minMessageCount?: number | undefined;
+            maxMessageCount?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             currentTaskId?: string;
@@ -3135,6 +3199,9 @@ declare class Client$a extends Client$b {
                 [k: string]: string;
             };
             messageCount: number;
+            properties?: {
+                [k: string]: string;
+            };
         }>;
         participants: (props: {
             id: string;
@@ -5801,6 +5868,10 @@ interface CreateBotRequestBody$1 {
      * Type of the [Bot](#schema_bot)
      */
     type?: "studio" | "adk" | "desk";
+    /**
+     * Maximum execution time (in seconds).
+     */
+    maxExecutionTime?: number;
 }
 type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
 interface CreateBotResponse$1 {
@@ -6966,6 +7037,8 @@ interface ListBotsRequestQuery$1 {
     tags?: {
         [k: string]: string;
     };
+    integrationNames?: string[];
+    pluginNames?: string[];
     nextToken?: string;
     sortField?: "createdAt" | "updatedAt";
     sortDirection?: "asc" | "desc";
@@ -8162,7 +8235,7 @@ interface CreateWorkspaceResponse$1 {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -8216,7 +8289,7 @@ interface GetWorkspaceResponse$1 {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -8388,7 +8461,7 @@ interface UpdateWorkspaceResponse$3 {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -8445,7 +8518,7 @@ interface UpdateWorkspaceResponse$2 {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -15088,6 +15161,8 @@ declare class Client$8 extends Client$9 {
             sortField?: "createdAt" | "updatedAt" | undefined;
             sortDirection?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
+            integrationNames?: string[] | undefined;
+            pluginNames?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -15387,8 +15462,11 @@ interface GetAddonResponse$1 {
     name: string;
     description: string;
     price: number;
-    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
+    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
     increment: number;
+    increments?: {
+        [k: string]: number;
+    };
     metadata?: {
         [k: string]: string;
     };
@@ -15409,8 +15487,11 @@ interface GetAddonResponse {
     name: string;
     description: string;
     price: number;
-    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
+    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
     increment: number;
+    increments?: {
+        [k: string]: number;
+    };
     metadata?: {
         [k: string]: string;
     };
@@ -15905,7 +15986,7 @@ interface CreateCreditGrantResponse {
      * Dollar value of the credit grant (e.g. 10 = $10.00 USD)
      */
     amount: number;
-    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions";
+    feature: "human_in_the_loop" | "ratelimit" | "incoming_messages_events" | "integration_spend" | "integration_subscription" | "table_rows" | "bot_count" | "always_alive_count" | "always_alive_concurrency" | "collaborator_count" | "file_storage" | "vector_db_storage" | "indexed_file_count" | "saved_versions";
     /**
      * Start of the period (inclusive)
      */
@@ -19114,6 +19195,12 @@ interface CreateConversationRequestBody {
      * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
      */
     integrationName?: string;
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
 }
 type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
 interface CreateConversationResponse {
@@ -19160,6 +19247,12 @@ interface CreateConversationResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -19217,6 +19310,12 @@ interface GetConversationResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -19234,6 +19333,8 @@ interface ListConversationsRequestQuery {
     channel?: string;
     afterDate?: string;
     beforeDate?: string;
+    minMessageCount?: number;
+    maxMessageCount?: number;
 }
 interface ListConversationsRequestParams {
 }
@@ -19281,6 +19382,12 @@ interface ListConversationsResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     }[];
     meta: {
         /**
@@ -19312,6 +19419,12 @@ interface GetOrCreateConversationRequestBody {
      * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
      */
     integrationName?: string;
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
     /**
      * Optional list of tag names to use for strict matching when looking up existing conversations. If provided, all specified tags must match exactly for a conversation to be considered a match. For example, with an existing conversation 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.
      */
@@ -19362,6 +19475,12 @@ interface GetOrCreateConversationResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
     meta: {
         created: boolean;
@@ -19387,6 +19506,12 @@ interface UpdateConversationRequestBody {
     tags?: {
         [k: string]: string;
     };
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
+     */
+    properties?: {
+        [k: string]: string | null;
+    };
 }
 type UpdateConversationInput = UpdateConversationRequestBody & UpdateConversationRequestHeaders & UpdateConversationRequestQuery & UpdateConversationRequestParams;
 interface UpdateConversationResponse {
@@ -19433,6 +19558,12 @@ interface UpdateConversationResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -20313,7 +20444,7 @@ interface InitializeIncomingMessageRequestBody {
          */
         pictureUrl?: string;
         /**
-         * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
          */
         properties?: {
             [k: string]: string;
@@ -20347,6 +20478,12 @@ interface InitializeIncomingMessageRequestBody {
          * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
          */
         integrationName?: string;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
         /**
          * 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.
          */
@@ -20464,6 +20601,12 @@ interface InitializeIncomingMessageResponse {
          * Number of messages in the conversation
          */
         messageCount: number;
+        /**
+         * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+         */
+        properties?: {
+            [k: string]: string;
+        };
     };
     /**
      * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
@@ -20638,7 +20781,7 @@ interface CreateUserRequestBody {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
      */
     properties?: {
         [k: string]: string;
@@ -20849,7 +20992,7 @@ interface GetOrCreateUserRequestBody {
      */
     pictureUrl?: string;
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
      */
     properties?: {
         [k: string]: string;
@@ -20946,7 +21089,7 @@ interface UpdateUserRequestBody {
         [k: string]: string | null;
     };
     /**
-     * EXPERIMENTAL - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations. Set individual properties to null to remove them.
      */
     properties?: {
         [k: string]: string | null;
@@ -24616,6 +24759,10 @@ interface CreateBotRequestBody {
      * Type of the [Bot](#schema_bot)
      */
     type?: "studio" | "adk" | "desk";
+    /**
+     * Maximum execution time (in seconds).
+     */
+    maxExecutionTime?: number;
 }
 type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
 interface CreateBotResponse {
@@ -25781,6 +25928,8 @@ interface ListBotsRequestQuery {
     tags?: {
         [k: string]: string;
     };
+    integrationNames?: string[];
+    pluginNames?: string[];
     nextToken?: string;
     sortField?: "createdAt" | "updatedAt";
     sortDirection?: "asc" | "desc";
@@ -26977,7 +27126,7 @@ interface CreateWorkspaceResponse {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -27031,7 +27180,7 @@ interface GetWorkspaceResponse {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -27203,7 +27352,7 @@ interface UpdateWorkspaceResponse$1 {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -27260,7 +27409,7 @@ interface UpdateWorkspaceResponse {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -37692,7 +37841,7 @@ interface Workspace {
     updatedAt: string;
     botCount: number;
     billingVersion: "v1" | "v2" | "v3" | "v4";
-    plan: "community" | "team" | "enterprise" | "plus";
+    plan: "community" | "team" | "enterprise" | "plus" | "managed";
     blocked: boolean;
     spendingLimit: number;
     about?: string;
@@ -37877,6 +38026,12 @@ interface Conversation {
      * Number of messages in the conversation
      */
     messageCount: number;
+    /**
+     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     */
+    properties?: {
+        [k: string]: string;
+    };
 }
 /**
  * The event object represents an action or an occurrence.
@@ -38622,6 +38777,8 @@ declare class Client extends Client$1 implements IClient {
             participantIds?: string[] | undefined;
             afterDate?: string | undefined;
             beforeDate?: string | undefined;
+            minMessageCount?: number | undefined;
+            maxMessageCount?: number | undefined;
         }) => AsyncCollection<{
             id: string;
             currentTaskId?: string;
@@ -38634,6 +38791,9 @@ declare class Client extends Client$1 implements IClient {
                 [k: string]: string;
             };
             messageCount: number;
+            properties?: {
+                [k: string]: string;
+            };
         }>;
         participants: (props: {
             id: string;
@@ -38773,6 +38933,8 @@ declare class Client extends Client$1 implements IClient {
             sortField?: "createdAt" | "updatedAt" | undefined;
             sortDirection?: "asc" | "desc" | undefined;
             dev?: boolean | undefined;
+            integrationNames?: string[] | undefined;
+            pluginNames?: string[] | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;