@botpress/client 1.18.0 → 1.20.0

package/dist/index.d.ts

@@ -2683,6 +2683,10 @@ interface GetOrCreateWorkflowRequestBody$1 {
      * Event id must be specified if the workflow is created with the status in_progress
      */
     eventId?: string;
+    /**
+     * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow 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.
+     */
+    discriminateByTags?: string[];
 }
 type GetOrCreateWorkflowInput$1 = GetOrCreateWorkflowRequestBody$1 & GetOrCreateWorkflowRequestHeaders$1 & GetOrCreateWorkflowRequestQuery$1 & GetOrCreateWorkflowRequestParams$1;
 interface GetOrCreateWorkflowResponse$1 {
@@ -5509,6 +5513,7 @@ interface CreateBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -6134,6 +6139,7 @@ interface UpdateBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -6591,6 +6597,7 @@ interface GetBotResponse$1 {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -7363,6 +7370,49 @@ type DeleteBotApiKeyInput$1 = DeleteBotApiKeyRequestBody$1 & DeleteBotApiKeyRequ
 interface DeleteBotApiKeyResponse$1 {
 }
 
+interface GetBotAllowlistRequestHeaders$1 {
+}
+interface GetBotAllowlistRequestQuery$1 {
+}
+interface GetBotAllowlistRequestParams$1 {
+    botId: string;
+}
+interface GetBotAllowlistRequestBody$1 {
+}
+type GetBotAllowlistInput$1 = GetBotAllowlistRequestBody$1 & GetBotAllowlistRequestHeaders$1 & GetBotAllowlistRequestQuery$1 & GetBotAllowlistRequestParams$1;
+interface GetBotAllowlistResponse$1 {
+    /**
+     * Allowlist setting of the bot
+     */
+    setting: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
+    users: {
+        id: string;
+    }[];
+}
+
+interface UpdateBotAllowlistRequestHeaders$1 {
+}
+interface UpdateBotAllowlistRequestQuery$1 {
+}
+interface UpdateBotAllowlistRequestParams$1 {
+    botId: string;
+}
+interface UpdateBotAllowlistRequestBody$1 {
+    /**
+     * Allowlist setting of the bot
+     */
+    setting?: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
+    users?: {
+        /**
+         * If `true`, the user should be added to the allowlist. If `false`, the user should be removed from the allowlist. This performs a partial update, so any existing users not included here will be kept in the allowlist
+         */
+        [k: string]: boolean;
+    };
+}
+type UpdateBotAllowlistInput$1 = UpdateBotAllowlistRequestBody$1 & UpdateBotAllowlistRequestHeaders$1 & UpdateBotAllowlistRequestQuery$1 & UpdateBotAllowlistRequestParams$1;
+interface UpdateBotAllowlistResponse$1 {
+}
+
 interface ListWorkspaceInvoicesRequestHeaders$1 {
 }
 interface ListWorkspaceInvoicesRequestQuery$1 {
@@ -13939,6 +13989,8 @@ declare class Client$7 {
     readonly listBotApiKeys: (input: ListBotApiKeysInput$1) => Promise<ListBotApiKeysResponse$1>;
     readonly createBotApiKey: (input: CreateBotApiKeyInput$1) => Promise<CreateBotApiKeyResponse$1>;
     readonly deleteBotApiKey: (input: DeleteBotApiKeyInput$1) => Promise<DeleteBotApiKeyResponse$1>;
+    readonly getBotAllowlist: (input: GetBotAllowlistInput$1) => Promise<GetBotAllowlistResponse$1>;
+    readonly updateBotAllowlist: (input: UpdateBotAllowlistInput$1) => Promise<UpdateBotAllowlistResponse$1>;
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput$1) => Promise<ListWorkspaceInvoicesResponse$1>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput$1) => Promise<GetUpcomingInvoiceResponse$1>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput$1) => Promise<ChargeWorkspaceUnpaidInvoicesResponse$1>;
@@ -14308,9 +14360,9 @@ interface UpsertFileRequestBody$1 {
                 generateMasterSummary?: boolean;
             };
             /**
-             * Internal setting, cannot be set manually.
+             * If not set, the default indexing stack will be used.
              */
-            stack?: "realtime-v1";
+            stack?: "legacy" | "realtime-v1";
             vision?: {
                 /**
                  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -14923,6 +14975,7 @@ interface SearchFilesRequestQuery$1 {
     limit?: number;
     consolidate?: boolean;
     includeBreadcrumb?: boolean;
+    withContext?: boolean;
 }
 interface SearchFilesRequestParams$1 {
 }
@@ -14992,8 +15045,14 @@ interface SearchFilesResponse$1 {
              */
             updatedAt: string;
         };
+        /**
+         * Surrounding passages including the current passage, based on the requested `contextDepth`. Only returned if the `withContext` parameter is set to `true`. Not supported when using the `consolidate` option.
+         */
         context?: {
-            id: string;
+            /**
+             * The ID of the vector that the context passage belongs to. Omitted for breadcrumbs.
+             */
+            id?: string;
             text: string;
             /**
              * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
@@ -15002,7 +15061,7 @@ interface SearchFilesResponse$1 {
             /**
              * The type of context passage
              */
-            type: "preceding" | "subsequent" | "breadcrumb";
+            type: "preceding" | "subsequent" | "current" | "breadcrumb";
         }[];
     }[];
 }
@@ -19648,6 +19707,10 @@ interface GetOrCreateWorkflowRequestBody {
      * Event id must be specified if the workflow is created with the status in_progress
      */
     eventId?: string;
+    /**
+     * Optional list of tag names to use for strict matching when looking up existing workflows. If provided, all specified tags must match exactly for a workflow to be considered a match. For example, with an existing workflow 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.
+     */
+    discriminateByTags?: string[];
 }
 type GetOrCreateWorkflowInput = GetOrCreateWorkflowRequestBody & GetOrCreateWorkflowRequestHeaders & GetOrCreateWorkflowRequestQuery & GetOrCreateWorkflowRequestParams;
 interface GetOrCreateWorkflowResponse {
@@ -22266,6 +22329,7 @@ interface CreateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -22891,6 +22955,7 @@ interface UpdateBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -23348,6 +23413,7 @@ interface GetBotResponse {
                 interfaces?: {
                     [k: string]: {
                         integrationId: string;
+                        interfaceId: string;
                     };
                 };
                 /**
@@ -24120,6 +24186,49 @@ type DeleteBotApiKeyInput = DeleteBotApiKeyRequestBody & DeleteBotApiKeyRequestH
 interface DeleteBotApiKeyResponse {
 }
 
+interface GetBotAllowlistRequestHeaders {
+}
+interface GetBotAllowlistRequestQuery {
+}
+interface GetBotAllowlistRequestParams {
+    botId: string;
+}
+interface GetBotAllowlistRequestBody {
+}
+type GetBotAllowlistInput = GetBotAllowlistRequestBody & GetBotAllowlistRequestHeaders & GetBotAllowlistRequestQuery & GetBotAllowlistRequestParams;
+interface GetBotAllowlistResponse {
+    /**
+     * Allowlist setting of the bot
+     */
+    setting: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
+    users: {
+        id: string;
+    }[];
+}
+
+interface UpdateBotAllowlistRequestHeaders {
+}
+interface UpdateBotAllowlistRequestQuery {
+}
+interface UpdateBotAllowlistRequestParams {
+    botId: string;
+}
+interface UpdateBotAllowlistRequestBody {
+    /**
+     * Allowlist setting of the bot
+     */
+    setting?: "ALL_WORKSPACE_USERS" | "SELECTED_USERS";
+    users?: {
+        /**
+         * If `true`, the user should be added to the allowlist. If `false`, the user should be removed from the allowlist. This performs a partial update, so any existing users not included here will be kept in the allowlist
+         */
+        [k: string]: boolean;
+    };
+}
+type UpdateBotAllowlistInput = UpdateBotAllowlistRequestBody & UpdateBotAllowlistRequestHeaders & UpdateBotAllowlistRequestQuery & UpdateBotAllowlistRequestParams;
+interface UpdateBotAllowlistResponse {
+}
+
 interface ListWorkspaceInvoicesRequestHeaders {
 }
 interface ListWorkspaceInvoicesRequestQuery {
@@ -30729,9 +30838,9 @@ interface UpsertFileRequestBody {
                 generateMasterSummary?: boolean;
             };
             /**
-             * Internal setting, cannot be set manually.
+             * If not set, the default indexing stack will be used.
              */
-            stack?: "realtime-v1";
+            stack?: "legacy" | "realtime-v1";
             vision?: {
                 /**
                  * (Team/Enterprise plan only, charged as AI Spend) For PDF files, set this option to `true` or pass an array with specific page numbers to use a vision-enabled LLM to transcribe each page of the PDF as standalone vectors and index them.
@@ -31344,6 +31453,7 @@ interface SearchFilesRequestQuery {
     limit?: number;
     consolidate?: boolean;
     includeBreadcrumb?: boolean;
+    withContext?: boolean;
 }
 interface SearchFilesRequestParams {
 }
@@ -31413,8 +31523,14 @@ interface SearchFilesResponse {
              */
             updatedAt: string;
         };
+        /**
+         * Surrounding passages including the current passage, based on the requested `contextDepth`. Only returned if the `withContext` parameter is set to `true`. Not supported when using the `consolidate` option.
+         */
         context?: {
-            id: string;
+            /**
+             * The ID of the vector that the context passage belongs to. Omitted for breadcrumbs.
+             */
+            id?: string;
             text: string;
             /**
              * Position of the context passage relative to the current passage. Negative for preceding passages, positive for subsequent, ommited for breadcrumbs.
@@ -31423,7 +31539,7 @@ interface SearchFilesResponse {
             /**
              * The type of context passage
              */
-            type: "preceding" | "subsequent" | "breadcrumb";
+            type: "preceding" | "subsequent" | "current" | "breadcrumb";
         }[];
     }[];
 }
@@ -33378,6 +33494,7 @@ interface Bot {
             interfaces?: {
                 [k: string]: {
                     integrationId: string;
+                    interfaceId: string;
                 };
             };
             /**
@@ -35225,6 +35342,8 @@ declare class Client$1 {
     readonly listBotApiKeys: (input: ListBotApiKeysInput) => Promise<ListBotApiKeysResponse>;
     readonly createBotApiKey: (input: CreateBotApiKeyInput) => Promise<CreateBotApiKeyResponse>;
     readonly deleteBotApiKey: (input: DeleteBotApiKeyInput) => Promise<DeleteBotApiKeyResponse>;
+    readonly getBotAllowlist: (input: GetBotAllowlistInput) => Promise<GetBotAllowlistResponse>;
+    readonly updateBotAllowlist: (input: UpdateBotAllowlistInput) => Promise<UpdateBotAllowlistResponse>;
     readonly listWorkspaceInvoices: (input: ListWorkspaceInvoicesInput) => Promise<ListWorkspaceInvoicesResponse>;
     readonly getUpcomingInvoice: (input: GetUpcomingInvoiceInput) => Promise<GetUpcomingInvoiceResponse>;
     readonly chargeWorkspaceUnpaidInvoices: (input: ChargeWorkspaceUnpaidInvoicesInput) => Promise<ChargeWorkspaceUnpaidInvoicesResponse>;