@artsy/cohesion 4.99.0 → 4.100.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.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,15 @@
1
+ # v4.100.0 (Tue Feb 07 2023)
2
+
3
+ #### 🚀 Enhancement
4
+
5
+ - [AS-3677] CMS conversation page events [#398](https://github.com/artsy/cohesion/pull/398) ([@daytavares](https://github.com/daytavares))
6
+
7
+ #### Authors: 1
8
+
9
+ - Dayane Tavares ([@daytavares](https://github.com/daytavares))
10
+
11
+ ---
12
+
1
13
  # v4.99.0 (Wed Feb 01 2023)
2
14
 
3
15
  #### 🚀 Enhancement
@@ -1332,3 +1332,86 @@ export interface ClickedOnPriceDisplayDropdown {
1332
1332
  context_page_owner_id?: string;
1333
1333
  label: string;
1334
1334
  }
1335
+ /**
1336
+ * A Partner selects a filter on the conversations page in CMS.
1337
+ *
1338
+ * This schema describes events sent to Segment from [[ClickedConversationsFilter]]
1339
+ *
1340
+ * @example
1341
+ * ```
1342
+ * {
1343
+ * label: [selected filter all, selected filter new, selected filter replied],
1344
+ * context_module: "conversations",
1345
+ * context_page_owner_type: "conversation",
1346
+ * context_page_owner_id: "60de173a47476c000fd5c4cc"
1347
+ * artwork_id: "60de173a47476c000fd5c4cc"
1348
+ * partner_id: "35de173a47476c111fd5c4cc"
1349
+ * }
1350
+ * ```
1351
+ */
1352
+ export interface ClickedConversationsFilter {
1353
+ label: string;
1354
+ context_module: string;
1355
+ context_page_owner_type: PageOwnerType;
1356
+ context_page_owner_id?: string;
1357
+ artwork_id: string;
1358
+ partner_id: string;
1359
+ }
1360
+ /**
1361
+ * Partner clicks on dismiss inquiry modal on the conversations page in CMS.
1362
+ * They can click on: Select a reason, Cancel, Dismiss inquiry
1363
+ *
1364
+ * This schema describes events sent to Segment from [[clickedDismissInquiry]]
1365
+ *
1366
+ * @example
1367
+ * ```
1368
+ * {
1369
+ * conversation_id: 123456
1370
+ * label: [select a reason, cancel dismiss inquiry, dismiss inquiry]
1371
+ * reason: [The artwork is no longer available, I already contacted this person, Other]
1372
+ * context_module: "conversations",
1373
+ * context_page_owner_type: "conversation",
1374
+ * context_page_owner_id: "60de173a47476c000fd5c4cc"
1375
+ * artwork_id: "60de173a47476c000fd5c4cc"
1376
+ * partner_id: "35de173a47476c111fd5c4cc"
1377
+ * }
1378
+ * ```
1379
+ */
1380
+ export interface ClickedDismissInquiry {
1381
+ conversation_id: string;
1382
+ label: string;
1383
+ reason: string;
1384
+ context_module: string;
1385
+ context_page_owner_type: PageOwnerType;
1386
+ context_page_owner_id?: string;
1387
+ artwork_id: string;
1388
+ partner_id: string;
1389
+ }
1390
+ /**
1391
+ * Partner clicks on mark as spam modal on the conversations page in CMS.
1392
+ * They can click on: Cancel or Delete and Mark as Spam
1393
+ *
1394
+ * This schema describes events sent to Segment from [[clickedMarkSpam]]
1395
+ *
1396
+ * @example
1397
+ * ```
1398
+ * {
1399
+ * conversation_id: 123456
1400
+ * label: [mark as spam, cancel mark as spam, delete and mark as spam]
1401
+ * context_module: "conversations",
1402
+ * context_page_owner_type: "conversation",
1403
+ * context_page_owner_id: "60de173a47476c000fd5c4cc"
1404
+ * artwork_id: "60de173a47476c000fd5c4cc"
1405
+ * partner_id: "35de173a47476c111fd5c4cc"
1406
+ * }
1407
+ * ```
1408
+ */
1409
+ export interface ClickedMarkSpam {
1410
+ conversation_id: string;
1411
+ label: string;
1412
+ context_module: string;
1413
+ context_page_owner_type: PageOwnerType;
1414
+ context_page_owner_id?: string;
1415
+ artwork_id: string;
1416
+ partner_id: string;
1417
+ }
@@ -2,7 +2,7 @@ import { ClickedActivityPanelNotificationItem, ClickedActivityPanelTab, ClickedN
2
2
  import { AddToCalendar } from "./AddToCalendar";
3
3
  import { AuctionPageView, BidPageView, ClickedActiveBid, ClickedRegisterToBid, ConfirmBid, ConfirmRegistrationPageview, EnterLiveAuction, MaxBidSelected, RegistrationPageView, RegistrationSubmitted } from "./Auction";
4
4
  import { AuthImpression, CompletedOnboarding, CreatedAccount, OnboardingUserInputData, ResetYourPassword, StartedOnboarding, SuccessfullyLoggedIn } from "./Authentication";
5
- import { CheckedAccountBalance, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnPriceDisplayDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedOrderSummary, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard } from "./Click";
5
+ import { CheckedAccountBalance, ClickedAddNewShippingAddress, ClickedAddWorksToFair, ClickedAppDownload, ClickedArticleGroup, ClickedArtistGroup, ClickedArtistSeriesGroup, ClickedArtworkGroup, ClickedAuctionGroup, ClickedAuctionResultItem, ClickedBuyerProtection, ClickedChangePage, ClickedChangePaymentMethod, ClickedChangeShippingAddress, ClickedChangeShippingMethod, ClickedCollectionGroup, ClickedCreateAlert, ClickedDeliveryMethod, ClickedEditArtwork, ClickedExpansionToggle, ClickedFairCard, ClickedFairGroup, ClickedGalleryGroup, ClickedLoadMore, ClickedMainArtworkGrid, ClickedNavigationTab, ClickedOfferActions, ClickedOfferOption, ClickedOnArtworkShippingUnitsDropdown, ClickedOnArtworkShippingWeight, ClickedOnFramedMeasurements, ClickedOnFramedMeasurementsDropdown, ClickedOnPriceDisplayDropdown, ClickedOnSubmitOrder, ClickedOrderPage, ClickedOrderSummary, ClickedDismissInquiry, ClickedMarkSpam, ClickedPartnerCard, ClickedPartnerLink, ClickedPaymentDetails, ClickedPaymentMethod, ClickedPromoSpace, ClickedSelectShippingOption, ClickedShippingAddress, ClickedShowGroup, ClickedShowMore, ClickedSnooze, ClickedVerifyIdentity, ClickedViewingRoomCard, ClickedConversationsFilter } from "./Click";
6
6
  import { EditedUserProfile } from "./CollectorProfile";
7
7
  import { ArtworkDetailsCompleted, ConsignmentSubmitted, ContactInformationCompleted, SentConsignmentInquiry, SubmitAnotherArtwork, UploadPhotosCompleted, ViewArtworkMyCollection } from "./Consignments";
8
8
  import { FocusedOnConversationMessageInput, SentConversationMessage, TappedInboxConversation, TappedMakeOffer, TappedViewOffer } from "./Conversations";
@@ -29,7 +29,7 @@ import { ViewedVideo } from "./Video";
29
29
  *
30
30
  * Each event describes one ActionType
31
31
  */
32
- export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnPriceDisplayDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ExperimentViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
32
+ export type Event = AddToCalendar | AddCollectedArtwork | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BidPageView | CreatedAccount | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAppDownload | ClickedArticleGroup | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBuyerProtection | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCollectionGroup | ClickedCreateAlert | ClickedDeliveryMethod | ClickedEditArtwork | ClickedExpansionToggle | ClickedFairCard | ClickedFairGroup | ClickedGalleryGroup | ClickedLoadMore | ClickedMainArtworkGrid | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferOption | ClickedOnArtworkShippingWeight | ClickedOnArtworkShippingUnitsDropdown | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnPriceDisplayDropdown | ClickedOnSubmitOrder | ClickedSnooze | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentMethod | ClickedPaymentDetails | CheckedAccountBalance | ClickedPromoSpace | ClickedRegisterToBid | ClickedSelectShippingOption | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedOfferActions | ClickedOrderPage | ClickedOrderSummary | ClickedDismissInquiry | ClickedMarkSpam | ClickedConversationsFilter | CommercialFilterParamsChanged | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | DeleteCollectedArtwork | DeletedSavedSearch | EditCollectedArtwork | EditedSavedSearch | EditedUserProfile | EnterLiveAuction | ExperimentViewed | UploadSizeLimitExceeded | FocusedOnConversationMessageInput | FocusedOnSearchInput | FocusedOnPriceDatabaseSearchInput | FollowEvents | Impression | MaxBidSelected | MyCollectionOnboardingCompleted | OnboardingUserInputData | PriceDatabaseFilterParamsChanged | PromptForReview | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | Screen | SearchedPriceDatabase | SearchedReverseImageWithNoResults | SearchedReverseImageWithResults | SearchedWithNoResults | SelectedArtworkFromReverseImageSearch | SelectedItemFromSearch | SelectedItemFromPriceDatabaseSearch | SelectedRecentPriceRange | SentConsignmentInquiry | SentConversationMessage | SentRequestPriceEstimate | Share | StartedOnboarding | SubmitAnotherArtwork | SuccessfullyLoggedIn | TappedArticleGroup | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBuyNow | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedConsign | TappedContactGallery | TappedConsignmentInquiry | TappedCreateAlert | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedInboxConversation | TappedInfoBubble | TappedLink | TappedNavigationTab | TappedMainArtworkGrid | TappedMakeOffer | TappedMyCollectionInsightsMedianAuctionRailItem | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedPartnerCard | TappedPickImageFromLibrary | TappedPromoSpace | TappedRequestPriceEstimate | TappedReverseImageSearch | TappedSell | TappedSellArtwork | TappedShowMore | TappedLearnMore | TappedSkip | TappedTabBar | TappedToggleCameraFlash | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TimeOnPage | ToggledAccordion | ToggledNotification | ToggledSavedSearch | UploadPhotosCompleted | ViewArtworkMyCollection | ViewedVideo | VisitMyCollection | VisitMyCollectionOnboardingSlide;
33
33
  /**
34
34
  * The top-level actions an Event describes.
35
35
  *
@@ -247,6 +247,14 @@ export declare enum ActionType {
247
247
  /**
248
248
  * Corresponds to {@link ClickedPartnerCard}
249
249
  */
250
+ clickedDismissInquiry = "clickedDismissInquiry",
251
+ /**
252
+ * Corresponds to {@link ClickedDismissInquiry}
253
+ */
254
+ clickedMarkSpam = "clickedMarkSpam",
255
+ /**
256
+ * Corresponds to {@link ClickedMarkSpam}
257
+ */
250
258
  clickedPartnerCard = "clickedPartnerCard",
251
259
  /**
252
260
  * Corresponds to {@link ClickedPartnerLink}
@@ -483,6 +491,10 @@ export declare enum ActionType {
483
491
  /**
484
492
  * Corresponds to {@link SelectedItemFromPriceDatabaseSearch}
485
493
  */
494
+ clickedConversationsFilter = "clickedConversationsFilter",
495
+ /**
496
+ * Corresponds to {@link ClickedConversationsFilter}
497
+ */
486
498
  selectedItemFromPriceDatabaseSearch = "selectedItemFromPriceDatabaseSearch",
487
499
  /**
488
500
  * Corresponds to {@link SelectedItemFromSearch}
@@ -72,6 +72,8 @@ exports.ActionType = ActionType;
72
72
  ActionType["clickedOnSubmitOrder"] = "clickedOnSubmitOrder";
73
73
  ActionType["clickedOrderPage"] = "clickedOrderPage";
74
74
  ActionType["clickedOrderSummary"] = "clickedOrderSummary";
75
+ ActionType["clickedDismissInquiry"] = "clickedDismissInquiry";
76
+ ActionType["clickedMarkSpam"] = "clickedMarkSpam";
75
77
  ActionType["clickedPartnerCard"] = "clickedPartnerCard";
76
78
  ActionType["clickedPartnerLink"] = "clickedPartnerLink";
77
79
  ActionType["clickedPaymentMethod"] = "clickedPaymentMethod";
@@ -131,6 +133,7 @@ exports.ActionType = ActionType;
131
133
  ActionType["selectArtistFromSearch"] = "selectArtistFromSearch";
132
134
  ActionType["selectArtworkFromGrid"] = "selectArtworkFromGrid";
133
135
  ActionType["selectedArtworkFromReverseImageSearch"] = "selectedArtworkFromReverseImageSearch";
136
+ ActionType["clickedConversationsFilter"] = "clickedConversationsFilter";
134
137
  ActionType["selectedItemFromPriceDatabaseSearch"] = "selectedItemFromPriceDatabaseSearch";
135
138
  ActionType["selectedItemFromSearch"] = "selectedItemFromSearch";
136
139
  ActionType["selectedRecentPriceRange"] = "selectedRecentPriceRange";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.99.0",
3
+ "version": "4.100.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {