@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/resources/notifications.ts

@@ -1,178 +0,0 @@
-import { APIResource } from "../resource";
-
-/**
- * Filters for querying event and automation execution logs.
- */
-export 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",
- * });
- * ```
- */
-export 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,
-   * });
-   * ```
-   */
-  async listLogs(params?: LogFilter) {
-    return this.get("/api/saas/events/logs", { params } as any);
-  }
-
-  /**
-   * 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"
-   * ```
-   */
-  async retrieveLog(logId: string) {
-    return this.get(`/api/saas/events/logs/${logId}`);
-  }
-
-  /**
-   * 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}`);
-   * ```
-   */
-  async getStats(params?: { startDate?: string; endDate?: string }) {
-    return this.get("/api/saas/events/stats", { params } as any);
-  }
-
-  /**
-   * 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 });
-   * ```
-   */
-  async listCallbacks(params?: Omit<LogFilter, "trigger" | "phone">) {
-    return this.get("/api/saas/callbacks/logs", { params } as any);
-  }
-
-  // --- CRM Notifications (Alerts) ---
-  // Backend routes mounted at /api/crm — see crm.router.ts + notification.routes.ts
-
-  /**
-   * List unread CRM notifications and alerts (e.g., lead assignments, system alerts).
-   *
-   * @param params - Optional filters (limit, unreadOnly).
-   * @returns Paginated list of notification objects.
-   * @example
-   * ```typescript
-   * const alerts = await erixClient.notifications.listAlerts({ unreadOnly: true });
-   * ```
-   */
-  async listAlerts<T = any>(params?: { limit?: number; unreadOnly?: boolean }) {
-    return this.get<T>("/api/crm/notifications", { params } as any);
-  }
-
-  /**
-   * Dismiss/mark a specific notification alert as read.
-   *
-   * @param notificationId - The unique ID of the notification.
-   * @example
-   * ```typescript
-   * await erixClient.notifications.dismissAlert("alert_123");
-   * ```
-   */
-  async dismissAlert<T = any>(notificationId: string) {
-    return this.patch<T>(`/api/crm/notifications/${notificationId}/dismiss`);
-  }
-
-  /**
-   * Clear all notifications for the current tenant immediately.
-   *
-   * @example
-   * ```typescript
-   * await erixClient.notifications.clearAllAlerts();
-   * ```
-   */
-  async clearAllAlerts<T = any>() {
-    return this.deleteRequest<T>("/api/crm/notifications/clear-all");
-  }
-
-  /**
-   * Retry an action from a notification (e.g. failed automation send).
-   *
-   * @param notificationId - The unique ID of the notification.
-   * @example
-   * ```typescript
-   * await erixClient.notifications.retryAction("alert_123");
-   * ```
-   */
-  async retryAction<T = any>(notificationId: string) {
-    return this.post<T>(`/api/crm/notifications/${notificationId}/retry`, {});
-  }
-}

package/src/resources/queue.ts

@@ -1,64 +0,0 @@
-import { APIResource } from "../resource";
-
-export interface JobStats {
-  waiting: number;
-  active: number;
-  completed: number;
-  failed: number;
-  delayed: number;
-}
-
-export class Queue extends APIResource {
-  /**
-   * List all background jobs that have failed execution.
-   *
-   * @returns Array of failed job objects.
-   * @example
-   * ```typescript
-   * const failed = await erixClient.queue.listFailed();
-   * ```
-   */
-  async listFailed<T = any>() {
-    return this.get<T>("/api/saas/admin/queue/failed");
-  }
-
-  /**
-   * Get real-time health statistics for the background job queue (waiting, active, failed).
-   *
-   * @returns Queue statistics summary.
-   * @example
-   * ```typescript
-   * const stats = await erixClient.queue.getStats();
-   * console.log(`Active Jobs: ${stats.active}`);
-   * ```
-   */
-  async getStats<T = JobStats>() {
-    return this.get<T>("/api/saas/admin/queue/stats");
-  }
-
-  /**
-   * Manually retry a failed background job.
-   *
-   * @param jobId - The unique ID of the failed job.
-   * @example
-   * ```typescript
-   * await erixClient.queue.retryJob("job_123");
-   * ```
-   */
-  async retryJob<T = any>(jobId: string) {
-    return this.post<T>(`/api/saas/admin/queue/${jobId}/retry`, {});
-  }
-
-  /**
-   * Remove a job from the queue.
-   *
-   * @param jobId - The unique ID of the job to delete.
-   * @example
-   * ```typescript
-   * await erixClient.queue.deleteJob("job_123");
-   * ```
-   */
-  async deleteJob<T = any>(jobId: string) {
-    return this.deleteRequest<T>(`/api/saas/admin/queue/${jobId}`);
-  }
-}

package/src/resources/storage.ts

@@ -1,101 +0,0 @@
-import { APIResource } from "../resource";
-
-export class Folders extends APIResource {
-  /**
-   * Create a new folder in the tenant's cloud storage.
-   *
-   * @param name - The name of the folder to create.
-   * @example
-   * ```typescript
-   * await erixClient.storage.folders.create("Invoices");
-   * ```
-   */
-  async create<T = any>(name: string) {
-    return this.post<T>("/api/saas/storage/folders", { name });
-  }
-
-  /**
-   * Delete a folder and its contents.
-   */
-  async delete<T = any>(folderPath: string) {
-    return this.deleteRequest<T>(`/api/saas/storage/folders/${encodeURIComponent(folderPath)}`);
-  }
-}
-
-export class Files extends APIResource {
-  /**
-   * List files within a specific folder.
-   *
-   * @param folder - The folder name or path.
-   * @param params - Optional year/month filters for organized storage.
-   * @example
-   * ```typescript
-   * const files = await erixClient.storage.files.list("Invoices", { year: "2026" });
-   * ```
-   */
-  async list<T = any>(folder: string, params?: { year?: string; month?: string }) {
-    return this.get<T>(`/api/saas/storage/files/${folder}`, { params } as any);
-  }
-
-  /**
-   * Get a presigned upload URL for direct-to-cloud browser uploads.
-   * This allows the client to upload files directly to R2/S3 without hitting the backend.
-   *
-   * @param params - Upload parameters (folder, filename, contentType).
-   * @example
-   * ```typescript
-   * const { data } = await erixClient.storage.files.getUploadUrl({
-   *   folder: "Invoices",
-   *   filename: "inv_1.pdf",
-   *   contentType: "application/pdf"
-   * });
-   * // Now use data.url with a PUT request
-   * ```
-   */
-  async getUploadUrl<T = any>(params: {
-    folder: string;
-    filename: string;
-    contentType: string;
-  }) {
-    return this.post<T>("/api/saas/storage/upload-url", params);
-  }
-
-  /**
-   * Notify backend after a successful direct browser upload.
-   */
-  async confirmUpload<T = any>(params: { key: string; sizeBytes: number }) {
-    return this.post<T>("/api/saas/storage/confirm-upload", params);
-  }
-
-  /**
-   * Get a presigned download URL for an R2 key.
-   */
-  async getDownloadUrl<T = any>(key: string) {
-    return this.post<T>("/api/saas/storage/download-url", { key });
-  }
-
-  /**
-   * Delete a file by key.
-   */
-  async delete(key: string) {
-    return this.deleteRequest("/api/saas/storage/files", { params: { key } } as any);
-  }
-}
-
-export class Storage extends APIResource {
-  public folders: Folders;
-  public files: Files;
-
-  constructor(client: any) {
-    super(client);
-    this.folders = new Folders(client);
-    this.files = new Files(client);
-  }
-
-  /**
-   * Get tenant storage usage and quota limitations.
-   */
-  async usage<T = any>() {
-    return this.get<T>("/api/saas/storage/usage");
-  }
-}

package/src/resources/webhooks.ts

@@ -1,80 +0,0 @@
-import { APIError } from "../error";
-
-export class WebhookSignatureError extends APIError {
-  constructor(message: string) {
-    super(message, 400, "invalid_signature");
-    this.name = "WebhookSignatureError";
-  }
-}
-
-/**
- * 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}`);
- *   }
- * });
- * ```
- */
-export 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.
-   */
-  public async constructEvent(
-    payload: string | Buffer,
-    signature: string | string[] | undefined,
-    secret: string,
-  ): Promise<any> {
-    if (!signature) {
-      throw new WebhookSignatureError("No webhook signature provided");
-    }
-
-    let sig = Array.isArray(signature) ? signature[0] : signature;
-    if (sig.startsWith("sha256=")) {
-      sig = sig.slice(7);
-    }
-
-    try {
-      // Dynamic import ensures Isomorphic bundles (like Vite UI) don't crash on import,
-      // and only throw if someone incorrectly tries to verify a webhook in the browser.
-      const crypto = await import("node:crypto");
-
-      const hmac = crypto.createHmac("sha256", secret);
-      const digest = hmac.update(payload).digest("hex");
-
-      const isValid = crypto.timingSafeEqual(Buffer.from(digest), Buffer.from(sig));
-
-      if (!isValid) {
-        throw new WebhookSignatureError("Invalid webhook signature provided");
-      }
-
-      return JSON.parse(payload.toString("utf8"));
-    } catch (error: any) {
-      if (error instanceof WebhookSignatureError) {
-        throw error;
-      }
-      throw new WebhookSignatureError(`Webhook payload parsing failed: ${error.message}`);
-    }
-  }
-}

package/src/resources/whatsapp/broadcasts.ts

@@ -1,94 +0,0 @@
-import { APIResource } from "../../resource";
-
-export interface CreateBroadcastParams {
-  /** Optional name for the broadcast campaign */
-  name?: string;
-  /** Name of the Meta template to send */
-  templateName: string;
-  /** Language code (defaults to en_US) */
-  templateLanguage?: string;
-  /** List of recipients with their phone numbers and variable overrides */
-  recipients: {
-    phone: string;
-    variables?: string[];
-  }[];
-}
-
-export class Broadcasts extends APIResource {
-  /**
-   * List past and active WhatsApp broadcast campaigns.
-   *
-   * @param params - Optional filter parameters (page, limit, status).
-   * @returns Paginated list of broadcast records.
-   * @example
-   * ```typescript
-   * const broadcasts = await erixClient.whatsapp.broadcasts.list({ limit: 10 });
-   * ```
-   */
-  async list<T = any>(params?: Record<string, any>) {
-    return this.get<T>("/api/saas/chat/broadcasts", { params } as any);
-  }
-
-  /**
-   * Retrieve full details and real-time stats for a specific broadcast campaign.
-   *
-   * @param id - The unique identifier of the broadcast.
-   * @returns The broadcast record including sent/failed counts.
-   * @example
-   * ```typescript
-   * const stats = await erixClient.whatsapp.broadcasts.retrieve("bc_123");
-   * console.log(`Success Rate: ${(stats.sentCount / stats.totalRecipients) * 100}%`);
-   * ```
-   */
-  async retrieve<T = any>(id: string) {
-    return this.get<T>(`/api/saas/chat/broadcasts/${id}`);
-  }
-
-  /**
-   * Create a new broadcast campaign to send template messages to multiple recipients.
-   *
-   * @param params - Broadcast configuration (name, templateName, recipients).
-   * @returns The newly created broadcast record.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.broadcasts.create({
-   *   name: "Spring Sale",
-   *   templateName: "promo_code",
-   *   recipients: [
-   *     { phone: "+919876543210", variables: ["SAVE10"] }
-   *   ]
-   * });
-   * ```
-   */
-  async create<T = any>(params: CreateBroadcastParams) {
-    return this.post<T>("/api/saas/chat/broadcast", params);
-  }
-
-  /**
-   * Update broadcast metadata, such as its name or administrative status.
-   *
-   * @param id - The unique ID of the broadcast.
-   * @param data - The fields to update (name, status).
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.broadcasts.update("bc_123", { name: "Revised Spring Sale" });
-   * ```
-   */
-  async update<T = any>(id: string, data: { name?: string; status?: string }) {
-    return this.patch<T>(`/api/saas/chat/broadcasts/${id}`, data);
-  }
-
-  /**
-   * Delete a broadcast campaign record.
-   * Note: This does not cancel messages already in flight but removes the record from the dashboard.
-   *
-   * @param id - The unique ID of the broadcast.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.broadcasts.delete("bc_123");
-   * ```
-   */
-  async delete<T = any>(id: string) {
-    return this.deleteRequest<T>(`/api/saas/chat/broadcasts/${id}`);
-  }
-}

package/src/resources/whatsapp/conversations.ts

@@ -1,128 +0,0 @@
-import { APIResource } from "../../resource";
-
-export interface ListParams {
-  limit?: number;
-  before?: string;
-  after?: string;
-  status?: string;
-}
-
-export class Conversations extends APIResource {
-  /**
-   * List conversations for the tenant.
-   * @deprecated Use `list` method from `ErixClient` instead.
-   * @param params - List parameters.
-   * @returns List of conversations.
-   * @example
-   * ```typescript
-   * import { ErixClient } from "erix-react";
-   * const erixClient = new ErixClient({ apiKey: "YOUR_API_KEY" });
-   * const conversations = await erixClient.whatsapp.conversations.list();
-   * ```
-   */
-  async list<T = any>(params?: ListParams) {
-    return this.get<T>("/api/saas/chat/conversations", { params } as any);
-  }
-
-  /**
-   * Create a new conversation explicitly.
-   *
-   * @param params - Conversation details.
-   * @example
-   * ```typescript
-   * const conversation = await erixClient.whatsapp.conversations.create({
-   *   phone: "+919876543210",
-   *   name: "John Doe"
-   * });
-   * ```
-   */
-  async create<T = any>(params: { phone: string; name?: string }) {
-    return this.post<T>("/api/saas/chat/conversations", params);
-  }
-
-  /**
-   * Retrieve details of a specific conversation.
-   *
-   * @param conversationId - The unique ID of the conversation.
-   * @example
-   * ```typescript
-   * const conversation = await erixClient.whatsapp.conversations.retrieve("conv_123");
-   * ```
-   */
-  async retrieve<T = any>(conversationId: string) {
-    return this.get<T>(`/api/saas/chat/conversations/${conversationId}`);
-  }
-
-  /**
-   * Get messages for a specific conversation.
-   *
-   * @param conversationId - The unique ID of the conversation.
-   * @param params - Pagination and filter parameters.
-   * @example
-   * ```typescript
-   * const messages = await erixClient.whatsapp.conversations.messages("conv_123", { limit: 50 });
-   * ```
-   */
-  async messages<T = any>(conversationId: string, params?: ListParams) {
-    return this.get<T>(`/api/saas/chat/conversations/${conversationId}/messages`, {
-      params,
-    } as any);
-  }
-
-  /**
-   * Link a conversation to a lead in the CRM.
-   *
-   * @param conversationId - The unique ID of the conversation.
-   * @param leadId - The unique ID of the lead to link.
-   * @param leadData - Optional additional lead metadata.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.conversations.linkLead("conv_123", "lead_456");
-   * ```
-   */
-  async linkLead<T = any>(conversationId: string, leadId: string, leadData?: any) {
-    return this.post<T>(`/api/saas/chat/conversations/${conversationId}/link-lead`, {
-      leadId,
-      leadData,
-    });
-  }
-
-  /**
-   * Mark a conversation as read (clear unread count).
-   *
-   * @param conversationId - The unique ID of the conversation.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.conversations.markRead("conv_123");
-   * ```
-   */
-  async markRead<T = any>(conversationId: string) {
-    return this.post<T>(`/api/saas/chat/conversations/${conversationId}/read`, {});
-  }
-
-  /**
-   * Delete a conversation.
-   *
-   * @param conversationId - The unique ID of the conversation.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.conversations.delete("conv_123");
-   * ```
-   */
-  async delete(conversationId: string) {
-    return this.deleteRequest(`/api/saas/chat/conversations/${conversationId}`);
-  }
-
-  /**
-   * Bulk delete conversations.
-   *
-   * @param ids - Array of conversation IDs to delete.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.conversations.bulkDelete(["conv_1", "conv_2"]);
-   * ```
-   */
-  async bulkDelete<T = any>(ids: string[]) {
-    return this.post<T>("/api/saas/chat/conversations/bulk-delete", { ids });
-  }
-}