@ecodrix/erix-api 2.1.3 → 2.1.5

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 {
@@ -1974,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.
  *
@@ -2593,9 +2789,65 @@ interface Template {
     status: "APPROVED" | "PENDING" | "REJECTED";
     components: TemplateComponent[];
 }
+type TemplateBindingSource = "crm" | "trigger" | "system" | "manual" | "static" | "computed";
+type TemplateEmptyPolicy = "use_fallback" | "error" | "empty_string";
+interface TemplateBinding {
+    token?: string;
+    position: number;
+    source: TemplateBindingSource;
+    collection?: string;
+    field?: string;
+    staticValue?: string;
+    formula?: string;
+    transform?: string;
+    fallback?: string;
+    required?: boolean;
+    label?: string;
+    componentType?: string;
+    componentIndex?: number;
+    originalIndex?: string | number;
+}
 interface TemplateMapping {
-    mappings: any[];
-    onEmptyVariable: string;
+    mappings: TemplateBinding[];
+    onEmptyVariable: TemplateEmptyPolicy;
+}
+interface MappingField {
+    key: string;
+    label: string;
+    type?: string;
+    dataType?: string;
+}
+interface MappingSources {
+    collections: Array<{
+        name: string;
+        label: string;
+        fields: MappingField[];
+    }>;
+    triggers: Array<{
+        name: string;
+        label: string;
+        fields: MappingField[];
+    }>;
+    system: MappingField[];
+    static: {
+        hint: string;
+    };
+}
+interface TemplateApiResponse<T> {
+    success: boolean;
+    data: T;
+    message?: string;
+    error?: string;
+}
+interface MappingValidationResult {
+    isReady: boolean;
+    mappingCount: number;
+}
+interface MappingPreviewResult {
+    isReady: boolean;
+    resolvedVariables: string[];
+    previewText: string;
+    contextSnapshot?: Record<string, unknown>;
 }
 declare class Templates extends APIResource {
     /**
@@ -2677,8 +2929,10 @@ declare class Templates extends APIResource {
      * ```
      */
     mappingConfig<T = any>(): Promise<T>;
+    /** Tenant-scoped CRM, custom-field, automation, and system mapping sources. */
+    mappingSources<T = MappingSources>(): Promise<TemplateApiResponse<T>>;
     /**
-     * List CRM collections available for variable mapping (Leads, Deals, etc.).
+     * List CRM collections available for variable mapping (legacy).
      */
     collections<T = any>(): Promise<T>;
     /**
@@ -2693,27 +2947,17 @@ declare class Templates extends APIResource {
      * @param templateName - Name of the template.
      * @param payload - Mapping definitions.
      */
-    updateMapping<T = any>(templateName: string, payload: TemplateMapping): Promise<T>;
+    updateMapping<T = unknown>(templateName: string, payload: TemplateMapping): Promise<TemplateApiResponse<T>>;
+    /** Validate a persisted mapping, or a draft mapping before saving. */
+    validate<T = MappingValidationResult>(templateName: string, draft?: TemplateMapping): Promise<TemplateApiResponse<T>>;
     /**
-     * Validate if a template is ready for automated sending based on its mappings.
+     * Preview a template resolution with caller-provided sample data.
+     * Draft mappings are validated server-side and are never persisted.
      */
-    validate<T = any>(templateName: string): Promise<T>;
-    /**
-     * Preview a template resolution with sample data.
-     *
-     * @param templateName - Name of the template.
-     * @param context - Lead data or variable overrides for preview.
-     * @example
-     * ```typescript
-     * const preview = await erixClient.whatsapp.templates.preview("welcome", {
-     *   lead: { firstName: "Alice" }
-     * });
-     * ```
-     */
-    preview<T = any>(templateName: string, context: {
-        lead?: any;
-        vars?: any;
-    }): Promise<T>;
+    preview<T = MappingPreviewResult>(templateName: string, context: {
+        lead?: Record<string, unknown>;
+        vars?: Record<string, unknown>;
+    }, mappings?: TemplateBinding[], onEmptyVariable?: TemplateEmptyPolicy): Promise<TemplateApiResponse<T>>;
     /**
      * Introspect a template and provide a manifest of its required variables.
      *
@@ -6505,6 +6749,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/*`). */
@@ -7265,4 +7513,4 @@ declare function getRetryConfig(error: any): {
     readonly reason: "Generic API errors may be transient and worth retrying";
 };
 
-export { type AIPersona, APIError, AdminOnboarding, type AnswerFollowupBody, type AnswerOnboardingPayload, type AnswerOnboardingResponse, type ApplyCouponPayload, AuthenticationError, type BehaviorRules, type Broadcast, type CheckboxConfig, type CheckoutAmountBreakdown, type CheckoutOrderResponse, type CheckoutProduct, type CheckoutSession, type ColorRule, type ColumnConfig, type CompleteOnboardingPayload, type CompleteOnboardingResponse, type ConfidenceResponse, ConnectInfra, type Conversation, type ListParams as ConversationListParams, type Correction, type CreateBroadcastParams, type CreateLeadParams, type CreateNichePackPayload, type CreateOnboardingConfigPayload, type CreateOnboardingExperimentPayload, type CreateOrderPayload, type CreatePipelineParams, type CreateSessionPayload, type CrmView, type CurrencyConfig, type CurrencyValue, type CustomFieldFilter, type DateConfig, type DateTimeConfig, type DropdownConfig, ECODrIxAPI as ECODrIx, ECODrIxAPI, type ECODrIxAPIOptions, ERROR_RETRY_CONFIG, EcodrixError, type EditOnboardingPayload, type EditOnboardingResponse, type EmailConfig, EmailConnect, ErixChat, ErixProduct, type FieldConfig, type FieldDefinition, type FieldManifest, type FieldType, type FileConfig, type FilterOperator, type FilterRule, type ForkNichePackPayload, type FormulaConfig, type GlobalOnboardingPayload, HTTP_STATUS_ERROR_MAP, type ICP, InfraDomain, LEAD_STATUS_VALUES, type LayoutType, type Lead, type LeadPattern, type LeadSource, type LeadStatus, type LearningMemory, type ListLeadsParams, type ListNichePacksParams, type ListNichePacksResponse, type ListOnboardingConfigsParams, type ListOnboardingExperimentsParams, type ListOnboardingExperimentsResponse, type ManifestFieldType, type Message, type NichePack, type NichePackResearchConfig, type NichePackResponse, type NichePackStatus, type NichePackSummary, type NormalizedFieldValue, type NumberConfig, Onboarding, type OnboardingAbandonmentResponse, type OnboardingAbandonmentResult, type OnboardingAbandonmentRow, type OnboardingAnalyticsFiltersParams, type OnboardingCohortRange, type OnboardingConfig, type OnboardingExperiment, type OnboardingExperimentResponse, type OnboardingExperimentStatus, type OnboardingExperimentVariant, type OnboardingFunnelResponse, type OnboardingFunnelResult, type OnboardingFunnelStep, type OnboardingMemoryMapping, type OnboardingOption, type OnboardingSession, type OnboardingSessionStatus, type OnboardingStateResponse, type OnboardingStep, type OnboardingStepType, type OnboardingTimeOnStepResponse, type OnboardingTimeOnStepResult, type OnboardingTimeOnStepRow, type OutreachEdit, type PaginatedResponse, Persona, type PersonaFollowupQuestion, type PersonaFollowupsResponse, type PersonaIdentity, type PersonaTimelineEntry, type PersonaTimelineOptions, type PersonaTimelineResponse, type PhoneConfig, type Pipeline, type PipelineStage, type PipelineStageParams, PlatformAdmin, PlatformDomain, PlatformTenants, PlatformUsers, ProductDomain, type ProgressConfig, RateLimitError, type RatingConfig, type ReinforceResponse, type ReinforcementEvent, type RelationConfig, type RelationValue, type ResourceManifest, type SendMessageParams, type ServiceConfig, type ServiceConfigGlobal, type ServiceConfigPerProduct, type SmokeTestMaterializerAction, type SmokeTestNichePackPayload, type SmokeTestResult, type SortRule, type StartOnboardingPayload, type StartOnboardingResponse, StorageInfra, type StoredFieldValue, type SuggestionEvent, type TagsConfig, type Template, type TemplateComponent, type TemplateMapping, type TextConfig, type UpdateNichePackPayload, type UpdateOnboardingConfigPayload, type UpdateOnboardingExperimentPayload, type UpsertLeadParams, type UrlConfig, type VerifyPayload, type ViewConfig, type Vocabulary, WhatsAppConnect, type WorkspaceDashboardLayout, type WorkspaceDefaultAutomation, type WorkspaceDefaultField, type WorkspaceDefaultPipeline, type WorkspaceModuleConfig, type WorkspaceProfile, ECODrIxAPI as default, getErrorDetails, getRetryConfig, handleAPIError, isAPIError };
+export { type AIPersona, APIError, AdminOnboarding, type AnswerFollowupBody, type AnswerOnboardingPayload, type AnswerOnboardingResponse, type ApplyCouponPayload, AuthenticationError, type BehaviorRules, type Broadcast, type CheckboxConfig, type CheckoutAmountBreakdown, type CheckoutOrderResponse, type CheckoutProduct, type CheckoutSession, type ColorRule, type ColumnConfig, type CompleteOnboardingPayload, type CompleteOnboardingResponse, type ConfidenceResponse, ConnectInfra, type Conversation, type ListParams as ConversationListParams, type Correction, type CreateBroadcastParams, type CreateLeadParams, type CreateNichePackPayload, type CreateOnboardingConfigPayload, type CreateOnboardingExperimentPayload, type CreateOrderPayload, type CreatePipelineParams, type CreateSessionPayload, type CrmView, type CurrencyConfig, type CurrencyValue, type CustomFieldFilter, type DateConfig, type DateTimeConfig, type DropdownConfig, ECODrIxAPI as ECODrIx, ECODrIxAPI, type ECODrIxAPIOptions, ERROR_RETRY_CONFIG, EcodrixError, type EditOnboardingPayload, type EditOnboardingResponse, type EmailConfig, EmailConnect, ErixChat, ErixProduct, type FieldConfig, type FieldDefinition, type FieldManifest, type FieldType, type FileConfig, type FilterOperator, type FilterRule, type ForkNichePackPayload, type FormulaConfig, type GlobalOnboardingPayload, HTTP_STATUS_ERROR_MAP, type ICP, InfraDomain, LEAD_STATUS_VALUES, type LayoutType, type Lead, type LeadPattern, type LeadSource, type LeadStatus, type LearningMemory, type ListLeadsParams, type ListNichePacksParams, type ListNichePacksResponse, type ListOnboardingConfigsParams, type ListOnboardingExperimentsParams, type ListOnboardingExperimentsResponse, type ManifestFieldType, type MappingField, type MappingPreviewResult, type MappingSources, type MappingValidationResult, type Message, type NichePack, type NichePackResearchConfig, type NichePackResponse, type NichePackStatus, type NichePackSummary, type NormalizedFieldValue, type NumberConfig, Onboarding, type OnboardingAbandonmentResponse, type OnboardingAbandonmentResult, type OnboardingAbandonmentRow, type OnboardingAnalyticsFiltersParams, type OnboardingCohortRange, type OnboardingConfig, type OnboardingExperiment, type OnboardingExperimentResponse, type OnboardingExperimentStatus, type OnboardingExperimentVariant, type OnboardingFunnelResponse, type OnboardingFunnelResult, type OnboardingFunnelStep, type OnboardingMemoryMapping, type OnboardingOption, type OnboardingSession, type OnboardingSessionStatus, type OnboardingStateResponse, type OnboardingStep, type OnboardingStepType, type OnboardingTimeOnStepResponse, type OnboardingTimeOnStepResult, type OnboardingTimeOnStepRow, type OutreachEdit, type PaginatedResponse, Persona, type PersonaFollowupQuestion, type PersonaFollowupsResponse, type PersonaIdentity, type PersonaTimelineEntry, type PersonaTimelineOptions, type PersonaTimelineResponse, type PhoneConfig, type Pipeline, type PipelineStage, type PipelineStageParams, PlatformAdmin, PlatformDomain, PlatformTenants, PlatformUsers, ProductDomain, type ProgressConfig, RateLimitError, type RatingConfig, type ReinforceResponse, type ReinforcementEvent, type RelationConfig, type RelationValue, type ResourceManifest, type SendMessageParams, type ServiceConfig, type ServiceConfigGlobal, type ServiceConfigPerProduct, type SmokeTestMaterializerAction, type SmokeTestNichePackPayload, type SmokeTestResult, type SortRule, type StartOnboardingPayload, type StartOnboardingResponse, StorageInfra, type StoredFieldValue, type SuggestionEvent, type TagsConfig, type Template, type TemplateApiResponse, type TemplateBinding, type TemplateBindingSource, type TemplateComponent, type TemplateEmptyPolicy, type TemplateMapping, type TextConfig, type UpdateNichePackPayload, type UpdateOnboardingConfigPayload, type UpdateOnboardingExperimentPayload, type UpsertLeadParams, type UrlConfig, type VerifyPayload, type ViewConfig, type Vocabulary, WhatsAppConnect, type WorkspaceDashboardLayout, type WorkspaceDefaultAutomation, type WorkspaceDefaultField, type WorkspaceDefaultPipeline, type WorkspaceModuleConfig, type WorkspaceProfile, ECODrIxAPI as default, getErrorDetails, getRetryConfig, handleAPIError, isAPIError };