@artsy/cohesion 4.59.0 → 4.60.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.60.0 (Tue Aug 09 2022)
+
+#### 🚀  Enhancement
+
+- [AS-3324] Adding event for balance account check [#345](https://github.com/artsy/cohesion/pull/345) ([@daytavares](https://github.com/daytavares))
+
+#### Authors: 1
+
+- Dayane Tavares ([@daytavares](https://github.com/daytavares))
+
+---
+
 # v4.59.0 (Thu Jul 28 2022)
 
 #### 🚀  Enhancement

package/dist/Schema/Events/Click.d.ts

@@ -781,6 +781,39 @@ export interface ClickedPaymentDetails {
     order_id: string;
     subject: string;
 }
+/**
+ * After choosing Bank Transfer, when user clicks on save & continue
+ * on the payment page, the balance account is checked
+ *
+ *  This schema describes events sent
+ * to Segment from [[clickedBalanceAccountCheck]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "checkedAccountBalance",
+ *    flow: "Make Offer",
+ *    context_page_owner_type: "orders-payment",
+ *    order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11"
+ *    amount: 2000,
+ *    currency: "USD"
+ *    payment_method: "bank transfer"
+ *    subject: "balance account check"
+ *    outcome: "sucess"
+ *  }
+ * ```
+ */
+export interface CheckedAccountBalance {
+    action: ActionType.checkedAccountBalance;
+    flow: string;
+    context_page_owner_type: string;
+    order_id: string;
+    amount: number;
+    currency: string;
+    payment_method: string;
+    subject: string;
+    outcome: string;
+}
 /**
  *  User selects existing shipping address when entering the orders
  *  checkout flow.

package/dist/Schema/Events/index.d.ts

@@ -1,7 +1,7 @@
 import { AddToCalendar } from "./AddToCalendar";
 import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
 import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
-import { ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
+import { ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, CheckedAccountBalance, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
 import { ArtworkDetailsCompleted, ConsignmentSubmitted, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
 import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
 import { ExperimentViewed } from "./ExperimentViewed";
@@ -22,7 +22,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
  *
  * Each event describes one ActionType
  */
-export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
+export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedCreateAlert | TappedExploreGroup | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedPartnerCard | TappedPromoSpace | TappedRequestPriceEstimate | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection;
 /**
  * The top-level actions an Event describes.
  *
@@ -217,6 +217,10 @@ export declare enum ActionType {
     /**
      * Corresponds to {@link ClickedPaymentDetails}
      */
+    checkedAccountBalance = "checkedAccountBalance",
+    /**
+     * Corresponds to {@link CheckedAccountBalance}
+     */
     clickedPromoSpace = "clickedPromoSpace",
     /**
      * Corresponds to {@link ClickedRegisterToBid}

package/dist/Schema/Events/index.js

@@ -66,6 +66,7 @@ exports.ActionType = ActionType;
   ActionType["clickedPlayVideo"] = "clickedPlayVideo";
   ActionType["clickedPaymentMethod"] = "clickedPaymentMethod";
   ActionType["clickedPaymentDetails"] = "clickedPaymentDetails";
+  ActionType["checkedAccountBalance"] = "checkedAccountBalance";
   ActionType["clickedPromoSpace"] = "clickedPromoSpace";
   ActionType["clickedRegisterToBid"] = "clickedRegisterToBid";
   ActionType["clickedSelectShippingOption"] = "clickedSelectShippingOption";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.59.0",
+  "version": "4.60.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {