@ecodrix/erix-api 1.0.0

package/src/resources/whatsapp/index.ts

@@ -0,0 +1,49 @@
+import { APIResource } from "../../resource";
+import { Messages } from "./messages";
+import { Conversations } from "./conversations";
+import type { AxiosInstance } from "axios";
+
+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;
+
+  constructor(client: AxiosInstance) {
+    super(client);
+    this.messages = new Messages(client);
+    this.conversations = new Conversations(client);
+  }
+
+  /**
+   * 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/whatsapp/send-template", payload);
+  }
+}

package/src/resources/whatsapp/messages.ts

@@ -0,0 +1,138 @@
+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;
+  /** 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>;
+}
+
+/**
+ * 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 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;
+}
+
+/**
+ * WhatsApp outbound messaging resource.
+ *
+ * Access via `ecod.whatsapp.messages`.
+ *
+ * @example
+ * ```typescript
+ * await ecod.whatsapp.messages.send({
+ *   to: "+919876543210",
+ *   text: "Your appointment is confirmed!",
+ * });
+ * ```
+ */
+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.
+   *
+   * @param params - Message parameters.
+   * @returns The created message record.
+   *
+   * @example Text message
+   * ```typescript
+   * await ecod.whatsapp.messages.send({
+   *   to: "+919876543210",
+   *   text: "Hello!",
+   * });
+   * ```
+   *
+   * @example Media message
+   * ```typescript
+   * await ecod.whatsapp.messages.send({
+   *   to: "+919876543210",
+   *   mediaUrl: "https://cdn.ecodrix.com/invoice.pdf",
+   *   mediaType: "document",
+   *   filename: "invoice.pdf",
+   * });
+   * ```
+   */
+  async send(params: SendMessageParams) {
+    return this.post("/api/saas/chat/send", params);
+  }
+
+  /**
+   * Send a pre-approved WhatsApp Business template message.
+   *
+   * Templates must be approved in Meta Business Manager before use.
+   * Variable placeholders in the template body are filled left-to-right
+   * from the `variables` array.
+   *
+   * @param params - Template message parameters.
+   * @returns The created message record.
+   *
+   * @example
+   * ```typescript
+   * await ecod.whatsapp.messages.sendTemplate({
+   *   to: "+919876543210",
+   *   templateName: "appointment_reminder",
+   *   language: "en_US",
+   *   variables: ["Alice", "10 April", "10:00 AM"],
+   * });
+   * ```
+   */
+  async sendTemplate(params: SendTemplateParams) {
+    return this.post("/api/saas/chat/send", {
+      ...params,
+      templateLanguage: params.language || "en_US",
+    });
+  }
+
+  /**
+   * 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`);
+  }
+}