@ecodrix/erix-api 1.1.5 → 1.1.6

package/dist/ts/cjs/index.d.cts

@@ -132,19 +132,21 @@ declare 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);
      * ```
      */
     overview<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
      * 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");
@@ -152,44 +154,74 @@ declare class Analytics extends APIResource {
      */
     funnel<T = any>(pipelineId: string): Promise<T>;
     /**
-     * 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");
+     * ```
      */
     forecast<T = any>(pipelineId?: string): Promise<T>;
     /**
-     * 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.
      */
     sources<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     team<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     heatmap<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     scores<T = any>(): Promise<T>;
     /**
-     * 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.
      */
     stageTime<T = any>(pipelineId: string): Promise<T>;
     /**
-     * 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.
      */
     tiered<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Consolidated analytics including CRM overview and WhatsApp.
+     * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
+     *
+     * @param params - Time range filters.
      */
     summary<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
      * 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);
      * ```
      */
     whatsapp<T = any>(params?: AnalyticsParams): Promise<T>;

package/dist/ts/esm/index.d.ts

@@ -132,19 +132,21 @@ declare 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);
      * ```
      */
     overview<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
      * 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");
@@ -152,44 +154,74 @@ declare class Analytics extends APIResource {
      */
     funnel<T = any>(pipelineId: string): Promise<T>;
     /**
-     * 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");
+     * ```
      */
     forecast<T = any>(pipelineId?: string): Promise<T>;
     /**
-     * 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.
      */
     sources<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     team<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     heatmap<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * 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.
      */
     scores<T = any>(): Promise<T>;
     /**
-     * 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.
      */
     stageTime<T = any>(pipelineId: string): Promise<T>;
     /**
-     * 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.
      */
     tiered<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
-     * Consolidated analytics including CRM overview and WhatsApp.
+     * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
+     *
+     * @param params - Time range filters.
      */
     summary<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
      * 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);
      * ```
      */
     whatsapp<T = any>(params?: AnalyticsParams): Promise<T>;