@artisan-commerce/analytics-web 0.1.0-canary.3 → 0.1.0-canary.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/build/main.bundle.js +1 -1
  3. package/build/report.json +1 -1
  4. package/build/src/lib/events/auth/changePasswordAttempt/changePasswordAttempt.d.ts +1 -1
  5. package/build/src/lib/events/banner/bannerImpression/bannerImpression.d.ts +1 -1
  6. package/build/src/lib/events/banner/bannerImpression/bannerImpression.types.d.ts +1 -1
  7. package/build/src/lib/events/banner/selectBanner/selectBanner.d.ts +1 -1
  8. package/build/src/lib/events/banner/selectBanner/selectBanner.types.d.ts +4 -4
  9. package/build/src/lib/events/billing/addBillingInfo/addBillingInfo.d.ts +1 -1
  10. package/build/src/lib/events/billing/addBillingInfo/addBillingInfo.types.d.ts +1 -1
  11. package/build/src/lib/events/billing/selectBillingInfo/selectBillingInfo.d.ts +1 -1
  12. package/build/src/lib/events/billing/selectBillingInfo/selectBillingInfo.types.d.ts +2 -2
  13. package/build/src/lib/events/billing/updateBillingInfo/updateBillingInfo.d.ts +1 -1
  14. package/build/src/lib/events/billing/updateBillingInfo/updateBillingInfo.types.d.ts +2 -2
  15. package/build/src/lib/events/booking/bookAppointment/bookAppointment.d.ts +1 -1
  16. package/build/src/lib/events/category/searchCategoryAttempt/searchCategoryAttempt.d.ts +1 -1
  17. package/build/src/lib/events/category/selectCategory/selectCategory.d.ts +1 -1
  18. package/build/src/lib/events/checkout/checkoutAction/checkoutAction.d.ts +1 -1
  19. package/build/src/lib/events/checkout/checkoutAction/checkoutAction.types.d.ts +1 -1
  20. package/build/src/lib/events/checkout/initiateCheckout/initiateCheckout.d.ts +1 -1
  21. package/build/src/lib/events/coupon/applyBenefit/applyBenefit.d.ts +1 -1
  22. package/build/src/lib/events/coupon/couponCodeError/couponCodeError.d.ts +1 -1
  23. package/build/src/lib/events/coupon/redeemCouponCode/redeemCouponCode.d.ts +1 -1
  24. package/build/src/lib/events/coupon/removeBenefit/removeBenefit.d.ts +1 -1
  25. package/build/src/lib/events/coupon/viewBenefitDetails/viewBenefitDetails.d.ts +1 -1
  26. package/build/src/lib/events/coupon/viewBenefitsWallet/viewBenefitsWallet.d.ts +1 -1
  27. package/build/src/lib/events/coupon/viewQRStoreCoupon/viewQRStoreCoupon.d.ts +2 -1
  28. package/build/src/lib/events/credit/addCredits/addCredits.d.ts +1 -1
  29. package/build/src/lib/events/credit/spendCredits/spendCredits.d.ts +1 -1
  30. package/build/src/lib/events/credit/viewCredits/viewCredits.d.ts +1 -1
  31. package/build/src/lib/events/customEvent/customEvent.d.ts +1 -1
  32. package/build/src/lib/events/events.d.ts +1 -1
  33. package/build/src/lib/events/events.types.d.ts +1 -1
  34. package/build/src/lib/events/fulfillment/viewFulfillmentStep/viewFulfillmentStep.d.ts +1 -1
  35. package/build/src/lib/events/fulfillment/viewTracking/viewTracking.d.ts +1 -1
  36. package/build/src/lib/events/fulfillment/viewTracking/viewTracking.types.d.ts +1 -1
  37. package/build/src/lib/events/geo/changeLocation/changeLocation.d.ts +1 -1
  38. package/build/src/lib/events/geo/findLocation/findLocation.d.ts +1 -1
  39. package/build/src/lib/events/geo/outOfCoverage/outOfCoverage.d.ts +1 -1
  40. package/build/src/lib/events/geo/setLocation/setLocation.d.ts +1 -1
  41. package/build/src/lib/events/help/requestAssistance/requestAssistance.d.ts +2 -1
  42. package/build/src/lib/events/loyalty/earnPoints/earnPoints.d.ts +1 -1
  43. package/build/src/lib/events/loyalty/sharePoints/sharePoints.d.ts +1 -1
  44. package/build/src/lib/events/loyalty/spendPoints/spendPoints.d.ts +1 -1
  45. package/build/src/lib/events/loyalty/viewLoyaltyLevel/viewLoyaltyLevel.d.ts +1 -1
  46. package/build/src/lib/events/order/cancelOrder/cancelOrder.d.ts +1 -1
  47. package/build/src/lib/events/order/rateOrder/rateOrder.d.ts +1 -1
  48. package/build/src/lib/events/order/requestRefund/requestRefund.d.ts +1 -1
  49. package/build/src/lib/events/order/requestRefund/requestRefund.types.d.ts +1 -0
  50. package/build/src/lib/events/other/generateLead/generateLead.d.ts +1 -1
  51. package/build/src/lib/events/other/pageView/pageView.d.ts +2 -1
  52. package/build/src/lib/events/other/pageView/pageView.types.d.ts +2 -2
  53. package/build/src/lib/events/other/searchPageContent/searchPageContent.d.ts +1 -1
  54. package/build/src/lib/events/other/searchPageContent/searchPageContent.types.d.ts +1 -1
  55. package/build/src/lib/events/payment/changePaymentType/changePaymentType.d.ts +1 -1
  56. package/build/src/lib/events/payment/changePaymentType/changePaymentType.types.d.ts +6 -2
  57. package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.d.ts +1 -1
  58. package/build/src/lib/events/payment/selectPaymentType/selectPaymentType.types.d.ts +2 -2
  59. package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.d.ts +1 -1
  60. package/build/src/lib/events/payment/setPaymentInfo/setPaymentInfo.types.d.ts +3 -3
  61. package/build/src/lib/events/product/customizeProduct/customizeProduct.d.ts +1 -1
  62. package/build/src/lib/events/product/filterProducts/filterProducts.d.ts +1 -1
  63. package/build/src/lib/events/product/searchProductAttempt/searchProductAttempt.d.ts +1 -1
  64. package/build/src/lib/events/product/selectProduct/selectProduct.d.ts +1 -1
  65. package/build/src/lib/events/product/sortProducts/sortProducts.d.ts +1 -1
  66. package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.d.ts +1 -1
  67. package/build/src/lib/events/purchase/purchaseAttempt/purchaseAttempt.types.d.ts +1 -1
  68. package/build/src/lib/events/purchase/purchaseFail/purchaseFail.d.ts +1 -1
  69. package/build/src/lib/events/purchase/purchaseSuccess/purchaseSuccess.d.ts +1 -1
  70. package/build/src/lib/events/settings/viewSettings/viewSettings.d.ts +1 -1
  71. package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.d.ts +1 -1
  72. package/build/src/lib/events/shipping/addShippingAddress/addShippingAddress.types.d.ts +1 -1
  73. package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.d.ts +1 -1
  74. package/build/src/lib/events/shipping/selectShippingAddress/selectShippingAddress.types.d.ts +1 -1
  75. package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.d.ts +1 -1
  76. package/build/src/lib/events/shipping/updateShippingAddress/updateShippingAddress.types.d.ts +1 -1
  77. package/build/src/lib/events/shoppingCart/addProductToCart/addProductToCart.d.ts +1 -1
  78. package/build/src/lib/events/shoppingCart/addProductToWishlist/addProductToWishlist.d.ts +1 -1
  79. package/build/src/lib/events/shoppingCart/removeProductFromCart/removeProductFromCart.d.ts +1 -1
  80. package/build/src/lib/events/shoppingCart/removeProductFromWishlist/removeProductFromWishlist.d.ts +1 -1
  81. package/build/src/lib/events/shoppingCart/updateProductInCart/updateProductInCart.d.ts +1 -1
  82. package/build/src/lib/events/shoppingCart/updateProductInWishlist/updateProductInWishlist.d.ts +1 -1
  83. package/build/src/lib/events/shoppingCart/viewCart/viewCart.d.ts +1 -1
  84. package/build/src/lib/events/social/share/share.d.ts +1 -1
  85. package/build/src/lib/events/social/share/share.types.d.ts +3 -3
  86. package/build/src/lib/events/store/setStore/setStore.d.ts +1 -1
  87. package/build/src/lib/events/user/setUserInfo/setUserInfo.d.ts +1 -1
  88. package/build/src/lib/events/user/updateUserInfo/updateUserInfo.d.ts +1 -1
  89. package/build/src/lib/events/vendor/setVendor/setVendor.d.ts +1 -1
  90. package/build/src/lib/events/workflow/selectWorkflow/selectWorkflow.d.ts +1 -1
  91. package/build/src/lib/providers/FacebookPixel/events/order/rateOrder/rateOrder.types.d.ts +1 -0
  92. package/package.json +2 -2
@@ -2,7 +2,7 @@ import { ChangePasswordAttemptParams } from "./changePasswordAttempt.types";
2
2
  /**
3
3
  * Emits a changePasswordAttempt event to every configured provider.
4
4
  *
5
- * Log this event when the users show an intention to change their password.
5
+ * Log this event when users show an intention to change their password.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @param {ChangePasswordAttemptParams} params ChangePasswordAttempt event parameters
@@ -2,7 +2,7 @@ import { BannerImpressionParams } from "./bannerImpression.types";
2
2
  /**
3
3
  * Emits a bannerImpression event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when a banner is visible on the screen.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {BannerImpressionParams} params BannerImpression event parameters
@@ -5,7 +5,7 @@ import { BannerImpressionParams as FacebookBannerImpressionParams } from "../../
5
5
  *
6
6
  * @interface BannerImpressionCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} url The url of a banner a user had an impression on
8
+ * @property {string} url The URL of a banner a user had an impression on
9
9
  * @property {string} name The name of a banner a user had an impression on
10
10
  * @property {string} list The name of the list where the banner is
11
11
  * @property {number} position The position in a list where the banner is
@@ -2,7 +2,7 @@ import { SelectBannerParams } from "./selectBanner.types";
2
2
  /**
3
3
  * Emits a selectBanner event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users select a banner.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SelectBannerParams} params SelectBanner event parameters
@@ -5,10 +5,10 @@ import { SelectBannerParams as FacebookSelectBannerParams } from "../../../provi
5
5
  *
6
6
  * @interface SelectBannerCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} url The url of a banner a user had an impression on
9
- * @property {string} name The name of a banner a user had an impression on
10
- * @property {string} list the name of the list where the product is
11
- * @property {number} position the position in a list where the product is
8
+ * @property {string} url The url of the selected banner
9
+ * @property {string} name The name of the selected banner
10
+ * @property {string} list the name of the list where the banner is
11
+ * @property {number} position the position in a list where the banner is
12
12
  */
13
13
  export interface SelectBannerCommonParams {
14
14
  url: string;
@@ -2,7 +2,7 @@ import { AddBillingInfoParams } from "./addBillingInfo.types";
2
2
  /**
3
3
  * Emits a addBillingInfo event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users add their billing information.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {AddBillingInfoParams} params AddBillingInfo event parameters
@@ -5,7 +5,7 @@ import { AddBillingInfoParams as FacebookAddBillingInfoParams } from "../../../p
5
5
  *
6
6
  * @interface AddBillingInfoCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} alias The name of the new billing info data
8
+ * @property {string} alias The name of the new billing information data
9
9
  */
10
10
  export interface AddBillingInfoCommonParams {
11
11
  alias?: string;
@@ -2,7 +2,7 @@ import { SelectBillingInfoParams } from "./selectBillingInfo.types";
2
2
  /**
3
3
  * Emits a selectBillingInfo event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users select a billing information.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SelectBillingInfoParams} params SelectBillingInfo event parameters
@@ -5,8 +5,8 @@ import { SelectBillingInfoParams as FacebookSelectBillingInfoParams } from "../.
5
5
  *
6
6
  * @interface SelectBillingInfoCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} alias The name of the new billing info data
9
- * @property {number} position the position in a list where the product is
8
+ * @property {string} alias The name of the new billing information data
9
+ * @property {number} position The position in a list where the billing information data is
10
10
  */
11
11
  export interface SelectBillingInfoCommonParams {
12
12
  alias?: string;
@@ -2,7 +2,7 @@ import { UpdateBillingInfoParams } from "./updateBillingInfo.types";
2
2
  /**
3
3
  * Emits a updateBillingInfo event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users update their billing information.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {UpdateBillingInfoParams} params UpdateBillingInfo event parameters
@@ -5,8 +5,8 @@ import { UpdateBillingInfoParams as FacebookUpdateBillingInfoParams } from "../.
5
5
  *
6
6
  * @interface UpdateBillingInfoCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} alias The name of the new billing info data
9
- * @property {number} position the position in a list where the product is
8
+ * @property {string} alias The name of the new billing information data
9
+ * @property {number} position The position in a list where the billing information data is
10
10
  * @property {string[]} fields The updated fields names
11
11
  */
12
12
  export interface UpdateBillingInfoCommonParams {
@@ -2,7 +2,7 @@ import { BookAppointmentParams } from "./bookAppointment.types";
2
2
  /**
3
3
  * Emits a bookAppointment event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event after users successfully book an appointment.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {BookAppointmentParams} params BookAppointment event parameters
@@ -2,7 +2,7 @@ import { SearchCategoryAttemptParams } from "./searchCategoryAttempt.types";
2
2
  /**
3
3
  * Emits a SearchCategoryAttempt event to every configured provider.
4
4
  *
5
- * Log this event when the users try to search an specific category.
5
+ * Log this event when users try to search an specific category.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SearchCategoryAttemptParams} params SearchCategoryAttempt event parameters
@@ -2,7 +2,7 @@ import { SelectCategoryParams } from "./selectCategory.types";
2
2
  /**
3
3
  * Emits a selectCategory event to every configured provider.
4
4
  *
5
- * Log this event when the users select a category. This category may or may not
5
+ * Log this event when users select a category. This category may or may not
6
6
  * be on a list.
7
7
  *
8
8
  * @since 0.5.14
@@ -2,7 +2,7 @@ import { CheckoutActionParams } from "./checkoutAction.types";
2
2
  /**
3
3
  * Emits a checkoutAction event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users complete a step in the checkout progress.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {CheckoutActionParams} params CheckoutAction event parameters
@@ -6,7 +6,7 @@ import { CheckoutActionParams as FacebookCheckoutActionParams } from "../../../p
6
6
  * @interface CheckoutActionCommonParams
7
7
  * @since 0.5.14
8
8
  * @property {string} action The name of the checkout step (e.g "billing")
9
- * @property {string} progress The completness of the checkout progress (e.g "1/3")
9
+ * @property {string} progress The completeness of the checkout progress (e.g "1/3")
10
10
  */
11
11
  export interface CheckoutActionCommonParams {
12
12
  action: string;
@@ -2,7 +2,7 @@ import { InitiateCheckoutParams } from "./initiateCheckout.types";
2
2
  /**
3
3
  * Emits a initiateCheckout event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event at the start of a checkout process.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {InitiateCheckoutParams} params InitiateCheckout event parameters
@@ -2,7 +2,7 @@ import { ApplyBenefitParams } from "./applyBenefit.types";
2
2
  /**
3
3
  * Emits a applyBenefit event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users apply a coupon on their order.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ApplyBenefitParams} params ApplyBenefit event parameters
@@ -2,7 +2,7 @@ import { CouponCodeErrorParams } from "./couponCodeError.types";
2
2
  /**
3
3
  * Emits a couponCodeError event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when your redeem coupon request has failed.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {CouponCodeErrorParams} params CouponCodeError event parameters
@@ -2,7 +2,7 @@ import { RedeemCouponCodeParams } from "./redeemCouponCode.types";
2
2
  /**
3
3
  * Emits a redeemCouponCode event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users successfully redeem a coupon.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {RedeemCouponCodeParams} params RedeemCouponCode event parameters
@@ -2,7 +2,7 @@ import { RemoveBenefitParams } from "./removeBenefit.types";
2
2
  /**
3
3
  * Emits a removeBenefit event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users remove coupon from their order.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {RemoveBenefitParams} params RemoveBenefit event parameters
@@ -2,7 +2,7 @@ import { ViewBenefitDetailsParams } from "./viewBenefitDetails.types";
2
2
  /**
3
3
  * Emits a viewBenefitDetails event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users see the benefits of a coupon.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewBenefitDetailsParams} params ViewBenefitDetails event parameters
@@ -2,7 +2,7 @@ import { ViewBenefitsWalletParams } from "./viewBenefitsWallet.types";
2
2
  /**
3
3
  * Emits a viewBenefitsWallet event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users see their available coupons in the wallet.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewBenefitsWalletParams} params ViewBenefitsWallet event parameters
@@ -2,7 +2,8 @@ import { ViewQRStoreCouponParams } from "./viewQRStoreCoupon.types";
2
2
  /**
3
3
  * Emits a viewQrStoreCoupon event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users view the details of a store coupon that has a QR
6
+ * code.
6
7
  *
7
8
  * @since 0.5.14
8
9
  * @property {ViewQrStoreCouponParams} params ViewQrStoreCoupon event parameters
@@ -2,7 +2,7 @@ import { AddCreditsParams } from "./addCredits.types";
2
2
  /**
3
3
  * Emits a addCredits event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users add credits to their accounts.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {AddCreditsParams} params AddCredits event parameters
@@ -2,7 +2,7 @@ import { SpendCreditsParams } from "./spendCredits.types";
2
2
  /**
3
3
  * Emits a spendCredits event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users spend their credits.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SpendCreditsParams} params SpendCredits event parameters
@@ -2,7 +2,7 @@ import { ViewCreditsParams } from "./viewCredits.types";
2
2
  /**
3
3
  * Emits a viewCredits event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users see how much credits they have.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewCreditsParams} params ViewCredits event parameters
@@ -8,5 +8,5 @@ import { CustomEventParams } from "./customEvent.types";
8
8
  * @param {string} eventName The name of the custom event
9
9
  * @param {CustomEventParams} params CustomEvent event parameters
10
10
  */
11
- declare const logCustomEvent: (eventName: string, params: CustomEventParams) => void;
11
+ declare const logCustomEvent: (eventName: string, params?: CustomEventParams) => void;
12
12
  export default logCustomEvent;
@@ -57,7 +57,7 @@ declare const events: {
57
57
  help: {
58
58
  logRequestAssistance: (params: import("./help/requestAssistance/requestAssistance.types").RequestAssistanceParams) => void;
59
59
  };
60
- logCustomEvent: (eventName: string, params: import("./customEvent/customEvent.types").CustomEventParams) => void;
60
+ logCustomEvent: (eventName: string, params?: import("./customEvent/customEvent.types").CustomEventParams) => void;
61
61
  loyalty: {
62
62
  logEarnPoints: (params: import("./loyalty/earnPoints/earnPoints.types").EarnPointsParams) => void;
63
63
  logSharePoints: (params: import("./loyalty/sharePoints/sharePoints.types").SharePointsParams) => void;
@@ -21,4 +21,4 @@ export declare type Workflow = "Delivery" | "Pickup" | "Other";
21
21
  * @typedef PaymentType
22
22
  * @since 0.5.14
23
23
  */
24
- export declare type PaymentType = "Credit" | "Debit" | "Cash" | "Other";
24
+ export declare type PaymentType = "Credit" | "Debit" | "Cash" | "Dataphone" | "Other";
@@ -2,7 +2,7 @@ import { ViewFulfillmentStepParams } from "./viewFulfillmentStep.types";
2
2
  /**
3
3
  * Emits a viewFulfillmentStep event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users see what step the order is in.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewFulfillmentStepParams} params ViewFulfillmentStep event parameters
@@ -2,7 +2,7 @@ import { ViewTrackingParams } from "./viewTracking.types";
2
2
  /**
3
3
  * Emits a viewTracking event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users see where the delivery man is on the map.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewTrackingParams} params ViewTracking event parameters
@@ -5,7 +5,7 @@ import { ViewTrackingParams as FacebookViewTrackingParams } from "../../../provi
5
5
  *
6
6
  * @interface ViewTrackingCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} orderId The order unique identifer
8
+ * @property {string} orderId The order unique identifier
9
9
  */
10
10
  export interface ViewTrackingCommonParams {
11
11
  orderId: string;
@@ -2,7 +2,7 @@ import { ChangeLocationParams } from "./changeLocation.types";
2
2
  /**
3
3
  * Emits a changeLocation event to every configured provider.
4
4
  *
5
- * Log this event when the users change their location.
5
+ * Log this event when users change their location.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ChangeLocationParams} params ChangeLocation event parameters
@@ -2,7 +2,7 @@ import { FindLocationParams } from "./findLocation.types";
2
2
  /**
3
3
  * Emits a findLocation event to every configured provider.
4
4
  *
5
- * Log this event after the users have searched for a location.
5
+ * Log this event after users have searched for a location.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {FindLocationParams} params FindLocation event parameters
@@ -2,7 +2,7 @@ import { OutOfCoverageParams } from "./outOfCoverage.types";
2
2
  /**
3
3
  * Emits a outOfCoverage event to every configured provider.
4
4
  *
5
- * Log this event when the users are in a location out of coverage.
5
+ * Log this event when users are in a location out of coverage.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {OutOfCoverageParams} params OutOfCoverage event parameters
@@ -2,7 +2,7 @@ import { SetLocationParams } from "./setLocation.types";
2
2
  /**
3
3
  * Emits a setLocation event to every configured provider.
4
4
  *
5
- * Log this event when the users set their location.
5
+ * Log this event when users set their location.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SetLocationParams} params SetLocation event parameters
@@ -2,7 +2,8 @@ import { RequestAssistanceParams } from "./requestAssistance.types";
2
2
  /**
3
3
  * Emits a requestAssistance event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users try to contact the business by phone/SMS, email,
6
+ * chat, or other means.
6
7
  *
7
8
  * @since 0.5.14
8
9
  * @property {RequestAssistanceParams} params RequestAssistance event parameters
@@ -2,7 +2,7 @@ import { EarnPointsParams } from "./earnPoints.types";
2
2
  /**
3
3
  * Emits a earnPoints event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users earn points.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {EarnPointsParams} params EarnPoints event parameters
@@ -2,7 +2,7 @@ import { SharePointsParams } from "./sharePoints.types";
2
2
  /**
3
3
  * Emits a sharePoints event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users share their points.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SharePointsParams} params SharePoints event parameters
@@ -2,7 +2,7 @@ import { SpendPointsParams } from "./spendPoints.types";
2
2
  /**
3
3
  * Emits a spendPoints event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users spend their points.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SpendPointsParams} params SpendPoints event parameters
@@ -2,7 +2,7 @@ import { ViewLoyaltyLevelParams } from "./viewLoyaltyLevel.types";
2
2
  /**
3
3
  * Emits a viewLoyaltyLevel event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users view a loyalty level.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ViewLoyaltyLevelParams} params ViewLoyaltyLevel event parameters
@@ -2,7 +2,7 @@ import { CancelOrderParams } from "./cancelOrder.types";
2
2
  /**
3
3
  * Emits a cancelOrder event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users cancel an order.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {CancelOrderParams} params CancelOrder event parameters
@@ -2,7 +2,7 @@ import { RateOrderParams } from "./rateOrder.types";
2
2
  /**
3
3
  * Emits a rateOrder event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users rate an order.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {RateOrderParams} params RateOrder event parameters
@@ -2,7 +2,7 @@ import { RequestRefundParams } from "./requestRefund.types";
2
2
  /**
3
3
  * Emits a requestRefund event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users request a refund of the order.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {RequestRefundParams} params RequestRefund event parameters
@@ -6,6 +6,7 @@ import { RequestRefundParams as FacebookRequestRefundParams } from "../../../pro
6
6
  * @interface RequestRefundCommonParams
7
7
  * @since 0.5.14
8
8
  * @property {string} orderId The orders unique identifier
9
+ * @property {number} orderTotal The total cost of the order
9
10
  * @property {string} reason The reason by which the user is requesting a refund of the order
10
11
  */
11
12
  export interface RequestRefundCommonParams {
@@ -2,7 +2,7 @@ import { GenerateLeadParams } from "./generateLead.types";
2
2
  /**
3
3
  * Emits a generateLead event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users take an action that tells you they can be a lead.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {GenerateLeadParams} params GenerateLead event parameters
@@ -2,7 +2,8 @@ import { PageViewParams } from "./pageView.types";
2
2
  /**
3
3
  * Emits a pageView event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when you need to add custom page view that the default page
6
+ * view event does not log.
6
7
  *
7
8
  * @since 0.5.14
8
9
  * @param {PageViewParams} params PageView event parameters
@@ -5,8 +5,8 @@ import { PageViewParams as FacebookPageViewParams } from "../../../providers/Fac
5
5
  *
6
6
  * @interface PageViewCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} pathname The visited url path
9
- * @property {string} name The name of the visited path
8
+ * @property {string} pathname The name of the visited path, this value must start with a / character
9
+ * @property {string} name The title of the page
10
10
  */
11
11
  export interface PageViewCommonParams {
12
12
  pathname?: string;
@@ -2,7 +2,7 @@ import { SearchPageContentParams } from "./searchPageContent.types";
2
2
  /**
3
3
  * Emits a searchPageContent event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users search for any content in the application.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SearchPageContentParams} params SearchPageContent event parameters
@@ -5,7 +5,7 @@ import { SearchPageContentParams as FacebookSearchPageContentParams } from "../.
5
5
  *
6
6
  * @interface SearchPageContentCommonParams
7
7
  * @since 0.5.14
8
- * @property {string} query The searched query
8
+ * @property {string} query The searched text
9
9
  */
10
10
  export interface SearchPageContentCommonParams {
11
11
  query: string;
@@ -2,7 +2,7 @@ import { ChangePaymentTypeParams } from "./changePaymentType.types";
2
2
  /**
3
3
  * Emits a changePaymentType event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users change the payment type.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {ChangePaymentTypeParams} params ChangePaymentType event parameters
@@ -7,12 +7,16 @@ import { PaymentType } from "../../events.types";
7
7
  * @interface ChangePaymentTypeCommonParams
8
8
  * @since 0.5.14
9
9
  * @property {PaymentType} previousPaymentType The previously set payment type
10
- * @property {PaymentType} nextPayamentType The new set payment type
10
+ * @property {string} previousCardType If was paying with card, the previously set card provider (e.g. visa)
11
+ * @property {PaymentType} nextPaymentType The new set payment type
12
+ * @property {string} nextCardType If paying with card, the new card provider
11
13
  * @property {number} orderTotal The total cost of the order
12
14
  */
13
15
  export interface ChangePaymentTypeCommonParams {
14
16
  previousPaymentType: PaymentType;
15
- nextPayamentType: PaymentType;
17
+ previousCardType?: string;
18
+ nextPaymentType: PaymentType;
19
+ nextCardType?: string;
16
20
  orderTotal: number;
17
21
  }
18
22
  /**
@@ -2,7 +2,7 @@ import { SelectPaymentTypeParams } from "./selectPaymentType.types";
2
2
  /**
3
3
  * Emits a selectPaymentType event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users select the payment type.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SelectPaymentTypeParams} params SelectPaymentType event parameters
@@ -6,11 +6,11 @@ import { PaymentType } from "../../events.types";
6
6
  *
7
7
  * @interface SelectPaymentTypeCommonParams
8
8
  * @since 0.5.14
9
- * @property {PaymentType} payamentType The new set payment type (e.g. Cash)
9
+ * @property {PaymentType} paymentType The new set payment type (e.g. Cash)
10
10
  * @property {number} orderTotal The total cost of the order
11
11
  */
12
12
  export interface SelectPaymentTypeCommonParams {
13
- payamentType: PaymentType;
13
+ paymentType: PaymentType;
14
14
  orderTotal: number;
15
15
  }
16
16
  /**
@@ -2,7 +2,7 @@ import { SetPaymentInfoParams } from "./setPaymentInfo.types";
2
2
  /**
3
3
  * Emits a setPaymentInfo event to every configured provider.
4
4
  *
5
- * Log this event when
5
+ * Log this event when users set the payment type for the first time.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {SetPaymentInfoParams} params SetPaymentInfo event parameters
@@ -7,12 +7,12 @@ import { PaymentType } from "../../events.types";
7
7
  * @interface SetPaymentInfoCommonParams
8
8
  * @since 0.5.14
9
9
  * @property {number} orderTotal The total cost of the order
10
- * @property {PaymentType} payamentType The new set payment type (e.g. Cash)
11
- * @property {string} cardType If paying with card the card provider (e.g. visa)
10
+ * @property {PaymentType} paymentType The new set payment type (e.g. Cash)
11
+ * @property {string} cardType If paying with card, the card provider (e.g. visa)
12
12
  */
13
13
  export interface SetPaymentInfoCommonParams {
14
14
  orderTotal: number;
15
- payamentType: PaymentType;
15
+ paymentType: PaymentType;
16
16
  cardType?: string;
17
17
  }
18
18
  /**
@@ -2,7 +2,7 @@ import { CustomizeProductParams } from "./customizeProduct.types";
2
2
  /**
3
3
  * Emits a customizeProduct event to every configured provider.
4
4
  *
5
- * Log this event when the users add extras to the base offered product.
5
+ * Log this event when users add extras to the base offered product.
6
6
  *
7
7
  * @since 0.5.14
8
8
  * @property {CustomizeProductParams} params CustomizeProduct event parameters