@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/resources/crm/pipelines.ts

@@ -1,197 +0,0 @@
-import { APIResource } from "../../resource";
-import type { ResourceManifest } from "../../types/metadata";
-
-export interface CreatePipelineParams {
-  name: string;
-  isDefault?: boolean;
-  stages?: any[]; // Typically an array of stage objects
-}
-
-export interface PipelineStageParams {
-  name: string;
-  color?: string;
-  probability?: number;
-}
-
-export class Pipelines extends APIResource {
-  /**
-   * 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();
-   * ```
-   */
-  async list<T = any>() {
-    return this.get<T>("/api/crm/pipelines");
-  }
-
-  /**
-   * Introspect a pipeline and provide a manifest of its stages.
-   *
-   * Returns metadata about stage colors, probabilities, and order.
-   * Erix React uses this to build kanban boards and stage pickers.
-   *
-   * @param pipelineId - The unique ID of the pipeline.
-   */
-  async getStageManifest(pipelineId: string): Promise<ResourceManifest> {
-    const pipeline: any = await this.retrieve(pipelineId);
-    const stages = Array.isArray(pipeline.data?.stages) ? pipeline.data.stages : [];
-
-    return {
-      name: `Pipeline: ${pipeline.data?.name || pipelineId}`,
-      fields: stages.map((s: any) => ({
-        key: s._id,
-        label: s.name,
-        type: "string", // Labels are strings
-        required: true,
-        options: [{ label: s.name, value: s._id }],
-        group: "Stages",
-        uiHints: {
-          color: s.color || "#cbd5e1",
-          probability: s.probability,
-        },
-      })) as any,
-      uiHints: {
-        icon: "Columns",
-        primaryColor: "#6366f1",
-      },
-    };
-  }
-
-  /**
-   * 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"]
-   * });
-   * ```
-   */
-  async create<T = any>(payload: { name: string; stages: string[] }) {
-    return this.post<T>("/api/crm/pipelines", payload);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async retrieve<T = any>(pipelineId: string) {
-    return this.get<T>(`/api/crm/pipelines/${pipelineId}`);
-  }
-
-  /**
-   * Update an existing pipeline.
-   */
-  async update<T = any>(pipelineId: string, payload: Partial<{ name: string; stages: string[] }>) {
-    return this.patch<T>(`/api/crm/pipelines/${pipelineId}`, payload as any);
-  }
-
-  /**
-   * Set pipeline as the tenant's default.
-   */
-  async setDefault<T = any>(pipelineId: string) {
-    return this.patch<T>(`/api/crm/pipelines/${pipelineId}/default`, {});
-  }
-
-  /**
-   * Duplicate a pipeline with a new name.
-   */
-  async duplicate<T = any>(pipelineId: string, newName: string) {
-    return this.post<T>(`/api/crm/pipelines/${pipelineId}/duplicate`, {
-      newName,
-    });
-  }
-
-  /**
-   * Archive a pipeline.
-   */
-  async archive<T = any>(pipelineId: string) {
-    return this.patch<T>(`/api/crm/pipelines/${pipelineId}/archive`, {});
-  }
-
-  /**
-   * Delete a pipeline permanently.
-   */
-  async delete(pipelineId: string) {
-    return this.deleteRequest(`/api/crm/pipelines/${pipelineId}`);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async board<T = any>(pipelineId: string) {
-    return this.get<T>(`/api/crm/pipelines/${pipelineId}/board`);
-  }
-
-  /**
-   * Retrieve a revenue forecast based on stage probabilities for a pipeline.
-   */
-  async forecast<T = any>(pipelineId: string) {
-    return this.get<T>(`/api/crm/pipelines/${pipelineId}/forecast`);
-  }
-
-  // --- Stage Management ---
-
-  /**
-   * 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
-   * });
-   * ```
-   */
-  async addStage<T = any>(pipelineId: string, params: PipelineStageParams) {
-    return this.post<T>(`/api/crm/pipelines/${pipelineId}/stages`, params);
-  }
-
-  /**
-   * Change the order of stages inside the pipeline.
-   */
-  async reorderStages<T = any>(pipelineId: string, orderArray: string[]) {
-    return this.patch<T>(`/api/crm/pipelines/${pipelineId}/stages/reorder`, {
-      order: orderArray,
-    });
-  }
-
-  /**
-   * Update a specific stage.
-   */
-  async updateStage<T = any>(stageId: string, params: Partial<PipelineStageParams>) {
-    return this.patch<T>(`/api/crm/stages/${stageId}`, params);
-  }
-
-  /**
-   * 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.
-   */
-  async deleteStage(stageId: string, moveLeadsToStageId?: string) {
-    return this.deleteRequest(`/api/crm/stages/${stageId}`, {
-      data: moveLeadsToStageId ? { moveLeadsToStageId } : undefined,
-    });
-  }
-}

package/src/resources/crm/scoring.ts

@@ -1,46 +0,0 @@
-import { APIResource } from "../../resource";
-
-export interface ScoringConfig {
-  decayDays: number;
-  thresholds: {
-    hot: number;
-    warm: number;
-  };
-  rules: any[]; // Specific rule shapes
-}
-
-export class Scoring extends APIResource {
-  /**
-   * 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();
-   * ```
-   */
-  async getConfig<T = any>() {
-    return this.get<T>("/api/crm/scoring");
-  }
-
-  /**
-   * Update scoring configuration.
-   */
-  async updateConfig<T = any>(payload: Partial<ScoringConfig>) {
-    return this.patch<T>("/api/crm/scoring", payload as any);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async recalculate<T = any>(leadId: string) {
-    return this.post<T>(`/api/crm/scoring/${leadId}/recalculate`, {});
-  }
-}

package/src/resources/crm/sequences.ts

@@ -1,51 +0,0 @@
-import { APIResource } from "../../resource";
-
-export class Sequences extends APIResource {
-  /**
-   * 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" }
-   * });
-   * ```
-   */
-  async enroll<T = any>(payload: {
-    leadId: string;
-    ruleId: string;
-    variables?: Record<string, any>;
-  }) {
-    return this.post<T>("/api/crm/sequences/enroll", payload);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async unenroll<T = any>(enrollmentId: string) {
-    return this.deleteRequest(`/api/crm/sequences/unenroll/${enrollmentId}`);
-  }
-
-  /**
-   * 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");
-   * ```
-   */
-  async listForLead<T = any>(leadId: string) {
-    return this.get<T>(`/api/crm/sequences/lead/${leadId}`);
-  }
-}

package/src/resources/email.ts

@@ -1,142 +0,0 @@
-import { APIResource } from "../resource";
-
-/**
- * Payload to send a high-throughput email campaign.
- */
-export 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.
- */
-export interface CampaignResult {
-  success: boolean;
-  message?: string;
-  [key: string]: any;
-}
-
-export interface EmailTemplate {
-  id: string;
-  name: string;
-  description?: string;
-  subject: string;
-  preheader?: string;
-  htmlBody: string;
-  textBody?: string;
-  category: "marketing" | "transactional" | "sequence";
-  status: "draft" | "published" | "archived";
-  type: "standard" | "layout";
-  layoutId?: string;
-  thumbnail?: string;
-  variableMapping?: any[];
-  createdAt: string;
-  updatedAt: string;
-}
-
-export interface CreateTemplateDTO {
-  name: string;
-  subject: string;
-  htmlBody: string;
-  description?: string;
-  category?: "marketing" | "transactional" | "sequence";
-  status?: "draft" | "published" | "archived";
-  variableMapping?: any[];
-}
-
-export interface TemplatePreviewResponse {
-  success: boolean;
-  data: {
-    subject: string;
-    html: string;
-    text?: string;
-  };
-}
-
-/**
- * Outbound email marketing engine and template management.
- *
- * Access via `ecod.email`.
- */
-export class Email extends APIResource {
-  /**
-   * Send an HTML email campaign to a list of recipients.
-   */
-  async sendCampaign(payload: SendCampaignPayload): Promise<CampaignResult> {
-    return this.post<CampaignResult>("/api/saas/emails/campaign", payload);
-  }
-
-  /**
-   * Send a system test email to validate your current SMTP configuration.
-   */
-  async sendTest(to: string): Promise<CampaignResult> {
-    return this.post<CampaignResult>("/api/saas/emails/test", { to });
-  }
-
-  // --- Template Management ---
-
-  /**
-   * List all email templates.
-   */
-  async listTemplates(query?: any): Promise<{ success: boolean; data: EmailTemplate[] }> {
-    return this.get<{ success: boolean; data: EmailTemplate[] }>("/api/saas/mail/templates", {
-      params: query,
-    });
-  }
-
-  /**
-   * Get a single email template by ID.
-   */
-  async getTemplate(id: string): Promise<{ success: boolean; data: EmailTemplate }> {
-    return this.get<{ success: boolean; data: EmailTemplate }>(`/api/saas/mail/templates/${id}`);
-  }
-
-  /**
-   * Create a new email template.
-   */
-  async createTemplate(
-    data: CreateTemplateDTO,
-  ): Promise<{ success: boolean; data: EmailTemplate }> {
-    return this.post<{ success: boolean; data: EmailTemplate }>("/api/saas/mail/templates", data);
-  }
-
-  /**
-   * Update an existing email template.
-   */
-  async updateTemplate(
-    id: string,
-    data: Partial<CreateTemplateDTO>,
-  ): Promise<{ success: boolean; data: EmailTemplate }> {
-    return this.put<{ success: boolean; data: EmailTemplate }>(
-      `/api/saas/mail/templates/${id}`,
-      data,
-    );
-  }
-
-  /**
-   * Delete an email template.
-   */
-  async deleteTemplate(id: string, force = false): Promise<{ success: boolean }> {
-    return this.deleteRequest<{ success: boolean }>(`/api/saas/mail/templates/${id}`, {
-      params: { force },
-    });
-  }
-
-  /**
-   * Preview a template with dynamic variable resolution.
-   */
-  async previewTemplate(
-    id: string,
-    params: { leadId?: string; variables?: Record<string, any> },
-  ): Promise<TemplatePreviewResponse> {
-    return this.post<TemplatePreviewResponse>(`/api/saas/mail/templates/${id}/preview`, params);
-  }
-}
-
-/** @deprecated Use Email instead */
-export class EmailResource extends Email {}

package/src/resources/events.ts

@@ -1,189 +0,0 @@
-import type { AxiosInstance } from "axios";
-import { APIResource } from "../resource";
-
-/**
- * Event definition representing an entry point capable of triggering automations.
- */
-export 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.
- */
-export 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.
- */
-export 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;
-  /** Automatically generate a Google Meet appointment if matched actions require it */
-  requiresMeet?: boolean;
-  /** Configuration details for the generated Google Meet appointment */
-  meetConfig?: {
-    summary?: string;
-    description?: string;
-    startTime?: string;
-    duration?: number;
-    timezone?: string;
-    attendees?: string[];
-  };
-}
-
-/**
- * Response returned when triggering an event.
- */
-export interface TriggerResponse {
-  success: boolean;
-  data?: {
-    eventLogId: string;
-    trigger: string;
-    leadId: string;
-    rulesMatched: number;
-  };
-  message?: string;
-  code?: string;
-}
-
-export class EventsResource extends APIResource {
-  /**
-   * 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();
-   * ```
-   */
-  async list(): Promise<{ success: boolean; data: EventDefinition[] }> {
-    return this.get<{ success: boolean; data: EventDefinition[] }>("/api/saas/events");
-  }
-
-  /**
-   * Register a new custom event entry point into the CRM automation engine.
-   * Useful when introducing new granular triggers.
-   */
-  async assign(payload: AssignEventPayload): Promise<{ success: boolean; data: EventDefinition }> {
-    return this.post<{ success: boolean; data: EventDefinition }>(
-      "/api/saas/events/assign",
-      payload,
-    );
-  }
-
-  /**
-   * Deactivate a custom event assignment by name.
-   */
-  async unassign(name: string): Promise<{ success: boolean; data: any }> {
-    return this.post<{ success: boolean; data: any }>("/api/saas/events/unassign", { name });
-  }
-
-  /**
-   * Deactivate multiple custom event assignments simultaneously.
-   */
-  async unassignBulk(names: string[]): Promise<{ success: boolean; message: string }> {
-    return this.post<{ success: boolean; message: string }>("/api/saas/events/unassign/bulk", {
-      names,
-    });
-  }
-
-  /**
-   * 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
-   * });
-   * ```
-   */
-  async trigger(payload: TriggerPayload): Promise<TriggerResponse> {
-    return this.post<TriggerResponse>("/api/saas/workflows/trigger", payload);
-  }
-
-  // --- CRM Custom Events ---
-
-  /**
-   * List all custom event definitions.
-   */
-  async listCustomEvents<T = any>() {
-    return this.get<T>("/api/saas/crm/custom-events");
-  }
-
-  /**
-   * Create or upsert a custom event definition.
-   */
-  async createCustomEvent<T = any>(payload: {
-    name: string;
-    displayName: string;
-    description?: string;
-  }) {
-    return this.post<T>("/api/saas/crm/custom-events", payload);
-  }
-
-  /**
-   * Delete a custom event definition.
-   */
-  async deleteCustomEvent<T = any>(id: string) {
-    return this.deleteRequest<T>(`/api/saas/crm/custom-events/${id}`);
-  }
-
-  /**
-   * Manually emit a custom event to trigger workflows based on its definition.
-   */
-  async emit<T = any>(payload: { eventName: string; leadId: string; data?: any }) {
-    return this.post<T>("/api/saas/crm/events/emit", payload);
-  }
-}

package/src/resources/health.ts

@@ -1,84 +0,0 @@
-import { APIResource } from "../resource";
-
-export interface SystemHealth {
-  status: string;
-  version: string;
-  env: string;
-  uptime: number;
-  db: string;
-  queueDepth: number;
-  timestamp: string;
-}
-
-export interface ClientHealth {
-  clientCode: string;
-  services: {
-    whatsapp: "connected" | "not_configured";
-    email: "configured" | "not_configured";
-    googleMeet: "configured" | "not_configured";
-  };
-  activeAutomations: number;
-  queueDepth: number;
-  timestamp: string;
-}
-
-export interface JobStatus {
-  jobId: string;
-  status: string;
-  attempts: number;
-  maxAttempts: number;
-  lastError: any;
-  runAt: string;
-  completedAt: string | null;
-  failedAt: string | null;
-  createdAt: string;
-}
-
-/**
- * Platform and tenant-specific health diagnostics.
- *
- * Access via `ecod.health`.
- */
-export class Health extends APIResource {
-  /**
-   * Perform a global platform health check.
-   * Verify that the core API, database, and background workers are operational.
-   */
-  async system(): Promise<SystemHealth> {
-    const res = await this.get<{ success: boolean; data: SystemHealth }>("/api/saas/health");
-    return res.data;
-  }
-
-  /**
-   * Tenant-specific health check.
-   *
-   * Identifies correctly configured third-party integrations (WhatsApp, SMTP, Google Meet)
-   * and reports active automation counts.
-   */
-  async clientHealth(): Promise<ClientHealth> {
-    const res = await this.get<{ success: boolean; data: ClientHealth }>("/api/saas/health/client");
-    return res.data;
-  }
-
-  /**
-   * Alias for clientHealth to match diagnostic terminology.
-   */
-  async getDiagnosticReport(): Promise<ClientHealth> {
-    return this.clientHealth();
-  }
-
-  /**
-   * Lookup the execution status of a background job.
-   *
-   * Use this to poll for completion of long-running tasks like bulk exports
-   * or campaign dispatches.
-   *
-   * @param jobId - The unique ID of the background job.
-   */
-  async jobStatus(jobId: string): Promise<JobStatus> {
-    const res = await this.get<{ success: boolean; data: JobStatus }>(
-      `/api/saas/jobs/status/${jobId}`,
-    );
-    return res.data;
-  }
-}