Merge pull request #446 from artsy/dtavares_address_val

[AS-4029] Adding new event to track close address validation modal
artsy · Jul 21, 2023 · a1c35e1 · a1c35e1
2 parents bb8bae9 + b84d4b0
commit a1c35e1
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 2 deletions.
diff --git a/src/Schema/Events/Click.ts b/src/Schema/Events/Click.ts
@@ -1635,4 +1635,31 @@ export interface ClickedOnDuplicateArtwork {
   subject: string
   option: string
   label: string
+}
+/**
+ *  User clicks in one of the options that closes the modal (buttons, x or away from the screen).
+ *
+ *  This schema describes events sent to Segment from [[clickedCloseValidationAddressModal]]
+ *
+ *  @example
+ *  ```
+ *  {
+ *    action: "clickedCloseValidationAddressModal",
+ *    context_module: "OrdersShipping",
+ *    context_page_owner_type: "orders-shipping",
+ *    context_page_owner_id: "57e60c68-a198-431e-8a02-6ecb01e3a99b",
+ *    subject: Check your delivery address
+ *    option: Recommended
+ *    label: X
+ *  }
+ * ```
+ */
+ export interface ClickedCloseValidationAddressModal {
+  action: ActionType.clickedCloseValidationAddressModal
+  context_module: ContextModule
+  context_page_owner_type: string
+  context_page_owner_id: string
+  subject: string
+  option: string
+  label: string
 }
diff --git a/src/Schema/Events/index.ts b/src/Schema/Events/index.ts
@@ -89,7 +89,8 @@ import {
   ClickedSnooze,
   ClickedVerifyIdentity,
   ClickedViewingRoomCard,
-  ClickedValidationAddressOptions,  
+  ClickedValidationAddressOptions,
+  ClickedCloseValidationAddressModal,  
 } from "./Click"
 import { EditedUserProfile } from "./CollectorProfile"
 import {
@@ -287,7 +288,8 @@ export type Event =
   | ClickedMarkSpam
   | ClickedMarkSold
   | ClickedConversationsFilter
-  | ClickedValidationAddressOptions 
+  | ClickedValidationAddressOptions
+  | ClickedCloseValidationAddressModal 
   | CommercialFilterParamsChanged
   | CompletedOnboarding
   | ConfirmBid
@@ -716,6 +718,10 @@ export enum ActionType {
    * Corresponds to {@link ClickedValidationAddressOptions}
    */
   clickedValidationAddressOptions = "clickedValidationAddressOptions", 
+  /**
+   * Corresponds to {@link ClickedCloseValidationAddressModal}
+   */
+  clickedCloseValidationAddressModal = "clickedCloseValidationAddressModal",
   /**
    * Corresponds to {@link CommercialFilterParamsChanged}
    */