@bimpeai/sdk 0.0.0-beta-20260606071952

package/dist/index.d.ts

@@ -0,0 +1,478 @@
+interface PaginationMeta {
+    readonly total_count: number;
+    readonly page_count: number;
+    readonly current_page: number;
+    readonly limit: number;
+    readonly has_next_page: boolean;
+    readonly has_previous_page: boolean;
+}
+interface ListQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: string;
+}
+interface ApiResponse<T> {
+    readonly data: T;
+    readonly meta: PaginationMeta | null;
+    readonly requestId: string | null;
+    readonly status: number;
+    readonly headers: Headers;
+}
+interface RequestOptions {
+    idempotencyKey?: string;
+    signal?: AbortSignal;
+    timeout?: number;
+    maxRetries?: number;
+    headers?: Record<string, string>;
+}
+interface InternalRequestSpec {
+    method: 'GET' | 'POST' | 'PATCH' | 'DELETE' | 'PUT';
+    path: string;
+    query?: Record<string, string | number | boolean | undefined>;
+    body?: unknown;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+    timeout?: number;
+    maxRetries?: number;
+    idempotencyKey?: string;
+}
+type Fetch = typeof globalThis.fetch;
+interface Logger {
+    debug(message: string, context?: Record<string, unknown>): void;
+    warn(message: string, context?: Record<string, unknown>): void;
+}
+/**
+ * The slice of the transport that resources depend on. Depending on this rather
+ * than the concrete HttpClient keeps the transport class out of the public types.
+ */
+interface RequestExecutor {
+    request<T>(spec: InternalRequestSpec & RequestOptions): Promise<ApiResponse<T>>;
+}
+
+interface HttpClientConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+    maxRetries?: number;
+    fetch?: Fetch;
+    defaultHeaders?: Record<string, string>;
+    logger?: Logger;
+}
+
+interface Rule {
+    readonly id: string;
+    readonly name: string;
+    readonly trigger: string;
+    readonly condition: string | null;
+    readonly response: string;
+    readonly action: string | null;
+    readonly enabled: boolean;
+}
+interface RuleInput {
+    id: string;
+    name: string;
+    trigger: string;
+    condition?: string | null;
+    response: string;
+    action?: string | null;
+    enabled: boolean;
+}
+interface Agent {
+    readonly id: string;
+    readonly name: string;
+    readonly description: string | null;
+    readonly system_prompt: string | null;
+    readonly language: string | null;
+    readonly persona: string | null;
+    readonly agent_workflow_id: string | null;
+    readonly rules: readonly Rule[] | null;
+    readonly timezone: string | null;
+    readonly logo: string | null;
+    readonly business_name: string | null;
+    readonly business_address: string | null;
+    readonly business_email: string | null;
+    readonly business_description: string | null;
+    readonly test_channel_code: string | null;
+    readonly status: string;
+    readonly status_reason: string | null;
+    readonly escalation_email: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+}
+interface AgentDetail extends Agent {
+    readonly integration: readonly AgentIntegration[];
+    readonly channel: readonly AgentChannel[];
+    readonly conversation_flow: readonly AgentConversationFlow[];
+    readonly actions: readonly AgentActionSummary[];
+    readonly knowledge_bases: readonly KnowledgeBaseSummary[];
+}
+interface CreateAgentBody {
+    name: string;
+    description?: string | null;
+    system_prompt?: string | null;
+    language?: string | null;
+    persona?: string | null;
+    agent_workflow_id?: string | null;
+    rules?: RuleInput[] | null;
+    timezone?: string | null;
+    logo?: string | null;
+    business_name?: string | null;
+    business_address?: string | null;
+    business_email?: string | null;
+    business_description?: string | null;
+    escalation_email?: string | null;
+}
+type UpdateAgentBody = Partial<CreateAgentBody>;
+interface IntegrationConfigField {
+    readonly key: string;
+    readonly label: string;
+    readonly type: string;
+    readonly required: boolean;
+}
+interface IntegrationAction {
+    readonly action_name: string;
+    readonly name: string;
+    readonly description: string | null;
+    readonly category: string;
+    readonly is_enabled: boolean;
+    readonly require_human_approval: boolean;
+}
+interface AgentIntegration {
+    readonly id: string;
+    readonly type: string;
+    readonly status: string;
+    readonly is_connected: boolean;
+    readonly config_fields: readonly IntegrationConfigField[];
+    readonly actions: readonly IntegrationAction[];
+}
+interface AgentChannel {
+    readonly id: string;
+    readonly type: string;
+    readonly status: string;
+    readonly is_connected: boolean;
+}
+interface AgentConversationFlow {
+    readonly name: string;
+    readonly description: string | null;
+    readonly category: string | null;
+    readonly priority: number;
+    readonly is_active: boolean;
+}
+interface AgentActionSummary {
+    readonly id: string;
+    readonly integration_type: string;
+    readonly integration_name: string;
+    readonly name: string;
+    readonly action_name: string;
+    readonly description: string | null;
+    readonly is_enabled: boolean;
+}
+interface KnowledgeBaseSummary {
+    readonly id: string;
+    readonly type: 'text' | 'url';
+    readonly name: string;
+    readonly description: string | null;
+}
+interface CreateKnowledgeBaseTextBody {
+    type: 'text';
+    name: string;
+    description?: string | null;
+    content: string;
+}
+interface CreateKnowledgeBaseUrlBody {
+    type: 'url';
+    name: string;
+    description?: string | null;
+    url: string;
+}
+type CreateKnowledgeBaseBody = CreateKnowledgeBaseTextBody | CreateKnowledgeBaseUrlBody;
+interface UpdateKnowledgeBaseBody {
+    name?: string;
+    description?: string | null;
+    content?: string | null;
+    url?: string | null;
+}
+
+declare class AgentActions {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(agentId: string): Promise<readonly AgentActionSummary[]>;
+}
+
+type PageFetcher<T> = (page: number) => Promise<Page<T>>;
+interface PageInit<T> {
+    data: readonly T[];
+    meta: PaginationMeta | null;
+    requestId: string | null;
+    fetcher: PageFetcher<T>;
+}
+declare class Page<T> implements AsyncIterable<T> {
+    readonly data: readonly T[];
+    readonly meta: PaginationMeta | null;
+    readonly requestId: string | null;
+    private readonly fetcher;
+    constructor(init: PageInit<T>);
+    get hasNextPage(): boolean;
+    getNextPage(): Promise<Page<T> | null>;
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    pages(): AsyncGenerator<Page<T>>;
+}
+/**
+ * The return value of a `list` call. Awaiting it yields the first `Page`; iterating
+ * it with `for await` walks every item across all pages, fetching lazily.
+ */
+declare class PagePromise<T> implements PromiseLike<Page<T>>, AsyncIterable<T> {
+    private readonly load;
+    constructor(load: () => Promise<Page<T>>);
+    then<TResult1 = Page<T>, TResult2 = never>(onfulfilled?: ((value: Page<T>) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: unknown) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
+    catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<Page<T> | TResult>;
+    finally(onfinally?: (() => void) | null): Promise<Page<T>>;
+    [Symbol.asyncIterator](): AsyncIterator<T>;
+    pages(): AsyncIterable<Page<T>>;
+}
+
+declare class AgentChannels {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(agentId: string): Promise<readonly AgentChannel[]>;
+}
+
+declare class AgentConversationFlows {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(agentId: string): Promise<readonly AgentConversationFlow[]>;
+}
+
+declare class AgentIntegrations {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(agentId: string): Promise<readonly AgentIntegration[]>;
+}
+
+declare class AgentKnowledgeBases {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(agentId: string): Promise<readonly KnowledgeBaseSummary[]>;
+    create(agentId: string, body: CreateKnowledgeBaseBody, options?: RequestOptions): Promise<KnowledgeBaseSummary>;
+    update(agentId: string, kbId: string, body: UpdateKnowledgeBaseBody): Promise<KnowledgeBaseSummary>;
+    delete(agentId: string, kbId: string): Promise<void>;
+}
+
+type Client$3 = RequestExecutor;
+declare class Agents {
+    private readonly client;
+    readonly integrations: AgentIntegrations;
+    readonly channels: AgentChannels;
+    readonly conversationFlows: AgentConversationFlows;
+    readonly actions: AgentActions;
+    readonly knowledgeBases: AgentKnowledgeBases;
+    constructor(client: Client$3);
+    list(query?: ListQuery): PagePromise<Agent>;
+    create(body: CreateAgentBody, options?: RequestOptions): Promise<Agent>;
+    retrieve(agentId: string): Promise<AgentDetail>;
+    update(agentId: string, body: UpdateAgentBody): Promise<Agent>;
+    private fetchPage;
+}
+
+interface Call {
+    readonly id: string;
+}
+
+declare class Calls {
+    private readonly client;
+    constructor(client: RequestExecutor);
+    list(): Promise<readonly Call[]>;
+}
+
+type ConversationChannel = 'whatsapp' | 'messenger' | 'instagram' | 'webchat' | 'test_whatsapp' | 'test_messenger' | 'test_instagram';
+interface Conversation {
+    readonly id: string;
+    readonly channel_type: string;
+    readonly channel_id: string | null;
+    readonly is_test_channel: boolean;
+    readonly full_name: string | null;
+    readonly email: string | null;
+    readonly phone_number: string | null;
+    readonly channel_username: string | null;
+    readonly is_ai_chat_paused: boolean;
+    readonly last_message_at: string | null;
+    readonly last_message_preview: string | null;
+    readonly created_at: string;
+    readonly updated_at: string;
+}
+interface ListConversationsQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    channel?: ConversationChannel;
+}
+interface Message {
+    readonly id: string;
+    readonly role: string;
+    readonly message: string | null;
+    readonly message_type: string | null;
+    readonly created_at: string;
+}
+interface MessageAttachment {
+    type: string;
+    url: string;
+}
+interface SendMessageBody {
+    message: string;
+    attachments?: MessageAttachment[];
+}
+interface ListMessagesQuery {
+    page?: number;
+    limit?: number;
+}
+
+type Client$2 = RequestExecutor;
+declare class Messages {
+    private readonly client;
+    constructor(client: Client$2);
+    list(agentId: string, conversationId: string, query?: ListMessagesQuery): PagePromise<Message>;
+    send(agentId: string, conversationId: string, body: SendMessageBody, options?: RequestOptions): Promise<Message>;
+    private fetchPage;
+}
+
+type Client$1 = RequestExecutor;
+declare class Conversations {
+    private readonly client;
+    readonly messages: Messages;
+    constructor(client: Client$1);
+    list(agentId: string, query?: ListConversationsQuery): PagePromise<Conversation>;
+    retrieve(agentId: string, conversationId: string): Promise<Conversation>;
+    private fetchPage;
+}
+
+type WorkflowVisibility = 'private' | 'public';
+type WorkflowScope = 'owned' | 'public';
+interface WorkflowSummary {
+    readonly id: string;
+    readonly name: string;
+    readonly description: string | null;
+    readonly category: string | null;
+    readonly visibility: WorkflowVisibility;
+    readonly is_owner: boolean;
+    readonly created_at: string;
+    readonly updated_at: string;
+}
+interface Workflow extends WorkflowSummary {
+    readonly system_prompt: string | null;
+    readonly rules: readonly Rule[];
+    readonly flows: readonly Record<string, unknown>[];
+    readonly tags: readonly string[];
+    readonly prompt_config: Record<string, unknown>;
+}
+interface CreateWorkflowBody {
+    name: string;
+    description?: string;
+    category?: string;
+    system_prompt?: string;
+    rules?: RuleInput[];
+    flows?: Record<string, unknown>[];
+    tags?: string[];
+    prompt_config?: Record<string, unknown>;
+}
+type UpdateWorkflowBody = Partial<CreateWorkflowBody>;
+interface ListWorkflowsQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: string;
+    scope?: WorkflowScope;
+}
+
+type Client = RequestExecutor;
+declare class Workflows {
+    private readonly client;
+    constructor(client: Client);
+    list(query?: ListWorkflowsQuery): PagePromise<WorkflowSummary>;
+    create(body: CreateWorkflowBody, options?: RequestOptions): Promise<Workflow>;
+    retrieve(workflowId: string): Promise<Workflow>;
+    update(workflowId: string, body: UpdateWorkflowBody): Promise<Workflow>;
+    delete(workflowId: string): Promise<void>;
+    private fetchPage;
+}
+
+type BimpeAIConfig = HttpClientConfig;
+declare class BimpeAI {
+    readonly agents: Agents;
+    readonly workflows: Workflows;
+    readonly conversations: Conversations;
+    readonly calls: Calls;
+    private readonly http;
+    constructor(config: BimpeAIConfig);
+    request<T>(spec: InternalRequestSpec & RequestOptions): Promise<ApiResponse<T>>;
+}
+
+declare class BimpeAIError extends Error {
+    constructor(message: string);
+}
+declare class UserError extends BimpeAIError {
+}
+declare class ConnectionError extends BimpeAIError {
+    readonly cause?: unknown;
+    constructor(message: string, cause?: unknown);
+}
+declare class ConnectionTimeoutError extends ConnectionError {
+}
+interface ApiErrorInit {
+    message: string;
+    status: number;
+    code: string | null;
+    requestId: string | null;
+    headers: Headers;
+    body: unknown;
+}
+declare class ApiError extends BimpeAIError {
+    readonly status: number;
+    readonly code: string | null;
+    readonly requestId: string | null;
+    readonly headers: Headers;
+    readonly body: unknown;
+    constructor(init: ApiErrorInit);
+}
+declare class BadRequestError extends ApiError {
+}
+interface FieldError {
+    readonly path: string;
+    readonly message: string;
+}
+interface ValidationErrorInit extends ApiErrorInit {
+    fieldErrors: readonly FieldError[];
+}
+declare class ValidationError extends BadRequestError {
+    readonly fieldErrors: readonly FieldError[];
+    constructor(init: ValidationErrorInit);
+}
+declare class AuthenticationError extends ApiError {
+}
+declare class PermissionDeniedError extends ApiError {
+}
+declare class NotFoundError extends ApiError {
+}
+declare class ConflictError extends ApiError {
+}
+interface RateLimitErrorInit extends ApiErrorInit {
+    retryAfter?: number | null;
+    limit?: number | null;
+    remaining?: number | null;
+    resetAt?: Date | null;
+}
+declare class RateLimitError extends ApiError {
+    readonly retryAfter: number | null;
+    readonly limit: number | null;
+    readonly remaining: number | null;
+    readonly resetAt: Date | null;
+    constructor(init: RateLimitErrorInit);
+}
+declare class InternalServerError extends ApiError {
+}
+declare class NotImplementedError extends ApiError {
+}
+
+declare const VERSION = "0.0.0-beta-20260606071952";
+
+export { type Agent, type AgentActionSummary, AgentActions, type AgentChannel, AgentChannels, type AgentConversationFlow, AgentConversationFlows, type AgentDetail, type AgentIntegration, AgentIntegrations, AgentKnowledgeBases, Agents, ApiError, type ApiResponse, AuthenticationError, BadRequestError, BimpeAI, type BimpeAIConfig, BimpeAIError, type Call, Calls, ConflictError, ConnectionError, ConnectionTimeoutError, type Conversation, type ConversationChannel, Conversations, type CreateAgentBody, type CreateKnowledgeBaseBody, type CreateKnowledgeBaseTextBody, type CreateKnowledgeBaseUrlBody, type CreateWorkflowBody, type FieldError, type IntegrationAction, type IntegrationConfigField, InternalServerError, type KnowledgeBaseSummary, type ListConversationsQuery, type ListMessagesQuery, type ListQuery, type ListWorkflowsQuery, type Message, type MessageAttachment, Messages, NotFoundError, NotImplementedError, Page, PagePromise, type PaginationMeta, PermissionDeniedError, RateLimitError, type RequestOptions, type Rule, type RuleInput, type SendMessageBody, type UpdateAgentBody, type UpdateKnowledgeBaseBody, type UpdateWorkflowBody, UserError, VERSION, ValidationError, type Workflow, type WorkflowScope, type WorkflowSummary, type WorkflowVisibility, Workflows };