@ecodrix/erix-api 2.1.2 → 2.1.4

package/dist/ts/esm/index.d.ts

@@ -234,6 +234,26 @@ declare class Analytics extends APIResource {
      * ```
      */
     whatsapp<T = any>(params?: AnalyticsParams): Promise<T>;
+    /**
+     * Revenue Intelligence — source attribution, deal velocity, cohorts, pulse.
+     */
+    revenue<T = any>(): Promise<T>;
+    /**
+     * Business Health Score — 0-100 composite with sub-scores and top actions.
+     */
+    health<T = any>(): Promise<T>;
+    /**
+     * Payment Intelligence — client scores, reminders, cash flow forecast.
+     */
+    payments<T = any>(): Promise<T>;
+    /**
+     * Review Engine Stats — requests sent, ratings, Google redirects.
+     */
+    reviews<T = any>(): Promise<T>;
+    /**
+     * Customer Retention — churn risk, at-risk leads, re-engagement stats.
+     */
+    retention<T = any>(): Promise<T>;
 }
 
 declare class AutomationDashboard extends APIResource {
@@ -402,6 +422,144 @@ declare class Automations extends APIResource {
     }): Promise<T>;
 }
 
+/**
+ * CRM Campaigns — broadcast campaigns with A/B testing.
+ *
+ * @example
+ * ```typescript
+ * const campaigns = await ecod.crm.campaigns.list();
+ * const analytics = await ecod.crm.campaigns.analytics("campaign-id");
+ * const ab = await ecod.crm.campaigns.createAB({ channel: "email", ... });
+ * ```
+ */
+declare class CRMCampaigns extends APIResource {
+    /**
+     * List campaigns with metrics.
+     */
+    list<T = any>(params?: {
+        status?: string;
+        startDate?: string;
+        endDate?: string;
+        page?: number;
+        limit?: number;
+    }): Promise<T>;
+    /**
+     * Get analytics for a specific campaign.
+     */
+    analytics<T = any>(campaignId: string): Promise<T>;
+    /**
+     * Create and send a campaign.
+     */
+    create<T = any>(payload: {
+        channel: "email" | "whatsapp";
+        recipients: Array<string | {
+            email?: string;
+            phone?: string;
+            name?: string;
+        }>;
+        subject?: string;
+        html?: string;
+        templateName?: string;
+        languageCode?: string;
+        variables?: Record<string, unknown>;
+    }): Promise<T>;
+    /**
+     * Create an A/B split test campaign.
+     */
+    createAB<T = any>(payload: {
+        channel: "email" | "whatsapp";
+        recipients: Array<string | {
+            email?: string;
+            phone?: string;
+            name?: string;
+        }>;
+        variants: Array<{
+            name: string;
+            subject?: string;
+            html?: string;
+            templateName?: string;
+        }>;
+        testPercent?: number;
+        waitHours?: number;
+        winnerMetric?: "open" | "click" | "reply" | "delivered";
+    }): Promise<T>;
+}
+
+/**
+ * CRM Documents — document checklist management per lead.
+ *
+ * @example
+ * ```typescript
+ * const checklist = await ecod.crm.documents.getChecklist("lead-id");
+ * await ecod.crm.documents.createChecklist("lead-id", "consultant__business");
+ * await ecod.crm.documents.markReceived("lead-id", "pan_card", fileUrl);
+ * await ecod.crm.documents.sendReminder("lead-id");
+ * ```
+ */
+declare class CRMDocuments extends APIResource {
+    /**
+     * Get document checklist for a lead.
+     */
+    getChecklist<T = any>(leadId: string): Promise<T>;
+    /**
+     * Create a checklist from a niche template.
+     */
+    createChecklist<T = any>(leadId: string, templateNiche: string): Promise<T>;
+    /**
+     * Mark a checklist item as received.
+     */
+    markReceived<T = any>(leadId: string, itemKey: string, fileUrl?: string): Promise<T>;
+    /**
+     * Send missing documents reminder via WhatsApp.
+     */
+    sendReminder<T = any>(leadId: string): Promise<T>;
+    /**
+     * List all leads with incomplete document checklists.
+     */
+    listIncomplete<T = any>(): Promise<T>;
+    /**
+     * List available checklist templates.
+     */
+    listTemplates<T = any>(): Promise<T>;
+}
+
+/**
+ * CRM Invoice Export — download invoices in accounting formats.
+ *
+ * @example
+ * ```typescript
+ * const csv = await ecod.crm.invoiceExport.csv({ from: "2026-01-01", status: "paid" });
+ * const tally = await ecod.crm.invoiceExport.tally();
+ * const zoho = await ecod.crm.invoiceExport.zoho({ from: "2026-06-01", to: "2026-08-31" });
+ * ```
+ */
+declare class CRMInvoiceExport extends APIResource {
+    /**
+     * Export invoices as CSV (universal spreadsheet format).
+     */
+    csv<T = any>(params?: {
+        from?: string;
+        to?: string;
+        status?: string;
+    }): Promise<T>;
+    /**
+     * Export invoices in Tally Prime-compatible JSON format.
+     */
+    tally<T = any>(params?: {
+        from?: string;
+        to?: string;
+        status?: string;
+    }): Promise<T>;
+    /**
+     * Export invoices in Zoho Books CSV format.
+     */
+    zoho<T = any>(params?: {
+        from?: string;
+        to?: string;
+        status?: string;
+    }): Promise<T>;
+}
+
 /**
  * The specific UI control type suggested for a field on a `ResourceManifest`.
  *
@@ -894,6 +1052,14 @@ declare class Leads extends APIResource {
      * List sequence enrollments for this lead.
      */
     sequences<T = any>(leadId: string): Promise<T>;
+    /**
+     * Merge two duplicate leads. Primary survives, secondary's data is merged in
+     * (conversations, activities, tags) and the secondary is deleted.
+     *
+     * @param primaryId - The lead to keep.
+     * @param secondaryId - The lead to merge into primary and delete.
+     */
+    merge<T = any>(primaryId: string, secondaryId: string): Promise<T>;
 }
 
 declare class Payments extends APIResource {
@@ -1073,6 +1239,12 @@ declare class Pipelines extends APIResource {
     deleteStage(stageId: string, moveLeadsToStageId?: string): Promise<unknown>;
 }
 
+/** Optional time-decay: leads lose points once idle past `afterDays`. */
+interface ScoreDecay {
+    enabled: boolean;
+    afterDays: number;
+    pointsPerDay: number;
+}
 interface ScoringConfig {
     /** Scoring rules — each rule adds/subtracts points based on field conditions. */
     rules: any[];
@@ -1091,6 +1263,8 @@ interface ScoringConfig {
      * @example ["lead_created", "appointment_booked"]
      */
     recalculateOnTriggers?: string[];
+    /** Optional time-decay for idle leads. */
+    decay?: ScoreDecay;
 }
 declare class Scoring extends APIResource {
     /**
@@ -1118,6 +1292,13 @@ declare class Scoring extends APIResource {
      * ```
      */
     recalculate<T = any>(leadId: string): Promise<T>;
+    /**
+     * Preview a lead's score + per-rule breakdown WITHOUT persisting it.
+     * Powers the scoring config "why this lead scores X" panel.
+     *
+     * @param leadId - The unique ID of the lead to evaluate.
+     */
+    preview<T = any>(leadId: string): Promise<T>;
 }
 
 declare class Sequences extends APIResource {
@@ -1959,6 +2140,36 @@ declare class Logs extends APIResource {
     }>;
 }
 
+/**
+ * Niche Resources — Workflow packs + WhatsApp template suggestions.
+ *
+ * @example
+ * ```typescript
+ * const packs = await ecod.niche.workflowPacks();
+ * const detail = await ecod.niche.workflowPackDetail("pack_healthcare");
+ * const result = await ecod.niche.installWorkflowPack("pack_healthcare");
+ * const templates = await ecod.niche.templateSuggestions();
+ * ```
+ */
+declare class NicheResources extends APIResource {
+    /**
+     * List workflow packs available for the org's niche.
+     */
+    workflowPacks<T = any>(): Promise<T>;
+    /**
+     * Get a specific workflow pack with full flow details.
+     */
+    workflowPackDetail<T = any>(packId: string): Promise<T>;
+    /**
+     * Install a workflow pack — clone all flows into the org's workspace.
+     */
+    installWorkflowPack<T = any>(packId: string): Promise<T>;
+    /**
+     * WhatsApp template suggestions for the org's niche.
+     */
+    templateSuggestions<T = any>(): Promise<T>;
+}
+
 /**
  * Portal Inbox — team-side unified inbox for portal conversations.
  *
@@ -6490,6 +6701,10 @@ declare class ErixProduct {
     readonly projects: ProjectDocuments;
     readonly campaigns: Campaigns;
     readonly portalInbox: PortalInbox;
+    readonly niche: NicheResources;
+    readonly documents: CRMDocuments;
+    readonly invoiceExport: CRMInvoiceExport;
+    readonly crmCampaigns: CRMCampaigns;
     constructor(client: AxiosInstance);
 }
 /** Product domain root (`/v1/api/product/*`). */
@@ -6741,6 +6956,12 @@ interface ECODrIxAPIOptions {
      * never set this and never pass a URL.
      */
     baseUrl?: string;
+    /**
+     * Per-request timeout in milliseconds. A request that gets no response
+     * within this window is aborted and rejected (rather than hanging the
+     * caller forever). Defaults to 30000 (30s). Set 0 to disable.
+     */
+    timeout?: number;
 }
 /**
  * The primary entry point for the ECODrIx SDK.