@artsy/cohesion 4.43.0 → 4.44.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.44.0 (Mon Apr 25 2022)
+
+#### 🚀  Enhancement
+
+- [TX-227] Creating events for the payment checkout flow [#322](https://github.com/artsy/cohesion/pull/322) ([@daytavares](https://github.com/daytavares))
+
+#### Authors: 1
+
+- Dayane Tavares ([@daytavares](https://github.com/daytavares))
+
+---
+
 # v4.43.0 (Tue Mar 29 2022)
 
 #### 🚀  Enhancement

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

@@ -661,6 +661,58 @@ export interface ClickedPartnerCard {
     destination_page_owner_slug: string;
     type: "thumbnail";
 }
+/**
+ *  User clicks in one of the payment options on the payment pageview
+ *
+ *  This schema describes events sent to Segment from [[clickedPaymentMethod]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedPaymentMethod",
+ *    flow: "Make Offer",
+ *    context_page_owner_type: "orders-payment",
+ *    order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11",
+ *    subject: "click payment method",
+ *    payment method: "bank transfer"
+ *    amount: 2000,
+ *    currency: "USD"
+ *  }
+ * ```
+ */
+export interface ClickedPaymentMethod {
+    action: ActionType.clickedPaymentMethod;
+    flow: string;
+    context_page_owner_type: string;
+    order_id: string;
+    subject: string;
+    payment_method: string;
+    amount: number;
+    currency: string;
+}
+/**
+ *  User clicks in one of the payment details on the payment pageview
+ *
+ *  This schema describes events sent to Segment from [[clickedPaymentDetails]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedPaymentDetails",
+ *    flow: "Make Offer",
+ *    context_page_owner_type: "orders-payment",
+ *    order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11",
+ *    subject: "add another credit card",
+ *  }
+ * ```
+ */
+export interface ClickedPaymentDetails {
+    action: ActionType.clickedPaymentDetails;
+    flow: string;
+    context_page_owner_type: string;
+    order_id: string;
+    subject: 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 { BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
 import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, 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, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, 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, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, ClickedPaymentMethod, ClickedPaymentDetails, 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";
@@ -21,7 +21,7 @@ import { ToggledAccordion } from "./UserExperienceInteractions";
  *
  * Each event describes one ActionType
  */
-export declare type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | 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 | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | 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 | ClickedPaymentMethod | ClickedPaymentDetails | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EnterLiveAuction | ExperimentViewed | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | MaxBidSelected | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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.
  *
@@ -188,6 +188,14 @@ export declare enum ActionType {
     /**
      * Corresponds to {@link ClickedPromoSpace}
      */
+    clickedPaymentMethod = "clickedPaymentMethod",
+    /**
+     * Corresponds to {@link ClickedPaymentMethod}
+     */
+    clickedPaymentDetails = "clickedPaymentDetails",
+    /**
+     * Corresponds to {@link ClickedPaymentDetails}
+     */
     clickedPromoSpace = "clickedPromoSpace",
     /**
      * Corresponds to {@link ClickedRegisterToBid}

package/dist/Schema/Events/index.js

@@ -59,6 +59,8 @@ exports.ActionType = ActionType;
   ActionType["clickedOnSubmitOrder"] = "clickedOnSubmitOrder";
   ActionType["clickedSnooze"] = "clickedSnooze";
   ActionType["clickedPartnerCard"] = "clickedPartnerCard";
+  ActionType["clickedPaymentMethod"] = "clickedPaymentMethod";
+  ActionType["clickedPaymentDetails"] = "clickedPaymentDetails";
   ActionType["clickedPromoSpace"] = "clickedPromoSpace";
   ActionType["clickedRegisterToBid"] = "clickedRegisterToBid";
   ActionType["clickedSelectShippingOption"] = "clickedSelectShippingOption";

package/package.json

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