@adtrackify/at-tracking-event-types 3.5.13 → 3.5.14

package/dist/esm/types/api/notification-settings.d.ts

@@ -0,0 +1,23 @@
+import { TRACKING_EVENT_NAME } from '../event/base/event-name-enum.js';
+import { USER_ROLES } from './user-account.js';
+export declare enum NOTIFICATION_CATEGORY {
+    ACCOUNT_MANAGEMENT = "account_management",
+    SUBSCRIPTION = "subscription",
+    USAGE = "usage",
+    SYSTEM_HEALTH = "system_health"
+}
+export interface NotificationSetting {
+    key: string;
+    displayName: string;
+    description: string;
+    category: NOTIFICATION_CATEGORY;
+    allowedRoles: USER_ROLES[];
+    events: TRACKING_EVENT_NAME[];
+}
+export interface NotificationPreferences {
+    categories: Partial<Record<NOTIFICATION_CATEGORY, boolean>>;
+    settings?: Partial<Record<string, boolean>>;
+    updatedAt?: string;
+}
+export declare const NOTIFICATION_SETTINGS: NotificationSetting[];
+export declare function getSettingsForEvent(eventName: TRACKING_EVENT_NAME): NotificationSetting[];

package/dist/esm/types/api/notification-settings.js

@@ -0,0 +1,103 @@
+import { TRACKING_EVENT_NAME } from '../event/base/event-name-enum.js';
+import { USER_ROLES } from './user-account.js';
+export var NOTIFICATION_CATEGORY;
+(function (NOTIFICATION_CATEGORY) {
+    NOTIFICATION_CATEGORY["ACCOUNT_MANAGEMENT"] = "account_management";
+    NOTIFICATION_CATEGORY["SUBSCRIPTION"] = "subscription";
+    NOTIFICATION_CATEGORY["USAGE"] = "usage";
+    NOTIFICATION_CATEGORY["SYSTEM_HEALTH"] = "system_health";
+})(NOTIFICATION_CATEGORY || (NOTIFICATION_CATEGORY = {}));
+export const NOTIFICATION_SETTINGS = [
+    {
+        key: 'team_member_invited',
+        displayName: 'Team member invited',
+        description: 'When a new user is invited to join the team',
+        category: NOTIFICATION_CATEGORY.ACCOUNT_MANAGEMENT,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INVITATION_NEW_USER],
+    },
+    {
+        key: 'team_member_added',
+        displayName: 'Team member added',
+        description: 'When an existing user is added to the account',
+        category: NOTIFICATION_CATEGORY.ACCOUNT_MANAGEMENT,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INVITATION_EXISTING_USER],
+    },
+    {
+        key: 'subscription_cancelled',
+        displayName: 'Subscription cancelled',
+        description: 'When your subscription is cancelled',
+        category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_CANCELLED],
+    },
+    {
+        key: 'payment_failed',
+        displayName: 'Payment failed',
+        description: 'When a payment attempt fails',
+        category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_PAYMENT_FAILED],
+    },
+    {
+        key: 'trial_ending_soon',
+        displayName: 'Trial ending soon',
+        description: 'When your trial period is ending',
+        category: NOTIFICATION_CATEGORY.SUBSCRIPTION,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_TRIAL_ENDING_SOON],
+    },
+    {
+        key: 'approaching_usage_limit',
+        displayName: 'Approaching usage limit',
+        description: 'When usage reaches 90% of plan limit',
+        category: NOTIFICATION_CATEGORY.USAGE,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_NEARING_USAGE_LIMIT],
+    },
+    {
+        key: 'usage_limit_exceeded',
+        displayName: 'Usage limit exceeded',
+        description: 'When usage exceeds plan limit',
+        category: NOTIFICATION_CATEGORY.USAGE,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_SUBSCRIPTION_OVER_USAGE_LIMIT],
+    },
+    {
+        key: 'destination_unhealthy',
+        displayName: 'Destination unhealthy',
+        description: 'When a destination connection fails after retries',
+        category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER, USER_ROLES.MEMBER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_DESTINATION_UNHEALTHY],
+    },
+    {
+        key: 'integration_unhealthy',
+        displayName: 'Integration unhealthy',
+        description: 'When an integration connection fails after retries',
+        category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER, USER_ROLES.MEMBER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_INTEGRATION_UNHEALTHY],
+    },
+    {
+        key: 'pixel_unhealthy',
+        displayName: 'Pixel unhealthy',
+        description: 'When the tracking pixel fails',
+        category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER, USER_ROLES.MEMBER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_PIXEL_UNHEALTHY],
+    },
+    {
+        key: 'theme_extension_unhealthy',
+        displayName: 'Theme app extension unhealthy',
+        description: 'When the theme app extension fails',
+        category: NOTIFICATION_CATEGORY.SYSTEM_HEALTH,
+        allowedRoles: [USER_ROLES.OWNER, USER_ROLES.ADMIN, USER_ROLES.MANAGER, USER_ROLES.MEMBER],
+        events: [TRACKING_EVENT_NAME.INTERNAL_ACCOUNT_THEME_EXTENSION_UNHEALTHY],
+    },
+];
+export function getSettingsForEvent(eventName) {
+    return NOTIFICATION_SETTINGS.filter((s) => s.events.includes(eventName));
+}
+//# sourceMappingURL=notification-settings.js.map

package/dist/esm/types/api/notification-settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification-settings.js","sourceRoot":"","sources":["../../../../src/types/api/notification-settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AACvE,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAK/C,MAAM,CAAN,IAAY,qBAKX;AALD,WAAY,qBAAqB;IAC/B,kEAAyC,CAAA;IACzC,sDAA6B,CAAA;IAC7B,wCAAe,CAAA;IACf,wDAA+B,CAAA;AACjC,CAAC,EALW,qBAAqB,KAArB,qBAAqB,QAKhC;AAqCD,MAAM,CAAC,MAAM,qBAAqB,GAA0B;IAE1D;QACE,GAAG,EAAE,qBAAqB;QAC1B,WAAW,EAAE,qBAAqB;QAClC,WAAW,EAAE,6CAA6C;QAC1D,QAAQ,EAAE,qBAAqB,CAAC,kBAAkB;QAClD,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,mBAAmB,CAAC,oCAAoC,CAAC;KACnE;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,+CAA+C;QAC5D,QAAQ,EAAE,qBAAqB,CAAC,kBAAkB;QAClD,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,mBAAmB,CAAC,yCAAyC,CAAC;KACxE;IAED;QACE,GAAG,EAAE,wBAAwB;QAC7B,WAAW,EAAE,wBAAwB;QACrC,WAAW,EAAE,qCAAqC;QAClD,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,mBAAmB,CAAC,uCAAuC,CAAC;KACtE;IACD;QACE,GAAG,EAAE,gBAAgB;QACrB,WAAW,EAAE,gBAAgB;QAC7B,WAAW,EAAE,8BAA8B;QAC3C,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,mBAAmB,CAAC,4CAA4C,CAAC;KAC3E;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,kCAAkC;QAC/C,QAAQ,EAAE,qBAAqB,CAAC,YAAY;QAC5C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,CAAC;QAClD,MAAM,EAAE,CAAC,mBAAmB,CAAC,+CAA+C,CAAC;KAC9E;IAED;QACE,GAAG,EAAE,yBAAyB;QAC9B,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,sCAAsC;QACnD,QAAQ,EAAE,qBAAqB,CAAC,KAAK;QACrC,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,mBAAmB,CAAC,iDAAiD,CAAC;KAChF;IACD;QACE,GAAG,EAAE,sBAAsB;QAC3B,WAAW,EAAE,sBAAsB;QACnC,WAAW,EAAE,+BAA+B;QAC5C,QAAQ,EAAE,qBAAqB,CAAC,KAAK;QACrC,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,CAAC;QACtE,MAAM,EAAE,CAAC,mBAAmB,CAAC,8CAA8C,CAAC;KAC7E;IAED;QACE,GAAG,EAAE,uBAAuB;QAC5B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,mDAAmD;QAChE,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,mBAAmB,CAAC,sCAAsC,CAAC;KACrE;IACD;QACE,GAAG,EAAE,uBAAuB;QAC5B,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,oDAAoD;QACjE,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,mBAAmB,CAAC,sCAAsC,CAAC;KACrE;IAED;QACE,GAAG,EAAE,iBAAiB;QACtB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,+BAA+B;QAC5C,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,mBAAmB,CAAC,gCAAgC,CAAC;KAC/D;IACD;QACE,GAAG,EAAE,2BAA2B;QAChC,WAAW,EAAE,+BAA+B;QAC5C,WAAW,EAAE,oCAAoC;QACjD,QAAQ,EAAE,qBAAqB,CAAC,aAAa;QAC7C,YAAY,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM,CAAC;QACzF,MAAM,EAAE,CAAC,mBAAmB,CAAC,0CAA0C,CAAC;KACzE;CACF,CAAC;AAOF,MAAM,UAAU,mBAAmB,CAAC,SAA8B;IAChE,OAAO,qBAAqB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;AAC3E,CAAC"}

package/dist/esm/types/api/pixel-setup-health.d.ts

@@ -1,19 +1,19 @@
-export interface PixelSetupHealth {
-    accountId: string;
-    healthAttributes: HealthAttributes;
-}
-export interface HealthAttributes {
-    noOfDestinations: number;
-    noOfEnabledDestinations: number;
-    destinations: DestinationHealth[];
-    destinationsHealthy: boolean;
-    themeAppExtensionHealthy: boolean;
-    conversionPixelHealthy: boolean;
-    customPixelHealthy: boolean;
-}
-export interface DestinationHealth {
-    id: string;
-    displayName: string;
-    healthy: boolean;
-    enabled: boolean;
-}
+export interface PixelSetupHealth {
+    accountId: string;
+    healthAttributes: HealthAttributes;
+}
+export interface HealthAttributes {
+    noOfDestinations: number;
+    noOfEnabledDestinations: number;
+    destinations: DestinationHealth[];
+    destinationsHealthy: boolean;
+    themeAppExtensionHealthy: boolean;
+    conversionPixelHealthy: boolean;
+    customPixelHealthy: boolean;
+}
+export interface DestinationHealth {
+    id: string;
+    displayName: string;
+    healthy: boolean;
+    enabled: boolean;
+}

package/dist/esm/types/api/pixel-setup-health.js

@@ -1,2 +1,2 @@
-export {};
+export {};
 //# sourceMappingURL=pixel-setup-health.js.map

package/dist/esm/types/api/promotion-code.d.ts

@@ -0,0 +1,35 @@
+import { Subscription } from './subscription.js';
+export declare enum PROMOTION_CODE_DURATION {
+    FOREVER = "forever",
+    ONCE = "once",
+    REPEATING = "repeating"
+}
+export interface PromotionCodeDetails {
+    id: string;
+    code: string;
+    percentOff?: number;
+    amountOff?: number;
+    currency?: string;
+    duration: PROMOTION_CODE_DURATION;
+    durationInMonths?: number;
+    maxRedemptions?: number;
+    timesRedeemed?: number;
+    expiresAt?: string;
+}
+export interface PromotionCodePreview {
+    currentAmount: number;
+    discountedAmount: number;
+    discountAmount: number;
+    currency: string;
+    nextBillingDate?: string;
+}
+export interface ValidatePromotionCodeResponse {
+    valid: boolean;
+    promotionCode?: PromotionCodeDetails;
+    preview?: PromotionCodePreview;
+    message?: string;
+}
+export interface ApplyPromotionCodeResponse {
+    message: string;
+    subscription: Subscription;
+}

package/dist/esm/types/api/promotion-code.js

@@ -0,0 +1,7 @@
+export var PROMOTION_CODE_DURATION;
+(function (PROMOTION_CODE_DURATION) {
+    PROMOTION_CODE_DURATION["FOREVER"] = "forever";
+    PROMOTION_CODE_DURATION["ONCE"] = "once";
+    PROMOTION_CODE_DURATION["REPEATING"] = "repeating";
+})(PROMOTION_CODE_DURATION || (PROMOTION_CODE_DURATION = {}));
+//# sourceMappingURL=promotion-code.js.map

package/dist/esm/types/api/promotion-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promotion-code.js","sourceRoot":"","sources":["../../../../src/types/api/promotion-code.ts"],"names":[],"mappings":"AAMA,MAAM,CAAN,IAAY,uBAIX;AAJD,WAAY,uBAAuB;IACjC,8CAAmB,CAAA;IACnB,wCAAa,CAAA;IACb,kDAAuB,CAAA;AACzB,CAAC,EAJW,uBAAuB,KAAvB,uBAAuB,QAIlC"}

package/dist/esm/types/api/query.d.ts

@@ -1,147 +1,147 @@
-import { MEASURE } from './measures/measures.js';
-export interface DateRange {
-    start: string;
-    end: string;
-    timezone?: string;
-    utcStart?: string;
-    utcEnd?: string;
-}
-export declare enum GRANULARITY {
-    NONE = "none",
-    SECOND = "second",
-    MINUTE = "minute",
-    HOUR = "hour",
-    DAY = "day",
-    WEEK = "week",
-    MONTH = "month",
-    QUARTER = "quarter",
-    YEAR = "year"
-}
-export interface Query {
-    pixelId: string;
-    measures: MeasureConfig[];
-    dateRange: DateRange;
-    compareDateRange?: DateRange;
-    granularity?: GRANULARITY;
-    dimensions?: DIMENSION[];
-    filters?: any[];
-    timezone?: string;
-    orderSettings?: OrderSettings;
-}
-export interface MeasureConfig {
-    measure: MEASURE;
-    pacing?: boolean;
-}
-export interface OrderSettings {
-    countVoidedOrders?: boolean;
-    countPendingOrders?: boolean;
-}
-export interface AppliedDimensions {
-    dimensionName?: string;
-    dimensionValue?: string;
-}
-export declare type MeasureDataRow = {
-    [key: string]: any;
-    dt?: string;
-    start?: string;
-    end?: string;
-};
-export interface QueryData {
-    primary?: MeasureDataRow[];
-    compare?: MeasureDataRow[];
-}
-export interface MeasureDetail {
-    measure: MEASURE;
-    isAverage: boolean;
-    isPercentage: boolean;
-    calculatedAverage: boolean;
-    success: boolean;
-    primaryAvg: number;
-    compareAvg: number;
-    primarySum: number;
-    compareSum: number;
-    percentDiff: number;
-    hasPacing: boolean;
-}
-export interface QueryResult {
-    granularity: GRANULARITY;
-    dimensions: DIMENSION[];
-    dateRange: DateRange;
-    compareDateRange?: DateRange;
-    measureDetails: MeasureDetail[] | null;
-    data: QueryData | null;
-}
-export interface QueryResponse {
-    results: QueryResult[];
-}
-export declare enum DIMENSION {
-    DEVICE_MODEL = "device_model",
-    DEVICE_VENDOR = "device_vendor",
-    DEVICE_TYPE = "device_type",
-    BROWSER = "browser",
-    BROWSER_VERSION = "browser_version",
-    BROWSER_OS = "browser_os",
-    OS = "OS",
-    LANDING_PATH = "landing_path",
-    PAGE_PATH = "path",
-    PAGE_TITLE = "title",
-    QUERY_STRING = "query",
-    GATEWAY = "gateway",
-    CURRENCY = "currency",
-    SHIPPING_CODE = "shipping_code",
-    IS_MOBILE = "is_mobile",
-    IS_WIRELESS = "is_wireless",
-    CITY = "city",
-    PROVINCE_CODE = "province_code",
-    PROVINCE = "province",
-    COUNTRY_CODE = "country_code",
-    COUNTRY = "country",
-    POSTAL_CODE = "postal_code",
-    FINANCIAL_STATUS = "financial_status",
-    FULFILLMENT_STATUS = "fulfillment_status",
-    DISCOUNT_CODE = "discount_code",
-    REFERRER = "referrer",
-    REFERRER_MEDIUM = "referrer_medium",
-    REFERRER_SOURCE = "referrer_source",
-    REFERRER_TERM = "referrer_term",
-    UTM_SOURCE = "utm_source",
-    UTM_CAMPAIGN = "utm_campaign",
-    UTM_MEDIUM = "utm_medium",
-    UTM_TERM = "utm_term",
-    UTM_CONTENT = "utm_content",
-    UTM_SOURCE_MEDIUM = "utm_source_medium",
-    UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
-    UTM_ADSET = "utm_adset",
-    UTM_AD = "utm_ad",
-    CLICK_NETWORK = "click_network",
-    ADBLOCK_DETECTED = "adblock_detected",
-    TIMEZONE = "timezone",
-    LOCALE = "locale",
-    CAMPAIGN = "campaign",
-    ADSET = "adset",
-    AD = "ad",
-    CUSTOMER_TYPE = "customer_type",
-    AD_SOURCE = "ad_source",
-    PRODUCT = "product",
-    VARIANT = "variant",
-    ORDER = "order",
-    NEW_CUSTOMER_ORDER = "new_customer_order"
-}
-export declare enum FIELDS {
-    SHOPIFY_ORDER_ID = "shopify.order_id",
-    SHOPIFY_ORDER_NAME = "shopify.order_name",
-    SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
-    SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
-    SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
-    SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
-    TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
-}
-export declare enum ATTRIBUTION_MODEL {
-    FIRST_CLICK = "first_click",
-    LAST_CLICK = "last_click",
-    ANY_CLICK = "any_click"
-}
-export declare enum PAGES_REPORT_DIMENSION {
-    LANDING_PAGE = "landing_page",
-    EXIT_PAGE = "exit_page"
-}
+import { MEASURE } from './measures/measures.js';
+export interface DateRange {
+    start: string;
+    end: string;
+    timezone?: string;
+    utcStart?: string;
+    utcEnd?: string;
+}
+export declare enum GRANULARITY {
+    NONE = "none",
+    SECOND = "second",
+    MINUTE = "minute",
+    HOUR = "hour",
+    DAY = "day",
+    WEEK = "week",
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}
+export interface Query {
+    pixelId: string;
+    measures: MeasureConfig[];
+    dateRange: DateRange;
+    compareDateRange?: DateRange;
+    granularity?: GRANULARITY;
+    dimensions?: DIMENSION[];
+    filters?: any[];
+    timezone?: string;
+    orderSettings?: OrderSettings;
+}
+export interface MeasureConfig {
+    measure: MEASURE;
+    pacing?: boolean;
+}
+export interface OrderSettings {
+    countVoidedOrders?: boolean;
+    countPendingOrders?: boolean;
+}
+export interface AppliedDimensions {
+    dimensionName?: string;
+    dimensionValue?: string;
+}
+export declare type MeasureDataRow = {
+    [key: string]: any;
+    dt?: string;
+    start?: string;
+    end?: string;
+};
+export interface QueryData {
+    primary?: MeasureDataRow[];
+    compare?: MeasureDataRow[];
+}
+export interface MeasureDetail {
+    measure: MEASURE;
+    isAverage: boolean;
+    isPercentage: boolean;
+    calculatedAverage: boolean;
+    success: boolean;
+    primaryAvg: number;
+    compareAvg: number;
+    primarySum: number;
+    compareSum: number;
+    percentDiff: number;
+    hasPacing: boolean;
+}
+export interface QueryResult {
+    granularity: GRANULARITY;
+    dimensions: DIMENSION[];
+    dateRange: DateRange;
+    compareDateRange?: DateRange;
+    measureDetails: MeasureDetail[] | null;
+    data: QueryData | null;
+}
+export interface QueryResponse {
+    results: QueryResult[];
+}
+export declare enum DIMENSION {
+    DEVICE_MODEL = "device_model",
+    DEVICE_VENDOR = "device_vendor",
+    DEVICE_TYPE = "device_type",
+    BROWSER = "browser",
+    BROWSER_VERSION = "browser_version",
+    BROWSER_OS = "browser_os",
+    OS = "OS",
+    LANDING_PATH = "landing_path",
+    PAGE_PATH = "path",
+    PAGE_TITLE = "title",
+    QUERY_STRING = "query",
+    GATEWAY = "gateway",
+    CURRENCY = "currency",
+    SHIPPING_CODE = "shipping_code",
+    IS_MOBILE = "is_mobile",
+    IS_WIRELESS = "is_wireless",
+    CITY = "city",
+    PROVINCE_CODE = "province_code",
+    PROVINCE = "province",
+    COUNTRY_CODE = "country_code",
+    COUNTRY = "country",
+    POSTAL_CODE = "postal_code",
+    FINANCIAL_STATUS = "financial_status",
+    FULFILLMENT_STATUS = "fulfillment_status",
+    DISCOUNT_CODE = "discount_code",
+    REFERRER = "referrer",
+    REFERRER_MEDIUM = "referrer_medium",
+    REFERRER_SOURCE = "referrer_source",
+    REFERRER_TERM = "referrer_term",
+    UTM_SOURCE = "utm_source",
+    UTM_CAMPAIGN = "utm_campaign",
+    UTM_MEDIUM = "utm_medium",
+    UTM_TERM = "utm_term",
+    UTM_CONTENT = "utm_content",
+    UTM_SOURCE_MEDIUM = "utm_source_medium",
+    UTM_SOURCE_CAMPAIGN = "utm_source_campaign",
+    UTM_ADSET = "utm_adset",
+    UTM_AD = "utm_ad",
+    CLICK_NETWORK = "click_network",
+    ADBLOCK_DETECTED = "adblock_detected",
+    TIMEZONE = "timezone",
+    LOCALE = "locale",
+    CAMPAIGN = "campaign",
+    ADSET = "adset",
+    AD = "ad",
+    CUSTOMER_TYPE = "customer_type",
+    AD_SOURCE = "ad_source",
+    PRODUCT = "product",
+    VARIANT = "variant",
+    ORDER = "order",
+    NEW_CUSTOMER_ORDER = "new_customer_order"
+}
+export declare enum FIELDS {
+    SHOPIFY_ORDER_ID = "shopify.order_id",
+    SHOPIFY_ORDER_NAME = "shopify.order_name",
+    SHOPIFY_ORDER_CREATED_DATE = "shopify.order_created_date",
+    SHOPIFY_ORDER_IS_NEW_CUSTOMER = "shopify.order_is_new_customer",
+    SHOPIFY_ORDER_CUSTOMER_EMAIL = "shopify.order_customer_email",
+    SHOPIFY_ORDER_CUSTOMER_PHONE = "shopify.order_customer_phone",
+    TRACKED_CONVERSION_TOUCHPOINTS = "tracked.conversion_touchpoints"
+}
+export declare enum ATTRIBUTION_MODEL {
+    FIRST_CLICK = "first_click",
+    LAST_CLICK = "last_click",
+    ANY_CLICK = "any_click"
+}
+export declare enum PAGES_REPORT_DIMENSION {
+    LANDING_PAGE = "landing_page",
+    EXIT_PAGE = "exit_page"
+}