@ecodrix/erix-api 1.0.1 → 1.0.4

package/dist/index.d.cts

@@ -0,0 +1,1979 @@
+import type { AxiosInstance, AxiosRequestConfig, Method } from "axios";
+
+interface RequestOptions extends AxiosRequestConfig {
+  /**
+   * If true, will not add the x-client-code header.
+   */
+  ignoreClientCode?: boolean;
+  /**
+   * Safe execution idempotency key.
+   * If provided, the backend will safely ignore duplicate requests retried with the same key.
+   */
+  idempotencyKey?: string;
+}
+declare abstract class APIResource {
+  protected readonly client: AxiosInstance;
+  constructor(client: AxiosInstance);
+  protected post<T>(url: string, data?: any, options?: RequestOptions): Promise<T>;
+  protected get<T>(url: string, options?: RequestOptions): Promise<T>;
+  protected patch<T>(url: string, data?: any, options?: RequestOptions): Promise<T>;
+  protected put<T>(url: string, data?: any, options?: RequestOptions): Promise<T>;
+  protected deleteRequest<T>(url: string, options?: RequestOptions): Promise<T>;
+  private buildConfig;
+  private handleError;
+}
+
+/**
+ * Parameters for sending a free-form WhatsApp message.
+ */
+interface SendMessageParams {
+  /**
+   * Recipient's phone number in E.164 format.
+   * @example "+919876543210"
+   */
+  to: string;
+  /** Plain text body of the message. */
+  text?: string;
+  /** Public URL of the media asset to send. */
+  mediaUrl?: string;
+  /** MIME category of the media. */
+  mediaType?: "image" | "video" | "audio" | "document";
+  /** The `messageId` of the message to reply to (quoted replies). */
+  replyToId?: string;
+  /** Filename shown to the recipient (required for `document` type). */
+  filename?: string;
+  /** Arbitrary metadata stored with the message record. */
+  metadata?: Record<string, any>;
+}
+/**
+ * Parameters for sending a pre-approved WhatsApp Business template.
+ */
+interface SendTemplateParams {
+  /**
+   * Recipient's phone number in E.164 format.
+   * @example "+919876543210"
+   */
+  to: string;
+  /** The exact template name as approved in Meta Business Manager. */
+  templateName: string;
+  /**
+   * BCP-47 language code for the template.
+   * @default "en_US"
+   */
+  language?: string;
+  /**
+   * Ordered array of variable substitutions for template placeholders.
+   * @example ["Alice", "10 April 2026", "10:00 AM"]
+   */
+  variables?: string[];
+  /** Optional header media URL (for templates with media headers). */
+  mediaUrl?: string;
+  /** Media type for the header (e.g. "image", "document"). */
+  mediaType?: string;
+}
+/**
+ * WhatsApp outbound messaging resource.
+ *
+ * Access via `ecod.whatsapp.messages`.
+ *
+ * @example
+ * ```typescript
+ * await ecod.whatsapp.messages.send({
+ *   to: "+919876543210",
+ *   text: "Your appointment is confirmed!",
+ * });
+ * ```
+ */
+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.
+   *
+   * @param params - Message parameters.
+   * @returns The created message record.
+   *
+   * @example Text message
+   * ```typescript
+   * await ecod.whatsapp.messages.send({
+   *   to: "+919876543210",
+   *   text: "Hello!",
+   * });
+   * ```
+   *
+   * @example Media message
+   * ```typescript
+   * await ecod.whatsapp.messages.send({
+   *   to: "+919876543210",
+   *   mediaUrl: "https://cdn.ecodrix.com/invoice.pdf",
+   *   mediaType: "document",
+   *   filename: "invoice.pdf",
+   * });
+   * ```
+   */
+  send(params: SendMessageParams): Promise<unknown>;
+  /**
+   * 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.
+   *
+   * @param params - Template message parameters.
+   * @returns The created message record.
+   *
+   * @example
+   * ```typescript
+   * await ecod.whatsapp.messages.sendTemplate({
+   *   to: "+919876543210",
+   *   templateName: "appointment_reminder",
+   *   language: "en_US",
+   *   variables: ["Alice", "10 April", "10:00 AM"],
+   * });
+   * ```
+   */
+  sendTemplate(params: SendTemplateParams): Promise<unknown>;
+  /**
+   * Star or unstar a message.
+   *
+   * @param messageId - The ID of the message.
+   * @param isStarred - Boolean indicating whether to star or unstar.
+   */
+  star<T = any>(messageId: string, isStarred: boolean): Promise<T>;
+  /**
+   * React to a message with an emoji.
+   *
+   * @param messageId - The ID of the message.
+   * @param reaction - The emoji (e.g. "👍") to react with, or empty string to remove.
+   */
+  react<T = any>(messageId: string, reaction: string): Promise<T>;
+  /**
+   * Mark all messages in a conversation as read (double-tick).
+   *
+   * @param conversationId - The conversation to mark as read.
+   *
+   * @example
+   * ```typescript
+   * await ecod.whatsapp.messages.markRead("conv_64abc...");
+   * ```
+   */
+  markRead(conversationId: string): Promise<unknown>;
+}
+
+interface ListParams {
+  limit?: number;
+  before?: string;
+  after?: string;
+  status?: string;
+}
+declare class Conversations extends APIResource {
+  /**
+   * List conversations for the tenant.
+   */
+  list<T = any>(params?: ListParams): Promise<T>;
+  /**
+   * Create a new conversation explicitly.
+   *
+   * @param params - Conversation details.
+   */
+  create<T = any>(params: {
+    phone: string;
+    name?: string;
+  }): Promise<T>;
+  /**
+   * Retrieve details of a specific conversation.
+   */
+  retrieve<T = any>(conversationId: string): Promise<T>;
+  /**
+   * Get messages for a specific conversation.
+   */
+  messages<T = any>(conversationId: string, params?: ListParams): Promise<T>;
+  /**
+   * Link a conversation to a lead.
+   */
+  linkLead<T = any>(conversationId: string, leadId: string, leadData?: any): Promise<T>;
+  /**
+   * Delete a conversation.
+   */
+  delete(conversationId: string): Promise<unknown>;
+  /**
+   * Bulk delete conversations.
+   */
+  bulkDelete(ids: string[]): Promise<unknown>;
+}
+
+interface CreateBroadcastParams {
+  templateName: string;
+  recipients: string[];
+}
+declare class Broadcasts extends APIResource {
+  /**
+   * List past and active broadcasts.
+   */
+  list<T = any>(params?: Record<string, any>): Promise<T>;
+  /**
+   * Create a new broadcast to send a template message to multiple recipients.
+   */
+  create<T = any>(params: CreateBroadcastParams): Promise<T>;
+}
+
+interface TemplateMapping {
+  mappings: any[];
+  onEmptyVariable: string;
+}
+declare class Templates extends APIResource {
+  /**
+   * List all templates from the tenant database.
+   */
+  list<T = any>(params?: {
+    status?: string;
+    mappingStatus?: string;
+    channel?: string;
+  }): Promise<T>;
+  /**
+   * Synchronize templates from Meta API.
+   */
+  sync<T = any>(): Promise<T>;
+  /**
+   * Get template details.
+   */
+  retrieve<T = any>(templateIdentifier: string): Promise<T>;
+  /**
+   * Create a new template manually.
+   */
+  create<T = any>(payload: any): Promise<T>;
+  /**
+   * Update an existing template.
+   */
+  update<T = any>(templateId: string, payload: any): Promise<T>;
+  /**
+   * Delete a template.
+   */
+  deleteTemplate<T = any>(templateName: string, force?: boolean): Promise<T>;
+  /**
+   * List curated mapping config options.
+   */
+  mappingConfig<T = any>(): Promise<T>;
+  /**
+   * List CRM collections for variable mapping.
+   */
+  collections<T = any>(): Promise<T>;
+  /**
+   * List CRM fields for a collection.
+   */
+  collectionFields<T = any>(collectionName: string): Promise<T>;
+  /**
+   * Update variable mappings for a template.
+   */
+  updateMapping<T = any>(templateName: string, payload: TemplateMapping): Promise<T>;
+  /**
+   * Validate mapping readiness.
+   */
+  validate<T = any>(templateName: string): Promise<T>;
+  /**
+   * Preview a template resolution.
+   */
+  preview<T = any>(
+    templateName: string,
+    context: {
+      lead?: any;
+      vars?: any;
+    },
+  ): Promise<T>;
+  /**
+   * Check automation usage of a template.
+   */
+  checkUsage<T = any>(templateName: string): Promise<T>;
+}
+
+interface SendTemplatePayload {
+  /** Phone number in E.164 format. */
+  phone: string;
+  /** Name of the pre-approved WhatsApp template. */
+  templateName: string;
+  /** Language code (defaults to "en"). */
+  languageCode?: string;
+  /** Key-value pairs matching variables in your template (e.g., {{1}}, {{2}}). */
+  variables?: Record<string, string>;
+  /** Explicitly resolved variables if bypassing the internal resolution engine. */
+  resolvedVariables?: any[];
+}
+declare class WhatsApp extends APIResource {
+  messages: Messages;
+  conversations: Conversations;
+  broadcasts: Broadcasts;
+  templates: Templates;
+  constructor(client: AxiosInstance);
+  /**
+   * Upload an asset directly to chat storage.
+   */
+  upload<T = any>(file: Blob | Buffer | File | any, filename: string): Promise<T>;
+  /**
+   * Dispatch a WhatsApp template message directly to a specific phone number.
+   * Bypasses the automation queue for immediate high-priority delivery.
+   *
+   * @param payload - The template dispatch payload.
+   * @returns Information about the dispatched message.
+   */
+  sendTemplate(payload: SendTemplatePayload): Promise<{
+    success: boolean;
+    messageId?: string;
+    templateName?: string;
+    resolvedVariables?: any[];
+  }>;
+}
+
+/**
+ * Valid statuses for a CRM Lead.
+ */
+type LeadStatus = "new" | "contacted" | "qualified" | "won" | "lost" | "archived";
+/**
+ * Common lead acquisition sources. Additional string values are allowed.
+ */
+type LeadSource = "website" | "whatsapp" | "direct" | "referral" | string;
+/**
+ * Parameters for creating a new CRM Lead.
+ */
+interface CreateLeadParams {
+  /** Lead's first name. Required. */
+  firstName: string;
+  /** Lead's last name. */
+  lastName?: string;
+  /** Lead's email address. */
+  email?: string;
+  /** Lead's phone number in E.164 format (e.g. "+919876543210"). */
+  phone?: string;
+  /**
+   * Acquisition channel.
+   */
+  source?: LeadSource;
+  /** Arbitrary key-value metadata (UTM params, order IDs, etc.). */
+  metadata?: Record<string, any>;
+  /** Pipeline ID to assign the lead */
+  pipelineId?: string;
+  /** Stage ID to assign the lead */
+  stageId?: string;
+}
+/**
+ * Options for listing leads.
+ */
+interface ListLeadsParams {
+  status?: LeadStatus;
+  pipelineId?: string;
+  stageId?: string;
+  source?: LeadSource;
+  assignedTo?: string;
+  tags?: string[] | string;
+  minScore?: number;
+  search?: string;
+  startDate?: string;
+  endDate?: string;
+  appointmentId?: string;
+  bookingId?: string;
+  orderId?: string;
+  meetingId?: string;
+  page?: number;
+  limit?: number;
+  sortBy?: string;
+  sortDir?: "asc" | "desc";
+}
+/**
+ * Options for upserting a lead.
+ */
+interface UpsertLeadParams {
+  leadData: Partial<CreateLeadParams> & {
+    phone: string;
+    name?: string;
+  };
+  moduleInfo?: any;
+  trigger?: string;
+  pipelineId?: string;
+  stageId?: string;
+}
+/**
+ * CRM Lead resource — full lifecycle management.
+ *
+ * Access via `ecod.crm.leads`.
+ *
+ * @example
+ * ```typescript
+ * const { data: lead } = await ecod.crm.leads.create({
+ *   firstName: "Alice",
+ *   phone: "+919876543210",
+ *   source: "website",
+ * });
+ * ```
+ */
+declare class Leads extends APIResource {
+  /**
+   * Create a new lead in the CRM pipeline.
+   *
+   * @param params - Lead creation parameters. `firstName` is required.
+   * @returns The newly created Lead document.
+   */
+  create<T = any>(params: CreateLeadParams): Promise<T>;
+  /**
+   * Upsert a lead by phone number. Creates if not exists, updates if exists.
+   *
+   * @param params - Upsert parameters containing leadData with a phone number.
+   * @returns The newly created or updated Lead document.
+   */
+  upsert<T = any>(params: UpsertLeadParams): Promise<T>;
+  /**
+   * Bulk ingest leads efficiently in parallel using automatic chunking.
+   * Prevents rate limit exhaustion by executing `chunkSize` requests at a time.
+   *
+   * @param leads - Array of leads to create.
+   * @param chunkSize - Number of leads to send concurrently (default: 50)
+   * @returns Array of created lead results.
+   */
+  createMany(leads: CreateLeadParams[], chunkSize?: number): Promise<any[]>;
+  /**
+   * Bulk upsert (import) leads.
+   *
+   * @param leads - Array of leads to import.
+   */
+  import<T = any>(leads: Partial<CreateLeadParams>[]): Promise<T>;
+  /**
+   * List leads with optional filtering and pagination.
+   *
+   * @param params - Filter options (status, source, pipelineId, page, limit, etc.)
+   * @returns Paginated list of Lead documents.
+   */
+  list<T = any>(params?: ListLeadsParams): Promise<T>;
+  /**
+   * Auto-paginating iterator for leads.
+   * Seamlessly fetches leads page by page as you iterate.
+   */
+  listAutoPaging(params?: ListLeadsParams): AsyncGenerator<any, void, unknown>;
+  /**
+   * Retrieve a single lead by its unique ID.
+   *
+   * @param leadId - The MongoDB ObjectId of the lead.
+   * @returns The Lead document, or a 404 error if not found.
+   */
+  retrieve<T = any>(leadId: string): Promise<T>;
+  /**
+   * Retrieve a single lead by its phone number.
+   *
+   * @param phone - Lead's phone number.
+   */
+  retrieveByPhone<T = any>(phone: string): Promise<T>;
+  /**
+   * Retrieve a single lead by a reference key and value.
+   *
+   * @param refKey - Reference key metadata.
+   * @param refValue - Reference value.
+   */
+  retrieveByRef<T = any>(refKey: string, refValue: string): Promise<T>;
+  /**
+   * Update the fields of an existing lead.
+   *
+   * @param leadId - The ID of the lead to update.
+   * @param params - Partial lead fields to update.
+   * @returns The updated Lead document.
+   */
+  update<T = any>(leadId: string, params: Partial<CreateLeadParams>): Promise<T>;
+  /**
+   * Move a lead to a new stage in a pipeline.
+   *
+   * @param leadId - ID of the lead.
+   * @param stageId - Target stage ID.
+   */
+  move<T = any>(leadId: string, stageId: string): Promise<T>;
+  /**
+   * Convert a lead (mark as won or lost with reason).
+   *
+   * @param leadId - ID of the lead.
+   * @param outcome - "won" | "lost"
+   * @param reason - Reason for the outcome.
+   */
+  convert<T = any>(leadId: string, outcome: "won" | "lost", reason?: string): Promise<T>;
+  /**
+   * Update the tags of a lead.
+   *
+   * @param leadId - ID of the lead.
+   * @param options - Tags to add or remove.
+   */
+  tags<T = any>(
+    leadId: string,
+    options: {
+      add?: string[];
+      remove?: string[];
+    },
+  ): Promise<T>;
+  /**
+   * Recalculate lead score based on activities and interactions.
+   *
+   * @param leadId - ID of the lead.
+   */
+  recalculateScore<T = any>(leadId: string): Promise<T>;
+  /**
+   * Update embedded metadata/references of a lead without touching core fields.
+   *
+   * @param leadId - ID of the lead.
+   * @param metadata - Metadata object indicating { refs, extra }
+   */
+  updateMetadata<T = any>(
+    leadId: string,
+    metadata: {
+      refs?: Record<string, any>;
+      extra?: Record<string, any>;
+    },
+  ): Promise<T>;
+  /**
+   * Introspect available custom fields configured by the tenant limit.
+   */
+  fields<T = any>(): Promise<T>;
+  /**
+   * Archive (soft-delete) a single lead.
+   *
+   * @param leadId - The ID of the lead to archive.
+   */
+  delete(leadId: string): Promise<unknown>;
+  /**
+   * Bulk archive multiple leads.
+   *
+   * @param ids - Array of lead IDs to archive.
+   */
+  bulkDelete(ids: string[]): Promise<unknown>;
+}
+
+interface CreatePipelineParams {
+  name: string;
+  isDefault?: boolean;
+  stages?: any[];
+}
+interface PipelineStageParams {
+  name: string;
+  color?: string;
+  probability?: number;
+}
+declare class Pipelines extends APIResource {
+  /**
+   * List all pipelines matching the optional query parameters.
+   */
+  list<T = any>(params?: Record<string, any>): Promise<T>;
+  /**
+   * Create a new pipeline.
+   */
+  create<T = any>(params: CreatePipelineParams): Promise<T>;
+  /**
+   * Retrieve a single pipeline.
+   */
+  retrieve<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Update a pipeline's details.
+   */
+  update<T = any>(
+    pipelineId: string,
+    params: {
+      name?: string;
+      description?: string;
+    },
+  ): Promise<T>;
+  /**
+   * Set pipeline as the tenant's default.
+   */
+  setDefault<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Duplicate a pipeline with a new name.
+   */
+  duplicate<T = any>(pipelineId: string, newName: string): Promise<T>;
+  /**
+   * Archive a pipeline.
+   */
+  archive<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Delete a pipeline permanently.
+   */
+  delete(pipelineId: string): Promise<unknown>;
+  /**
+   * Retrieve a Kanban-style board representation of the pipeline with leads nested.
+   */
+  board<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Retrieve a revenue forecast based on stage probabilities for a pipeline.
+   */
+  forecast<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Add a new stage to the pipeline.
+   */
+  addStage<T = any>(pipelineId: string, params: PipelineStageParams): Promise<T>;
+  /**
+   * Change the order of stages inside the pipeline.
+   */
+  reorderStages<T = any>(pipelineId: string, orderArray: string[]): Promise<T>;
+  /**
+   * Update a specific stage.
+   */
+  updateStage<T = any>(stageId: string, params: Partial<PipelineStageParams>): Promise<T>;
+  /**
+   * Delete a stage. Optionally provide a fallback stageId to move active leads to.
+   */
+  deleteStage(stageId: string, moveLeadsToStageId?: string): Promise<unknown>;
+}
+
+interface LogActivityParams {
+  leadId: string;
+  type: "note" | "call" | "email" | "meeting" | "whatsapp" | "system";
+  title: string;
+  body?: string;
+  metadata?: Record<string, any>;
+}
+interface LogCallParams {
+  durationMinutes: number;
+  summary: string;
+  outcome: "answered" | "no_answer" | "busy" | "voicemail" | "wrong_number";
+}
+declare class Notes extends APIResource {
+  /**
+   * List all notes for a specific lead.
+   */
+  list<T = any>(leadId: string): Promise<T>;
+  /**
+   * Add a note to a lead.
+   */
+  create<T = any>(
+    leadId: string,
+    params: {
+      content: string;
+    },
+  ): Promise<T>;
+  /**
+   * Update an existing note.
+   */
+  update<T = any>(noteId: string, content: string): Promise<T>;
+  /**
+   * Pin or unpin a note to the top of the feed.
+   */
+  pin<T = any>(noteId: string, isPinned?: boolean): Promise<T>;
+  /**
+   * Delete a note.
+   */
+  delete(noteId: string): Promise<unknown>;
+}
+declare class Activities extends APIResource {
+  notes: Notes;
+  constructor(client: any);
+  /**
+   * Retrieve the complete chronological timeline for a lead.
+   */
+  timeline<T = any>(
+    leadId: string,
+    params?: {
+      page?: number;
+      limit?: number;
+    },
+  ): Promise<T>;
+  /**
+   * List specific activities (filtered by type).
+   */
+  list<T = any>(
+    leadId: string,
+    params?: {
+      type?: string;
+      page?: number;
+      limit?: number;
+    },
+  ): Promise<T>;
+  /**
+   * Generic method to log a business activity/event.
+   */
+  log<T = any>(params: LogActivityParams): Promise<T>;
+  /**
+   * Specific method to log communication outcomes.
+   */
+  logCall<T = any>(leadId: string, params: LogCallParams): Promise<T>;
+}
+
+type AnalyticsRange = "24h" | "7d" | "30d" | "60d" | "90d" | "365d";
+interface AnalyticsParams {
+  range?: AnalyticsRange;
+  from?: string;
+  to?: string;
+  pipelineId?: string;
+}
+declare class Analytics extends APIResource {
+  /**
+   * KPIs: total leads, pipeline value, won revenue, avg score, conversion rate.
+   */
+  overview<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * Stage-by-stage lead counts and conversion percentages.
+   */
+  funnel<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Revenue forecast: deal value × stage probability.
+   */
+  forecast<T = any>(pipelineId?: string): Promise<T>;
+  /**
+   * Lead source breakdown: count, conversion rate, total value per source.
+   */
+  sources<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * Team leaderboard: won deals, revenue, activity count, conversion rate per member.
+   */
+  team<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * Daily activity counts by type. For activity calendar.
+   */
+  heatmap<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * Score distribution: how many leads in each score bucket.
+   */
+  scores<T = any>(): Promise<T>;
+  /**
+   * Avg time leads spend in each stage. Helps find bottlenecks.
+   */
+  stageTime<T = any>(pipelineId: string): Promise<T>;
+  /**
+   * Tiered Growth Report matching business sophistication.
+   */
+  tiered<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * Consolidated analytics including CRM overview and WhatsApp.
+   */
+  summary<T = any>(params?: AnalyticsParams): Promise<T>;
+  /**
+   * WhatsApp volume and delivery analytics.
+   */
+  whatsapp<T = any>(params?: AnalyticsParams): Promise<T>;
+}
+
+interface AutomationRulePayload {
+  name: string;
+  trigger: string;
+  isActive?: boolean;
+  nodes: any[];
+  edges: any[];
+}
+declare class Automations extends APIResource {
+  /**
+   * List all automation rules for the tenant.
+   */
+  list<T = any>(): Promise<T>;
+  /**
+   * Create a new automation rule.
+   */
+  create<T = any>(payload: AutomationRulePayload): Promise<T>;
+  /**
+   * Update an existing automation rule.
+   */
+  update<T = any>(ruleId: string, payload: Partial<AutomationRulePayload>): Promise<T>;
+  /**
+   * Enable or disable an automation rule.
+   */
+  toggle<T = any>(ruleId: string): Promise<T>;
+  /**
+   * Delete an automation rule.
+   */
+  deleteRule<T = any>(ruleId: string): Promise<T>;
+  /**
+   * Bulk delete rules.
+   */
+  bulkDelete<T = any>(ruleIds: string[]): Promise<T>;
+  /**
+   * Dry-run test an automation rule against a specific lead.
+   */
+  test<T = any>(ruleId: string, leadId: string): Promise<T>;
+  /**
+   * List enrollments for a rule.
+   */
+  enrollments<T = any>(ruleId: string): Promise<T>;
+  /**
+   * Get an enrollment detail.
+   */
+  getEnrollment<T = any>(enrollmentId: string): Promise<T>;
+  /**
+   * Pause an enrollment.
+   */
+  pauseEnrollment<T = any>(ruleId: string, enrollmentId: string): Promise<T>;
+  /**
+   * Resume an enrollment.
+   */
+  resumeEnrollment<T = any>(ruleId: string, enrollmentId: string): Promise<T>;
+  /**
+   * List workflow runs.
+   */
+  runs<T = any>(ruleId: string): Promise<T>;
+  /**
+   * Get run details.
+   */
+  getRun<T = any>(runId: string): Promise<T>;
+  /**
+   * Resume a paused run.
+   */
+  resumeRun<T = any>(runId: string): Promise<T>;
+  /**
+   * Abort a running workflow.
+   */
+  abortRun<T = any>(runId: string): Promise<T>;
+  /**
+   * Emit an external webhook event to unlock a `wait_event` node inside a
+   * paused workflow run. Required when integrating third-party tools that
+   * need to resume a suspended automation.
+   *
+   * @param ruleId - The automation rule that contains the wait_event node.
+   * @param eventName - The event name that should match the node's condition.
+   * @param payload - Arbitrary data forwarded to the node context.
+   */
+  webhookEvent<T = any>(ruleId: string, eventName: string, payload?: any): Promise<T>;
+}
+
+declare class Sequences extends APIResource {
+  /**
+   * Manually enroll a lead in a drip sequence (automation rule).
+   */
+  enroll<T = any>(payload: {
+    leadId: string;
+    ruleId: string;
+    variables?: Record<string, any>;
+  }): Promise<T>;
+  /**
+   * Unenroll a lead from a running sequence.
+   */
+  unenroll<T = any>(enrollmentId: string): Promise<T>;
+  /**
+   * List active sequence enrollments for a specific lead.
+   */
+  listForLead<T = any>(leadId: string): Promise<T>;
+}
+
+interface ScoringConfig {
+  decayDays: number;
+  thresholds: {
+    hot: number;
+    warm: number;
+  };
+  rules: any[];
+}
+declare class Scoring extends APIResource {
+  /**
+   * Retrieve the tenant's global lead scoring configuration.
+   */
+  getConfig<T = any>(): Promise<T>;
+  /**
+   * Update scoring configuration.
+   */
+  updateConfig<T = any>(payload: Partial<ScoringConfig>): Promise<T>;
+  /**
+   * Force recalculate the score for a specific lead.
+   */
+  recalculate<T = any>(leadId: string): Promise<T>;
+}
+
+declare class Payments extends APIResource {
+  /**
+   * Record an inbound payment against a lead or appointment.
+   */
+  capture<T = any>(payload: {
+    leadId: string;
+    amount: number;
+    currency?: string;
+    description?: string;
+    appointmentId?: string;
+  }): Promise<T>;
+}
+
+declare class AutomationDashboard extends APIResource {
+  /**
+   * Retrieve summary statistics for automation health.
+   */
+  stats<T = any>(): Promise<T>;
+  /**
+   * List recent EventLog entries (automation logs).
+   */
+  logs<T = any>(params?: {
+    limit?: number;
+    status?: string;
+  }): Promise<T>;
+  /**
+   * Re-emit a failed event log to process its automations again.
+   */
+  retryFailedEvent<T = any>(logId: string): Promise<T>;
+}
+
+declare class CRM {
+  leads: Leads;
+  pipelines: Pipelines;
+  activities: Activities;
+  analytics: Analytics;
+  automations: Automations;
+  sequences: Sequences;
+  scoring: Scoring;
+  payments: Payments;
+  automationDashboard: AutomationDashboard;
+  constructor(client: AxiosInstance);
+}
+
+/**
+ * Options for the `upload()` elite helper.
+ */
+interface UploadOptions {
+  /**
+   * The destination folder key in R2.
+   * @example "customer_documents" | "avatars" | "invoices"
+   */
+  folder: string;
+  /**
+   * The desired filename, including extension.
+   * @example "contract.pdf" | "profile.jpg"
+   */
+  filename: string;
+  /**
+   * The MIME type of the file.
+   * @example "application/pdf" | "image/jpeg" | "video/mp4"
+   */
+  contentType: string;
+}
+/**
+ * Cloudflare R2-backed media resource.
+ *
+ * Access via `ecod.media`.
+ *
+ * The `upload()` method is the recommended approach. It acts as a client-side
+ * orchestrator: it fetches a presigned URL from the backend, uploads directly
+ * to R2 (bypassing the API server), then confirms the upload — all in one call.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await ecod.media.upload(fileBuffer, {
+ *   folder: "invoices",
+ *   filename: "invoice-001.pdf",
+ *   contentType: "application/pdf",
+ * });
+ * console.log(data.url); // → https://cdn.ecodrix.com/invoices/invoice-001.pdf
+ * ```
+ */
+declare class MediaResource extends APIResource {
+  /**
+   * Get current storage usage metrics for the tenant.
+   *
+   * @returns `{ usedMB, limitMB, fileCount }`
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.media.getUsage();
+   * console.log(`${data.usedMB} / ${data.limitMB} MB used`);
+   * ```
+   */
+  getUsage(): Promise<unknown>;
+  /**
+   * Create a new top-level folder in the tenant's R2 bucket.
+   *
+   * @param name - Folder name (alphanumeric, hyphens, underscores).
+   *
+   * @example
+   * ```typescript
+   * await ecod.media.createFolder("patient_records");
+   * ```
+   */
+  createFolder(name: string): Promise<unknown>;
+  /**
+   * List files within a specific folder, with optional date filtering.
+   *
+   * @param folder - The folder key to list.
+   * @param params - Optional `year` and `month` filters (e.g. `{ year: "2026", month: "04" }`).
+   * @returns Array of file metadata objects.
+   *
+   * @example
+   * ```typescript
+   * const { data: files } = await ecod.media.list("invoices", { year: "2026" });
+   * ```
+   */
+  list(
+    folder: string,
+    params?: {
+      year?: string;
+      month?: string;
+    },
+  ): Promise<unknown>;
+  /**
+   * Delete a file from R2 by its storage key.
+   *
+   * @param key - The full storage key of the file (e.g. `"invoices/contract.pdf"`).
+   *
+   * @example
+   * ```typescript
+   * await ecod.media.delete("invoices/old-contract.pdf");
+   * ```
+   */
+  delete(key: string): Promise<unknown>;
+  /**
+   * Request a temporary presigned download URL for a private file.
+   *
+   * @param key - The full storage key of the file.
+   * @returns `{ url }` — a time-limited download URL.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.media.getDownloadUrl("invoices/contract.pdf");
+   * // → { url: "https://cdn.ecodrix.com/...?token=..." }
+   * ```
+   */
+  getDownloadUrl(key: string): Promise<unknown>;
+  /**
+   * **Elite Upload Helper** — uploads a file to Cloudflare R2 in a single call.
+   *
+   * This orchestrates 3 steps transparently:
+   * 1. Fetch a presigned `PUT` URL from the ECODrIx backend.
+   * 2. Upload the file _directly_ to R2 (no API proxy, maximum throughput).
+   * 3. Confirm the upload with the backend so it is indexed and tracked.
+   *
+   * Works with Node.js `Buffer`, browser `File`/`Blob`, or any stream-like
+   * object that Axios can PUT.
+   *
+   * @param file - The file data to upload.
+   * @param options - Folder, filename, and content type.
+   * @returns Confirmed file metadata including `key` and `url`.
+   *
+   * @example Node.js
+   * ```typescript
+   * import { readFileSync } from "fs";
+   * const buf = readFileSync("./invoice.pdf");
+   * const { data } = await ecod.media.upload(buf, {
+   *   folder: "invoices",
+   *   filename: "invoice-001.pdf",
+   *   contentType: "application/pdf",
+   * });
+   * ```
+   *
+   * @example Browser
+   * ```typescript
+   * const file = inputElement.files[0];
+   * const { data } = await ecod.media.upload(file, {
+   *   folder: "avatars",
+   *   filename: file.name,
+   *   contentType: file.type,
+   * });
+   * ```
+   */
+  upload(file: any, options: UploadOptions): Promise<any>;
+}
+
+/**
+ * Parameters for scheduling a new Google Meet appointment.
+ */
+interface CreateMeetingParams {
+  /** The CRM Lead ID this meeting belongs to. */
+  leadId: string;
+  /** Full name of the external participant. */
+  participantName: string;
+  /** Phone number of the participant in E.164 format. */
+  participantPhone: string;
+  /**
+   * Meeting start time.
+   * @example new Date("2026-04-10T10:00:00.000Z")
+   */
+  startTime: Date | string;
+  /**
+   * Meeting end time.
+   * @example new Date("2026-04-10T10:30:00.000Z")
+   */
+  endTime: Date | string;
+  /** Arbitrary metadata to attach to the meeting record. */
+  metadata?: Record<string, any>;
+}
+/**
+ * Parameters for updating an existing meeting.
+ */
+interface UpdateMeetingParams {
+  /**
+   * Update the meeting status.
+   * @example "scheduled" | "completed" | "cancelled"
+   */
+  status?: string;
+  /** Update the payment status for paid consultations. */
+  paymentStatus?: string;
+  /** New start time for rescheduling. */
+  startTime?: Date | string;
+  /** New end time for rescheduling. */
+  endTime?: Date | string;
+  /** Duration in minutes. */
+  duration?: number;
+}
+/**
+ * Google Meet appointment scheduling resource.
+ *
+ * Access via `ecod.meet`.
+ *
+ * @example
+ * ```typescript
+ * const { data } = await ecod.meet.create({
+ *   leadId: "64abc...",
+ *   participantName: "Alice",
+ *   participantPhone: "+919876543210",
+ *   startTime: "2026-04-10T10:00:00Z",
+ *   endTime: "2026-04-10T10:30:00Z",
+ * });
+ * console.log(data.meetLink); // → https://meet.google.com/abc-defg-hij
+ * ```
+ */
+declare class Meetings extends APIResource {
+  /**
+   * Schedule a new Google Meet with a lead.
+   *
+   * The backend automatically creates a Google Calendar event and generates
+   * a Meet link, then sends confirmation notifications via WhatsApp.
+   *
+   * @param data - Meeting details.
+   * @returns The created Meeting document including `meetLink`.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.meet.create({
+   *   leadId: "64abc...",
+   *   participantName: "Alice",
+   *   participantPhone: "+91...",
+   *   startTime: "2026-04-10T10:00:00Z",
+   *   endTime: "2026-04-10T10:30:00Z",
+   * });
+   * ```
+   */
+  create(data: CreateMeetingParams): Promise<any>;
+  /**
+   * List all meetings for the tenant, with optional filters.
+   *
+   * @param params - `leadId` to filter by lead; `status` to filter by state.
+   * @returns Array of Meeting documents.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.meet.list({ status: "scheduled" });
+   * ```
+   */
+  list(params?: {
+    leadId?: string;
+    status?: string;
+  }): Promise<any>;
+  /**
+   * Retrieve the full details for a specific meeting.
+   *
+   * @param meetingId - The unique meeting ID.
+   * @returns The Meeting document.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.meet.retrieve("meeting_id");
+   * ```
+   */
+  retrieve(meetingId: string): Promise<any>;
+  /**
+   * Update or reschedule an existing meeting.
+   *
+   * Partial updates are supported — only supply the fields you wish to change.
+   *
+   * @param meetingId - The meeting to update.
+   * @param data - Fields to update.
+   * @returns The updated Meeting document.
+   *
+   * @example
+   * ```typescript
+   * // Reschedule
+   * await ecod.meet.update("meeting_id", {
+   *   startTime: "2026-04-11T11:00:00Z",
+   *   endTime: "2026-04-11T11:30:00Z",
+   * });
+   * ```
+   */
+  update<T = any>(meetingId: string, data: UpdateMeetingParams): Promise<T>;
+  /**
+   * Reschedule an existing meeting. Provides explicit method for time modifications.
+   */
+  reschedule<T = any>(
+    meetingId: string,
+    params: {
+      startTime: Date | string;
+      endTime: Date | string;
+      duration?: number;
+    },
+  ): Promise<T>;
+  /**
+   * Cancel a meeting. This sets the meeting status to `"cancelled"`.
+   *
+   * @param meetingId - The meeting to cancel.
+   *
+   * @example
+   * ```typescript
+   * await ecod.meet.delete("meeting_id");
+   * ```
+   */
+  delete(meetingId: string): Promise<any>;
+}
+
+/**
+ * Filters for querying event and automation execution logs.
+ */
+interface LogFilter {
+  /** Page number for pagination (1-indexed). */
+  page?: number;
+  /** Maximum number of records to return per page. */
+  limit?: number;
+  /**
+   * Filter by automation trigger name.
+   * @example "lead_created" | "appointment_booked"
+   */
+  trigger?: string;
+  /**
+   * Filter by execution status.
+   * @example "success" | "failed" | "pending"
+   */
+  status?: string;
+  /** Filter logs associated with a specific phone number. */
+  phone?: string;
+  /** Start of the date range (inclusive). ISO 8601 or Date object. */
+  startDate?: string | Date;
+  /** End of the date range (inclusive). ISO 8601 or Date object. */
+  endDate?: string | Date;
+}
+/**
+ * Automation event log and provider callback resource.
+ *
+ * Access via `ecod.notifications`.
+ *
+ * This resource is **read-only**. It exposes platform audit trails — useful
+ * for debugging automation failures, monitoring webhook callbacks, and
+ * building internal ops dashboards.
+ *
+ * @example
+ * ```typescript
+ * // Find failed automations in April
+ * const { data } = await ecod.notifications.listLogs({
+ *   status: "failed",
+ *   startDate: "2026-04-01",
+ *   endDate: "2026-04-30",
+ * });
+ * ```
+ */
+declare class Notifications extends APIResource {
+  /**
+   * List automation execution logs with optional filtering.
+   *
+   * Each log entry represents one automation run triggered by a platform event.
+   * Filter by `status: "failed"` to build a failure alerting pipeline.
+   *
+   * @param params - Optional filter criteria.
+   * @returns Paginated list of event log objects.
+   *
+   * @example
+   * ```typescript
+   * const { data: failed } = await ecod.notifications.listLogs({
+   *   status: "failed",
+   *   trigger: "lead_created",
+   *   limit: 50,
+   * });
+   * ```
+   */
+  listLogs(params?: LogFilter): Promise<unknown>;
+  /**
+   * Retrieve the full details for a single automation event log entry.
+   *
+   * @param logId - The unique log ID.
+   * @returns A single event log document including the payload and error trace.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.notifications.retrieveLog("log_64abc...");
+   * console.log(data.error);  // → "Provider timeout after 30s"
+   * ```
+   */
+  retrieveLog(logId: string): Promise<unknown>;
+  /**
+   * Get a summary statistics object for automation event execution.
+   *
+   * @param params - Optional date range for the summary window.
+   * @returns `{ total, success, failed, pending }` counts.
+   *
+   * @example
+   * ```typescript
+   * const { data: stats } = await ecod.notifications.getStats({
+   *   startDate: "2026-04-01",
+   *   endDate: "2026-04-30",
+   * });
+   * console.log(`Failed: ${stats.failed} / ${stats.total}`);
+   * ```
+   */
+  getStats(params?: {
+    startDate?: string;
+    endDate?: string;
+  }): Promise<unknown>;
+  /**
+   * List external provider webhook callback logs.
+   *
+   * These are inbound HTTP callbacks from third-party providers
+   * (payment gateways, email services, etc.) stored for audit purposes.
+   *
+   * @param params - Pagination and date filter options.
+   * @returns Paginated list of callback log records.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.notifications.listCallbacks({ limit: 20 });
+   * ```
+   */
+  listCallbacks(params?: Omit<LogFilter, "trigger" | "phone">): Promise<unknown>;
+  /**
+   * List active CRM notifications/alerts for the current agent.
+   */
+  listAlerts<T = any>(params?: {
+    limit?: number;
+    unreadOnly?: boolean;
+  }): Promise<T>;
+  /**
+   * Dismiss a specific notification alert.
+   */
+  dismissAlert<T = any>(notificationId: string): Promise<T>;
+  /**
+   * Clear (dismiss) all notifications for the current agent.
+   */
+  clearAllAlerts<T = any>(): Promise<T>;
+  /**
+   * Retry an action from a notification (e.g. failed send).
+   */
+  retryAction<T = any>(notificationId: string): Promise<T>;
+}
+
+/**
+ * Payload to send a high-throughput email campaign.
+ */
+interface SendCampaignPayload {
+  /** Array of recipient email addresses. */
+  recipients: string[];
+  /** Subject line of the email. */
+  subject: string;
+  /** HTML body of the email. */
+  html: string;
+}
+/**
+ * Interface representing the result of a campaign dispatch.
+ */
+interface CampaignResult {
+  success: boolean;
+  message?: string;
+  [key: string]: any;
+}
+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.
+   */
+  sendEmailCampaign(payload: SendCampaignPayload): Promise<CampaignResult>;
+  /**
+   * Send a system verification/test email to validate SMTP configuration.
+   *
+   * @param to - The recipient's email address.
+   * @returns The dispatch result.
+   */
+  sendTestEmail(to: string): Promise<CampaignResult>;
+}
+
+/**
+ * Event definition representing an entry point capable of triggering automations.
+ */
+interface EventDefinition {
+  name: string;
+  displayName: string;
+  description?: string;
+  pipelineId?: string;
+  stageId?: string;
+  defaultSource?: string;
+  [key: string]: any;
+}
+/**
+ * Payload to register/assign a new custom event definition.
+ */
+interface AssignEventPayload {
+  /** The internal machine-readable name of the event (e.g. "webinar_joined") */
+  name: string;
+  /** Human-readable display name */
+  displayName: string;
+  /** Event description */
+  description?: string;
+  /** ID of the pipeline to associate with matching leads */
+  pipelineId?: string;
+  /** ID of the stage within the pipeline */
+  stageId?: string;
+  /** Default source tag for leads created via this event */
+  defaultSource?: string;
+}
+/**
+ * Payload to programmatically trigger an event/workflow.
+ */
+interface TriggerPayload {
+  /** The name of the event to fire (e.g., "webinar_joined") */
+  trigger: string;
+  /** Phone number of the lead (E.164 format) */
+  phone: string;
+  /** Email of the lead */
+  email?: string;
+  /** Key-value pairs for string templates */
+  variables?: Record<string, string>;
+  /** Deep payload data mapping to the event */
+  data?: any;
+  /** URL to receive an acknowledgment callback when processing completes */
+  callbackUrl?: string;
+  /** Secret metadata passed back to the callback URL */
+  callbackMetadata?: any;
+  /** Auto-create lead if phone does not exist in CRM */
+  createLeadIfMissing?: boolean;
+  /** Pre-fill data if creating a new lead */
+  leadData?: {
+    firstName?: string;
+    lastName?: string;
+    source?: string;
+  };
+  /** Delay execution of matched workflows (in seconds) */
+  delaySeconds?: number;
+  /** Delay execution of matched workflows (in minutes) */
+  delayMinutes?: number;
+  /** Explicit ISO timestamp to trigger the workflow run */
+  runAt?: string;
+}
+/**
+ * Response returned when triggering an event.
+ */
+interface TriggerResponse {
+  success: boolean;
+  data?: {
+    eventLogId: string;
+    trigger: string;
+    leadId: string;
+    rulesMatched: number;
+  };
+  message?: string;
+  code?: string;
+}
+declare class EventsResource extends APIResource {
+  /**
+   * Retrieve all valid events (system + custom) that can be used as Automation Rule triggers.
+   */
+  list(): Promise<{
+    success: boolean;
+    data: EventDefinition[];
+  }>;
+  /**
+   * Register a new custom event entry point into the CRM automation engine.
+   * Useful when introducing new granular triggers.
+   */
+  assign(payload: AssignEventPayload): Promise<{
+    success: boolean;
+    data: EventDefinition;
+  }>;
+  /**
+   * Deactivate a custom event assignment by name.
+   */
+  unassign(name: string): Promise<{
+    success: boolean;
+    data: any;
+  }>;
+  /**
+   * Deactivate multiple custom event assignments simultaneously.
+   */
+  unassignBulk(names: string[]): Promise<{
+    success: boolean;
+    message: string;
+  }>;
+  /**
+   * Programmatically fire an event into the CRM automation engine.
+   * Emits to the internal EventBus to match with active Workflow Automation Rules.
+   */
+  trigger(payload: TriggerPayload): Promise<TriggerResponse>;
+  /**
+   * List all custom event definitions.
+   */
+  listCustomEvents<T = any>(): Promise<T>;
+  /**
+   * Create or upsert a custom event definition.
+   */
+  createCustomEvent<T = any>(payload: {
+    name: string;
+    displayName: string;
+    description?: string;
+  }): Promise<T>;
+  /**
+   * Delete a custom event definition.
+   */
+  deleteCustomEvent<T = any>(id: string): Promise<T>;
+  /**
+   * Manually emit a custom event to trigger workflows based on its definition.
+   */
+  emit<T = any>(payload: {
+    eventName: string;
+    leadId: string;
+    data?: any;
+  }): Promise<T>;
+}
+
+/**
+ * Typed error hierarchy for the @ecodrix/erix-api SDK.
+ *
+ * All errors thrown by the SDK extend `EcodrixError`, so a single
+ * `catch` block can handle them all, while still allowing granular
+ * differentiation between auth failures, rate limits, and generic API errors.
+ *
+ * @example
+ * ```typescript
+ * import { APIError, AuthenticationError, RateLimitError } from "@ecodrix/erix-api";
+ *
+ * try {
+ *   await ecod.crm.leads.retrieve("invalid_id");
+ * } catch (err) {
+ *   if (err instanceof AuthenticationError) {
+ *     console.error("Invalid API key or client code.");
+ *   } else if (err instanceof RateLimitError) {
+ *     console.warn("Slow down — rate limit hit.");
+ *   } else if (err instanceof APIError) {
+ *     console.error(`API error ${err.status}: ${err.message}`);
+ *   }
+ * }
+ * ```
+ */
+/** Base class for all ECODrIx SDK errors. */
+declare class EcodrixError extends Error {
+  constructor(message: string);
+}
+/**
+ * Represents an error returned by the ECODrIx API.
+ * Carries the HTTP `status` code and an optional `code` string.
+ */
+declare class APIError extends EcodrixError {
+  /** HTTP status code returned by the API (e.g. 400, 404, 500). */
+  status?: number;
+  /** Machine-readable error code (e.g. `"NOT_FOUND"`, `"VALIDATION_ERROR"`). */
+  code?: string;
+  constructor(message: string, status?: number, code?: string);
+}
+/**
+ * Thrown when the API key or client code is missing, invalid, or expired.
+ * HTTP 401.
+ */
+declare class AuthenticationError extends APIError {
+  constructor(message?: string);
+}
+/**
+ * Thrown when the rate limit for the API key has been exceeded.
+ * HTTP 429. Implement exponential backoff before retrying.
+ */
+declare class RateLimitError extends APIError {
+  constructor(message?: string);
+}
+
+declare class WebhookSignatureError extends APIError {
+  constructor(message: string);
+}
+/**
+ * Validates and constructs webhook events sent by the ECODrIx platform.
+ * Ensures the payload has not been tampered with.
+ *
+ * @example
+ * ```typescript
+ * import { ecod } from "./services/ecodrix";
+ *
+ * app.post("/api/webhooks", async (req, res) => {
+ *   try {
+ *     const event = await ecod.webhooks.constructEvent(
+ *       req.rawBody,
+ *       req.headers["x-ecodrix-signature"],
+ *       process.env.ECOD_WEBHOOK_SECRET
+ *     );
+ *     console.log("Verified event:", event.type);
+ *     res.send({ received: true });
+ *   } catch (err) {
+ *     res.status(400).send(`Webhook Error: ${err.message}`);
+ *   }
+ * });
+ * ```
+ */
+declare class Webhooks {
+  /**
+   * Cryptographically validates a webhook payload.
+   * Note: This method dynamically imports Node's `crypto` module, meaning it will only execute gracefully in a Server environment.
+   *
+   * @param payload - The raw request body as a string or Buffer.
+   * @param signature - The `x-ecodrix-signature` header value.
+   * @param secret - The webhook signing secret for your tenant.
+   * @returns The parsed JSON object of the event if the signature is valid.
+   * @throws WebhookSignatureError if the validation fails.
+   */
+  constructEvent(
+    payload: string | Buffer,
+    signature: string | string[] | undefined,
+    secret: string,
+  ): Promise<any>;
+}
+
+declare class Folders extends APIResource {
+  /**
+   * Create a new folder.
+   */
+  create<T = any>(name: string): Promise<T>;
+  /**
+   * Delete a folder and its contents.
+   */
+  delete<T = any>(folderPath: string): Promise<T>;
+}
+declare class Files extends APIResource {
+  /**
+   * List files in a folder.
+   */
+  list<T = any>(
+    folder: string,
+    params?: {
+      year?: string;
+      month?: string;
+    },
+  ): Promise<T>;
+  /**
+   * Get a presigned upload URL for direct-to-cloud browser uploads.
+   */
+  getUploadUrl<T = any>(params: {
+    folder: string;
+    filename: string;
+    contentType: string;
+  }): Promise<T>;
+  /**
+   * Notify backend after a successful direct browser upload.
+   */
+  confirmUpload<T = any>(params: {
+    key: string;
+    sizeBytes: number;
+  }): Promise<T>;
+  /**
+   * Get a presigned download URL for an R2 key.
+   */
+  getDownloadUrl<T = any>(key: string): Promise<T>;
+  /**
+   * Delete a file by key.
+   */
+  delete(key: string): Promise<unknown>;
+}
+declare class Storage extends APIResource {
+  folders: Folders;
+  files: Files;
+  constructor(client: any);
+  /**
+   * Get tenant storage usage and quota limitations.
+   */
+  usage<T = any>(): Promise<T>;
+}
+
+interface SendCampaignParams {
+  recipients: string[];
+  subject: string;
+  html: string;
+}
+declare class Emails extends APIResource {
+  /**
+   * Dispatch a bulk email campaign.
+   */
+  sendCampaign<T = any>(params: SendCampaignParams): Promise<T>;
+  /**
+   * Send a test verification email (used to verify SMTP functionality).
+   */
+  sendTest<T = any>(to: string): Promise<T>;
+}
+declare class Campaigns extends APIResource {
+  /**
+   * List email and SMS marketing campaigns.
+   */
+  list<T = any>(params?: {
+    status?: string;
+    limit?: number;
+  }): Promise<T>;
+  /**
+   * Create a new campaign.
+   */
+  create<T = any>(payload: {
+    name: string;
+    type: string;
+    subject?: string;
+    html?: string;
+    templateId?: string;
+    recipients?: string[];
+  }): Promise<T>;
+  /**
+   * Retrieve campaign details.
+   */
+  retrieve<T = any>(campaignId: string): Promise<T>;
+  /**
+   * Update a campaign.
+   */
+  update<T = any>(campaignId: string, payload: any): Promise<T>;
+  /**
+   * Delete a campaign.
+   */
+  delete<T = any>(campaignId: string): Promise<T>;
+  /**
+   * Send or schedule a campaign.
+   */
+  send<T = any>(
+    campaignId: string,
+    payload?: {
+      scheduledAt?: string;
+    },
+  ): Promise<T>;
+  /**
+   * Get campaign stats (opens, clicks, bounces).
+   */
+  stats<T = any>(campaignId: string): Promise<T>;
+}
+declare class Marketing extends APIResource {
+  emails: Emails;
+  campaigns: Campaigns;
+  constructor(client: any);
+}
+
+interface SystemHealth {
+  status: string;
+  version: string;
+  env: string;
+  uptime: number;
+  db: string;
+  queueDepth: number;
+  timestamp: string;
+}
+interface ClientHealth {
+  clientCode: string;
+  services: {
+    whatsapp: "connected" | "not_configured";
+    email: "configured" | "not_configured";
+    googleMeet: "configured" | "not_configured";
+  };
+  activeAutomations: number;
+  queueDepth: number;
+  timestamp: string;
+}
+interface JobStatus {
+  jobId: string;
+  status: string;
+  attempts: number;
+  maxAttempts: number;
+  lastError: any;
+  runAt: string;
+  completedAt: string | null;
+  failedAt: string | null;
+  createdAt: string;
+}
+declare class Health extends APIResource {
+  /**
+   * Global platform health check.
+   */
+  system(): Promise<SystemHealth>;
+  /**
+   * Tenant-specific health check. Identifies configured services.
+   */
+  clientHealth(): Promise<ClientHealth>;
+  /**
+   * Job execution status lookup.
+   */
+  jobStatus(jobId: string): Promise<JobStatus>;
+}
+
+/**
+ * Configuration options for the Ecodrix client.
+ */
+interface EcodrixOptions {
+  /**
+   * Your ECODrIx Platform API key.
+   * Obtain this from the ECODrIx dashboard under Settings → API Keys.
+   * @example "ecod_live_sk_..."
+   */
+  apiKey: string;
+  /**
+   * Your tenant ID (Client Code).
+   * This scopes all API requests to your specific organisation.
+   * Required for most operations.
+   * @example "ERIX_CLNT_JHBJHF"
+   */
+  clientCode?: string;
+  /**
+   * Override the base URL of the ECODrIx API.
+   * Useful for pointing to a local development or staging server.
+   * @default "https://api.ecodrix.com"
+   */
+  baseUrl?: string;
+  /**
+   * Override the Socket.io server URL for real-time events.
+   * Defaults to the same value as `baseUrl`.
+   * @default "https://api.ecodrix.com"
+   */
+  socketUrl?: string;
+}
+/**
+ * The primary entry point for the ECODrIx SDK.
+ *
+ * Initialise once with your credentials and use the namespaced resources
+ * to interact with every part of the platform.
+ *
+ * @example
+ * ```typescript
+ * import { Ecodrix } from "@ecodrix/erix-api";
+ *
+ * const ecod = new Ecodrix({
+ *   apiKey: process.env.ECOD_API_KEY!,
+ *   clientCode: "ERIX_CLNT_JHBJHF",
+ * });
+ *
+ * await ecod.whatsapp.messages.send({ to: "+91...", text: "Hello!" });
+ * const lead = await ecod.crm.leads.create({ firstName: "Alice", phone: "+91..." });
+ * ```
+ */
+declare class Ecodrix {
+  private readonly client;
+  private readonly socket;
+  /** WhatsApp messaging and conversation management. */
+  readonly whatsapp: WhatsApp;
+  /** CRM resources — Leads and related sub-resources. */
+  readonly crm: CRM;
+  /** Cloudflare R2-backed media storage. */
+  readonly media: MediaResource;
+  /** Google Meet appointment scheduling. */
+  readonly meet: Meetings;
+  /** Automation execution logs and provider webhook callbacks. */
+  readonly notifications: Notifications;
+  /** Outbound email marketing engine. */
+  readonly email: EmailResource;
+  /** Lead events and workflow automation triggers. */
+  readonly events: EventsResource;
+  /** Cryptographic webhook signature verification. */
+  readonly webhooks: Webhooks;
+  /** Tenant Cloud Storage mapping. */
+  readonly storage: Storage;
+  /** Email and SMS Marketing Campaigns. */
+  readonly marketing: Marketing;
+  /** Platform and tenant health diagnostics. */
+  readonly health: Health;
+  constructor(options: EcodrixOptions);
+  private setupSocket;
+  /**
+   * Subscribe to a real-time event emitted by the ECODrIx platform.
+   *
+   * The SDK maintains a persistent Socket.io connection. Events are
+   * scoped to your `clientCode` — you will only receive events for
+   * your own tenant.
+   *
+   * **Standard events:**
+   * - `whatsapp.message_received` — inbound WhatsApp message
+   * - `whatsapp.message_sent` — outbound message delivered
+   * - `crm.lead_created` — new CRM lead ingested
+   * - `crm.lead_updated` — lead details or stage changed
+   * - `meet.scheduled` — Google Meet appointment booked
+   * - `storage.upload_confirmed` — file upload completed
+   * - `automation.failed` — automation execution error
+   *
+   * @param event - The event name to subscribe to.
+   * @param callback - The handler function invoked when the event fires.
+   * @returns `this` for method chaining.
+   *
+   * @example
+   * ```typescript
+   * ecod
+   *   .on("whatsapp.message_received", (msg) => console.log(msg.body))
+   *   .on("automation.failed", (err) => alertTeam(err));
+   * ```
+   */
+  on(event: string, callback: (...args: any[]) => void): this;
+  /**
+   * Gracefully disconnect the real-time Socket.io connection.
+   * Call this when shutting down your server or when the client is
+   * no longer needed to free up resources.
+   *
+   * @example
+   * ```typescript
+   * process.on("SIGTERM", () => ecod.disconnect());
+   * ```
+   */
+  disconnect(): void;
+  /**
+   * Raw Execution Escape-Hatch.
+   * Send an authenticated HTTP request directly to the ECODrIx backend from ANY external project.
+   *
+   * This is extremely powerful giving you full unrestricted access to make calls
+   * against new, experimental, or completely custom backend APIs while still benefitting
+   * from the SDK's built-in authentication and automatic `axios-retry` logic.
+   *
+   * @example
+   * ```typescript
+   * const { data } = await ecod.request("POST", "/api/saas/experimental-feature", { flag: true });
+   * console.log(data);
+   * ```
+   */
+  request<T = any>(method: Method, path: string, data?: any, params?: any): Promise<T>;
+}
+
+export {
+  APIError,
+  Activities,
+  Analytics,
+  type AnalyticsParams,
+  type AnalyticsRange,
+  type AssignEventPayload,
+  AuthenticationError,
+  AutomationDashboard,
+  type AutomationRulePayload,
+  Automations,
+  Broadcasts,
+  CRM,
+  type CampaignResult,
+  Campaigns,
+  type ClientHealth,
+  Conversations,
+  type CreateBroadcastParams,
+  type CreateLeadParams,
+  type CreateMeetingParams,
+  type CreatePipelineParams,
+  Ecodrix,
+  EcodrixError,
+  type EcodrixOptions,
+  EmailResource,
+  Emails,
+  type EventDefinition,
+  EventsResource,
+  Files,
+  Folders,
+  Health,
+  type JobStatus,
+  type LeadSource,
+  type LeadStatus,
+  Leads,
+  type ListLeadsParams,
+  type ListParams,
+  type LogActivityParams,
+  type LogCallParams,
+  type LogFilter,
+  Marketing,
+  MediaResource,
+  Meetings,
+  Messages,
+  Notes,
+  Notifications,
+  Payments,
+  type PipelineStageParams,
+  Pipelines,
+  RateLimitError,
+  Scoring,
+  type ScoringConfig,
+  type SendCampaignParams,
+  type SendCampaignPayload,
+  type SendMessageParams,
+  type SendTemplateParams,
+  type SendTemplatePayload,
+  Sequences,
+  Storage,
+  type SystemHealth,
+  type TemplateMapping,
+  Templates,
+  type TriggerPayload,
+  type TriggerResponse,
+  type UpdateMeetingParams,
+  type UploadOptions,
+  type UpsertLeadParams,
+  WebhookSignatureError,
+  Webhooks,
+  WhatsApp,
+  Ecodrix as default,
+};