@ecodrix/erix-api 1.1.4 → 1.1.6

package/dist/index.d.ts

@@ -38,10 +38,25 @@ interface LogCallParams {
 declare class Notes extends APIResource {
     /**
      * List all notes for a specific lead.
+     *
+     * @param leadId - The unique ID of the lead.
+     * @example
+     * ```typescript
+     * const notes = await erixClient.crm.activities.notes.list("lead_123");
+     * ```
      */
     list<T = any>(leadId: string): Promise<T>;
     /**
-     * Add a note to a lead.
+     * Add a new descriptive note to a lead's profile.
+     *
+     * @param leadId - The unique ID of the lead.
+     * @param params - The note content.
+     * @example
+     * ```typescript
+     * await erixClient.crm.activities.notes.create("lead_123", {
+     *   content: "Customer is interested in the enterprise plan."
+     * });
+     * ```
      */
     create<T = any>(leadId: string, params: {
         content: string;
@@ -63,7 +78,14 @@ declare class Activities extends APIResource {
     notes: Notes;
     constructor(client: any);
     /**
-     * Retrieve the complete chronological timeline for a lead.
+     * Retrieve the complete chronological timeline of all activities for a lead.
+     *
+     * @param leadId - The unique ID of the lead.
+     * @param params - Optional pagination parameters.
+     * @example
+     * ```typescript
+     * const timeline = await erixClient.crm.activities.timeline("lead_123", { limit: 10 });
+     * ```
      */
     timeline<T = any>(leadId: string, params?: {
         page?: number;
@@ -78,7 +100,18 @@ declare class Activities extends APIResource {
         limit?: number;
     }): Promise<T>;
     /**
-     * Generic method to log a business activity/event.
+     * Generic method to log a business activity/event (e.g., system events, manual tasks).
+     *
+     * @param params - Activity details (leadId, type, title, body).
+     * @example
+     * ```typescript
+     * await erixClient.crm.activities.log({
+     *   leadId: "lead_123",
+     *   type: "system",
+     *   title: "Meeting Scheduled",
+     *   body: "Initial consultation booked for Friday."
+     * });
+     * ```
      */
     log<T = any>(params: LogActivityParams): Promise<T>;
     /**
@@ -96,65 +129,136 @@ interface AnalyticsParams {
 }
 declare class Analytics extends APIResource {
     /**
-     * KPIs: total leads, pipeline value, won revenue, avg score, conversion rate.
+     * Retrieve high-level CRM performance KPIs.
+     * Includes total leads, pipeline value, won revenue, and conversion rates.
+     *
+     * @param params - Optional filters including time range (24h, 7d, 30d, etc.) and custom date bounds.
+     * @returns {Promise<any>} KPI summary object containing core business metrics.
+     * @example
+     * ```typescript
+     * const stats = await erixClient.crm.analytics.overview({ range: "30d" });
+     * console.log(stats.avgScore);
+     * ```
      */
     overview<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Stage-by-stage lead counts and conversion percentages.
+     * Get stage-by-stage lead counts and conversion percentages for a pipeline.
+     * Useful for identifying funnel bottlenecks and drop-off points.
+     *
+     * @param pipelineId - The unique ID of the pipeline to analyze.
+     * @returns {Promise<any>} Array of funnel stages with count and conversion data.
+     * @example
+     * ```typescript
+     * const funnel = await erixClient.crm.analytics.funnel("pipe_123");
+     * ```
      */
     funnel<T = any>(pipelineId: string): Promise<T>;
     /**
-     * Revenue forecast: deal value × stage probability.
+     * Revenue forecast: Calculates expected revenue based on deal value × stage probability.
+     * Helps in sales planning and goal setting.
+     *
+     * @param pipelineId - Optional pipeline ID to filter the forecast.
+     * @returns {Promise<any>} Forecast data including weighted expected revenue.
+     * @example
+     * ```typescript
+     * const prognosis = await erixClient.crm.analytics.forecast("pipe_123");
+     * ```
      */
     forecast<T = any>(pipelineId?: string): Promise<T>;
     /**
-     * Lead source breakdown: count, conversion rate, total value per source.
+     * Lead source breakdown: count, conversion rate, and total value per source.
+     *
+     * @param params - Time range filters.
+     * @returns {Promise<any>} Breakdown of how different marketing channels are performing.
      */
     sources<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Team leaderboard: won deals, revenue, activity count, conversion rate per member.
+     * Team leaderboard: Evaluates agent performance across won deals, revenue, and activity.
+     *
+     * @param params - Time range filters.
+     * @returns {Promise<any>} Ranked list of team members by performance.
      */
     team<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Daily activity counts by type. For activity calendar.
+     * Activity heatmap: Daily activity counts by type.
+     * Ideal for visualizing engagement patterns on a calendar view.
+     *
+     * @param params - Time range filters.
+     * @returns {Promise<any>} Time-series data of team activities.
      */
     heatmap<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Score distribution: how many leads in each score bucket.
+     * Score distribution: Groups leads into buckets based on their calculated score (0-100).
+     *
+     * @returns {Promise<any>} Volume of leads in different readiness tiers.
      */
     scores<T = any>(): Promise<T>;
     /**
-     * Avg time leads spend in each stage. Helps find bottlenecks.
+     * Avg time in stage: Measures the velocity of leads through the sales pipeline.
+     *
+     * @param pipelineId - Target pipeline ID.
+     * @returns {Promise<any>} Velocity metrics per stage.
      */
     stageTime<T = any>(pipelineId: string): Promise<T>;
     /**
-     * Tiered Growth Report matching business sophistication.
+     * Tiered Growth Report matching business sophistication (Pulse, Growth, Weapon).
+     * Provides deep tactical and strategic insights.
+     *
+     * @param params - Filtering and range parameters.
      */
     tiered<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Consolidated analytics including CRM overview and WhatsApp.
+     * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
+     *
+     * @param params - Time range filters.
      */
     summary<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * WhatsApp volume and delivery analytics.
+     * Retrieve WhatsApp messaging volume and delivery performance analytics.
+     * Includes total sent, delivered, read, and daily volume trends.
+     *
+     * @param params - Optional filters (time range).
+     * @example
+     * ```typescript
+     * const waStats = await erixClient.crm.analytics.whatsapp({ range: "7d" });
+     * console.log(waStats.totalSent);
+     * ```
      */
     whatsapp<T = any>(params?: AnalyticsParams): Promise<T>;
 }
 
 declare class AutomationDashboard extends APIResource {
     /**
-     * Retrieve summary statistics for automation health.
+     * Retrieve summary statistics for automation health (total, success, failed).
+     *
+     * @returns Stats object.
+     * @example
+     * ```typescript
+     * const stats = await erixClient.crm.automationDashboard.stats();
+     * ```
      */
     stats<T = any>(): Promise<T>;
     /**
-     * List recent EventLog entries (automation logs).
+     * List recent EventLog entries representing automation executions.
+     *
+     * @param params - Optional filters (limit, status).
+     * @example
+     * ```typescript
+     * const logs = await erixClient.crm.automationDashboard.logs({ status: "failed" });
+     * ```
      */
     logs<T = any>(params?: {
         limit?: number;
         status?: string;
     }): Promise<T>;
     /**
-     * Re-emit a failed event log to process its automations again.
+     * Re-emit a failed event log to re-trigger its associated automation rules.
+     *
+     * @param logId - The unique ID of the failed event log.
+     * @example
+     * ```typescript
+     * await erixClient.crm.automationDashboard.retryFailedEvent("log_123");
+     * ```
      */
     retryFailedEvent<T = any>(logId: string): Promise<T>;
 }
@@ -168,11 +272,29 @@ interface AutomationRulePayload {
 }
 declare class Automations extends APIResource {
     /**
-     * List all automation rules for the tenant.
+     * List all automation rules (workflows) configured for the tenant.
+     *
+     * @returns Array of automation rule objects.
+     * @example
+     * ```typescript
+     * const rules = await erixClient.crm.automations.list();
+     * ```
      */
     list<T = any>(): Promise<T>;
     /**
-     * Create a new automation rule.
+     * Create a new automation rule with triggers and workflow nodes.
+     *
+     * @param payload - The automation rule definition (trigger, nodes, edges).
+     * @returns The created automation rule.
+     * @example
+     * ```typescript
+     * await erixClient.crm.automations.create({
+     *   name: "Welcome Email Workflow",
+     *   trigger: "contact_created",
+     *   nodes: [...],
+     *   edges: [...]
+     * });
+     * ```
      */
     create<T = any>(payload: AutomationRulePayload): Promise<T>;
     /**
@@ -192,7 +314,14 @@ declare class Automations extends APIResource {
      */
     bulkDelete<T = any>(ruleIds: string[]): Promise<T>;
     /**
-     * Dry-run test an automation rule against a specific lead.
+     * Dry-run test an automation rule against a specific lead to verify logic.
+     *
+     * @param ruleId - The ID of the rule to test.
+     * @param leadId - The ID of the lead to run the test against.
+     * @example
+     * ```typescript
+     * await erixClient.crm.automations.test("rule_123", "lead_456");
+     * ```
      */
     test<T = any>(ruleId: string, leadId: string): Promise<T>;
     /**
@@ -336,13 +465,28 @@ declare class Leads extends APIResource {
      *
      * @param params - Lead creation parameters. `firstName` is required.
      * @returns The newly created Lead document.
+     * @example
+     * ```typescript
+     * const lead = await erixClient.crm.leads.create({
+     *   firstName: "Alice",
+     *   phone: "+919876543210",
+     *   source: "website"
+     * });
+     * ```
      */
     create<T = any>(params: CreateLeadParams): Promise<T>;
     /**
-     * Upsert a lead by phone number. Creates if not exists, updates if exists.
+     * Upsert a lead by phone number. If a lead with the same phone exists,
+     * it will be updated; otherwise, a new lead is created.
      *
      * @param params - Upsert parameters containing leadData with a phone number.
      * @returns The newly created or updated Lead document.
+     * @example
+     * ```typescript
+     * await erixClient.crm.leads.upsert({
+     *   leadData: { phone: "+919876543210", firstName: "Alice" }
+     * });
+     * ```
      */
     upsert<T = any>(params: UpsertLeadParams): Promise<T>;
     /**
@@ -361,10 +505,18 @@ declare class Leads extends APIResource {
      */
     import<T = any>(leads: Partial<CreateLeadParams>[]): Promise<T>;
     /**
-     * List leads with optional filtering and pagination.
+     * List CRM leads with optional filtering and pagination.
      *
      * @param params - Filter options (status, source, pipelineId, page, limit, etc.)
      * @returns Paginated list of Lead documents.
+     * @example
+     * ```typescript
+     * const leads = await erixClient.crm.leads.list({
+     *   status: "new",
+     *   source: "website",
+     *   limit: 20
+     * });
+     * ```
      */
     list<T = any>(params?: ListLeadsParams): Promise<T>;
     /**
@@ -384,6 +536,10 @@ declare class Leads extends APIResource {
      *
      * @param leadId - The MongoDB ObjectId of the lead.
      * @returns The Lead document, or a 404 error if not found.
+     * @example
+     * ```typescript
+     * const lead = await erixClient.crm.leads.retrieve("64abc...");
+     * ```
      */
     retrieve<T = any>(leadId: string): Promise<T>;
     /**
@@ -405,6 +561,13 @@ declare class Leads extends APIResource {
      * @param leadId - The ID of the lead to update.
      * @param params - Partial lead fields to update.
      * @returns The updated Lead document.
+     * @example
+     * ```typescript
+     * await erixClient.crm.leads.update("64abc...", {
+     *   lastName: "Smith",
+     *   status: "qualified"
+     * });
+     * ```
      */
     update<T = any>(leadId: string, params: Partial<CreateLeadParams>): Promise<T>;
     /**
@@ -495,7 +658,18 @@ declare class Leads extends APIResource {
 
 declare class Payments extends APIResource {
     /**
-     * Record an inbound payment against a lead or appointment.
+     * Record an inbound payment/transaction against a lead or specific appointment.
+     *
+     * @param payload - Payment details (leadId, amount, currency, description).
+     * @example
+     * ```typescript
+     * await erixClient.crm.payments.capture({
+     *   leadId: "lead_123",
+     *   amount: 5000,
+     *   currency: "INR",
+     *   description: "Consultation Fee"
+     * });
+     * ```
      */
     capture<T = any>(payload: {
         leadId: string;
@@ -518,18 +692,40 @@ interface PipelineStageParams {
 }
 declare class Pipelines extends APIResource {
     /**
-     * List all pipelines and their stages.
+     * List all CRM pipelines and their configured stages.
+     *
+     * @returns Array of pipeline objects with nested stages.
+     * @example
+     * ```typescript
+     * const pipelines = await erixClient.crm.pipelines.list();
+     * ```
      */
     list<T = any>(): Promise<T>;
     /**
-     * Create a new pipeline.
+     * Create a new CRM sales or support pipeline.
+     *
+     * @param payload - Pipeline details (name and array of stage names).
+     * @returns The created pipeline record.
+     * @example
+     * ```typescript
+     * await erixClient.crm.pipelines.create({
+     *   name: "Sales Pipeline",
+     *   stages: ["Lead", "Contacted", "Proposal", "Negotiation", "Closed"]
+     * });
+     * ```
      */
     create<T = any>(payload: {
         name: string;
         stages: string[];
     }): Promise<T>;
     /**
-     * Retrieve a single pipeline by ID.
+     * Retrieve a single pipeline configuration by ID.
+     *
+     * @param pipelineId - The unique ID of the pipeline.
+     * @example
+     * ```typescript
+     * const pipeline = await erixClient.crm.pipelines.retrieve("pipe_123");
+     * ```
      */
     retrieve<T = any>(pipelineId: string): Promise<T>;
     /**
@@ -557,6 +753,12 @@ declare class Pipelines extends APIResource {
     delete(pipelineId: string): Promise<unknown>;
     /**
      * Retrieve a Kanban-style board representation of the pipeline with leads nested.
+     *
+     * @param pipelineId - The unique ID of the pipeline.
+     * @example
+     * ```typescript
+     * const board = await erixClient.crm.pipelines.board("pipe_123");
+     * ```
      */
     board<T = any>(pipelineId: string): Promise<T>;
     /**
@@ -565,6 +767,17 @@ declare class Pipelines extends APIResource {
     forecast<T = any>(pipelineId: string): Promise<T>;
     /**
      * Add a new stage to the pipeline.
+     *
+     * @param pipelineId - The unique ID of the pipeline.
+     * @param params - Stage details (name, color, probability).
+     * @example
+     * ```typescript
+     * await erixClient.crm.pipelines.addStage("pipe_123", {
+     *   name: "Decision Maker Bought In",
+     *   color: "#FF5733",
+     *   probability: 80
+     * });
+     * ```
      */
     addStage<T = any>(pipelineId: string, params: PipelineStageParams): Promise<T>;
     /**
@@ -576,7 +789,10 @@ declare class Pipelines extends APIResource {
      */
     updateStage<T = any>(stageId: string, params: Partial<PipelineStageParams>): Promise<T>;
     /**
-     * Delete a stage. Optionally provide a fallback stageId to move active leads to.
+     * Delete a stage permanently.
+     *
+     * @param stageId - The unique ID of the stage to delete.
+     * @param moveLeadsToStageId - Optional fallback stageId to move active leads to before deletion.
      */
     deleteStage(stageId: string, moveLeadsToStageId?: string): Promise<unknown>;
 }
@@ -591,7 +807,13 @@ interface ScoringConfig {
 }
 declare class Scoring extends APIResource {
     /**
-     * Retrieve the tenant's global lead scoring configuration.
+     * Retrieve the tenant's global lead scoring configuration (rules, decay, thresholds).
+     *
+     * @returns The scoring configuration object.
+     * @example
+     * ```typescript
+     * const config = await erixClient.crm.scoring.getConfig();
+     * ```
      */
     getConfig<T = any>(): Promise<T>;
     /**
@@ -599,14 +821,31 @@ declare class Scoring extends APIResource {
      */
     updateConfig<T = any>(payload: Partial<ScoringConfig>): Promise<T>;
     /**
-     * Force recalculate the score for a specific lead.
+     * Force an immediate score recalculation for a specific lead.
+     * Useful when profile data changes significantly.
+     *
+     * @param leadId - The unique ID of the lead.
+     * @example
+     * ```typescript
+     * await erixClient.crm.scoring.recalculate("lead_123");
+     * ```
      */
     recalculate<T = any>(leadId: string): Promise<T>;
 }
 
 declare class Sequences extends APIResource {
     /**
-     * Manually enroll a lead in a drip sequence (automation rule).
+     * Manually enroll a lead into a specific automation drip sequence (Workflow).
+     *
+     * @param payload - Enrollment details (leadId, ruleId, and custom variables).
+     * @example
+     * ```typescript
+     * await erixClient.crm.sequences.enroll({
+     *   leadId: "lead_123",
+     *   ruleId: "rule_456",
+     *   variables: { start_date: "2026-05-01" }
+     * });
+     * ```
      */
     enroll<T = any>(payload: {
         leadId: string;
@@ -614,11 +853,24 @@ declare class Sequences extends APIResource {
         variables?: Record<string, any>;
     }): Promise<T>;
     /**
-     * Unenroll a lead from a running sequence.
+     * Unenroll a lead from a currently running automation sequence.
+     *
+     * @param enrollmentId - The unique ID of the sequence enrollment.
+     * @example
+     * ```typescript
+     * await erixClient.crm.sequences.unenroll("enroll_123");
+     * ```
      */
     unenroll<T = any>(enrollmentId: string): Promise<unknown>;
     /**
-     * List active sequence enrollments for a specific lead.
+     * List all active and completed sequence enrollments for a specific lead.
+     *
+     * @param leadId - The unique ID of the lead.
+     * @returns Array of enrollment records.
+     * @example
+     * ```typescript
+     * const enrollments = await erixClient.crm.sequences.listForLead("lead_123");
+     * ```
      */
     listForLead<T = any>(leadId: string): Promise<T>;
 }
@@ -660,14 +912,26 @@ declare class EmailResource extends APIResource {
      * Send an HTML email campaign to a list of recipients.
      *
      * @param payload - The campaign details (recipients, subject, html).
-     * @returns The dispatch result.
+     * @returns The dispatch result indicating success or failure.
+     * @example
+     * ```typescript
+     * await erixClient.email.sendEmailCampaign({
+     *   recipients: ["user1@example.com", "user2@example.com"],
+     *   subject: "Monthly Newsletter",
+     *   html: "<h1>Hello!</h1><p>Check out our latest updates...</p>"
+     * });
+     * ```
      */
     sendEmailCampaign(payload: SendCampaignPayload): Promise<CampaignResult>;
     /**
-     * Send a system verification/test email to validate SMTP configuration.
+     * Send a system test email to validate your current SMTP configuration.
      *
      * @param to - The recipient's email address.
      * @returns The dispatch result.
+     * @example
+     * ```typescript
+     * await erixClient.email.sendTestEmail("admin@company.com");
+     * ```
      */
     sendTestEmail(to: string): Promise<CampaignResult>;
 }
@@ -761,7 +1025,13 @@ interface TriggerResponse {
 }
 declare class EventsResource extends APIResource {
     /**
-     * Retrieve all valid events (system + custom) that can be used as Automation Rule triggers.
+     * List all available event definitions (both system and custom) that can trigger automations.
+     *
+     * @returns Array of event definitions.
+     * @example
+     * ```typescript
+     * const events = await erixClient.events.list();
+     * ```
      */
     list(): Promise<{
         success: boolean;
@@ -790,8 +1060,20 @@ declare class EventsResource extends APIResource {
         message: string;
     }>;
     /**
-     * Programmatically fire an event into the CRM automation engine.
-     * Emits to the internal EventBus to match with active Workflow Automation Rules.
+     * Programmatically trigger an automation workflow by firing a specific event.
+     * This matches the event against active Automation Rules and executes linked actions.
+     *
+     * @param payload - The trigger details (event name, lead phone/email, variables).
+     * @returns Trigger response with diagnostic info (eventLogId, matched rules).
+     * @example
+     * ```typescript
+     * await erixClient.events.trigger({
+     *   trigger: "webinar_joined",
+     *   phone: "+919876543210",
+     *   variables: { webinar_name: "AI Masterclass" },
+     *   createLeadIfMissing: true
+     * });
+     * ```
      */
     trigger(payload: TriggerPayload): Promise<TriggerResponse>;
     /**
@@ -853,7 +1135,15 @@ interface JobStatus {
 }
 declare class Health extends APIResource {
     /**
-     * Global platform health check.
+     * Perform a global platform health check.
+     * Verify that the API, database, and background workers are operational.
+     *
+     * @returns System health summary (status, version, uptime).
+     * @example
+     * ```typescript
+     * const health = await erixClient.health.system();
+     * console.log(`API Status: ${health.status}`);
+     * ```
      */
     system(): Promise<SystemHealth>;
     /**
@@ -861,7 +1151,17 @@ declare class Health extends APIResource {
      */
     clientHealth(): Promise<ClientHealth>;
     /**
-     * Job execution status lookup.
+     * Lookup the execution status of a background job.
+     *
+     * @param jobId - The unique ID of the background job.
+     * @returns Job status report (attempts, error trace, completion time).
+     * @example
+     * ```typescript
+     * const status = await erixClient.health.jobStatus("job_123");
+     * if (status.status === "completed") {
+     *   console.log("Job finished successfully!");
+     * }
+     * ```
      */
     jobStatus(jobId: string): Promise<JobStatus>;
 }
@@ -873,7 +1173,18 @@ interface SendCampaignParams {
 }
 declare class Emails extends APIResource {
     /**
-     * Dispatch a bulk email campaign.
+     * Dispatch a bulk email campaign to a list of recipients.
+     *
+     * @param params - The campaign details (recipients, subject, html).
+     * @returns The dispatch result.
+     * @example
+     * ```typescript
+     * await erixClient.marketing.emails.sendCampaign({
+     *   recipients: ["user@example.com"],
+     *   subject: "Special Offer",
+     *   html: "<p>Check out our deal!</p>"
+     * });
+     * ```
      */
     sendCampaign<T = any>(params: SendCampaignParams): Promise<T>;
     /**
@@ -883,14 +1194,33 @@ declare class Emails extends APIResource {
 }
 declare class Campaigns extends APIResource {
     /**
-     * List email and SMS marketing campaigns.
+     * List all email and SMS marketing campaigns with optional status filtering.
+     *
+     * @param params - Optional filters (status, limit).
+     * @returns Paginated list of campaign objects.
+     * @example
+     * ```typescript
+     * const campaigns = await erixClient.marketing.campaigns.list({ status: "sent" });
+     * ```
      */
     list<T = any>(params?: {
         status?: string;
         limit?: number;
     }): Promise<T>;
     /**
-     * Create a new campaign.
+     * Create a new marketing campaign (Email or SMS).
+     *
+     * @param payload - Campaign details (name, type, content).
+     * @returns The created campaign record.
+     * @example
+     * ```typescript
+     * await erixClient.marketing.campaigns.create({
+     *   name: "Spring Sale",
+     *   type: "email",
+     *   subject: "Our Spring Sale is Here!",
+     *   html: "<h1>BIG DEALS!</h1>"
+     * });
+     * ```
      */
     create<T = any>(payload: {
         name: string;
@@ -901,7 +1231,13 @@ declare class Campaigns extends APIResource {
         recipients?: string[];
     }): Promise<T>;
     /**
-     * Retrieve campaign details.
+     * Retrieve full details for a specific marketing campaign.
+     *
+     * @param campaignId - The unique ID of the campaign.
+     * @example
+     * ```typescript
+     * const campaign = await erixClient.marketing.campaigns.retrieve("camp_123");
+     * ```
      */
     retrieve<T = any>(campaignId: string): Promise<T>;
     /**
@@ -913,13 +1249,35 @@ declare class Campaigns extends APIResource {
      */
     delete<T = any>(campaignId: string): Promise<T>;
     /**
-     * Send or schedule a campaign.
+     * Send a campaign immediately or schedule it for a later date.
+     *
+     * @param campaignId - The ID of the campaign to dispatch.
+     * @param payload - Optional scheduling information (ISO timestamp).
+     * @example
+     * ```typescript
+     * // Send immediately
+     * await erixClient.marketing.campaigns.send("camp_123");
+     *
+     * // Schedule for tomorrow
+     * await erixClient.marketing.campaigns.send("camp_123", {
+     *   scheduledAt: "2026-04-10T09:00:00Z"
+     * });
+     * ```
      */
     send<T = any>(campaignId: string, payload?: {
         scheduledAt?: string;
     }): Promise<T>;
     /**
-     * Get campaign stats (opens, clicks, bounces).
+     * Get detailed delivery and engagement statistics for a campaign.
+     * Includes opens, clicks, bounces, and delivery failures.
+     *
+     * @param campaignId - The ID of the campaign.
+     * @returns Stats summary object.
+     * @example
+     * ```typescript
+     * const report = await erixClient.marketing.campaigns.stats("camp_123");
+     * console.log(`Open Rate: ${report.openRate}%`);
+     * ```
      */
     stats<T = any>(campaignId: string): Promise<T>;
 }
@@ -927,8 +1285,18 @@ declare class WhatsAppMarketing extends APIResource {
     /**
      * Dispatch a template-based WhatsApp message with CRM-integrated variable resolution.
      *
-     * Unlike direct WhatsApp sending, this endpoint automatically pulls data from the CRM
+     * Unlike direct WhatsApp sending, this endpoint documentation automatically pulls data from the CRM
      * based on the provided variables mapping.
+     *
+     * @param params - Template details and recipient phone.
+     * @example
+     * ```typescript
+     * await erixClient.marketing.whatsapp.sendTemplate({
+     *   phone: "+919876543210",
+     *   templateName: "order_update",
+     *   variables: { "1": "Order #123" }
+     * });
+     * ```
      */
     sendTemplate<T = any>(params: {
         phone: string;
@@ -1346,26 +1714,46 @@ declare class Notifications extends APIResource {
      */
     listCallbacks(params?: Omit<LogFilter, "trigger" | "phone">): Promise<unknown>;
     /**
-     * List unread CRM notifications/alerts for the current tenant.
-     * Maps to: GET /api/crm/notifications
+     * List unread CRM notifications and alerts (e.g., lead assignments, system alerts).
+     *
+     * @param params - Optional filters (limit, unreadOnly).
+     * @returns Paginated list of notification objects.
+     * @example
+     * ```typescript
+     * const alerts = await erixClient.notifications.listAlerts({ unreadOnly: true });
+     * ```
      */
     listAlerts<T = any>(params?: {
         limit?: number;
         unreadOnly?: boolean;
     }): Promise<T>;
     /**
-     * Dismiss a specific notification alert.
-     * Maps to: PATCH /api/crm/notifications/:id/dismiss
+     * Dismiss/mark a specific notification alert as read.
+     *
+     * @param notificationId - The unique ID of the notification.
+     * @example
+     * ```typescript
+     * await erixClient.notifications.dismissAlert("alert_123");
+     * ```
      */
     dismissAlert<T = any>(notificationId: string): Promise<T>;
     /**
-     * Clear (dismiss) all notifications for the current tenant.
-     * Maps to: DELETE /api/crm/notifications/clear-all
+     * Clear all notifications for the current tenant immediately.
+     *
+     * @example
+     * ```typescript
+     * await erixClient.notifications.clearAllAlerts();
+     * ```
      */
     clearAllAlerts<T = any>(): Promise<T>;
     /**
      * Retry an action from a notification (e.g. failed automation send).
-     * Maps to: POST /api/crm/notifications/:id/retry
+     *
+     * @param notificationId - The unique ID of the notification.
+     * @example
+     * ```typescript
+     * await erixClient.notifications.retryAction("alert_123");
+     * ```
      */
     retryAction<T = any>(notificationId: string): Promise<T>;
 }
@@ -1379,26 +1767,57 @@ interface JobStats {
 }
 declare class Queue extends APIResource {
     /**
-     * List all failed jobs.
+     * List all background jobs that have failed execution.
+     *
+     * @returns Array of failed job objects.
+     * @example
+     * ```typescript
+     * const failed = await erixClient.queue.listFailed();
+     * ```
      */
     listFailed<T = any>(): Promise<T>;
     /**
-     * Get queue health statistics.
+     * Get real-time health statistics for the background job queue (waiting, active, failed).
+     *
+     * @returns Queue statistics summary.
+     * @example
+     * ```typescript
+     * const stats = await erixClient.queue.getStats();
+     * console.log(`Active Jobs: ${stats.active}`);
+     * ```
      */
     getStats<T = JobStats>(): Promise<T>;
     /**
-     * Retry a failed job.
+     * Manually retry a failed background job.
+     *
+     * @param jobId - The unique ID of the failed job.
+     * @example
+     * ```typescript
+     * await erixClient.queue.retryJob("job_123");
+     * ```
      */
     retryJob<T = any>(jobId: string): Promise<T>;
     /**
      * Remove a job from the queue.
+     *
+     * @param jobId - The unique ID of the job to delete.
+     * @example
+     * ```typescript
+     * await erixClient.queue.deleteJob("job_123");
+     * ```
      */
     deleteJob<T = any>(jobId: string): Promise<T>;
 }
 
 declare class Folders extends APIResource {
     /**
-     * Create a new folder.
+     * Create a new folder in the tenant's cloud storage.
+     *
+     * @param name - The name of the folder to create.
+     * @example
+     * ```typescript
+     * await erixClient.storage.folders.create("Invoices");
+     * ```
      */
     create<T = any>(name: string): Promise<T>;
     /**
@@ -1408,7 +1827,14 @@ declare class Folders extends APIResource {
 }
 declare class Files extends APIResource {
     /**
-     * List files in a folder.
+     * List files within a specific folder.
+     *
+     * @param folder - The folder name or path.
+     * @param params - Optional year/month filters for organized storage.
+     * @example
+     * ```typescript
+     * const files = await erixClient.storage.files.list("Invoices", { year: "2026" });
+     * ```
      */
     list<T = any>(folder: string, params?: {
         year?: string;
@@ -1416,6 +1842,18 @@ declare class Files extends APIResource {
     }): Promise<T>;
     /**
      * Get a presigned upload URL for direct-to-cloud browser uploads.
+     * This allows the client to upload files directly to R2/S3 without hitting the backend.
+     *
+     * @param params - Upload parameters (folder, filename, contentType).
+     * @example
+     * ```typescript
+     * const { data } = await erixClient.storage.files.getUploadUrl({
+     *   folder: "Invoices",
+     *   filename: "inv_1.pdf",
+     *   contentType: "application/pdf"
+     * });
+     * // Now use data.url with a PUT request
+     * ```
      */
     getUploadUrl<T = any>(params: {
         folder: string;
@@ -1557,13 +1995,70 @@ interface CreateBroadcastParams {
 }
 declare class Broadcasts extends APIResource {
     /**
-     * List past and active broadcasts.
+     * List past and active WhatsApp broadcast campaigns.
+     *
+     * @param params - Optional filter parameters (page, limit, status).
+     * @returns Paginated list of broadcast records.
+     * @example
+     * ```typescript
+     * const broadcasts = await erixClient.whatsapp.broadcasts.list({ limit: 10 });
+     * ```
      */
     list<T = any>(params?: Record<string, any>): Promise<T>;
     /**
-     * Create a new broadcast to send a template message to multiple recipients.
+     * Retrieve full details and real-time stats for a specific broadcast campaign.
+     *
+     * @param id - The unique identifier of the broadcast.
+     * @returns The broadcast record including sent/failed counts.
+     * @example
+     * ```typescript
+     * const stats = await erixClient.whatsapp.broadcasts.retrieve("bc_123");
+     * console.log(`Success Rate: ${(stats.sentCount / stats.totalRecipients) * 100}%`);
+     * ```
+     */
+    retrieve<T = any>(id: string): Promise<T>;
+    /**
+     * Create a new broadcast campaign to send template messages to multiple recipients.
+     *
+     * @param params - Broadcast configuration (name, templateName, recipients).
+     * @returns The newly created broadcast record.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.broadcasts.create({
+     *   name: "Spring Sale",
+     *   templateName: "promo_code",
+     *   recipients: [
+     *     { phone: "+919876543210", variables: ["SAVE10"] }
+     *   ]
+     * });
+     * ```
      */
     create<T = any>(params: CreateBroadcastParams): Promise<T>;
+    /**
+     * Update broadcast metadata, such as its name or administrative status.
+     *
+     * @param id - The unique ID of the broadcast.
+     * @param data - The fields to update (name, status).
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.broadcasts.update("bc_123", { name: "Revised Spring Sale" });
+     * ```
+     */
+    update<T = any>(id: string, data: {
+        name?: string;
+        status?: string;
+    }): Promise<T>;
+    /**
+     * Delete a broadcast campaign record.
+     * Note: This does not cancel messages already in flight but removes the record from the dashboard.
+     *
+     * @param id - The unique ID of the broadcast.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.broadcasts.delete("bc_123");
+     * ```
+     */
+    delete<T = any>(id: string): Promise<T>;
 }
 
 interface ListParams {
@@ -1575,12 +2070,28 @@ interface ListParams {
 declare class Conversations extends APIResource {
     /**
      * List conversations for the tenant.
+     * @deprecated Use `list` method from `ErixClient` instead.
+     * @param params - List parameters.
+     * @returns List of conversations.
+     * @example
+     * ```typescript
+     * import { ErixClient } from "erix-react";
+     * const erixClient = new ErixClient({ apiKey: "YOUR_API_KEY" });
+     * const conversations = await erixClient.whatsapp.conversations.list();
+     * ```
      */
     list<T = any>(params?: ListParams): Promise<T>;
     /**
      * Create a new conversation explicitly.
      *
      * @param params - Conversation details.
+     * @example
+     * ```typescript
+     * const conversation = await erixClient.whatsapp.conversations.create({
+     *   phone: "+919876543210",
+     *   name: "John Doe"
+     * });
+     * ```
      */
     create<T = any>(params: {
         phone: string;
@@ -1588,26 +2099,65 @@ declare class Conversations extends APIResource {
     }): Promise<T>;
     /**
      * Retrieve details of a specific conversation.
+     *
+     * @param conversationId - The unique ID of the conversation.
+     * @example
+     * ```typescript
+     * const conversation = await erixClient.whatsapp.conversations.retrieve("conv_123");
+     * ```
      */
     retrieve<T = any>(conversationId: string): Promise<T>;
     /**
      * Get messages for a specific conversation.
+     *
+     * @param conversationId - The unique ID of the conversation.
+     * @param params - Pagination and filter parameters.
+     * @example
+     * ```typescript
+     * const messages = await erixClient.whatsapp.conversations.messages("conv_123", { limit: 50 });
+     * ```
      */
     messages<T = any>(conversationId: string, params?: ListParams): Promise<T>;
     /**
-     * Link a conversation to a lead.
+     * Link a conversation to a lead in the CRM.
+     *
+     * @param conversationId - The unique ID of the conversation.
+     * @param leadId - The unique ID of the lead to link.
+     * @param leadData - Optional additional lead metadata.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.conversations.linkLead("conv_123", "lead_456");
+     * ```
      */
     linkLead<T = any>(conversationId: string, leadId: string, leadData?: any): Promise<T>;
     /**
      * Mark a conversation as read (clear unread count).
+     *
+     * @param conversationId - The unique ID of the conversation.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.conversations.markRead("conv_123");
+     * ```
      */
     markRead<T = any>(conversationId: string): Promise<T>;
     /**
      * Delete a conversation.
+     *
+     * @param conversationId - The unique ID of the conversation.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.conversations.delete("conv_123");
+     * ```
      */
     delete(conversationId: string): Promise<unknown>;
     /**
      * Bulk delete conversations.
+     *
+     * @param ids - Array of conversation IDs to delete.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.conversations.bulkDelete(["conv_1", "conv_2"]);
+     * ```
      */
     bulkDelete<T = any>(ids: string[]): Promise<T>;
 }
@@ -1700,26 +2250,26 @@ declare class Messages extends APIResource {
      * Send a free-text or media message to a WhatsApp number.
      *
      * For text-only messages, supply `text`. For media, supply `mediaUrl`
-     * and `mediaType`. Both can be combined.
+     * and `mediaType`. Both can be combined in a single message.
      *
-     * @param params - Message parameters.
-     * @returns The created message record.
+     * @param params - Message parameters including recipient, text, and media.
+     * @returns The created message record from the database.
      *
-     * @example Text message
+     * @example Send a simple text message
      * ```typescript
-     * await ecod.whatsapp.messages.send({
+     * await erixClient.whatsapp.messages.send({
      *   to: "+919876543210",
-     *   text: "Hello!",
+     *   text: "Hello from Ecodrix!",
      * });
      * ```
      *
-     * @example Media message
+     * @example Send an image with a caption
      * ```typescript
-     * await ecod.whatsapp.messages.send({
+     * await erixClient.whatsapp.messages.send({
      *   to: "+919876543210",
-     *   mediaUrl: "https://cdn.ecodrix.com/invoice.pdf",
-     *   mediaType: "document",
-     *   filename: "invoice.pdf",
+     *   text: "Check out this flyer",
+     *   mediaUrl: "https://example.com/flyer.jpg",
+     *   mediaType: "image",
      * });
      * ```
      */
@@ -1727,20 +2277,20 @@ declare class Messages extends APIResource {
     /**
      * Send a pre-approved WhatsApp Business template message.
      *
-     * Templates must be approved in Meta Business Manager before use.
-     * Variable placeholders in the template body are filled left-to-right
-     * from the `variables` array.
+     * Templates must be approved in Meta Business Manager before they can be sent.
+     * Variable placeholders (e.g., {{1}}, {{2}}) are replaced with values from the
+     * `variables` array in order.
      *
-     * @param params - Template message parameters.
+     * @param params - Template message configuration (name, language, variables).
      * @returns The created message record.
      *
      * @example
      * ```typescript
-     * await ecod.whatsapp.messages.sendTemplate({
+     * await erixClient.whatsapp.messages.sendTemplate({
      *   to: "+919876543210",
-     *   templateName: "appointment_reminder",
+     *   templateName: "welcome_user",
      *   language: "en_US",
-     *   variables: ["Alice", "10 April", "10:00 AM"],
+     *   variables: ["Alice"], // Replaces {{1}} in template
      * });
      * ```
      */
@@ -1802,7 +2352,14 @@ interface TemplateMapping {
 }
 declare class Templates extends APIResource {
     /**
-     * List all templates from the tenant database.
+     * List all WhatsApp message templates in the tenant database.
+     *
+     * @param params - Optional filter parameters (status, mappingStatus, channel).
+     * @returns List of message templates.
+     * @example
+     * ```typescript
+     * const templates = await erixClient.whatsapp.templates.list({ status: "APPROVED" });
+     * ```
      */
     list<T = any>(params?: {
         status?: string;
@@ -1810,54 +2367,108 @@ declare class Templates extends APIResource {
         channel?: string;
     }): Promise<T>;
     /**
-     * Synchronize templates from Meta API.
+     * Synchronize templates from the Meta WhatsApp Business API.
+     * This updates the local database with the latest template status and content from Meta.
+     *
+     * @returns Success status of the sync operation.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.templates.sync();
+     * ```
      */
     sync<T = any>(): Promise<T>;
     /**
-     * Get template details.
+     * Retrieve details of a specific WhatsApp template.
+     *
+     * @param templateIdentifier - The name or ID of the template.
+     * @returns Detailed template object including components and status.
+     * @example
+     * ```typescript
+     * const template = await erixClient.whatsapp.templates.retrieve("welcome_message");
+     * ```
      */
     retrieve<T = any>(templateIdentifier: string): Promise<T>;
     /**
-     * Create a new template manually.
+     * Create a new WhatsApp template manually (Draft).
+     *
+     * @param payload - Template configuration (name, category, language, components).
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.templates.create({
+     *   name: "new_promotion",
+     *   category: "MARKETING",
+     *   language: "en_US",
+     *   components: [...]
+     * });
+     * ```
      */
     create<T = any>(payload: any): Promise<T>;
     /**
-     * Update an existing template.
+     * Update an existing WhatsApp template.
+     *
+     * @param templateId - The unique ID of the template.
+     * @param payload - Updated template configuration.
      */
     update<T = any>(templateId: string, payload: any): Promise<T>;
     /**
-     * Delete a template.
+     * Delete a WhatsApp template from both the local database and Meta (if specified).
+     *
+     * @param templateName - The name of the template to delete.
+     * @param force - If true, attempts to delete from Meta API as well.
+     * @example
+     * ```typescript
+     * await erixClient.whatsapp.templates.deleteTemplate("old_template", true);
+     * ```
      */
     deleteTemplate<T = any>(templateName: string, force?: boolean): Promise<T>;
     /**
-     * List curated mapping config options.
+     * List available configuration options for variable mapping.
+     *
+     * @example
+     * ```typescript
+     * const config = await erixClient.whatsapp.templates.mappingConfig();
+     * ```
      */
     mappingConfig<T = any>(): Promise<T>;
     /**
-     * List CRM collections for variable mapping.
+     * List CRM collections available for variable mapping (Leads, Deals, etc.).
      */
     collections<T = any>(): Promise<T>;
     /**
-     * List CRM fields for a collection.
+     * List fields for a specific CRM collection to be used in mapping.
+     *
+     * @param collectionName - The name of the CRM collection.
      */
     collectionFields<T = any>(collectionName: string): Promise<T>;
     /**
-     * Update variable mappings for a template.
+     * Update variable mappings for a template to automate personalization.
+     *
+     * @param templateName - Name of the template.
+     * @param payload - Mapping definitions.
      */
     updateMapping<T = any>(templateName: string, payload: TemplateMapping): Promise<T>;
     /**
-     * Validate mapping readiness.
+     * Validate if a template is ready for automated sending based on its mappings.
      */
     validate<T = any>(templateName: string): Promise<T>;
     /**
-     * Preview a template resolution.
+     * 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>;
     /**
-     * Check automation usage of a template.
+     * Check which automations or sequences are currently using this template.
      */
     checkUsage<T = any>(templateName: string): Promise<T>;
 }