@marlinjai/mail-contract 0.8.1 → 0.10.0

package/dist/index.js

@@ -382,6 +382,8 @@ __export(index_exports, {
   TEMPLATE_INPUT_KINDS: () => TEMPLATE_INPUT_KINDS,
   TEMPLATE_INPUT_PROBLEM_REASONS: () => TEMPLATE_INPUT_PROBLEM_REASONS,
   TEMPLATE_LANGUAGE_STATUSES: () => TEMPLATE_LANGUAGE_STATUSES,
+  TEMPLATE_SORTS: () => TEMPLATE_SORTS,
+  TEMPLATE_SORT_DEFAULT_ORDER: () => TEMPLATE_SORT_DEFAULT_ORDER,
   TERMINAL_MAILING_STATUSES: () => TERMINAL_MAILING_STATUSES,
   Tag: () => Tag,
   TagAssignment: () => TagAssignment,
@@ -390,6 +392,7 @@ __export(index_exports, {
   TemplateCompileRequest: () => TemplateCompileRequest,
   TemplateCreate: () => TemplateCreate,
   TemplateCreatedData: () => TemplateCreatedData,
+  TemplateDeleteQuery: () => TemplateDeleteQuery,
   TemplateDeletedData: () => TemplateDeletedData,
   TemplateDocument: () => TemplateDocument,
   TemplateExportQuery: () => TemplateExportQuery,
@@ -1287,8 +1290,15 @@ var SavedSectionUpdate = import_zod5.z.object({
   description: import_zod5.z.string().max(2e3).nullable().optional(),
   section: SavedSectionBody.optional()
 }).refine((v) => v.name !== void 0 || v.description !== void 0 || v.section !== void 0, "at least one field");
+var TemplateDeleteQuery = import_zod5.z.object({
+  base_version: import_zod5.z.coerce.number().int().min(1).optional()
+});
+var TEMPLATE_SORTS = ["updated_at", "name", "version"];
+var TEMPLATE_SORT_DEFAULT_ORDER = { updated_at: "desc", name: "asc", version: "desc" };
 var TemplateListQuery = PageQuery.extend({
-  archived: import_zod5.z.enum(["true", "false"]).optional()
+  archived: import_zod5.z.enum(["true", "false"]).optional(),
+  sort: import_zod5.z.enum(TEMPLATE_SORTS).optional(),
+  order: import_zod5.z.enum(["asc", "desc"]).optional()
 });
 var TemplateVersion = import_zod5.z.object({
   template_id: Id,
@@ -1567,6 +1577,14 @@ var Mailing = import_zod7.z.object({
    * language: without a ready version in it, the main language goes out.
    */
   send_locale: LocaleTag.nullable(),
+  /**
+   * The template's language version the mailing was written from
+   * (`MailingCreate.template_locale`), or null. When set, it equals `locale`
+   * and `send_locale`: the mailing is one letter in that language, and the
+   * template's other versions never go out with it (see "Writing from one
+   * language version" in the contract's documentation).
+   */
+  template_locale: LocaleTag.nullable().default(null),
   /**
    * 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
@@ -1613,10 +1631,14 @@ var MailingCreate = import_zod7.z.object({
   ...MailingContent,
   subject: MailingContent.subject.optional(),
   document: TemplateDocument.optional(),
-  template_id: Id.optional()
+  template_id: Id.optional(),
+  template_locale: LocaleTag.optional()
 }).refine((v) => v.document === void 0 !== (v.template_id === void 0), {
   message: "exactly one of document or template_id",
   path: ["document"]
+}).refine((v) => v.template_locale === void 0 || v.template_id !== void 0, {
+  message: "template_locale names a version of template_id",
+  path: ["template_locale"]
 }).refine((v) => v.template_id !== void 0 || v.subject !== void 0, {
   message: "a mailing made from a document needs a subject",
   path: ["subject"]
@@ -4894,6 +4916,7 @@ var templateRoutes = {
     method: "DELETE",
     path: "/v1/templates/:id",
     params: IdParams,
+    query: TemplateDeleteQuery,
     response: Ok,
     status: 200,
     access: "write",
@@ -6473,6 +6496,8 @@ function matchRoute(method, pathname) {
   TEMPLATE_INPUT_KINDS,
   TEMPLATE_INPUT_PROBLEM_REASONS,
   TEMPLATE_LANGUAGE_STATUSES,
+  TEMPLATE_SORTS,
+  TEMPLATE_SORT_DEFAULT_ORDER,
   TERMINAL_MAILING_STATUSES,
   Tag,
   TagAssignment,
@@ -6481,6 +6506,7 @@ function matchRoute(method, pathname) {
   TemplateCompileRequest,
   TemplateCreate,
   TemplateCreatedData,
+  TemplateDeleteQuery,
   TemplateDeletedData,
   TemplateDocument,
   TemplateExportQuery,

package/dist/index.mjs

@@ -690,8 +690,15 @@ var SavedSectionUpdate = z5.object({
   description: z5.string().max(2e3).nullable().optional(),
   section: SavedSectionBody.optional()
 }).refine((v) => v.name !== void 0 || v.description !== void 0 || v.section !== void 0, "at least one field");
+var TemplateDeleteQuery = z5.object({
+  base_version: z5.coerce.number().int().min(1).optional()
+});
+var TEMPLATE_SORTS = ["updated_at", "name", "version"];
+var TEMPLATE_SORT_DEFAULT_ORDER = { updated_at: "desc", name: "asc", version: "desc" };
 var TemplateListQuery = PageQuery.extend({
-  archived: z5.enum(["true", "false"]).optional()
+  archived: z5.enum(["true", "false"]).optional(),
+  sort: z5.enum(TEMPLATE_SORTS).optional(),
+  order: z5.enum(["asc", "desc"]).optional()
 });
 var TemplateVersion = z5.object({
   template_id: Id,
@@ -970,6 +977,14 @@ var Mailing = z7.object({
    * language: without a ready version in it, the main language goes out.
    */
   send_locale: LocaleTag.nullable(),
+  /**
+   * The template's language version the mailing was written from
+   * (`MailingCreate.template_locale`), or null. When set, it equals `locale`
+   * and `send_locale`: the mailing is one letter in that language, and the
+   * template's other versions never go out with it (see "Writing from one
+   * language version" in the contract's documentation).
+   */
+  template_locale: LocaleTag.nullable().default(null),
   /**
    * 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
@@ -1016,10 +1031,14 @@ var MailingCreate = z7.object({
   ...MailingContent,
   subject: MailingContent.subject.optional(),
   document: TemplateDocument.optional(),
-  template_id: Id.optional()
+  template_id: Id.optional(),
+  template_locale: LocaleTag.optional()
 }).refine((v) => v.document === void 0 !== (v.template_id === void 0), {
   message: "exactly one of document or template_id",
   path: ["document"]
+}).refine((v) => v.template_locale === void 0 || v.template_id !== void 0, {
+  message: "template_locale names a version of template_id",
+  path: ["template_locale"]
 }).refine((v) => v.template_id !== void 0 || v.subject !== void 0, {
   message: "a mailing made from a document needs a subject",
   path: ["subject"]
@@ -4297,6 +4316,7 @@ var templateRoutes = {
     method: "DELETE",
     path: "/v1/templates/:id",
     params: IdParams,
+    query: TemplateDeleteQuery,
     response: Ok,
     status: 200,
     access: "write",
@@ -5875,6 +5895,8 @@ export {
   TEMPLATE_INPUT_KINDS,
   TEMPLATE_INPUT_PROBLEM_REASONS,
   TEMPLATE_LANGUAGE_STATUSES,
+  TEMPLATE_SORTS,
+  TEMPLATE_SORT_DEFAULT_ORDER,
   TERMINAL_MAILING_STATUSES,
   Tag,
   TagAssignment,
@@ -5883,6 +5905,7 @@ export {
   TemplateCompileRequest,
   TemplateCreate,
   TemplateCreatedData,
+  TemplateDeleteQuery,
   TemplateDeletedData,
   TemplateDocument,
   TemplateExportQuery,

package/package.json

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