@ecodrix/erix-api 1.2.7 → 1.2.9

package/src/resources/whatsapp/index.ts

@@ -1,67 +0,0 @@
-import type { AxiosInstance } from "axios";
-import { APIResource } from "../../resource";
-import { Broadcasts } from "./broadcasts";
-import { Conversations } from "./conversations";
-import { Messages } from "./messages";
-import { Templates } from "./templates";
-
-export interface SendTemplatePayload {
-  /** Phone number in E.164 format. */
-  phone: string;
-  /** Name of the pre-approved WhatsApp template. */
-  templateName: string;
-  /** Language code (defaults to "en"). */
-  languageCode?: string;
-  /** Key-value pairs matching variables in your template (e.g., {{1}}, {{2}}). */
-  variables?: Record<string, string>;
-  /** Explicitly resolved variables if bypassing the internal resolution engine. */
-  resolvedVariables?: any[];
-}
-
-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/chat/upload", form, {
-      headers:
-        typeof (form as any).getHeaders === "function" ? (form as any).getHeaders() : undefined,
-    });
-  }
-
-  /**
-   * Dispatch a WhatsApp template message directly to a specific phone number.
-   * Bypasses the automation queue for immediate high-priority delivery.
-   *
-   * @param payload - The template dispatch payload.
-   * @returns Information about the dispatched message.
-   */
-  async sendTemplate(payload: SendTemplatePayload): Promise<{
-    success: boolean;
-    messageId?: string;
-    templateName?: string;
-    resolvedVariables?: any[];
-  }> {
-    return this.post<{
-      success: boolean;
-      messageId?: string;
-      templateName?: string;
-      resolvedVariables?: any[];
-    }>("/api/saas/marketing/whatsapp/send-template", payload);
-  }
-}

package/src/resources/whatsapp/messages.ts

@@ -1,239 +0,0 @@
-import { APIResource } from "../../resource";
-
-/**
- * Parameters for sending a free-form WhatsApp message.
- */
-export interface SendMessageParams {
-  /**
-   * Recipient's phone number in E.164 format.
-   * @example "+919876543210"
-   */
-  to?: string;
-  /**
-   * The unique ID of the conversation. If supplied, `to` is resolved automatically.
-   */
-  conversationId?: string;
-  /** Plain text body of the message. */
-  text?: string;
-  /** Public URL of the media asset to send. */
-  mediaUrl?: string;
-  /** MIME category of the media. */
-  mediaType?: "image" | "video" | "audio" | "document";
-  /** The `messageId` of the message to reply to (quoted replies). */
-  replyToId?: string;
-  /** Filename shown to the recipient (required for `document` type). */
-  filename?: string;
-  /** Arbitrary metadata stored with the message record. */
-  metadata?: Record<string, any>;
-  /** Template name for template messages. */
-  templateName?: string;
-  /** Template language for template messages. */
-  templateLanguage?: string;
-  /** Alternative language parameter. */
-  language?: string;
-  /** Template variables. */
-  variables?: string[];
-}
-
-/**
- * Parameters for sending a pre-approved WhatsApp Business template.
- */
-export interface SendTemplateParams {
-  /**
-   * Recipient's phone number in E.164 format.
-   * @example "+919876543210"
-   */
-  to?: string;
-  /**
-   * The unique ID of the conversation.
-   */
-  conversationId?: string;
-  /** The exact template name as approved in Meta Business Manager. */
-  templateName: string;
-  /**
-   * BCP-47 language code for the template.
-   * @default "en_US"
-   */
-  language?: string;
-  /**
-   * Ordered array of variable substitutions for template placeholders.
-   * @example ["Alice", "10 April 2026", "10:00 AM"]
-   */
-  variables?: string[];
-  /** Optional header media URL (for templates with media headers). */
-  mediaUrl?: string;
-  /** Media type for the header (e.g. "image", "document"). */
-  mediaType?: string;
-  /** User ID of the agent sending the message. */
-  userId?: string;
-  /** Optional filename for media headers. */
-  filename?: string;
-  /** Template language for template messages. */
-  templateLanguage?: string;
-}
-
-/**
- * WhatsApp outbound messaging resource.
- *
- * Access via `ecod.whatsapp.messages`.
- *
- * @example
- * ```typescript
- * await ecod.whatsapp.messages.send({
- *   to: "+919876543210",
- *   text: "Your appointment is confirmed!",
- * });
- * ```
- */
-/**
- * Resolved media metadata returned by any upload endpoint.
- * `variants` is only present for raster images (JPEG, PNG, WebP, AVIF, GIF).
- */
-export interface ChatMediaMeta {
-  /** Raw CDN URL — always present, all media types */
-  url: string;
-  /** Categorical type — "image" | "video" | "audio" | "document" */
-  type: "image" | "video" | "audio" | "document";
-  /** Cloudflare-optimised variant URLs. Only present for raster images. */
-  variants?: {
-    /** 150px WebP — use for list thumbnails and chat bubbles */
-    thumb: string;
-    /** 600px WebP — use for modal previews */
-    medium: string;
-    /** 1200px WebP — use for hero or full-screen views */
-    full: string;
-    /** Original CDN URL, no transformation */
-    raw: string;
-  };
-  /** Storage key within the tenant bucket */
-  key?: string;
-  /** Original filename */
-  fileName?: string;
-}
-
-export class Messages extends APIResource {
-  /**
-   * Send a free-text or media message to a WhatsApp number.
-   *
-   * For text-only messages, supply `text`. For media, supply `mediaUrl`
-   * and `mediaType`. Both can be combined in a single message.
-   *
-   * @param params - Message parameters including recipient, text, and media.
-   * @returns The created message record from the database.
-   *
-   * @example Send a simple text message
-   * ```typescript
-   * await erixClient.whatsapp.messages.send({
-   *   to: "+919876543210",
-   *   text: "Hello from Ecodrix!",
-   * });
-   * ```
-   *
-   * @example Send an image with a caption
-   * ```typescript
-   * await erixClient.whatsapp.messages.send({
-   *   to: "+919876543210",
-   *   text: "Check out this flyer",
-   *   mediaUrl: "https://example.com/flyer.jpg",
-   *   mediaType: "image",
-   * });
-   * ```
-   */
-  async send<T = any>(params: SendMessageParams) {
-    return this.post<T>("/api/saas/chat/send", params);
-  }
-
-  /**
-   * Send a pre-approved WhatsApp Business template message.
-   *
-   * Templates must be approved in Meta Business Manager before they can be sent.
-   * Variable placeholders (e.g., {{1}}, {{2}}) are replaced with values from the
-   * `variables` array in order.
-   *
-   * @param params - Template message configuration (name, language, variables).
-   * @returns The created message record.
-   *
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.messages.sendTemplate({
-   *   to: "+919876543210",
-   *   templateName: "welcome_user",
-   *   language: "en_US",
-   *   variables: ["Alice"], // Replaces {{1}} in template
-   * });
-   * ```
-   */
-  async sendTemplate<T = any>(params: SendTemplateParams) {
-    return this.post<T>("/api/saas/chat/send", {
-      ...params,
-      templateLanguage: params.language || params.templateLanguage || "en_US",
-    });
-  }
-
-  /**
-   * 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).
-   *
-   * @param conversationId - The conversation to mark as read.
-   *
-   * @example
-   * ```typescript
-   * await ecod.whatsapp.messages.markRead("conv_64abc...");
-   * ```
-   */
-  async markRead(conversationId: string) {
-    return this.post(`/api/saas/chat/conversations/${conversationId}/read`);
-  }
-
-  /**
-   * Upload a media file for WhatsApp chat.
-   *
-   * Works with any file type — image, video, audio, or document.
-   * For raster images the response includes Cloudflare-optimised `variants`
-   * (thumb 150px, medium 600px, full 1200px). Non-image types return only `url`.
-   *
-   * @param file - The file to upload (File, Blob, or Buffer).
-   * @returns Full media metadata `{ url, type, variants?, key, fileName }`.
-   *
-   * @example
-   * ```typescript
-   * const file = input.files[0];
-   * const { data } = await ecod.whatsapp.messages.upload(file);
-   * // For images: data.variants.thumb → 150px WebP from Cloudflare
-   * // For video/audio: use data.url directly in <video> or <audio>
-   * ```
-   */
-  async upload(file: any): Promise<{ success: boolean; data: ChatMediaMeta }> {
-    const formData = new FormData();
-    formData.append("file", file);
-
-    return this.post<{ success: boolean; data: ChatMediaMeta }>("/api/saas/chat/upload", formData, {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-    });
-  }
-}

package/src/resources/whatsapp/templates.ts

@@ -1,218 +0,0 @@
-import { APIResource } from "../../resource";
-import type { ResourceManifest } from "../../types/metadata";
-
-export interface TemplateMapping {
-  mappings: any[];
-  onEmptyVariable: string;
-}
-
-export class Templates extends APIResource {
-  /**
-   * List all WhatsApp message templates in the tenant database.
-   *
-   * @param params - Optional filter parameters (status, mappingStatus, channel).
-   * @returns List of message templates.
-   * @example
-   * ```typescript
-   * const templates = await erixClient.whatsapp.templates.list({ status: "APPROVED" });
-   * ```
-   */
-  async list<T = any>(params?: {
-    status?: string;
-    mappingStatus?: string;
-    channel?: string;
-  }) {
-    return this.get<T>("/api/saas/chat/templates", { params } as any);
-  }
-
-  /**
-   * Synchronize templates from the Meta WhatsApp Business API.
-   * This updates the local database with the latest template status and content from Meta.
-   *
-   * @returns Success status of the sync operation.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.templates.sync();
-   * ```
-   */
-  async sync<T = any>() {
-    return this.post<T>("/api/saas/chat/templates/sync", {});
-  }
-
-  /**
-   * Retrieve details of a specific WhatsApp template.
-   *
-   * @param templateIdentifier - The name or ID of the template.
-   * @returns Detailed template object including components and status.
-   * @example
-   * ```typescript
-   * const template = await erixClient.whatsapp.templates.retrieve("welcome_message");
-   * ```
-   */
-  async retrieve<T = any>(templateIdentifier: string) {
-    return this.get<T>(`/api/saas/chat/templates/${encodeURIComponent(templateIdentifier)}`);
-  }
-
-  /**
-   * Create a new WhatsApp template manually (Draft).
-   *
-   * @param payload - Template configuration (name, category, language, components).
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.templates.create({
-   *   name: "new_promotion",
-   *   category: "MARKETING",
-   *   language: "en_US",
-   *   components: [...]
-   * });
-   * ```
-   */
-  async create<T = any>(payload: any) {
-    return this.post<T>("/api/saas/chat/templates", payload);
-  }
-
-  /**
-   * Update an existing WhatsApp template.
-   *
-   * @param templateId - The unique ID of the template.
-   * @param payload - Updated template configuration.
-   */
-  async update<T = any>(templateId: string, payload: any) {
-    return this.put<T>(`/api/saas/chat/templates/${templateId}`, payload);
-  }
-
-  /**
-   * Delete a WhatsApp template from both the local database and Meta (if specified).
-   *
-   * @param templateName - The name of the template to delete.
-   * @param force - If true, attempts to delete from Meta API as well.
-   * @example
-   * ```typescript
-   * await erixClient.whatsapp.templates.deleteTemplate("old_template", true);
-   * ```
-   */
-  async deleteTemplate<T = any>(templateName: string, force?: boolean) {
-    return this.deleteRequest<T>(
-      `/api/saas/chat/templates/${encodeURIComponent(templateName)}${force ? "?force=true" : ""}`,
-    );
-  }
-
-  /**
-   * List available configuration options for variable mapping.
-   *
-   * @example
-   * ```typescript
-   * const config = await erixClient.whatsapp.templates.mappingConfig();
-   * ```
-   */
-  async mappingConfig<T = any>() {
-    return this.get<T>("/api/saas/chat/templates/mapping/config");
-  }
-
-  /**
-   * List CRM collections available for variable mapping (Leads, Deals, etc.).
-   */
-  async collections<T = any>() {
-    return this.get<T>("/api/saas/chat/templates/collections");
-  }
-
-  /**
-   * List fields for a specific CRM collection to be used in mapping.
-   *
-   * @param collectionName - The name of the CRM collection.
-   */
-  async collectionFields<T = any>(collectionName: string) {
-    return this.get<T>(
-      `/api/saas/chat/templates/collections/${encodeURIComponent(collectionName)}/fields`,
-    );
-  }
-
-  /**
-   * Update variable mappings for a template to automate personalization.
-   *
-   * @param templateName - Name of the template.
-   * @param payload - Mapping definitions.
-   */
-  async updateMapping<T = any>(templateName: string, payload: TemplateMapping) {
-    return this.put<T>(
-      `/api/saas/chat/templates/${encodeURIComponent(templateName)}/mapping`,
-      payload,
-    );
-  }
-
-  /**
-   * Validate if a template is ready for automated sending based on its mappings.
-   */
-  async validate<T = any>(templateName: string) {
-    return this.get<T>(`/api/saas/chat/templates/${encodeURIComponent(templateName)}/validate`);
-  }
-
-  /**
-   * Preview a template resolution with sample data.
-   *
-   * @param templateName - Name of the template.
-   * @param context - Lead data or variable overrides for preview.
-   * @example
-   * ```typescript
-   * const preview = await erixClient.whatsapp.templates.preview("welcome", {
-   *   lead: { firstName: "Alice" }
-   * });
-   * ```
-   */
-  async preview<T = any>(templateName: string, context: { lead?: any; vars?: any }) {
-    return this.post<T>(`/api/saas/chat/templates/${encodeURIComponent(templateName)}/preview`, {
-      context,
-    });
-  }
-
-  /**
-   * Introspect a template and provide a manifest of its required variables.
-   *
-   * This is used by Erix React to build dynamic "Mapping Forms" where users
-   * can connect CRM fields to WhatsApp variables.
-   *
-   * @param templateIdentifier - The name or ID of the template.
-   */
-  async getVariableManifest(templateIdentifier: string): Promise<ResourceManifest> {
-    const template: any = await this.retrieve(templateIdentifier);
-    const components = Array.isArray(template.data?.components) ? template.data.components : [];
-
-    const fields: any[] = [];
-
-    for (const comp of components) {
-      // Look for {{n}} pattern in text components
-      if (comp.text) {
-        const vars = comp.text.match(/{{(\d+)}}/g);
-        if (vars) {
-          for (const v of vars) {
-            const index = v.replace(/{{|}}/g, "");
-            fields.push({
-              key: `var_${index}`,
-              label: `${comp.type} Var {{${index}}}`,
-              type: "string",
-              required: true,
-              group: comp.type,
-              description: `Variable placeholder in template ${comp.type}`,
-            });
-          }
-        }
-      }
-    }
-
-    return {
-      name: `Template variables: ${template.data?.name || templateIdentifier}`,
-      fields,
-      uiHints: {
-        icon: "Variables",
-        primaryColor: "#059669",
-      },
-    };
-  }
-
-  /**
-   * Check which automations or sequences are currently using this template.
-   */
-  async checkUsage<T = any>(templateName: string) {
-    return this.get<T>(`/api/saas/chat/templates/${encodeURIComponent(templateName)}/usage`);
-  }
-}

package/src/types/metadata.ts

@@ -1,71 +0,0 @@
-/**
- * The specific UI control type suggested for a field.
- */
-export type FieldType =
-  | "string"
-  | "number"
-  | "boolean"
-  | "date"
-  | "datetime"
-  | "select"
-  | "multi-select"
-  | "phone"
-  | "email"
-  | "currency"
-  | "json"
-  | "textarea"
-  | "richtext"
-  | "file"
-  | "image";
-
-/**
- * Metadata defining a single field within a resource.
- * Used by UI kits to automatically generate forms and validation logic.
- */
-export interface FieldManifest {
-  /** The technical key name used in API requests. */
-  key: string;
-  /** Human-readable label (localized if possible). */
-  label: string;
-  /** Suggested UI type. */
-  type: FieldType;
-  /** Short hint/placeholder text. */
-  description?: string;
-  /** Whether the field is required for creation. */
-  required: boolean;
-  /** Whether the field should be hidden from standard create/edit forms. */
-  hidden?: boolean;
-  /** If type is 'select', the available options. */
-  options?: Array<{ label: string; value: string | number }>;
-  /** Validation constraints. */
-  validation?: {
-    regex?: string;
-    min?: number;
-    max?: number;
-    message?: string;
-  };
-  /** Whether the field is read-only. */
-  readOnly?: boolean;
-  /** UI grouping/category name. */
-  group?: string;
-}
-
-/**
- * A logical grouping of fields and UI hints for a top-level resource.
- * Provides a 'blueprint' for erix-react components.
- */
-export interface ResourceManifest {
-  /** The unique name of the resource (e.g., 'Lead', 'Template'). */
-  name: string;
-  /** All available fields for this resource. */
-  fields: FieldManifest[];
-  /** Suggested UI configurations. */
-  uiHints?: {
-    icon?: string;
-    primaryColor?: string;
-    /** Default sort order. */
-    defaultSort?: { field: string; direction: "asc" | "desc" };
-    /** Fields to show in a compact table view. */
-    summaryFields?: string[];
-  };
-}