npm - @marlinjai/mail-sdk - Versions diffs - 0.9.0 → 0.11.0 - Mend

@marlinjai/mail-sdk 0.9.0 → 0.11.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.

Files changed (6) hide show

package/README.md CHANGED Viewed

@@ -157,6 +157,15 @@ What each piece does, and why:
   recorded as a miss (`matched: false` in `insertions` on `message.sent`, and in
   `mailings.languages`), so a drift between your form and the template shows up
   instead of passing silently.
+- **Values for this one letter** go in `merge` on `mailings.create` (or
+  `mailings.update` while it is a draft): the same for everyone who gets the
+  mailing, above the contact's stored values and the workspace's defaults,
+  below a recipient's own. On a letter it may hold the reader's `first_name`
+  and `last_name`. `mail.mailings.resolve(id, { recipients })` is a dry run:
+  it answers what each recipient would be sent (every value's text and where
+  it comes from) without adding anybody, and `blocking` lists what would
+  refuse the send. A send in which a value inside a link's address is empty
+  for a recipient is refused with `unfilled_link` (422).
 - **The provider** (`provider_id`, required) is the sending account the
   workspace has set up: find its id with `mail.providers.list()` or on the
   dashboard's Providers page, and keep it in configuration next to the

package/dist/index.d.mts CHANGED Viewed

@@ -1238,10 +1238,10 @@ declare function createNamespaces(config: CoreConfig): {
                     anomaly: {
                         at: string;
                         reason: string;
+                        blocking: boolean;
                         mailing_id: string | null;
                         sample: string;
                         scope: "mailing" | "provider";
-                        blocking: boolean;
                     } | null;
                 };
                 from_name: string;
@@ -1267,10 +1267,10 @@ declare function createNamespaces(config: CoreConfig): {
                     anomaly: {
                         at: string;
                         reason: string;
+                        blocking: boolean;
                         mailing_id: string | null;
                         sample: string;
                         scope: "mailing" | "provider";
-                        blocking: boolean;
                     } | null;
                 };
                 from_name: string;
@@ -1311,10 +1311,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1340,10 +1340,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1382,10 +1382,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1411,10 +1411,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1453,10 +1453,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1482,10 +1482,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1538,10 +1538,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1567,10 +1567,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1610,10 +1610,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1639,10 +1639,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1764,6 +1764,10 @@ declare function createNamespaces(config: CoreConfig): {
         }>;
         messages: (id: string, query?: RouteQuery<"contacts.messages">, opts?: RequestOpts) => Promise<{
             data: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }> | null;
                 id: string;
                 error: string | null;
                 subject: string;
@@ -1774,11 +1778,11 @@ declare function createNamespaces(config: CoreConfig): {
                 }> | null;
                 locale: string | null;
                 created_at: string;
+                contact_id: string | null;
                 provider_id: string;
                 to: string;
                 provider_message_id: string | null;
                 mailing_id: string | null;
-                contact_id: string | null;
                 recipient_id: string | null;
                 outcome: "sent" | "failed";
                 is_test: boolean;
@@ -1793,13 +1797,13 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
+                contact_id: string;
                 automation: {
                     status: "draft" | "archived" | "paused" | "active";
                     id: string;
                     name: string;
                 };
                 automation_id: string;
-                contact_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -1843,6 +1847,7 @@ declare function createNamespaces(config: CoreConfig): {
             data: {
                 status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
                 id: string;
+                merge: Record<string, string | number | boolean>;
                 name: string | null;
                 kind: "broadcast" | "automation" | "notification";
                 template_id: string | null;
@@ -1853,6 +1858,7 @@ declare function createNamespaces(config: CoreConfig): {
                 created_at: string;
                 updated_at: string;
                 send_locale: string | null;
+                template_locale: string | null;
                 topic: string | null;
                 provider_id: string;
                 counts: {
@@ -1888,6 +1894,7 @@ declare function createNamespaces(config: CoreConfig): {
         create: (body: RouteBody<"mailings.create">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -1905,6 +1912,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -1938,6 +1946,7 @@ declare function createNamespaces(config: CoreConfig): {
         get: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -1955,6 +1964,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -1990,6 +2000,7 @@ declare function createNamespaces(config: CoreConfig): {
         update: (id: string, body: RouteBody<"mailings.update">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2007,6 +2018,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2053,9 +2065,9 @@ declare function createNamespaces(config: CoreConfig): {
                 merge: Record<string, _marlinjai_mail_contract.JsonValue>;
                 created_at: string;
                 updated_at: string;
+                contact_id: string | null;
                 message_id: string | null;
                 mailing_id: string;
-                contact_id: string | null;
                 skip_reason: "cancelled" | "suppressed" | "not_subscribed" | "contact_erased" | "outcome_unknown" | null;
                 attempts: number;
                 last_error: string | null;
@@ -2066,9 +2078,50 @@ declare function createNamespaces(config: CoreConfig): {
             message_id: string;
             provider_message_id: string | null;
         }>;
+        /**
+         * A dry run: what each given recipient would be sent (every value's text
+         * and the layer it comes from, each insertion's choice, the problems
+         * found), without adding anybody. Without recipients: a reader with
+         * nothing of their own.
+         */
+        resolve: (id: string, body?: RouteBody<"mailings.resolve">, opts?: RequestOpts) => Promise<{
+            recipients: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }>;
+                email: string | null;
+                subject: string;
+                insertions: Record<string, {
+                    value: string | null;
+                    chosen: string;
+                    matched: boolean;
+                }> | null;
+                locale: string;
+                index: number | null;
+                contact_id: string | null;
+                problems: {
+                    value: string;
+                    message: string;
+                    kind: "unfilled_link" | "empty_value" | "insertion_miss";
+                    severity: "note" | "blocking";
+                }[];
+            }[];
+            blocking: {
+                value: string;
+                recipients: number;
+            }[];
+            rejected: {
+                reason: "unknown_contact" | "duplicate_in_batch";
+                index: number;
+            }[];
+            names: string[];
+            link_values: string[];
+        }>;
         send: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2086,6 +2139,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2119,6 +2173,7 @@ declare function createNamespaces(config: CoreConfig): {
         pause: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2136,6 +2191,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2169,6 +2225,7 @@ declare function createNamespaces(config: CoreConfig): {
         resume: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2186,6 +2243,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2219,6 +2277,7 @@ declare function createNamespaces(config: CoreConfig): {
         cancel: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2236,6 +2295,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2269,6 +2329,7 @@ declare function createNamespaces(config: CoreConfig): {
         retryFailed: (id: string, body?: RouteBody<"mailings.retryFailed">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2286,6 +2347,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2319,6 +2381,7 @@ declare function createNamespaces(config: CoreConfig): {
         duplicate: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2336,6 +2399,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2377,6 +2441,7 @@ declare function createNamespaces(config: CoreConfig): {
         schedule: (id: string, body: RouteBody<"mailings.schedule">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2394,6 +2459,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2427,6 +2493,7 @@ declare function createNamespaces(config: CoreConfig): {
         unschedule: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2444,6 +2511,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2477,6 +2545,7 @@ declare function createNamespaces(config: CoreConfig): {
         setAbTest: (id: string, body: RouteBody<"mailings.setAbTest">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2494,6 +2563,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2527,6 +2597,7 @@ declare function createNamespaces(config: CoreConfig): {
         clearAbTest: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2544,6 +2615,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2577,6 +2649,7 @@ declare function createNamespaces(config: CoreConfig): {
         pickAbWinner: (id: string, body: RouteBody<"mailings.pickAbWinner">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2594,6 +2667,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2664,12 +2738,12 @@ declare function createNamespaces(config: CoreConfig): {
                 sent: number;
                 planned: number;
             }[];
-            send_locale: string | null;
-            main_locale: string;
             fallback: {
                 planned: number;
                 wanted: string;
             }[];
+            send_locale: string | null;
+            main_locale: string;
             no_language: number;
             insertion_misses: {
                 value: string;
@@ -2682,6 +2756,10 @@ declare function createNamespaces(config: CoreConfig): {
     messages: {
         list: (query?: RouteQuery<"messages.list">, opts?: RequestOpts) => Promise<{
             data: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }> | null;
                 id: string;
                 error: string | null;
                 subject: string;
@@ -2692,11 +2770,11 @@ declare function createNamespaces(config: CoreConfig): {
                 }> | null;
                 locale: string | null;
                 created_at: string;
+                contact_id: string | null;
                 provider_id: string;
                 to: string;
                 provider_message_id: string | null;
                 mailing_id: string | null;
-                contact_id: string | null;
                 recipient_id: string | null;
                 outcome: "sent" | "failed";
                 is_test: boolean;
@@ -2705,6 +2783,10 @@ declare function createNamespaces(config: CoreConfig): {
             next_cursor: string | null;
         }>;
         get: (id: string, opts?: RequestOpts) => Promise<{
+            values: Record<string, {
+                text: string;
+                layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+            }> | null;
             id: string;
             error: string | null;
             subject: string;
@@ -2716,11 +2798,11 @@ declare function createNamespaces(config: CoreConfig): {
             locale: string | null;
             created_at: string;
             html: string;
+            contact_id: string | null;
             provider_id: string;
             to: string;
             provider_message_id: string | null;
             mailing_id: string | null;
-            contact_id: string | null;
             recipient_id: string | null;
             outcome: "sent" | "failed";
             is_test: boolean;
@@ -5068,7 +5150,7 @@ declare function createNamespaces(config: CoreConfig): {
             entered: number;
             refused: number;
             results: {
-                reason: "suppressed" | "not_subscribed" | "unknown_contact" | "already_inside" | "re_entry_off" | "in_cooldown" | "excluded" | "not_active" | null;
+                reason: "unknown_contact" | "suppressed" | "not_subscribed" | "already_inside" | "re_entry_off" | "in_cooldown" | "excluded" | "not_active" | null;
                 email: string | null;
                 contact_id: string | null;
                 external_id: string | null;
@@ -5086,8 +5168,8 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
-                automation_id: string;
                 contact_id: string;
+                automation_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -5114,8 +5196,8 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
-                automation_id: string;
                 contact_id: string;
+                automation_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -5131,8 +5213,8 @@ declare function createNamespaces(config: CoreConfig): {
             id: string;
             email: string;
             version: number;
-            automation_id: string;
             contact_id: string;
+            automation_id: string;
             last_error: string | null;
             external_id: string | null;
             current_step_id: string | null;

package/dist/index.d.ts CHANGED Viewed

@@ -1238,10 +1238,10 @@ declare function createNamespaces(config: CoreConfig): {
                     anomaly: {
                         at: string;
                         reason: string;
+                        blocking: boolean;
                         mailing_id: string | null;
                         sample: string;
                         scope: "mailing" | "provider";
-                        blocking: boolean;
                     } | null;
                 };
                 from_name: string;
@@ -1267,10 +1267,10 @@ declare function createNamespaces(config: CoreConfig): {
                     anomaly: {
                         at: string;
                         reason: string;
+                        blocking: boolean;
                         mailing_id: string | null;
                         sample: string;
                         scope: "mailing" | "provider";
-                        blocking: boolean;
                     } | null;
                 };
                 from_name: string;
@@ -1311,10 +1311,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1340,10 +1340,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1382,10 +1382,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1411,10 +1411,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1453,10 +1453,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1482,10 +1482,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1538,10 +1538,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1567,10 +1567,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1610,10 +1610,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1639,10 +1639,10 @@ declare function createNamespaces(config: CoreConfig): {
                 anomaly: {
                     at: string;
                     reason: string;
+                    blocking: boolean;
                     mailing_id: string | null;
                     sample: string;
                     scope: "mailing" | "provider";
-                    blocking: boolean;
                 } | null;
             };
             from_name: string;
@@ -1764,6 +1764,10 @@ declare function createNamespaces(config: CoreConfig): {
         }>;
         messages: (id: string, query?: RouteQuery<"contacts.messages">, opts?: RequestOpts) => Promise<{
             data: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }> | null;
                 id: string;
                 error: string | null;
                 subject: string;
@@ -1774,11 +1778,11 @@ declare function createNamespaces(config: CoreConfig): {
                 }> | null;
                 locale: string | null;
                 created_at: string;
+                contact_id: string | null;
                 provider_id: string;
                 to: string;
                 provider_message_id: string | null;
                 mailing_id: string | null;
-                contact_id: string | null;
                 recipient_id: string | null;
                 outcome: "sent" | "failed";
                 is_test: boolean;
@@ -1793,13 +1797,13 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
+                contact_id: string;
                 automation: {
                     status: "draft" | "archived" | "paused" | "active";
                     id: string;
                     name: string;
                 };
                 automation_id: string;
-                contact_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -1843,6 +1847,7 @@ declare function createNamespaces(config: CoreConfig): {
             data: {
                 status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
                 id: string;
+                merge: Record<string, string | number | boolean>;
                 name: string | null;
                 kind: "broadcast" | "automation" | "notification";
                 template_id: string | null;
@@ -1853,6 +1858,7 @@ declare function createNamespaces(config: CoreConfig): {
                 created_at: string;
                 updated_at: string;
                 send_locale: string | null;
+                template_locale: string | null;
                 topic: string | null;
                 provider_id: string;
                 counts: {
@@ -1888,6 +1894,7 @@ declare function createNamespaces(config: CoreConfig): {
         create: (body: RouteBody<"mailings.create">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -1905,6 +1912,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -1938,6 +1946,7 @@ declare function createNamespaces(config: CoreConfig): {
         get: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -1955,6 +1964,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -1990,6 +2000,7 @@ declare function createNamespaces(config: CoreConfig): {
         update: (id: string, body: RouteBody<"mailings.update">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2007,6 +2018,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2053,9 +2065,9 @@ declare function createNamespaces(config: CoreConfig): {
                 merge: Record<string, _marlinjai_mail_contract.JsonValue>;
                 created_at: string;
                 updated_at: string;
+                contact_id: string | null;
                 message_id: string | null;
                 mailing_id: string;
-                contact_id: string | null;
                 skip_reason: "cancelled" | "suppressed" | "not_subscribed" | "contact_erased" | "outcome_unknown" | null;
                 attempts: number;
                 last_error: string | null;
@@ -2066,9 +2078,50 @@ declare function createNamespaces(config: CoreConfig): {
             message_id: string;
             provider_message_id: string | null;
         }>;
+        /**
+         * A dry run: what each given recipient would be sent (every value's text
+         * and the layer it comes from, each insertion's choice, the problems
+         * found), without adding anybody. Without recipients: a reader with
+         * nothing of their own.
+         */
+        resolve: (id: string, body?: RouteBody<"mailings.resolve">, opts?: RequestOpts) => Promise<{
+            recipients: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }>;
+                email: string | null;
+                subject: string;
+                insertions: Record<string, {
+                    value: string | null;
+                    chosen: string;
+                    matched: boolean;
+                }> | null;
+                locale: string;
+                index: number | null;
+                contact_id: string | null;
+                problems: {
+                    value: string;
+                    message: string;
+                    kind: "unfilled_link" | "empty_value" | "insertion_miss";
+                    severity: "note" | "blocking";
+                }[];
+            }[];
+            blocking: {
+                value: string;
+                recipients: number;
+            }[];
+            rejected: {
+                reason: "unknown_contact" | "duplicate_in_batch";
+                index: number;
+            }[];
+            names: string[];
+            link_values: string[];
+        }>;
         send: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2086,6 +2139,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2119,6 +2173,7 @@ declare function createNamespaces(config: CoreConfig): {
         pause: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2136,6 +2191,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2169,6 +2225,7 @@ declare function createNamespaces(config: CoreConfig): {
         resume: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2186,6 +2243,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2219,6 +2277,7 @@ declare function createNamespaces(config: CoreConfig): {
         cancel: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2236,6 +2295,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2269,6 +2329,7 @@ declare function createNamespaces(config: CoreConfig): {
         retryFailed: (id: string, body?: RouteBody<"mailings.retryFailed">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2286,6 +2347,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2319,6 +2381,7 @@ declare function createNamespaces(config: CoreConfig): {
         duplicate: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2336,6 +2399,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2377,6 +2441,7 @@ declare function createNamespaces(config: CoreConfig): {
         schedule: (id: string, body: RouteBody<"mailings.schedule">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2394,6 +2459,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2427,6 +2493,7 @@ declare function createNamespaces(config: CoreConfig): {
         unschedule: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2444,6 +2511,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2477,6 +2545,7 @@ declare function createNamespaces(config: CoreConfig): {
         setAbTest: (id: string, body: RouteBody<"mailings.setAbTest">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2494,6 +2563,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2527,6 +2597,7 @@ declare function createNamespaces(config: CoreConfig): {
         clearAbTest: (id: string, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2544,6 +2615,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2577,6 +2649,7 @@ declare function createNamespaces(config: CoreConfig): {
         pickAbWinner: (id: string, body: RouteBody<"mailings.pickAbWinner">, opts?: RequestOpts) => Promise<{
             status: "draft" | "scheduled" | "sending" | "paused" | "sent" | "partially_failed" | "cancelled";
             id: string;
+            merge: Record<string, string | number | boolean>;
             name: string | null;
             kind: "broadcast" | "automation" | "notification";
             template_id: string | null;
@@ -2594,6 +2667,7 @@ declare function createNamespaces(config: CoreConfig): {
             created_at: string;
             updated_at: string;
             send_locale: string | null;
+            template_locale: string | null;
             topic: string | null;
             provider_id: string;
             counts: {
@@ -2664,12 +2738,12 @@ declare function createNamespaces(config: CoreConfig): {
                 sent: number;
                 planned: number;
             }[];
-            send_locale: string | null;
-            main_locale: string;
             fallback: {
                 planned: number;
                 wanted: string;
             }[];
+            send_locale: string | null;
+            main_locale: string;
             no_language: number;
             insertion_misses: {
                 value: string;
@@ -2682,6 +2756,10 @@ declare function createNamespaces(config: CoreConfig): {
     messages: {
         list: (query?: RouteQuery<"messages.list">, opts?: RequestOpts) => Promise<{
             data: {
+                values: Record<string, {
+                    text: string;
+                    layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+                }> | null;
                 id: string;
                 error: string | null;
                 subject: string;
@@ -2692,11 +2770,11 @@ declare function createNamespaces(config: CoreConfig): {
                 }> | null;
                 locale: string | null;
                 created_at: string;
+                contact_id: string | null;
                 provider_id: string;
                 to: string;
                 provider_message_id: string | null;
                 mailing_id: string | null;
-                contact_id: string | null;
                 recipient_id: string | null;
                 outcome: "sent" | "failed";
                 is_test: boolean;
@@ -2705,6 +2783,10 @@ declare function createNamespaces(config: CoreConfig): {
             next_cursor: string | null;
         }>;
         get: (id: string, opts?: RequestOpts) => Promise<{
+            values: Record<string, {
+                text: string;
+                layer: "contact" | "recipient" | "mailing" | "workspace" | "fallback" | "empty";
+            }> | null;
             id: string;
             error: string | null;
             subject: string;
@@ -2716,11 +2798,11 @@ declare function createNamespaces(config: CoreConfig): {
             locale: string | null;
             created_at: string;
             html: string;
+            contact_id: string | null;
             provider_id: string;
             to: string;
             provider_message_id: string | null;
             mailing_id: string | null;
-            contact_id: string | null;
             recipient_id: string | null;
             outcome: "sent" | "failed";
             is_test: boolean;
@@ -5068,7 +5150,7 @@ declare function createNamespaces(config: CoreConfig): {
             entered: number;
             refused: number;
             results: {
-                reason: "suppressed" | "not_subscribed" | "unknown_contact" | "already_inside" | "re_entry_off" | "in_cooldown" | "excluded" | "not_active" | null;
+                reason: "unknown_contact" | "suppressed" | "not_subscribed" | "already_inside" | "re_entry_off" | "in_cooldown" | "excluded" | "not_active" | null;
                 email: string | null;
                 contact_id: string | null;
                 external_id: string | null;
@@ -5086,8 +5168,8 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
-                automation_id: string;
                 contact_id: string;
+                automation_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -5114,8 +5196,8 @@ declare function createNamespaces(config: CoreConfig): {
                 id: string;
                 email: string;
                 version: number;
-                automation_id: string;
                 contact_id: string;
+                automation_id: string;
                 last_error: string | null;
                 external_id: string | null;
                 current_step_id: string | null;
@@ -5131,8 +5213,8 @@ declare function createNamespaces(config: CoreConfig): {
             id: string;
             email: string;
             version: number;
-            automation_id: string;
             contact_id: string;
+            automation_id: string;
             last_error: string | null;
             external_id: string | null;
             current_step_id: string | null;

package/dist/index.js CHANGED Viewed

@@ -559,6 +559,13 @@ function createNamespaces(config) {
       addRecipients: (id, body, opts) => execute(config, "mailings.addRecipients", { params: { id }, body }, opts),
       listRecipients: (id, query, opts) => execute(config, "mailings.listRecipients", { params: { id }, query }, opts),
       test: (id, body, opts) => execute(config, "mailings.test", { params: { id }, body }, opts),
+      /**
+       * A dry run: what each given recipient would be sent (every value's text
+       * and the layer it comes from, each insertion's choice, the problems
+       * found), without adding anybody. Without recipients: a reader with
+       * nothing of their own.
+       */
+      resolve: (id, body = {}, opts) => execute(config, "mailings.resolve", { params: { id }, body }, opts),
       send: (id, opts) => execute(config, "mailings.send", { params: { id }, body: {} }, opts),
       pause: (id, opts) => execute(config, "mailings.pause", { params: { id }, body: {} }, opts),
       resume: (id, opts) => execute(config, "mailings.resume", { params: { id }, body: {} }, opts),

package/dist/index.mjs CHANGED Viewed

@@ -543,6 +543,13 @@ function createNamespaces(config) {
       addRecipients: (id, body, opts) => execute(config, "mailings.addRecipients", { params: { id }, body }, opts),
       listRecipients: (id, query, opts) => execute(config, "mailings.listRecipients", { params: { id }, query }, opts),
       test: (id, body, opts) => execute(config, "mailings.test", { params: { id }, body }, opts),
+      /**
+       * A dry run: what each given recipient would be sent (every value's text
+       * and the layer it comes from, each insertion's choice, the problems
+       * found), without adding anybody. Without recipients: a reader with
+       * nothing of their own.
+       */
+      resolve: (id, body = {}, opts) => execute(config, "mailings.resolve", { params: { id }, body }, opts),
       send: (id, opts) => execute(config, "mailings.send", { params: { id }, body: {} }, opts),
       pause: (id, opts) => execute(config, "mailings.pause", { params: { id }, body: {} }, opts),
       resume: (id, opts) => execute(config, "mailings.resume", { params: { id }, body: {} }, opts),

package/package.json CHANGED Viewed

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Typed client for the Lumitra Mail v1 API: Node and edge runtimes, retries with idempotency, cursor pagination, webhook verification",
   "license": "MIT",
   "repository": {
@@ -32,7 +32,7 @@
     "LICENSE"
   ],
   "dependencies": {
-    "@marlinjai/mail-contract": "^0.9.0"
+    "@marlinjai/mail-contract": "^0.11.0"
   },
   "peerDependencies": {
     "zod": "^3.25.0"