@botpress/client 0.47.0 → 0.48.1

package/dist/index.d.ts

@@ -224,6 +224,10 @@ interface GetOrCreateConversationRequestBody {
      * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
      */
     integrationName?: string;
+    /**
+     * 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.
+     */
+    discriminateByTags?: string[];
 }
 type GetOrCreateConversationInput = GetOrCreateConversationRequestBody & GetOrCreateConversationRequestHeaders & GetOrCreateConversationRequestQuery & GetOrCreateConversationRequestParams;
 interface GetOrCreateConversationResponse {
@@ -830,6 +834,10 @@ interface GetOrCreateMessageRequestBody {
          */
         delay?: number;
     };
+    /**
+     * Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message 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 GetOrCreateMessageInput = GetOrCreateMessageRequestBody & GetOrCreateMessageRequestHeaders & GetOrCreateMessageRequestQuery & GetOrCreateMessageRequestParams;
 interface GetOrCreateMessageResponse {
@@ -1247,6 +1255,10 @@ interface GetOrCreateUserRequestBody {
      * URI of the user picture
      */
     pictureUrl?: string;
+    /**
+     * 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.
+     */
+    discriminateByTags?: string[];
 }
 type GetOrCreateUserInput = GetOrCreateUserRequestBody & GetOrCreateUserRequestHeaders & GetOrCreateUserRequestQuery & GetOrCreateUserRequestParams;
 interface GetOrCreateUserResponse {
@@ -1726,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 {
@@ -2961,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)
          */
@@ -3336,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)
          */
@@ -6313,7 +6351,7 @@ interface CreateIntegrationRequestBody {
      * 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.
      */
     secrets?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * JavaScript code of the integration
@@ -6377,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)
          */
@@ -6983,7 +7031,7 @@ interface ValidateIntegrationCreationRequestBody {
      * 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.
      */
     secrets?: {
-        [k: string]: string;
+        [k: string]: string | null;
     };
     /**
      * JavaScript code of the integration
@@ -7290,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.
      */
@@ -7354,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)
          */
@@ -7949,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.
      */
@@ -7993,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 {
@@ -8044,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: {
         /**
@@ -8090,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)
          */
@@ -8484,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)
          */
@@ -11778,6 +11903,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 {
@@ -13730,6 +13954,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)
      */
@@ -15129,6 +15363,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>;
@@ -15592,6 +15830,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;
@@ -15651,7 +15901,7 @@ declare class Client extends Client$1 implements IClient {
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
      */
-    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, publicContentImmediatelyAccessible, }: ClientInputs["uploadFile"]) => Promise<ClientOutputs["uploadFile"]>;
+    readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, indexing, expiresAt, metadata, publicContentImmediatelyAccessible, }: ClientInputs["uploadFile"]) => Promise<ClientOutputs["uploadFile"]>;
 }
 
 export { type Account, AlreadyExistsError, type ApiError, type Bot, BreakingChangesError, Client, type ClientConfig, type ClientInputs, type ClientOutputs, type ClientParams, type ClientProps, type ClientReturn, type Column, type Conversation, type ErrorType, type Event, type File, ForbiddenError, type IClient, type Integration, type Interface, InternalError, InvalidDataFormatError, InvalidIdentifierError, InvalidJsonSchemaError, InvalidPayloadError, InvalidQueryError, type Issue, type IssueEvent, LimitExceededError, type Message, MethodNotFoundError, type Operation, PayloadTooLargeError, PaymentRequiredError, type Plugin, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type RetryConfig, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workflow, type Workspace, type WorkspaceMember, errorFrom, isApiError };