@ecodrix/erix-api 1.1.4 → 1.1.5

package/src/resources/whatsapp/templates.ts

@@ -7,42 +7,90 @@ export interface TemplateMapping {
 
 export class Templates extends APIResource {
   /**
-   * List all templates from the tenant database.
+   * 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 }) {
+  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 Meta API.
+   * 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", {});
   }
 
   /**
-   * Get template details.
+   * 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)}`);
+    return this.get<T>(
+      `/api/saas/chat/templates/${encodeURIComponent(templateIdentifier)}`,
+    );
   }
 
   /**
-   * Create a new template manually.
+   * 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 template.
+   * 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 template.
+   * 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>(
@@ -51,21 +99,28 @@ export class Templates extends APIResource {
   }
 
   /**
-   * List curated mapping config options.
+   * 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 for variable mapping.
+   * List CRM collections available for variable mapping (Leads, Deals, etc.).
    */
   async collections<T = any>() {
     return this.get<T>("/api/saas/chat/templates/collections");
   }
 
   /**
-   * List CRM fields for a collection.
+   * 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>(
@@ -74,7 +129,10 @@ export class Templates extends APIResource {
   }
 
   /**
-   * Update variable mappings for a template.
+   * 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>(
@@ -84,16 +142,30 @@ export class Templates extends APIResource {
   }
 
   /**
-   * Validate mapping readiness.
+   * 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`);
+    return this.get<T>(
+      `/api/saas/chat/templates/${encodeURIComponent(templateName)}/validate`,
+    );
   }
 
   /**
-   * Preview a template resolution.
+   * 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 }) {
+  async preview<T = any>(
+    templateName: string,
+    context: { lead?: any; vars?: any },
+  ) {
     return this.post<T>(
       `/api/saas/chat/templates/${encodeURIComponent(templateName)}/preview`,
       { context },
@@ -101,9 +173,11 @@ export class Templates extends APIResource {
   }
 
   /**
-   * Check automation usage of a template.
+   * 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`);
+    return this.get<T>(
+      `/api/saas/chat/templates/${encodeURIComponent(templateName)}/usage`,
+    );
   }
 }