@marlinjai/mail-contract 0.14.0 → 0.15.1

package/dist/index.js

@@ -511,6 +511,7 @@ __export(index_exports, {
   billingRoutes: () => billingRoutes,
   buildPath: () => buildPath,
   buildTemplatePatch: () => buildTemplatePatch,
+  canDeleteMailing: () => canDeleteMailing,
   canTransition: () => canTransition,
   canonicalLocale: () => canonicalLocale,
   choiceKeyProblem: () => choiceKeyProblem,
@@ -1834,6 +1835,10 @@ var Mailing = import_zod8.z.object({
   updated_at: Timestamp
 });
 var MailingSummary = Mailing.omit({ document: true });
+function canDeleteMailing(mailing) {
+  if (mailing.kind !== "broadcast") return false;
+  return mailing.status === "draft" || mailing.status === "cancelled" && mailing.started_at === null;
+}
 var MailingContent = {
   name: import_zod8.z.string().max(200).optional(),
   subject: import_zod8.z.string().min(1).max(998),
@@ -3617,6 +3622,7 @@ var AUDIT_ACTIONS = [
   "mailing.paused",
   "mailing.resumed",
   "mailing.cancelled",
+  "mailing.deleted",
   "mailing.retried",
   "webhook.created",
   "webhook.updated",
@@ -5746,6 +5752,25 @@ var sendingRoutes = {
     access: "write",
     phase: "S2"
   },
+  /**
+   * Deletes a mailing that never started: a broadcast in `draft`, or one
+   * `cancelled` before any send began (`canDeleteMailing`). Its recipients,
+   * A/B variants and compiled content go with it. Test sends made from it stay
+   * in the archive, with `mailing_id` null: they are mail that really went out.
+   * Anything else is `mailing_invalid_state` (409): a scheduled mailing is
+   * unscheduled first, and a mailing that started is the record of what was
+   * sent. An automation's mailing is `conflict`; a transactional letter is
+   * deleted only by a key that may write one (`forbidden`).
+   */
+  "mailings.delete": {
+    method: "DELETE",
+    path: "/v1/mailings/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "write",
+    phase: "S2"
+  },
   "mailings.retryFailed": {
     method: "POST",
     path: "/v1/mailings/:id/retry-failed",
@@ -7003,6 +7028,7 @@ function matchRoute(method, pathname) {
   billingRoutes,
   buildPath,
   buildTemplatePatch,
+  canDeleteMailing,
   canTransition,
   canonicalLocale,
   choiceKeyProblem,

package/dist/index.mjs

@@ -1195,6 +1195,10 @@ var Mailing = z8.object({
   updated_at: Timestamp
 });
 var MailingSummary = Mailing.omit({ document: true });
+function canDeleteMailing(mailing) {
+  if (mailing.kind !== "broadcast") return false;
+  return mailing.status === "draft" || mailing.status === "cancelled" && mailing.started_at === null;
+}
 var MailingContent = {
   name: z8.string().max(200).optional(),
   subject: z8.string().min(1).max(998),
@@ -2978,6 +2982,7 @@ var AUDIT_ACTIONS = [
   "mailing.paused",
   "mailing.resumed",
   "mailing.cancelled",
+  "mailing.deleted",
   "mailing.retried",
   "webhook.created",
   "webhook.updated",
@@ -5107,6 +5112,25 @@ var sendingRoutes = {
     access: "write",
     phase: "S2"
   },
+  /**
+   * Deletes a mailing that never started: a broadcast in `draft`, or one
+   * `cancelled` before any send began (`canDeleteMailing`). Its recipients,
+   * A/B variants and compiled content go with it. Test sends made from it stay
+   * in the archive, with `mailing_id` null: they are mail that really went out.
+   * Anything else is `mailing_invalid_state` (409): a scheduled mailing is
+   * unscheduled first, and a mailing that started is the record of what was
+   * sent. An automation's mailing is `conflict`; a transactional letter is
+   * deleted only by a key that may write one (`forbidden`).
+   */
+  "mailings.delete": {
+    method: "DELETE",
+    path: "/v1/mailings/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "write",
+    phase: "S2"
+  },
   "mailings.retryFailed": {
     method: "POST",
     path: "/v1/mailings/:id/retry-failed",
@@ -6363,6 +6387,7 @@ export {
   billingRoutes,
   buildPath,
   buildTemplatePatch,
+  canDeleteMailing,
   canTransition,
   canonicalLocale,
   choiceKeyProblem,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.14.0",
+  "version": "0.15.1",
   "description": "The v1 API contract of the mail service: zod schemas and types for every request, response, error and webhook, the route table, and webhook signing helpers",
   "license": "MIT",
   "repository": {