@botpress/client 1.15.0 → 1.15.2

package/dist/index.d.ts

@@ -1389,7 +1389,7 @@ interface UpdateUserRequestBody$1 {
     /**
      * Name of the user
      */
-    name?: string;
+    name?: string | null;
     /**
      * URI of the user picture
      */
@@ -3070,6 +3070,18 @@ interface UpdateAccountResponse$1 {
     };
 }
 
+interface DeleteAccountRequestHeaders$1 {
+}
+interface DeleteAccountRequestQuery$1 {
+}
+interface DeleteAccountRequestParams$1 {
+}
+interface DeleteAccountRequestBody$1 {
+}
+type DeleteAccountInput$1 = DeleteAccountRequestBody$1 & DeleteAccountRequestHeaders$1 & DeleteAccountRequestQuery$1 & DeleteAccountRequestParams$1;
+interface DeleteAccountResponse$1 {
+}
+
 interface ListPersonalAccessTokensRequestHeaders$1 {
 }
 interface ListPersonalAccessTokensRequestQuery$1 {
@@ -5263,6 +5275,14 @@ interface CreateBotResponse$1 {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -5735,8 +5755,20 @@ interface UpdateBotRequestBody$1 {
             configuration?: {
                 [k: string]: any;
             };
+            /**
+             * A mapping of plugin interface aliases to their backing integrations
+             */
+            interfaces?: {
+                [k: string]: {
+                    integrationId: string;
+                };
+            };
         } | 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;
@@ -5856,6 +5888,14 @@ interface UpdateBotResponse$1 {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -6300,6 +6340,14 @@ interface GetBotResponse$1 {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -6651,7 +6699,7 @@ interface GetBotAnalyticsResponse$1 {
          */
         startDateTimeUtc: string;
         /**
-         * ISO 8601 date string of the end (exclusive) of the period
+         * ISO 8601 date string of the end (inclusive) of the period
          */
         endDateTimeUtc: string;
         returningUsers: number;
@@ -6707,6 +6755,50 @@ interface GetBotAnalyticsResponse$1 {
     }[];
 }
 
+interface ListActionRunsRequestHeaders$1 {
+}
+interface ListActionRunsRequestQuery$1 {
+    integrationName: string;
+    timestampFrom?: string;
+    timestampUntil?: string;
+    nextToken?: string;
+}
+interface ListActionRunsRequestParams$1 {
+    id: string;
+}
+interface ListActionRunsRequestBody$1 {
+}
+type ListActionRunsInput$1 = ListActionRunsRequestBody$1 & ListActionRunsRequestHeaders$1 & ListActionRunsRequestQuery$1 & ListActionRunsRequestParams$1;
+interface ListActionRunsResponse$1 {
+    data: {
+        /**
+         * ISO 8601 timestamp of the action run
+         */
+        timestamp: string;
+        integrationName?: string;
+        actionType: string;
+        /**
+         * Input of the action
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Output of the action
+         */
+        output: {
+            [k: string]: any;
+        } | null;
+        status: "SUCCESS" | "FAILURE";
+        durationMs: number;
+        cached: boolean;
+        errorMessage?: string | null;
+    }[];
+    meta: {
+        nextToken?: string;
+    };
+}
+
 interface GetBotIssueRequestHeaders$1 {
 }
 interface GetBotIssueRequestQuery$1 {
@@ -8993,10 +9085,6 @@ interface UpdateIntegrationRequestBody$1 {
             };
         } | null;
     };
-    sandbox?: {
-        identifierExtractScript?: string | null;
-        messageExtractScript?: string | null;
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -9696,10 +9784,6 @@ interface ValidateIntegrationUpdateRequestBody$1 {
             };
         } | null;
     };
-    sandbox?: {
-        identifierExtractScript?: string | null;
-        messageExtractScript?: string | null;
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -13143,8 +13227,8 @@ interface ListUsageActivityDailyResponse$1 {
         value: number;
         metadata?: {
             botId: string;
-            type: "IntegrationAction" | "FileIndexing";
-            subtype: string;
+            type: "IntegrationAction" | "FileIndexing" | "BingSearch" | "WebSearch";
+            subtype?: string;
             source?: string;
         };
     }[];
@@ -13227,6 +13311,7 @@ declare class Client$7 {
     readonly runVrl: (input: RunVrlInput$1) => Promise<RunVrlResponse$1>;
     readonly getAccount: (input: GetAccountInput$1) => Promise<GetAccountResponse$1>;
     readonly updateAccount: (input: UpdateAccountInput$1) => Promise<UpdateAccountResponse$1>;
+    readonly deleteAccount: (input: DeleteAccountInput$1) => Promise<DeleteAccountResponse$1>;
     readonly listPersonalAccessTokens: (input: ListPersonalAccessTokensInput$1) => Promise<ListPersonalAccessTokensResponse$1>;
     readonly createPersonalAccessToken: (input: CreatePersonalAccessTokenInput$1) => Promise<CreatePersonalAccessTokenResponse$1>;
     readonly deletePersonalAccessToken: (input: DeletePersonalAccessTokenInput$1) => Promise<DeletePersonalAccessTokenResponse$1>;
@@ -13251,6 +13336,7 @@ declare class Client$7 {
     readonly getBotLogs: (input: GetBotLogsInput$1) => Promise<GetBotLogsResponse$1>;
     readonly getBotWebchat: (input: GetBotWebchatInput$1) => Promise<GetBotWebchatResponse$1>;
     readonly getBotAnalytics: (input: GetBotAnalyticsInput$1) => Promise<GetBotAnalyticsResponse$1>;
+    readonly listActionRuns: (input: ListActionRunsInput$1) => Promise<ListActionRunsResponse$1>;
     readonly getBotIssue: (input: GetBotIssueInput$1) => Promise<GetBotIssueResponse$1>;
     readonly listBotIssues: (input: ListBotIssuesInput$1) => Promise<ListBotIssuesResponse$1>;
     readonly deleteBotIssue: (input: DeleteBotIssueInput$1) => Promise<DeleteBotIssueResponse$1>;
@@ -13517,8 +13603,8 @@ declare class Client$6 extends Client$7 {
             value: number;
             metadata?: {
                 botId: string;
-                type: "IntegrationAction" | "FileIndexing";
-                subtype: string;
+                type: "IntegrationAction" | "FileIndexing" | "BingSearch" | "WebSearch";
+                subtype?: string;
                 source?: string;
             };
         }>;
@@ -13567,7 +13653,7 @@ interface UpsertFileRequestBody$1 {
      */
     size: number;
     /**
-     * Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace.
+     * Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Files larger than 95 MB cannot be indexed. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace.
      */
     index?: boolean;
     indexing?: {
@@ -13774,6 +13860,17 @@ interface UpsertFileResponse$1 {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -13885,6 +13982,17 @@ interface ListFilesResponse$1 {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     }[];
     meta: {
         /**
@@ -13978,6 +14086,17 @@ interface GetFileResponse$1 {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -14085,6 +14204,17 @@ interface UpdateFileMetadataResponse$1 {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -14180,6 +14310,17 @@ interface CopyFileResponse$1 {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -14571,6 +14712,11 @@ declare class Client$4 extends Client$5 implements IClient$2 {
             status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
             failedStatusReason?: string;
             expiresAt?: string;
+            owner: {
+                type: "bot" | "integration" | "user";
+                id?: string;
+                name?: string;
+            };
         }>;
         filePassages: (props: {
             id: string;
@@ -17618,7 +17764,7 @@ interface UpdateUserRequestBody {
     /**
      * Name of the user
      */
-    name?: string;
+    name?: string | null;
     /**
      * URI of the user picture
      */
@@ -19091,6 +19237,18 @@ interface UpdateAccountResponse {
     };
 }
 
+interface DeleteAccountRequestHeaders {
+}
+interface DeleteAccountRequestQuery {
+}
+interface DeleteAccountRequestParams {
+}
+interface DeleteAccountRequestBody {
+}
+type DeleteAccountInput = DeleteAccountRequestBody & DeleteAccountRequestHeaders & DeleteAccountRequestQuery & DeleteAccountRequestParams;
+interface DeleteAccountResponse {
+}
+
 interface ListPersonalAccessTokensRequestHeaders {
 }
 interface ListPersonalAccessTokensRequestQuery {
@@ -21284,6 +21442,14 @@ interface CreateBotResponse {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -21756,8 +21922,20 @@ interface UpdateBotRequestBody {
             configuration?: {
                 [k: string]: any;
             };
+            /**
+             * A mapping of plugin interface aliases to their backing integrations
+             */
+            interfaces?: {
+                [k: string]: {
+                    integrationId: string;
+                };
+            };
         } | 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;
@@ -21877,6 +22055,14 @@ interface UpdateBotResponse {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -22321,6 +22507,14 @@ interface GetBotResponse {
                 configuration: {
                     [k: string]: any;
                 };
+                /**
+                 * A mapping of plugin interface aliases to their backing integrations
+                 */
+                interfaces?: {
+                    [k: string]: {
+                        integrationId: string;
+                    };
+                };
                 /**
                  * ID of the [Plugin](#schema_plugin)
                  */
@@ -22672,7 +22866,7 @@ interface GetBotAnalyticsResponse {
          */
         startDateTimeUtc: string;
         /**
-         * ISO 8601 date string of the end (exclusive) of the period
+         * ISO 8601 date string of the end (inclusive) of the period
          */
         endDateTimeUtc: string;
         returningUsers: number;
@@ -22728,6 +22922,50 @@ interface GetBotAnalyticsResponse {
     }[];
 }
 
+interface ListActionRunsRequestHeaders {
+}
+interface ListActionRunsRequestQuery {
+    integrationName: string;
+    timestampFrom?: string;
+    timestampUntil?: string;
+    nextToken?: string;
+}
+interface ListActionRunsRequestParams {
+    id: string;
+}
+interface ListActionRunsRequestBody {
+}
+type ListActionRunsInput = ListActionRunsRequestBody & ListActionRunsRequestHeaders & ListActionRunsRequestQuery & ListActionRunsRequestParams;
+interface ListActionRunsResponse {
+    data: {
+        /**
+         * ISO 8601 timestamp of the action run
+         */
+        timestamp: string;
+        integrationName?: string;
+        actionType: string;
+        /**
+         * Input of the action
+         */
+        input: {
+            [k: string]: any;
+        };
+        /**
+         * Output of the action
+         */
+        output: {
+            [k: string]: any;
+        } | null;
+        status: "SUCCESS" | "FAILURE";
+        durationMs: number;
+        cached: boolean;
+        errorMessage?: string | null;
+    }[];
+    meta: {
+        nextToken?: string;
+    };
+}
+
 interface GetBotIssueRequestHeaders {
 }
 interface GetBotIssueRequestQuery {
@@ -25015,10 +25253,6 @@ interface UpdateIntegrationRequestBody {
             };
         } | null;
     };
-    sandbox?: {
-        identifierExtractScript?: string | null;
-        messageExtractScript?: string | null;
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -25718,10 +25952,6 @@ interface ValidateIntegrationUpdateRequestBody {
             };
         } | null;
     };
-    sandbox?: {
-        identifierExtractScript?: string | null;
-        messageExtractScript?: string | null;
-    };
     /**
      * Optional attributes. Set attributes to null to remove them
      */
@@ -29165,8 +29395,8 @@ interface ListUsageActivityDailyResponse {
         value: number;
         metadata?: {
             botId: string;
-            type: "IntegrationAction" | "FileIndexing";
-            subtype: string;
+            type: "IntegrationAction" | "FileIndexing" | "BingSearch" | "WebSearch";
+            subtype?: string;
             source?: string;
         };
     }[];
@@ -29260,7 +29490,7 @@ interface UpsertFileRequestBody {
      */
     size: number;
     /**
-     * Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace.
+     * Set to a value of 'true' to index the file in vector storage. Only certain file formats are currently supported for indexing. Files larger than 95 MB cannot be indexed. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace.
      */
     index?: boolean;
     indexing?: {
@@ -29467,6 +29697,17 @@ interface UpsertFileResponse {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
         /**
          * URL to upload the file content. File content needs to be sent to this URL via a PUT request.
          */
@@ -29578,6 +29819,17 @@ interface ListFilesResponse {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     }[];
     meta: {
         /**
@@ -29671,6 +29923,17 @@ interface GetFileResponse {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -29778,6 +30041,17 @@ interface UpdateFileMetadataResponse {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -29873,6 +30147,17 @@ interface CopyFileResponse {
          * File expiry timestamp in ISO 8601 format
          */
         expiresAt?: string;
+        owner: {
+            type: "bot" | "integration" | "user";
+            /**
+             * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+             */
+            id?: string;
+            /**
+             * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+             */
+            name?: string;
+        };
     };
 }
 
@@ -31913,6 +32198,14 @@ interface Bot {
             configuration: {
                 [k: string]: any;
             };
+            /**
+             * A mapping of plugin interface aliases to their backing integrations
+             */
+            interfaces?: {
+                [k: string]: {
+                    integrationId: string;
+                };
+            };
             /**
              * ID of the [Plugin](#schema_plugin)
              */
@@ -33637,6 +33930,17 @@ interface File {
      * File expiry timestamp in ISO 8601 format
      */
     expiresAt?: string;
+    owner: {
+        type: "bot" | "integration" | "user";
+        /**
+         * This field is present if `type` is "user" or "bot". If `type` is "user", this is the user ID. If `type` is "bot", this is the bot ID.
+         */
+        id?: string;
+        /**
+         * This field is present if the `type` is "integration". If `type` is "integration", this is the integration name.
+         */
+        name?: string;
+    };
 }
 
 type ClientProps$1 = {
@@ -33695,6 +33999,7 @@ declare class Client$1 {
     readonly runVrl: (input: RunVrlInput) => Promise<RunVrlResponse>;
     readonly getAccount: (input: GetAccountInput) => Promise<GetAccountResponse>;
     readonly updateAccount: (input: UpdateAccountInput) => Promise<UpdateAccountResponse>;
+    readonly deleteAccount: (input: DeleteAccountInput) => Promise<DeleteAccountResponse>;
     readonly listPersonalAccessTokens: (input: ListPersonalAccessTokensInput) => Promise<ListPersonalAccessTokensResponse>;
     readonly createPersonalAccessToken: (input: CreatePersonalAccessTokenInput) => Promise<CreatePersonalAccessTokenResponse>;
     readonly deletePersonalAccessToken: (input: DeletePersonalAccessTokenInput) => Promise<DeletePersonalAccessTokenResponse>;
@@ -33719,6 +34024,7 @@ declare class Client$1 {
     readonly getBotLogs: (input: GetBotLogsInput) => Promise<GetBotLogsResponse>;
     readonly getBotWebchat: (input: GetBotWebchatInput) => Promise<GetBotWebchatResponse>;
     readonly getBotAnalytics: (input: GetBotAnalyticsInput) => Promise<GetBotAnalyticsResponse>;
+    readonly listActionRuns: (input: ListActionRunsInput) => Promise<ListActionRunsResponse>;
     readonly getBotIssue: (input: GetBotIssueInput) => Promise<GetBotIssueResponse>;
     readonly listBotIssues: (input: ListBotIssuesInput) => Promise<ListBotIssuesResponse>;
     readonly deleteBotIssue: (input: DeleteBotIssueInput) => Promise<DeleteBotIssueResponse>;
@@ -34130,6 +34436,11 @@ declare class Client extends Client$1 implements IClient {
             status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
             failedStatusReason?: string;
             expiresAt?: string;
+            owner: {
+                type: "bot" | "integration" | "user";
+                id?: string;
+                name?: string;
+            };
         }>;
         filePassages: (props: {
             id: string;
@@ -34169,8 +34480,8 @@ declare class Client extends Client$1 implements IClient {
             value: number;
             metadata?: {
                 botId: string;
-                type: "IntegrationAction" | "FileIndexing";
-                subtype: string;
+                type: "IntegrationAction" | "FileIndexing" | "BingSearch" | "WebSearch";
+                subtype?: string;
                 source?: string;
             };
         }>;