@happyvertical/smrt-marketing 0.57.36 → 0.57.38

package/dist/recipes.d.ts

@@ -0,0 +1,168 @@
+/**
+ * Declared recipes for smrt-marketing (#4409, #4437): user-facing units of
+ * functionality an app or agent can pick instead of the whole package.
+ * The scanner reads these statics into the `recipes` array of `manifest.json`
+ * and `smrt-knowledge.json`; nothing here runs at that point.
+ *
+ * @packageDocumentation
+ */
+import { SmrtRecipe } from '@happyvertical/smrt-core';
+import { Campaign } from './models/Campaign.js';
+import { CampaignChannel } from './models/CampaignChannel.js';
+import { CampaignMetricSnapshot } from './models/CampaignMetricSnapshot.js';
+/** Campaigns: Plan a campaign, choose where it runs and see what it brought in. */
+export declare class MarketingCampaignsRecipe extends SmrtRecipe {
+    static id: string;
+    static help: string;
+    static label: string;
+    static summary: string;
+    static synonyms: string[];
+    static section: {
+        id: string;
+        label: string;
+        icon: string;
+        description: string;
+    };
+    static models: (typeof Campaign | typeof CampaignChannel | typeof CampaignMetricSnapshot)[];
+    static nav: ({
+        label: string;
+        model: typeof Campaign;
+        icon: string;
+        description: string;
+        noun: string;
+    } | {
+        label: string;
+        model: typeof CampaignChannel;
+        icon: string;
+        description: string;
+        noun: string;
+    })[];
+    static options: {
+        readonly Campaign: {
+            readonly fields: {
+                readonly name: {
+                    readonly order: 1;
+                };
+                readonly objective: {
+                    readonly order: 2;
+                };
+                readonly status: {
+                    readonly order: 3;
+                };
+                readonly startAt: {
+                    readonly label: "Starts";
+                    readonly order: 4;
+                };
+                readonly endAt: {
+                    readonly label: "Ends";
+                    readonly order: 5;
+                };
+                readonly budgetCents: {
+                    readonly label: "Budget (cents)";
+                    readonly order: 6;
+                };
+                readonly currency: {
+                    readonly order: 7;
+                };
+                readonly customerId: {
+                    readonly label: "Customer";
+                    readonly visibility: "advanced";
+                };
+                readonly campaignKey: {
+                    readonly label: "Reference";
+                    readonly visibility: "advanced";
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly metadata: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly CampaignChannel: {
+            readonly fields: {
+                readonly campaignId: {
+                    readonly label: "Campaign";
+                    readonly order: 1;
+                };
+                readonly channelKind: {
+                    readonly label: "Kind";
+                    readonly order: 2;
+                };
+                readonly channelRef: {
+                    readonly label: "Name";
+                    readonly order: 3;
+                };
+                readonly allocatedBudgetCents: {
+                    readonly label: "Budget share (cents)";
+                    readonly order: 4;
+                };
+                readonly status: {
+                    readonly order: 5;
+                };
+                readonly startAt: {
+                    readonly label: "Starts";
+                    readonly order: 6;
+                };
+                readonly endAt: {
+                    readonly label: "Ends";
+                    readonly order: 7;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+        readonly CampaignMetricSnapshot: {
+            readonly fields: {
+                readonly campaignId: {
+                    readonly label: "Campaign";
+                    readonly order: 1;
+                };
+                readonly campaignChannelId: {
+                    readonly label: "Channel";
+                    readonly order: 2;
+                };
+                readonly periodStart: {
+                    readonly label: "From";
+                    readonly order: 3;
+                };
+                readonly periodEnd: {
+                    readonly label: "To";
+                    readonly order: 4;
+                };
+                readonly spendCents: {
+                    readonly label: "Spend (cents)";
+                    readonly order: 5;
+                };
+                readonly impressions: {
+                    readonly order: 6;
+                };
+                readonly clicks: {
+                    readonly order: 7;
+                };
+                readonly conversions: {
+                    readonly order: 8;
+                };
+                readonly leads: {
+                    readonly order: 9;
+                };
+                readonly revenueCents: {
+                    readonly label: "Revenue (cents)";
+                    readonly order: 10;
+                };
+                readonly source: {
+                    readonly order: 11;
+                };
+                readonly tenantId: {
+                    readonly visibility: "hidden";
+                };
+                readonly dedupeKey: {
+                    readonly visibility: "hidden";
+                };
+            };
+        };
+    };
+}
+//# sourceMappingURL=recipes.d.ts.map

package/dist/recipes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../src/recipes.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAChD,OAAO,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAC9D,OAAO,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AAE5E,mFAAmF;AACnF,qBAAa,wBAAyB,SAAQ,UAAU;IACtD,MAAM,CAAC,EAAE,SAAyB;IAClC,MAAM,CAAC,IAAI,SAA2B;IACtC,MAAM,CAAC,KAAK,SAAe;IAC3B,MAAM,CAAC,OAAO,SAC4F;IAC1G,MAAM,CAAC,QAAQ,WAOb;IACF,MAAM,CAAC,OAAO;;;;;MAKZ;IACF,MAAM,CAAC,MAAM,+EAAuD;IACpE,MAAM,CAAC,GAAG;;;;;;;;;;;;SAiBR;IACF,MAAM,CAAC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;MA6CH;CACZ"}