@artsy/cohesion 4.22.0 → 4.23.0

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 (5) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/dist/Schema/Events/Click.d.ts +29 -0
  3. package/dist/Schema/Events/index.d.ts +6 -2
  4. package/dist/Schema/Events/index.js +1 -0
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # v4.23.0 (Tue Nov 23 2021)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - [AS-2774] Creating new event for the new offer submission flow [#266](https://github.com/artsy/cohesion/pull/266) (dayanetavares@Dayanes-MBP.fritz.box)
6
+
7
+ #### Authors: 1
8
+
9
+ - Dayane Tavares ([@daytavares](https://github.com/daytavares))
10
+
11
+ ---
12
+
1
13
  # v4.22.0 (Tue Nov 23 2021)
2
14
 
3
15
  #### 🚀 Enhancement
package/dist/Schema/Events/Click.d.ts CHANGED
@@ -491,6 +491,35 @@ export interface ClickedNavigationTab {
491
491
  destination_path: string;
492
492
  subject: string;
493
493
  }
494
+ /**
495
+ * User clicks in one of the price options on the offer page
496
+ *
497
+ * This schema describes events sent to Segment from [[clickedOfferOption]]
498
+ *
499
+ * @example
500
+ * ```
501
+ * {
502
+ * action: "clickedOfferOption",
503
+ * flow: "Make Offer",
504
+ * context_page_owner_type: "orders-offer",
505
+ * context_page_owner_id: "dd0cbbb5-300b-4c49-92a1-fed55b077fa9",
506
+ * order_id: "407dd09f-4afd-4aad-a6cc-1d6704dc2b11",
507
+ * offer: "20% below the list price",
508
+ * amount: 2000,
509
+ * currency: "USD"
510
+ * }
511
+ * ```
512
+ */
513
+ export interface ClickedOfferOption {
514
+ action: ActionType.clickedOfferOption;
515
+ flow: string;
516
+ context_page_owner_type: string;
517
+ context_page_owner_id: string;
518
+ order_id: string;
519
+ offer: string;
520
+ amount: number;
521
+ currency: string;
522
+ }
494
523
  /**
495
524
  * A Partner clicks on Artwork weight (without packaging) bar in the artwork edit page
496
525
  * in CMS.
package/dist/Schema/Events/index.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  import { AddToCalendar } from "./AddToCalendar";
2
2
  import { AuthImpression, CreatedAccount, OnboardingUserInputData, ResetYourPassword, SuccessfullyLoggedIn } from "./Authentication";
3
- 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, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnSubmitOrder, ClickedPartnerCard, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
3
+ 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";
4
4
  import { ConsignmentSubmitted } from "./Consignments";
5
5
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
6
6
  import { AuctionResultsFilterParamsChanged, CommercialFilterParamsChanged, PriceDatabaseFilterParamsChanged } from "./FilterAndSort";
@@ -18,7 +18,7 @@ import { ToggledNotification, ToggledSavedSearch } from "./Toggle";
18
18
  *
19
19
  * Each event describes one ActionType
20
20
  */
21
- export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPromoSpace | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
21
+ export declare type Event = AddToCalendar | AddCollectedArtwork | AuctionResultsFilterParamsChanged | AuthImpression | CreatedAccount | 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 | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | CommercialFilterParamsChanged | ConsignmentArtistFailed | ConsignmentSubmitted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | ResetYourPassword | SaleScreenLoadComplete | Screen | SearchedPriceDatabase | SearchedWithNoResults | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SentConversationMessage | Share | 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 | TappedSell | TappedShowMore | TappedTabBar | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledNotification | ToggledSavedSearch;
22
22
  /**
23
23
  * The top-level actions an Event describes.
24
24
  *
@@ -141,6 +141,10 @@ export declare enum ActionType {
141
141
  /**
142
142
  * Corresponds to {@link ClickedOnArtworkShippingUnitsDropdown}
143
143
  */
144
+ clickedOfferOption = "clickedOfferOption",
145
+ /**
146
+ * Corresponds to {@link ClickedOfferOption}
147
+ */
144
148
  clickedOnArtworkShippingUnitsDropdown = "clickedOnArtworkShippingUnitsDropdown",
145
149
  /**
146
150
  * Corresponds to {@link ClickedOnArtworkShippingWeight}
package/dist/Schema/Events/index.js CHANGED
@@ -48,6 +48,7 @@ exports.ActionType = ActionType;
48
48
  ActionType["clickedLoadMore"] = "clickedLoadMore";
49
49
  ActionType["clickedMainArtworkGrid"] = "clickedMainArtworkGrid";
50
50
  ActionType["clickedNavigationTab"] = "clickedNavigationTab";
51
+ ActionType["clickedOfferOption"] = "clickedOfferOption";
51
52
  ActionType["clickedOnArtworkShippingUnitsDropdown"] = "clickedOnArtworkShippingUnitsDropdown";
52
53
  ActionType["clickedOnArtworkShippingWeight"] = "clickedOnArtworkShippingWeight";
53
54
  ActionType["clickedOnFramedMeasurements"] = "clickedOnFramedMeasurements";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.22.0",
3
+ "version": "4.23.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {