@botpress/client 0.26.5 → 0.28.0

package/dist/index.d.ts

@@ -7807,7 +7807,7 @@ interface UpsertFileRequestBody {
      */
     contentType?: string;
     /**
-     * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 30 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored.
+     * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored.
      */
     expiresAt?: string;
 }
@@ -8090,7 +8090,7 @@ interface UpdateFileMetadataRequestBody {
      */
     accessPolicies?: ("integrations" | "public_content")[];
     /**
-     * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 30 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored. Omit to keep the existing expiry intact. Set to `null` to remove the expiry.
+     * Expiry timestamp in ISO 8601 format with UTC timezone. After expiry, the File will be deleted. Must be in the future. Cannot be more than 90 days from now. The value up to minutes is considered. Seconds and milliseconds are ignored. Omit to keep the existing expiry intact. Set to `null` to remove the expiry.
      */
     expiresAt?: string | null;
 }
@@ -8175,6 +8175,7 @@ interface SearchFilesRequestQuery {
     query: string;
     contextDepth?: number;
     limit?: number;
+    includeBreadcrumb?: boolean;
 }
 interface SearchFilesRequestParams {
 }
@@ -11312,9 +11313,226 @@ declare class UploadFileError extends Error {
     } | undefined);
 }
 
+type ListOperation = keyof {
+    [K in Operation as ClientInputs[K] extends {
+        nextToken?: string | undefined;
+    } ? K : never]: null;
+};
+type ListInputs = {
+    [K in ListOperation]: Omit<ClientInputs[K], 'nextToken'>;
+};
+type PageLister<R> = (t: {
+    nextToken?: string;
+}) => Promise<{
+    items: R[];
+    meta: {
+        nextToken?: string;
+    };
+}>;
+declare class AsyncCollection<T> {
+    private _list;
+    constructor(_list: PageLister<T>);
+    [Symbol.asyncIterator](): AsyncGenerator<Awaited<T>, void, unknown>;
+    collect(props?: {
+        limit?: number;
+    }): Promise<T[]>;
+}
+declare class Lister {
+    private client;
+    constructor(client: Client$1);
+    readonly conversations: (props: ListInputs['listConversations']) => AsyncCollection<{
+        id: string;
+        currentTaskId?: string | undefined;
+        createdAt: string;
+        updatedAt: string;
+        channel: string;
+        integration: string;
+        tags: {
+            [k: string]: string;
+        };
+    }>;
+    readonly participants: (props: ListInputs['listParticipants']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        tags: {
+            [k: string]: string;
+        };
+        name?: string | undefined;
+        pictureUrl?: string | undefined;
+    }>;
+    readonly events: (props: ListInputs['listEvents']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        type: string;
+        payload: {
+            [k: string]: any;
+        };
+        conversationId?: string | undefined;
+        userId?: string | undefined;
+        messageId?: string | undefined;
+        status: "pending" | "processed" | "ignored" | "failed";
+        failureReason: string | null;
+    }>;
+    readonly messages: (props: ListInputs['listMessages']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        type: string;
+        payload: {
+            [k: string]: any;
+        };
+        direction: "incoming" | "outgoing";
+        userId: string;
+        conversationId: string;
+        tags: {
+            [k: string]: string;
+        };
+    }>;
+    readonly users: (props: ListInputs['listUsers']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        tags: {
+            [k: string]: string;
+        };
+        name?: string | undefined;
+        pictureUrl?: string | undefined;
+    }>;
+    readonly tasks: (props: ListInputs['listTasks']) => AsyncCollection<{
+        id: string;
+        title: string;
+        description: string;
+        type: string;
+        data: {
+            [k: string]: any;
+        };
+        status: "pending" | "failed" | "in_progress" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
+        parentTaskId?: string | undefined;
+        conversationId?: string | undefined;
+        userId?: string | undefined;
+        timeoutAt: string;
+        createdAt: string;
+        updatedAt: string;
+        failureReason?: string | undefined;
+        tags: {
+            [k: string]: string;
+        };
+    }>;
+    readonly publicIntegrations: (props: ListInputs['listPublicIntegrations']) => AsyncCollection<{
+        id: string;
+        name: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        title: string;
+        description: string;
+        iconUrl: string;
+        public: boolean;
+        verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
+        ownerWorkspace: {
+            id: string;
+            handle: string | null;
+            name: string;
+        };
+    }>;
+    readonly bots: (props: ListInputs['listBots']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name: string;
+        deployedAt?: string | undefined;
+    }>;
+    readonly botIssues: (props: ListInputs['listBotIssues']) => AsyncCollection<{
+        id: string;
+        code: string;
+        createdAt: string;
+        lastSeenAt: string;
+        title: string;
+        description: string;
+        groupedData: {
+            [k: string]: {
+                raw: string;
+                pretty?: string | undefined;
+            };
+        };
+        eventsCount: number;
+        category: "configuration" | "user_code" | "limits" | "other";
+        resolutionLink: string | null;
+    }>;
+    readonly workspaces: (props: ListInputs['listWorkspaces']) => AsyncCollection<UpdateWorkspaceResponse>;
+    readonly publicWorkspaces: (props: ListInputs['listPublicWorkspaces']) => AsyncCollection<GetPublicWorkspaceResponse>;
+    readonly workspaceMembers: (props: ListInputs['listWorkspaceMembers']) => AsyncCollection<{
+        id: string;
+        userId?: string | undefined;
+        email: string;
+        createdAt: string;
+        role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
+        profilePicture?: string | undefined;
+        displayName?: string | undefined;
+    }>;
+    readonly integrations: (props: ListInputs['listIntegrations']) => AsyncCollection<{
+        id: string;
+        name: string;
+        version: string;
+        createdAt: string;
+        updatedAt: string;
+        title: string;
+        description: string;
+        iconUrl: string;
+        public: boolean;
+        verificationStatus: "pending" | "unapproved" | "approved" | "rejected";
+    }>;
+    readonly interfaces: (props: ListInputs['listInterfaces']) => AsyncCollection<{
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name: string;
+        version: string;
+    }>;
+    readonly activities: (props: ListInputs['listActivities']) => AsyncCollection<{
+        id: string;
+        description: string;
+        taskId: string;
+        category: "unknown" | "capture" | "bot_message" | "user_message" | "agent_message" | "event" | "action" | "task_status" | "subtask_status" | "exception";
+        data: {
+            [k: string]: any;
+        };
+        createdAt: string;
+    }>;
+    readonly files: (props: ListInputs['listFiles']) => AsyncCollection<{
+        id: string;
+        botId: string;
+        key: string;
+        url: string;
+        size: number | null;
+        contentType: string;
+        tags: {
+            [k: string]: string;
+        };
+        createdAt: string;
+        updatedAt: string;
+        accessPolicies: ("integrations" | "public_content")[];
+        index: boolean;
+        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
+        failedStatusReason?: string | undefined;
+        expiresAt?: string | undefined;
+    }>;
+    readonly filePassages: (props: ListInputs['listFilePassages']) => AsyncCollection<{
+        id: string;
+        content: string;
+        meta: {
+            type?: "chunk" | undefined;
+            subtype?: "code" | "title" | "subtitle" | "paragraph" | "list" | "blockquote" | "table" | undefined;
+            pageNumber?: number | undefined;
+            position?: number | undefined;
+        };
+    }>;
+}
+
 declare class Client extends Client$1 implements IClient {
     readonly config: Readonly<ClientConfig>;
     constructor(clientProps?: ClientProps);
+    get list(): Lister;
     /**
      * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.
      */