@getnexorai/sdk 0.1.0

package/dist/config-eTstZgSV.d.ts

@@ -0,0 +1,440 @@
+type UUID = string;
+type ISODateString = string;
+interface ClientOptions {
+    /** Your Nexor API key. Get one in the dashboard at https://app.getnexor.ai */
+    apiKey: string;
+    /** Override the API base URL. Defaults to https://api.getnexor.ai */
+    baseUrl?: string;
+    /** Per-request timeout in ms. Defaults to 30000. */
+    timeoutMs?: number;
+    /** Number of automatic retries on 5xx / network errors. Defaults to 2. */
+    maxRetries?: number;
+    /** Custom fetch implementation (e.g. for testing). Defaults to globalThis.fetch. */
+    fetch?: typeof fetch;
+    /** Optional user-agent suffix appended to the default. */
+    userAgentSuffix?: string;
+}
+interface RequestOptions {
+    /** AbortSignal for cancellation. */
+    signal?: AbortSignal;
+    /** Override per-request timeout. */
+    timeoutMs?: number;
+    /** Optional idempotency key (echoed back to server logs). */
+    idempotencyKey?: string;
+}
+interface ForceFirstMessage {
+    channel: "whatsapp" | "email";
+    content: string;
+    /** Required when channel === "email". */
+    subject?: string;
+    /** Override the default email sender. */
+    sender_id?: UUID;
+}
+interface CreateLeadInput {
+    first_name: string;
+    last_name?: string;
+    email?: string;
+    phone?: string;
+    source?: string;
+    company?: string;
+    title?: string;
+    city?: string;
+    date_of_birth?: ISODateString;
+    external_id?: string;
+    metadata?: Record<string, unknown>;
+    tags?: string[] | string;
+    workflow_id?: UUID;
+    campaign_id?: UUID;
+    force_first_message?: ForceFirstMessage;
+    /** Any extra fields are merged into metadata server-side. */
+    [extra: string]: unknown;
+}
+interface Lead {
+    id: UUID;
+    first_name: string;
+    last_name: string | null;
+    email: string | null;
+    phone: string | null;
+    source: string;
+    company: string | null;
+    title: string | null;
+    metadata: Record<string, unknown>;
+    created_at: ISODateString;
+    updated_at?: ISODateString;
+    campaign_id?: UUID | null;
+    tags?: unknown;
+}
+interface WorkflowRunStub {
+    id: UUID;
+    job_id?: string;
+    workflow?: unknown;
+    cadence?: unknown;
+}
+interface CreateLeadResponse {
+    success: true;
+    lead: Lead;
+    workflow_run?: WorkflowRunStub;
+    force_first_message?: {
+        sent: boolean;
+        channel: "whatsapp" | "email";
+        error?: string;
+    };
+    warning?: string;
+}
+interface BulkResultEntry {
+    success: boolean;
+    index: number;
+    lead?: Lead;
+    workflow_run?: WorkflowRunStub;
+    tags?: UUID[];
+    error?: string;
+    warning?: string;
+}
+interface CreateLeadBulkResponse {
+    success: boolean;
+    results: BulkResultEntry[];
+    summary: {
+        total: number;
+        created: number;
+        failed: number;
+    };
+}
+interface GetLeadResponse {
+    success: true;
+    lead: Lead & {
+        active_workflow_run: unknown | null;
+    };
+    variables: Record<string, {
+        value: unknown;
+        value_text: string | null;
+        confidence: number | null;
+        updated_at: ISODateString;
+    }>;
+    engagement: {
+        whatsapp: {
+            last_sent_at: ISODateString | null;
+            last_delivered_at: ISODateString | null;
+            last_read_at: ISODateString | null;
+            last_reply_at: ISODateString | null;
+            window_open: boolean;
+        };
+        email: {
+            last_sent_at: ISODateString | null;
+            last_delivered_at: ISODateString | null;
+            last_opened_at: ISODateString | null;
+        };
+        call: {
+            last_call_at: ISODateString | null;
+            last_successful_call_at: ISODateString | null;
+            total_calls: number;
+        };
+    };
+}
+interface LeadHistoryItem {
+    id: string;
+    type: string;
+    channel: string;
+    timestamp: ISODateString;
+    direction?: "inbound" | "outbound" | null;
+    content?: string;
+    [key: string]: unknown;
+}
+interface GetLeadHistoryResponse {
+    success: true;
+    lead: {
+        id: UUID;
+        first_name: string;
+    };
+    history: LeadHistoryItem[];
+    pagination: {
+        limit: number;
+        offset: number;
+        has_more: boolean;
+    };
+}
+interface GetLeadHistoryParams {
+    channel?: ("whatsapp" | "email" | "call") | Array<"whatsapp" | "email" | "call">;
+    limit?: number;
+    offset?: number;
+}
+interface SyncTagsInput {
+    /** Either lead_id or email is required. */
+    lead_id?: UUID;
+    email?: string;
+    /** Source-of-truth set; [] clears all tags. */
+    tags: string[];
+}
+interface SyncTagsResponse {
+    success: true;
+    lead_id: UUID;
+    tags: unknown;
+    added: unknown[];
+    removed: unknown[];
+}
+interface Workflow {
+    id: UUID;
+    name: string;
+    description: string | null;
+    goal_type: string | null;
+    cadence_enabled: boolean;
+    created_at: ISODateString;
+}
+interface Campaign {
+    id: UUID;
+    name: string;
+    description: string | null;
+    created_at: ISODateString;
+}
+interface WhatsAppTemplate {
+    id: UUID;
+    name: string;
+    language: string;
+    category: string;
+    status: string;
+    components: unknown;
+    variables: unknown;
+}
+interface ListTemplatesParams {
+    status?: string;
+    category?: string;
+}
+interface SendMessageInput {
+    lead_id: UUID;
+    workflow_id: UUID;
+    channel: "whatsapp" | "email" | "call";
+    /** WhatsApp / email text body. */
+    content?: string;
+    /** Email HTML body. */
+    html?: string;
+    /** Email subject. */
+    subject?: string;
+    /** WhatsApp template id (alternative to free-form content). */
+    template_id?: UUID;
+    /** WhatsApp template component overrides. */
+    components?: unknown;
+    /** Retell first-utterance text when channel === "call". */
+    begin_message?: string;
+}
+interface CreateMeetingInput {
+    lead_email: string;
+    title: string;
+    starts_at: ISODateString;
+    ends_at?: ISODateString;
+    duration_minutes?: number;
+    timezone?: string;
+    meeting_url?: string;
+    location_type?: string;
+    location_details?: string;
+    description?: string;
+    host_email?: string;
+    meeting_type_id?: UUID;
+    attendee_name?: string;
+    attendee_email?: string;
+    attendee_phone?: string;
+    additional_attendees?: Array<{
+        name?: string;
+        email: string;
+    }>;
+    external_calendar_provider?: string;
+    external_event_id?: string;
+    status?: string;
+}
+interface MeetingNotesInput {
+    lead_email?: string;
+    notes?: string;
+    manual_ai_summary?: string;
+    provider?: string;
+    external_meeting_id?: string;
+    calendar_event_id?: UUID;
+    external_calendar_provider?: string;
+    external_calendar_event_id?: string;
+    meeting_url?: string;
+    meeting_date?: ISODateString;
+    meeting_title?: string;
+    duration_seconds?: number;
+    organizer_email?: string;
+    transcript_text?: string;
+    summary?: string;
+    action_items?: string[];
+    questions?: string[];
+    keywords?: string[];
+    sentences?: unknown[];
+    status?: "completed" | "pending" | "failed";
+}
+interface AutomationInput {
+    workflow_id: UUID;
+}
+interface ResumeAutomationInput extends AutomationInput {
+    resume_cadence?: boolean;
+}
+interface IsPausedResponse {
+    success: true;
+    paused: boolean;
+}
+
+/**
+ * Low-level Nexor API client.
+ *
+ * Most users should call `init()` / `createClient()` instead of instantiating
+ * this directly, but it's exported for advanced cases (DI, mocking).
+ */
+declare class NexorClient {
+    private cfg;
+    constructor(opts: ClientOptions);
+    /** Create a single lead, optionally assigning it to a workflow. */
+    createLead(input: CreateLeadInput, options?: RequestOptions): Promise<CreateLeadResponse>;
+    /** Create many leads in one request (max 1000). */
+    createLeadsBulk(inputs: CreateLeadInput[], options?: RequestOptions): Promise<CreateLeadBulkResponse>;
+    /** Update an existing lead. metadata is shallow-merged server-side. */
+    updateLead(leadId: UUID, updates: Partial<CreateLeadInput>, options?: RequestOptions): Promise<{
+        success: true;
+        lead: Lead;
+    }>;
+    /** Fetch a lead with its captured variables and per-channel engagement. */
+    getLead(leadId: UUID, options?: RequestOptions): Promise<GetLeadResponse>;
+    /** Full chronological history: messages, transcripts, activity. */
+    getLeadHistory(leadId: UUID, params?: GetLeadHistoryParams, options?: RequestOptions): Promise<GetLeadHistoryResponse>;
+    /** Has automation been paused (human takeover) for this lead? */
+    isLeadPaused(leadId: UUID, params?: {
+        workflow_id?: UUID;
+    }, options?: RequestOptions): Promise<IsPausedResponse>;
+    /** Pause automation (engage human takeover) on a specific workflow run. */
+    stopAutomation(leadId: UUID, input: AutomationInput, options?: RequestOptions): Promise<unknown>;
+    /** Resume automation; pass resume_cadence: true to restart scheduled touches. */
+    resumeAutomation(leadId: UUID, input: ResumeAutomationInput, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Replace the tag set on a lead (identified by lead_id OR email).
+     * Tags missing from the input are unassigned; new tags are find-or-created.
+     */
+    syncLeadTags(input: SyncTagsInput, options?: RequestOptions): Promise<SyncTagsResponse>;
+    /** All meetings on file for a lead (optionally filter by status). */
+    listLeadMeetings(leadId: UUID, params?: {
+        status?: string | string[];
+    }, options?: RequestOptions): Promise<unknown>;
+    /** Active workflows in your account. */
+    listWorkflows(options?: RequestOptions): Promise<{
+        success: true;
+        workflows: Workflow[];
+    }>;
+    /** Campaigns in your account. */
+    listCampaigns(options?: RequestOptions): Promise<{
+        success: true;
+        campaigns: Campaign[];
+    }>;
+    /** Approved WhatsApp templates. */
+    listTemplates(params?: ListTemplatesParams, options?: RequestOptions): Promise<{
+        success: true;
+        templates: WhatsAppTemplate[];
+    }>;
+    /** Send a one-off message (WhatsApp/email) or trigger a call. */
+    sendMessage(input: SendMessageInput, options?: RequestOptions): Promise<unknown>;
+    /** Log a booked meeting against an existing lead (matched by email). */
+    createMeeting(input: CreateMeetingInput, options?: RequestOptions): Promise<unknown>;
+    /** Push a note-taker transcript / summary / action items to a meeting. */
+    createMeetingNotes(input: MeetingNotesInput, options?: RequestOptions): Promise<unknown>;
+    /**
+     * Send a turn in a browser-embedded chat session. Backed by
+     * POST /api/public/chat on the Nexor API.
+     *
+     * Most users will not call this directly — `initChat()` handles it.
+     */
+    chat(input: {
+        workflow_id: UUID;
+        session_id: string;
+        message: string;
+        system_prompt?: string;
+        client_prompt?: string;
+        lead?: {
+            first_name?: string;
+            last_name?: string;
+            email?: string;
+            phone?: string;
+            metadata?: Record<string, unknown>;
+        };
+        metadata?: Record<string, unknown>;
+    }, options?: RequestOptions): Promise<{
+        success: true;
+        reply: string;
+        session_id: string;
+        lead_id?: UUID;
+        workflow_run_id?: UUID;
+    }>;
+}
+
+/**
+ * Chat widget configuration types + defaults.
+ *
+ * Kept separate from the widget's runtime code so other modules (and the
+ * top-level `nexor.initChat()` re-export) can pull types without dragging in
+ * the DOM construction code.
+ */
+
+interface ChatLeadCapture {
+    /** Which fields to ask for before chatting. Defaults to ["first_name", "email"]. */
+    fields?: Array<"first_name" | "last_name" | "email" | "phone">;
+    /** "before" gates chat behind the form; "skip" never asks. Default "before". */
+    mode?: "before" | "skip";
+    /** Label rendered above the form. */
+    label?: string;
+    /** Submit button label. */
+    submitLabel?: string;
+}
+interface ChatInitOptions {
+    /** Workflow that handles this chat conversation. Required. */
+    workflowId: UUID;
+    title?: string;
+    subtitle?: string;
+    greeting?: string;
+    /** Shown when a turn fails or the server returns no reply. */
+    errorText?: string;
+    /** BCP-47 locale for timestamps (e.g. "es", "en-US"). Defaults to the browser. */
+    locale?: string;
+    /** Hex colour for bubble + accents. Defaults to #111827. */
+    accentColor?: string;
+    /** Text colour rendered on top of the accent. Defaults to white. */
+    accentTextColor?: string;
+    /** Show the "Powered by Nexor" footer. Defaults to true. */
+    showBranding?: boolean;
+    position?: "bottom-right" | "bottom-left";
+    /** Auto-open the panel on first load. Defaults to false. */
+    openOnLoad?: boolean;
+    /** Coalesce rapid-fire messages: wait this many ms of quiet, then send the
+     *  buffered messages as one combined turn. Defaults to 700. 0 = per message. */
+    debounceMs?: number;
+    /** Append the widget to a custom element. Defaults to document.body. */
+    container?: HTMLElement;
+    systemPrompt?: string;
+    clientPrompt?: string;
+    /** Pre-known lead info (e.g. a logged-in user). Skips capture if complete. */
+    lead?: {
+        first_name?: string;
+        last_name?: string;
+        email?: string;
+        phone?: string;
+        metadata?: Record<string, unknown>;
+    };
+    capture?: ChatLeadCapture;
+    /** Arbitrary metadata passed with each turn (page URL, UTM, …). */
+    metadata?: Record<string, unknown>;
+    onOpen?: () => void;
+    onClose?: () => void;
+    onMessage?: (msg: {
+        role: "user" | "bot";
+        text: string;
+    }) => void;
+    onLeadCaptured?: (leadId: UUID) => void;
+    onError?: (err: Error) => void;
+}
+interface ChatHandle {
+    open(): void;
+    close(): void;
+    toggle(): void;
+    /** Programmatically send a user message. */
+    send(text: string): Promise<void>;
+    /** Tear down the widget and remove all DOM. */
+    destroy(): void;
+    /** Read the current session id (auto-generated on first open). */
+    getSessionId(): string;
+}
+
+export { type AutomationInput as A, type BulkResultEntry as B, type Campaign as C, type ForceFirstMessage as F, type GetLeadHistoryParams as G, type ISODateString as I, type Lead as L, type MeetingNotesInput as M, NexorClient as N, type RequestOptions as R, type SendMessageInput as S, type UUID as U, type WhatsAppTemplate as W, type ChatHandle as a, type ChatInitOptions as b, type ChatLeadCapture as c, type ClientOptions as d, type CreateLeadBulkResponse as e, type CreateLeadInput as f, type CreateLeadResponse as g, type CreateMeetingInput as h, type GetLeadHistoryResponse as i, type GetLeadResponse as j, type IsPausedResponse as k, type LeadHistoryItem as l, type ListTemplatesParams as m, type ResumeAutomationInput as n, type SyncTagsInput as o, type SyncTagsResponse as p, type Workflow as q, type WorkflowRunStub as r };