@botpress/client 0.27.0 → 0.29.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { AxiosRequestConfig, AxiosInstance, AxiosError } from 'axios';
 import * as axios from 'axios';
 export { axios };
+import { IAxiosRetryConfig } from 'axios-retry';
 
 type Primitive = string | number | boolean;
 type Value<P extends Primitive> = P | P[] | Record<string, P>;
@@ -11044,6 +11045,7 @@ type ClientOutputs = Simplify<{
     [T in Operation]: Awaited<ReturnType<IClient[T]>>;
 }>;
 type Headers = Record<string, string | string[]>;
+type RetryConfig = IAxiosRetryConfig;
 type ClientProps = {
     integrationId?: string;
     workspaceId?: string;
@@ -11052,6 +11054,7 @@ type ClientProps = {
     apiUrl?: string;
     timeout?: number;
     headers?: Headers;
+    retry?: RetryConfig;
 };
 type ClientConfig = {
     apiUrl: string;
@@ -11313,13 +11316,230 @@ 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.
      */
     readonly uploadFile: ({ key, index, tags, contentType, accessPolicies, content, url, expiresAt, }: 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, QuotaExceededError, RateLimitedError, ReferenceConstraintError, ReferenceNotFoundError, RelationConflictError, ResourceLockedConflictError, ResourceNotFoundError, type Row, RuntimeError, type State, type Table, UnauthorizedError, UnknownError, UnsupportedMediaTypeError, UploadFileError, type Usage, type User, type Workspace, type WorkspaceMember, errorFrom, isApiError };
+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, 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 Workspace, type WorkspaceMember, errorFrom, isApiError };