@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/resources/crm/index.ts

@@ -1,34 +0,0 @@
-import type { AxiosInstance } from "axios";
-import { Activities } from "./activities";
-import { Analytics } from "./analytics";
-import { AutomationDashboard } from "./automationDashboard";
-import { Automations } from "./automations";
-import { Leads } from "./leads";
-import { Payments } from "./payments";
-import { Pipelines } from "./pipelines";
-import { Scoring } from "./scoring";
-import { Sequences } from "./sequences";
-
-export class CRM {
-  public leads: Leads;
-  public pipelines: Pipelines;
-  public activities: Activities;
-  public analytics: Analytics;
-  public automations: Automations;
-  public sequences: Sequences;
-  public scoring: Scoring;
-  public payments: Payments;
-  public automationDashboard: AutomationDashboard;
-
-  constructor(client: AxiosInstance) {
-    this.leads = new Leads(client);
-    this.pipelines = new Pipelines(client);
-    this.activities = new Activities(client);
-    this.analytics = new Analytics(client);
-    this.automations = new Automations(client);
-    this.sequences = new Sequences(client);
-    this.scoring = new Scoring(client);
-    this.payments = new Payments(client);
-    this.automationDashboard = new AutomationDashboard(client);
-  }
-}

package/src/resources/crm/leads.ts

@@ -1,458 +0,0 @@
-import { APIResource } from "../../resource";
-import type { ResourceManifest } from "../../types/metadata";
-
-/**
- * Valid statuses for a CRM Lead.
- */
-export type LeadStatus = "new" | "contacted" | "qualified" | "won" | "lost" | "archived";
-
-/**
- * Common lead acquisition sources. Additional string values are allowed.
- */
-export type LeadSource = "website" | "whatsapp" | "direct" | "referral" | string;
-
-/**
- * Parameters for creating a new CRM Lead.
- */
-export 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.
- */
-export 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.
- */
-export 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",
- * });
- * ```
- */
-export 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.
-   * @example
-   * ```typescript
-   * const lead = await erixClient.crm.leads.create({
-   *   firstName: "Alice",
-   *   phone: "+919876543210",
-   *   source: "website"
-   * });
-   * ```
-   */
-  async create<T = any>(params: CreateLeadParams) {
-    return this.post<T>("/api/crm/leads", params);
-  }
-
-  /**
-   * Introspect the Leads resource and provide a "Blueprint" for UI generation.
-   *
-   * This method returns a list of all fields (standard + custom), their types,
-   * labels, and suggested UI controls. Erix React uses this to render SmartForms
-   * and tables dynamically.
-   */
-  async describe(): Promise<ResourceManifest> {
-    // 1. Fetch custom fields from the tenant configuration
-    const customFieldsRes: any = await this.fields();
-    const customFields = Array.isArray(customFieldsRes.data) ? customFieldsRes.data : [];
-
-    // 2. Define the core system fields
-    const systemFields: any[] = [
-      {
-        key: "firstName",
-        label: "First Name",
-        type: "string",
-        required: true,
-        group: "Basic Info",
-      },
-      { key: "lastName", label: "Last Name", type: "string", required: false, group: "Basic Info" },
-      { key: "phone", label: "Phone Number", type: "phone", required: true, group: "Contact" },
-      { key: "email", label: "Email Address", type: "email", required: false, group: "Contact" },
-      {
-        key: "status",
-        label: "Status",
-        type: "select",
-        required: true,
-        options: [
-          { label: "New", value: "new" },
-          { label: "Contacted", value: "contacted" },
-          { label: "Qualified", value: "qualified" },
-          { label: "Won", value: "won" },
-          { label: "Lost", value: "lost" },
-        ],
-      },
-      { key: "value", label: "Lead Value", type: "currency", required: false },
-      { key: "source", label: "Source", type: "string", required: false },
-    ];
-
-    // 3. Map custom fields to FieldManifest shape
-    const mappedCustom = customFields.map((f: any) => ({
-      key: `metadata.extra.${f.name}`,
-      label: f.label || f.name,
-      type: f.type || "string",
-      required: !!f.required,
-      options: f.options,
-      group: "Custom Fields",
-    }));
-
-    return {
-      name: "Lead",
-      fields: [...systemFields, ...mappedCustom],
-      uiHints: {
-        icon: "User",
-        primaryColor: "#3b82f6",
-        defaultSort: { field: "createdAt", direction: "desc" },
-        summaryFields: ["firstName", "lastName", "phone", "status"],
-      },
-    };
-  }
-
-  /**
-   * Upsert a lead by phone number. If a lead with the same phone exists,
-   * it will be updated; otherwise, a new lead is created.
-   *
-   * @param params - Upsert parameters containing leadData with a phone number.
-   * @returns The newly created or updated Lead document.
-   * @example
-   * ```typescript
-   * await erixClient.crm.leads.upsert({
-   *   leadData: { phone: "+919876543210", firstName: "Alice" }
-   * });
-   * ```
-   */
-  async upsert<T = any>(params: UpsertLeadParams) {
-    return this.post<T>("/api/crm/leads/upsert", params);
-  }
-
-  /**
-   * 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.
-   */
-  async createMany(leads: CreateLeadParams[], chunkSize = 50): Promise<any[]> {
-    const results: any[] = [];
-
-    for (let i = 0; i < leads.length; i += chunkSize) {
-      const chunk = leads.slice(i, i + chunkSize);
-
-      const chunkPromises = chunk.map((lead) => this.create(lead));
-      const chunkResults = await Promise.allSettled(chunkPromises);
-
-      for (const res of chunkResults) {
-        if (res.status === "fulfilled") {
-          results.push(res.value);
-        } else {
-          throw res.reason;
-        }
-      }
-    }
-
-    return results;
-  }
-
-  /**
-   * Bulk upsert (import) leads.
-   *
-   * @param leads - Array of leads to import.
-   */
-  async import<T = any>(leads: Partial<CreateLeadParams>[]) {
-    return this.post<T>("/api/crm/leads/import", { leads });
-  }
-
-  /**
-   * List CRM leads with optional filtering and pagination.
-   *
-   * @param params - Filter options (status, source, pipelineId, page, limit, etc.)
-   * @returns Paginated list of Lead documents.
-   * @example
-   * ```typescript
-   * const leads = await erixClient.crm.leads.list({
-   *   status: "new",
-   *   source: "website",
-   *   limit: 20
-   * });
-   * ```
-   */
-  async list<T = any>(params?: ListLeadsParams) {
-    const queryParams = { ...params } as any;
-    if (Array.isArray(queryParams.tags)) {
-      queryParams.tags = queryParams.tags.join(",");
-    }
-    return this.get<T>("/api/crm/leads", { params: queryParams } as any);
-  }
-
-  /**
-   * Auto-paginating iterator for leads.
-   * Seamlessly fetches leads page by page as you iterate.
-   *
-   * @example
-   * ```typescript
-   * for await (const lead of ecod.crm.leads.listAutoPaging<Lead>()) {
-   *   console.log(lead.firstName);
-   * }
-   * ```
-   */
-  async *listAutoPaging<T = any>(params?: ListLeadsParams): AsyncGenerator<T, void, unknown> {
-    let currentPage = params?.page || 1;
-    let hasMore = true;
-
-    while (hasMore) {
-      const response: any = await this.list<any>({
-        ...params,
-        page: currentPage,
-      });
-
-      const items = Array.isArray(response.data) ? response.data : response || [];
-
-      if (items.length === 0) {
-        hasMore = false;
-        break;
-      }
-
-      for (const item of items) {
-        yield item as T;
-      }
-
-      if (response.pagination && currentPage < response.pagination.pages) {
-        currentPage++;
-      } else if (!response.pagination && items.length > 0) {
-        // Fallback: If no explicit pagination struct, assume simple array and just keep pulling until empty
-        currentPage++;
-      } else {
-        hasMore = false;
-      }
-    }
-  }
-
-  /**
-   * 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.
-   * @example
-   * ```typescript
-   * const lead = await erixClient.crm.leads.retrieve("64abc...");
-   * ```
-   */
-  async retrieve<T = any>(leadId: string) {
-    return this.get<T>(`/api/crm/leads/${leadId}`);
-  }
-
-  /**
-   * Retrieve a single lead by its phone number.
-   *
-   * @param phone - Lead's phone number.
-   */
-  async retrieveByPhone<T = any>(phone: string) {
-    // URL-encode the phone to handle '+' safe
-    return this.get<T>(`/api/crm/leads/phone/${encodeURIComponent(phone)}`);
-  }
-
-  /**
-   * Retrieve a single lead by a reference key and value.
-   *
-   * @param refKey - Reference key metadata.
-   * @param refValue - Reference value.
-   */
-  async retrieveByRef<T = any>(refKey: string, refValue: string) {
-    return this.get<T>(
-      `/api/crm/leads/ref/${encodeURIComponent(refKey)}/${encodeURIComponent(refValue)}`,
-    );
-  }
-
-  /**
-   * 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.
-   * @example
-   * ```typescript
-   * await erixClient.crm.leads.update("64abc...", {
-   *   lastName: "Smith",
-   *   status: "qualified"
-   * });
-   * ```
-   */
-  async update<T = any>(leadId: string, params: Partial<CreateLeadParams>) {
-    return this.patch<T>(`/api/crm/leads/${leadId}`, params);
-  }
-
-  /**
-   * Move a lead to a new stage in a pipeline.
-   *
-   * @param leadId - ID of the lead.
-   * @param stageId - Target stage ID.
-   */
-  async move<T = any>(leadId: string, stageId: string) {
-    return this.patch<T>(`/api/crm/leads/${leadId}/move`, { stageId });
-  }
-
-  /**
-   * 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.
-   */
-  async convert<T = any>(leadId: string, outcome: "won" | "lost", reason?: string) {
-    return this.post<T>(`/api/crm/leads/${leadId}/convert`, {
-      outcome,
-      reason,
-    });
-  }
-
-  /**
-   * Update the tags of a lead.
-   *
-   * @param leadId - ID of the lead.
-   * @param options - Tags to add or remove.
-   */
-  async tags<T = any>(leadId: string, options: { add?: string[]; remove?: string[] }) {
-    return this.patch<T>(`/api/crm/leads/${leadId}/tags`, options);
-  }
-
-  /**
-   * Recalculate lead score based on activities and interactions.
-   *
-   * @param leadId - ID of the lead.
-   */
-  async recalculateScore<T = any>(leadId: string) {
-    return this.post<T>(`/api/crm/leads/${leadId}/score`, {});
-  }
-
-  /**
-   * Update embedded metadata/references of a lead without touching core fields.
-   *
-   * @param leadId - ID of the lead.
-   * @param metadata - Metadata object indicating { refs, extra }
-   */
-  async updateMetadata<T = any>(
-    leadId: string,
-    metadata: { refs?: Record<string, any>; extra?: Record<string, any> },
-  ) {
-    return this.patch<T>(`/api/crm/leads/${leadId}/metadata`, metadata);
-  }
-
-  /**
-   * Introspect available custom fields configured by the tenant limit.
-   */
-  async fields<T = any>() {
-    return this.get<T>("/api/crm/leads/fields");
-  }
-
-  /**
-   * List all notes for a specific lead.
-   */
-  async notes<T = any>(leadId: string) {
-    return this.get<T>(`/api/crm/leads/${leadId}/notes`);
-  }
-
-  /**
-   * Retrieve the complete chronological timeline for a lead.
-   */
-  async activities<T = any>(leadId: string, params?: { page?: number; limit?: number }) {
-    return this.get<T>(`/api/crm/leads/${leadId}/timeline`, { params } as any);
-  }
-
-  /**
-   * Add a note to a lead.
-   */
-  async createNote<T = any>(leadId: string, params: { content: string }) {
-    return this.post<T>(`/api/crm/leads/${leadId}/notes`, params);
-  }
-
-  /**
-   * Update an existing note.
-   */
-  async updateNote<T = any>(leadId: string, noteId: string, params: { content: string }) {
-    return this.patch<T>(`/api/crm/notes/${noteId}`, params);
-  }
-
-  /**
-   * Delete a note.
-   */
-  async deleteNote<T = any>(leadId: string, noteId: string) {
-    return this.deleteRequest(`/api/crm/notes/${noteId}`);
-  }
-
-  /**
-   * Archive (soft-delete) a single lead.
-   *
-   * @param leadId - The ID of the lead to archive.
-   */
-  async delete(leadId: string) {
-    return this.deleteRequest(`/api/crm/leads/${leadId}`);
-  }
-
-  /**
-   * Bulk archive multiple leads.
-   *
-   * @param ids - Array of lead IDs to archive.
-   */
-  async bulkDelete(ids: string[]) {
-    return this.deleteRequest("/api/crm/leads", { data: { ids } });
-  }
-}

package/src/resources/crm/payments.ts

@@ -1,27 +0,0 @@
-import { APIResource } from "../../resource";
-
-export class Payments extends APIResource {
-  /**
-   * Record an inbound payment/transaction against a lead or specific appointment.
-   *
-   * @param payload - Payment details (leadId, amount, currency, description).
-   * @example
-   * ```typescript
-   * await erixClient.crm.payments.capture({
-   *   leadId: "lead_123",
-   *   amount: 5000,
-   *   currency: "INR",
-   *   description: "Consultation Fee"
-   * });
-   * ```
-   */
-  async capture<T = any>(payload: {
-    leadId: string;
-    amount: number;
-    currency?: string;
-    description?: string;
-    appointmentId?: string;
-  }) {
-    return this.post<T>("/api/crm/payments/capture", payload);
-  }
-}