@botpress/client 1.43.0 → 1.44.0

package/dist/index.d.ts

@@ -311,10 +311,10 @@ interface GetOrCreateConversationRequestBody$1 {
      */
     channel: string;
     /**
-     * Tags for the [Conversation](#schema_conversation)
+     * Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
@@ -322,10 +322,10 @@ interface GetOrCreateConversationRequestBody$1 {
      */
     integrationName?: string;
     /**
-     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties. Set individual properties to null or empty string to remove them.
      */
     properties?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * 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.
@@ -403,10 +403,10 @@ interface UpdateConversationRequestBody$1 {
      */
     currentTaskId?: string;
     /**
-     * Tags for the [Conversation](#schema_conversation)
+     * Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [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.
@@ -1019,10 +1019,10 @@ interface GetOrCreateMessageRequestBody$1 {
      */
     type: string;
     /**
-     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+     * Tags for the message. Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.
@@ -1170,10 +1170,10 @@ interface UpdateMessageRequestParams$1 {
 }
 interface UpdateMessageRequestBody$1 {
     /**
-     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Set to null or empty string to remove.
      */
-    tags: {
-        [k: string]: string;
+    tags?: {
+        [k: string]: string | null;
     };
     /**
      * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
@@ -1879,10 +1879,10 @@ interface GetOrCreateUserRequestParams$1 {
 }
 interface GetOrCreateUserRequestBody$1 {
     /**
-     * Tags for the [User](#schema_user)
+     * Tags for the user. Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
@@ -1898,17 +1898,17 @@ 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. Set individual properties to null or empty string to remove them.
      */
     properties?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
      * DEPRECATED - Use properties instead.
      */
     attributes?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user 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.
@@ -1974,10 +1974,10 @@ interface UpdateUserRequestParams$1 {
 }
 interface UpdateUserRequestBody$1 {
     /**
-     * Tags for the [User](#schema_user)
+     * Tags for the [User](#schema_user). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Name of the user
@@ -2709,10 +2709,10 @@ interface UpdateWorkflowRequestBody$1 {
      */
     failureReason?: string;
     /**
-     * Tags for the [Workflow](#schema_workflow)
+     * Tags for the [Workflow](#schema_workflow). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Specific user related to this workflow
@@ -6346,12 +6346,6 @@ interface UpdateBotRequestBody$1 {
             [k: string]: any;
         };
     };
-    /**
-     * Optional attributes of the [Bot](#schema_bot)
-     */
-    tags?: {
-        [k: string]: string;
-    };
     blocked?: boolean;
     /**
      * Maximum execution time (in seconds).
@@ -6361,6 +6355,12 @@ interface UpdateBotRequestBody$1 {
      * Indicates if the [Bot](#schema_bot) should be in always alive mode
      */
     alwaysAlive?: boolean;
+    /**
+     * Optional attributes of the [Bot](#schema_bot). Set to null or empty string to remove.
+     */
+    tags?: {
+        [k: string]: string | null;
+    };
     user?: {
         tags?: {
             /**
@@ -8241,6 +8241,7 @@ interface CreateWorkspaceRequestParams$1 {
 }
 interface CreateWorkspaceRequestBody$1 {
     name: string;
+    billingVersion?: "v4";
 }
 type CreateWorkspaceInput$1 = CreateWorkspaceRequestBody$1 & CreateWorkspaceRequestHeaders$1 & CreateWorkspaceRequestQuery$1 & CreateWorkspaceRequestParams$1;
 interface CreateWorkspaceResponse$1 {
@@ -15515,9 +15516,7 @@ interface GetAddonResponse$1 {
      * Addon unit price in dollars per month
      */
     price: number;
-    feature: "incoming_messages_events" | "integration_spend" | "table_rows" | "bot_count" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions" | "indexed_file_count" | "conversation_sessions";
-    increment: number;
-    increments?: {
+    increments: {
         [k: string]: number;
     };
     metadata?: {
@@ -15543,9 +15542,7 @@ interface GetAddonResponse {
      * Addon unit price in dollars per month
      */
     price: number;
-    feature: "incoming_messages_events" | "integration_spend" | "table_rows" | "bot_count" | "collaborator_count" | "file_storage" | "vector_db_storage" | "saved_versions" | "indexed_file_count" | "conversation_sessions";
-    increment: number;
-    increments?: {
+    increments: {
         [k: string]: number;
     };
     metadata?: {
@@ -19551,10 +19548,10 @@ interface GetOrCreateConversationRequestBody {
      */
     channel: string;
     /**
-     * Tags for the [Conversation](#schema_conversation)
+     * Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
@@ -19562,10 +19559,10 @@ interface GetOrCreateConversationRequestBody {
      */
     integrationName?: string;
     /**
-     * **EXPERIMENTAL** - Optional shared properties that can be accessed and modified by both the bot and any of its integrations.
+     * **EXPERIMENTAL** - Optional shared properties. Set individual properties to null or empty string to remove them.
      */
     properties?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * 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.
@@ -19643,10 +19640,10 @@ interface UpdateConversationRequestBody {
      */
     currentTaskId?: string;
     /**
-     * Tags for the [Conversation](#schema_conversation)
+     * Tags for the [Conversation](#schema_conversation). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [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.
@@ -20259,10 +20256,10 @@ interface GetOrCreateMessageRequestBody {
      */
     type: string;
     /**
-     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+     * Tags for the message. Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.
@@ -20410,10 +20407,10 @@ interface UpdateMessageRequestParams {
 }
 interface UpdateMessageRequestBody {
     /**
-     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
+     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Set to null or empty string to remove.
      */
-    tags: {
-        [k: string]: string;
+    tags?: {
+        [k: string]: string | null;
     };
     /**
      * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
@@ -21119,10 +21116,10 @@ interface GetOrCreateUserRequestParams {
 }
 interface GetOrCreateUserRequestBody {
     /**
-     * Tags for the [User](#schema_user)
+     * Tags for the user. Set to null or empty string to remove.
      */
     tags: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
@@ -21138,17 +21135,17 @@ 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. Set individual properties to null or empty string to remove them.
      */
     properties?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * @deprecated
      * DEPRECATED - Use properties instead.
      */
     attributes?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Optional list of tag names to use for strict matching when looking up existing users. If provided, all specified tags must match exactly for a user to be considered a match. For example, with an existing user 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.
@@ -21214,10 +21211,10 @@ interface UpdateUserRequestParams {
 }
 interface UpdateUserRequestBody {
     /**
-     * Tags for the [User](#schema_user)
+     * Tags for the [User](#schema_user). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Name of the user
@@ -21949,10 +21946,10 @@ interface UpdateWorkflowRequestBody {
      */
     failureReason?: string;
     /**
-     * Tags for the [Workflow](#schema_workflow)
+     * Tags for the [Workflow](#schema_workflow). Set to null or empty string to remove.
      */
     tags?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * Specific user related to this workflow
@@ -25373,12 +25370,6 @@ interface UpdateBotRequestBody {
             [k: string]: any;
         };
     };
-    /**
-     * Optional attributes of the [Bot](#schema_bot)
-     */
-    tags?: {
-        [k: string]: string;
-    };
     blocked?: boolean;
     /**
      * Maximum execution time (in seconds).
@@ -25388,6 +25379,12 @@ interface UpdateBotRequestBody {
      * Indicates if the [Bot](#schema_bot) should be in always alive mode
      */
     alwaysAlive?: boolean;
+    /**
+     * Optional attributes of the [Bot](#schema_bot). Set to null or empty string to remove.
+     */
+    tags?: {
+        [k: string]: string | null;
+    };
     user?: {
         tags?: {
             /**
@@ -27268,6 +27265,7 @@ interface CreateWorkspaceRequestParams {
 }
 interface CreateWorkspaceRequestBody {
     name: string;
+    billingVersion?: "v4";
 }
 type CreateWorkspaceInput = CreateWorkspaceRequestBody & CreateWorkspaceRequestHeaders & CreateWorkspaceRequestQuery & CreateWorkspaceRequestParams;
 interface CreateWorkspaceResponse {