@botpress/client 1.21.0 → 1.22.2

package/dist/index.d.ts

@@ -2872,8 +2872,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;
@@ -2904,7 +2904,7 @@ declare class Client$8 extends Client$9 {
             userId?: string | undefined;
             conversationId?: string | undefined;
             messageId?: string | undefined;
-            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
+            status?: ("pending" | "ignored" | "processed" | "failed" | "scheduled") | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -6030,10 +6030,6 @@ interface UpdateBotRequestBody$1 {
             };
         } | null;
     };
-    /**
-     * If true, plugins will be merged into the bot and entity references will be resolved. If you are uncertain about this field, you should probably set it to true
-     */
-    shouldMergePlugins?: boolean;
     subscriptions?: {
         events: {
             [k: string]: {} | null;
@@ -6055,6 +6051,10 @@ interface UpdateBotRequestBody$1 {
         name: string;
     }[];
     layers?: string[];
+    /**
+     * UNUSED. Please ignore this field. It will be removed in the near future.
+     */
+    shouldMergePlugins?: boolean;
 }
 type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
 interface UpdateBotResponse$1 {
@@ -12411,18 +12411,6 @@ interface CreatePluginRequestBody$1 {
             };
         };
     };
-    dependencies?: {
-        interfaces?: {
-            [k: string]: {
-                id: string;
-            };
-        };
-        integrations?: {
-            [k: string]: {
-                id: string;
-            };
-        };
-    };
     /**
      * Optional attributes
      */
@@ -12459,6 +12447,46 @@ interface CreatePluginRequestBody$1 {
      * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    dependencies?: {
+        /**
+         * Mapping of interface aliases to interface references
+         */
+        interfaces?: {
+            [k: string]: {
+                /**
+                 * Id of the interface. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the interface
+                 */
+                name?: string;
+                /**
+                 * Version of the interface. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            };
+        };
+        /**
+         * Mapping of integration aliases to integration references
+         */
+        integrations?: {
+            [k: string]: {
+                /**
+                 * Id of the integration. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the integration
+                 */
+                name?: string;
+                /**
+                 * Version of the integration. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            };
+        };
+    };
 }
 type CreatePluginInput$1 = CreatePluginRequestBody$1 & CreatePluginRequestHeaders$1 & CreatePluginRequestQuery$1 & CreatePluginRequestParams$1;
 interface CreatePluginResponse$1 {
@@ -13435,18 +13463,6 @@ interface UpdatePluginRequestBody$1 {
             } | null;
         };
     };
-    dependencies?: {
-        interfaces?: {
-            [k: string]: {
-                id: string;
-            } | null;
-        };
-        integrations?: {
-            [k: string]: {
-                id: string;
-            } | null;
-        };
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -13483,6 +13499,46 @@ interface UpdatePluginRequestBody$1 {
      * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    dependencies?: {
+        /**
+         * Mapping of interface aliases to interface references
+         */
+        interfaces?: {
+            [k: string]: {
+                /**
+                 * Id of the interface. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the interface
+                 */
+                name?: string;
+                /**
+                 * Version of the interface. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            } | null;
+        };
+        /**
+         * Mapping of integration aliases to integration references
+         */
+        integrations?: {
+            [k: string]: {
+                /**
+                 * Id of the integration. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the integration
+                 */
+                name?: string;
+                /**
+                 * Version of the integration. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            } | null;
+        };
+    };
 }
 type UpdatePluginInput$1 = UpdatePluginRequestBody$1 & UpdatePluginRequestHeaders$1 & UpdatePluginRequestQuery$1 & UpdatePluginRequestParams$1;
 interface UpdatePluginResponse$1 {
@@ -14148,9 +14204,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;
@@ -14184,8 +14240,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;
@@ -14240,11 +14296,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;
@@ -15278,6 +15334,9 @@ interface CreateKnowledgeBaseRequestBody$1 {
      * Name of the knowledge base.
      */
     name: string;
+    tags?: {
+        [k: string]: string;
+    };
 }
 type CreateKnowledgeBaseInput$1 = CreateKnowledgeBaseRequestBody$1 & CreateKnowledgeBaseRequestHeaders$1 & CreateKnowledgeBaseRequestQuery$1 & CreateKnowledgeBaseRequestParams$1;
 interface CreateKnowledgeBaseResponse$1 {
@@ -15290,6 +15349,9 @@ interface CreateKnowledgeBaseResponse$1 {
          * Name of the knowledge base.
          */
         name: string;
+        tags: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -15318,6 +15380,12 @@ interface UpdateKnowledgeBaseRequestBody$1 {
      * New name of the knowledge base.
      */
     name: string;
+    /**
+     * The knowledge base tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
+     */
+    tags?: {
+        [k: string]: string | null;
+    };
 }
 type UpdateKnowledgeBaseInput$1 = UpdateKnowledgeBaseRequestBody$1 & UpdateKnowledgeBaseRequestHeaders$1 & UpdateKnowledgeBaseRequestQuery$1 & UpdateKnowledgeBaseRequestParams$1;
 interface UpdateKnowledgeBaseResponse$1 {
@@ -15330,6 +15398,9 @@ interface UpdateKnowledgeBaseResponse$1 {
          * Name of the knowledge base.
          */
         name: string;
+        tags: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -15337,6 +15408,7 @@ interface ListKnowledgeBasesRequestHeaders$1 {
 }
 interface ListKnowledgeBasesRequestQuery$1 {
     nextToken?: string;
+    tags?: any;
 }
 interface ListKnowledgeBasesRequestParams$1 {
 }
@@ -15357,6 +15429,9 @@ interface ListKnowledgeBasesResponse$1 {
          * Knowledge base creation timestamp in ISO 8601 format
          */
         createdAt: string;
+        tags: {
+            [k: string]: string;
+        };
     }[];
     meta: {
         /**
@@ -15415,8 +15490,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;
@@ -15458,6 +15533,10 @@ declare class Client$4 extends Client$5 implements IClient$2 {
                 sourceUrl?: string;
             };
         }>;
+        fileTags: (props: {}) => AsyncCollection<string>;
+        fileTagValues: (props: {
+            tag: string;
+        }) => AsyncCollection<string>;
     };
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
@@ -22923,10 +23002,6 @@ interface UpdateBotRequestBody {
             };
         } | null;
     };
-    /**
-     * If true, plugins will be merged into the bot and entity references will be resolved. If you are uncertain about this field, you should probably set it to true
-     */
-    shouldMergePlugins?: boolean;
     subscriptions?: {
         events: {
             [k: string]: {} | null;
@@ -22948,6 +23023,10 @@ interface UpdateBotRequestBody {
         name: string;
     }[];
     layers?: string[];
+    /**
+     * UNUSED. Please ignore this field. It will be removed in the near future.
+     */
+    shouldMergePlugins?: boolean;
 }
 type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
 interface UpdateBotResponse {
@@ -29305,18 +29384,6 @@ interface CreatePluginRequestBody {
             };
         };
     };
-    dependencies?: {
-        interfaces?: {
-            [k: string]: {
-                id: string;
-            };
-        };
-        integrations?: {
-            [k: string]: {
-                id: string;
-            };
-        };
-    };
     /**
      * Optional attributes
      */
@@ -29353,6 +29420,46 @@ interface CreatePluginRequestBody {
      * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    dependencies?: {
+        /**
+         * Mapping of interface aliases to interface references
+         */
+        interfaces?: {
+            [k: string]: {
+                /**
+                 * Id of the interface. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the interface
+                 */
+                name?: string;
+                /**
+                 * Version of the interface. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            };
+        };
+        /**
+         * Mapping of integration aliases to integration references
+         */
+        integrations?: {
+            [k: string]: {
+                /**
+                 * Id of the integration. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the integration
+                 */
+                name?: string;
+                /**
+                 * Version of the integration. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            };
+        };
+    };
 }
 type CreatePluginInput = CreatePluginRequestBody & CreatePluginRequestHeaders & CreatePluginRequestQuery & CreatePluginRequestParams;
 interface CreatePluginResponse {
@@ -30329,18 +30436,6 @@ interface UpdatePluginRequestBody {
             } | null;
         };
     };
-    dependencies?: {
-        interfaces?: {
-            [k: string]: {
-                id: string;
-            } | null;
-        };
-        integrations?: {
-            [k: string]: {
-                id: string;
-            } | null;
-        };
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -30377,6 +30472,46 @@ interface UpdatePluginRequestBody {
      * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
      */
     public?: boolean;
+    dependencies?: {
+        /**
+         * Mapping of interface aliases to interface references
+         */
+        interfaces?: {
+            [k: string]: {
+                /**
+                 * Id of the interface. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the interface
+                 */
+                name?: string;
+                /**
+                 * Version of the interface. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            } | null;
+        };
+        /**
+         * Mapping of integration aliases to integration references
+         */
+        integrations?: {
+            [k: string]: {
+                /**
+                 * Id of the integration. If provided, "name" and "version" are ignored
+                 */
+                id?: string;
+                /**
+                 * Name of the integration
+                 */
+                name?: string;
+                /**
+                 * Version of the integration. Accepts semver versions and version ranges
+                 */
+                version?: string;
+            } | null;
+        };
+    };
 }
 type UpdatePluginInput = UpdatePluginRequestBody & UpdatePluginRequestHeaders & UpdatePluginRequestQuery & UpdatePluginRequestParams;
 interface UpdatePluginResponse {
@@ -31831,6 +31966,9 @@ interface CreateKnowledgeBaseRequestBody {
      * Name of the knowledge base.
      */
     name: string;
+    tags?: {
+        [k: string]: string;
+    };
 }
 type CreateKnowledgeBaseInput = CreateKnowledgeBaseRequestBody & CreateKnowledgeBaseRequestHeaders & CreateKnowledgeBaseRequestQuery & CreateKnowledgeBaseRequestParams;
 interface CreateKnowledgeBaseResponse {
@@ -31843,6 +31981,9 @@ interface CreateKnowledgeBaseResponse {
          * Name of the knowledge base.
          */
         name: string;
+        tags: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -31871,6 +32012,12 @@ interface UpdateKnowledgeBaseRequestBody {
      * New name of the knowledge base.
      */
     name: string;
+    /**
+     * The knowledge base tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
+     */
+    tags?: {
+        [k: string]: string | null;
+    };
 }
 type UpdateKnowledgeBaseInput = UpdateKnowledgeBaseRequestBody & UpdateKnowledgeBaseRequestHeaders & UpdateKnowledgeBaseRequestQuery & UpdateKnowledgeBaseRequestParams;
 interface UpdateKnowledgeBaseResponse {
@@ -31883,6 +32030,9 @@ interface UpdateKnowledgeBaseResponse {
          * Name of the knowledge base.
          */
         name: string;
+        tags: {
+            [k: string]: string;
+        };
     };
 }
 
@@ -31890,6 +32040,7 @@ interface ListKnowledgeBasesRequestHeaders {
 }
 interface ListKnowledgeBasesRequestQuery {
     nextToken?: string;
+    tags?: any;
 }
 interface ListKnowledgeBasesRequestParams {
 }
@@ -31910,6 +32061,9 @@ interface ListKnowledgeBasesResponse {
          * Knowledge base creation timestamp in ISO 8601 format
          */
         createdAt: string;
+        tags: {
+            [k: string]: string;
+        };
     }[];
     meta: {
         /**
@@ -35622,8 +35776,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;
@@ -35654,7 +35808,7 @@ declare class Client extends Client$1 implements IClient {
             userId?: string | undefined;
             conversationId?: string | undefined;
             messageId?: string | undefined;
-            status?: "pending" | "ignored" | "processed" | "failed" | "scheduled" | undefined;
+            status?: ("pending" | "ignored" | "processed" | "failed" | "scheduled") | undefined;
         }) => AsyncCollection<{
             id: string;
             createdAt: string;
@@ -35740,9 +35894,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;
@@ -35776,8 +35930,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;
@@ -35824,11 +35978,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;
@@ -35929,8 +36083,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;
@@ -35972,6 +36126,10 @@ declare class Client extends Client$1 implements IClient {
                 sourceUrl?: string;
             };
         }>;
+        fileTags: (props: {}) => AsyncCollection<string>;
+        fileTagValues: (props: {
+            tag: string;
+        }) => AsyncCollection<string>;
         usageActivity: (props: {
             type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
             id: string;