@ecodrix/erix-api 1.1.5 → 1.1.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ecodrix/erix-api",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "author": "ECODrIx Team <contact@ecodrix.com>",
   "license": "MIT",
   "description": "Official Isomorphic SDK for the ECODrIx platform. Native support for WhatsApp, CRM, Storage, and Meetings across TS, JS, Python, and Java.",

package/src/resources/crm/analytics.ts

@@ -14,11 +14,12 @@ export class Analytics extends APIResource {
    * Retrieve high-level CRM performance KPIs.
    * Includes total leads, pipeline value, won revenue, and conversion rates.
    *
-   * @param params - Optional filters (time range, pipelineId).
-   * @returns KPI summary object.
+   * @param params - Optional filters including time range (24h, 7d, 30d, etc.) and custom date bounds.
+   * @returns {Promise<any>} KPI summary object containing core business metrics.
    * @example
    * ```typescript
    * const stats = await erixClient.crm.analytics.overview({ range: "30d" });
+   * console.log(stats.avgScore);
    * ```
    */
   async overview<T = any>(params?: AnalyticsParams) {
@@ -27,9 +28,10 @@ export class Analytics extends APIResource {
 
   /**
    * Get stage-by-stage lead counts and conversion percentages for a pipeline.
-   * Useful for identifying funnel bottlenecks.
+   * Useful for identifying funnel bottlenecks and drop-off points.
    *
    * @param pipelineId - The unique ID of the pipeline to analyze.
+   * @returns {Promise<any>} Array of funnel stages with count and conversion data.
    * @example
    * ```typescript
    * const funnel = await erixClient.crm.analytics.funnel("pipe_123");
@@ -42,56 +44,88 @@ export class Analytics extends APIResource {
   }
 
   /**
-   * Revenue forecast: deal value × stage probability.
+   * Revenue forecast: Calculates expected revenue based on deal value × stage probability.
+   * Helps in sales planning and goal setting.
+   *
+   * @param pipelineId - Optional pipeline ID to filter the forecast.
+   * @returns {Promise<any>} Forecast data including weighted expected revenue.
+   * @example
+   * ```typescript
+   * const prognosis = await erixClient.crm.analytics.forecast("pipe_123");
+   * ```
    */
   async forecast<T = any>(pipelineId?: string) {
-    return this.get<T>("/api/crm/analytics/forecast", { params: { pipelineId } } as any);
+    return this.get<T>("/api/crm/analytics/forecast", {
+      params: { pipelineId },
+    } as any);
   }
 
   /**
-   * Lead source breakdown: count, conversion rate, total value per source.
+   * Lead source breakdown: count, conversion rate, and total value per source.
+   *
+   * @param params - Time range filters.
+   * @returns {Promise<any>} Breakdown of how different marketing channels are performing.
    */
   async sources<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/sources", { params } as any);
   }
 
   /**
-   * Team leaderboard: won deals, revenue, activity count, conversion rate per member.
+   * Team leaderboard: Evaluates agent performance across won deals, revenue, and activity.
+   *
+   * @param params - Time range filters.
+   * @returns {Promise<any>} Ranked list of team members by performance.
    */
   async team<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/team", { params } as any);
   }
 
   /**
-   * Daily activity counts by type. For activity calendar.
+   * Activity heatmap: Daily activity counts by type.
+   * Ideal for visualizing engagement patterns on a calendar view.
+   *
+   * @param params - Time range filters.
+   * @returns {Promise<any>} Time-series data of team activities.
    */
   async heatmap<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/heatmap", { params } as any);
   }
 
   /**
-   * Score distribution: how many leads in each score bucket.
+   * Score distribution: Groups leads into buckets based on their calculated score (0-100).
+   *
+   * @returns {Promise<any>} Volume of leads in different readiness tiers.
    */
   async scores<T = any>() {
     return this.get<T>("/api/crm/analytics/scores");
   }
 
   /**
-   * Avg time leads spend in each stage. Helps find bottlenecks.
+   * Avg time in stage: Measures the velocity of leads through the sales pipeline.
+   *
+   * @param pipelineId - Target pipeline ID.
+   * @returns {Promise<any>} Velocity metrics per stage.
    */
   async stageTime<T = any>(pipelineId: string) {
-    return this.get<T>("/api/crm/analytics/stage-time", { params: { pipelineId } } as any);
+    return this.get<T>("/api/crm/analytics/stage-time", {
+      params: { pipelineId },
+    } as any);
   }
 
   /**
-   * Tiered Growth Report matching business sophistication.
+   * Tiered Growth Report matching business sophistication (Pulse, Growth, Weapon).
+   * Provides deep tactical and strategic insights.
+   *
+   * @param params - Filtering and range parameters.
    */
   async tiered<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/tiered", { params } as any);
   }
 
   /**
-   * Consolidated analytics including CRM overview and WhatsApp.
+   * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
+   *
+   * @param params - Time range filters.
    */
   async summary<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/summary", { params } as any);
@@ -99,15 +133,16 @@ export class Analytics extends APIResource {
 
   /**
    * Retrieve WhatsApp messaging volume and delivery performance analytics.
+   * Includes total sent, delivered, read, and daily volume trends.
    *
    * @param params - Optional filters (time range).
    * @example
    * ```typescript
    * const waStats = await erixClient.crm.analytics.whatsapp({ range: "7d" });
+   * console.log(waStats.totalSent);
    * ```
    */
   async whatsapp<T = any>(params?: AnalyticsParams) {
     return this.get<T>("/api/crm/analytics/whatsapp", { params } as any);
   }
-
 }