@marlinjai/mail-contract 0.3.0 → 0.4.0

package/dist/index.js

@@ -199,6 +199,7 @@ __export(index_exports, {
   InviteListQuery: () => InviteListQuery,
   InviteStatus: () => InviteStatus,
   JsonValue: () => JsonValue,
+  LETTER_RECIPIENT_REFUSAL: () => LETTER_RECIPIENT_REFUSAL,
   LIST_UNSUBSCRIBE_POST_VALUE: () => LIST_UNSUBSCRIBE_POST_VALUE,
   MAILING_ACTIONS: () => MAILING_ACTIONS,
   MAILING_KINDS: () => MAILING_KINDS,
@@ -217,6 +218,7 @@ __export(index_exports, {
   MAX_IMPORT_URL_LENGTH: () => MAX_IMPORT_URL_LENGTH,
   MAX_INVITE_TTL_DAYS: () => MAX_INVITE_TTL_DAYS,
   MAX_IN_LIST: () => MAX_IN_LIST,
+  MAX_LETTER_RECIPIENTS: () => MAX_LETTER_RECIPIENTS,
   MAX_MERGE_DEFAULTS: () => MAX_MERGE_DEFAULTS,
   MAX_MERGE_DEFAULT_LENGTH: () => MAX_MERGE_DEFAULT_LENGTH,
   MAX_MJML_DEPTH: () => MAX_MJML_DEPTH,
@@ -904,7 +906,12 @@ var Mailing = import_zod5.z.object({
   /** The template the document was taken from, if any. The snapshot is what is sent. */
   template_id: Id.nullable(),
   document: TemplateDocument,
-  topic: Slug,
+  /**
+   * The topic the mailing is sent under. Null for a letter (a one-to-one
+   * mailing with at most one recipient, which belongs to no topic and whose
+   * unsubscribe link offers every topic) and for an automation's notification.
+   */
+  topic: Slug.nullable(),
   provider_id: Id,
   status: MailingStatus,
   counts: MailingCounts,
@@ -929,7 +936,13 @@ var MailingContent = {
   name: import_zod5.z.string().max(200).optional(),
   subject: import_zod5.z.string().min(1).max(998),
   preheader: import_zod5.z.string().max(500).optional(),
-  topic: Slug,
+  /**
+   * Omitted or null makes the mailing a letter: one recipient at most, sent to
+   * anybody not blocked on every topic, with an unsubscribe link that offers
+   * every topic and no List-Unsubscribe headers. See "Letters" in the
+   * contract's documentation.
+   */
+  topic: Slug.nullable().optional(),
   provider_id: Id,
   metadata: MailingMetadata.optional()
 };
@@ -945,7 +958,8 @@ var MailingUpdate = import_zod5.z.object({
   name: import_zod5.z.string().max(200).nullable().optional(),
   subject: MailingContent.subject.optional(),
   preheader: import_zod5.z.string().max(500).nullable().optional(),
-  topic: Slug.optional(),
+  /** Null turns a draft into a letter, which it can only be with at most one recipient. */
+  topic: Slug.nullable().optional(),
   provider_id: Id.optional(),
   metadata: MailingMetadata.optional(),
   document: TemplateDocument.optional()
@@ -993,6 +1007,8 @@ var Recipient = import_zod5.z.object({
   updated_at: Timestamp
 });
 var MAX_RECIPIENTS_PER_BATCH = 1e3;
+var MAX_LETTER_RECIPIENTS = 1;
+var LETTER_RECIPIENT_REFUSAL = "letter_has_one_recipient";
 var RecipientInput = import_zod5.z.object({
   contact_id: Id.optional(),
   external_id: import_zod5.z.string().min(1).max(255).optional(),
@@ -2530,6 +2546,7 @@ var AUDIT_ACTIONS = [
   "provider.anomaly_cleared",
   "topic.created",
   "topic.updated",
+  "topic.deleted",
   "template.created",
   "template.updated",
   "template.deleted",
@@ -3777,6 +3794,16 @@ var sendingRoutes = {
     access: "admin",
     phase: "S2"
   },
+  /** Refused with `conflict` while a mailing or an automation step still uses the topic; subscriptions and suppressions on it go with it. */
+  "topics.delete": {
+    method: "DELETE",
+    path: "/v1/topics/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "admin",
+    phase: "S2"
+  },
   "contacts.upsert": {
     method: "POST",
     path: "/v1/contacts",
@@ -4898,6 +4925,7 @@ function matchRoute(method, pathname) {
   InviteListQuery,
   InviteStatus,
   JsonValue,
+  LETTER_RECIPIENT_REFUSAL,
   LIST_UNSUBSCRIBE_POST_VALUE,
   MAILING_ACTIONS,
   MAILING_KINDS,
@@ -4916,6 +4944,7 @@ function matchRoute(method, pathname) {
   MAX_IMPORT_URL_LENGTH,
   MAX_INVITE_TTL_DAYS,
   MAX_IN_LIST,
+  MAX_LETTER_RECIPIENTS,
   MAX_MERGE_DEFAULTS,
   MAX_MERGE_DEFAULT_LENGTH,
   MAX_MJML_DEPTH,

package/dist/index.mjs

@@ -439,7 +439,12 @@ var Mailing = z5.object({
   /** The template the document was taken from, if any. The snapshot is what is sent. */
   template_id: Id.nullable(),
   document: TemplateDocument,
-  topic: Slug,
+  /**
+   * The topic the mailing is sent under. Null for a letter (a one-to-one
+   * mailing with at most one recipient, which belongs to no topic and whose
+   * unsubscribe link offers every topic) and for an automation's notification.
+   */
+  topic: Slug.nullable(),
   provider_id: Id,
   status: MailingStatus,
   counts: MailingCounts,
@@ -464,7 +469,13 @@ var MailingContent = {
   name: z5.string().max(200).optional(),
   subject: z5.string().min(1).max(998),
   preheader: z5.string().max(500).optional(),
-  topic: Slug,
+  /**
+   * Omitted or null makes the mailing a letter: one recipient at most, sent to
+   * anybody not blocked on every topic, with an unsubscribe link that offers
+   * every topic and no List-Unsubscribe headers. See "Letters" in the
+   * contract's documentation.
+   */
+  topic: Slug.nullable().optional(),
   provider_id: Id,
   metadata: MailingMetadata.optional()
 };
@@ -480,7 +491,8 @@ var MailingUpdate = z5.object({
   name: z5.string().max(200).nullable().optional(),
   subject: MailingContent.subject.optional(),
   preheader: z5.string().max(500).nullable().optional(),
-  topic: Slug.optional(),
+  /** Null turns a draft into a letter, which it can only be with at most one recipient. */
+  topic: Slug.nullable().optional(),
   provider_id: Id.optional(),
   metadata: MailingMetadata.optional(),
   document: TemplateDocument.optional()
@@ -528,6 +540,8 @@ var Recipient = z5.object({
   updated_at: Timestamp
 });
 var MAX_RECIPIENTS_PER_BATCH = 1e3;
+var MAX_LETTER_RECIPIENTS = 1;
+var LETTER_RECIPIENT_REFUSAL = "letter_has_one_recipient";
 var RecipientInput = z5.object({
   contact_id: Id.optional(),
   external_id: z5.string().min(1).max(255).optional(),
@@ -2065,6 +2079,7 @@ var AUDIT_ACTIONS = [
   "provider.anomaly_cleared",
   "topic.created",
   "topic.updated",
+  "topic.deleted",
   "template.created",
   "template.updated",
   "template.deleted",
@@ -3312,6 +3327,16 @@ var sendingRoutes = {
     access: "admin",
     phase: "S2"
   },
+  /** Refused with `conflict` while a mailing or an automation step still uses the topic; subscriptions and suppressions on it go with it. */
+  "topics.delete": {
+    method: "DELETE",
+    path: "/v1/topics/:id",
+    params: IdParams,
+    response: Ok,
+    status: 200,
+    access: "admin",
+    phase: "S2"
+  },
   "contacts.upsert": {
     method: "POST",
     path: "/v1/contacts",
@@ -4432,6 +4457,7 @@ export {
   InviteListQuery,
   InviteStatus,
   JsonValue,
+  LETTER_RECIPIENT_REFUSAL,
   LIST_UNSUBSCRIBE_POST_VALUE,
   MAILING_ACTIONS,
   MAILING_KINDS,
@@ -4450,6 +4476,7 @@ export {
   MAX_IMPORT_URL_LENGTH,
   MAX_INVITE_TTL_DAYS,
   MAX_IN_LIST,
+  MAX_LETTER_RECIPIENTS,
   MAX_MERGE_DEFAULTS,
   MAX_MERGE_DEFAULT_LENGTH,
   MAX_MJML_DEPTH,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.3.0",
+  "version": "0.4.0",
   "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": {