@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/error.ts

@@ -1,72 +0,0 @@
-/**
- * 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. */
-export class EcodrixError extends Error {
-  constructor(message: string) {
-    super(message);
-    this.name = "EcodrixError";
-  }
-}
-
-/**
- * Represents an error returned by the ECODrIx API.
- * Carries the HTTP `status` code and an optional `code` string.
- */
-export class APIError extends EcodrixError {
-  /** HTTP status code returned by the API (e.g. 400, 404, 500). */
-  public status?: number;
-  /** Machine-readable error code (e.g. `"NOT_FOUND"`, `"VALIDATION_ERROR"`). */
-  public code?: string;
-
-  constructor(message: string, status?: number, code?: string) {
-    super(message);
-    this.name = "APIError";
-    this.status = status;
-    this.code = code;
-  }
-}
-
-/**
- * Thrown when the API key or client code is missing, invalid, or expired.
- * HTTP 401.
- */
-export class AuthenticationError extends APIError {
-  constructor(message = "Invalid API Key or Client Code") {
-    super(message, 401, "AUTH_FAILED");
-    this.name = "AuthenticationError";
-  }
-}
-
-/**
- * Thrown when the rate limit for the API key has been exceeded.
- * HTTP 429. Implement exponential backoff before retrying.
- */
-export class RateLimitError extends APIError {
-  constructor(message = "Too many requests. Please slow down.") {
-    super(message, 429, "RATE_LIMIT_EXCEEDED");
-    this.name = "RateLimitError";
-  }
-}

package/src/index.ts

@@ -1,34 +0,0 @@
-export { Ecodrix, type EcodrixOptions } from "./core";
-export * from "./types/metadata";
-export * from "./error";
-export * from "./resources/crm/activities";
-export * from "./resources/crm/analytics";
-export * from "./resources/crm/automationDashboard";
-export * from "./resources/crm/automations";
-export * from "./resources/crm/index";
-export * from "./resources/crm/leads";
-export * from "./resources/crm/payments";
-export * from "./resources/crm/pipelines";
-export * from "./resources/crm/scoring";
-export * from "./resources/crm/sequences";
-export * from "./resources/email";
-export * from "./resources/events";
-export * from "./resources/health";
-export * from "./resources/logs";
-export * from "./resources/marketing";
-export * from "./resources/media";
-export * from "./resources/meet";
-export * from "./resources/notifications";
-export * from "./resources/queue";
-export * from "./resources/storage";
-export * from "./resources/webhooks";
-export * from "./resources/whatsapp/broadcasts";
-export * from "./resources/whatsapp/conversations";
-// Resource Type Exports
-export * from "./resources/whatsapp/index";
-export * from "./resources/whatsapp/messages";
-export * from "./resources/whatsapp/templates";
-
-// Export the main client also as default for better ergonomics
-import { Ecodrix } from "./core";
-export default Ecodrix;

package/src/resource.ts

@@ -1,93 +0,0 @@
-import type { AxiosInstance, AxiosRequestConfig } from "axios";
-import { APIError } from "./error";
-
-export 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;
-}
-
-export abstract class APIResource {
-  public constructor(protected readonly client: AxiosInstance) {}
-
-  protected async post<T>(url: string, data?: any, options?: RequestOptions): Promise<T> {
-    try {
-      const config = this.buildConfig(options);
-      const response = await this.client.post(url, data, config);
-      return response.data;
-    } catch (error: any) {
-      this.handleError(error);
-    }
-  }
-
-  protected async get<T>(url: string, options?: RequestOptions): Promise<T> {
-    try {
-      const config = this.buildConfig(options);
-      const response = await this.client.get(url, config);
-      return response.data;
-    } catch (error: any) {
-      this.handleError(error);
-    }
-  }
-
-  protected async patch<T>(url: string, data?: any, options?: RequestOptions): Promise<T> {
-    try {
-      const config = this.buildConfig(options);
-      const response = await this.client.patch(url, data, config);
-      return response.data;
-    } catch (error: any) {
-      this.handleError(error);
-    }
-  }
-
-  protected async put<T>(url: string, data?: any, options?: RequestOptions): Promise<T> {
-    try {
-      const config = this.buildConfig(options);
-      const response = await this.client.put(url, data, config);
-      return response.data;
-    } catch (error: any) {
-      this.handleError(error);
-    }
-  }
-
-  protected async deleteRequest<T>(url: string, options?: RequestOptions): Promise<T> {
-    try {
-      const config = this.buildConfig(options);
-      const response = await this.client.delete(url, config);
-      return response.data;
-    } catch (error: any) {
-      this.handleError(error);
-    }
-  }
-
-  private buildConfig(options?: RequestOptions): AxiosRequestConfig | undefined {
-    if (!options) return undefined;
-
-    const config: AxiosRequestConfig = { ...options };
-    if (options.idempotencyKey) {
-      config.headers = {
-        ...config.headers,
-        "Idempotency-Key": options.idempotencyKey,
-      };
-    }
-    return config;
-  }
-
-  private handleError(error: any): never {
-    if (error.response) {
-      throw new APIError(
-        error.response.data?.message || error.response.data?.error || "API Request Failed",
-        error.response.status,
-        error.response.data?.code,
-      );
-    }
-    throw new APIError(error.message || "Network Error");
-  }
-}

package/src/resources/crm/activities.ts

@@ -1,122 +0,0 @@
-import { APIResource } from "../../resource";
-
-export interface LogActivityParams {
-  leadId: string;
-  type: "note" | "call" | "email" | "meeting" | "whatsapp" | "system";
-  title: string;
-  body?: string;
-  metadata?: Record<string, any>;
-}
-
-export interface LogCallParams {
-  durationMinutes: number;
-  summary: string;
-  outcome: "answered" | "no_answer" | "busy" | "voicemail" | "wrong_number";
-}
-
-export 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");
-   * ```
-   */
-  async list<T = any>(leadId: string) {
-    return this.get<T>(`/api/crm/leads/${leadId}/notes`);
-  }
-
-  /**
-   * 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."
-   * });
-   * ```
-   */
-  async create<T = any>(leadId: string, params: { content: string }) {
-    return this.post<T>(`/api/crm/leads/${leadId}/notes`, params);
-  }
-
-  /**
-   * Update an existing note.
-   */
-  async update<T = any>(noteId: string, content: string) {
-    return this.patch<T>(`/api/crm/notes/${noteId}`, { content });
-  }
-
-  /**
-   * Pin or unpin a note to the top of the feed.
-   */
-  async pin<T = any>(noteId: string, isPinned = true) {
-    return this.patch<T>(`/api/crm/notes/${noteId}/pin`, { isPinned });
-  }
-
-  /**
-   * Delete a note.
-   */
-  async delete(noteId: string) {
-    return this.deleteRequest(`/api/crm/notes/${noteId}`);
-  }
-}
-
-export class Activities extends APIResource {
-  public notes: Notes;
-
-  constructor(client: any) {
-    super(client);
-    this.notes = new Notes(client);
-  }
-
-  /**
-   * 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 });
-   * ```
-   */
-  async timeline<T = any>(leadId: string, params?: { page?: number; limit?: number }) {
-    return this.get<T>(`/api/crm/leads/${leadId}/timeline`, { params } as any);
-  }
-
-  /**
-   * List specific activities (filtered by type).
-   */
-  async list<T = any>(leadId: string, params?: { type?: string; page?: number; limit?: number }) {
-    return this.get<T>(`/api/crm/leads/${leadId}/activities`, { params: { ...params } } as any);
-  }
-
-  /**
-   * 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."
-   * });
-   * ```
-   */
-  async log<T = any>(params: LogActivityParams) {
-    return this.post<T>(`/api/crm/leads/${params.leadId}/activities`, params);
-  }
-
-  /**
-   * Specific method to log communication outcomes.
-   */
-  async logCall<T = any>(leadId: string, params: LogCallParams) {
-    return this.post<T>(`/api/crm/leads/${leadId}/calls`, params);
-  }
-}

package/src/resources/crm/analytics.ts

@@ -1,148 +0,0 @@
-import { APIResource } from "../../resource";
-
-export type AnalyticsRange = "24h" | "7d" | "30d" | "60d" | "90d" | "365d";
-
-export interface AnalyticsParams {
-  range?: AnalyticsRange;
-  from?: string;
-  to?: string;
-  pipelineId?: string;
-}
-
-export class Analytics extends APIResource {
-  /**
-   * 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);
-   * ```
-   */
-  async overview<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/overview", { params } as any);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async funnel<T = any>(pipelineId: string) {
-    return this.get<T>("/api/crm/analytics/funnel", {
-      params: { pipelineId },
-    } as any);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async forecast<T = any>(pipelineId?: string) {
-    return this.get<T>("/api/crm/analytics/forecast", {
-      params: { pipelineId },
-    } as any);
-  }
-
-  /**
-   * 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.
-   */
-  async sources<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/sources", { params } as any);
-  }
-
-  /**
-   * 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.
-   */
-  async team<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/team", { params } as any);
-  }
-
-  /**
-   * 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.
-   */
-  async heatmap<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/heatmap", { params } as any);
-  }
-
-  /**
-   * Score distribution: Groups leads into buckets based on their calculated score (0-100).
-   *
-   * @returns {Promise<any>} Volume of leads in different readiness tiers.
-   */
-  async scores<T = any>() {
-    return this.get<T>("/api/crm/analytics/scores");
-  }
-
-  /**
-   * 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.
-   */
-  async stageTime<T = any>(pipelineId: string) {
-    return this.get<T>("/api/crm/analytics/stage-time", {
-      params: { pipelineId },
-    } as any);
-  }
-
-  /**
-   * Tiered Growth Report matching business sophistication (Pulse, Growth, Weapon).
-   * Provides deep tactical and strategic insights.
-   *
-   * @param params - Filtering and range parameters.
-   */
-  async tiered<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/tiered", { params } as any);
-  }
-
-  /**
-   * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
-   *
-   * @param params - Time range filters.
-   */
-  async summary<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/summary", { params } as any);
-  }
-
-  /**
-   * 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);
-   * ```
-   */
-  async whatsapp<T = any>(params?: AnalyticsParams) {
-    return this.get<T>("/api/crm/analytics/whatsapp", { params } as any);
-  }
-}

package/src/resources/crm/automationDashboard.ts

@@ -1,42 +0,0 @@
-import { APIResource } from "../../resource";
-
-export class AutomationDashboard extends APIResource {
-  /**
-   * Retrieve summary statistics for automation health (total, success, failed).
-   *
-   * @returns Stats object.
-   * @example
-   * ```typescript
-   * const stats = await erixClient.crm.automationDashboard.stats();
-   * ```
-   */
-  async stats<T = any>() {
-    return this.get<T>("/api/crm/automation/stats");
-  }
-
-  /**
-   * List recent EventLog entries representing automation executions.
-   *
-   * @param params - Optional filters (limit, status).
-   * @example
-   * ```typescript
-   * const logs = await erixClient.crm.automationDashboard.logs({ status: "failed" });
-   * ```
-   */
-  async logs<T = any>(params?: { limit?: number; status?: string }) {
-    return this.get<T>("/api/crm/automation/logs", { params } as any);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async retryFailedEvent<T = any>(logId: string) {
-    return this.post<T>(`/api/crm/automation/logs/${logId}/retry`, {});
-  }
-}

package/src/resources/crm/automations.ts

@@ -1,170 +0,0 @@
-import { APIResource } from "../../resource";
-
-export interface AutomationRulePayload {
-  name: string;
-  trigger: string;
-  isActive?: boolean;
-  nodes: any[];
-  edges: any[];
-}
-
-export class Automations extends APIResource {
-  /**
-   * List all automation rules (workflows) configured for the tenant.
-   *
-   * @returns Array of automation rule objects.
-   * @example
-   * ```typescript
-   * const rules = await erixClient.crm.automations.list();
-   * ```
-   */
-  async list<T = any>() {
-    return this.get<T>("/api/crm/automations");
-  }
-
-  /**
-   * 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: [...]
-   * });
-   * ```
-   */
-  async create<T = any>(payload: AutomationRulePayload) {
-    return this.post<T>("/api/crm/automations", payload);
-  }
-
-  /**
-   * Update an existing automation rule.
-   */
-  async update<T = any>(ruleId: string, payload: Partial<AutomationRulePayload>) {
-    return this.patch<T>(`/api/crm/automations/${ruleId}`, payload as any);
-  }
-
-  /**
-   * Enable or disable an automation rule.
-   */
-  async toggle<T = any>(ruleId: string) {
-    return this.patch<T>(`/api/crm/automations/${ruleId}/toggle`);
-  }
-
-  /**
-   * Delete an automation rule.
-   */
-  async delete<T = any>(ruleId: string) {
-    return this.deleteRequest(`/api/crm/automations/${ruleId}`);
-  }
-
-  /**
-   * Bulk delete rules.
-   */
-  async bulkDelete<T = any>(ruleIds: string[]) {
-    return this.post<T>("/api/crm/automations/bulk-delete", { ids: ruleIds });
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async test<T = any>(ruleId: string, leadId: string) {
-    return this.post<T>(`/api/crm/automations/${ruleId}/test`, { leadId });
-  }
-
-  /**
-   * Get available event triggers for automations.
-   */
-  async getAvailableEvents<T = any>() {
-    return this.post<T>("/api/crm/automations/events", {});
-  }
-
-  /**
-   * List enrollments for a rule.
-   */
-  async enrollments<T = any>(
-    ruleId: string,
-    params?: {
-      status?: string;
-      page?: number;
-      limit?: number;
-      startDate?: string;
-      endDate?: string;
-    },
-  ) {
-    return this.get<T>(`/api/crm/automations/${ruleId}/enrollments`, { params });
-  }
-
-  /**
-   * Get an enrollment detail.
-   */
-  async getEnrollment<T = any>(enrollmentId: string) {
-    return this.get<T>(`/api/crm/automations/enrollments/${enrollmentId}`);
-  }
-
-  /**
-   * Pause an enrollment.
-   */
-  async pauseEnrollment<T = any>(ruleId: string, enrollmentId: string) {
-    return this.post<T>(`/api/crm/automations/${ruleId}/enrollments/${enrollmentId}/pause`, {});
-  }
-
-  /**
-   * Resume an enrollment.
-   */
-  async resumeEnrollment<T = any>(ruleId: string, enrollmentId: string) {
-    return this.post<T>(`/api/crm/automations/${ruleId}/enrollments/${enrollmentId}/resume`, {});
-  }
-
-  /**
-   * List workflow runs.
-   */
-  async runs<T = any>(ruleId: string) {
-    return this.get<T>(`/api/crm/automations/${ruleId}/runs`);
-  }
-
-  /**
-   * Get run details.
-   */
-  async getRun<T = any>(runId: string) {
-    return this.get<T>(`/api/crm/automations/runs/${runId}`);
-  }
-
-  /**
-   * Resume a paused run.
-   */
-  async resumeRun<T = any>(runId: string) {
-    return this.post<T>(`/api/crm/automations/runs/${runId}/resume`, {});
-  }
-
-  /**
-   * Abort a running workflow.
-   */
-  async abortRun<T = any>(runId: string) {
-    return this.post<T>(`/api/crm/automations/runs/${runId}/abort`, {});
-  }
-
-  /**
-   * 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.
-   */
-  async webhookEvent<T = any>(ruleId: string, eventName: string, payload?: any) {
-    return this.post<T>("/api/crm/webhook-event", { ruleId, eventName, payload });
-  }
-}