@artsy/cohesion 4.404.0 → 4.405.0--canary.751.16435.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,27 +1,3 @@
1
- # v4.404.0 (Mon Sep 21 2026)
2
-
3
- #### 🚀 Enhancement
4
-
5
- - feat: add City Guide's Add to Itinerary tap events [#753](https://github.com/artsy/cohesion/pull/753) ([@MounirDhahri](https://github.com/MounirDhahri))
6
-
7
- #### Authors: 1
8
-
9
- - Mounir Dhahri ([@MounirDhahri](https://github.com/MounirDhahri))
10
-
11
- ---
12
-
13
- # v4.403.0 (Mon Sep 21 2026)
14
-
15
- #### 🚀 Enhancement
16
-
17
- - feat: add OwnerType.cityGuide for the City Guide home screen [#752](https://github.com/artsy/cohesion/pull/752) ([@MounirDhahri](https://github.com/MounirDhahri))
18
-
19
- #### Authors: 1
20
-
21
- - Mounir Dhahri ([@MounirDhahri](https://github.com/MounirDhahri))
22
-
23
- ---
24
-
25
1
  # v4.402.0 (Fri Sep 18 2026)
26
2
 
27
3
  #### 🚀 Enhancement
@@ -1045,98 +1045,6 @@ export interface TappedCreateAlert {
1045
1045
  context_screen_owner_slug?: string;
1046
1046
  context_module?: ContextModule;
1047
1047
  }
1048
- /**
1049
- * A user taps the "+"/save control on a show, fair, or custom stop to open the Add to
1050
- * Itinerary sheet, in City Guide
1051
- *
1052
- * This schema describes events sent to Segment from [[tappedAddToItinerary]]
1053
- *
1054
- * @example Tapped from a show page, not a City Guide guide at all
1055
- * ```
1056
- * {
1057
- * action: "tappedAddToItinerary",
1058
- * context_module: "cityGuideCard",
1059
- * context_screen_owner_type: "cityGuide",
1060
- * context_screen_owner_slug: "london-united-kingdom",
1061
- * destination_screen_owner_type: "show",
1062
- * destination_screen_owner_id: "5f2c930b1ee0d500043b47dd",
1063
- * is_curated_guide: false
1064
- * }
1065
- * ```
1066
- *
1067
- * @example Tapped from a stop row inside a curated guide — `context_screen_owner_id`/
1068
- * `context_screen_owner_slug` are that guide's own id/slug
1069
- * ```
1070
- * {
1071
- * action: "tappedAddToItinerary",
1072
- * context_module: "cityGuideCard",
1073
- * context_screen_owner_type: "cityGuideGuide",
1074
- * context_screen_owner_id: "b0b1c2d3-e4f5-4a6b-8c9d-0e1f2a3b4c5d",
1075
- * context_screen_owner_slug: "chill-vibes-only",
1076
- * destination_screen_owner_type: "show",
1077
- * destination_screen_owner_id: "5f2c930b1ee0d500043b47dd",
1078
- * is_curated_guide: true
1079
- * }
1080
- * ```
1081
- */
1082
- export interface TappedAddToItinerary {
1083
- action: ActionType.tappedAddToItinerary;
1084
- context_module?: ContextModule;
1085
- /** The screen the tap happened on. When it's a curated guide's own stop list, this is
1086
- * `cityGuideGuide` with `context_screen_owner_id`/`_slug` set to that guide. */
1087
- context_screen_owner_type: ScreenOwnerType;
1088
- context_screen_owner_id?: string;
1089
- context_screen_owner_slug?: string;
1090
- destination_screen_owner_type?: ScreenOwnerType;
1091
- destination_screen_owner_id?: string;
1092
- destination_screen_owner_slug?: string;
1093
- /** Whether the row this tap came from belongs to a curated City Guide guide, rather than the
1094
- * viewer's own personal itinerary or somewhere outside City Guide entirely (a show/fair
1095
- * page, a custom stop screen, a saved list). */
1096
- is_curated_guide: boolean;
1097
- }
1098
- /**
1099
- * A user taps "Add Full List" on a curated City Guide guide, to add every one of its stops
1100
- * to one or more of their own itineraries
1101
- *
1102
- * This schema describes events sent to Segment from [[tappedAddFullListToItinerary]]
1103
- *
1104
- * @example
1105
- * ```
1106
- * {
1107
- * action: "tappedAddFullListToItinerary",
1108
- * context_screen_owner_type: "cityGuideGuide",
1109
- * context_screen_owner_id: "b0b1c2d3-e4f5-4a6b-8c9d-0e1f2a3b4c5d",
1110
- * context_screen_owner_slug: "chill-vibes-only"
1111
- * }
1112
- * ```
1113
- */
1114
- export interface TappedAddFullListToItinerary {
1115
- action: ActionType.tappedAddFullListToItinerary;
1116
- context_screen_owner_type: ScreenOwnerType;
1117
- context_screen_owner_id?: string;
1118
- context_screen_owner_slug?: string;
1119
- }
1120
- /**
1121
- * A user taps "Create New Itinerary" inside the Add to Itinerary sheet, in City Guide
1122
- *
1123
- * This schema describes events sent to Segment from [[tappedCreateItinerary]]
1124
- *
1125
- * @example
1126
- * ```
1127
- * {
1128
- * action: "tappedCreateItinerary",
1129
- * context_screen_owner_type: "cityGuide",
1130
- * context_screen_owner_slug: "london-united-kingdom"
1131
- * }
1132
- * ```
1133
- */
1134
- export interface TappedCreateItinerary {
1135
- action: ActionType.tappedCreateItinerary;
1136
- context_screen_owner_type: ScreenOwnerType;
1137
- context_screen_owner_id?: string;
1138
- context_screen_owner_slug?: string;
1139
- }
1140
1048
  /**
1141
1049
  * A user taps "Bid" on an artwork page inside an Auction
1142
1050
  *
@@ -17,7 +17,6 @@ import { TappedProductCapabilitiesGroup } from "./HomeFeedArtsyOnboarding";
17
17
  import { MyCollectionOnboardingCompleted, TappedExploreMyCollection, VisitMyCollection, VisitMyCollectionOnboardingSlide } from "./HomeFeedMyCollectionOnboarding";
18
18
  import { Impression } from "./Impression";
19
19
  import { BannerViewed, CreateAlertReminderMessageViewed, EditProfileModalViewed, ErrorMessageViewed, ExpressCheckoutViewed, ImmersiveViewArtworkDisplayed, ImmersiveViewOptionViewed, ItemViewed, NavigationDropdownViewed, NewPaymentMethodViewed, OrderDetailsViewed, OrderProgressionViewed, PartnerOfferInConversationViewed, ProgressiveOnboardingTooltipViewed, RailViewed, SavedAddressViewed, SavedPaymentMethodViewed, SendOffersBannerViewed, SendOffersErrorMessage, SendOffersModalViewed, ShippingEstimateViewed, ShippingQuoteViewed, TooltipViewed, ValidationAddressViewed, ViewedToast } from "./ImpressionTracking";
20
- import { AddedStopToItinerary } from "./Itineraries";
21
20
  import { AddCollectedArtwork, DeleteCollectedArtwork, EditCollectedArtwork, SaveCollectedArtwork, SentRequestPriceEstimate, TappedCollectedArtwork, TappedCollectedArtworkImages, TappedMyCollection, TappedMyCollectionAddArtworkArtist, TappedRequestPriceEstimate } from "./MyCollection";
22
21
  import { TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight, TappedMyCollectionInsightsMedianAuctionPriceChartCategory, TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe, TappedMyCollectionInsightsMedianAuctionRailItem } from "./MyCollectionInsights";
23
22
  import { PromptForReview } from "./PromptForReview";
@@ -29,7 +28,7 @@ import { DarkModeOptionUpdated } from "./Settings";
29
28
  import { ClickedOpenInNewTabButton, ClickedShareButton, Share } from "./Share";
30
29
  import { SwipedInfiniteDiscoveryArtwork, SwipedUp } from "./Swipe";
31
30
  import { SaleScreenLoadComplete, Screen, TimeOnPage } from "./System";
32
- import { Tapped3Dots, TappedActivityGroup, TappedAddFullListToItinerary, TappedAddToItinerary, TappedArtAssistant, TappedArtAssistantNewChat, TappedArtAssistantSuggestion, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAskSpecialist, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyerProtection, TappedBuyNow, TappedCardGroup, TappedChangePaymentMethod, TappedClearTask, TappedCollectionGroup, TappedCompleteYourProfile, TappedConfirmSeeFewerWorks, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedCreateItinerary, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedGlobalSearchBar, TappedImportFees, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedMenuItemGroup, TappedNavigationPillsGroup, TappedNavigationTab, TappedOrderArtworkImage, TappedPartnerCard, TappedPromoSpace, TappedSearchByImage, TappedSeeFewerWorks, TappedSell, TappedSellArtwork, TappedShare, TappedShowMore, TappedSkip, TappedTabBar, TappedTaskGroup, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup, TappedViewWork, TappedVisitHelpCenter } from "./Tap";
31
+ import { Tapped3Dots, TappedActivityGroup, TappedArtAssistant, TappedArtAssistantNewChat, TappedArtAssistantSuggestion, TappedArticleGroup, TappedArticleShare, TappedArtistGroup, TappedArtistSeriesGroup, TappedArtworkGroup, TappedAskSpecialist, TappedAuctionGroup, TappedAuctionResultGroup, TappedBid, TappedBrowseSimilarArtworks, TappedBuyerProtection, TappedBuyNow, TappedCardGroup, TappedChangePaymentMethod, TappedClearTask, TappedCollectionGroup, TappedCompleteYourProfile, TappedConfirmSeeFewerWorks, TappedConsign, TappedConsignmentInquiry, TappedContactGallery, TappedCreateAlert, TappedExploreGroup, TappedFairCard, TappedFairGroup, TappedGlobalSearchBar, TappedImportFees, TappedInfoBubble, TappedLearnMore, TappedLink, TappedMainArtworkGrid, TappedMenuItemGroup, TappedNavigationPillsGroup, TappedNavigationTab, TappedOrderArtworkImage, TappedPartnerCard, TappedPromoSpace, TappedSearchByImage, TappedSeeFewerWorks, TappedSell, TappedSellArtwork, TappedShare, TappedShowMore, TappedSkip, TappedTabBar, TappedTaskGroup, TappedVerifyIdentity, TappedViewingRoomCard, TappedViewingRoomGroup, TappedViewWork, TappedVisitHelpCenter } from "./Tap";
33
32
  import { ToggledArtistBio, ToggledCollapsibleOrderSummary, ToggledNotification, ToggledOfferHistory, ToggledSavedSearch } from "./Toggle";
34
33
  import { UploadSizeLimitExceeded } from "./UploadSizeLimitExceeded";
35
34
  import { ToggledAccordion } from "./UserExperienceInteractions";
@@ -39,7 +38,7 @@ import { ViewedVideo } from "./Video";
39
38
  *
40
39
  * Each event describes one ActionType
41
40
  */
42
- export type Event = AcceptedOffer | AddCollectedArtwork | AddedArtworkToArtworkList | AddedStopToItinerary | AddedToAlbum | AddressAutoCompletionResult | AddToCalendar | ArtAssistantTurnFailed | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BannerViewed | BidPageView | CheckedAccountBalance | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistArtworkImage | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAskSpecialist | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBid | ClickedBuyerProtection | ClickedBuyNow | ClickedCancelExpressCheckout | ClickedChangeOfferOption | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCloseValidationAddressModal | ClickedCollectionGroup | ClickedCompleteYourProfile | ClickedContactGallery | ClickedConversationsFilter | ClickedCounterOfferOption | ClickedCreateAlert | ClickedCV | ClickedDeliveryMethod | ClickedDismissInquiry | ClickedDownloadAppFooter | ClickedDownloadAppHeader | ClickedEditArtwork | ClickedEditAlert | ClickedEditShippingAddress | ClickedEstimateShippingCost | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedExpressCheckout | ClickedFairCard | ClickedFairGroup | ClickedFulfillmentTab | ClickedGalleryGroup | ClickedGene | ClickedHeader | ClickedHeroUnitGroup | ClickedImmersiveView | ClickedImportFees | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMakeOffer | ClickedMarketingModal | ClickedMarkSold | ClickedMarkSpam | ClickedNavBar | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferActions | ClickedOfferOption | ClickedOnArtworkShippingUnitsDropdown | ClickedOnArtworkShippingWeight | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedOrderArtworkImage | ClickedOrderPage | ClickedOrderProgression | ClickedOrderSummary | ClickedOpenInNewTabButton | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentDetails | ClickedPaymentMethod | ClickedPromoSpace | ClickedPublish | ClickedRegisterToBid | ClickedSaveAsTemplate | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShareButton | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedSnooze | ClickedSocialPost | ClickedStartPartnerOffer | ClickedTermsAndConditions | ClickedUpdateArtwork | ClickedUploadArtwork | ClickedValidationAddressOptions | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedViewWork | ClickedVisitHelpCenter | CommercialFilterParamsChanged | CommercialFilterSelectedAll | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAccount | CreateAlertReminderMessageViewed | CreatedAlbum | CreatedArtworkList | DarkModeOptionUpdated | DeclinedOffer | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedAlert | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EditProfileModalViewed | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ExpressCheckoutViewed | FocusedOnConversationMessageInput | FocusedOnPriceDatabaseSearchInput | FocusedOnSearchInput | FollowEvents | Impression | ImmersiveViewArtworkDisplayed | ImmersiveViewOptionViewed | ItemViewed | MaxBidSelected | MyCollectionOnboardingCompleted | NavigationDropdownViewed | NewPaymentMethodViewed | OnboardingUserInputData | OrderDetailsViewed | OrderProgressionViewed | PartnerOfferInConversationViewed | PastedIntoSearchInput | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ReceivedArtAssistantResponse | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedAddressViewed | SavedCookieConsentPreferences | SavedPaymentMethodViewed | SavedPriceRange | Screen | SearchedByImageWithNoResults | SearchedByImageWithResults | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SearchedWithSuggestedFilter | SelectedItemFromAddressAutoCompletion | SelectedItemFromPriceDatabaseSearch | SelectedItemFromSearch | SelectedItemFromSearchPage | SelectedFromDrawer | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentConsignmentInquiry | SentArtAssistantMessage | SentContent | SentConversationMessage | SentRequestPriceEstimate | Share | ShippingEstimateViewed | ShippingQuoteViewed | StartedOnboarding | SubmitAnotherArtwork | SubmittedCounterOffer | SubmittedOffer | SubmittedOrder | SuccessfullyLoggedIn | SwipedInfiniteDiscoveryArtwork | SwipedUp | Tapped3Dots | TappedActivityGroup | TappedAddFullListToItinerary | TappedAddToItinerary | TappedAlertsGroup | TappedArtAssistant | TappedArtAssistantNewChat | TappedArtAssistantSuggestion | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedArtworkList | TappedAskSpecialist | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyerProtection | TappedBuyNow | TappedCardGroup | TappedChangePaymentMethod | TappedClearTask | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedCompleteYourProfile | TappedConfirmSeeFewerWorks | TappedConsign | TappedConsignmentInquiry | TappedContactGallery | TappedCreateAlert | TappedCreateItinerary | TappedEditedProfile | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedFollowsGroup | TappedGlobalSearchBar | TappedImportFees | TappedInboxConversation | TappedInfoBubble | TappedLearnMore | TappedLink | TappedMainArtworkGrid | TappedMakeOffer | TappedMenuItemGroup | TappedMyCollection | TappedMyCollectionAddArtworkArtist | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionInsightsMedianAuctionRailItem | TappedNavigationPillsGroup | TappedNavigationTab | TappedNewArtworkList | TappedNotificationsBell | TappedOfferSettings | TappedOrderArtworkImage | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSearchByImage | TappedSeeFewerWorks | TappedSell | TappedSellArtwork | TappedShare | TappedShowMore | TappedSkip | TappedTabBar | TappedTaskGroup | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TappedVisitHelpCenter | TimeOnPage | ToggledAccordion | ToggledArtistBio | ToggledCollapsibleOrderSummary | ToggledNotification | ToggledOfferHistory | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | ProgressiveOnboardingTooltipViewed | UploadPhotosCompleted | UploadSizeLimitExceeded | ValidationAddressViewed | ViewArtworkMyCollection | ViewedArtworkList | ViewedSharedArtworkList | ViewedVideo | ViewedToast | VisitMyCollection | VisitMyCollectionOnboardingSlide;
41
+ export type Event = AcceptedOffer | AddCollectedArtwork | AddedArtworkToArtworkList | AddedToAlbum | AddressAutoCompletionResult | AddToCalendar | ArtAssistantTurnFailed | ArtworkDetailsCompleted | AuctionPageView | AuctionResultsFilterParamsChanged | AuthImpression | BannerViewed | BidPageView | CheckedAccountBalance | ClickedActiveBid | ClickedActivityPanelNotificationItem | ClickedActivityPanelTab | ClickedAddFilters | ClickedAddMissingArtworksDetails | ClickedAddNewShippingAddress | ClickedAddWorksToFair | ClickedAlertsFilters | ClickedAppDownload | ClickedArticleGroup | ClickedArtistArtworkImage | ClickedArtistGroup | ClickedArtistSeriesGroup | ClickedArtworkGroup | ClickedAskSpecialist | ClickedAuctionGroup | ClickedAuctionResultItem | ClickedBid | ClickedBuyerProtection | ClickedBuyNow | ClickedCancelExpressCheckout | ClickedChangeOfferOption | ClickedChangePage | ClickedChangePaymentMethod | ClickedChangeShippingAddress | ClickedChangeShippingMethod | ClickedCloseValidationAddressModal | ClickedCollectionGroup | ClickedCompleteYourProfile | ClickedContactGallery | ClickedConversationsFilter | ClickedCounterOfferOption | ClickedCreateAlert | ClickedCV | ClickedDeliveryMethod | ClickedDismissInquiry | ClickedDownloadAppFooter | ClickedDownloadAppHeader | ClickedEditArtwork | ClickedEditAlert | ClickedEditShippingAddress | ClickedEstimateShippingCost | ClickedExpandFilterPanel | ClickedExpansionToggle | ClickedExpressCheckout | ClickedFairCard | ClickedFairGroup | ClickedFulfillmentTab | ClickedGalleryGroup | ClickedGene | ClickedHeader | ClickedHeroUnitGroup | ClickedImmersiveView | ClickedImportFees | ClickedLoadMore | ClickedMainArtworkGrid | ClickedMakeOffer | ClickedMarketingModal | ClickedMarkSold | ClickedMarkSpam | ClickedNavBar | ClickedNavigationTab | ClickedNotificationsBell | ClickedOfferActions | ClickedOfferOption | ClickedOnArtworkShippingUnitsDropdown | ClickedOnArtworkShippingWeight | ClickedOnBuyNowCheckbox | ClickedOnDuplicateArtwork | ClickedOnFramedMeasurements | ClickedOnFramedMeasurementsDropdown | ClickedOnLearnMore | ClickedOnMakeOfferCheckbox | ClickedOnPagination | ClickedOnPriceDisplayDropdown | ClickedOnReadMore | ClickedOrderArtworkImage | ClickedOrderPage | ClickedOrderProgression | ClickedOrderSummary | ClickedOpenInNewTabButton | ClickedPartnerCard | ClickedPartnerLink | ClickedPaymentDetails | ClickedPaymentMethod | ClickedPromoSpace | ClickedPublish | ClickedRegisterToBid | ClickedSaveAsTemplate | ClickedSelectShippingOption | ClickedSendPartnerOffer | ClickedShareButton | ClickedShippingAddress | ClickedShowGroup | ClickedShowMore | ClickedSnooze | ClickedSocialPost | ClickedStartPartnerOffer | ClickedTermsAndConditions | ClickedUpdateArtwork | ClickedUploadArtwork | ClickedValidationAddressOptions | ClickedVerifyIdentity | ClickedViewingRoomCard | ClickedViewWork | ClickedVisitHelpCenter | CommercialFilterParamsChanged | CommercialFilterSelectedAll | CompletedOfflineSync | CompletedOnboarding | ConfirmBid | ConfirmRegistrationPageview | ConsignmentArtistFailed | ConsignmentSubmitted | ContactInformationCompleted | CreatedAccount | CreateAlertReminderMessageViewed | CreatedAlbum | CreatedArtworkList | DarkModeOptionUpdated | DeclinedOffer | DeleteCollectedArtwork | DeletedArtworkList | DeletedSavedSearch | EditCollectedArtwork | EditedAlert | EditedArtworkList | EditedAutocompletedAddress | EditedSavedSearch | EditedUserProfile | EditProfileModalViewed | EnterLiveAuction | ErrorMessageViewed | ExperimentViewed | ExpressCheckoutViewed | FocusedOnConversationMessageInput | FocusedOnPriceDatabaseSearchInput | FocusedOnSearchInput | FollowEvents | Impression | ImmersiveViewArtworkDisplayed | ImmersiveViewOptionViewed | ItemViewed | MaxBidSelected | MyCollectionOnboardingCompleted | NavigationDropdownViewed | NewPaymentMethodViewed | OnboardingUserInputData | OrderDetailsViewed | OrderProgressionViewed | PartnerOfferInConversationViewed | PastedIntoSearchInput | PriceDatabaseFilterParamsChanged | PromptForReview | RailViewed | ReceivedArtAssistantResponse | RegistrationPageView | RegistrationSubmitted | ResetYourPassword | SaleScreenLoadComplete | SaveCollectedArtwork | SavedAddressViewed | SavedCookieConsentPreferences | SavedPaymentMethodViewed | SavedPriceRange | Screen | SearchedByImageWithNoResults | SearchedByImageWithResults | SearchedPriceDatabase | SearchedWithNoResults | SearchedWithResults | SearchedWithSuggestedFilter | SelectedItemFromAddressAutoCompletion | SelectedItemFromPriceDatabaseSearch | SelectedItemFromSearch | SelectedItemFromSearchPage | SelectedFromDrawer | SelectedRecentPriceRange | SelectedSearchSuggestionQuickNavigationItem | SendOffersBannerViewed | SendOffersErrorMessage | SendOffersModalViewed | SentConsignmentInquiry | SentArtAssistantMessage | SentContent | SentConversationMessage | SentRequestPriceEstimate | Share | ShippingEstimateViewed | ShippingQuoteViewed | StartedOnboarding | SubmitAnotherArtwork | SubmittedCounterOffer | SubmittedOffer | SubmittedOrder | SuccessfullyLoggedIn | SwipedInfiniteDiscoveryArtwork | SwipedUp | Tapped3Dots | TappedActivityGroup | TappedAlertsGroup | TappedArtAssistant | TappedArtAssistantNewChat | TappedArtAssistantSuggestion | TappedArticleGroup | TappedArticleShare | TappedArtistGroup | TappedArtistSeriesGroup | TappedArtworkGroup | TappedArtworkList | TappedAskSpecialist | TappedAuctionGroup | TappedAuctionResultGroup | TappedBid | TappedBrowseSimilarArtworks | TappedBuyerProtection | TappedBuyNow | TappedCardGroup | TappedChangePaymentMethod | TappedClearTask | TappedCollectedArtwork | TappedCollectedArtworkImages | TappedCollectionGroup | TappedCompleteYourProfile | TappedConfirmSeeFewerWorks | TappedConsign | TappedConsignmentInquiry | TappedContactGallery | TappedCreateAlert | TappedEditedProfile | TappedExploreGroup | TappedExploreMyCollection | TappedFairCard | TappedFairGroup | TappedFollowsGroup | TappedGlobalSearchBar | TappedImportFees | TappedInboxConversation | TappedInfoBubble | TappedLearnMore | TappedLink | TappedMainArtworkGrid | TappedMakeOffer | TappedMenuItemGroup | TappedMyCollection | TappedMyCollectionAddArtworkArtist | TappedMyCollectionInsightsMedianAuctionPriceChartCareerHighlight | TappedMyCollectionInsightsMedianAuctionPriceChartCategory | TappedMyCollectionInsightsMedianAuctionPriceChartTimeframe | TappedMyCollectionInsightsMedianAuctionRailItem | TappedNavigationPillsGroup | TappedNavigationTab | TappedNewArtworkList | TappedNotificationsBell | TappedOfferSettings | TappedOrderArtworkImage | TappedPartnerCard | TappedProductCapabilitiesGroup | TappedPromoSpace | TappedRequestPriceEstimate | TappedSearchByImage | TappedSeeFewerWorks | TappedSell | TappedSellArtwork | TappedShare | TappedShowMore | TappedSkip | TappedTabBar | TappedTaskGroup | TappedVerifyIdentity | TappedViewingRoomCard | TappedViewingRoomGroup | TappedViewOffer | TappedViewWork | TappedVisitHelpCenter | TimeOnPage | ToggledAccordion | ToggledArtistBio | ToggledCollapsibleOrderSummary | ToggledNotification | ToggledOfferHistory | ToggledPresentationModeSetting | ToggledSavedSearch | TooltipViewed | ProgressiveOnboardingTooltipViewed | UploadPhotosCompleted | UploadSizeLimitExceeded | ValidationAddressViewed | ViewArtworkMyCollection | ViewedArtworkList | ViewedSharedArtworkList | ViewedVideo | ViewedToast | VisitMyCollection | VisitMyCollectionOnboardingSlide;
43
42
  /**
44
43
  * The top-level actions an Event describes.
45
44
  *
@@ -54,10 +53,6 @@ export declare enum ActionType {
54
53
  * Corresponds to {@link AddedArtworkToArtworkList}
55
54
  */
56
55
  addedArtworkToArtworkList = "addedArtworkToArtworkList",
57
- /**
58
- * Corresponds to {@link AddedStopToItinerary}
59
- */
60
- addedStopToItinerary = "addedStopToItinerary",
61
56
  /**
62
57
  * Corresponds to {@link AddedToAlbum}
63
58
  */
@@ -999,14 +994,6 @@ export declare enum ActionType {
999
994
  * Corresponds to {@link TappedActivityGroup}
1000
995
  */
1001
996
  tappedActivityGroup = "tappedActivityGroup",
1002
- /**
1003
- * Corresponds to {@link TappedAddFullListToItinerary}
1004
- */
1005
- tappedAddFullListToItinerary = "tappedAddFullListToItinerary",
1006
- /**
1007
- * Corresponds to {@link TappedAddToItinerary}
1008
- */
1009
- tappedAddToItinerary = "tappedAddToItinerary",
1010
997
  /**
1011
998
  * Corresponds to {@link TappedAlertsGroup}
1012
999
  */
@@ -1131,10 +1118,6 @@ export declare enum ActionType {
1131
1118
  * Corresponds to {@link TappedCreateAlertHeader}
1132
1119
  */
1133
1120
  tappedCreateAlertHeader = "tappedCreateAlertHeader",
1134
- /**
1135
- * Corresponds to {@link TappedCreateItinerary}
1136
- */
1137
- tappedCreateItinerary = "tappedCreateItinerary",
1138
1121
  /**
1139
1122
  * Corresponds to {@link TappedEditedProfile}
1140
1123
  */
@@ -22,7 +22,6 @@ exports.ActionType = ActionType;
22
22
  (function (ActionType) {
23
23
  ActionType["acceptedOffer"] = "acceptedOffer";
24
24
  ActionType["addedArtworkToArtworkList"] = "addedArtworkToArtworkList";
25
- ActionType["addedStopToItinerary"] = "addedStopToItinerary";
26
25
  ActionType["addedToAlbum"] = "addedToAlbum";
27
26
  ActionType["addArtworkDetails"] = "addArtworkDetails";
28
27
  ActionType["addCollectedArtwork"] = "addCollectedArtwork";
@@ -258,8 +257,6 @@ exports.ActionType = ActionType;
258
257
  ActionType["swipedUp"] = "swipedUp";
259
258
  ActionType["tapped3Dots"] = "tapped3Dots";
260
259
  ActionType["tappedActivityGroup"] = "tappedActivityGroup";
261
- ActionType["tappedAddFullListToItinerary"] = "tappedAddFullListToItinerary";
262
- ActionType["tappedAddToItinerary"] = "tappedAddToItinerary";
263
260
  ActionType["tappedAlertsGroup"] = "tappedAlertsGroup";
264
261
  ActionType["tappedArtAssistant"] = "tappedArtAssistant";
265
262
  ActionType["tappedArtAssistantNewChat"] = "tappedArtAssistantNewChat";
@@ -291,7 +288,6 @@ exports.ActionType = ActionType;
291
288
  ActionType["tappedConsignmentInquiry"] = "tappedConsignmentInquiry";
292
289
  ActionType["tappedCreateAlert"] = "tappedCreateAlert";
293
290
  ActionType["tappedCreateAlertHeader"] = "tappedCreateAlertHeader";
294
- ActionType["tappedCreateItinerary"] = "tappedCreateItinerary";
295
291
  ActionType["tappedEditedProfile"] = "tappedEditedProfile";
296
292
  ActionType["tappedExploreGroup"] = "tappedExploreGroup";
297
293
  ActionType["tappedExploreMyCollection"] = "tappedExploreMyCollection";
@@ -88,7 +88,6 @@ export declare enum ContextModule {
88
88
  bulkEditDrawer = "bulkEditDrawer",
89
89
  categoryRail = "categoryRail",
90
90
  cityGuideCard = "cityGuideCard",
91
- cityGuideMapToggle = "cityGuideMapToggle",
92
91
  collectionCard = "collectionCard",
93
92
  collectionDescription = "collectionDescription",
94
93
  collectionRail = "collectionRail",
@@ -102,7 +102,6 @@ exports.ContextModule = ContextModule;
102
102
  ContextModule["bulkEditDrawer"] = "bulkEditDrawer";
103
103
  ContextModule["categoryRail"] = "categoryRail";
104
104
  ContextModule["cityGuideCard"] = "cityGuideCard";
105
- ContextModule["cityGuideMapToggle"] = "cityGuideMapToggle";
106
105
  ContextModule["collectionCard"] = "collectionCard";
107
106
  ContextModule["collectionDescription"] = "collectionDescription";
108
107
  ContextModule["collectionRail"] = "collectionRail";
@@ -54,12 +54,8 @@ export declare enum OwnerType {
54
54
  basedOnYourRecentSaves = "basedOnYourRecentSaves",
55
55
  brandSettings = "brandSettings",
56
56
  category = "category",
57
- cityGuide = "cityGuide",
58
- cityGuideCustomStop = "cityGuideCustomStop",
59
- cityGuideEventList = "cityGuideEventList",
60
57
  cityGuideGuide = "cityGuideGuide",
61
58
  cityGuideMap = "cityGuideMap",
62
- cityGuideSavedList = "cityGuideSavedList",
63
59
  cityPicker = "cityPicker",
64
60
  collect = "collect",
65
61
  collection = "collection",
@@ -187,7 +183,7 @@ export declare enum OwnerType {
187
183
  /**
188
184
  * Owner types available in iOS/Android
189
185
  */
190
- export type ScreenOwnerType = OwnerType.about | OwnerType.account | OwnerType.accountDarkMode | OwnerType.accountDeleteMyAccount | OwnerType.accountEmail | OwnerType.accountLoginAndSecurity | OwnerType.accountNotifications | OwnerType.accountOrders | OwnerType.accountPassword | OwnerType.accountPayment | OwnerType.accountAddPayment | OwnerType.accountPersonalDataRequest | OwnerType.accountPhoneNumber | OwnerType.accountPreferences | OwnerType.accountPriceRange | OwnerType.accountPrivacy | OwnerType.accountSettings | OwnerType.accountTermsAndConditions | OwnerType.activities | OwnerType.activity | OwnerType.album | OwnerType.alertConfirmation | OwnerType.alertDetails | OwnerType.alertFilters | OwnerType.alerts | OwnerType.alert | OwnerType.alertsInfoModal | OwnerType.allArtistSeries | OwnerType.artAssistant | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistArticles | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.artworkList | OwnerType.artworkPriceFilter | OwnerType.artworkRecommendations | OwnerType.auctionResult | OwnerType.auctionResultsForArtistsYouFollow | OwnerType.auctions | OwnerType.auctionsOverview | OwnerType.authModal | OwnerType.basedOnYourRecentSaves | OwnerType.category | OwnerType.cityGuide | OwnerType.cityGuideCustomStop | OwnerType.cityGuideEventList | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityGuideSavedList | OwnerType.cityPicker | OwnerType.collect | OwnerType.collection | OwnerType.collectionsCategory | OwnerType.confirmYourBid | OwnerType.consign | OwnerType.consignmentFlow | OwnerType.consignmentInquiry | OwnerType.consignmentSubmission | OwnerType.conversation | OwnerType.conversationMakeOfferConfirmArtwork | OwnerType.createAlert | OwnerType.editAlert | OwnerType.editProfile | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.favorites | OwnerType.favoritesAlerts | OwnerType.favoritesFollows | OwnerType.favoritesSaves | OwnerType.featuredFairs | OwnerType.follows | OwnerType.gallery | OwnerType.galleriesForYou | OwnerType.gene | OwnerType.home | OwnerType.inbox | OwnerType.inboxBids | OwnerType.inboxConversation | OwnerType.inboxInquiries | OwnerType.infiniteDiscoveryArtwork | OwnerType.infiniteDiscoveryArtist | OwnerType.infiniteDiscoveryOnboarding | OwnerType.lotsByArtistsYouFollow | OwnerType.lotsForYou | OwnerType.marketNews | OwnerType.marketingCollection | OwnerType.myCollection | OwnerType.myCollectionAddArtworkArtist | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtworkAbout | OwnerType.myCollectionArtworkInsights | OwnerType.myCollectionInsights | OwnerType.myCollectionInsightsMedianAuctionPrice | OwnerType.myCollectionOnboarding | OwnerType.newWorksForYou | OwnerType.newWorksFromGalleriesYouFollow | OwnerType.notification | OwnerType.onboarding | OwnerType.ordersDetail | OwnerType.partner | OwnerType.priceDatabase | OwnerType.profile | OwnerType.quickLinks | OwnerType.recentlyViewed | OwnerType.sale | OwnerType.saleInformation | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.savedSearchArtworkMatches | OwnerType.saves | OwnerType.savesAndFollows | OwnerType.savesInfoModal | OwnerType.search | OwnerType.searchByImage | OwnerType.sell | OwnerType.settings | OwnerType.show | OwnerType.shows | OwnerType.similarToRecentlyViewed | OwnerType.submitArtworkStepAddDetails | OwnerType.submitArtworkStepAddDimensions | OwnerType.submitArtworkStepAddPhoneNumber | OwnerType.submitArtworkStepAddPhotos | OwnerType.submitArtworkStepAddtionalDocuments | OwnerType.submitArtworkStepAddTitle | OwnerType.submitArtworkStepArtistRejected | OwnerType.submitArtworkStepCompleteYourSubmission | OwnerType.submitArtworkStepCompleteYourSubmissionPostApproval | OwnerType.submitArtworkStepCondition | OwnerType.submitArtworkStepFrameInformation | OwnerType.submitArtworkStepPurchaseHistory | OwnerType.submitArtworkStepSelectArtist | OwnerType.submitArtworkStepSelectArtworkMyCollectionArtwork | OwnerType.submitArtworkStepShippingLocation | OwnerType.submitArtworkStepStart | OwnerType.tag | OwnerType.upcomingAuctions | OwnerType.viewingRoom | OwnerType.viewingRoomArtworkPage | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.worksForYou | OwnerType.yourMaxBid;
186
+ export type ScreenOwnerType = OwnerType.about | OwnerType.account | OwnerType.accountDarkMode | OwnerType.accountDeleteMyAccount | OwnerType.accountEmail | OwnerType.accountLoginAndSecurity | OwnerType.accountNotifications | OwnerType.accountOrders | OwnerType.accountPassword | OwnerType.accountPayment | OwnerType.accountAddPayment | OwnerType.accountPersonalDataRequest | OwnerType.accountPhoneNumber | OwnerType.accountPreferences | OwnerType.accountPriceRange | OwnerType.accountPrivacy | OwnerType.accountSettings | OwnerType.accountTermsAndConditions | OwnerType.activities | OwnerType.activity | OwnerType.album | OwnerType.alertConfirmation | OwnerType.alertDetails | OwnerType.alertFilters | OwnerType.alerts | OwnerType.alert | OwnerType.alertsInfoModal | OwnerType.allArtistSeries | OwnerType.artAssistant | OwnerType.article | OwnerType.articles | OwnerType.artist | OwnerType.artistArticles | OwnerType.artistAuctionResults | OwnerType.artistSeries | OwnerType.artwork | OwnerType.artworkList | OwnerType.artworkPriceFilter | OwnerType.artworkRecommendations | OwnerType.auctionResult | OwnerType.auctionResultsForArtistsYouFollow | OwnerType.auctions | OwnerType.auctionsOverview | OwnerType.authModal | OwnerType.basedOnYourRecentSaves | OwnerType.category | OwnerType.cityGuideGuide | OwnerType.cityGuideMap | OwnerType.cityPicker | OwnerType.collect | OwnerType.collection | OwnerType.collectionsCategory | OwnerType.confirmYourBid | OwnerType.consign | OwnerType.consignmentFlow | OwnerType.consignmentInquiry | OwnerType.consignmentSubmission | OwnerType.conversation | OwnerType.conversationMakeOfferConfirmArtwork | OwnerType.createAlert | OwnerType.editAlert | OwnerType.editProfile | OwnerType.explore | OwnerType.fair | OwnerType.fairArtworks | OwnerType.favorites | OwnerType.favoritesAlerts | OwnerType.favoritesFollows | OwnerType.favoritesSaves | OwnerType.featuredFairs | OwnerType.follows | OwnerType.gallery | OwnerType.galleriesForYou | OwnerType.gene | OwnerType.home | OwnerType.inbox | OwnerType.inboxBids | OwnerType.inboxConversation | OwnerType.inboxInquiries | OwnerType.infiniteDiscoveryArtwork | OwnerType.infiniteDiscoveryArtist | OwnerType.infiniteDiscoveryOnboarding | OwnerType.lotsByArtistsYouFollow | OwnerType.lotsForYou | OwnerType.marketNews | OwnerType.marketingCollection | OwnerType.myCollection | OwnerType.myCollectionAddArtworkArtist | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtwork | OwnerType.myCollectionArtworkAbout | OwnerType.myCollectionArtworkInsights | OwnerType.myCollectionInsights | OwnerType.myCollectionInsightsMedianAuctionPrice | OwnerType.myCollectionOnboarding | OwnerType.newWorksForYou | OwnerType.newWorksFromGalleriesYouFollow | OwnerType.notification | OwnerType.onboarding | OwnerType.ordersDetail | OwnerType.partner | OwnerType.priceDatabase | OwnerType.profile | OwnerType.quickLinks | OwnerType.recentlyViewed | OwnerType.sale | OwnerType.saleInformation | OwnerType.savedSearch | OwnerType.savedSearches | OwnerType.savedSearchArtworkMatches | OwnerType.saves | OwnerType.savesAndFollows | OwnerType.savesInfoModal | OwnerType.search | OwnerType.searchByImage | OwnerType.sell | OwnerType.settings | OwnerType.show | OwnerType.shows | OwnerType.similarToRecentlyViewed | OwnerType.submitArtworkStepAddDetails | OwnerType.submitArtworkStepAddDimensions | OwnerType.submitArtworkStepAddPhoneNumber | OwnerType.submitArtworkStepAddPhotos | OwnerType.submitArtworkStepAddtionalDocuments | OwnerType.submitArtworkStepAddTitle | OwnerType.submitArtworkStepArtistRejected | OwnerType.submitArtworkStepCompleteYourSubmission | OwnerType.submitArtworkStepCompleteYourSubmissionPostApproval | OwnerType.submitArtworkStepCondition | OwnerType.submitArtworkStepFrameInformation | OwnerType.submitArtworkStepPurchaseHistory | OwnerType.submitArtworkStepSelectArtist | OwnerType.submitArtworkStepSelectArtworkMyCollectionArtwork | OwnerType.submitArtworkStepShippingLocation | OwnerType.submitArtworkStepStart | OwnerType.tag | OwnerType.upcomingAuctions | OwnerType.viewingRoom | OwnerType.viewingRoomArtworkPage | OwnerType.viewingRoomArtworks | OwnerType.viewingRoomList | OwnerType.worksForYou | OwnerType.yourMaxBid;
191
187
  /**
192
188
  * Owner types available in web/mobile web
193
189
  */
@@ -72,12 +72,8 @@ exports.OwnerType = OwnerType;
72
72
  OwnerType["basedOnYourRecentSaves"] = "basedOnYourRecentSaves";
73
73
  OwnerType["brandSettings"] = "brandSettings";
74
74
  OwnerType["category"] = "category";
75
- OwnerType["cityGuide"] = "cityGuide";
76
- OwnerType["cityGuideCustomStop"] = "cityGuideCustomStop";
77
- OwnerType["cityGuideEventList"] = "cityGuideEventList";
78
75
  OwnerType["cityGuideGuide"] = "cityGuideGuide";
79
76
  OwnerType["cityGuideMap"] = "cityGuideMap";
80
- OwnerType["cityGuideSavedList"] = "cityGuideSavedList";
81
77
  OwnerType["cityPicker"] = "cityPicker";
82
78
  OwnerType["collect"] = "collect";
83
79
  OwnerType["collection"] = "collection";
@@ -154,6 +154,156 @@ export interface OsEditedArtworkField {
154
154
  /** Artist and location only: the resolved Artsy entity ID */
155
155
  matched_id?: string;
156
156
  }
157
+ /**
158
+ * A partner clicks the Writing Assistant button on a description cell to open the
159
+ * AI description drawer.
160
+ *
161
+ * This schema describes events sent to Segment from [[OsClickedWritingAssistant]]
162
+ *
163
+ * @example
164
+ * ```
165
+ * {
166
+ * action: "clickedWritingAssistant",
167
+ * context_module: "artworkTable",
168
+ * context_page_owner_type: "inventory",
169
+ * artwork_id: "abc123"
170
+ * }
171
+ * ```
172
+ */
173
+ export interface OsClickedWritingAssistant {
174
+ action: OsActionType.clickedWritingAssistant;
175
+ context_module: OsContextModule.artworkTable;
176
+ context_page_owner_type: OsOwnerType;
177
+ artwork_id: string;
178
+ }
179
+ /**
180
+ * A partner clicks "Add Description" in the Writing Assistant drawer, applying the
181
+ * generated (and possibly edited) description to the description cell.
182
+ *
183
+ * This schema describes events sent to Segment from [[OsAddedGeneratedArtworkDescription]]
184
+ *
185
+ * @example
186
+ * ```
187
+ * {
188
+ * action: "addedGeneratedArtworkDescription",
189
+ * context_module: "writingAssistantDrawer",
190
+ * context_page_owner_type: "inventory",
191
+ * artwork_id: "abc123",
192
+ * regenerate_count: 2,
193
+ * was_edited: true,
194
+ * document_count: 1,
195
+ * generated_description: "A vibrant abstract composition..."
196
+ * }
197
+ * ```
198
+ */
199
+ export interface OsAddedGeneratedArtworkDescription {
200
+ action: OsActionType.addedGeneratedArtworkDescription;
201
+ context_module: OsContextModule.writingAssistantDrawer;
202
+ context_page_owner_type: OsOwnerType;
203
+ artwork_id: string;
204
+ /** Number of times the partner clicked Regenerate (excludes automatic regenerations triggered by adding/removing a document) */
205
+ regenerate_count: number;
206
+ /** Whether the final text differs from the last generated text */
207
+ was_edited: boolean;
208
+ /** Number of supporting documents attached at the time of adding the description */
209
+ document_count: number;
210
+ /** The raw AI-generated text, before any edits the partner made */
211
+ generated_description: string;
212
+ }
213
+ /**
214
+ * A partner closes the Writing Assistant drawer without adding the generated description,
215
+ * via the Cancel button, the X, the backdrop, or Escape.
216
+ *
217
+ * This schema describes events sent to Segment from [[OsClosedWritingAssistant]]
218
+ *
219
+ * @example
220
+ * ```
221
+ * {
222
+ * action: "closedWritingAssistant",
223
+ * context_module: "writingAssistantDrawer",
224
+ * context_page_owner_type: "inventory",
225
+ * artwork_id: "abc123",
226
+ * value: "cancel",
227
+ * regenerate_count: 2,
228
+ * was_edited: true,
229
+ * document_count: 1,
230
+ * generated_description: "A vibrant abstract composition..."
231
+ * }
232
+ * ```
233
+ */
234
+ export interface OsClosedWritingAssistant {
235
+ action: OsActionType.closedWritingAssistant;
236
+ context_module: OsContextModule.writingAssistantDrawer;
237
+ context_page_owner_type: OsOwnerType;
238
+ artwork_id: string;
239
+ /** "cancel" = Cancel button, "close" = X, backdrop, or Escape */
240
+ value: "cancel" | "close";
241
+ /** Number of times the partner clicked Regenerate (excludes automatic regenerations triggered by adding/removing a document) */
242
+ regenerate_count: number;
243
+ /** Whether the discarded text differs from the last generated text */
244
+ was_edited: boolean;
245
+ /** Number of supporting documents attached when the drawer was closed */
246
+ document_count: number;
247
+ /** The raw AI-generated text that was discarded */
248
+ generated_description: string;
249
+ }
250
+ /**
251
+ * A partner rates a generated description as helpful or not, via the thumbs feedback
252
+ * shown below the text in the Writing Assistant drawer. Fires once the follow-up detail
253
+ * modal resolves (Send, Skip, or close) — `detail` is the optional free text the partner
254
+ * added, or an empty string if they skipped or closed without typing anything.
255
+ *
256
+ * This schema describes events sent to Segment from [[OsRatedGeneratedArtworkDescription]]
257
+ *
258
+ * @example
259
+ * ```
260
+ * {
261
+ * action: "ratedGeneratedArtworkDescription",
262
+ * context_module: "writingAssistantDrawer",
263
+ * context_page_owner_type: "inventory",
264
+ * artwork_id: "abc123",
265
+ * value: "up",
266
+ * detail: "",
267
+ * regenerate_count: 2,
268
+ * was_edited: false,
269
+ * document_count: 1,
270
+ * generated_description: "A vibrant abstract composition..."
271
+ * }
272
+ * ```
273
+ *
274
+ * @example With optional detail text
275
+ * ```
276
+ * {
277
+ * action: "ratedGeneratedArtworkDescription",
278
+ * context_module: "writingAssistantDrawer",
279
+ * context_page_owner_type: "inventory",
280
+ * artwork_id: "abc123",
281
+ * value: "down",
282
+ * detail: "Too generic, didn't mention the material",
283
+ * regenerate_count: 0,
284
+ * was_edited: false,
285
+ * document_count: 0,
286
+ * generated_description: "A vibrant abstract composition..."
287
+ * }
288
+ * ```
289
+ */
290
+ export interface OsRatedGeneratedArtworkDescription {
291
+ action: OsActionType.ratedGeneratedArtworkDescription;
292
+ context_module: OsContextModule.writingAssistantDrawer;
293
+ context_page_owner_type: OsOwnerType;
294
+ artwork_id: string;
295
+ value: "up" | "down";
296
+ /** Optional free text the partner added in the follow-up modal; empty string if skipped or closed without typing */
297
+ detail: string;
298
+ /** Number of times the partner clicked Regenerate (excludes automatic regenerations triggered by adding/removing a document) */
299
+ regenerate_count: number;
300
+ /** Whether the rated text differs from the last generated text */
301
+ was_edited: boolean;
302
+ /** Number of supporting documents attached at the time of rating */
303
+ document_count: number;
304
+ /** The raw AI-generated text being rated */
305
+ generated_description: string;
306
+ }
157
307
  /**
158
308
  * A partner successfully adds a new location via the Add Location modal (2-step flow).
159
309
  * Fires on useCreatePartnerLocation mutation success.
@@ -267,10 +417,22 @@ export interface OsSavedArtworkImages {
267
417
  * document_count: 3
268
418
  * }
269
419
  * ```
420
+ *
421
+ * @example Uploaded from the Writing Assistant drawer
422
+ * ```
423
+ * {
424
+ * action: "addedArtworkDocument",
425
+ * context_module: "writingAssistantDrawer",
426
+ * context_page_owner_type: "inventory",
427
+ * artwork_id: "abc123",
428
+ * document_count: 1,
429
+ * value: { type: "pdf", size: "1.2MB" }
430
+ * }
431
+ * ```
270
432
  */
271
433
  export interface OsAddedArtworkDocument {
272
434
  action: OsActionType.addedArtworkDocument;
273
- context_module: OsContextModule.documentsModal;
435
+ context_module: OsContextModule.documentsModal | OsContextModule.writingAssistantDrawer;
274
436
  context_page_owner_type: OsOwnerType;
275
437
  artwork_id: string;
276
438
  /** Document count after the upload */
@@ -422,4 +584,4 @@ export interface OsReorderedInventoryTableColumns {
422
584
  /** Full resulting column key order (reorderable columns only, pinned columns excluded) */
423
585
  new_order: string[];
424
586
  }
425
- export type OsInventoryTable = ChangedInventoryTableColumnVisibility | EditedInventoryField | OsAddedArtist | OsAddedArtworkDocument | OsAddedLocation | OsClickedActionsDropdown | OsClickedArtworkRow | OsClickedEditArtworkButton | OsClickedEditionSetRow | OsClickedImagesModal | OsEditedArtworkField | OsRemovedArtworkDocument | OsReorderedInventoryTableColumns | OsSavedArtworkImages;
587
+ export type OsInventoryTable = ChangedInventoryTableColumnVisibility | EditedInventoryField | OsAddedArtist | OsAddedArtworkDocument | OsAddedGeneratedArtworkDescription | OsAddedLocation | OsClickedActionsDropdown | OsClickedArtworkRow | OsClickedEditArtworkButton | OsClickedEditionSetRow | OsClickedImagesModal | OsClickedWritingAssistant | OsClosedWritingAssistant | OsEditedArtworkField | OsRatedGeneratedArtworkDescription | OsRemovedArtworkDocument | OsReorderedInventoryTableColumns | OsSavedArtworkImages;
@@ -39,6 +39,10 @@ export declare enum OsActionType {
39
39
  * Corresponds to {@link AddedArtworksToList}
40
40
  */
41
41
  addedArtworksToList = "addedArtworksToList",
42
+ /**
43
+ * Corresponds to {@link OsInventoryTable}
44
+ */
45
+ addedGeneratedArtworkDescription = "addedGeneratedArtworkDescription",
42
46
  /**
43
47
  * Corresponds to {@link OsInventoryTable}
44
48
  */
@@ -152,6 +156,14 @@ export declare enum OsActionType {
152
156
  * Corresponds to {@link OsInstagramEditor}
153
157
  */
154
158
  clickedUploadImageBank = "clickedUploadImageBank",
159
+ /**
160
+ * Corresponds to {@link OsInventoryTable}
161
+ */
162
+ clickedWritingAssistant = "clickedWritingAssistant",
163
+ /**
164
+ * Corresponds to {@link OsInventoryTable}
165
+ */
166
+ closedWritingAssistant = "closedWritingAssistant",
155
167
  /**
156
168
  * Corresponds to {@link CompletedArtworkDistribution}
157
169
  */
@@ -221,6 +233,10 @@ export declare enum OsActionType {
221
233
  * Corresponds to {@link ProgressedGettingStarted}
222
234
  */
223
235
  progressedOnboarding = "progressedOnboarding",
236
+ /**
237
+ * Corresponds to {@link OsInventoryTable}
238
+ */
239
+ ratedGeneratedArtworkDescription = "ratedGeneratedArtworkDescription",
224
240
  /**
225
241
  * Corresponds to {@link OsInventoryTable}
226
242
  */
@@ -24,6 +24,7 @@ exports.OsActionType = OsActionType;
24
24
  OsActionType["appliedFilter"] = "appliedFilter";
25
25
  OsActionType["addedArtworkDocument"] = "addedArtworkDocument";
26
26
  OsActionType["addedArtworksToList"] = "addedArtworksToList";
27
+ OsActionType["addedGeneratedArtworkDescription"] = "addedGeneratedArtworkDescription";
27
28
  OsActionType["addedLocation"] = "addedLocation";
28
29
  OsActionType["bulkEditedArtworks"] = "bulkEditedArtworks";
29
30
  OsActionType["cancelledArtworkImport"] = "cancelledArtworkImport";
@@ -53,6 +54,8 @@ exports.OsActionType = OsActionType;
53
54
  OsActionType["clickedShowMeHow"] = "clickedShowMeHow";
54
55
  OsActionType["clickedSendConfirmation"] = "clickedSendConfirmation";
55
56
  OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
57
+ OsActionType["clickedWritingAssistant"] = "clickedWritingAssistant";
58
+ OsActionType["closedWritingAssistant"] = "closedWritingAssistant";
56
59
  OsActionType["completedArtworkDistribution"] = "completedArtworkDistribution";
57
60
  OsActionType["completedArtworkImport"] = "completedArtworkImport";
58
61
  OsActionType["completedOnboarding"] = "completedOnboarding";
@@ -70,6 +73,7 @@ exports.OsActionType = OsActionType;
70
73
  OsActionType["editedInventoryField"] = "editedInventoryField";
71
74
  OsActionType["movedArtworksBetweenLists"] = "movedArtworksBetweenLists";
72
75
  OsActionType["progressedOnboarding"] = "progressedOnboarding";
76
+ OsActionType["ratedGeneratedArtworkDescription"] = "ratedGeneratedArtworkDescription";
73
77
  OsActionType["removedArtworkDocument"] = "removedArtworkDocument";
74
78
  OsActionType["removedFilter"] = "removedFilter";
75
79
  OsActionType["removedArtworksFromList"] = "removedArtworksFromList";
@@ -39,5 +39,6 @@ export declare enum OsContextModule {
39
39
  privateViewingRoomEditor = "privateViewingRoomEditor",
40
40
  publishConfirmationModal = "publishConfirmationModal",
41
41
  sendConfirmationModal = "sendConfirmationModal",
42
- tableActions = "tableActions"
42
+ tableActions = "tableActions",
43
+ writingAssistantDrawer = "writingAssistantDrawer"
43
44
  }
@@ -50,4 +50,5 @@ exports.OsContextModule = OsContextModule;
50
50
  OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
51
51
  OsContextModule["sendConfirmationModal"] = "sendConfirmationModal";
52
52
  OsContextModule["tableActions"] = "tableActions";
53
+ OsContextModule["writingAssistantDrawer"] = "writingAssistantDrawer";
53
54
  })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@artsy/cohesion",
3
- "version": "4.404.0",
3
+ "version": "4.405.0--canary.751.16435.0",
4
4
  "description": "Analytics schema",
5
5
  "main": "dist/index.js",
6
6
  "publishConfig": {
@@ -1,31 +0,0 @@
1
- import { OwnerType } from "../Values/OwnerType";
2
- import { ActionType } from ".";
3
- /**
4
- * Schema describing City Guide itinerary events
5
- * @packageDocumentation
6
- */
7
- /**
8
- * When a user adds a stop (a show, fair, or custom stop) to one or more of their own
9
- * itineraries by pressing Done in the Add to Itinerary sheet
10
- *
11
- * This schema describes events sent to Segment from [[addedStopToItinerary]]
12
- *
13
- * @example
14
- * ```
15
- * {
16
- * action: "addedStopToItinerary",
17
- * context_owner_id: "5f2c930b1ee0d500043b47dd",
18
- * context_owner_slug: "andy-warhol-flowers",
19
- * context_owner_type: "show",
20
- * owner_ids: ["b0b1c2d3-e4f5-4a6b-8c9d-0e1f2a3b4c5d"]
21
- * }
22
- * ```
23
- */
24
- export interface AddedStopToItinerary {
25
- action: ActionType.addedStopToItinerary;
26
- context_owner_id?: string;
27
- context_owner_slug?: string;
28
- context_owner_type: OwnerType;
29
- /** The itinerary (or itineraries, adding a curated guide's full list) the stop landed on. */
30
- owner_ids: string[];
31
- }
@@ -1 +0,0 @@
1
- "use strict";