@ecodrix/erix-api 1.3.2 → 1.3.4

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

@@ -211,6 +211,12 @@ declare class Analytics extends APIResource {
      * Consolidated analytics including CRM overview and WhatsApp messaging metrics.
      *
      * @param params - Time range filters.
+     * @returns {Promise<any>} Consolidated analytics object containing CRM overview and WhatsApp messaging metrics.
+     * @example
+     * ```typescript
+     * const stats = await erixClient.crm.analytics.summary({ range: "30d" });
+     * console.log(stats.overview.totalLeads);
+     * ```
      */
     summary<T = any>(params?: AnalyticsParams): Promise<T>;
     /**
@@ -376,6 +382,21 @@ declare class Automations extends APIResource {
      * @param payload - Arbitrary data forwarded to the node context.
      */
     webhookEvent<T = any>(ruleId: string, eventName: string, payload?: any): Promise<T>;
+    /**
+     * Fire a CRM automation trigger for a given phone number.
+     *
+     * @param params - Trigger payload (trigger name, phone, variables, etc.)
+     */
+    trigger<T = any>(params: {
+        trigger: string;
+        phone: string;
+        email?: string;
+        variables?: Record<string, string>;
+        createLeadIfMissing?: boolean;
+        leadData?: any;
+        delayMinutes?: number;
+        runAt?: Date | string;
+    }): Promise<T>;
 }
 
 /**
@@ -451,18 +472,32 @@ type LeadSource = "website" | "whatsapp" | "direct" | "referral" | string;
  * Parameters for creating a new CRM Lead.
  */
 interface CreateLeadParams {
-    /** Lead's first name. Required. */
-    firstName: string;
+    /** Lead's full name (alternative to firstName/lastName). */
+    name?: string;
+    /** Lead's first name. Required for creation if name is not provided. */
+    firstName?: string;
     /** Lead's last name. */
     lastName?: string;
     /** Lead's email address. */
     email?: string;
     /** Lead's phone number in E.164 format (e.g. "+919876543210"). */
     phone?: string;
+    /**
+     * Current status of the lead.
+     */
+    status?: LeadStatus;
+    /**
+     * Estimated value of the lead.
+     */
+    value?: number;
     /**
      * Acquisition channel.
      */
     source?: LeadSource;
+    /** Primary message or enquiry from the lead. */
+    message?: string;
+    /** Internal note about the lead activity. */
+    activityNote?: string;
     /** Arbitrary key-value metadata (UTM params, order IDs, etc.). */
     metadata?: Record<string, any>;
     /** Pipeline ID to assign the lead */
@@ -568,11 +603,19 @@ declare class Leads extends APIResource {
      */
     createMany(leads: CreateLeadParams[], chunkSize?: number): Promise<any[]>;
     /**
-     * Bulk upsert (import) leads.
+     * Bulk upsert (import) leads. Supports high-volume synchronization.
      *
      * @param leads - Array of leads to import.
+     * ---- **Done** ---- API Endpoint
      */
     import<T = any>(leads: Partial<CreateLeadParams>[]): Promise<T>;
+    /**
+     * Alias for bulk upserting leads.
+     *
+     * @param leads - Array of leads to import.
+     * ---- **Done** ---- API Endpoint
+     */
+    bulkUpsert<T = any>(leads: Partial<CreateLeadParams>[]): Promise<T>;
     /**
      * List CRM leads with optional filtering and pagination.
      *
@@ -615,8 +658,22 @@ declare class Leads extends APIResource {
      * Retrieve a single lead by its phone number.
      *
      * @param phone - Lead's phone number.
+     * ---- **Done** ---- API Endpoint
      */
     retrieveByPhone<T = any>(phone: string): Promise<T>;
+    /**
+     * Fetches all leads belonging to a specific Kanban column in a pipeline.
+     *
+     * @param pipelineId - Parent pipeline ID.
+     * @param stageId - Target stage ID.
+     * @param params - Pagination controls.
+     * @returns Paginated result set.
+     * ---- **Done** ---- API Endpoint
+     */
+    byStage<T = any>(pipelineId: string, stageId: string, params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<T>;
     /**
      * Retrieve a single lead by a reference key and value.
      *
@@ -712,17 +769,32 @@ declare class Leads extends APIResource {
      */
     deleteNote<T = any>(leadId: string, noteId: string): Promise<unknown>;
     /**
-     * Archive (soft-delete) a single lead.
+     * Delete a single lead permanently.
      *
-     * @param leadId - The ID of the lead to archive.
+     * @param leadId - The ID of the lead to delete.
+     * ---- **Done** ---- API Endpoint
      */
     delete(leadId: string): Promise<unknown>;
     /**
      * Bulk archive multiple leads.
      *
      * @param ids - Array of lead IDs to archive.
+     * ---- **Done** ---- API Endpoint
+     */
+    bulkArchive<T = any>(ids: string[]): Promise<T>;
+    /**
+     * Bulk delete multiple leads permanently.
+     *
+     * @param ids - Array of lead IDs to archive.
+     * ---- **Done** ---- API Endpoint
      */
     bulkDelete(ids: string[]): Promise<unknown>;
+    /**
+     * Archive a single lead.
+     *
+     * @param leadId - The ID of the lead to archive.
+     */
+    archive<T = any>(leadId: string): Promise<T>;
 }
 
 declare class Payments extends APIResource {
@@ -749,15 +821,12 @@ declare class Payments extends APIResource {
     }): Promise<T>;
 }
 
-interface CreatePipelineParams {
-    name: string;
-    isDefault?: boolean;
-    stages?: any[];
-}
 interface PipelineStageParams {
     name: string;
     color?: string;
     probability?: number;
+    isWon?: boolean;
+    isLost?: boolean;
 }
 declare class Pipelines extends APIResource {
     /**
@@ -880,12 +949,23 @@ declare class Pipelines extends APIResource {
 }
 
 interface ScoringConfig {
-    decayDays: number;
-    thresholds: {
-        hot: number;
-        warm: number;
-    };
+    /** Scoring rules — each rule adds/subtracts points based on field conditions. */
     rules: any[];
+    /**
+     * Score threshold above which a lead is considered "hot".
+     * @default 70
+     */
+    hotThreshold?: number;
+    /**
+     * Score threshold below which a lead is considered "cold".
+     * @default 20
+     */
+    coldThreshold?: number;
+    /**
+     * List of CRM trigger names that cause an automatic score recalculation.
+     * @example ["lead_created", "appointment_booked"]
+     */
+    recalculateOnTriggers?: string[];
 }
 declare class Scoring extends APIResource {
     /**
@@ -1079,9 +1159,6 @@ declare class Email extends APIResource {
         variables?: Record<string, any>;
     }): Promise<TemplatePreviewResponse>;
 }
-/** @deprecated Use Email instead */
-declare class EmailResource extends Email {
-}
 
 /**
  * Event definition representing an entry point capable of triggering automations.
@@ -1695,9 +1772,6 @@ declare class Media extends APIResource {
      */
     upload(file: any, options: UploadOptions): Promise<any>;
 }
-/** @deprecated Use Media instead */
-declare class MediaResource extends Media {
-}
 
 /**
  * Parameters for scheduling a new Google Meet appointment.
@@ -1709,6 +1783,8 @@ interface CreateMeetingParams {
     participantName: string;
     /** Phone number of the participant in E.164 format. */
     participantPhone: string;
+    /** Email addresses of the participants. */
+    participantEmails?: string[];
     /**
      * Meeting start time.
      * @example new Date("2026-04-10T10:00:00.000Z")
@@ -1719,8 +1795,19 @@ interface CreateMeetingParams {
      * @example new Date("2026-04-10T10:30:00.000Z")
      */
     endTime: Date | string;
+    /** Duration in minutes. */
+    duration?: number;
+    /** Whether the meeting is online (Google Meet) or offline (In-person). */
+    meetingMode?: "online" | "offline";
+    /** Whether this is a free or paid consultation. */
+    type?: "free" | "paid";
+    /** Amount charged for paid consultations. */
+    amount?: number;
     /** Arbitrary metadata to attach to the meeting record. */
-    metadata?: Record<string, any>;
+    metadata?: {
+        refs?: Record<string, string | undefined>;
+        extra?: Record<string, any>;
+    };
 }
 /**
  * Parameters for updating an existing meeting.
@@ -1730,15 +1817,17 @@ interface UpdateMeetingParams {
      * Update the meeting status.
      * @example "scheduled" | "completed" | "cancelled"
      */
-    status?: string;
+    status?: "scheduled" | "completed" | "cancelled" | string;
     /** Update the payment status for paid consultations. */
-    paymentStatus?: string;
+    paymentStatus?: "pending" | "paid" | "na" | string;
     /** New start time for rescheduling. */
     startTime?: Date | string;
     /** New end time for rescheduling. */
     endTime?: Date | string;
     /** Duration in minutes. */
     duration?: number;
+    /** Update metadata. */
+    metadata?: any;
 }
 /**
  * Google Meet appointment scheduling resource.
@@ -2184,9 +2273,6 @@ declare class RateLimitError extends APIError {
     constructor(message?: string);
 }
 
-declare class WebhookSignatureError extends APIError {
-    constructor(message: string);
-}
 /**
  * Validates and constructs webhook events sent by the ECODrIx platform.
  * Ensures the payload has not been tampered with.
@@ -3011,13 +3097,111 @@ declare class Cors extends APIResource {
     delete<T = any>(id: string): Promise<T>;
 }
 
+interface CheckoutProduct {
+    externalId: string;
+    name: string;
+    price: number;
+    image?: string;
+}
+interface CheckoutAmountBreakdown {
+    subtotal: number;
+    discount: number;
+    delivery: number;
+    total: number;
+}
+interface CheckoutSession {
+    sessionId: string;
+    product: {
+        name: string;
+        price: number;
+        image?: string;
+    };
+    amounts: CheckoutAmountBreakdown;
+    items: Array<{
+        productId: string;
+        quantity: number;
+    }>;
+}
+interface CreateSessionPayload {
+    productId: string;
+    quantity: number;
+    couponCode?: string;
+}
+interface ApplyCouponPayload {
+    sessionId: string;
+    couponCode: string;
+}
+interface VerifyPayload {
+    sessionId: string;
+    method: "truecaller" | "otp";
+    token?: string;
+    phone?: string;
+    otp?: string;
+}
+interface CreateOrderPayload {
+    sessionId: string;
+    customer: {
+        name: string;
+        phone: string;
+        email?: string;
+        address: {
+            line1: string;
+            city: string;
+            state: string;
+            pincode: string;
+        };
+    };
+    paymentProvider: "razorpay" | "cod";
+}
+interface CheckoutOrderResponse {
+    order_id: string;
+    payment_order_id?: string;
+    amount?: number;
+    currency?: string;
+    status?: string;
+    message?: string;
+}
+
+/**
+ * Resource for managing the ErixCheckout one-click flow.
+ *
+ * This resource handles session creation, coupon application,
+ * identity verification, and final order placement.
+ */
+declare class Checkout extends APIResource {
+    /**
+     * Retrieves product information for the checkout modal.
+     * @param productId - External SKU/ID of the product.
+     */
+    getProduct(productId: string): Promise<CheckoutProduct>;
+    /**
+     * Initializes a new checkout session.
+     */
+    createSession(payload: CreateSessionPayload): Promise<CheckoutSession>;
+    /**
+     * Applies a discount coupon to an active session.
+     */
+    applyCoupon(payload: ApplyCouponPayload): Promise<CheckoutSession>;
+    /**
+     * Verifies user identity via Truecaller or OTP.
+     */
+    verify(payload: VerifyPayload): Promise<{
+        verified: boolean;
+        data?: any;
+    }>;
+    /**
+     * Finalizes the order and initiates payment.
+     */
+    createOrder(payload: CreateOrderPayload): Promise<CheckoutOrderResponse>;
+}
+
 /**
- * Configuration options for the Ecodrix client.
+ * Configuration options for the ECODrIxAPI client.
  *
  * Minimum required: `apiKey` and `clientCode`.
  * The backend URL is managed internally and should not need to be changed.
  */
-interface EcodrixOptions {
+interface ECODrIxAPIOptions {
     /**
      * Your ECODrIx Platform API key.
      * Obtain this from the ECODrIx dashboard under Settings → API Keys.
@@ -3054,9 +3238,9 @@ interface EcodrixOptions {
  *
  * @example
  * ```typescript
- * import { Ecodrix } from "@ecodrix/erix-api";
+ * import { ECODrIxAPI } from "@ecodrix/erix-api";
  *
- * const ecod = new Ecodrix({
+ * const ecod = new ECODrIxAPI({
  *   apiKey: process.env.ECOD_API_KEY!,
  *   clientCode: "ERIX_CLNT_JHBJHF",
  * });
@@ -3065,7 +3249,7 @@ interface EcodrixOptions {
  * const lead = await ecod.crm.leads.create({ firstName: "Alice", phone: "+91..." });
  * ```
  */
-declare class Ecodrix {
+declare class ECODrIxAPI {
     /**
      * @internal Axios HTTP client for making API requests.
      */
@@ -3114,7 +3298,9 @@ declare class Ecodrix {
     readonly settings: Settings;
     /** Dynamic Cross-Origin Resource Sharing network policies. */
     readonly cors: Cors;
-    constructor(options: EcodrixOptions);
+    /** ErixCheckout one-click checkout flow management. */
+    readonly checkout: Checkout;
+    constructor(options: ECODrIxAPIOptions);
     /**
      * Join a specific real-time room (e.g., a conversation or a lead).
      *
@@ -3195,4 +3381,4 @@ declare class Ecodrix {
     request<T = any>(method: Method, path: string, data?: any, params?: any): Promise<T>;
 }
 
-export { APIError, Activities, Agency, Analytics, type AnalyticsParams, type AnalyticsRange, type AssignEventPayload, AuthenticationError, AutomationDashboard, type AutomationRulePayload, Automations, Blogs, Broadcasts, CRM, type CallbackLog, type CampaignResult, Campaigns, type ChatMediaMeta, type ClientHealth, Clients, Conversations, Cors, type CorsOriginCreatePayload, type CorsOriginUpdatePayload, type CreateBroadcastParams, type CreateLeadParams, type CreateMeetingParams, type CreatePipelineParams, type CreateTemplateDTO, Ecodrix, EcodrixError, type EcodrixOptions, Email, EmailConfig, EmailResource, type EmailTemplate, Emails, type EventDefinition, type EventLog, EventsResource, type FieldManifest, type FieldType, Files, Folders, GlobalLeads, Health, type JobStats, type JobStatus, type LeadSource, type LeadStatus, Leads, type ListLeadsParams, type ListParams, type LogActivityParams, type LogCallParams, type LogFilter, type LogPaginationQuery, type LogResponse, Logs, Marketing, Media, MediaResource, Meetings, Messages, Notes, Notifications, Payments, type PipelineStageParams, Pipelines, Queue, RateLimitError, type ResourceManifest, Scoring, type ScoringConfig, type SendCampaignParams, type SendCampaignPayload, type SendMessageParams, type SendTemplateParams, type SendTemplatePayload, Sequences, Services, Settings, Storage, type SystemHealth, type TemplateMapping, type TemplatePreviewResponse, Templates, type TriggerPayload, type TriggerResponse, type UpdateMeetingParams, type UploadOptions, type UpsertLeadParams, WebhookSignatureError, Webhooks, WhatsApp, WhatsAppMarketing, Ecodrix as default };
+export { APIError, type ApplyCouponPayload, AuthenticationError, type CheckoutAmountBreakdown, type CheckoutOrderResponse, type CheckoutProduct, type CheckoutSession, type CreateOrderPayload, type CreateSessionPayload, ECODrIxAPI as ECODrIx, ECODrIxAPI, type ECODrIxAPIOptions, EcodrixError, type FieldManifest, type FieldType, RateLimitError, type ResourceManifest, type VerifyPayload, ECODrIxAPI as default };