@artisan-commerce/analytics-web 0.2.0-canary.81 → 0.2.0-canary.9

package/build/src/lib/events/category/index.d.ts

@@ -0,0 +1,7 @@
+declare const events: {
+    logCategoryImpression: (params: import("./categoryImpression/categoryImpression.types").CategoryImpressionParams) => void;
+    logSearchCategoryAttempt: (params: import("./searchCategoryAttempt/searchCategoryAttempt.types").SearchCategoryAttemptParams) => void;
+    logSelectCategory: (params: import("./selectCategory/selectCategory.types").SelectCategoryParams) => void;
+    logViewCategory: (params: import("./viewCategory/viewCategory.types").ViewCategoryParams) => void;
+};
+export default events;

package/build/src/lib/events/category/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/category/searchCategoryAttempt/searchCategoryAttempt.d.ts

@@ -0,0 +1,11 @@
+import { SearchCategoryAttemptParams } from "./searchCategoryAttempt.types";
+/**
+ * Emits a SearchCategoryAttempt event to every configured provider.
+ *
+ * Log this event when users try to search an specific category.
+ *
+ * @since 0.5.14
+ * @property {SearchCategoryAttemptParams} params SearchCategoryAttempt event parameters
+ */
+declare const logSearchCategoryAttempt: (params: SearchCategoryAttemptParams) => void;
+export default logSearchCategoryAttempt;

package/build/src/lib/events/category/searchCategoryAttempt/searchCategoryAttempt.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/category/searchCategoryAttempt/searchCategoryAttempt.types.d.ts

@@ -0,0 +1,20 @@
+import { SearchCategoryAttemptParams as GoogleSearchCategoryAttemptParams } from "../../../providers/GoogleAnalytics/events/category/searchCategoryAttempt/searchCategoryAttempt.types";
+import { SearchCategoryAttemptParams as FacebookSearchCategoryAttemptParams } from "../../../providers/FacebookPixel/events/category/searchCategoryAttempt/searchCategoryAttempt.types";
+import { SearchCategoryAttemptParams as SegmentSearchCategoryAttemptParams } from "../../../providers/Segment/events/category/searchCategoryAttempt/searchCategoryAttempt.types";
+/**
+ * searchCategoryAttempt event interface
+ *
+ * @interface SearchCategoryAttemptCommonParams
+ * @since 0.5.14
+ * @property {string} query the searched text
+ */
+export interface SearchCategoryAttemptCommonParams {
+    query: string;
+}
+/**
+ * SearchCategoryAttempt event params.
+ *
+ * @typedef SearchCategoryAttemptParams
+ * @since 0.5.14
+ */
+export declare type SearchCategoryAttemptParams = GoogleSearchCategoryAttemptParams & FacebookSearchCategoryAttemptParams & SegmentSearchCategoryAttemptParams;

package/build/src/lib/events/category/selectCategory/selectCategory.d.ts

@@ -0,0 +1,12 @@
+import { SelectCategoryParams } from "./selectCategory.types";
+/**
+ * Emits a selectCategory event to every configured provider.
+ *
+ * Log this event when users select a category. This category may or may not
+ * be on a list.
+ *
+ * @since 0.5.14
+ * @property {SelectCategoryParams} params SelectCategory event parameters
+ */
+declare const logSelectCategory: (params: SelectCategoryParams) => void;
+export default logSelectCategory;

package/build/src/lib/events/category/selectCategory/selectCategory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/category/selectCategory/selectCategory.types.d.ts

@@ -0,0 +1,25 @@
+import { Category } from "@artisan-commerce/types";
+import { SelectCategoryParams as GoogleSelectCategoryParams } from "../../../providers/GoogleAnalytics/events/category/selectCategory/selectCategory.types";
+import { SelectCategoryParams as FacebookSelectCategoryParams } from "../../../providers/FacebookPixel/events/category/selectCategory/selectCategory.types";
+import { SelectCategoryParams as SegmentSelectCategoryParams } from "../../../providers/Segment/events/category/selectCategory/selectCategory.types";
+/**
+ * selectCategory event interface
+ *
+ * @interface SelectCategoryCommonParams
+ * @since 0.5.14
+ * @property {Category} query the selected category
+ * @property {string} list the name of the list where the category is
+ * @property {number} position the position in a list where the category is
+ */
+export interface SelectCategoryCommonParams {
+    category: Category;
+    list?: string;
+    position?: number;
+}
+/**
+ * selectCategory event params.
+ *
+ * @typedef SelectCategoryParams
+ * @since 0.5.14
+ */
+export declare type SelectCategoryParams = GoogleSelectCategoryParams & FacebookSelectCategoryParams & SegmentSelectCategoryParams;

package/build/src/lib/events/category/viewCategory/viewCategory.d.ts

@@ -0,0 +1,12 @@
+import { ViewCategoryParams } from "./viewCategory.types";
+/**
+ * Emits a viewCategory event to every configured provider.
+ *
+ * Log this event when the details or products of a category load successfully
+ * and are shown to the user.
+ *
+ * @since 0.5.14
+ * @property {ViewCategoryParams} params ViewCategory event parameters
+ */
+declare const logViewCategory: (params: ViewCategoryParams) => void;
+export default logViewCategory;

package/build/src/lib/events/category/viewCategory/viewCategory.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/category/viewCategory/viewCategory.types.d.ts

@@ -0,0 +1,21 @@
+import { Category } from "@artisan-commerce/types";
+import { ViewCategoryParams as GoogleViewCategoryParams } from "../../../providers/GoogleAnalytics/events/category/viewCategory/viewCategory.types";
+import { ViewCategoryParams as FacebookViewCategoryParams } from "../../../providers/FacebookPixel/events/category/viewCategory/viewCategory.types";
+import { ViewCategoryParams as SegmentViewCategoryParams } from "../../../providers/Segment/events/category/viewCategory/viewCategory.types";
+/**
+ * viewCategory event interface
+ *
+ * @interface ViewCategoryCommonParams
+ * @since 0.5.14
+ * @property {Category} category the category that the details are being viewed
+ */
+export interface ViewCategoryCommonParams {
+    category: Category;
+}
+/**
+ * viewCategory event params.
+ *
+ * @typedef ViewCategoryParams
+ * @since 0.5.14
+ */
+export declare type ViewCategoryParams = GoogleViewCategoryParams & FacebookViewCategoryParams & SegmentViewCategoryParams;

package/build/src/lib/events/checkout/checkoutAction/checkoutAction.d.ts

@@ -0,0 +1,11 @@
+import { CheckoutActionParams } from "./checkoutAction.types";
+/**
+ * Emits a checkoutAction event to every configured provider.
+ *
+ * Log this event when users complete a step in the checkout progress.
+ *
+ * @since 0.5.14
+ * @property {CheckoutActionParams} params CheckoutAction event parameters
+ */
+declare const logCheckoutAction: (params: CheckoutActionParams) => void;
+export default logCheckoutAction;

package/build/src/lib/events/checkout/checkoutAction/checkoutAction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/checkout/checkoutAction/checkoutAction.types.d.ts

@@ -0,0 +1,22 @@
+import { CheckoutActionParams as GoogleCheckoutActionParams } from "../../../providers/GoogleAnalytics/events/checkout/checkoutAction/checkoutAction.types";
+import { CheckoutActionParams as FacebookCheckoutActionParams } from "../../../providers/FacebookPixel/events/checkout/checkoutAction/checkoutAction.types";
+import { CheckoutActionParams as SegmentCheckoutActionParams } from "../../../providers/Segment/events/checkout/checkoutAction/checkoutAction.types";
+/**
+ * checkoutAction event interface
+ *
+ * @interface CheckoutActionCommonParams
+ * @since 0.5.14
+ * @property {string} action The name of the checkout step (e.g "billing")
+ * @property {string} progress The completeness of the checkout progress (e.g "1/3")
+ */
+export interface CheckoutActionCommonParams {
+    action: string;
+    progress?: string;
+}
+/**
+ * checkoutAction event params.
+ *
+ * @typedef CheckoutActionParams
+ * @since 0.5.14
+ */
+export declare type CheckoutActionParams = GoogleCheckoutActionParams & FacebookCheckoutActionParams & SegmentCheckoutActionParams;

package/build/src/lib/events/checkout/index.d.ts

@@ -0,0 +1,5 @@
+declare const events: {
+    logCheckoutAction: (params: import("./checkoutAction/checkoutAction.types").CheckoutActionParams) => void;
+    logInitiateCheckout: (params: import("./initiateCheckout/initiateCheckout.types").InitiateCheckoutParams) => void;
+};
+export default events;

package/build/src/lib/events/checkout/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/checkout/initiateCheckout/initiateCheckout.d.ts

@@ -0,0 +1,11 @@
+import { InitiateCheckoutParams } from "./initiateCheckout.types";
+/**
+ * Emits a initiateCheckout event to every configured provider.
+ *
+ * Log this event at the start of a checkout process.
+ *
+ * @since 0.5.14
+ * @property {InitiateCheckoutParams} params InitiateCheckout event parameters
+ */
+declare const logInitiateCheckout: (params: InitiateCheckoutParams) => void;
+export default logInitiateCheckout;

package/build/src/lib/events/checkout/initiateCheckout/initiateCheckout.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/checkout/initiateCheckout/initiateCheckout.types.d.ts

@@ -0,0 +1,21 @@
+import { ShoppingCart } from "@artisan-commerce/types";
+import { InitiateCheckoutParams as GoogleInitiateCheckoutParams } from "../../../providers/GoogleAnalytics/events/checkout/initiateCheckout/initiateCheckout.types";
+import { InitiateCheckoutParams as FacebookInitiateCheckoutParams } from "../../../providers/FacebookPixel/events/checkout/initiateCheckout/initiateCheckout.types";
+import { InitiateCheckoutParams as SegmentInitiateCheckoutParams } from "../../../providers/Segment/events/checkout/initiateCheckout/initiateCheckout.types";
+/**
+ * initiateCheckout event interface
+ *
+ * @interface InitiateCheckoutCommonParams
+ * @since 0.5.14
+ * @property {ShoppingCart} shoppingCart The order's shopping cart
+ */
+export interface InitiateCheckoutCommonParams {
+    shoppingCart: ShoppingCart;
+}
+/**
+ * initiateCheckout event params.
+ *
+ * @typedef InitiateCheckoutParams
+ * @since 0.5.14
+ */
+export declare type InitiateCheckoutParams = GoogleInitiateCheckoutParams & FacebookInitiateCheckoutParams & SegmentInitiateCheckoutParams;

package/build/src/lib/events/coupon/applyBenefit/applyBenefit.d.ts

@@ -0,0 +1,11 @@
+import { ApplyBenefitParams } from "./applyBenefit.types";
+/**
+ * Emits a applyBenefit event to every configured provider.
+ *
+ * Log this event when users apply a coupon on their order.
+ *
+ * @since 0.5.14
+ * @property {ApplyBenefitParams} params ApplyBenefit event parameters
+ */
+declare const logApplyBenefit: (params: ApplyBenefitParams) => void;
+export default logApplyBenefit;

package/build/src/lib/events/coupon/applyBenefit/applyBenefit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/applyBenefit/applyBenefit.types.d.ts

@@ -0,0 +1,24 @@
+import { ApplyBenefitParams as GoogleApplyBenefitParams } from "../../../providers/GoogleAnalytics/events/coupon/applyBenefit/applyBenefit.types";
+import { ApplyBenefitParams as FacebookApplyBenefitParams } from "../../../providers/FacebookPixel/events/coupon/applyBenefit/applyBenefit.types";
+import { ApplyBenefitParams as SegmentApplyBenefitParams } from "../../../providers/Segment/events/coupon/applyBenefit/applyBenefit.types";
+/**
+ * applyBenefit event interface
+ *
+ * @interface ApplyBenefitCommonParams
+ * @since 0.5.14
+ * @property {string} benefitId The benefit identifier
+ * @property {string} benefitName The name of benefit
+ * @property {string} discount The value of the discount (e.g 10%, FREE-SHIPPING)
+ */
+export interface ApplyBenefitCommonParams {
+    benefitId: string;
+    benefitName: string;
+    discount: string;
+}
+/**
+ * applyBenefit event params.
+ *
+ * @typedef ApplyBenefitParams
+ * @since 0.5.14
+ */
+export declare type ApplyBenefitParams = GoogleApplyBenefitParams & FacebookApplyBenefitParams & SegmentApplyBenefitParams;

package/build/src/lib/events/coupon/couponCodeError/couponCodeError.d.ts

@@ -0,0 +1,11 @@
+import { CouponCodeErrorParams } from "./couponCodeError.types";
+/**
+ * Emits a couponCodeError event to every configured provider.
+ *
+ * Log this event when your redeem coupon request has failed.
+ *
+ * @since 0.5.14
+ * @property {CouponCodeErrorParams} params CouponCodeError event parameters
+ */
+declare const logCouponCodeError: (params: CouponCodeErrorParams) => void;
+export default logCouponCodeError;

package/build/src/lib/events/coupon/couponCodeError/couponCodeError.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/couponCodeError/couponCodeError.types.d.ts

@@ -0,0 +1,24 @@
+import { CouponCodeErrorParams as GoogleCouponCodeErrorParams } from "../../../providers/GoogleAnalytics/events/coupon/couponCodeError/couponCodeError.types";
+import { CouponCodeErrorParams as FacebookCouponCodeErrorParams } from "../../../providers/FacebookPixel/events/coupon/couponCodeError/couponCodeError.types";
+import { CouponCodeErrorParams as SegmentCouponCodeErrorParams } from "../../../providers/Segment/events/coupon/couponCodeError/couponCodeError.types";
+/**
+ * couponCodeError event interface
+ *
+ * @interface CouponCodeErrorCommonParams
+ * @since 0.5.14
+ * @property {string} code The code of the coupon
+ * @property {string} message The response error message
+ * @property {number} message The response status code
+ */
+export interface CouponCodeErrorCommonParams {
+    code: string;
+    message: string;
+    statusCode: number;
+}
+/**
+ * couponCodeError event params.
+ *
+ * @typedef CouponCodeErrorParams
+ * @since 0.5.14
+ */
+export declare type CouponCodeErrorParams = GoogleCouponCodeErrorParams & FacebookCouponCodeErrorParams & SegmentCouponCodeErrorParams;

package/build/src/lib/events/coupon/index.d.ts

@@ -0,0 +1,10 @@
+declare const events: {
+    logApplyBenefit: (params: import("./applyBenefit/applyBenefit.types").ApplyBenefitParams) => void;
+    logCouponCodeError: (params: import("./couponCodeError/couponCodeError.types").CouponCodeErrorParams) => void;
+    logRedeemCouponCode: (params: import("./redeemCouponCode/redeemCouponCode.types").RedeemCouponCodeParams) => void;
+    logRemoveBenefit: (params: import("./removeBenefit/removeBenefit.types").RemoveBenefitParams) => void;
+    logViewBenefitDetails: (params: import("./viewBenefitDetails/viewBenefitDetails.types").ViewBenefitDetailsParams) => void;
+    logViewBenefitsWallet: (params: import("./viewBenefitsWallet/viewBenefitsWallet.types").ViewBenefitsWalletParams) => void;
+    logViewQRStoreCoupon: (params?: import("./viewQRStoreCoupon/viewQRStoreCoupon.types").ViewQRStoreCouponParams) => void;
+};
+export default events;

package/build/src/lib/events/coupon/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/redeemCouponCode/redeemCouponCode.d.ts

@@ -0,0 +1,11 @@
+import { RedeemCouponCodeParams } from "./redeemCouponCode.types";
+/**
+ * Emits a redeemCouponCode event to every configured provider.
+ *
+ * Log this event when users successfully redeem a coupon.
+ *
+ * @since 0.5.14
+ * @property {RedeemCouponCodeParams} params RedeemCouponCode event parameters
+ */
+declare const logRedeemCouponCode: (params: RedeemCouponCodeParams) => void;
+export default logRedeemCouponCode;

package/build/src/lib/events/coupon/redeemCouponCode/redeemCouponCode.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/redeemCouponCode/redeemCouponCode.types.d.ts

@@ -0,0 +1,24 @@
+import { RedeemCouponCodeParams as GoogleRedeemCouponCodeParams } from "../../../providers/GoogleAnalytics/events/coupon/redeemCouponCode/redeemCouponCode.types";
+import { RedeemCouponCodeParams as FacebookRedeemCouponCodeParams } from "../../../providers/FacebookPixel/events/coupon/redeemCouponCode/redeemCouponCode.types";
+import { RedeemCouponCodeParams as SegmentRedeemCouponCodeParams } from "../../../providers/Segment/events/coupon/redeemCouponCode/redeemCouponCode.types";
+/**
+ * redeemCouponCode event interface
+ *
+ * @interface RedeemCouponCodeParams
+ * @since 0.5.14
+ * @extends GoogleRedeemCouponCodeParams
+ * @extends FacebookRedeemCouponCodeParams
+ * @property {string} code The code of the coupon
+ */
+export interface RedeemCouponCodeCommonParams {
+    code: string;
+}
+/**
+ * redeemCouponCode event params
+ *
+ * @interface RedeemCouponCodeParams
+ * @since 0.5.14
+ * @extends GoogleRedeemCouponCodeParams
+ * @extends FacebookRedeemCouponCodeParams
+ */
+export declare type RedeemCouponCodeParams = GoogleRedeemCouponCodeParams & FacebookRedeemCouponCodeParams & SegmentRedeemCouponCodeParams;

package/build/src/lib/events/coupon/removeBenefit/removeBenefit.d.ts

@@ -0,0 +1,11 @@
+import { RemoveBenefitParams } from "./removeBenefit.types";
+/**
+ * Emits a removeBenefit event to every configured provider.
+ *
+ * Log this event when users remove coupon from their order.
+ *
+ * @since 0.5.14
+ * @property {RemoveBenefitParams} params RemoveBenefit event parameters
+ */
+declare const logRemoveBenefit: (params: RemoveBenefitParams) => void;
+export default logRemoveBenefit;

package/build/src/lib/events/coupon/removeBenefit/removeBenefit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/removeBenefit/removeBenefit.types.d.ts

@@ -0,0 +1,24 @@
+import { RemoveBenefitParams as GoogleRemoveBenefitParams } from "../../../providers/GoogleAnalytics/events/coupon/removeBenefit/removeBenefit.types";
+import { RemoveBenefitParams as FacebookRemoveBenefitParams } from "../../../providers/FacebookPixel/events/coupon/removeBenefit/removeBenefit.types";
+import { RemoveBenefitParams as SegmentRemoveBenefitParams } from "../../../providers/Segment/events/coupon/removeBenefit/removeBenefit.types";
+/**
+ * removeBenefit event interface
+ *
+ * @interface RemoveBenefitCommonParams
+ * @since 0.5.14
+ * @property {string} benefitId The benefit identifier
+ * @property {string} benefitName The name of benefit
+ * @property {string} discount The value of the discount (e.g 10%, FREE-SHIPPING)
+ */
+export interface RemoveBenefitCommonParams {
+    benefitId: string;
+    benefitName: string;
+    discount: string;
+}
+/**
+ * removeBenefit event params.
+ *
+ * @typedef RemoveBenefitParams
+ * @since 0.5.14
+ */
+export declare type RemoveBenefitParams = GoogleRemoveBenefitParams & FacebookRemoveBenefitParams & SegmentRemoveBenefitParams;

package/build/src/lib/events/coupon/viewBenefitDetails/viewBenefitDetails.d.ts

@@ -0,0 +1,11 @@
+import { ViewBenefitDetailsParams } from "./viewBenefitDetails.types";
+/**
+ * Emits a viewBenefitDetails event to every configured provider.
+ *
+ * Log this event when users see the benefits of a coupon.
+ *
+ * @since 0.5.14
+ * @property {ViewBenefitDetailsParams} params ViewBenefitDetails event parameters
+ */
+declare const logViewBenefitDetails: (params: ViewBenefitDetailsParams) => void;
+export default logViewBenefitDetails;

package/build/src/lib/events/coupon/viewBenefitDetails/viewBenefitDetails.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/viewBenefitDetails/viewBenefitDetails.types.d.ts

@@ -0,0 +1,24 @@
+import { ViewBenefitDetailsParams as GoogleViewBenefitDetailsParams } from "../../../providers/GoogleAnalytics/events/coupon/viewBenefitDetails/viewBenefitDetails.types";
+import { ViewBenefitDetailsParams as FacebookViewBenefitDetailsParams } from "../../../providers/FacebookPixel/events/coupon/viewBenefitDetails/viewBenefitDetails.types";
+import { ViewBenefitDetailsParams as SegmentViewBenefitDetailsParams } from "../../../providers/Segment/events/coupon/viewBenefitDetails/viewBenefitDetails.types";
+/**
+ * viewBenefitDetails event interface
+ *
+ * @interface ViewBenefitDetailsCommonParams
+ * @since 0.5.14
+ * @property {string} benefitId The benefit identifier
+ * @property {string} benefitName The name of benefit
+ * @property {string} discount The value of the discount (e.g 10%, FREE-SHIPPING)
+ */
+export interface ViewBenefitDetailsCommonParams {
+    benefitId: string;
+    benefitName: string;
+    discount: string;
+}
+/**
+ * viewBenefitDetails event params.
+ *
+ * @typedef ViewBenefitDetailsParams
+ * @since 0.5.14
+ */
+export declare type ViewBenefitDetailsParams = GoogleViewBenefitDetailsParams & FacebookViewBenefitDetailsParams & SegmentViewBenefitDetailsParams;

package/build/src/lib/events/coupon/viewBenefitsWallet/viewBenefitsWallet.d.ts

@@ -0,0 +1,11 @@
+import { ViewBenefitsWalletParams } from "./viewBenefitsWallet.types";
+/**
+ * Emits a viewBenefitsWallet event to every configured provider.
+ *
+ * Log this event when users see their available coupons in the wallet.
+ *
+ * @since 0.5.14
+ * @property {ViewBenefitsWalletParams} params ViewBenefitsWallet event parameters
+ */
+declare const logViewBenefitsWallet: (params: ViewBenefitsWalletParams) => void;
+export default logViewBenefitsWallet;

package/build/src/lib/events/coupon/viewBenefitsWallet/viewBenefitsWallet.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/viewBenefitsWallet/viewBenefitsWallet.types.d.ts

@@ -0,0 +1,20 @@
+import { ViewBenefitsWalletParams as GoogleViewBenefitsWalletParams } from "../../../providers/GoogleAnalytics/events/coupon/viewBenefitsWallet/viewBenefitsWallet.types";
+import { ViewBenefitsWalletParams as FacebookViewBenefitsWalletParams } from "../../../providers/FacebookPixel/events/coupon/viewBenefitsWallet/viewBenefitsWallet.types";
+import { ViewBenefitsWalletParams as SegmentViewBenefitsWalletParams } from "../../../providers/Segment/events/coupon/viewBenefitsWallet/viewBenefitsWallet.types";
+/**
+ * viewBenefitsWallet event interface
+ *
+ * @interface ViewBenefitsWalletCommonParams
+ * @since 0.5.14
+ * @property {string} walletId The benefits wallet identifier
+ */
+export interface ViewBenefitsWalletCommonParams {
+    walletId: string;
+}
+/**
+ * viewBenefitsWallet event params.
+ *
+ * @typedef ViewBenefitsWalletParams
+ * @since 0.5.14
+ */
+export declare type ViewBenefitsWalletParams = GoogleViewBenefitsWalletParams & FacebookViewBenefitsWalletParams & SegmentViewBenefitsWalletParams;

package/build/src/lib/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.d.ts

@@ -0,0 +1,12 @@
+import { ViewQRStoreCouponParams } from "./viewQRStoreCoupon.types";
+/**
+ * Emits a viewQrStoreCoupon event to every configured provider.
+ *
+ * Log this event when users view the details of a store coupon that has a QR
+ * code.
+ *
+ * @since 0.5.14
+ * @property {ViewQrStoreCouponParams} params ViewQrStoreCoupon event parameters
+ */
+declare const logViewQRStoreCoupon: (params?: ViewQRStoreCouponParams) => void;
+export default logViewQRStoreCoupon;

package/build/src/lib/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.types.d.ts

@@ -0,0 +1,18 @@
+import { ViewQRStoreCouponParams as GoogleViewQRStoreCouponParams } from "../../../providers/GoogleAnalytics/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.types";
+import { ViewQRStoreCouponParams as FacebookViewQRStoreCouponParams } from "../../../providers/FacebookPixel/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.types";
+import { ViewQRStoreCouponParams as SegmentViewQRStoreCouponParams } from "../../../providers/Segment/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.types";
+/**
+ * viewQRStoreCoupon event interface
+ *
+ * @interface ViewQRStoreCouponCommonParams
+ * @since 0.5.14
+ */
+export interface ViewQRStoreCouponCommonParams {
+}
+/**
+ * viewQRStoreCoupon event params.
+ *
+ * @typedef ViewQRStoreCouponParams
+ * @since 0.5.14
+ */
+export declare type ViewQRStoreCouponParams = GoogleViewQRStoreCouponParams & FacebookViewQRStoreCouponParams & SegmentViewQRStoreCouponParams;

package/build/src/lib/events/credit/addCredits/addCredits.d.ts

@@ -0,0 +1,11 @@
+import { AddCreditsParams } from "./addCredits.types";
+/**
+ * Emits a addCredits event to every configured provider.
+ *
+ * Log this event when users add credits to their accounts.
+ *
+ * @since 0.5.14
+ * @property {AddCreditsParams} params AddCredits event parameters
+ */
+declare const logAddCredits: (params: AddCreditsParams) => void;
+export default logAddCredits;

package/build/src/lib/events/credit/addCredits/addCredits.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/credit/addCredits/addCredits.types.d.ts

@@ -0,0 +1,20 @@
+import { AddCreditsParams as GoogleAddCreditsParams } from "../../../providers/GoogleAnalytics/events/credit/addCredits/addCredits.types";
+import { AddCreditsParams as FacebookAddCreditsParams } from "../../../providers/FacebookPixel/events/credit/addCredits/addCredits.types";
+import { AddCreditsParams as SegmentAddCreditsParams } from "../../../providers/Segment/events/credit/addCredits/addCredits.types";
+/**
+ * addCredits event interface
+ *
+ * @interface AddCreditsCommonParams
+ * @since 0.5.14
+ * @property {number} amount The amount of credits to add
+ */
+export interface AddCreditsCommonParams {
+    amount: number;
+}
+/**
+ * addCredits event params.
+ *
+ * @typedef AddCreditsParams
+ * @since 0.5.14
+ */
+export declare type AddCreditsParams = GoogleAddCreditsParams & FacebookAddCreditsParams & SegmentAddCreditsParams;

package/build/src/lib/events/credit/index.d.ts

@@ -0,0 +1,6 @@
+declare const events: {
+    logAddCredits: (params: import("./addCredits/addCredits.types").AddCreditsParams) => void;
+    logSpendCredits: (params: import("./spendCredits/spendCredits.types").SpendCreditsParams) => void;
+    logViewCredits: (params: import("./viewCredits/viewCredits.types").ViewCreditsParams) => void;
+};
+export default events;

package/build/src/lib/events/credit/index.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/credit/spendCredits/spendCredits.d.ts

@@ -0,0 +1,11 @@
+import { SpendCreditsParams } from "./spendCredits.types";
+/**
+ * Emits a spendCredits event to every configured provider.
+ *
+ * Log this event when users spend their credits.
+ *
+ * @since 0.5.14
+ * @property {SpendCreditsParams} params SpendCredits event parameters
+ */
+declare const logSpendCredits: (params: SpendCreditsParams) => void;
+export default logSpendCredits;

package/build/src/lib/events/credit/spendCredits/spendCredits.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/src/lib/events/credit/spendCredits/spendCredits.types.d.ts

@@ -0,0 +1,20 @@
+import { SpendCreditsParams as GoogleSpendCreditsParams } from "../../../providers/GoogleAnalytics/events/credit/spendCredits/spendCredits.types";
+import { SpendCreditsParams as FacebookSpendCreditsParams } from "../../../providers/FacebookPixel/events/credit/spendCredits/spendCredits.types";
+import { SpendCreditsParams as SegmentSpendCreditsParams } from "../../../providers/Segment/events/credit/spendCredits/spendCredits.types";
+/**
+ * spendCredits event interface
+ *
+ * @interface SpendCreditsCommonParams
+ * @since 0.5.14
+ * @property {number} amount The amount of credits spent
+ */
+export interface SpendCreditsCommonParams {
+    amount: number;
+}
+/**
+ * spendCredits event params.
+ *
+ * @typedef SpendCreditsParams
+ * @since 0.5.14
+ */
+export declare type SpendCreditsParams = GoogleSpendCreditsParams & FacebookSpendCreditsParams & SegmentSpendCreditsParams;

package/build/src/lib/events/credit/viewCredits/viewCredits.d.ts

@@ -0,0 +1,11 @@
+import { ViewCreditsParams } from "./viewCredits.types";
+/**
+ * Emits a viewCredits event to every configured provider.
+ *
+ * Log this event when users see how much credits they have.
+ *
+ * @since 0.5.14
+ * @property {ViewCreditsParams} params ViewCredits event parameters
+ */
+declare const logViewCredits: (params: ViewCreditsParams) => void;
+export default logViewCredits;

package/build/src/lib/events/credit/viewCredits/viewCredits.test.d.ts

@@ -0,0 +1 @@
+export {};