@ecodrix/erix-api 1.0.0 → 1.0.3

package/src/resources/events.ts

@@ -64,6 +64,17 @@ export interface TriggerPayload {
   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[];
+  };
 }
 
 /**
@@ -118,4 +129,34 @@ export class EventsResource extends APIResource {
   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

@@ -0,0 +1,61 @@
+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;
+}
+
+export class Health extends APIResource {
+  /**
+   * Global platform health check.
+   */
+  async system(): Promise<SystemHealth> {
+    const res = await this.get<{ data: SystemHealth }>("/api/saas/health", { headers: { accept: "application/json" } });
+    return res.data;
+  }
+
+  /**
+   * Tenant-specific health check. Identifies configured services.
+   */
+  async clientHealth(): Promise<ClientHealth> {
+    const res = await this.get<{ data: ClientHealth }>("/api/saas/health/client");
+    return res.data;
+  }
+
+  /**
+   * Job execution status lookup.
+   */
+  async jobStatus(jobId: string): Promise<JobStatus> {
+    const res = await this.get<{ data: JobStatus }>(`/api/saas/jobs/status/${jobId}`);
+    return res.data;
+  }
+}

package/src/resources/marketing.ts

@@ -0,0 +1,104 @@
+import { APIResource } from "../resource";
+
+export interface SendCampaignParams {
+  recipients: string[];
+  subject: string;
+  html: string;
+}
+
+export class Emails extends APIResource {
+  /**
+   * Dispatch a bulk email campaign.
+   */
+  async sendCampaign<T = any>(params: SendCampaignParams) {
+    return this.post<T>("/api/saas/marketing/emails/campaign", params);
+  }
+
+  /**
+   * Send a test verification email (used to verify SMTP functionality).
+   */
+  async sendTest<T = any>(to: string) {
+    return this.post<T>("/api/saas/marketing/emails/test", { to });
+  }
+}
+export class Campaigns extends APIResource {
+  /**
+   * List email and SMS marketing campaigns.
+   */
+  async list<T = any>(params?: { status?: string; limit?: number }) {
+    return this.get<T>("/api/saas/marketing/campaigns", { params } as any);
+  }
+
+  /**
+   * Create a new campaign.
+   */
+  async create<T = any>(payload: { name: string; type: string; subject?: string; html?: string; templateId?: string; recipients?: string[] }) {
+    return this.post<T>("/api/saas/marketing/campaigns", payload);
+  }
+
+  /**
+   * Retrieve campaign details.
+   */
+  async retrieve<T = any>(campaignId: string) {
+    return this.get<T>(`/api/saas/marketing/campaigns/${campaignId}`);
+  }
+
+  /**
+   * Update a campaign.
+   */
+  async update<T = any>(campaignId: string, payload: any) {
+    return this.patch<T>(`/api/saas/marketing/campaigns/${campaignId}`, payload);
+  }
+
+  /**
+   * Delete a campaign.
+   */
+  async delete<T = any>(campaignId: string) {
+    return this.deleteRequest<T>(`/api/saas/marketing/campaigns/${campaignId}`);
+  }
+
+  /**
+   * Send or schedule a campaign.
+   */
+  async send<T = any>(campaignId: string, payload?: { scheduledAt?: string }) {
+    return this.post<T>(`/api/saas/marketing/campaigns/${campaignId}/send`, payload || {});
+  }
+
+  /**
+   * Get campaign stats (opens, clicks, bounces).
+   */
+  async stats<T = any>(campaignId: string) {
+    return this.get<T>(`/api/saas/marketing/campaigns/${campaignId}/stats`);
+  }
+}
+
+export class WhatsAppMarketing extends APIResource {
+  /**
+   * Dispatch a template-based WhatsApp message with CRM-integrated variable resolution.
+   *
+   * Unlike direct WhatsApp sending, this endpoint automatically pulls data from the CRM
+   * based on the provided variables mapping.
+   */
+  async sendTemplate<T = any>(params: {
+    phone: string;
+    templateName: string;
+    languageCode?: string;
+    variables?: Record<string, string>;
+    resolvedVariables?: Record<string, string>;
+  }) {
+    return this.post<T>("/api/saas/marketing/whatsapp/send-template", params);
+  }
+}
+
+export class Marketing extends APIResource {
+  public emails: Emails;
+  public campaigns: Campaigns;
+  public whatsapp: WhatsAppMarketing;
+
+  constructor(client: any) {
+    super(client);
+    this.emails = new Emails(client);
+    this.campaigns = new Campaigns(client);
+    this.whatsapp = new WhatsAppMarketing(client);
+  }
+}

package/src/resources/meet.ts

@@ -133,8 +133,15 @@ export class Meetings extends APIResource {
    * });
    * ```
    */
-  async update(meetingId: string, data: UpdateMeetingParams): Promise<any> {
-    return this.client.patch(`/api/saas/meet/${meetingId}`, data).then((res) => res.data);
+  async update<T = any>(meetingId: string, data: UpdateMeetingParams) {
+    return this.patch<T>(`/api/saas/meet/${meetingId}`, data);
+  }
+
+  /**
+   * Reschedule an existing meeting. Provides explicit method for time modifications.
+   */
+  async reschedule<T = any>(meetingId: string, params: { startTime: Date | string; endTime: Date | string; duration?: number }) {
+    return this.patch<T>(`/api/saas/meet/${meetingId}`, params);
   }
 
   /**

package/src/resources/notifications.ts

@@ -120,4 +120,34 @@ export class Notifications extends APIResource {
   async listCallbacks(params?: Omit<LogFilter, "trigger" | "phone">) {
     return this.get("/api/saas/callbacks/logs", { params } as any);
   }
+
+  // --- CRM Notifications (Alerts) ---
+
+  /**
+   * List active CRM notifications/alerts for the current agent.
+   */
+  async listAlerts<T = any>(params?: { limit?: number; unreadOnly?: boolean }) {
+    return this.get<T>("/api/saas/crm/notifications", { params } as any);
+  }
+
+  /**
+   * Dismiss a specific notification alert.
+   */
+  async dismissAlert<T = any>(notificationId: string) {
+    return this.patch<T>(`/api/saas/crm/notifications/${notificationId}/dismiss`);
+  }
+
+  /**
+   * Clear (dismiss) all notifications for the current agent.
+   */
+  async clearAllAlerts<T = any>() {
+    return this.deleteRequest<T>("/api/saas/crm/notifications/clear-all");
+  }
+
+  /**
+   * Retry an action from a notification (e.g. failed send).
+   */
+  async retryAction<T = any>(notificationId: string) {
+    return this.post<T>(`/api/saas/crm/notifications/${notificationId}/retry`, {});
+  }
 }

package/src/resources/queue.ts

@@ -0,0 +1,39 @@
+import { APIResource } from "../resource";
+
+export interface JobStats {
+  waiting: number;
+  active: number;
+  completed: number;
+  failed: number;
+  delayed: number;
+}
+
+export class Queue extends APIResource {
+  /**
+   * List all failed jobs.
+   */
+  async listFailed<T = any>() {
+    return this.get<T>("/api/saas/queue/failed");
+  }
+
+  /**
+   * Get queue health statistics.
+   */
+  async getStats<T = JobStats>() {
+    return this.get<T>("/api/saas/queue/stats");
+  }
+
+  /**
+   * Retry a failed job.
+   */
+  async retryJob<T = any>(jobId: string) {
+    return this.post<T>(`/api/saas/queue/${jobId}/retry`, {});
+  }
+
+  /**
+   * Remove a job from the queue.
+   */
+  async deleteJob<T = any>(jobId: string) {
+    return this.deleteRequest<T>(`/api/saas/queue/${jobId}`);
+  }
+}

package/src/resources/storage.ts

@@ -0,0 +1,72 @@
+import { APIResource } from "../resource";
+
+export class Folders extends APIResource {
+  /**
+   * Create a new folder.
+   */
+  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 in a folder.
+   */
+  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.
+   */
+  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/whatsapp/broadcasts.ts

@@ -0,0 +1,31 @@
+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 broadcasts.
+   */
+  async list<T = any>(params?: Record<string, any>) {
+    return this.get<T>("/api/saas/chat/broadcasts", { params } as any);
+  }
+
+  /**
+   * Create a new broadcast to send a template message to multiple recipients.
+   */
+  async create<T = any>(params: CreateBroadcastParams) {
+    return this.post<T>("/api/saas/chat/broadcast", params);
+  }
+}

package/src/resources/whatsapp/conversations.ts

@@ -3,41 +3,66 @@ 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.
    */
-  async list(params?: ListParams): Promise<any> {
-    return this.get("/api/saas/chat/conversations", { params } as any);
+  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.
+   */
+  async create<T = any>(params: { phone: string; name?: string }) {
+    return this.post<T>("/api/saas/chat/conversations", params);
   }
 
   /**
    * Retrieve details of a specific conversation.
    */
-  async retrieve(conversationId: string): Promise<any> {
-    return this.get(`/api/saas/chat/conversations/${conversationId}`);
+  async retrieve<T = any>(conversationId: string) {
+    return this.get<T>(`/api/saas/chat/conversations/${conversationId}`);
   }
 
   /**
    * Get messages for a specific conversation.
    */
-  async messages(conversationId: string, params?: ListParams): Promise<any> {
-    return this.get(`/api/saas/chat/conversations/${conversationId}/messages`, { params } as any);
+  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.
    */
-  async linkLead(conversationId: string, leadId: string) {
-    return this.post(`/api/saas/chat/conversations/${conversationId}/link-lead`, { leadId });
+  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).
+   */
+  async markRead<T = any>(conversationId: string) {
+    return this.post<T>(`/api/saas/chat/conversations/${conversationId}/read`, {});
   }
 
   /**
    * Delete a conversation.
    */
-  async delete(conversationId: string): Promise<any> {
+  async delete(conversationId: string) {
     return this.deleteRequest(`/api/saas/chat/conversations/${conversationId}`);
   }
+
+  /**
+   * Bulk delete conversations.
+   */
+  async bulkDelete(ids: string[]) {
+    return this.post("/api/saas/chat/conversations/bulk-delete", { ids });
+  }
 }

package/src/resources/whatsapp/index.ts

@@ -1,6 +1,8 @@
 import { APIResource } from "../../resource";
 import { Messages } from "./messages";
 import { Conversations } from "./conversations";
+import { Broadcasts } from "./broadcasts";
+import { Templates } from "./templates";
 import type { AxiosInstance } from "axios";
 
 export interface SendTemplatePayload {
@@ -19,11 +21,29 @@ export interface SendTemplatePayload {
 export class WhatsApp extends APIResource {
   public messages: Messages;
   public conversations: Conversations;
+  public broadcasts: Broadcasts;
+  public templates: Templates;
 
   constructor(client: AxiosInstance) {
     super(client);
     this.messages = new Messages(client);
     this.conversations = new Conversations(client);
+    this.broadcasts = new Broadcasts(client);
+    this.templates = new Templates(client);
+  }
+
+  /**
+   * Upload an asset directly to chat storage.
+   */
+  async upload<T = any>(file: Blob | Buffer | File | any, filename: string) {
+    const form = new FormData();
+    form.append("file", file, filename);
+    return this.post<T>("/api/saas/whatsapp/upload", form, {
+      headers:
+        typeof (form as any).getHeaders === "function"
+          ? (form as any).getHeaders()
+          : undefined,
+    });
   }
 
   /**

package/src/resources/whatsapp/messages.ts

@@ -122,6 +122,30 @@ export class Messages extends APIResource {
     });
   }
 
+  /**
+   * Star or unstar a message.
+   *
+   * @param messageId - The ID of the message.
+   * @param isStarred - Boolean indicating whether to star or unstar.
+   */
+  async star<T = any>(messageId: string, isStarred: boolean) {
+    return this.post<T>(`/api/saas/chat/messages/${messageId}/star`, {
+      isStarred,
+    });
+  }
+
+  /**
+   * 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.
+   */
+  async react<T = any>(messageId: string, reaction: string) {
+    return this.post<T>(`/api/saas/chat/messages/${messageId}/react`, {
+      reaction,
+    });
+  }
+
   /**
    * Mark all messages in a conversation as read (double-tick).
    *

package/src/resources/whatsapp/templates.ts

@@ -0,0 +1,99 @@
+import { APIResource } from "../../resource";
+
+export interface TemplateMapping {
+  mappings: any[];
+  onEmptyVariable: string;
+}
+
+export class Templates extends APIResource {
+  /**
+   * List all templates from the tenant database.
+   */
+  async list<T = any>(params?: { status?: string; mappingStatus?: string; channel?: string }) {
+    return this.get<T>("/api/saas/whatsapp/templates", { params } as any);
+  }
+
+  /**
+   * Synchronize templates from Meta API.
+   */
+  async sync<T = any>() {
+    return this.post<T>("/api/saas/whatsapp/templates/sync", {});
+  }
+
+  /**
+   * Get template details.
+   */
+  async retrieve<T = any>(templateIdentifier: string) {
+    return this.get<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateIdentifier)}`);
+  }
+
+  /**
+   * Create a new template manually.
+   */
+  async create<T = any>(payload: any) {
+    return this.post<T>("/api/saas/whatsapp/templates", payload);
+  }
+
+  /**
+   * Update an existing template.
+   */
+  async update<T = any>(templateId: string, payload: any) {
+    return this.put<T>(`/api/saas/whatsapp/templates/${templateId}`, payload);
+  }
+
+  /**
+   * Delete a template.
+   */
+  async deleteTemplate<T = any>(templateName: string, force?: boolean) {
+    return this.deleteRequest<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateName)}${force ? "?force=true" : ""}`);
+  }
+
+  /**
+   * List curated mapping config options.
+   */
+  async mappingConfig<T = any>() {
+    return this.get<T>("/api/saas/whatsapp/templates/mapping/config");
+  }
+
+  /**
+   * List CRM collections for variable mapping.
+   */
+  async collections<T = any>() {
+    return this.get<T>("/api/saas/whatsapp/templates/collections");
+  }
+
+  /**
+   * List CRM fields for a collection.
+   */
+  async collectionFields<T = any>(collectionName: string) {
+    return this.get<T>(`/api/saas/whatsapp/templates/collections/${encodeURIComponent(collectionName)}/fields`);
+  }
+
+  /**
+   * Update variable mappings for a template.
+   */
+  async updateMapping<T = any>(templateName: string, payload: TemplateMapping) {
+    return this.put<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateName)}/mapping`, payload);
+  }
+
+  /**
+   * Validate mapping readiness.
+   */
+  async validate<T = any>(templateName: string) {
+    return this.get<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateName)}/validate`);
+  }
+
+  /**
+   * Preview a template resolution.
+   */
+  async preview<T = any>(templateName: string, context: { lead?: any; vars?: any }) {
+    return this.post<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateName)}/preview`, { context });
+  }
+
+  /**
+   * Check automation usage of a template.
+   */
+  async checkUsage<T = any>(templateName: string) {
+    return this.get<T>(`/api/saas/whatsapp/templates/${encodeURIComponent(templateName)}/usage`);
+  }
+}