@artsy/cohesion 4.376.0 → 4.377.0--canary.723.15425.0

package/dist/Schema/index.d.ts

@@ -57,6 +57,7 @@ export * from "./os/Events/ConnectedAppsFlow";
 export * from "./os/Events/FilterSortSearch";
 export * from "./os/Events/InstagramEditor";
 export * from "./os/Events/InventoryTable";
+export * from "./os/Events/MailchimpEditor";
 export * from "./os/Events/MaterialsEditor";
 export * from "./os/Events/MultiAddFlow";
 export * from "./os/Events/Submit";

package/dist/Schema/index.js

@@ -604,6 +604,18 @@ Object.keys(_InventoryTable).forEach(function (key) {
   });
 });
 
+var _MailchimpEditor = require("./os/Events/MailchimpEditor");
+
+Object.keys(_MailchimpEditor).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function get() {
+      return _MailchimpEditor[key];
+    }
+  });
+});
+
 var _MaterialsEditor = require("./os/Events/MaterialsEditor");
 
 Object.keys(_MaterialsEditor).forEach(function (key) {

package/dist/Schema/os/Events/InstagramEditor.d.ts

@@ -6,12 +6,13 @@ import { OsActionType } from ".";
  * @packageDocumentation
  */
 /**
- * A partner clicks "Connect" or "Cancel" in the Instagram account connection modal.
- * The same modal is also used for Mailchimp; `label` identifies which service it is.
+ * A partner clicks "Connect" or "Cancel" in the account connection modal. The same
+ * modal is used for both Instagram and Mailchimp; `label` identifies which service it
+ * is, and `context_page_owner_type` identifies the surface it was opened from.
  *
  * This schema describes events sent to Segment from [[OsClickedConnectModal]]
  *
- * @example Connect
+ * @example Instagram connect
  * ```
  * {
  *   action: "clickedConnectModal",
@@ -22,13 +23,13 @@ import { OsActionType } from ".";
  * }
  * ```
  *
- * @example Cancel
+ * @example Mailchimp cancel
  * ```
  * {
  *   action: "clickedConnectModal",
  *   context_module: "connectModal",
- *   context_page_owner_type: "studioInstagram",
- *   label: "instagram",
+ *   context_page_owner_type: "studioMailchimp",
+ *   label: "mailchimp",
  *   value: "cancel"
  * }
  * ```
@@ -36,7 +37,7 @@ import { OsActionType } from ".";
 export interface OsClickedConnectModal {
     action: OsActionType.clickedConnectModal;
     context_module: OsContextModule.connectModal;
-    context_page_owner_type: OsOwnerType.studioInstagram;
+    context_page_owner_type: OsOwnerType;
     label: "instagram" | "mailchimp";
     value: "connect" | "cancel";
 }

package/dist/Schema/os/Events/MailchimpEditor.d.ts

@@ -0,0 +1,89 @@
+import { OsContextModule } from "../Values/OsContextModule";
+import { OsOwnerType } from "../Values/OsOwnerType";
+import { OsActionType } from ".";
+/**
+ * Schemas describing Art OS Mailchimp Editor events
+ * @packageDocumentation
+ */
+/**
+ * A partner clicks "Cancel" or "Continue" in the Mailchimp campaign send confirmation modal.
+ *
+ * This schema describes events sent to Segment from [[OsClickedSendConfirmation]]
+ *
+ * @example Continue
+ * ```
+ * {
+ *   action: "clickedSendConfirmation",
+ *   context_module: "sendConfirmationModal",
+ *   context_page_owner_type: "studioMailchimp",
+ *   value: "continue"
+ * }
+ * ```
+ *
+ * @example Cancel
+ * ```
+ * {
+ *   action: "clickedSendConfirmation",
+ *   context_module: "sendConfirmationModal",
+ *   context_page_owner_type: "studioMailchimp",
+ *   value: "cancel"
+ * }
+ * ```
+ */
+export interface OsClickedSendConfirmation {
+    action: OsActionType.clickedSendConfirmation;
+    context_module: OsContextModule.sendConfirmationModal;
+    context_page_owner_type: OsOwnerType.studioMailchimp;
+    value: "cancel" | "continue";
+}
+/**
+ * A partner sends a Mailchimp campaign or downloads a PDF from the Mailchimp editor.
+ *
+ * `content` is a generic catch-all holding campaign metadata fields: artworkTitle,
+ * artistNames, subject, recipientCount, etc. It is kept generic so the same pattern
+ * can serve multiple studio surfaces.
+ *
+ * This schema describes events sent to Segment from [[OsCreatedMailchimpContent]]
+ *
+ * @example Send campaign
+ * ```
+ * {
+ *   action: "createdStudioContent",
+ *   context_module: "mailchimpEditor",
+ *   context_page_owner_type: "studioMailchimp",
+ *   value: "mailchimp campaign",
+ *   brand_kit: true,
+ *   content: {
+ *     artworkTitle: "Xpto",
+ *     artistNames: ["Jane Doe", "John Doe"],
+ *     subject: "New artwork available",
+ *     recipientCount: 150
+ *   }
+ * }
+ * ```
+ *
+ * @example PDF download
+ * ```
+ * {
+ *   action: "createdStudioContent",
+ *   context_module: "mailchimpEditor",
+ *   context_page_owner_type: "studioMailchimp",
+ *   value: "pdf download",
+ *   brand_kit: false,
+ *   content: {
+ *     artworkTitle: "Xpto",
+ *     artistNames: ["Jane Doe", "John Doe"]
+ *   }
+ * }
+ * ```
+ */
+export interface OsCreatedMailchimpContent {
+    action: OsActionType.createdStudioContent;
+    context_module: OsContextModule.mailchimpEditor;
+    context_page_owner_type: OsOwnerType.studioMailchimp;
+    value: "mailchimp campaign" | "pdf download";
+    brand_kit: boolean;
+    /** Generic catch-all for campaign metadata included in the created content */
+    content: Record<string, unknown>;
+}
+export type OsMailchimpEditor = OsClickedSendConfirmation | OsCreatedMailchimpContent;

package/dist/Schema/os/Events/MailchimpEditor.js

@@ -0,0 +1 @@
+"use strict";

package/dist/Schema/os/Events/__tests__/MailchimpEditor.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/Schema/os/Events/index.d.ts

@@ -4,6 +4,7 @@ import { OsConnectedAppsFlow } from "./ConnectedAppsFlow";
 import { OsFilterSortSearch } from "./FilterSortSearch";
 import { OsInstagramEditor } from "./InstagramEditor";
 import { OsInventoryTable } from "./InventoryTable";
+import { OsMailchimpEditor } from "./MailchimpEditor";
 import { OsMaterialsEditor } from "./MaterialsEditor";
 import { OsMultiAddFlow } from "./MultiAddFlow";
 import { OsSubmitEvent } from "./Submit";
@@ -13,7 +14,7 @@ import { OsToggleEvent } from "./Toggle";
  *
  * Each event describes one ActionType
  */
-export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMaterialsEditor | OsSubmitEvent | OsToggleEvent;
+export type OsEvent = OsMultiAddFlow | ClickedBrandKitColor | ClickedBrandKitFont | ClickedAddBrandKitFile | ClickedSaveBrandKit | OsConnectedAppsFlow | OsClickEvent | OsFilterSortSearch | OsInstagramEditor | OsInventoryTable | OsMailchimpEditor | OsMaterialsEditor | OsSubmitEvent | OsToggleEvent;
 /**
  * List of all Art OS actions
  *
@@ -117,6 +118,10 @@ export declare enum OsActionType {
      * Corresponds to {@link OsInstagramEditor}
      */
     clickedPublishConfirmation = "clickedPublishConfirmation",
+    /**
+     * Corresponds to {@link OsMailchimpEditor}
+     */
+    clickedSendConfirmation = "clickedSendConfirmation",
     /**
      * Corresponds to {@link OsInstagramEditor}
      */
@@ -146,7 +151,8 @@ export declare enum OsActionType {
      */
     createdList = "createdList",
     /**
-     * Corresponds to {@link OsMaterialsEditor} and {@link OsInstagramEditor}
+     * Corresponds to {@link OsMaterialsEditor}, {@link OsInstagramEditor}, and
+     * {@link OsMailchimpEditor}
      */
     createdStudioContent = "createdStudioContent",
     /**

package/dist/Schema/os/Events/index.js

@@ -45,6 +45,7 @@ exports.OsActionType = OsActionType;
   OsActionType["clickedImagesModal"] = "clickedImagesModal";
   OsActionType["clickedOpenList"] = "clickedOpenList";
   OsActionType["clickedPublishConfirmation"] = "clickedPublishConfirmation";
+  OsActionType["clickedSendConfirmation"] = "clickedSendConfirmation";
   OsActionType["clickedUploadImageBank"] = "clickedUploadImageBank";
   OsActionType["completedArtworkDistribution"] = "completedArtworkDistribution";
   OsActionType["completedArtworkImport"] = "completedArtworkImport";

package/dist/Schema/os/Values/OsContextModule.d.ts

@@ -29,9 +29,11 @@ export declare enum OsContextModule {
     instagramEditor = "instagramEditor",
     listCard = "listCard",
     listDetail = "listDetail",
+    mailchimpEditor = "mailchimpEditor",
     materialsEditor = "materialsEditor",
     multiAdd = "multiAdd",
     multiAddReview = "multiAddReview",
     publishConfirmationModal = "publishConfirmationModal",
+    sendConfirmationModal = "sendConfirmationModal",
     tableActions = "tableActions"
 }

package/dist/Schema/os/Values/OsContextModule.js

@@ -39,9 +39,11 @@ exports.OsContextModule = OsContextModule;
   OsContextModule["instagramEditor"] = "instagramEditor";
   OsContextModule["listCard"] = "listCard";
   OsContextModule["listDetail"] = "listDetail";
+  OsContextModule["mailchimpEditor"] = "mailchimpEditor";
   OsContextModule["materialsEditor"] = "materialsEditor";
   OsContextModule["multiAdd"] = "multiAdd";
   OsContextModule["multiAddReview"] = "multiAddReview";
   OsContextModule["publishConfirmationModal"] = "publishConfirmationModal";
+  OsContextModule["sendConfirmationModal"] = "sendConfirmationModal";
   OsContextModule["tableActions"] = "tableActions";
 })(OsContextModule || (exports.OsContextModule = OsContextModule = {}));

package/dist/Schema/os/Values/OsOwnerType.d.ts

@@ -9,5 +9,6 @@ export declare enum OsOwnerType {
     inventory = "inventory",
     studio = "studio",
     studioInstagram = "studioInstagram",
+    studioMailchimp = "studioMailchimp",
     studioMaterials = "studioMaterials"
 }

package/dist/Schema/os/Values/OsOwnerType.js

@@ -19,5 +19,6 @@ exports.OsOwnerType = OsOwnerType;
   OsOwnerType["inventory"] = "inventory";
   OsOwnerType["studio"] = "studio";
   OsOwnerType["studioInstagram"] = "studioInstagram";
+  OsOwnerType["studioMailchimp"] = "studioMailchimp";
   OsOwnerType["studioMaterials"] = "studioMaterials";
 })(OsOwnerType || (exports.OsOwnerType = OsOwnerType = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@artsy/cohesion",
-  "version": "4.376.0",
+  "version": "4.377.0--canary.723.15425.0",
   "description": "Analytics schema",
   "main": "dist/index.js",
   "publishConfig": {