@adtrackify/at-tracking-event-types 2.0.2 → 2.0.3

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

@@ -1,97 +1,97 @@
-export interface DateRange {
-    start: string;
-    end: string;
-}
-export declare enum GRANULARITY {
-    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",
-    SHOPIFY_CUSTOMERS = "shopify.customers",
-    SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
-    SHOPIFY_RETURNS = "shopify.returns",
-    SHOPIFY_RETURN_REVENUE = "shopify.return_revenue",
-    SHOPIFY_RETURN_RATE = "shopify.return_rate",
-    SHOPIFY_REFUNDS = "shopify.refunds",
-    SHOPIFY_REFUND_REVENUE = "shopify.refunds_revenue",
-    SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
-    SHOPIFY_ORDERS = "shopify.orders",
-    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",
-    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 MeasureDataRow {
-    [key: string]: number | string;
-    'dt': string;
-}
-export interface MeasureData {
-    primaryAvg: number;
-    compareAvg: number;
-    primarySum: number;
-    compareSum: number;
-    percentDiff: number;
-    primary?: MeasureDataRow[];
-    compare?: MeasureDataRow[];
-}
-export interface MeasureResult {
-    measure: MEASURE;
-    granularity: GRANULARITY;
-    dateRange: DateRange;
-    compareDateRange?: DateRange;
-    success: boolean;
-    data: MeasureData;
-}
-export declare enum DIMENSION {
-    REFERRER = "referrer",
-    COUNTRY = "country",
-    POSTAL_CODE = "postal_code",
-    PROVINCE = "province",
-    DEVICE_MODEL = "device_model",
-    DEVICE_VENDOR = "device_vendor",
-    DEVICE_TYPE = "device_type",
-    BROWSER = "browser",
-    BROWSER_VERSION = "browser_version",
-    OS = "OS",
-    PAGE_PATH = "path",
-    PAGE_TITLE = "title",
-    QUERY_STRING = "query",
-    UTM_SOURCE = "utm_source",
-    UTM_MEDIUM = "utm_medium",
-    UTM_TERM = "utm_term",
-    UTM_CONTENT = "utm_content",
-    ADBLOCK_DETECTED = "adblock_detected",
-    TIMEZONE = "timezone",
-    LOCALE = "locale"
-}
+export interface DateRange {
+    start: string;
+    end: string;
+}
+export declare enum GRANULARITY {
+    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",
+    SHOPIFY_CUSTOMERS = "shopify.customers",
+    SHOPIFY_ABANDONED_CHECKOUTS = "shopify.abandoned_checkouts",
+    SHOPIFY_RETURNS = "shopify.returns",
+    SHOPIFY_RETURN_REVENUE = "shopify.return_revenue",
+    SHOPIFY_RETURN_RATE = "shopify.return_rate",
+    SHOPIFY_REFUNDS = "shopify.refunds",
+    SHOPIFY_REFUND_REVENUE = "shopify.refunds_revenue",
+    SHOPIFY_REFUND_RATE = "shopify.refunds_rate",
+    SHOPIFY_ORDERS = "shopify.orders",
+    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",
+    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 MeasureDataRow {
+    [key: string]: number | string;
+    'dt': string;
+}
+export interface MeasureData {
+    primaryAvg: number;
+    compareAvg: number;
+    primarySum: number;
+    compareSum: number;
+    percentDiff: number;
+    primary?: MeasureDataRow[];
+    compare?: MeasureDataRow[];
+}
+export interface MeasureResult {
+    measure: MEASURE;
+    granularity: GRANULARITY;
+    dateRange: DateRange;
+    compareDateRange?: DateRange;
+    success: boolean;
+    data: MeasureData;
+}
+export declare enum DIMENSION {
+    REFERRER = "referrer",
+    COUNTRY = "country",
+    POSTAL_CODE = "postal_code",
+    PROVINCE = "province",
+    DEVICE_MODEL = "device_model",
+    DEVICE_VENDOR = "device_vendor",
+    DEVICE_TYPE = "device_type",
+    BROWSER = "browser",
+    BROWSER_VERSION = "browser_version",
+    OS = "OS",
+    PAGE_PATH = "path",
+    PAGE_TITLE = "title",
+    QUERY_STRING = "query",
+    UTM_SOURCE = "utm_source",
+    UTM_MEDIUM = "utm_medium",
+    UTM_TERM = "utm_term",
+    UTM_CONTENT = "utm_content",
+    ADBLOCK_DETECTED = "adblock_detected",
+    TIMEZONE = "timezone",
+    LOCALE = "locale"
+}

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

@@ -1,67 +1,67 @@
-export var GRANULARITY;
-(function (GRANULARITY) {
-    GRANULARITY["SECOND"] = "second";
-    GRANULARITY["MINUTE"] = "minute";
-    GRANULARITY["HOUR"] = "hour";
-    GRANULARITY["DAY"] = "day";
-    GRANULARITY["WEEK"] = "week";
-    GRANULARITY["MONTH"] = "month";
-    GRANULARITY["QUARTER"] = "quarter";
-    GRANULARITY["YEAR"] = "year";
-})(GRANULARITY || (GRANULARITY = {}));
-export var MEASURE;
-(function (MEASURE) {
-    MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
-    MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
-    MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
-    MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
-    MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
-    MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
-    MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
-    MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
-    MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
-    MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
-    MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
-    MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
-    MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
-    MEASURE["SHOPIFY_RETURNS"] = "shopify.returns";
-    MEASURE["SHOPIFY_RETURN_REVENUE"] = "shopify.return_revenue";
-    MEASURE["SHOPIFY_RETURN_RATE"] = "shopify.return_rate";
-    MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds";
-    MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_revenue";
-    MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
-    MEASURE["SHOPIFY_ORDERS"] = "shopify.orders";
-    MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
-    MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
-    MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
-    MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
-    MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
-    MEASURE["SITE_TTFB"] = "site.ttfb";
-    MEASURE["SITE_FCP"] = "site.fcp";
-    MEASURE["SITE_LCP"] = "site.lcp";
-    MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
-})(MEASURE || (MEASURE = {}));
-export var DIMENSION;
-(function (DIMENSION) {
-    DIMENSION["REFERRER"] = "referrer";
-    DIMENSION["COUNTRY"] = "country";
-    DIMENSION["POSTAL_CODE"] = "postal_code";
-    DIMENSION["PROVINCE"] = "province";
-    DIMENSION["DEVICE_MODEL"] = "device_model";
-    DIMENSION["DEVICE_VENDOR"] = "device_vendor";
-    DIMENSION["DEVICE_TYPE"] = "device_type";
-    DIMENSION["BROWSER"] = "browser";
-    DIMENSION["BROWSER_VERSION"] = "browser_version";
-    DIMENSION["OS"] = "OS";
-    DIMENSION["PAGE_PATH"] = "path";
-    DIMENSION["PAGE_TITLE"] = "title";
-    DIMENSION["QUERY_STRING"] = "query";
-    DIMENSION["UTM_SOURCE"] = "utm_source";
-    DIMENSION["UTM_MEDIUM"] = "utm_medium";
-    DIMENSION["UTM_TERM"] = "utm_term";
-    DIMENSION["UTM_CONTENT"] = "utm_content";
-    DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
-    DIMENSION["TIMEZONE"] = "timezone";
-    DIMENSION["LOCALE"] = "locale";
-})(DIMENSION || (DIMENSION = {}));
+export var GRANULARITY;
+(function (GRANULARITY) {
+    GRANULARITY["SECOND"] = "second";
+    GRANULARITY["MINUTE"] = "minute";
+    GRANULARITY["HOUR"] = "hour";
+    GRANULARITY["DAY"] = "day";
+    GRANULARITY["WEEK"] = "week";
+    GRANULARITY["MONTH"] = "month";
+    GRANULARITY["QUARTER"] = "quarter";
+    GRANULARITY["YEAR"] = "year";
+})(GRANULARITY || (GRANULARITY = {}));
+export var MEASURE;
+(function (MEASURE) {
+    MEASURE["TRACKED_PAGE_VIEWS"] = "tracked.page_views";
+    MEASURE["TRACKED_VIEW_CONTENTS"] = "tracked.view_contents";
+    MEASURE["TRACKED_ADD_TO_CARTS"] = "tracked.add_to_carts";
+    MEASURE["TRACKED_INITIATE_CHECKOUTS"] = "tracked.initiate_checkouts";
+    MEASURE["TRACKED_PURCHASES"] = "tracked.purchases";
+    MEASURE["TRACKED_REVENUE"] = "tracked.revenue";
+    MEASURE["TRACKED_SESSION_CONVERSION_RATE"] = "tracked.session_conversion_rate";
+    MEASURE["TRACKED_REVENUE_PER_VISITOR"] = "tracked.revenue_per_visitor";
+    MEASURE["TRACKED_REVENUE_PER_SESSION"] = "tracked.revenue_per_session";
+    MEASURE["TRACKED_UNIQUE_SESSIONS"] = "tracked.sessions";
+    MEASURE["TRACKED_UNIQUE_VISITORS"] = "tracked.visitors";
+    MEASURE["SHOPIFY_CUSTOMERS"] = "shopify.customers";
+    MEASURE["SHOPIFY_ABANDONED_CHECKOUTS"] = "shopify.abandoned_checkouts";
+    MEASURE["SHOPIFY_RETURNS"] = "shopify.returns";
+    MEASURE["SHOPIFY_RETURN_REVENUE"] = "shopify.return_revenue";
+    MEASURE["SHOPIFY_RETURN_RATE"] = "shopify.return_rate";
+    MEASURE["SHOPIFY_REFUNDS"] = "shopify.refunds";
+    MEASURE["SHOPIFY_REFUND_REVENUE"] = "shopify.refunds_revenue";
+    MEASURE["SHOPIFY_REFUND_RATE"] = "shopify.refunds_rate";
+    MEASURE["SHOPIFY_ORDERS"] = "shopify.orders";
+    MEASURE["SHOPIFY_REVENUE"] = "shopify.revenue";
+    MEASURE["SHOPIFY_AOV"] = "shopify.average_order_value";
+    MEASURE["SHOPIFY_TOP_PRODUCTS"] = "shopify.top_products";
+    MEASURE["SHOPIFY_CUSTOMER_LTV"] = "shopify.customer_ltv";
+    MEASURE["SHOPIFY_REPEAT_CUSTOMER_RATE"] = "shopify.repeat_customer_rate";
+    MEASURE["SITE_TTFB"] = "site.ttfb";
+    MEASURE["SITE_FCP"] = "site.fcp";
+    MEASURE["SITE_LCP"] = "site.lcp";
+    MEASURE["SITE_TIME_ON_SITE"] = "site.time_on_site";
+})(MEASURE || (MEASURE = {}));
+export var DIMENSION;
+(function (DIMENSION) {
+    DIMENSION["REFERRER"] = "referrer";
+    DIMENSION["COUNTRY"] = "country";
+    DIMENSION["POSTAL_CODE"] = "postal_code";
+    DIMENSION["PROVINCE"] = "province";
+    DIMENSION["DEVICE_MODEL"] = "device_model";
+    DIMENSION["DEVICE_VENDOR"] = "device_vendor";
+    DIMENSION["DEVICE_TYPE"] = "device_type";
+    DIMENSION["BROWSER"] = "browser";
+    DIMENSION["BROWSER_VERSION"] = "browser_version";
+    DIMENSION["OS"] = "OS";
+    DIMENSION["PAGE_PATH"] = "path";
+    DIMENSION["PAGE_TITLE"] = "title";
+    DIMENSION["QUERY_STRING"] = "query";
+    DIMENSION["UTM_SOURCE"] = "utm_source";
+    DIMENSION["UTM_MEDIUM"] = "utm_medium";
+    DIMENSION["UTM_TERM"] = "utm_term";
+    DIMENSION["UTM_CONTENT"] = "utm_content";
+    DIMENSION["ADBLOCK_DETECTED"] = "adblock_detected";
+    DIMENSION["TIMEZONE"] = "timezone";
+    DIMENSION["LOCALE"] = "locale";
+})(DIMENSION || (DIMENSION = {}));
 //# sourceMappingURL=query.js.map

package/dist/esm/types/api/shopify-app-install.d.ts

@@ -1,46 +1,46 @@
-export interface ShopifyAppInstall {
-    shopifyAppInstallId: string;
-    shop: string;
-    accessToken?: string;
-    appStatus?: string;
-    appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
-    code?: string;
-    hmac?: string;
-    host?: string;
-    installRequest?: ShopifyInstallRequest;
-    isAppEnabled?: boolean;
-    pixelId?: string;
-    shopInfo?: any;
-    state?: string;
-    timestamp?: number;
-    createdAt: string;
-    updatedAt: string;
-}
-export declare enum ShopifyAppInstallStatus {
-    STARTED = "started",
-    COMPLETED = "completed",
-    UNINSTALLED = "uninstalled",
-    FAILED = "failed",
-    NONE = "none"
-}
-export declare enum ShopifyAppSubscriptionStatus {
-    ACTIVE = "active",
-    CANCELLED = "cancelled",
-    DECLINED = "declined",
-    EXPIRED = "expired",
-    FROZEN = "frozen",
-    PENDING = "pending",
-    NOT_SUBMITTED = "na"
-}
-export interface ShopifyInstallRequest {
-    shop?: string;
-    session?: string;
-    hmac?: string;
-    host?: string;
-    nonce?: string;
-    timestamp?: string;
-    status?: string;
-}
-export interface ShopifyStoreInfo {
-    [key: string]: any;
-}
+export interface ShopifyAppInstall {
+    shopifyAppInstallId: string;
+    shop: string;
+    accessToken?: string;
+    appStatus?: string;
+    appSubscriptionStatus?: ShopifyAppSubscriptionStatus;
+    code?: string;
+    hmac?: string;
+    host?: string;
+    installRequest?: ShopifyInstallRequest;
+    isAppEnabled?: boolean;
+    pixelId?: string;
+    shopInfo?: any;
+    state?: string;
+    timestamp?: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export declare enum ShopifyAppInstallStatus {
+    STARTED = "started",
+    COMPLETED = "completed",
+    UNINSTALLED = "uninstalled",
+    FAILED = "failed",
+    NONE = "none"
+}
+export declare enum ShopifyAppSubscriptionStatus {
+    ACTIVE = "active",
+    CANCELLED = "cancelled",
+    DECLINED = "declined",
+    EXPIRED = "expired",
+    FROZEN = "frozen",
+    PENDING = "pending",
+    NOT_SUBMITTED = "na"
+}
+export interface ShopifyInstallRequest {
+    shop?: string;
+    session?: string;
+    hmac?: string;
+    host?: string;
+    nonce?: string;
+    timestamp?: string;
+    status?: string;
+}
+export interface ShopifyStoreInfo {
+    [key: string]: any;
+}

package/dist/esm/types/api/shopify-app-install.js

@@ -1,19 +1,19 @@
-export var ShopifyAppInstallStatus;
-(function (ShopifyAppInstallStatus) {
-    ShopifyAppInstallStatus["STARTED"] = "started";
-    ShopifyAppInstallStatus["COMPLETED"] = "completed";
-    ShopifyAppInstallStatus["UNINSTALLED"] = "uninstalled";
-    ShopifyAppInstallStatus["FAILED"] = "failed";
-    ShopifyAppInstallStatus["NONE"] = "none";
-})(ShopifyAppInstallStatus || (ShopifyAppInstallStatus = {}));
-export var ShopifyAppSubscriptionStatus;
-(function (ShopifyAppSubscriptionStatus) {
-    ShopifyAppSubscriptionStatus["ACTIVE"] = "active";
-    ShopifyAppSubscriptionStatus["CANCELLED"] = "cancelled";
-    ShopifyAppSubscriptionStatus["DECLINED"] = "declined";
-    ShopifyAppSubscriptionStatus["EXPIRED"] = "expired";
-    ShopifyAppSubscriptionStatus["FROZEN"] = "frozen";
-    ShopifyAppSubscriptionStatus["PENDING"] = "pending";
-    ShopifyAppSubscriptionStatus["NOT_SUBMITTED"] = "na";
-})(ShopifyAppSubscriptionStatus || (ShopifyAppSubscriptionStatus = {}));
+export var ShopifyAppInstallStatus;
+(function (ShopifyAppInstallStatus) {
+    ShopifyAppInstallStatus["STARTED"] = "started";
+    ShopifyAppInstallStatus["COMPLETED"] = "completed";
+    ShopifyAppInstallStatus["UNINSTALLED"] = "uninstalled";
+    ShopifyAppInstallStatus["FAILED"] = "failed";
+    ShopifyAppInstallStatus["NONE"] = "none";
+})(ShopifyAppInstallStatus || (ShopifyAppInstallStatus = {}));
+export var ShopifyAppSubscriptionStatus;
+(function (ShopifyAppSubscriptionStatus) {
+    ShopifyAppSubscriptionStatus["ACTIVE"] = "active";
+    ShopifyAppSubscriptionStatus["CANCELLED"] = "cancelled";
+    ShopifyAppSubscriptionStatus["DECLINED"] = "declined";
+    ShopifyAppSubscriptionStatus["EXPIRED"] = "expired";
+    ShopifyAppSubscriptionStatus["FROZEN"] = "frozen";
+    ShopifyAppSubscriptionStatus["PENDING"] = "pending";
+    ShopifyAppSubscriptionStatus["NOT_SUBMITTED"] = "na";
+})(ShopifyAppSubscriptionStatus || (ShopifyAppSubscriptionStatus = {}));
 //# sourceMappingURL=shopify-app-install.js.map

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

@@ -1,60 +1,60 @@
-export interface Subscription {
-    id: string;
-    accountId?: string;
-    shopifyAppInstallId?: string;
-    shopifyDomain?: string;
-    stripeCustomerId?: string;
-    stripeSubscriptionId?: string;
-    stripeCompletedCheckoutSession?: any;
-    shopifyChargeId?: string;
-    subscriptionPlan?: SubscriptionPlan;
-    status?: SUBSCRIPTION_STATUS;
-    paymentStatus?: PAYMENT_STATUS;
-    paymentGateway?: PAYMENT_GATEWAY;
-    createdAt: string;
-    updatedAt: string;
-}
-export interface SubscriptionPlan {
-    id: number;
-    planName: string;
-    displayName: string;
-    description: string;
-    sku: string;
-    price: string;
-    displayPrice: string;
-    billingFrequency: PLAN_BILLING_FREQUENCY;
-    trialLengthDays?: number;
-    trialRequiresCreditCard?: boolean;
-    planDesc?: string[];
-    unitPriceText?: string;
-    isHighlighted?: boolean;
-    isBanner?: boolean;
-    bannerText?: string;
-    bannerColor?: string;
-    stripePriceId?: string;
-    stripeProductId?: string;
-}
-export declare enum PLAN_BILLING_FREQUENCY {
-    MONTHLY = "monthly",
-    YEARLY = "yearly"
-}
-export declare enum PAYMENT_STATUS {
-    CURRENT = "current",
-    PAST_DUE = "past_due",
-    CANCELLED = "cancelled",
-    FAILED = "failed"
-}
-export declare enum SUBSCRIPTION_STATUS {
-    ACTIVE = "active",
-    CANCELLED = "cancelled",
-    DECLINED = "declined",
-    EXPIRED = "expired",
-    FROZEN = "frozen",
-    PENDING = "pending",
-    NOT_SUBMITTED = "na"
-}
-export declare enum PAYMENT_GATEWAY {
-    STRIPE = "stripe",
-    PAYPAL = "paypal",
-    SHOPIFY = "shopify"
-}
+export interface Subscription {
+    id: string;
+    accountId?: string;
+    shopifyAppInstallId?: string;
+    shopifyDomain?: string;
+    stripeCustomerId?: string;
+    stripeSubscriptionId?: string;
+    stripeCompletedCheckoutSession?: any;
+    shopifyChargeId?: string;
+    subscriptionPlan?: SubscriptionPlan;
+    status?: SUBSCRIPTION_STATUS;
+    paymentStatus?: PAYMENT_STATUS;
+    paymentGateway?: PAYMENT_GATEWAY;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface SubscriptionPlan {
+    id: number;
+    planName: string;
+    displayName: string;
+    description: string;
+    sku: string;
+    price: string;
+    displayPrice: string;
+    billingFrequency: PLAN_BILLING_FREQUENCY;
+    trialLengthDays?: number;
+    trialRequiresCreditCard?: boolean;
+    planDesc?: string[];
+    unitPriceText?: string;
+    isHighlighted?: boolean;
+    isBanner?: boolean;
+    bannerText?: string;
+    bannerColor?: string;
+    stripePriceId?: string;
+    stripeProductId?: string;
+}
+export declare enum PLAN_BILLING_FREQUENCY {
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+export declare enum PAYMENT_STATUS {
+    CURRENT = "current",
+    PAST_DUE = "past_due",
+    CANCELLED = "cancelled",
+    FAILED = "failed"
+}
+export declare enum SUBSCRIPTION_STATUS {
+    ACTIVE = "active",
+    CANCELLED = "cancelled",
+    DECLINED = "declined",
+    EXPIRED = "expired",
+    FROZEN = "frozen",
+    PENDING = "pending",
+    NOT_SUBMITTED = "na"
+}
+export declare enum PAYMENT_GATEWAY {
+    STRIPE = "stripe",
+    PAYPAL = "paypal",
+    SHOPIFY = "shopify"
+}

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

@@ -1,29 +1,29 @@
-export var PLAN_BILLING_FREQUENCY;
-(function (PLAN_BILLING_FREQUENCY) {
-    PLAN_BILLING_FREQUENCY["MONTHLY"] = "monthly";
-    PLAN_BILLING_FREQUENCY["YEARLY"] = "yearly";
-})(PLAN_BILLING_FREQUENCY || (PLAN_BILLING_FREQUENCY = {}));
-export var PAYMENT_STATUS;
-(function (PAYMENT_STATUS) {
-    PAYMENT_STATUS["CURRENT"] = "current";
-    PAYMENT_STATUS["PAST_DUE"] = "past_due";
-    PAYMENT_STATUS["CANCELLED"] = "cancelled";
-    PAYMENT_STATUS["FAILED"] = "failed";
-})(PAYMENT_STATUS || (PAYMENT_STATUS = {}));
-export var SUBSCRIPTION_STATUS;
-(function (SUBSCRIPTION_STATUS) {
-    SUBSCRIPTION_STATUS["ACTIVE"] = "active";
-    SUBSCRIPTION_STATUS["CANCELLED"] = "cancelled";
-    SUBSCRIPTION_STATUS["DECLINED"] = "declined";
-    SUBSCRIPTION_STATUS["EXPIRED"] = "expired";
-    SUBSCRIPTION_STATUS["FROZEN"] = "frozen";
-    SUBSCRIPTION_STATUS["PENDING"] = "pending";
-    SUBSCRIPTION_STATUS["NOT_SUBMITTED"] = "na";
-})(SUBSCRIPTION_STATUS || (SUBSCRIPTION_STATUS = {}));
-export var PAYMENT_GATEWAY;
-(function (PAYMENT_GATEWAY) {
-    PAYMENT_GATEWAY["STRIPE"] = "stripe";
-    PAYMENT_GATEWAY["PAYPAL"] = "paypal";
-    PAYMENT_GATEWAY["SHOPIFY"] = "shopify";
-})(PAYMENT_GATEWAY || (PAYMENT_GATEWAY = {}));
+export var PLAN_BILLING_FREQUENCY;
+(function (PLAN_BILLING_FREQUENCY) {
+    PLAN_BILLING_FREQUENCY["MONTHLY"] = "monthly";
+    PLAN_BILLING_FREQUENCY["YEARLY"] = "yearly";
+})(PLAN_BILLING_FREQUENCY || (PLAN_BILLING_FREQUENCY = {}));
+export var PAYMENT_STATUS;
+(function (PAYMENT_STATUS) {
+    PAYMENT_STATUS["CURRENT"] = "current";
+    PAYMENT_STATUS["PAST_DUE"] = "past_due";
+    PAYMENT_STATUS["CANCELLED"] = "cancelled";
+    PAYMENT_STATUS["FAILED"] = "failed";
+})(PAYMENT_STATUS || (PAYMENT_STATUS = {}));
+export var SUBSCRIPTION_STATUS;
+(function (SUBSCRIPTION_STATUS) {
+    SUBSCRIPTION_STATUS["ACTIVE"] = "active";
+    SUBSCRIPTION_STATUS["CANCELLED"] = "cancelled";
+    SUBSCRIPTION_STATUS["DECLINED"] = "declined";
+    SUBSCRIPTION_STATUS["EXPIRED"] = "expired";
+    SUBSCRIPTION_STATUS["FROZEN"] = "frozen";
+    SUBSCRIPTION_STATUS["PENDING"] = "pending";
+    SUBSCRIPTION_STATUS["NOT_SUBMITTED"] = "na";
+})(SUBSCRIPTION_STATUS || (SUBSCRIPTION_STATUS = {}));
+export var PAYMENT_GATEWAY;
+(function (PAYMENT_GATEWAY) {
+    PAYMENT_GATEWAY["STRIPE"] = "stripe";
+    PAYMENT_GATEWAY["PAYPAL"] = "paypal";
+    PAYMENT_GATEWAY["SHOPIFY"] = "shopify";
+})(PAYMENT_GATEWAY || (PAYMENT_GATEWAY = {}));
 //# sourceMappingURL=subscription.js.map