@apollo-deploy/signal-schemas 1.0.0

package/dist/definitions/signal-email/request.schema.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Apollo Signal — Email Request Schemas
+ *
+ * Validation schemas for the public /v1/emails* API surface.
+ * These are the only Signal request schemas that cross the backend-to-client
+ * boundary and belong in this package.
+ *
+ * Dashboard request schemas (/signal/*) are backend-private and live in
+ * apps/signal/src/modules/<module>/contracts/internal/.
+ */
+import { z } from 'zod';
+/**
+ * Request body for POST /v1/emails.
+ *
+ * Authenticated with a Bearer ap_signal_... API key that carries the
+ * emails:send scope. The key is bound to exactly one Signal project at
+ * issuance time; the project is resolved server-side from the key's
+ * permissions payload — callers do not supply a project ID.
+ */
+export declare const SignalSendEmailBodySchema: z.ZodObject<{
+    from: z.ZodString;
+    to: z.ZodArray<z.ZodString>;
+    cc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    replyTo: z.ZodOptional<z.ZodString>;
+    subject: z.ZodOptional<z.ZodString>;
+    html: z.ZodOptional<z.ZodString>;
+    text: z.ZodOptional<z.ZodString>;
+    tags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    idempotencyKey: z.ZodOptional<z.ZodString>;
+    testMode: z.ZodOptional<z.ZodBoolean>;
+    attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        filename: z.ZodString;
+        content: z.ZodString;
+        contentType: z.ZodString;
+        disposition: z.ZodOptional<z.ZodEnum<{
+            attachment: "attachment";
+            inline: "inline";
+        }>>;
+        contentId: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    scheduledAt: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"optimal">]>>;
+    deliveryWindow: z.ZodOptional<z.ZodObject<{
+        start: z.ZodString;
+        end: z.ZodString;
+    }, z.core.$strip>>;
+    sendTimeCategory: z.ZodDefault<z.ZodEnum<{
+        transactional: "transactional";
+        marketing: "marketing";
+        notification: "notification";
+        digest: "digest";
+    }>>;
+    templateId: z.ZodOptional<z.ZodString>;
+    variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    trackingSettings: z.ZodOptional<z.ZodObject<{
+        openTracking: z.ZodOptional<z.ZodBoolean>;
+        clickTracking: z.ZodOptional<z.ZodBoolean>;
+        unsubscribeTracking: z.ZodOptional<z.ZodBoolean>;
+        readEngagement: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Request body for POST /v1/emails/batch.
+ * Each item in the emails array follows the same shape as a single send.
+ * Rate-limit quota is checked atomically across the full batch before any
+ * SES call is made. Results are returned per-item (partial success allowed).
+ */
+export declare const SignalBatchSendEmailBodySchema: z.ZodObject<{
+    emails: z.ZodArray<z.ZodObject<{
+        from: z.ZodString;
+        to: z.ZodArray<z.ZodString>;
+        cc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        bcc: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        replyTo: z.ZodOptional<z.ZodString>;
+        subject: z.ZodOptional<z.ZodString>;
+        html: z.ZodOptional<z.ZodString>;
+        text: z.ZodOptional<z.ZodString>;
+        tags: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        idempotencyKey: z.ZodOptional<z.ZodString>;
+        testMode: z.ZodOptional<z.ZodBoolean>;
+        attachments: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            filename: z.ZodString;
+            content: z.ZodString;
+            contentType: z.ZodString;
+            disposition: z.ZodOptional<z.ZodEnum<{
+                attachment: "attachment";
+                inline: "inline";
+            }>>;
+            contentId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>>;
+        scheduledAt: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodLiteral<"optimal">]>>;
+        deliveryWindow: z.ZodOptional<z.ZodObject<{
+            start: z.ZodString;
+            end: z.ZodString;
+        }, z.core.$strip>>;
+        sendTimeCategory: z.ZodDefault<z.ZodEnum<{
+            transactional: "transactional";
+            marketing: "marketing";
+            notification: "notification";
+            digest: "digest";
+        }>>;
+        templateId: z.ZodOptional<z.ZodString>;
+        variables: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        trackingSettings: z.ZodOptional<z.ZodObject<{
+            openTracking: z.ZodOptional<z.ZodBoolean>;
+            clickTracking: z.ZodOptional<z.ZodBoolean>;
+            unsubscribeTracking: z.ZodOptional<z.ZodBoolean>;
+            readEngagement: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Path parameters for GET /v1/emails/:emailId.
+ */
+export declare const SignalGetEmailParamsSchema: z.ZodObject<{
+    emailId: z.ZodString;
+}, z.core.$strip>;
+export type SignalSendEmailBody = z.infer<typeof SignalSendEmailBodySchema>;
+export type SignalBatchSendEmailBody = z.infer<typeof SignalBatchSendEmailBodySchema>;
+export type SignalGetEmailParams = z.infer<typeof SignalGetEmailParamsSchema>;
+//# sourceMappingURL=request.schema.d.ts.map

package/dist/definitions/signal-email/request.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/signal-email/request.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAoBxB;;;;;;;GAOG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAqKnC,CAAC;AAMJ;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAEzC,CAAC;AAMH;;GAEG;AACH,eAAO,MAAM,0BAA0B;;iBAErC,CAAC;AAMH,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAC5E,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AACtF,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC"}

package/dist/definitions/signal-email/request.schema.js

@@ -0,0 +1,201 @@
+/**
+ * Apollo Signal — Email Request Schemas
+ *
+ * Validation schemas for the public /v1/emails* API surface.
+ * These are the only Signal request schemas that cross the backend-to-client
+ * boundary and belong in this package.
+ *
+ * Dashboard request schemas (/signal/*) are backend-private and live in
+ * apps/signal/src/modules/<module>/contracts/internal/.
+ */
+import { z } from 'zod';
+// ---------------------------------------------------------------------------
+// Shared address primitives
+// ---------------------------------------------------------------------------
+/**
+ * RFC 5321 email address (local@domain), max 320 chars.
+ */
+const EmailAddressSchema = z.string().email().max(320);
+/**
+ * "Name <email>" or bare "email" sender/recipient format.
+ */
+const AddressSchema = z.string().min(1).max(998);
+// ---------------------------------------------------------------------------
+// POST /v1/emails — send a transactional email
+// ---------------------------------------------------------------------------
+/**
+ * Request body for POST /v1/emails.
+ *
+ * Authenticated with a Bearer ap_signal_... API key that carries the
+ * emails:send scope. The key is bound to exactly one Signal project at
+ * issuance time; the project is resolved server-side from the key's
+ * permissions payload — callers do not supply a project ID.
+ */
+export const SignalSendEmailBodySchema = z
+    .object({
+    /**
+     * Sender address. Must be a verified domain owned by the project.
+     * Accepts "Name <email>" or bare "email" format.
+     */
+    from: AddressSchema,
+    /**
+     * Primary recipient(s). At least one required.
+     * Combined with cc and bcc, the total must not exceed the project's
+     * maxRecipientsPerMessage limit (default 10).
+     */
+    to: z.array(EmailAddressSchema).min(1).max(50),
+    /** Carbon-copy recipients. */
+    cc: z.array(EmailAddressSchema).max(50).optional(),
+    /** Blind carbon-copy recipients. */
+    bcc: z.array(EmailAddressSchema).max(50).optional(),
+    /** Reply-to address. */
+    replyTo: EmailAddressSchema.optional(),
+    /**
+     * Email subject line. Required unless templateId is provided.
+     * Max 998 chars (RFC 5322).
+     */
+    subject: z.string().min(1).max(998).optional(),
+    /**
+     * HTML body. At least one of html or text must be provided.
+     * Max 10 MiB after encoding.
+     */
+    html: z.string().min(1).optional(),
+    /**
+     * Plain-text body. At least one of html or text must be provided.
+     * Max 10 MiB.
+     */
+    text: z.string().min(1).optional(),
+    /**
+     * Caller-supplied key-value tags attached to the email record.
+     * Useful for filtering in the dashboard. Max 50 entries; keys and values
+     * max 256 chars each.
+     */
+    tags: z
+        .record(z.string().max(256), z.string().max(256))
+        .refine((t) => Object.keys(t).length <= 50, 'Maximum 50 tags allowed')
+        .optional(),
+    /**
+     * Arbitrary caller-supplied metadata stored with the email record.
+     * Not forwarded to SES. Max 50 keys.
+     */
+    metadata: z
+        .record(z.string().max(256), z.string().max(256))
+        .refine((m) => Object.keys(m).length <= 50, 'Maximum 50 metadata keys allowed')
+        .optional(),
+    /**
+     * Idempotency key. When supplied, a second request with the same key
+     * within the project returns the original response without re-sending.
+     * Max 255 chars; caller-generated (UUID recommended).
+     */
+    idempotencyKey: z.string().min(1).max(255).optional(),
+    /**
+     * When true (or when the X-Apollo-Signal-Test-Mode: true header is
+     * present), the email is validated and recorded but NOT submitted to SES.
+     * No usage is counted; no webhooks are fired.
+     */
+    testMode: z.boolean().optional(),
+    /**
+     * File attachments. Each item is base64-encoded. Total decoded size across
+     * all attachments must not exceed 10 MiB (SES raw message limit).
+     */
+    attachments: z
+        .array(z.object({
+        /** Original filename shown in the email client. */
+        filename: z.string().min(1).max(255),
+        /** Base64-encoded file content. */
+        content: z.string().min(1),
+        /** MIME content-type, e.g. "application/pdf" or "image/png". */
+        contentType: z.string().min(1).max(127),
+        /** "attachment" (default) saves to disk; "inline" embeds in HTML via cid:. */
+        disposition: z.enum(['attachment', 'inline']).optional(),
+        /** Content-ID for inline images, e.g. "logo" (referenced as cid:logo in HTML). */
+        contentId: z.string().max(255).optional(),
+    }))
+        .max(20)
+        .optional(),
+    /**
+     * ISO 8601 UTC datetime at which to deliver the email. Must be at least
+     * 30 seconds and no more than 30 days in the future. When omitted the
+     * email is sent immediately.
+     *
+     * Set to the string "optimal" to use AI-powered send time optimisation.
+     * When "optimal" is used, deliveryWindow must also be provided.
+     * Not available for sendTimeCategory: "transactional" emails.
+     */
+    scheduledAt: z
+        .union([z.string().datetime({ offset: true }), z.literal('optimal')])
+        .optional(),
+    /**
+     * Delivery window for send-time optimisation. Required when scheduledAt
+     * is "optimal". The email will be delivered within this window at the
+     * time Signal predicts the recipient is most likely to engage.
+     */
+    deliveryWindow: z
+        .object({
+        /** ISO 8601 UTC datetime — earliest the email may be delivered. */
+        start: z.string().datetime({ offset: true }),
+        /** ISO 8601 UTC datetime — latest the email may be delivered. */
+        end: z.string().datetime({ offset: true }),
+    })
+        .optional(),
+    /**
+     * Category of the email. Used to determine whether send-time optimisation
+     * applies. Transactional emails are always sent immediately regardless of
+     * scheduledAt. Defaults to "transactional".
+     */
+    sendTimeCategory: z
+        .enum(['transactional', 'marketing', 'notification', 'digest'])
+        .default('transactional'),
+    /**
+     * ID of a pre-created template to use for subject, html, and text.
+     * Explicit subject/html/text fields take precedence over template content.
+     */
+    templateId: z.string().min(1).optional(),
+    /**
+     * Key-value pairs used to substitute {{variable_name}} placeholders in
+     * the template. Ignored when templateId is not provided.
+     */
+    variables: z.record(z.string(), z.string()).optional(),
+    /**
+     * Per-send tracking overrides. When provided, these values take precedence
+     * over the project-level trackingSettings for this specific email.
+     */
+    trackingSettings: z
+        .object({
+        openTracking: z.boolean().optional(),
+        clickTracking: z.boolean().optional(),
+        unsubscribeTracking: z.boolean().optional(),
+        readEngagement: z.boolean().optional(),
+    })
+        .optional(),
+})
+    .refine((b) => b.subject !== undefined || b.templateId !== undefined, { message: 'subject is required when templateId is not provided', path: ['subject'] })
+    .refine((b) => b.templateId !== undefined || b.html !== undefined || b.text !== undefined, { message: 'At least one of html or text must be provided when templateId is not provided', path: ['html'] });
+// ---------------------------------------------------------------------------
+// POST /v1/emails/batch — send up to 100 emails in a single call
+// ---------------------------------------------------------------------------
+/**
+ * Request body for POST /v1/emails/batch.
+ * Each item in the emails array follows the same shape as a single send.
+ * Rate-limit quota is checked atomically across the full batch before any
+ * SES call is made. Results are returned per-item (partial success allowed).
+ */
+export const SignalBatchSendEmailBodySchema = z.object({
+    emails: z.array(SignalSendEmailBodySchema).min(1).max(100),
+});
+// ---------------------------------------------------------------------------
+// GET /v1/emails/:emailId — retrieve a sent email
+// ---------------------------------------------------------------------------
+/**
+ * Path parameters for GET /v1/emails/:emailId.
+ */
+export const SignalGetEmailParamsSchema = z.object({
+    emailId: z.string().min(1),
+});
+// ---------------------------------------------------------------------------
+// Schema registry — promotes types to OpenAPI components/schemas
+// ---------------------------------------------------------------------------
+z.globalRegistry.add(SignalSendEmailBodySchema, { id: 'SignalSendEmailBody' });
+z.globalRegistry.add(SignalBatchSendEmailBodySchema, { id: 'SignalBatchSendEmailBody' });
+z.globalRegistry.add(SignalGetEmailParamsSchema, { id: 'SignalGetEmailParams' });
+//# sourceMappingURL=request.schema.js.map

package/dist/definitions/signal-email/request.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"request.schema.js","sourceRoot":"","sources":["../../../src/definitions/signal-email/request.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,8EAA8E;AAC9E,4BAA4B;AAC5B,8EAA8E;AAE9E;;GAEG;AACH,MAAM,kBAAkB,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,aAAa,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAEjD,8EAA8E;AAC9E,+CAA+C;AAC/C,8EAA8E;AAE9E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN;;;OAGG;IACH,IAAI,EAAE,aAAa;IAEnB;;;;OAIG;IACH,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;IAE9C,8BAA8B;IAC9B,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAElD,oCAAoC;IACpC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEnD,wBAAwB;IACxB,OAAO,EAAE,kBAAkB,CAAC,QAAQ,EAAE;IAEtC;;;OAGG;IACH,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAE9C;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAElC;;;OAGG;IACH,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAElC;;;;OAIG;IACH,IAAI,EAAE,CAAC;SACJ,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAChD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,yBAAyB,CAAC;SACrE,QAAQ,EAAE;IAEb;;;OAGG;IACH,QAAQ,EAAE,CAAC;SACR,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SAChD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,EAAE,EAAE,kCAAkC,CAAC;SAC9E,QAAQ,EAAE;IAEb;;;;OAIG;IACH,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IAErD;;;;OAIG;IACH,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAEhC;;;OAGG;IACH,WAAW,EAAE,CAAC;SACX,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;QACP,mDAAmD;QACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QACpC,mCAAmC;QACnC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;QAC1B,gEAAgE;QAChE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;QACvC,8EAA8E;QAC9E,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC,CAAC,QAAQ,EAAE;QACxD,kFAAkF;QAClF,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;KAC1C,CAAC,CACH;SACA,GAAG,CAAC,EAAE,CAAC;SACP,QAAQ,EAAE;IAEb;;;;;;;;OAQG;IACH,WAAW,EAAE,CAAC;SACX,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC;SACpE,QAAQ,EAAE;IAEb;;;;OAIG;IACH,cAAc,EAAE,CAAC;SACd,MAAM,CAAC;QACN,mEAAmE;QACnE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;QAC5C,iEAAiE;QACjE,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC;KAC3C,CAAC;SACD,QAAQ,EAAE;IAEb;;;;OAIG;IACH,gBAAgB,EAAE,CAAC;SAChB,IAAI,CAAC,CAAC,eAAe,EAAE,WAAW,EAAE,cAAc,EAAE,QAAQ,CAAC,CAAC;SAC9D,OAAO,CAAC,eAAe,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE;IAExC;;;OAGG;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEtD;;;OAGG;IACH,gBAAgB,EAAE,CAAC;SAChB,MAAM,CAAC;QACN,YAAY,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACpC,aAAa,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACrC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC3C,cAAc,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,QAAQ,EAAE;CACd,CAAC;KACD,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,KAAK,SAAS,IAAI,CAAC,CAAC,UAAU,KAAK,SAAS,EAC5D,EAAE,OAAO,EAAE,qDAAqD,EAAE,IAAI,EAAE,CAAC,SAAS,CAAC,EAAE,CACtF;KACA,MAAM,CACL,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,IAAI,KAAK,SAAS,EACjF,EAAE,OAAO,EAAE,+EAA+E,EAAE,IAAI,EAAE,CAAC,MAAM,CAAC,EAAE,CAC7G,CAAC;AAEJ,8EAA8E;AAC9E,iEAAiE;AACjE,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IACrD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,yBAAyB,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;CAC3D,CAAC,CAAC;AAEH,8EAA8E;AAC9E,kDAAkD;AAClD,8EAA8E;AAE9E;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IACjD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC;AAUH,8EAA8E;AAC9E,iEAAiE;AACjE,8EAA8E;AAE9E,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,EAAE,EAAE,qBAAqB,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,8BAA8B,EAAE,EAAE,EAAE,EAAE,0BAA0B,EAAE,CAAC,CAAC;AACzF,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,0BAA0B,EAAE,EAAE,EAAE,EAAE,sBAAsB,EAAE,CAAC,CAAC","sourcesContent":["/**\n * Apollo Signal — Email Request Schemas\n *\n * Validation schemas for the public /v1/emails* API surface.\n * These are the only Signal request schemas that cross the backend-to-client\n * boundary and belong in this package.\n *\n * Dashboard request schemas (/signal/*) are backend-private and live in\n * apps/signal/src/modules/<module>/contracts/internal/.\n */\n\nimport { z } from 'zod';\n\n// ---------------------------------------------------------------------------\n// Shared address primitives\n// ---------------------------------------------------------------------------\n\n/**\n * RFC 5321 email address (local@domain), max 320 chars.\n */\nconst EmailAddressSchema = z.string().email().max(320);\n\n/**\n * \"Name <email>\" or bare \"email\" sender/recipient format.\n */\nconst AddressSchema = z.string().min(1).max(998);\n\n// ---------------------------------------------------------------------------\n// POST /v1/emails — send a transactional email\n// ---------------------------------------------------------------------------\n\n/**\n * Request body for POST /v1/emails.\n *\n * Authenticated with a Bearer ap_signal_... API key that carries the\n * emails:send scope. The key is bound to exactly one Signal project at\n * issuance time; the project is resolved server-side from the key's\n * permissions payload — callers do not supply a project ID.\n */\nexport const SignalSendEmailBodySchema = z\n  .object({\n    /**\n     * Sender address. Must be a verified domain owned by the project.\n     * Accepts \"Name <email>\" or bare \"email\" format.\n     */\n    from: AddressSchema,\n\n    /**\n     * Primary recipient(s). At least one required.\n     * Combined with cc and bcc, the total must not exceed the project's\n     * maxRecipientsPerMessage limit (default 10).\n     */\n    to: z.array(EmailAddressSchema).min(1).max(50),\n\n    /** Carbon-copy recipients. */\n    cc: z.array(EmailAddressSchema).max(50).optional(),\n\n    /** Blind carbon-copy recipients. */\n    bcc: z.array(EmailAddressSchema).max(50).optional(),\n\n    /** Reply-to address. */\n    replyTo: EmailAddressSchema.optional(),\n\n    /**\n     * Email subject line. Required unless templateId is provided.\n     * Max 998 chars (RFC 5322).\n     */\n    subject: z.string().min(1).max(998).optional(),\n\n    /**\n     * HTML body. At least one of html or text must be provided.\n     * Max 10 MiB after encoding.\n     */\n    html: z.string().min(1).optional(),\n\n    /**\n     * Plain-text body. At least one of html or text must be provided.\n     * Max 10 MiB.\n     */\n    text: z.string().min(1).optional(),\n\n    /**\n     * Caller-supplied key-value tags attached to the email record.\n     * Useful for filtering in the dashboard. Max 50 entries; keys and values\n     * max 256 chars each.\n     */\n    tags: z\n      .record(z.string().max(256), z.string().max(256))\n      .refine((t) => Object.keys(t).length <= 50, 'Maximum 50 tags allowed')\n      .optional(),\n\n    /**\n     * Arbitrary caller-supplied metadata stored with the email record.\n     * Not forwarded to SES. Max 50 keys.\n     */\n    metadata: z\n      .record(z.string().max(256), z.string().max(256))\n      .refine((m) => Object.keys(m).length <= 50, 'Maximum 50 metadata keys allowed')\n      .optional(),\n\n    /**\n     * Idempotency key. When supplied, a second request with the same key\n     * within the project returns the original response without re-sending.\n     * Max 255 chars; caller-generated (UUID recommended).\n     */\n    idempotencyKey: z.string().min(1).max(255).optional(),\n\n    /**\n     * When true (or when the X-Apollo-Signal-Test-Mode: true header is\n     * present), the email is validated and recorded but NOT submitted to SES.\n     * No usage is counted; no webhooks are fired.\n     */\n    testMode: z.boolean().optional(),\n\n    /**\n     * File attachments. Each item is base64-encoded. Total decoded size across\n     * all attachments must not exceed 10 MiB (SES raw message limit).\n     */\n    attachments: z\n      .array(\n        z.object({\n          /** Original filename shown in the email client. */\n          filename: z.string().min(1).max(255),\n          /** Base64-encoded file content. */\n          content: z.string().min(1),\n          /** MIME content-type, e.g. \"application/pdf\" or \"image/png\". */\n          contentType: z.string().min(1).max(127),\n          /** \"attachment\" (default) saves to disk; \"inline\" embeds in HTML via cid:. */\n          disposition: z.enum(['attachment', 'inline']).optional(),\n          /** Content-ID for inline images, e.g. \"logo\" (referenced as cid:logo in HTML). */\n          contentId: z.string().max(255).optional(),\n        }),\n      )\n      .max(20)\n      .optional(),\n\n    /**\n     * ISO 8601 UTC datetime at which to deliver the email. Must be at least\n     * 30 seconds and no more than 30 days in the future. When omitted the\n     * email is sent immediately.\n     *\n     * Set to the string \"optimal\" to use AI-powered send time optimisation.\n     * When \"optimal\" is used, deliveryWindow must also be provided.\n     * Not available for sendTimeCategory: \"transactional\" emails.\n     */\n    scheduledAt: z\n      .union([z.string().datetime({ offset: true }), z.literal('optimal')])\n      .optional(),\n\n    /**\n     * Delivery window for send-time optimisation. Required when scheduledAt\n     * is \"optimal\". The email will be delivered within this window at the\n     * time Signal predicts the recipient is most likely to engage.\n     */\n    deliveryWindow: z\n      .object({\n        /** ISO 8601 UTC datetime — earliest the email may be delivered. */\n        start: z.string().datetime({ offset: true }),\n        /** ISO 8601 UTC datetime — latest the email may be delivered. */\n        end: z.string().datetime({ offset: true }),\n      })\n      .optional(),\n\n    /**\n     * Category of the email. Used to determine whether send-time optimisation\n     * applies. Transactional emails are always sent immediately regardless of\n     * scheduledAt. Defaults to \"transactional\".\n     */\n    sendTimeCategory: z\n      .enum(['transactional', 'marketing', 'notification', 'digest'])\n      .default('transactional'),\n\n    /**\n     * ID of a pre-created template to use for subject, html, and text.\n     * Explicit subject/html/text fields take precedence over template content.\n     */\n    templateId: z.string().min(1).optional(),\n\n    /**\n     * Key-value pairs used to substitute {{variable_name}} placeholders in\n     * the template. Ignored when templateId is not provided.\n     */\n    variables: z.record(z.string(), z.string()).optional(),\n\n    /**\n     * Per-send tracking overrides. When provided, these values take precedence\n     * over the project-level trackingSettings for this specific email.\n     */\n    trackingSettings: z\n      .object({\n        openTracking: z.boolean().optional(),\n        clickTracking: z.boolean().optional(),\n        unsubscribeTracking: z.boolean().optional(),\n        readEngagement: z.boolean().optional(),\n      })\n      .optional(),\n  })\n  .refine(\n    (b) => b.subject !== undefined || b.templateId !== undefined,\n    { message: 'subject is required when templateId is not provided', path: ['subject'] },\n  )\n  .refine(\n    (b) => b.templateId !== undefined || b.html !== undefined || b.text !== undefined,\n    { message: 'At least one of html or text must be provided when templateId is not provided', path: ['html'] },\n  );\n\n// ---------------------------------------------------------------------------\n// POST /v1/emails/batch — send up to 100 emails in a single call\n// ---------------------------------------------------------------------------\n\n/**\n * Request body for POST /v1/emails/batch.\n * Each item in the emails array follows the same shape as a single send.\n * Rate-limit quota is checked atomically across the full batch before any\n * SES call is made. Results are returned per-item (partial success allowed).\n */\nexport const SignalBatchSendEmailBodySchema = z.object({\n  emails: z.array(SignalSendEmailBodySchema).min(1).max(100),\n});\n\n// ---------------------------------------------------------------------------\n// GET /v1/emails/:emailId — retrieve a sent email\n// ---------------------------------------------------------------------------\n\n/**\n * Path parameters for GET /v1/emails/:emailId.\n */\nexport const SignalGetEmailParamsSchema = z.object({\n  emailId: z.string().min(1),\n});\n\n// ---------------------------------------------------------------------------\n// Inferred TypeScript types\n// ---------------------------------------------------------------------------\n\nexport type SignalSendEmailBody = z.infer<typeof SignalSendEmailBodySchema>;\nexport type SignalBatchSendEmailBody = z.infer<typeof SignalBatchSendEmailBodySchema>;\nexport type SignalGetEmailParams = z.infer<typeof SignalGetEmailParamsSchema>;\n\n// ---------------------------------------------------------------------------\n// Schema registry — promotes types to OpenAPI components/schemas\n// ---------------------------------------------------------------------------\n\nz.globalRegistry.add(SignalSendEmailBodySchema, { id: 'SignalSendEmailBody' });\nz.globalRegistry.add(SignalBatchSendEmailBodySchema, { id: 'SignalBatchSendEmailBody' });\nz.globalRegistry.add(SignalGetEmailParamsSchema, { id: 'SignalGetEmailParams' });\n"]}

package/dist/definitions/signal-email/response.schema.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Apollo Signal — Email Response Schemas
+ *
+ * Response shapes for the public /v1/emails* API surface.
+ * These are the only Signal response schemas that cross the backend-to-client
+ * boundary and belong in this package.
+ *
+ * Dashboard response schemas (/signal/*) are backend-private and live in
+ * apps/signal/src/modules/<module>/contracts/internal/.
+ */
+import { z } from 'zod';
+/**
+ * Response body for a successful POST /v1/emails.
+ *
+ * When testMode is true the status field is "test" and messageId is null.
+ */
+export declare const SignalSendEmailResponseSchema: z.ZodObject<{
+    id: z.ZodString;
+    messageId: z.ZodNullable<z.ZodString>;
+    status: z.ZodEnum<{
+        failed: "failed";
+        queued: "queued";
+        scheduled: "scheduled";
+        cancelled: "cancelled";
+        sent: "sent";
+        delivered: "delivered";
+        bounced: "bounced";
+        complained: "complained";
+        rejected: "rejected";
+        suppressed: "suppressed";
+        test: "test";
+    }>;
+    createdAt: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Public email resource returned by GET /v1/emails/:emailId.
+ *
+ * Scoped to the project bound to the API key. Recipient addresses are
+ * returned in full (the caller is the project owner).
+ */
+export declare const SignalEmailResourceSchema: z.ZodObject<{
+    id: z.ZodString;
+    messageId: z.ZodNullable<z.ZodString>;
+    from: z.ZodString;
+    to: z.ZodArray<z.ZodString>;
+    cc: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    bcc: z.ZodNullable<z.ZodArray<z.ZodString>>;
+    replyTo: z.ZodNullable<z.ZodString>;
+    subject: z.ZodString;
+    status: z.ZodEnum<{
+        failed: "failed";
+        queued: "queued";
+        scheduled: "scheduled";
+        cancelled: "cancelled";
+        sent: "sent";
+        delivered: "delivered";
+        bounced: "bounced";
+        complained: "complained";
+        rejected: "rejected";
+        suppressed: "suppressed";
+        test: "test";
+    }>;
+    error: z.ZodNullable<z.ZodString>;
+    tags: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
+    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
+    testMode: z.ZodBoolean;
+    createdAt: z.ZodString;
+    sentAt: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export type SignalSendEmailResponse = z.infer<typeof SignalSendEmailResponseSchema>;
+export type SignalEmailResource = z.infer<typeof SignalEmailResourceSchema>;
+//# sourceMappingURL=response.schema.d.ts.map

package/dist/definitions/signal-email/response.schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.schema.d.ts","sourceRoot":"","sources":["../../../src/definitions/signal-email/response.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AASxB;;;;GAIG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;;;;;;;;;;iBAexC,CAAC;AAMH;;;;;GAKG;AACH,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAgDpC,CAAC;AAMH,MAAM,MAAM,uBAAuB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,6BAA6B,CAAC,CAAC;AACpF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC"}

package/dist/definitions/signal-email/response.schema.js

@@ -0,0 +1,83 @@
+/**
+ * Apollo Signal — Email Response Schemas
+ *
+ * Response shapes for the public /v1/emails* API surface.
+ * These are the only Signal response schemas that cross the backend-to-client
+ * boundary and belong in this package.
+ *
+ * Dashboard response schemas (/signal/*) are backend-private and live in
+ * apps/signal/src/modules/<module>/contracts/internal/.
+ */
+import { z } from 'zod';
+import { IsoDateStringSchema, NullableIsoDateStringSchema } from '../common.js';
+import { SignalEmailStatusSchema } from './domain.schema.js';
+// ---------------------------------------------------------------------------
+// POST /v1/emails — send response
+// ---------------------------------------------------------------------------
+/**
+ * Response body for a successful POST /v1/emails.
+ *
+ * When testMode is true the status field is "test" and messageId is null.
+ */
+export const SignalSendEmailResponseSchema = z.object({
+    /** Email ID (email_<crockford-base32>). */
+    id: z.string(),
+    /**
+     * SES message ID. Present when the email was submitted to SES.
+     * null for test-mode sends.
+     */
+    messageId: z.string().nullable(),
+    /** Email status immediately after the send attempt. */
+    status: SignalEmailStatusSchema,
+    /** ISO 8601 timestamp when the email record was created. */
+    createdAt: IsoDateStringSchema,
+});
+// ---------------------------------------------------------------------------
+// GET /v1/emails/:emailId — email resource
+// ---------------------------------------------------------------------------
+/**
+ * Public email resource returned by GET /v1/emails/:emailId.
+ *
+ * Scoped to the project bound to the API key. Recipient addresses are
+ * returned in full (the caller is the project owner).
+ */
+export const SignalEmailResourceSchema = z.object({
+    /** Email ID (email_<crockford-base32>). */
+    id: z.string(),
+    /** SES message ID. null until the email is submitted to SES. */
+    messageId: z.string().nullable(),
+    /** Sender address as supplied in the send request. */
+    from: z.string(),
+    /** Primary recipient addresses. */
+    to: z.array(z.string()),
+    /** Carbon-copy recipients. null when not supplied. */
+    cc: z.array(z.string()).nullable(),
+    /** Blind carbon-copy recipients. null when not supplied. */
+    bcc: z.array(z.string()).nullable(),
+    /** Reply-to address. null when not supplied. */
+    replyTo: z.string().nullable(),
+    /** Email subject line. */
+    subject: z.string(),
+    /** Current lifecycle status. */
+    status: SignalEmailStatusSchema,
+    /** Error message when status is "failed". null otherwise. */
+    error: z.string().nullable(),
+    /** Caller-supplied tags. null when not supplied. */
+    tags: z.record(z.string(), z.string()).nullable(),
+    /** Caller-supplied metadata. null when not supplied. */
+    metadata: z.record(z.string(), z.string()).nullable(),
+    /** true when the email was sent in test mode. */
+    testMode: z.boolean(),
+    /** ISO 8601 timestamp when the email record was created. */
+    createdAt: IsoDateStringSchema,
+    /** ISO 8601 timestamp when the email was submitted to SES. null until sent. */
+    sentAt: NullableIsoDateStringSchema,
+    /** ISO 8601 timestamp of the last status update. */
+    updatedAt: IsoDateStringSchema,
+});
+// ---------------------------------------------------------------------------
+// Schema registry — promotes types to OpenAPI components/schemas
+// ---------------------------------------------------------------------------
+z.globalRegistry.add(SignalSendEmailResponseSchema, { id: 'SignalSendEmailResponse' });
+z.globalRegistry.add(SignalEmailResourceSchema, { id: 'SignalEmailResource' });
+//# sourceMappingURL=response.schema.js.map

package/dist/definitions/signal-email/response.schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.schema.js","sourceRoot":"","sources":["../../../src/definitions/signal-email/response.schema.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,mBAAmB,EAAE,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChF,OAAO,EAAE,uBAAuB,EAAE,MAAM,oBAAoB,CAAC;AAE7D,8EAA8E;AAC9E,kCAAkC;AAClC,8EAA8E;AAE9E;;;;GAIG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC,MAAM,CAAC;IACpD,2CAA2C;IAC3C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IAEd;;;OAGG;IACH,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEhC,uDAAuD;IACvD,MAAM,EAAE,uBAAuB;IAE/B,4DAA4D;IAC5D,SAAS,EAAE,mBAAmB;CAC/B,CAAC,CAAC;AAEH,8EAA8E;AAC9E,2CAA2C;AAC3C,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,2CAA2C;IAC3C,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE;IAEd,gEAAgE;IAChE,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAEhC,sDAAsD;IACtD,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAEhB,mCAAmC;IACnC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IAEvB,sDAAsD;IACtD,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAElC,4DAA4D;IAC5D,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEnC,gDAAgD;IAChD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE9B,0BAA0B;IAC1B,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;IAEnB,gCAAgC;IAChC,MAAM,EAAE,uBAAuB;IAE/B,6DAA6D;IAC7D,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAE5B,oDAAoD;IACpD,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAEjD,wDAAwD;IACxD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;IAErD,iDAAiD;IACjD,QAAQ,EAAE,CAAC,CAAC,OAAO,EAAE;IAErB,4DAA4D;IAC5D,SAAS,EAAE,mBAAmB;IAE9B,+EAA+E;IAC/E,MAAM,EAAE,2BAA2B;IAEnC,oDAAoD;IACpD,SAAS,EAAE,mBAAmB;CAC/B,CAAC,CAAC;AASH,8EAA8E;AAC9E,iEAAiE;AACjE,8EAA8E;AAE9E,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,6BAA6B,EAAE,EAAE,EAAE,EAAE,yBAAyB,EAAE,CAAC,CAAC;AACvF,CAAC,CAAC,cAAc,CAAC,GAAG,CAAC,yBAAyB,EAAE,EAAE,EAAE,EAAE,qBAAqB,EAAE,CAAC,CAAC","sourcesContent":["/**\n * Apollo Signal — Email Response Schemas\n *\n * Response shapes for the public /v1/emails* API surface.\n * These are the only Signal response schemas that cross the backend-to-client\n * boundary and belong in this package.\n *\n * Dashboard response schemas (/signal/*) are backend-private and live in\n * apps/signal/src/modules/<module>/contracts/internal/.\n */\n\nimport { z } from 'zod';\n\nimport { IsoDateStringSchema, NullableIsoDateStringSchema } from '../common.js';\nimport { SignalEmailStatusSchema } from './domain.schema.js';\n\n// ---------------------------------------------------------------------------\n// POST /v1/emails — send response\n// ---------------------------------------------------------------------------\n\n/**\n * Response body for a successful POST /v1/emails.\n *\n * When testMode is true the status field is \"test\" and messageId is null.\n */\nexport const SignalSendEmailResponseSchema = z.object({\n  /** Email ID (email_<crockford-base32>). */\n  id: z.string(),\n\n  /**\n   * SES message ID. Present when the email was submitted to SES.\n   * null for test-mode sends.\n   */\n  messageId: z.string().nullable(),\n\n  /** Email status immediately after the send attempt. */\n  status: SignalEmailStatusSchema,\n\n  /** ISO 8601 timestamp when the email record was created. */\n  createdAt: IsoDateStringSchema,\n});\n\n// ---------------------------------------------------------------------------\n// GET /v1/emails/:emailId — email resource\n// ---------------------------------------------------------------------------\n\n/**\n * Public email resource returned by GET /v1/emails/:emailId.\n *\n * Scoped to the project bound to the API key. Recipient addresses are\n * returned in full (the caller is the project owner).\n */\nexport const SignalEmailResourceSchema = z.object({\n  /** Email ID (email_<crockford-base32>). */\n  id: z.string(),\n\n  /** SES message ID. null until the email is submitted to SES. */\n  messageId: z.string().nullable(),\n\n  /** Sender address as supplied in the send request. */\n  from: z.string(),\n\n  /** Primary recipient addresses. */\n  to: z.array(z.string()),\n\n  /** Carbon-copy recipients. null when not supplied. */\n  cc: z.array(z.string()).nullable(),\n\n  /** Blind carbon-copy recipients. null when not supplied. */\n  bcc: z.array(z.string()).nullable(),\n\n  /** Reply-to address. null when not supplied. */\n  replyTo: z.string().nullable(),\n\n  /** Email subject line. */\n  subject: z.string(),\n\n  /** Current lifecycle status. */\n  status: SignalEmailStatusSchema,\n\n  /** Error message when status is \"failed\". null otherwise. */\n  error: z.string().nullable(),\n\n  /** Caller-supplied tags. null when not supplied. */\n  tags: z.record(z.string(), z.string()).nullable(),\n\n  /** Caller-supplied metadata. null when not supplied. */\n  metadata: z.record(z.string(), z.string()).nullable(),\n\n  /** true when the email was sent in test mode. */\n  testMode: z.boolean(),\n\n  /** ISO 8601 timestamp when the email record was created. */\n  createdAt: IsoDateStringSchema,\n\n  /** ISO 8601 timestamp when the email was submitted to SES. null until sent. */\n  sentAt: NullableIsoDateStringSchema,\n\n  /** ISO 8601 timestamp of the last status update. */\n  updatedAt: IsoDateStringSchema,\n});\n\n// ---------------------------------------------------------------------------\n// Inferred TypeScript types\n// ---------------------------------------------------------------------------\n\nexport type SignalSendEmailResponse = z.infer<typeof SignalSendEmailResponseSchema>;\nexport type SignalEmailResource = z.infer<typeof SignalEmailResourceSchema>;\n\n// ---------------------------------------------------------------------------\n// Schema registry — promotes types to OpenAPI components/schemas\n// ---------------------------------------------------------------------------\n\nz.globalRegistry.add(SignalSendEmailResponseSchema, { id: 'SignalSendEmailResponse' });\nz.globalRegistry.add(SignalEmailResourceSchema, { id: 'SignalEmailResource' });\n"]}