@botpress/client 0.48.0 → 0.48.2

package/dist/index.d.ts

@@ -1738,6 +1738,12 @@ interface ConfigureIntegrationRequestBody {
      * Recurring schedule on which `register()` will be called on the integration
      */
     scheduleRegisterCall?: "hourly" | "daily" | "weekly" | "bi-weekly" | "monthly" | "bi-monthly" | "quarterly" | "yearly";
+    /**
+     * Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations.
+     */
+    sandboxIdentifiers?: {
+        [k: string]: {} | null;
+    } | null;
 }
 type ConfigureIntegrationInput = ConfigureIntegrationRequestBody & ConfigureIntegrationRequestHeaders & ConfigureIntegrationRequestQuery & ConfigureIntegrationRequestParams;
 interface ConfigureIntegrationResponse {
@@ -2973,6 +2979,16 @@ interface GetPublicIntegrationByIdResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -3348,6 +3364,16 @@ interface GetPublicIntegrationResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -6389,6 +6415,16 @@ interface CreateIntegrationResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -7302,6 +7338,10 @@ interface UpdateIntegrationRequestBody {
             };
         } | null;
     };
+    sandbox?: {
+        identifierExtractScript?: string | null;
+        messageExtractScript?: string | null;
+    };
     /**
      * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
      */
@@ -7366,6 +7406,16 @@ interface UpdateIntegrationResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -7961,6 +8011,10 @@ interface ValidateIntegrationUpdateRequestBody {
             };
         } | null;
     };
+    sandbox?: {
+        identifierExtractScript?: string | null;
+        messageExtractScript?: string | null;
+    };
     /**
      * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
      */
@@ -8005,8 +8059,17 @@ interface ListIntegrationsRequestHeaders {
 }
 interface ListIntegrationsRequestQuery {
     nextToken?: string;
+    limit?: number;
     name?: string;
     version?: string;
+    interfaceId?: string;
+    interfaceName?: string;
+    visibility?: "public" | "private";
+    installedByBotId?: string;
+    verificationStatus?: "unapproved" | "pending" | "approved" | "rejected";
+    search?: string;
+    sortBy?: "popularity" | "name" | "createdAt" | "updatedAt" | "installCount";
+    direction?: "asc" | "desc";
     dev?: boolean;
 }
 interface ListIntegrationsRequestParams {
@@ -8056,6 +8119,36 @@ interface ListIntegrationsResponse {
          * Status of the integration version verification
          */
         verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
+        /**
+         * Metadata about which fields matched the search criteria
+         */
+        matchedOn?: {
+            /**
+             * Whether the integration name matched the search term
+             */
+            name?: boolean;
+            /**
+             * Whether the integration title matched the search term
+             */
+            title?: boolean;
+            /**
+             * Whether the integration description matched the search term
+             */
+            description?: boolean;
+            /**
+             * Action names that matched the search term
+             */
+            actions?: string[];
+            /**
+             * Interface names that matched the search term
+             */
+            interfaces?: string[];
+        };
+        ownerWorkspace?: {
+            id: string;
+            handle: string | null;
+            name: string;
+        };
     }[];
     meta: {
         /**
@@ -8102,6 +8195,16 @@ interface GetIntegrationResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -8496,6 +8599,16 @@ interface GetIntegrationByNameResponse {
              */
             extractScript?: string;
         };
+        sandbox?: {
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+             */
+            identifierExtractScript?: string;
+            /**
+             * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+             */
+            messageExtractScript?: string;
+        };
         /**
          * URL of the [Integration](#schema_integration)
          */
@@ -10729,6 +10842,22 @@ interface ListPluginsResponse {
          * Version of the [Plugin](#schema_plugin)
          */
         version: string;
+        /**
+         * Title of the plugin. This is the name that will be displayed in the UI
+         */
+        title: string;
+        /**
+         * Description of the plugin. This is the description that will be displayed in the UI
+         */
+        description: string;
+        /**
+         * URL of the icon of the plugin. This is the icon that will be displayed in the UI
+         */
+        iconUrl: string;
+        /**
+         * URL of the readme of the plugin. This is the readme that will be displayed in the UI
+         */
+        readmeUrl: string;
     }[];
     meta: {
         /**
@@ -11790,6 +11919,105 @@ interface ListFileTagValuesResponse {
     };
 }
 
+interface CreateKnowledgeBaseRequestHeaders {
+}
+interface CreateKnowledgeBaseRequestQuery {
+}
+interface CreateKnowledgeBaseRequestParams {
+}
+interface CreateKnowledgeBaseRequestBody {
+    /**
+     * Name of the knowledge base.
+     */
+    name: string;
+}
+type CreateKnowledgeBaseInput = CreateKnowledgeBaseRequestBody & CreateKnowledgeBaseRequestHeaders & CreateKnowledgeBaseRequestQuery & CreateKnowledgeBaseRequestParams;
+interface CreateKnowledgeBaseResponse {
+    knowledgeBase: {
+        /**
+         * Knowledge base ID
+         */
+        id: string;
+        /**
+         * Name of the knowledge base.
+         */
+        name: string;
+    };
+}
+
+interface DeleteKnowledgeBaseRequestHeaders {
+}
+interface DeleteKnowledgeBaseRequestQuery {
+}
+interface DeleteKnowledgeBaseRequestParams {
+    id: string;
+}
+interface DeleteKnowledgeBaseRequestBody {
+}
+type DeleteKnowledgeBaseInput = DeleteKnowledgeBaseRequestBody & DeleteKnowledgeBaseRequestHeaders & DeleteKnowledgeBaseRequestQuery & DeleteKnowledgeBaseRequestParams;
+interface DeleteKnowledgeBaseResponse {
+}
+
+interface UpdateKnowledgeBaseRequestHeaders {
+}
+interface UpdateKnowledgeBaseRequestQuery {
+}
+interface UpdateKnowledgeBaseRequestParams {
+    id: string;
+}
+interface UpdateKnowledgeBaseRequestBody {
+    /**
+     * New name of the knowledge base.
+     */
+    name: string;
+}
+type UpdateKnowledgeBaseInput = UpdateKnowledgeBaseRequestBody & UpdateKnowledgeBaseRequestHeaders & UpdateKnowledgeBaseRequestQuery & UpdateKnowledgeBaseRequestParams;
+interface UpdateKnowledgeBaseResponse {
+    knowledgeBase: {
+        /**
+         * Knowledge base ID
+         */
+        id: string;
+        /**
+         * Name of the knowledge base.
+         */
+        name: string;
+    };
+}
+
+interface ListKnowledgeBasesRequestHeaders {
+}
+interface ListKnowledgeBasesRequestQuery {
+    nextToken?: string;
+}
+interface ListKnowledgeBasesRequestParams {
+}
+interface ListKnowledgeBasesRequestBody {
+}
+type ListKnowledgeBasesInput = ListKnowledgeBasesRequestBody & ListKnowledgeBasesRequestHeaders & ListKnowledgeBasesRequestQuery & ListKnowledgeBasesRequestParams;
+interface ListKnowledgeBasesResponse {
+    knowledgeBases: {
+        /**
+         * Knowledge base ID
+         */
+        id: string;
+        /**
+         * Name of the knowledge base.
+         */
+        name: string;
+        /**
+         * Knowledge base creation timestamp in ISO 8601 format
+         */
+        createdAt: string;
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}
+
 interface ListTablesRequestHeaders {
 }
 interface ListTablesRequestQuery {
@@ -13742,6 +13970,16 @@ interface Integration {
          */
         extractScript?: string;
     };
+    sandbox?: {
+        /**
+         * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
+         */
+        identifierExtractScript?: string;
+        /**
+         * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
+         */
+        messageExtractScript?: string;
+    };
     /**
      * URL of the [Integration](#schema_integration)
      */
@@ -15141,6 +15379,10 @@ declare class Client$1 {
     readonly listFilePassages: (input: ListFilePassagesInput) => Promise<ListFilePassagesResponse>;
     readonly listFileTags: (input: ListFileTagsInput) => Promise<ListFileTagsResponse>;
     readonly listFileTagValues: (input: ListFileTagValuesInput) => Promise<ListFileTagValuesResponse>;
+    readonly createKnowledgeBase: (input: CreateKnowledgeBaseInput) => Promise<CreateKnowledgeBaseResponse>;
+    readonly deleteKnowledgeBase: (input: DeleteKnowledgeBaseInput) => Promise<DeleteKnowledgeBaseResponse>;
+    readonly updateKnowledgeBase: (input: UpdateKnowledgeBaseInput) => Promise<UpdateKnowledgeBaseResponse>;
+    readonly listKnowledgeBases: (input: ListKnowledgeBasesInput) => Promise<ListKnowledgeBasesResponse>;
     readonly listTables: (input: ListTablesInput) => Promise<ListTablesResponse>;
     readonly getTable: (input: GetTableInput) => Promise<GetTableResponse>;
     readonly getOrCreateTable: (input: GetOrCreateTableInput) => Promise<GetOrCreateTableResponse>;
@@ -15604,6 +15846,18 @@ declare class Lister {
         iconUrl: string;
         public: boolean;
         verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
+        matchedOn?: {
+            name?: boolean;
+            title?: boolean;
+            description?: boolean;
+            actions?: string[];
+            interfaces?: string[];
+        };
+        ownerWorkspace?: {
+            id: string;
+            handle: string | null;
+            name: string;
+        };
     }>;
     readonly interfaces: (props: ListInputs["listInterfaces"]) => AsyncCollection<{
         id: string;