@adtrackify/at-tracking-event-types 2.0.40 → 2.0.42

package/dist/esm/types/api/destinations/third-party-destination-configs.d.ts

@@ -1,53 +1,53 @@
-import { Destination, UserDestinationConfiguration } from './destinations';
-export interface AdTrackifyFacebookDestination extends Destination {
-    configuration: FacebookPixelConfiguration;
-}
-export interface AdTrackifyTikTokDestination extends Destination {
-    configuration: TiktokPixelConfiguration;
-}
-export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
-    configuration: GoogleAnalytics4Configuration;
-}
-export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
-    apiAccessToken?: string;
-    enableConversionAPI: boolean;
-    pixelId: string;
-}
-export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
-    apiAccessToken?: string;
-    enableConversionAPI: boolean;
-    pixelId: string;
-}
-export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
-    apiSecret: string;
-    measurementId: string;
-}
-export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
-    pixelId: string;
-    conversionID: string;
-}
-export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
-    hubspotId: string;
-}
-export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
-    snapchatPixelId: string;
-}
-export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
-    twitterPixelId: string;
-}
-export interface IntercomTagConfiguration extends UserDestinationConfiguration {
-    appId: string;
-    apiBase: string;
-}
-export interface WebhookConfiguration extends UserDestinationConfiguration {
-    webhookUrl: string;
-}
-export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
-    html: string;
-    location: CustomHTMLLocation;
-}
-export declare enum CustomHTMLLocation {
-    HEADER = "header",
-    FOOTER = "footer",
-    BODY = "body"
-}
+import { Destination, UserDestinationConfiguration } from './destinations';
+export interface AdTrackifyFacebookDestination extends Destination {
+    configuration: FacebookPixelConfiguration;
+}
+export interface AdTrackifyTikTokDestination extends Destination {
+    configuration: TiktokPixelConfiguration;
+}
+export interface AdTrackifyGoogleAnalytics4Destination extends Destination {
+    configuration: GoogleAnalytics4Configuration;
+}
+export interface FacebookPixelConfiguration extends UserDestinationConfiguration {
+    apiAccessToken?: string;
+    enableConversionAPI: boolean;
+    pixelId: string;
+}
+export interface TiktokPixelConfiguration extends UserDestinationConfiguration {
+    apiAccessToken?: string;
+    enableConversionAPI: boolean;
+    pixelId: string;
+}
+export interface GoogleAnalytics4Configuration extends UserDestinationConfiguration {
+    apiSecret: string;
+    measurementId: string;
+}
+export interface GoogleAdsConfiguration extends UserDestinationConfiguration {
+    pixelId: string;
+    conversionID: string;
+}
+export interface HubspotPixelConfiguration extends UserDestinationConfiguration {
+    hubspotId: string;
+}
+export interface SnapchatPixelConfiguration extends UserDestinationConfiguration {
+    snapchatPixelId: string;
+}
+export interface TwitterPixelConfiguration extends UserDestinationConfiguration {
+    twitterPixelId: string;
+}
+export interface IntercomTagConfiguration extends UserDestinationConfiguration {
+    appId: string;
+    apiBase: string;
+}
+export interface WebhookConfiguration extends UserDestinationConfiguration {
+    webhookUrl: string;
+}
+export interface CustomHTMLConfiguration extends UserDestinationConfiguration {
+    html: string;
+    location: CustomHTMLLocation;
+}
+export declare enum CustomHTMLLocation {
+    HEADER = "header",
+    FOOTER = "footer",
+    BODY = "body"
+}

package/dist/esm/types/api/destinations/third-party-destination-configs.js

@@ -1,7 +1,7 @@
-export var CustomHTMLLocation;
-(function (CustomHTMLLocation) {
-    CustomHTMLLocation["HEADER"] = "header";
-    CustomHTMLLocation["FOOTER"] = "footer";
-    CustomHTMLLocation["BODY"] = "body";
-})(CustomHTMLLocation || (CustomHTMLLocation = {}));
+export var CustomHTMLLocation;
+(function (CustomHTMLLocation) {
+    CustomHTMLLocation["HEADER"] = "header";
+    CustomHTMLLocation["FOOTER"] = "footer";
+    CustomHTMLLocation["BODY"] = "body";
+})(CustomHTMLLocation || (CustomHTMLLocation = {}));
 //# sourceMappingURL=third-party-destination-configs.js.map

package/dist/esm/types/api/event-status.d.ts

@@ -1,18 +1,18 @@
-import { TrackingEvent } from '../event';
-import { Destination } from './destinations/destinations';
-export interface EventStatus {
-    eventStatusId: string;
-    eventId: string;
-    pixelId: string;
-    event: TrackingEvent;
-    destinations: Destination[];
-    eventStatus: EventStatusIndicator;
-    eventReceivedAt: string;
-    createdAt: string;
-    updatedAt: string;
-}
-export declare enum EventStatusIndicator {
-    SUCCESS = "success",
-    FAILED = "failed",
-    UNKNOWN = "unknown"
-}
+import { TrackingEvent } from '../event';
+import { Destination } from './destinations/destinations';
+export interface EventStatus {
+    eventStatusId: string;
+    eventId: string;
+    pixelId: string;
+    event: TrackingEvent;
+    destinations: Destination[];
+    eventStatus: EventStatusIndicator;
+    eventReceivedAt: string;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare enum EventStatusIndicator {
+    SUCCESS = "success",
+    FAILED = "failed",
+    UNKNOWN = "unknown"
+}

package/dist/esm/types/api/event-status.js

@@ -1,7 +1,7 @@
-export var EventStatusIndicator;
-(function (EventStatusIndicator) {
-    EventStatusIndicator["SUCCESS"] = "success";
-    EventStatusIndicator["FAILED"] = "failed";
-    EventStatusIndicator["UNKNOWN"] = "unknown";
-})(EventStatusIndicator || (EventStatusIndicator = {}));
+export var EventStatusIndicator;
+(function (EventStatusIndicator) {
+    EventStatusIndicator["SUCCESS"] = "success";
+    EventStatusIndicator["FAILED"] = "failed";
+    EventStatusIndicator["UNKNOWN"] = "unknown";
+})(EventStatusIndicator || (EventStatusIndicator = {}));
 //# sourceMappingURL=event-status.js.map

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

@@ -1,9 +1,9 @@
-export * from './account';
-export * from './destinations/destinations';
-export * from './destinations/destination-catalog';
-export * from './destinations/third-party-destination-configs';
-export * from './shopify-app-install';
-export * from './subscription';
-export * from './user';
-export * from './query';
-export * from './event-status';
+export * from './account';
+export * from './destinations/destinations';
+export * from './destinations/destination-catalog';
+export * from './destinations/third-party-destination-configs';
+export * from './shopify-app-install';
+export * from './subscription';
+export * from './user';
+export * from './query';
+export * from './event-status';

package/dist/esm/types/api/index.js

@@ -1,10 +1,10 @@
-export * from './account';
-export * from './destinations/destinations';
-export * from './destinations/destination-catalog';
-export * from './destinations/third-party-destination-configs';
-export * from './shopify-app-install';
-export * from './subscription';
-export * from './user';
-export * from './query';
-export * from './event-status';
+export * from './account';
+export * from './destinations/destinations';
+export * from './destinations/destination-catalog';
+export * from './destinations/third-party-destination-configs';
+export * from './shopify-app-install';
+export * from './subscription';
+export * from './user';
+export * from './query';
+export * from './event-status';
 //# sourceMappingURL=index.js.map

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

@@ -1,143 +1,143 @@
-export interface DateRange {
-    start: string;
-    end: string;
-}
-export declare enum GRANULARITY {
-    NONE = "none",
-    SECOND = "second",
-    MINUTE = "minute",
-    HOUR = "hour",
-    DAY = "day",
-    WEEK = "week",
-    MONTH = "month",
-    QUARTER = "quarter",
-    YEAR = "year"
-}
-export declare enum MEASURE {
-    TRACKED_PAGE_VIEWS = "tracked.page_views",
-    TRACKED_VIEW_CONTENTS = "tracked.view_contents",
-    TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
-    TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
-    TRACKED_PURCHASES = "tracked.purchases",
-    TRACKED_REVENUE = "tracked.revenue",
-    TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
-    TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
-    TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
-    TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
-    TRACKED_UNIQUE_VISITORS = "tracked.visitors",
-    TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
-    TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
-    TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
-    TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
-    TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
-    SHOPIFY_CUSTOMERS = "shopify.customers",
-    SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
-    SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
-    SHOPIFY_REFUNDS = "shopify.refunds_count",
-    SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
-    SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
-    SHOPIFY_DISCOUNTS = "shopify.discounts_count",
-    SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
-    SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
-    SHOPIFY_ORDERS = "shopify.order_count",
-    SHOPIFY_REVENUE = "shopify.revenue",
-    SHOPIFY_AOV = "shopify.average_order_value",
-    SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
-    SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
-    SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
-    SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
-    SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
-    SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
-    SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
-    SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
-    SITE_TTFB = "site.ttfb",
-    SITE_FCP = "site.fcp",
-    SITE_LCP = "site.lcp",
-    SITE_TIME_ON_SITE = "site.time_on_site"
-}
-export interface Query {
-    pixelId: string;
-    measures: MEASURE[];
-    dateRange: DateRange;
-    compareDateRange?: DateRange;
-    granularity?: GRANULARITY;
-    dimensions?: DIMENSION[];
-    filters?: any[];
-}
-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;
-}
-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_CAMPAIGN = "utm_campaign",
-    UTM_SOURCE = "utm_source",
-    UTM_MEDIUM = "utm_medium",
-    UTM_TERM = "utm_term",
-    UTM_CONTENT = "utm_content",
-    CLICK_NETWORK = "click_network",
-    ADBLOCK_DETECTED = "adblock_detected",
-    TIMEZONE = "timezone",
-    LOCALE = "locale"
-}
+export interface DateRange {
+    start: string;
+    end: string;
+}
+export declare enum GRANULARITY {
+    NONE = "none",
+    SECOND = "second",
+    MINUTE = "minute",
+    HOUR = "hour",
+    DAY = "day",
+    WEEK = "week",
+    MONTH = "month",
+    QUARTER = "quarter",
+    YEAR = "year"
+}
+export declare enum MEASURE {
+    TRACKED_PAGE_VIEWS = "tracked.page_views",
+    TRACKED_VIEW_CONTENTS = "tracked.view_contents",
+    TRACKED_ADD_TO_CARTS = "tracked.add_to_carts",
+    TRACKED_INITIATE_CHECKOUTS = "tracked.initiate_checkouts",
+    TRACKED_PURCHASES = "tracked.purchases",
+    TRACKED_REVENUE = "tracked.revenue",
+    TRACKED_SESSION_CONVERSION_RATE = "tracked.session_conversion_rate",
+    TRACKED_REVENUE_PER_VISITOR = "tracked.revenue_per_visitor",
+    TRACKED_REVENUE_PER_SESSION = "tracked.revenue_per_session",
+    TRACKED_UNIQUE_SESSIONS = "tracked.sessions",
+    TRACKED_UNIQUE_VISITORS = "tracked.visitors",
+    TRACKED_ADD_TO_CART_RATE = "tracked.add_to_cart_rate",
+    TRACKED_VIEW_CONTENT_RATE = "tracked.view_content_rate",
+    TRACKED_INITIATE_CHECKOUT_RATE = "tracked.initiate_checkout_rate",
+    TRACKED_ATC_TO_IC_RATE = "tracked.atc_to_ic_rate",
+    TRACKED_IC_TO_PURCHASE_RATE = "tracked.ic_to_purchase_rate",
+    SHOPIFY_CUSTOMERS = "shopify.customers",
+    SHOPIFY_ABANDONED_CHECKOUTS_VALUE = "shopify.abandoned_checkouts_value",
+    SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
+    SHOPIFY_REFUNDS = "shopify.refunds_count",
+    SHOPIFY_REFUND_REVENUE = "shopify.refunds_amount",
+    SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
+    SHOPIFY_DISCOUNTS = "shopify.discounts_count",
+    SHOPIFY_DISCOUNT_AMOUNT = "shopify.discount_amount",
+    SHOPIFY_DISCOUNT_RATE = "shopify.discounts_rate",
+    SHOPIFY_ORDERS = "shopify.order_count",
+    SHOPIFY_REVENUE = "shopify.revenue",
+    SHOPIFY_AOV = "shopify.average_order_value",
+    SHOPIFY_TOP_PRODUCTS = "shopify.top_products",
+    SHOPIFY_CUSTOMER_LTV = "shopify.customer_ltv",
+    SHOPIFY_REPEAT_CUSTOMER_RATE = "shopify.repeat_customer_rate",
+    SHOPIFY_TAX_AMOUNT = "shopify.tax_amount",
+    SHOPIFY_SHIPPING_AMOUNT = "shopify.shipping_amount",
+    SHOPIFY_SUBTOTAL_AMOUNT = "shopify.subtotal_amount",
+    SHOPIFY_NEW_CUSTOMER_RATE = "shopify.new_customer_rate",
+    SHOPIFY_RETURNING_CUSTOMER_RATE = "shopify.new_customer_rate",
+    SITE_TTFB = "site.ttfb",
+    SITE_FCP = "site.fcp",
+    SITE_LCP = "site.lcp",
+    SITE_TIME_ON_SITE = "site.time_on_site"
+}
+export interface Query {
+    pixelId: string;
+    measures: MEASURE[];
+    dateRange: DateRange;
+    compareDateRange?: DateRange;
+    granularity?: GRANULARITY;
+    dimensions?: DIMENSION[];
+    filters?: any[];
+}
+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;
+}
+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_CAMPAIGN = "utm_campaign",
+    UTM_SOURCE = "utm_source",
+    UTM_MEDIUM = "utm_medium",
+    UTM_TERM = "utm_term",
+    UTM_CONTENT = "utm_content",
+    CLICK_NETWORK = "click_network",
+    ADBLOCK_DETECTED = "adblock_detected",
+    TIMEZONE = "timezone",
+    LOCALE = "locale"
+}