@cakemail-org/ui-components-v2 2.2.104 → 2.2.105

package/dist/cjs/factories/eventTracking/index.d.ts

@@ -0,0 +1,14 @@
+import { EventModel } from "../../models/eventTracking";
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "../../services/eventTracking";
+import { TEventBreakdown, TEventFunnel, TEventListResponse, TEventPropertyKeys, TEventSummary, TEventTimeseries } from "./types";
+export declare class EventTrackingFactory {
+    static list({ ...options }: TListEvents): Promise<Omit<TEventListResponse, "items"> & {
+        items: EventModel[];
+    }>;
+    static getSummary({ ...options }: TGetEventSummary): Promise<TEventSummary>;
+    static getTimeseries({ ...options }: TGetEventTimeseries): Promise<TEventTimeseries>;
+    static getBreakdown({ ...options }: TGetEventBreakdown): Promise<TEventBreakdown>;
+    static getPropertyKeys({ ...options }: TGetEventPropertyKeys): Promise<TEventPropertyKeys>;
+    static getFunnel({ ...options }: TGetEventFunnel): Promise<TEventFunnel>;
+}
+export * from "./types";

package/dist/cjs/factories/eventTracking/types.d.ts

@@ -0,0 +1,91 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export type TEventRow = {
+    event_id: string;
+    event_type: ETrackedEventType | string;
+    entity_type: ETrackedEntityType | string;
+    entity_id: string;
+    session_id?: string | null;
+    visitor_id?: string | null;
+    occurred_at: string;
+    device_type?: string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utm_source?: string | null;
+    utm_medium?: string | null;
+    utm_campaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scroll_depth?: number | null;
+    element_id?: string | null;
+    popup_trigger?: string | null;
+    page_url?: string | null;
+    email?: string | null;
+    list_id?: string | null;
+    contact_id?: string | null;
+    form_id?: string | null;
+    ip?: string | null;
+};
+export type TEventListResponse = {
+    total: number;
+    limit: number;
+    offset: number;
+    items: TEventRow[];
+};
+export type TSummaryByEventType = {
+    event_type: string;
+    count: number;
+};
+export type TEventSummary = {
+    total: number;
+    by_event_type: TSummaryByEventType[];
+    new_visitors: number;
+    returning_visitors: number;
+};
+export type TTimeseriesPoint = {
+    timestamp: string;
+    count: number;
+};
+export type TTimeseriesPointBreakdown = {
+    timestamp: string;
+    values: Array<{
+        dimension_value?: string | null;
+        count: number;
+    }>;
+};
+export type TEventTimeseries = {
+    granularity: string;
+    event_type?: string | null;
+    breakdown?: string | null;
+    series: Array<TTimeseriesPoint | TTimeseriesPointBreakdown>;
+};
+export type TBreakdownItem = {
+    value?: string | null;
+    count: number;
+    percentage: number;
+};
+export type TEventBreakdown = {
+    dimension: string;
+    total: number;
+    items: TBreakdownItem[];
+};
+export type TPropertyKey = {
+    key: string;
+    count: number;
+};
+export type TEventPropertyKeys = {
+    keys: TPropertyKey[];
+};
+export type TFunnelStep = {
+    event_type: string;
+    count: number;
+    step_conversion_rate: number;
+    overall_conversion_rate: number;
+};
+export type TEventFunnel = {
+    window_hours: number;
+    steps: TFunnelStep[];
+    total_entered: number;
+    total_completed: number;
+    overall_conversion_rate: number;
+};

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

@@ -6,6 +6,7 @@ export * from "./campaigns";
 export * from "./contacts";
 export * from "./customDomains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./lists";
 export * from "./pages";

package/dist/cjs/index.js

@@ -11306,6 +11306,128 @@ function renderEmail(_a) {
     });
 }
 
+exports.EEventBreakdownDimension = void 0;
+(function (EEventBreakdownDimension) {
+    EEventBreakdownDimension["deviceType"] = "device_type";
+    EEventBreakdownDimension["browser"] = "browser";
+    EEventBreakdownDimension["os"] = "os";
+    EEventBreakdownDimension["source"] = "source";
+    EEventBreakdownDimension["utmSource"] = "utm_source";
+    EEventBreakdownDimension["utmMedium"] = "utm_medium";
+    EEventBreakdownDimension["utmCampaign"] = "utm_campaign";
+    EEventBreakdownDimension["entityType"] = "entity_type";
+    EEventBreakdownDimension["elementId"] = "element_id";
+    EEventBreakdownDimension["popupTrigger"] = "popup_trigger";
+    EEventBreakdownDimension["pageUrl"] = "page_url";
+    EEventBreakdownDimension["listId"] = "list_id";
+    EEventBreakdownDimension["contactId"] = "contact_id";
+    EEventBreakdownDimension["formId"] = "form_id";
+})(exports.EEventBreakdownDimension || (exports.EEventBreakdownDimension = {}));
+exports.EEventTimeseriesGranularity = void 0;
+(function (EEventTimeseriesGranularity) {
+    EEventTimeseriesGranularity["hour"] = "hour";
+    EEventTimeseriesGranularity["day"] = "day";
+    EEventTimeseriesGranularity["week"] = "week";
+    EEventTimeseriesGranularity["month"] = "month";
+})(exports.EEventTimeseriesGranularity || (exports.EEventTimeseriesGranularity = {}));
+exports.EEventSortField = void 0;
+(function (EEventSortField) {
+    EEventSortField["occurredAt"] = "occurred_at";
+    EEventSortField["eventType"] = "event_type";
+    EEventSortField["entityId"] = "entity_id";
+    EEventSortField["deviceType"] = "device_type";
+    EEventSortField["source"] = "source";
+})(exports.EEventSortField || (exports.EEventSortField = {}));
+
+var eventsBaseUrl = uiKitConfig.GATEWAY_PROXY + "/events";
+function buildEventQuery(options) {
+    if (options === void 0) { options = {}; }
+    var query = __assign({}, options);
+    if (Array.isArray(query.eventType)) {
+        query.eventType = query.eventType.join(",");
+    }
+    if (query.properties && typeof query.properties === "object") {
+        query.properties = JSON.stringify(query.properties);
+    }
+    return camelCase(query);
+}
+function buildEventBody(body) {
+    var payload = __assign({}, body);
+    if (Array.isArray(payload.steps)) {
+        payload.steps = payload.steps.map(function (step) {
+            var funnelStep = step;
+            return camelCase(funnelStep);
+        });
+    }
+    return camelCase(payload);
+}
+function listEvents(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl,
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.get,
+        },
+    });
+}
+function getEventSummary(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/summary",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.get,
+        },
+    });
+}
+function getEventTimeseries(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/timeseries",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.get,
+        },
+    });
+}
+function getEventBreakdown(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/breakdown",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.get,
+        },
+    });
+}
+function getEventPropertyKeys(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/properties",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.get,
+        },
+    });
+}
+function getEventFunnel(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/funnel",
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: exports.EMethods.post,
+            body: buildEventBody(options),
+        },
+    });
+}
+
 function createForm(_a) {
     var form = _a.form, type = _a.type;
     return callApi({
@@ -12440,6 +12562,65 @@ var Email = /** @class */ (function () {
     return Email;
 }());
 
+exports.ETrackedEventType = void 0;
+(function (ETrackedEventType) {
+    ETrackedEventType["pageView"] = "page_view";
+    ETrackedEventType["scrollDepth"] = "scroll_depth";
+    ETrackedEventType["pageConversion"] = "page_conversion";
+    ETrackedEventType["pageExit"] = "page_exit";
+    ETrackedEventType["popupView"] = "popup_view";
+    ETrackedEventType["popupDismiss"] = "popup_dismiss";
+    ETrackedEventType["popupConversion"] = "popup_conversion";
+    ETrackedEventType["click"] = "click";
+    ETrackedEventType["formSubmit"] = "form_submit";
+})(exports.ETrackedEventType || (exports.ETrackedEventType = {}));
+exports.ETrackedEntityType = void 0;
+(function (ETrackedEntityType) {
+    ETrackedEntityType["page"] = "page";
+    ETrackedEntityType["popup"] = "popup";
+})(exports.ETrackedEntityType || (exports.ETrackedEntityType = {}));
+exports.ETrackedDeviceType = void 0;
+(function (ETrackedDeviceType) {
+    ETrackedDeviceType["mobile"] = "mobile";
+    ETrackedDeviceType["desktop"] = "desktop";
+    ETrackedDeviceType["tablet"] = "tablet";
+})(exports.ETrackedDeviceType || (exports.ETrackedDeviceType = {}));
+
+var EventModel = /** @class */ (function () {
+    function EventModel(params) {
+        var _a;
+        this.eventId = params.eventId;
+        this.eventType = params.eventType;
+        this.entityType = params.entityType;
+        this.entityId = params.entityId;
+        this.sessionId = params.sessionId;
+        this.visitorId = params.visitorId;
+        this.occurredAt = params.occurredAt;
+        this.deviceType = params.deviceType;
+        this.browser = params.browser;
+        this.os = params.os;
+        this.source = params.source;
+        this.utmSource = params.utmSource;
+        this.utmMedium = params.utmMedium;
+        this.utmCampaign = params.utmCampaign;
+        this.referrer = params.referrer;
+        this.properties = (_a = params.properties) !== null && _a !== void 0 ? _a : {};
+        this.scrollDepth = params.scrollDepth;
+        this.elementId = params.elementId;
+        this.popupTrigger = params.popupTrigger;
+        this.pageUrl = params.pageUrl;
+        this.email = params.email;
+        this.listId = params.listId;
+        this.contactId = params.contactId;
+        this.formId = params.formId;
+        this.ip = params.ip;
+    }
+    EventModel.prototype.toJson = function () {
+        return modelToJson(this);
+    };
+    return EventModel;
+}());
+
 var CommonFormModel = /** @class */ (function () {
     function CommonFormModel(_a) {
         var id = _a.id, name = _a.name, list_id = _a.list_id, double_opt_in = _a.double_opt_in;
@@ -19981,6 +20162,90 @@ var EmailAPIFactory = /** @class */ (function () {
     return EmailAPIFactory;
 }());
 
+function mapEventRow(row) {
+    var _a;
+    return new EventModel({
+        eventId: row.event_id,
+        eventType: row.event_type,
+        entityType: row.entity_type,
+        entityId: row.entity_id,
+        sessionId: row.session_id,
+        visitorId: row.visitor_id,
+        occurredAt: row.occurred_at,
+        deviceType: row.device_type,
+        browser: row.browser,
+        os: row.os,
+        source: row.source,
+        utmSource: row.utm_source,
+        utmMedium: row.utm_medium,
+        utmCampaign: row.utm_campaign,
+        referrer: row.referrer,
+        properties: (_a = row.properties) !== null && _a !== void 0 ? _a : {},
+        scrollDepth: row.scroll_depth,
+        elementId: row.element_id,
+        popupTrigger: row.popup_trigger,
+        pageUrl: row.page_url,
+        email: row.email,
+        listId: row.list_id,
+        contactId: row.contact_id,
+        formId: row.form_id,
+        ip: row.ip,
+    });
+}
+var EventTrackingFactory = /** @class */ (function () {
+    function EventTrackingFactory() {
+    }
+    EventTrackingFactory.list = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, listEvents(options).then(function (response) { return (__assign(__assign({}, response), { items: response.items.map(mapEventRow) })); })];
+            });
+        });
+    };
+    EventTrackingFactory.getSummary = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventSummary(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getTimeseries = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventTimeseries(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getBreakdown = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventBreakdown(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getPropertyKeys = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventPropertyKeys(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getFunnel = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventFunnel(options)];
+            });
+        });
+    };
+    return EventTrackingFactory;
+}());
+
 var FormsFactory = /** @class */ (function () {
     function FormsFactory() {
     }
@@ -20657,6 +20922,8 @@ exports.Email = Email;
 exports.EmailAPIFactory = EmailAPIFactory;
 exports.EmptyContent = EmptyContent;
 exports.EnhancedFormModel = EnhancedFormModel;
+exports.EventModel = EventModel;
+exports.EventTrackingFactory = EventTrackingFactory;
 exports.FileUpload = FileUpload;
 exports.FilterBar = FilterBar;
 exports.FormModel = FormModel;
@@ -20835,6 +21102,11 @@ exports.getEmail = getEmail;
 exports.getEmailActivitySummary = getEmailActivitySummary;
 exports.getEmailReport = getEmailReport;
 exports.getEndOfDate = getEndOfDate;
+exports.getEventBreakdown = getEventBreakdown;
+exports.getEventFunnel = getEventFunnel;
+exports.getEventPropertyKeys = getEventPropertyKeys;
+exports.getEventSummary = getEventSummary;
+exports.getEventTimeseries = getEventTimeseries;
 exports.getForm = getForm;
 exports.getHashQueryWithoutHistory = getHashQueryWithoutHistory;
 exports.getIconSize = getIconSize;
@@ -20878,6 +21150,7 @@ exports.listContacts = listContacts;
 exports.listCustomDomains = listCustomDomains;
 exports.listDkimService = listDkimService;
 exports.listEmailLogs = listEmailLogs;
+exports.listEvents = listEvents;
 exports.listForms = listForms;
 exports.listList = listList;
 exports.listListAttributes = listListAttributes;

package/dist/cjs/models/eventTracking/index.d.ts

@@ -0,0 +1,31 @@
+import { TEventModel } from "./types";
+export declare class EventModel {
+    readonly eventId: string;
+    readonly eventType: TEventModel["eventType"];
+    readonly entityType: TEventModel["entityType"];
+    readonly entityId: string;
+    readonly sessionId?: string | null;
+    readonly visitorId?: string | null;
+    readonly occurredAt: string;
+    readonly deviceType?: TEventModel["deviceType"];
+    readonly browser?: string | null;
+    readonly os?: string | null;
+    readonly source?: string | null;
+    readonly utmSource?: string | null;
+    readonly utmMedium?: string | null;
+    readonly utmCampaign?: string | null;
+    readonly referrer?: string | null;
+    readonly properties: Record<string, unknown>;
+    readonly scrollDepth?: number | null;
+    readonly elementId?: string | null;
+    readonly popupTrigger?: string | null;
+    readonly pageUrl?: string | null;
+    readonly email?: string | null;
+    readonly listId?: string | null;
+    readonly contactId?: string | null;
+    readonly formId?: string | null;
+    readonly ip?: string | null;
+    constructor(params: TEventModel);
+    toJson(): any;
+}
+export * from "./types";

package/dist/cjs/models/eventTracking/types.d.ts

@@ -0,0 +1,47 @@
+export declare enum ETrackedEventType {
+    pageView = "page_view",
+    scrollDepth = "scroll_depth",
+    pageConversion = "page_conversion",
+    pageExit = "page_exit",
+    popupView = "popup_view",
+    popupDismiss = "popup_dismiss",
+    popupConversion = "popup_conversion",
+    click = "click",
+    formSubmit = "form_submit"
+}
+export declare enum ETrackedEntityType {
+    page = "page",
+    popup = "popup"
+}
+export declare enum ETrackedDeviceType {
+    mobile = "mobile",
+    desktop = "desktop",
+    tablet = "tablet"
+}
+export type TEventModel = {
+    eventId: string;
+    eventType: ETrackedEventType | string;
+    entityType: ETrackedEntityType | string;
+    entityId: string;
+    sessionId?: string | null;
+    visitorId?: string | null;
+    occurredAt: string;
+    deviceType?: ETrackedDeviceType | string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utmSource?: string | null;
+    utmMedium?: string | null;
+    utmCampaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scrollDepth?: number | null;
+    elementId?: string | null;
+    popupTrigger?: string | null;
+    pageUrl?: string | null;
+    email?: string | null;
+    listId?: string | null;
+    contactId?: string | null;
+    formId?: string | null;
+    ip?: string | null;
+};

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

@@ -5,6 +5,7 @@ export * from "./contact";
 export * from "./customDomains";
 export * from "./customer";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./form";
 export * from "./list";
 export * from "./pages";

package/dist/cjs/services/eventTracking/index.d.ts

@@ -0,0 +1,8 @@
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "./types";
+export declare function listEvents({ useImpersonationTree, ...options }: TListEvents): Promise<any>;
+export declare function getEventSummary({ useImpersonationTree, ...options }: TGetEventSummary): Promise<any>;
+export declare function getEventTimeseries({ useImpersonationTree, ...options }: TGetEventTimeseries): Promise<any>;
+export declare function getEventBreakdown({ useImpersonationTree, ...options }: TGetEventBreakdown): Promise<any>;
+export declare function getEventPropertyKeys({ useImpersonationTree, ...options }: TGetEventPropertyKeys): Promise<any>;
+export declare function getEventFunnel({ useImpersonationTree, ...options }: TGetEventFunnel): Promise<any>;
+export * from "./types";

package/dist/cjs/services/eventTracking/types.d.ts

@@ -0,0 +1,92 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export declare enum EEventBreakdownDimension {
+    deviceType = "device_type",
+    browser = "browser",
+    os = "os",
+    source = "source",
+    utmSource = "utm_source",
+    utmMedium = "utm_medium",
+    utmCampaign = "utm_campaign",
+    entityType = "entity_type",
+    elementId = "element_id",
+    popupTrigger = "popup_trigger",
+    pageUrl = "page_url",
+    listId = "list_id",
+    contactId = "contact_id",
+    formId = "form_id"
+}
+export declare enum EEventTimeseriesGranularity {
+    hour = "hour",
+    day = "day",
+    week = "week",
+    month = "month"
+}
+export declare enum EEventSortField {
+    occurredAt = "occurred_at",
+    eventType = "event_type",
+    entityId = "entity_id",
+    deviceType = "device_type",
+    source = "source"
+}
+export type TEventDateRangeParams = {
+    fromDate?: string;
+    toDate?: string;
+};
+export type TEventEntityFilterParams = {
+    entityId?: string;
+    entityType?: ETrackedEntityType | string;
+};
+export type TEventAttributionFilterParams = {
+    email?: string;
+    listId?: string;
+    contactId?: string;
+    formId?: string;
+    elementId?: string;
+    popupTrigger?: string;
+    pageUrl?: string;
+};
+export type TEventLineageParams = {
+    subLineage?: string;
+    includeSubAccounts?: boolean;
+};
+export type TEventCommonFilterParams = TEventDateRangeParams & TEventEntityFilterParams & TEventAttributionFilterParams & TEventLineageParams;
+export type TListEvents = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string | Array<ETrackedEventType | string>;
+    sortBy?: EEventSortField | string;
+    sortOrder?: "asc" | "desc";
+    properties?: string | Record<string, unknown>;
+    scrollDepthGte?: number;
+    scrollDepthLte?: number;
+    limit?: number;
+    offset?: number;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventSummary = TEventCommonFilterParams & {
+    useImpersonationTree?: boolean;
+};
+export type TGetEventTimeseries = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string;
+    granularity?: EEventTimeseriesGranularity | string;
+    breakdown?: EEventBreakdownDimension | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventBreakdown = TEventCommonFilterParams & {
+    dimension: EEventBreakdownDimension | string;
+    eventType?: ETrackedEventType | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventPropertyKeys = TEventDateRangeParams & TEventEntityFilterParams & TEventLineageParams & {
+    eventType?: ETrackedEventType | string;
+    search?: string;
+    email?: string;
+    useImpersonationTree?: boolean;
+};
+export type TEventFunnelStep = {
+    eventType: ETrackedEventType | string;
+    properties?: Record<string, unknown>;
+};
+export type TGetEventFunnel = TEventCommonFilterParams & {
+    steps: TEventFunnelStep[];
+    windowHours?: number;
+    useImpersonationTree?: boolean;
+};

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

@@ -8,6 +8,7 @@ export * from "./contacts";
 export * from "./customDomains";
 export * from "./domains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./hidden";
 export * from "./lists";

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

@@ -0,0 +1,14 @@
+import { EventModel } from "../../models/eventTracking";
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "../../services/eventTracking";
+import { TEventBreakdown, TEventFunnel, TEventListResponse, TEventPropertyKeys, TEventSummary, TEventTimeseries } from "./types";
+export declare class EventTrackingFactory {
+    static list({ ...options }: TListEvents): Promise<Omit<TEventListResponse, "items"> & {
+        items: EventModel[];
+    }>;
+    static getSummary({ ...options }: TGetEventSummary): Promise<TEventSummary>;
+    static getTimeseries({ ...options }: TGetEventTimeseries): Promise<TEventTimeseries>;
+    static getBreakdown({ ...options }: TGetEventBreakdown): Promise<TEventBreakdown>;
+    static getPropertyKeys({ ...options }: TGetEventPropertyKeys): Promise<TEventPropertyKeys>;
+    static getFunnel({ ...options }: TGetEventFunnel): Promise<TEventFunnel>;
+}
+export * from "./types";

package/dist/esm/factories/eventTracking/types.d.ts

@@ -0,0 +1,91 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export type TEventRow = {
+    event_id: string;
+    event_type: ETrackedEventType | string;
+    entity_type: ETrackedEntityType | string;
+    entity_id: string;
+    session_id?: string | null;
+    visitor_id?: string | null;
+    occurred_at: string;
+    device_type?: string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utm_source?: string | null;
+    utm_medium?: string | null;
+    utm_campaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scroll_depth?: number | null;
+    element_id?: string | null;
+    popup_trigger?: string | null;
+    page_url?: string | null;
+    email?: string | null;
+    list_id?: string | null;
+    contact_id?: string | null;
+    form_id?: string | null;
+    ip?: string | null;
+};
+export type TEventListResponse = {
+    total: number;
+    limit: number;
+    offset: number;
+    items: TEventRow[];
+};
+export type TSummaryByEventType = {
+    event_type: string;
+    count: number;
+};
+export type TEventSummary = {
+    total: number;
+    by_event_type: TSummaryByEventType[];
+    new_visitors: number;
+    returning_visitors: number;
+};
+export type TTimeseriesPoint = {
+    timestamp: string;
+    count: number;
+};
+export type TTimeseriesPointBreakdown = {
+    timestamp: string;
+    values: Array<{
+        dimension_value?: string | null;
+        count: number;
+    }>;
+};
+export type TEventTimeseries = {
+    granularity: string;
+    event_type?: string | null;
+    breakdown?: string | null;
+    series: Array<TTimeseriesPoint | TTimeseriesPointBreakdown>;
+};
+export type TBreakdownItem = {
+    value?: string | null;
+    count: number;
+    percentage: number;
+};
+export type TEventBreakdown = {
+    dimension: string;
+    total: number;
+    items: TBreakdownItem[];
+};
+export type TPropertyKey = {
+    key: string;
+    count: number;
+};
+export type TEventPropertyKeys = {
+    keys: TPropertyKey[];
+};
+export type TFunnelStep = {
+    event_type: string;
+    count: number;
+    step_conversion_rate: number;
+    overall_conversion_rate: number;
+};
+export type TEventFunnel = {
+    window_hours: number;
+    steps: TFunnelStep[];
+    total_entered: number;
+    total_completed: number;
+    overall_conversion_rate: number;
+};

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

@@ -6,6 +6,7 @@ export * from "./campaigns";
 export * from "./contacts";
 export * from "./customDomains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./lists";
 export * from "./pages";

package/dist/esm/index.js

@@ -11286,6 +11286,128 @@ function renderEmail(_a) {
     });
 }
 
+var EEventBreakdownDimension;
+(function (EEventBreakdownDimension) {
+    EEventBreakdownDimension["deviceType"] = "device_type";
+    EEventBreakdownDimension["browser"] = "browser";
+    EEventBreakdownDimension["os"] = "os";
+    EEventBreakdownDimension["source"] = "source";
+    EEventBreakdownDimension["utmSource"] = "utm_source";
+    EEventBreakdownDimension["utmMedium"] = "utm_medium";
+    EEventBreakdownDimension["utmCampaign"] = "utm_campaign";
+    EEventBreakdownDimension["entityType"] = "entity_type";
+    EEventBreakdownDimension["elementId"] = "element_id";
+    EEventBreakdownDimension["popupTrigger"] = "popup_trigger";
+    EEventBreakdownDimension["pageUrl"] = "page_url";
+    EEventBreakdownDimension["listId"] = "list_id";
+    EEventBreakdownDimension["contactId"] = "contact_id";
+    EEventBreakdownDimension["formId"] = "form_id";
+})(EEventBreakdownDimension || (EEventBreakdownDimension = {}));
+var EEventTimeseriesGranularity;
+(function (EEventTimeseriesGranularity) {
+    EEventTimeseriesGranularity["hour"] = "hour";
+    EEventTimeseriesGranularity["day"] = "day";
+    EEventTimeseriesGranularity["week"] = "week";
+    EEventTimeseriesGranularity["month"] = "month";
+})(EEventTimeseriesGranularity || (EEventTimeseriesGranularity = {}));
+var EEventSortField;
+(function (EEventSortField) {
+    EEventSortField["occurredAt"] = "occurred_at";
+    EEventSortField["eventType"] = "event_type";
+    EEventSortField["entityId"] = "entity_id";
+    EEventSortField["deviceType"] = "device_type";
+    EEventSortField["source"] = "source";
+})(EEventSortField || (EEventSortField = {}));
+
+var eventsBaseUrl = uiKitConfig.GATEWAY_PROXY + "/events";
+function buildEventQuery(options) {
+    if (options === void 0) { options = {}; }
+    var query = __assign({}, options);
+    if (Array.isArray(query.eventType)) {
+        query.eventType = query.eventType.join(",");
+    }
+    if (query.properties && typeof query.properties === "object") {
+        query.properties = JSON.stringify(query.properties);
+    }
+    return camelCase(query);
+}
+function buildEventBody(body) {
+    var payload = __assign({}, body);
+    if (Array.isArray(payload.steps)) {
+        payload.steps = payload.steps.map(function (step) {
+            var funnelStep = step;
+            return camelCase(funnelStep);
+        });
+    }
+    return camelCase(payload);
+}
+function listEvents(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl,
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.get,
+        },
+    });
+}
+function getEventSummary(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/summary",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.get,
+        },
+    });
+}
+function getEventTimeseries(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/timeseries",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.get,
+        },
+    });
+}
+function getEventBreakdown(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/breakdown",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.get,
+        },
+    });
+}
+function getEventPropertyKeys(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/properties",
+        query: buildEventQuery(options),
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.get,
+        },
+    });
+}
+function getEventFunnel(_a) {
+    var useImpersonationTree = _a.useImpersonationTree, options = __rest(_a, ["useImpersonationTree"]);
+    return callApi({
+        url: eventsBaseUrl + "/funnel",
+        useImpersonationTree: useImpersonationTree,
+        fetchOptions: {
+            method: EMethods.post,
+            body: buildEventBody(options),
+        },
+    });
+}
+
 function createForm(_a) {
     var form = _a.form, type = _a.type;
     return callApi({
@@ -12420,6 +12542,65 @@ var Email = /** @class */ (function () {
     return Email;
 }());
 
+var ETrackedEventType;
+(function (ETrackedEventType) {
+    ETrackedEventType["pageView"] = "page_view";
+    ETrackedEventType["scrollDepth"] = "scroll_depth";
+    ETrackedEventType["pageConversion"] = "page_conversion";
+    ETrackedEventType["pageExit"] = "page_exit";
+    ETrackedEventType["popupView"] = "popup_view";
+    ETrackedEventType["popupDismiss"] = "popup_dismiss";
+    ETrackedEventType["popupConversion"] = "popup_conversion";
+    ETrackedEventType["click"] = "click";
+    ETrackedEventType["formSubmit"] = "form_submit";
+})(ETrackedEventType || (ETrackedEventType = {}));
+var ETrackedEntityType;
+(function (ETrackedEntityType) {
+    ETrackedEntityType["page"] = "page";
+    ETrackedEntityType["popup"] = "popup";
+})(ETrackedEntityType || (ETrackedEntityType = {}));
+var ETrackedDeviceType;
+(function (ETrackedDeviceType) {
+    ETrackedDeviceType["mobile"] = "mobile";
+    ETrackedDeviceType["desktop"] = "desktop";
+    ETrackedDeviceType["tablet"] = "tablet";
+})(ETrackedDeviceType || (ETrackedDeviceType = {}));
+
+var EventModel = /** @class */ (function () {
+    function EventModel(params) {
+        var _a;
+        this.eventId = params.eventId;
+        this.eventType = params.eventType;
+        this.entityType = params.entityType;
+        this.entityId = params.entityId;
+        this.sessionId = params.sessionId;
+        this.visitorId = params.visitorId;
+        this.occurredAt = params.occurredAt;
+        this.deviceType = params.deviceType;
+        this.browser = params.browser;
+        this.os = params.os;
+        this.source = params.source;
+        this.utmSource = params.utmSource;
+        this.utmMedium = params.utmMedium;
+        this.utmCampaign = params.utmCampaign;
+        this.referrer = params.referrer;
+        this.properties = (_a = params.properties) !== null && _a !== void 0 ? _a : {};
+        this.scrollDepth = params.scrollDepth;
+        this.elementId = params.elementId;
+        this.popupTrigger = params.popupTrigger;
+        this.pageUrl = params.pageUrl;
+        this.email = params.email;
+        this.listId = params.listId;
+        this.contactId = params.contactId;
+        this.formId = params.formId;
+        this.ip = params.ip;
+    }
+    EventModel.prototype.toJson = function () {
+        return modelToJson(this);
+    };
+    return EventModel;
+}());
+
 var CommonFormModel = /** @class */ (function () {
     function CommonFormModel(_a) {
         var id = _a.id, name = _a.name, list_id = _a.list_id, double_opt_in = _a.double_opt_in;
@@ -19961,6 +20142,90 @@ var EmailAPIFactory = /** @class */ (function () {
     return EmailAPIFactory;
 }());
 
+function mapEventRow(row) {
+    var _a;
+    return new EventModel({
+        eventId: row.event_id,
+        eventType: row.event_type,
+        entityType: row.entity_type,
+        entityId: row.entity_id,
+        sessionId: row.session_id,
+        visitorId: row.visitor_id,
+        occurredAt: row.occurred_at,
+        deviceType: row.device_type,
+        browser: row.browser,
+        os: row.os,
+        source: row.source,
+        utmSource: row.utm_source,
+        utmMedium: row.utm_medium,
+        utmCampaign: row.utm_campaign,
+        referrer: row.referrer,
+        properties: (_a = row.properties) !== null && _a !== void 0 ? _a : {},
+        scrollDepth: row.scroll_depth,
+        elementId: row.element_id,
+        popupTrigger: row.popup_trigger,
+        pageUrl: row.page_url,
+        email: row.email,
+        listId: row.list_id,
+        contactId: row.contact_id,
+        formId: row.form_id,
+        ip: row.ip,
+    });
+}
+var EventTrackingFactory = /** @class */ (function () {
+    function EventTrackingFactory() {
+    }
+    EventTrackingFactory.list = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, listEvents(options).then(function (response) { return (__assign(__assign({}, response), { items: response.items.map(mapEventRow) })); })];
+            });
+        });
+    };
+    EventTrackingFactory.getSummary = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventSummary(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getTimeseries = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventTimeseries(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getBreakdown = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventBreakdown(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getPropertyKeys = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventPropertyKeys(options)];
+            });
+        });
+    };
+    EventTrackingFactory.getFunnel = function (_a) {
+        return __awaiter(this, void 0, void 0, function () {
+            var options = __rest(_a, []);
+            return __generator(this, function (_b) {
+                return [2 /*return*/, getEventFunnel(options)];
+            });
+        });
+    };
+    return EventTrackingFactory;
+}());
+
 var FormsFactory = /** @class */ (function () {
     function FormsFactory() {
     }
@@ -20587,4 +20852,4 @@ var UsersFactory = /** @class */ (function () {
     return UsersFactory;
 }());
 
-export { AccountModel, AccountsFactory, ActionBarContainer, ActionBarContainerHandler, AssetManager, AutomationModel, AutomationsFactory, Avatar, BillingFactory, BrandWrapper, BrandsFactory, Button, ButtonMenu, CampaignModel, CampaignsFactory, Checkbox, Chip, CircularProgress, CodeInput, ColManager, ColorTextField, CommonFormModel, ContactModel, ContactsFactory, ContentSectionContainer, CountryDropdown, CustomDomainModel, CustomDomainsFactory, CustomerModel, DataTable, DataTableHead, DataTableRow, DateCalendar, DatePicker, DateTimeCalendar, DateTimePicker, Dialog, DialogActions, DialogHandler, DialogTitle, Divider, Drawer, DrawerHandler, DropMenu, Dropdown, EApiLanguages, EAssetManagerMatchType, ECampaignStatuses, ECertificateStatus, EDnsStatus, EEMailSummaryStatuses, EEditorType, EEmailAttachementTypes, EEmailLogType, EEmailLogTypeParam, EEmailProviders, EEmailStatuses, EEmailSummaryEngagement, EEvents, EIngressRouteStatus, EListAttributeType, EMethods, EOperatorTypes, EPageBranding, EPartialInfoPool, EPopupBranding, EPopupBrowserType, EPopupCloseButtonPosition, EPopupDeviceType, EPopupDisplayFrequency, EPopupPosition, EPopupTriggerType, EStorageType, ETaskType, ElementContains, Email, EmailAPIFactory, EmptyContent, EnhancedFormModel, FileUpload, FilterBar, FormModel, FormsFactory, FullBar, GenericWrapper, GenericWrapperContext, GroupedActions, Header, Icon, IconPill, InformationGroup, InlineTextEdit, LinearProgress, Link, ListCampaignModel, ListModel, ListPageModel, ListPopupModel, ListTemplateModel, ListsFactory, LoadingContainer, LocationTextField, Logo, MD5, MetricCard, Modal, ModalHandler, ModalHeading, Overlay, OverlayHandler, OverlayHeading, PageModel, PagesFactory, PersonalAccessTokenModel, PersonalAccessTokensFactory, PhoneTextField, PopupModel, PopupsFactory, Radio, ResourceEdit, ScopePicker, Search, SenderModel, SendersFactory, SideMenu, SideMenuContainer, SideMenuItem, SubNav, SummaryEnhancedFormModel, SuppressedEmailsFactory, SystemEmailsFactory, SystemEmailsModel, TagsFactory, TasksFactory, TemplateModel, TemplatesFactory, TextField, TimePicker, TimeSelector, Toggle, TopMenu, Typography, UserModel, UsersFactory, acceptListPolicy, addInterestsToContactsOfList, addPartialInformation, addSuppressedEmail, addToImpersonificationTree, amIImpersonating, amILoggedInService, archiveCampaign, areAllPropertiesEmpty, buildMUITheme, callApi, camelCase, camelToSnakeCase, cancelCampaign, capitalizeFirstLetter, cleanPostHogId, clearImpersonificationTree, clearStorage, copyToClipboard, createAccount, createBrand, createCampaign, createCampaignLogsExports, createCampaignsReportsExport, createContactsExport, createCustomDomain, createForm, createPage, createPat, createPopup, createSender, createSuppressedEmailExport, createTemplate, deepMergeObject, deleteAccount, deleteAnyAutomation, deleteAutomation, deleteCampaign, deleteCampaignsReportsExport, deleteContact, deleteCustomDomain, deleteForm, deleteList, deletePage, deletePartialInformation, deletePopup, deleteSender, deleteStorageItem, deleteSuppressedEmail, deleteTaskService, deleteTemplate, deleteUser, deleteWorkflow, descendingComparator, disableForm, disablePage, disablePopup, domainHasValidCertificateService, downloadCampaignLogExport, downloadCampaignsReportsExport, downloadContactsExport, downloadListLogExport, downloadSuppressedEmailExport, emptyAccountAddress, emptyAccountLimits, enableForm, enablePage, enablePopup, enrichBrand, enrichOrganization, enrichProfile, eventCondition, eventIdentify, eventLogout, fetchRetry, fetchRoute, findNestedProperty, formatNumber, getAccount, getAccountMetadata, getAccountReport, getAdjustedBillingCycle, getAllAutomationStats, getAutomation, getAutomationEmailContent, getAutomationExecutionsCount, getAutomationStats, getBeeTokenService, getBestLocalMatch, getBrand, getBrandService, getBrandUrl, getCalendarFormat, getCampaign, getCampaignLinks, getCampaignLinksReport, getCampaignLogs, getCampaignLogsExports, getCampaignReport, getCampaignRevisions, getCampaignsReportsExport, getComparator, getContactsExport, getCustomDomain, getCustomerProfile, getDate, getDomainFromEmail, getDomainsFromEmails, getDomainsService, getEmail, getEmailActivitySummary, getEmailReport, getEndOfDate, getForm, getHashQueryWithoutHistory, getIconSize, getList, getListLogs, getListReport, getNestedProperty, getPage, getPat, getPopup, getPropertyValue, getSender, getStartOfDate, getStorage, getSuppressedEmailExport, getTColor, getTaskService, getTemplate, getUnixTime, getUrlQueryParam, getUser, getUtmCookies, googlePlacesMapper, hasDecimal, impersonateService, initFieldValidation, initPostHog, isColorLight, isDomainValidService, isPublicEmailProviderService, isSimpleType, isValidEmail, isValidString, isValidUrl, lisTEmailTags, listAccounts, listAutomations, listCampaigns, listCampaignsReportsExports, listContacts, listCustomDomains, listDkimService, listEmailLogs, listForms, listList, listListAttributes, listListInterests, listPages, listPats, listPopups, listSenders, listSuppressedEmails, listSystemEmails, listTasksService, listTemplates, listUsers, listWorkflows, logOutService, loginService, miliToSecond, modelSet, modelToJson, originalBrand, patchAccountDomainsService, patchForm, popImpersonificationTree, postMessage, publishForm, publishPage, publishPopup, reScheduleCampaign, removeEmptyProperties, removeInterestsFromContactsOfList, removeQueryParams, removeTrailingChar, renderCampaign, renderEmail, renderForm, renderPage, renderPopup, renderPublicHtmlForm, renderTemplate, requestSupportService, resendEmail, resendVerificationEmail, resumeCampaign, revokePat, saveList, scheduleCampaign, searchCustomerProfiles, sendCampaignTest, setBrandHeadElements, setStorage, shareTemplate, splitArray, splitObject, stableSort, startPromisePool, suspendAccount, suspendCampaign, tagContact, tagsContactsOfList, trackEvent, truncateEmail, truncateText, uiKitConfig, unArchiveCampaign, unScheduleCampaign, unSuspendAccount, unshareTemplate, unsubscribeContact, untagContact, untagContactsOfList, updateAccount, updateAndClearUrlParams, updateAnyAutomation, updateAutomation, updateCampaign, updatePage, updatePat, updatePopup, updateSystemEmails, updateTemplate, updateUser, updateWorkflow, validateColor, validateEmail, validateGenericInput, validateUrl, verifyCustomDomain, verifyTrackingCnamesService, wait, whiteLabelBrand, whoAmi };
+export { AccountModel, AccountsFactory, ActionBarContainer, ActionBarContainerHandler, AssetManager, AutomationModel, AutomationsFactory, Avatar, BillingFactory, BrandWrapper, BrandsFactory, Button, ButtonMenu, CampaignModel, CampaignsFactory, Checkbox, Chip, CircularProgress, CodeInput, ColManager, ColorTextField, CommonFormModel, ContactModel, ContactsFactory, ContentSectionContainer, CountryDropdown, CustomDomainModel, CustomDomainsFactory, CustomerModel, DataTable, DataTableHead, DataTableRow, DateCalendar, DatePicker, DateTimeCalendar, DateTimePicker, Dialog, DialogActions, DialogHandler, DialogTitle, Divider, Drawer, DrawerHandler, DropMenu, Dropdown, EApiLanguages, EAssetManagerMatchType, ECampaignStatuses, ECertificateStatus, EDnsStatus, EEMailSummaryStatuses, EEditorType, EEmailAttachementTypes, EEmailLogType, EEmailLogTypeParam, EEmailProviders, EEmailStatuses, EEmailSummaryEngagement, EEventBreakdownDimension, EEventSortField, EEventTimeseriesGranularity, EEvents, EIngressRouteStatus, EListAttributeType, EMethods, EOperatorTypes, EPageBranding, EPartialInfoPool, EPopupBranding, EPopupBrowserType, EPopupCloseButtonPosition, EPopupDeviceType, EPopupDisplayFrequency, EPopupPosition, EPopupTriggerType, EStorageType, ETaskType, ETrackedDeviceType, ETrackedEntityType, ETrackedEventType, ElementContains, Email, EmailAPIFactory, EmptyContent, EnhancedFormModel, EventModel, EventTrackingFactory, FileUpload, FilterBar, FormModel, FormsFactory, FullBar, GenericWrapper, GenericWrapperContext, GroupedActions, Header, Icon, IconPill, InformationGroup, InlineTextEdit, LinearProgress, Link, ListCampaignModel, ListModel, ListPageModel, ListPopupModel, ListTemplateModel, ListsFactory, LoadingContainer, LocationTextField, Logo, MD5, MetricCard, Modal, ModalHandler, ModalHeading, Overlay, OverlayHandler, OverlayHeading, PageModel, PagesFactory, PersonalAccessTokenModel, PersonalAccessTokensFactory, PhoneTextField, PopupModel, PopupsFactory, Radio, ResourceEdit, ScopePicker, Search, SenderModel, SendersFactory, SideMenu, SideMenuContainer, SideMenuItem, SubNav, SummaryEnhancedFormModel, SuppressedEmailsFactory, SystemEmailsFactory, SystemEmailsModel, TagsFactory, TasksFactory, TemplateModel, TemplatesFactory, TextField, TimePicker, TimeSelector, Toggle, TopMenu, Typography, UserModel, UsersFactory, acceptListPolicy, addInterestsToContactsOfList, addPartialInformation, addSuppressedEmail, addToImpersonificationTree, amIImpersonating, amILoggedInService, archiveCampaign, areAllPropertiesEmpty, buildMUITheme, callApi, camelCase, camelToSnakeCase, cancelCampaign, capitalizeFirstLetter, cleanPostHogId, clearImpersonificationTree, clearStorage, copyToClipboard, createAccount, createBrand, createCampaign, createCampaignLogsExports, createCampaignsReportsExport, createContactsExport, createCustomDomain, createForm, createPage, createPat, createPopup, createSender, createSuppressedEmailExport, createTemplate, deepMergeObject, deleteAccount, deleteAnyAutomation, deleteAutomation, deleteCampaign, deleteCampaignsReportsExport, deleteContact, deleteCustomDomain, deleteForm, deleteList, deletePage, deletePartialInformation, deletePopup, deleteSender, deleteStorageItem, deleteSuppressedEmail, deleteTaskService, deleteTemplate, deleteUser, deleteWorkflow, descendingComparator, disableForm, disablePage, disablePopup, domainHasValidCertificateService, downloadCampaignLogExport, downloadCampaignsReportsExport, downloadContactsExport, downloadListLogExport, downloadSuppressedEmailExport, emptyAccountAddress, emptyAccountLimits, enableForm, enablePage, enablePopup, enrichBrand, enrichOrganization, enrichProfile, eventCondition, eventIdentify, eventLogout, fetchRetry, fetchRoute, findNestedProperty, formatNumber, getAccount, getAccountMetadata, getAccountReport, getAdjustedBillingCycle, getAllAutomationStats, getAutomation, getAutomationEmailContent, getAutomationExecutionsCount, getAutomationStats, getBeeTokenService, getBestLocalMatch, getBrand, getBrandService, getBrandUrl, getCalendarFormat, getCampaign, getCampaignLinks, getCampaignLinksReport, getCampaignLogs, getCampaignLogsExports, getCampaignReport, getCampaignRevisions, getCampaignsReportsExport, getComparator, getContactsExport, getCustomDomain, getCustomerProfile, getDate, getDomainFromEmail, getDomainsFromEmails, getDomainsService, getEmail, getEmailActivitySummary, getEmailReport, getEndOfDate, getEventBreakdown, getEventFunnel, getEventPropertyKeys, getEventSummary, getEventTimeseries, getForm, getHashQueryWithoutHistory, getIconSize, getList, getListLogs, getListReport, getNestedProperty, getPage, getPat, getPopup, getPropertyValue, getSender, getStartOfDate, getStorage, getSuppressedEmailExport, getTColor, getTaskService, getTemplate, getUnixTime, getUrlQueryParam, getUser, getUtmCookies, googlePlacesMapper, hasDecimal, impersonateService, initFieldValidation, initPostHog, isColorLight, isDomainValidService, isPublicEmailProviderService, isSimpleType, isValidEmail, isValidString, isValidUrl, lisTEmailTags, listAccounts, listAutomations, listCampaigns, listCampaignsReportsExports, listContacts, listCustomDomains, listDkimService, listEmailLogs, listEvents, listForms, listList, listListAttributes, listListInterests, listPages, listPats, listPopups, listSenders, listSuppressedEmails, listSystemEmails, listTasksService, listTemplates, listUsers, listWorkflows, logOutService, loginService, miliToSecond, modelSet, modelToJson, originalBrand, patchAccountDomainsService, patchForm, popImpersonificationTree, postMessage, publishForm, publishPage, publishPopup, reScheduleCampaign, removeEmptyProperties, removeInterestsFromContactsOfList, removeQueryParams, removeTrailingChar, renderCampaign, renderEmail, renderForm, renderPage, renderPopup, renderPublicHtmlForm, renderTemplate, requestSupportService, resendEmail, resendVerificationEmail, resumeCampaign, revokePat, saveList, scheduleCampaign, searchCustomerProfiles, sendCampaignTest, setBrandHeadElements, setStorage, shareTemplate, splitArray, splitObject, stableSort, startPromisePool, suspendAccount, suspendCampaign, tagContact, tagsContactsOfList, trackEvent, truncateEmail, truncateText, uiKitConfig, unArchiveCampaign, unScheduleCampaign, unSuspendAccount, unshareTemplate, unsubscribeContact, untagContact, untagContactsOfList, updateAccount, updateAndClearUrlParams, updateAnyAutomation, updateAutomation, updateCampaign, updatePage, updatePat, updatePopup, updateSystemEmails, updateTemplate, updateUser, updateWorkflow, validateColor, validateEmail, validateGenericInput, validateUrl, verifyCustomDomain, verifyTrackingCnamesService, wait, whiteLabelBrand, whoAmi };

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

@@ -0,0 +1,31 @@
+import { TEventModel } from "./types";
+export declare class EventModel {
+    readonly eventId: string;
+    readonly eventType: TEventModel["eventType"];
+    readonly entityType: TEventModel["entityType"];
+    readonly entityId: string;
+    readonly sessionId?: string | null;
+    readonly visitorId?: string | null;
+    readonly occurredAt: string;
+    readonly deviceType?: TEventModel["deviceType"];
+    readonly browser?: string | null;
+    readonly os?: string | null;
+    readonly source?: string | null;
+    readonly utmSource?: string | null;
+    readonly utmMedium?: string | null;
+    readonly utmCampaign?: string | null;
+    readonly referrer?: string | null;
+    readonly properties: Record<string, unknown>;
+    readonly scrollDepth?: number | null;
+    readonly elementId?: string | null;
+    readonly popupTrigger?: string | null;
+    readonly pageUrl?: string | null;
+    readonly email?: string | null;
+    readonly listId?: string | null;
+    readonly contactId?: string | null;
+    readonly formId?: string | null;
+    readonly ip?: string | null;
+    constructor(params: TEventModel);
+    toJson(): any;
+}
+export * from "./types";

package/dist/esm/models/eventTracking/types.d.ts

@@ -0,0 +1,47 @@
+export declare enum ETrackedEventType {
+    pageView = "page_view",
+    scrollDepth = "scroll_depth",
+    pageConversion = "page_conversion",
+    pageExit = "page_exit",
+    popupView = "popup_view",
+    popupDismiss = "popup_dismiss",
+    popupConversion = "popup_conversion",
+    click = "click",
+    formSubmit = "form_submit"
+}
+export declare enum ETrackedEntityType {
+    page = "page",
+    popup = "popup"
+}
+export declare enum ETrackedDeviceType {
+    mobile = "mobile",
+    desktop = "desktop",
+    tablet = "tablet"
+}
+export type TEventModel = {
+    eventId: string;
+    eventType: ETrackedEventType | string;
+    entityType: ETrackedEntityType | string;
+    entityId: string;
+    sessionId?: string | null;
+    visitorId?: string | null;
+    occurredAt: string;
+    deviceType?: ETrackedDeviceType | string | null;
+    browser?: string | null;
+    os?: string | null;
+    source?: string | null;
+    utmSource?: string | null;
+    utmMedium?: string | null;
+    utmCampaign?: string | null;
+    referrer?: string | null;
+    properties: Record<string, unknown>;
+    scrollDepth?: number | null;
+    elementId?: string | null;
+    popupTrigger?: string | null;
+    pageUrl?: string | null;
+    email?: string | null;
+    listId?: string | null;
+    contactId?: string | null;
+    formId?: string | null;
+    ip?: string | null;
+};

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

@@ -5,6 +5,7 @@ export * from "./contact";
 export * from "./customDomains";
 export * from "./customer";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./form";
 export * from "./list";
 export * from "./pages";

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

@@ -0,0 +1,8 @@
+import { TGetEventBreakdown, TGetEventFunnel, TGetEventPropertyKeys, TGetEventSummary, TGetEventTimeseries, TListEvents } from "./types";
+export declare function listEvents({ useImpersonationTree, ...options }: TListEvents): Promise<any>;
+export declare function getEventSummary({ useImpersonationTree, ...options }: TGetEventSummary): Promise<any>;
+export declare function getEventTimeseries({ useImpersonationTree, ...options }: TGetEventTimeseries): Promise<any>;
+export declare function getEventBreakdown({ useImpersonationTree, ...options }: TGetEventBreakdown): Promise<any>;
+export declare function getEventPropertyKeys({ useImpersonationTree, ...options }: TGetEventPropertyKeys): Promise<any>;
+export declare function getEventFunnel({ useImpersonationTree, ...options }: TGetEventFunnel): Promise<any>;
+export * from "./types";

package/dist/esm/services/eventTracking/types.d.ts

@@ -0,0 +1,92 @@
+import { ETrackedEntityType, ETrackedEventType } from "../../models/eventTracking/types";
+export declare enum EEventBreakdownDimension {
+    deviceType = "device_type",
+    browser = "browser",
+    os = "os",
+    source = "source",
+    utmSource = "utm_source",
+    utmMedium = "utm_medium",
+    utmCampaign = "utm_campaign",
+    entityType = "entity_type",
+    elementId = "element_id",
+    popupTrigger = "popup_trigger",
+    pageUrl = "page_url",
+    listId = "list_id",
+    contactId = "contact_id",
+    formId = "form_id"
+}
+export declare enum EEventTimeseriesGranularity {
+    hour = "hour",
+    day = "day",
+    week = "week",
+    month = "month"
+}
+export declare enum EEventSortField {
+    occurredAt = "occurred_at",
+    eventType = "event_type",
+    entityId = "entity_id",
+    deviceType = "device_type",
+    source = "source"
+}
+export type TEventDateRangeParams = {
+    fromDate?: string;
+    toDate?: string;
+};
+export type TEventEntityFilterParams = {
+    entityId?: string;
+    entityType?: ETrackedEntityType | string;
+};
+export type TEventAttributionFilterParams = {
+    email?: string;
+    listId?: string;
+    contactId?: string;
+    formId?: string;
+    elementId?: string;
+    popupTrigger?: string;
+    pageUrl?: string;
+};
+export type TEventLineageParams = {
+    subLineage?: string;
+    includeSubAccounts?: boolean;
+};
+export type TEventCommonFilterParams = TEventDateRangeParams & TEventEntityFilterParams & TEventAttributionFilterParams & TEventLineageParams;
+export type TListEvents = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string | Array<ETrackedEventType | string>;
+    sortBy?: EEventSortField | string;
+    sortOrder?: "asc" | "desc";
+    properties?: string | Record<string, unknown>;
+    scrollDepthGte?: number;
+    scrollDepthLte?: number;
+    limit?: number;
+    offset?: number;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventSummary = TEventCommonFilterParams & {
+    useImpersonationTree?: boolean;
+};
+export type TGetEventTimeseries = TEventCommonFilterParams & {
+    eventType?: ETrackedEventType | string;
+    granularity?: EEventTimeseriesGranularity | string;
+    breakdown?: EEventBreakdownDimension | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventBreakdown = TEventCommonFilterParams & {
+    dimension: EEventBreakdownDimension | string;
+    eventType?: ETrackedEventType | string;
+    useImpersonationTree?: boolean;
+};
+export type TGetEventPropertyKeys = TEventDateRangeParams & TEventEntityFilterParams & TEventLineageParams & {
+    eventType?: ETrackedEventType | string;
+    search?: string;
+    email?: string;
+    useImpersonationTree?: boolean;
+};
+export type TEventFunnelStep = {
+    eventType: ETrackedEventType | string;
+    properties?: Record<string, unknown>;
+};
+export type TGetEventFunnel = TEventCommonFilterParams & {
+    steps: TEventFunnelStep[];
+    windowHours?: number;
+    useImpersonationTree?: boolean;
+};

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

@@ -8,6 +8,7 @@ export * from "./contacts";
 export * from "./customDomains";
 export * from "./domains";
 export * from "./emailAPI";
+export * from "./eventTracking";
 export * from "./forms";
 export * from "./hidden";
 export * from "./lists";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cakemail-org/ui-components-v2",
-    "version": "2.2.104",
+    "version": "2.2.105",
     "description": "ui library kit made with material UI",
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",