@sylphx/contract 0.2.0

package/dist/endpoints/newsletter.d.ts

@@ -0,0 +1,366 @@
+/**
+ * Newsletter endpoints — Console-plane subscriber / sequence / step /
+ * enrollment CRUD + analytics. No BaaS overlap.
+ *
+ * Production mount: `/newsletter/*` (see
+ * `apps/api/src/server/platform/app.ts`). Plane: `'management'`.
+ */
+export declare const newsletterEndpoints: {
+    readonly listSubscribers: import("../endpoint.js").Endpoint<"GET", "/newsletter/subscribers", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        projectId: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        verified: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        source: import("effect/Schema").optional<import("effect/Schema").Literal<["website", "waitlist", "referral", "api", "import"]>>;
+        search: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        includeUnsubscribed: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        limit: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        offset: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        subscribers: import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            id: typeof import("effect/Schema").String;
+            email: typeof import("effect/Schema").String;
+            name: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+            source: import("effect/Schema").Literal<["website", "waitlist", "referral", "api", "import"]>;
+            emailVerified: typeof import("effect/Schema").Boolean;
+            subscribedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+            unsubscribedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+            createdAt: typeof import("effect/Schema").String;
+            preferences: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Boolean>>;
+        }>>;
+        total: typeof import("effect/Schema").Number;
+        hasMore: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly getSubscriber: import("../endpoint.js").Endpoint<"GET", "/newsletter/subscribers/by-email", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        email: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        email: typeof import("effect/Schema").String;
+        name: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        source: import("effect/Schema").Literal<["website", "waitlist", "referral", "api", "import"]>;
+        emailVerified: typeof import("effect/Schema").Boolean;
+        subscribedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        unsubscribedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        createdAt: typeof import("effect/Schema").String;
+        preferences: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Boolean>>;
+        metadata: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Unknown>>;
+        updatedAt: typeof import("effect/Schema").String;
+    }>>;
+    readonly getPreferences: import("../endpoint.js").Endpoint<"GET", "/newsletter/subscribers/preferences", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        email: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Boolean>>;
+    readonly exportSubscribers: import("../endpoint.js").Endpoint<"GET", "/newsletter/subscribers/export", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        verified: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        includeUnsubscribed: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        csv: typeof import("effect/Schema").String;
+        filename: typeof import("effect/Schema").String;
+    }>>;
+    readonly subscriberStats: import("../endpoint.js").Endpoint<"GET", "/newsletter/subscribers/stats", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        total: typeof import("effect/Schema").Number;
+        verified: typeof import("effect/Schema").Number;
+        unsubscribed: typeof import("effect/Schema").Number;
+        bySource: import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Number>;
+    }>>;
+    readonly deleteSubscriber: import("../endpoint.js").Endpoint<"DELETE", "/newsletter/subscribers", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        email: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+        message: typeof import("effect/Schema").String;
+    }>>;
+    readonly bulkDeleteSubscribers: import("../endpoint.js").Endpoint<"POST", "/newsletter/subscribers/bulk-delete", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        projectId: typeof import("effect/Schema").String;
+        subscriberIds: import("effect/Schema").Array$<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Struct<{
+        deleted: typeof import("effect/Schema").Number;
+        errors: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            id: typeof import("effect/Schema").String;
+            error: typeof import("effect/Schema").String;
+        }>>>;
+    }>>;
+    readonly resendVerification: import("../endpoint.js").Endpoint<"POST", "/newsletter/subscribers/resend-verification", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        email: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Struct<{
+        sent: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly listSequences: import("../endpoint.js").Endpoint<"GET", "/newsletter/sequences", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        projectId: typeof import("effect/Schema").String;
+        includeInactive: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Array$<import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        projectId: typeof import("effect/Schema").String;
+        name: typeof import("effect/Schema").String;
+        description: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>;
+        triggerConditions: import("effect/Schema").NullOr<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        isActive: typeof import("effect/Schema").Boolean;
+        allowReenrollment: typeof import("effect/Schema").Boolean;
+        exitOnUnsubscribe: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+    }>>>;
+    readonly createSequence: import("../endpoint.js").Endpoint<"POST", "/newsletter/sequences", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        projectId: typeof import("effect/Schema").String;
+        name: typeof import("effect/Schema").String;
+        description: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>;
+        triggerConditions: import("effect/Schema").optional<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        allowReenrollment: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+        exitOnUnsubscribe: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+    }>, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        projectId: typeof import("effect/Schema").String;
+        name: typeof import("effect/Schema").String;
+        description: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>;
+        triggerConditions: import("effect/Schema").NullOr<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        isActive: typeof import("effect/Schema").Boolean;
+        allowReenrollment: typeof import("effect/Schema").Boolean;
+        exitOnUnsubscribe: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+        steps: import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            id: typeof import("effect/Schema").String;
+            sequenceId: typeof import("effect/Schema").String;
+            stepNumber: typeof import("effect/Schema").Number;
+            type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+            name: typeof import("effect/Schema").String;
+            config: typeof import("effect/Schema").Unknown;
+            isEnabled: typeof import("effect/Schema").Boolean;
+            createdAt: typeof import("effect/Schema").String;
+            updatedAt: typeof import("effect/Schema").String;
+        }>>;
+    }>>;
+    readonly getSequence: import("../endpoint.js").Endpoint<"GET", "/newsletter/sequences/:sequenceId", import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        projectId: typeof import("effect/Schema").String;
+        name: typeof import("effect/Schema").String;
+        description: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>;
+        triggerConditions: import("effect/Schema").NullOr<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        isActive: typeof import("effect/Schema").Boolean;
+        allowReenrollment: typeof import("effect/Schema").Boolean;
+        exitOnUnsubscribe: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+        steps: import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            id: typeof import("effect/Schema").String;
+            sequenceId: typeof import("effect/Schema").String;
+            stepNumber: typeof import("effect/Schema").Number;
+            type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+            name: typeof import("effect/Schema").String;
+            config: typeof import("effect/Schema").Unknown;
+            isEnabled: typeof import("effect/Schema").Boolean;
+            createdAt: typeof import("effect/Schema").String;
+            updatedAt: typeof import("effect/Schema").String;
+        }>>;
+    }>>;
+    readonly updateSequence: import("../endpoint.js").Endpoint<"PATCH", "/newsletter/sequences/:sequenceId", import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        name: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        description: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").optional<import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>>;
+        triggerConditions: import("effect/Schema").optional<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        isActive: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+        allowReenrollment: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+        exitOnUnsubscribe: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+    }>, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        projectId: typeof import("effect/Schema").String;
+        name: typeof import("effect/Schema").String;
+        description: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+        trigger: import("effect/Schema").Literal<["subscribe", "verify_email", "tag_added", "manual", "event"]>;
+        triggerConditions: import("effect/Schema").NullOr<import("effect/Schema").Struct<{
+            tag: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            event: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            conditions: import("effect/Schema").optional<import("effect/Schema").Array$<import("effect/Schema").Struct<{
+                field: typeof import("effect/Schema").String;
+                operator: import("effect/Schema").Literal<["eq", "neq", "contains", "exists"]>;
+                value: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+            }>>>;
+        }>>;
+        isActive: typeof import("effect/Schema").Boolean;
+        allowReenrollment: typeof import("effect/Schema").Boolean;
+        exitOnUnsubscribe: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+        steps: import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            id: typeof import("effect/Schema").String;
+            sequenceId: typeof import("effect/Schema").String;
+            stepNumber: typeof import("effect/Schema").Number;
+            type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+            name: typeof import("effect/Schema").String;
+            config: typeof import("effect/Schema").Unknown;
+            isEnabled: typeof import("effect/Schema").Boolean;
+            createdAt: typeof import("effect/Schema").String;
+            updatedAt: typeof import("effect/Schema").String;
+        }>>;
+    }>>;
+    readonly deleteSequence: import("../endpoint.js").Endpoint<"DELETE", "/newsletter/sequences/:sequenceId", import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly getSequenceAnalytics: import("../endpoint.js").Endpoint<"GET", "/newsletter/sequences/:sequenceId/analytics", import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+        totalEnrollments: typeof import("effect/Schema").Number;
+        activeEnrollments: typeof import("effect/Schema").Number;
+        completedEnrollments: typeof import("effect/Schema").Number;
+        cancelledEnrollments: typeof import("effect/Schema").Number;
+        unsubscribedEnrollments: typeof import("effect/Schema").Number;
+        stepAnalytics: import("effect/Schema").Array$<import("effect/Schema").Struct<{
+            stepId: typeof import("effect/Schema").String;
+            stepName: typeof import("effect/Schema").String;
+            reached: typeof import("effect/Schema").Number;
+            completed: typeof import("effect/Schema").Number;
+            avgDurationMs: import("effect/Schema").NullOr<typeof import("effect/Schema").Number>;
+        }>>;
+    }>>;
+    readonly addStep: import("../endpoint.js").Endpoint<"POST", "/newsletter/steps", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+        stepNumber: typeof import("effect/Schema").Number;
+        type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+        name: typeof import("effect/Schema").String;
+        config: typeof import("effect/Schema").Unknown;
+        isEnabled: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+    }>, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        sequenceId: typeof import("effect/Schema").String;
+        stepNumber: typeof import("effect/Schema").Number;
+        type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+        name: typeof import("effect/Schema").String;
+        config: typeof import("effect/Schema").Unknown;
+        isEnabled: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+    }>>;
+    readonly reorderSteps: import("../endpoint.js").Endpoint<"POST", "/newsletter/steps/reorder", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+        stepOrder: import("effect/Schema").Array$<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly updateStep: import("../endpoint.js").Endpoint<"PATCH", "/newsletter/steps/:stepId", import("effect/Schema").Struct<{
+        stepId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        stepNumber: import("effect/Schema").optional<typeof import("effect/Schema").Number>;
+        name: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        config: import("effect/Schema").optional<typeof import("effect/Schema").Unknown>;
+        isEnabled: import("effect/Schema").optional<typeof import("effect/Schema").Boolean>;
+    }>, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        sequenceId: typeof import("effect/Schema").String;
+        stepNumber: typeof import("effect/Schema").Number;
+        type: import("effect/Schema").Literal<["email", "delay", "condition", "tag", "webhook"]>;
+        name: typeof import("effect/Schema").String;
+        config: typeof import("effect/Schema").Unknown;
+        isEnabled: typeof import("effect/Schema").Boolean;
+        createdAt: typeof import("effect/Schema").String;
+        updatedAt: typeof import("effect/Schema").String;
+    }>>;
+    readonly deleteStep: import("../endpoint.js").Endpoint<"DELETE", "/newsletter/steps/:stepId", import("effect/Schema").Struct<{
+        stepId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly listEnrollments: import("../endpoint.js").Endpoint<"GET", "/newsletter/enrollments", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+        status: import("effect/Schema").optional<import("effect/Schema").Literal<["active", "completed", "paused", "cancelled", "unsubscribed"]>>;
+        limit: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+        offset: import("effect/Schema").optional<typeof import("effect/Schema").String>;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Array$<import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        sequenceId: typeof import("effect/Schema").String;
+        subscriberId: typeof import("effect/Schema").String;
+        status: import("effect/Schema").Literal<["active", "completed", "paused", "cancelled", "unsubscribed"]>;
+        currentStep: typeof import("effect/Schema").Number;
+        context: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Unknown>>;
+        enrolledAt: typeof import("effect/Schema").String;
+        completedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+    }>>>;
+    readonly enrollSubscriber: import("../endpoint.js").Endpoint<"POST", "/newsletter/enrollments", import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        sequenceId: typeof import("effect/Schema").String;
+        subscriberId: typeof import("effect/Schema").String;
+        context: import("effect/Schema").optional<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Unknown>>;
+    }>, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        sequenceId: typeof import("effect/Schema").String;
+        subscriberId: typeof import("effect/Schema").String;
+        status: import("effect/Schema").Literal<["active", "completed", "paused", "cancelled", "unsubscribed"]>;
+        currentStep: typeof import("effect/Schema").Number;
+        context: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Unknown>>;
+        enrolledAt: typeof import("effect/Schema").String;
+        completedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+    }>>;
+    readonly getEnrollment: import("../endpoint.js").Endpoint<"GET", "/newsletter/enrollments/:enrollmentId", import("effect/Schema").Struct<{
+        enrollmentId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        id: typeof import("effect/Schema").String;
+        sequenceId: typeof import("effect/Schema").String;
+        subscriberId: typeof import("effect/Schema").String;
+        status: import("effect/Schema").Literal<["active", "completed", "paused", "cancelled", "unsubscribed"]>;
+        currentStep: typeof import("effect/Schema").Number;
+        context: import("effect/Schema").NullOr<import("effect/Schema").Record$<typeof import("effect/Schema").String, typeof import("effect/Schema").Unknown>>;
+        enrolledAt: typeof import("effect/Schema").String;
+        completedAt: import("effect/Schema").NullOr<typeof import("effect/Schema").String>;
+    }>>;
+    readonly cancelEnrollment: import("../endpoint.js").Endpoint<"POST", "/newsletter/enrollments/:enrollmentId/cancel", import("effect/Schema").Struct<{
+        enrollmentId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly pauseEnrollment: import("../endpoint.js").Endpoint<"POST", "/newsletter/enrollments/:enrollmentId/pause", import("effect/Schema").Struct<{
+        enrollmentId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+    readonly resumeEnrollment: import("../endpoint.js").Endpoint<"POST", "/newsletter/enrollments/:enrollmentId/resume", import("effect/Schema").Struct<{
+        enrollmentId: typeof import("effect/Schema").String;
+    }>, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Schema.AnyNoContext | undefined, import("effect/Schema").Struct<{
+        success: typeof import("effect/Schema").Boolean;
+    }>>;
+};
+//# sourceMappingURL=newsletter.d.ts.map

package/dist/endpoints/newsletter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"newsletter.d.ts","sourceRoot":"","sources":["../../src/endpoints/newsletter.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAsCH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiOtB,CAAA"}

package/dist/endpoints/newsletter.js

@@ -0,0 +1,232 @@
+/**
+ * Newsletter endpoints — Console-plane subscriber / sequence / step /
+ * enrollment CRUD + analytics. No BaaS overlap.
+ *
+ * Production mount: `/newsletter/*` (see
+ * `apps/api/src/server/platform/app.ts`). Plane: `'management'`.
+ */
+import { defineEndpoint } from '../endpoint.js';
+import { AddStepInput, BulkDeleteSubscribersInput, BulkDeleteSubscribersResult, CreateSequenceInput, DeleteSubscriberInput, DeleteSubscriberResult, Enrollment, EnrollmentIdPath, EnrollSubscriberInput, ExportSubscribersQuery, ExportSubscribersResult, GetSubscriberQuery, ListEnrollmentsQuery, ListEnrollmentsResult, ListSequencesQuery, ListSequencesResult, ListSubscribersQuery, ListSubscribersResult, NewsletterSuccessResult, ReorderStepsInput, ResendVerificationInput, ResendVerificationResult, SequenceAnalytics, SequenceIdPath, SequenceWithSteps, Step, StepIdPath, SubscriberDetail, SubscriberPreferences, SubscriberStatsResult, UpdateSequenceInput, UpdateStepInput, } from '../schemas/newsletter.js';
+export const newsletterEndpoints = {
+    // ── Subscribers ────────────────────────────────────────────────────────
+    listSubscribers: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/subscribers',
+        query: ListSubscribersQuery,
+        response: ListSubscribersResult,
+        plane: 'management',
+        summary: 'List newsletter subscribers',
+        tags: ['newsletter'],
+    }),
+    getSubscriber: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/subscribers/by-email',
+        query: GetSubscriberQuery,
+        response: SubscriberDetail,
+        plane: 'management',
+        summary: 'Get a subscriber by email',
+        tags: ['newsletter'],
+    }),
+    getPreferences: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/subscribers/preferences',
+        query: GetSubscriberQuery,
+        response: SubscriberPreferences,
+        plane: 'management',
+        summary: 'Get subscription preferences for a subscriber',
+        tags: ['newsletter'],
+    }),
+    exportSubscribers: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/subscribers/export',
+        query: ExportSubscribersQuery,
+        response: ExportSubscribersResult,
+        plane: 'management',
+        summary: 'Export subscribers as CSV',
+        tags: ['newsletter'],
+    }),
+    subscriberStats: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/subscribers/stats',
+        response: SubscriberStatsResult,
+        plane: 'management',
+        summary: 'Overall subscriber statistics',
+        tags: ['newsletter'],
+    }),
+    deleteSubscriber: defineEndpoint({
+        method: 'DELETE',
+        path: '/newsletter/subscribers',
+        body: DeleteSubscriberInput,
+        response: DeleteSubscriberResult,
+        plane: 'management',
+        summary: 'Delete a subscriber by email (GDPR)',
+        tags: ['newsletter'],
+    }),
+    bulkDeleteSubscribers: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/subscribers/bulk-delete',
+        body: BulkDeleteSubscribersInput,
+        response: BulkDeleteSubscribersResult,
+        plane: 'management',
+        summary: 'Bulk delete up to 100 subscribers at once',
+        tags: ['newsletter'],
+    }),
+    resendVerification: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/subscribers/resend-verification',
+        body: ResendVerificationInput,
+        response: ResendVerificationResult,
+        plane: 'management',
+        summary: 'Resend verification email to an unverified subscriber',
+        tags: ['newsletter'],
+    }),
+    // ── Sequences ──────────────────────────────────────────────────────────
+    listSequences: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/sequences',
+        query: ListSequencesQuery,
+        response: ListSequencesResult,
+        plane: 'management',
+        summary: 'List automation sequences for a project',
+        tags: ['newsletter'],
+    }),
+    createSequence: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/sequences',
+        body: CreateSequenceInput,
+        response: SequenceWithSteps,
+        plane: 'management',
+        summary: 'Create a new automation sequence',
+        tags: ['newsletter'],
+    }),
+    getSequence: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/sequences/:sequenceId',
+        params: SequenceIdPath,
+        response: SequenceWithSteps,
+        plane: 'management',
+        summary: 'Get a sequence with its steps',
+        tags: ['newsletter'],
+    }),
+    updateSequence: defineEndpoint({
+        method: 'PATCH',
+        path: '/newsletter/sequences/:sequenceId',
+        params: SequenceIdPath,
+        body: UpdateSequenceInput,
+        response: SequenceWithSteps,
+        plane: 'management',
+        summary: 'Update an automation sequence',
+        tags: ['newsletter'],
+    }),
+    deleteSequence: defineEndpoint({
+        method: 'DELETE',
+        path: '/newsletter/sequences/:sequenceId',
+        params: SequenceIdPath,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Delete an automation sequence and its steps',
+        tags: ['newsletter'],
+    }),
+    getSequenceAnalytics: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/sequences/:sequenceId/analytics',
+        params: SequenceIdPath,
+        response: SequenceAnalytics,
+        plane: 'management',
+        summary: 'Get analytics for an automation sequence',
+        tags: ['newsletter'],
+    }),
+    // ── Steps ──────────────────────────────────────────────────────────────
+    addStep: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/steps',
+        body: AddStepInput,
+        response: Step,
+        plane: 'management',
+        summary: 'Add a step to a sequence',
+        tags: ['newsletter'],
+    }),
+    reorderSteps: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/steps/reorder',
+        body: ReorderStepsInput,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Reorder steps within a sequence',
+        tags: ['newsletter'],
+    }),
+    updateStep: defineEndpoint({
+        method: 'PATCH',
+        path: '/newsletter/steps/:stepId',
+        params: StepIdPath,
+        body: UpdateStepInput,
+        response: Step,
+        plane: 'management',
+        summary: 'Update an existing automation step',
+        tags: ['newsletter'],
+    }),
+    deleteStep: defineEndpoint({
+        method: 'DELETE',
+        path: '/newsletter/steps/:stepId',
+        params: StepIdPath,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Delete an automation step',
+        tags: ['newsletter'],
+    }),
+    // ── Enrollments ────────────────────────────────────────────────────────
+    listEnrollments: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/enrollments',
+        query: ListEnrollmentsQuery,
+        response: ListEnrollmentsResult,
+        plane: 'management',
+        summary: 'List enrollments for a sequence',
+        tags: ['newsletter'],
+    }),
+    enrollSubscriber: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/enrollments',
+        body: EnrollSubscriberInput,
+        response: Enrollment,
+        plane: 'management',
+        summary: 'Manually enroll a subscriber in a sequence',
+        tags: ['newsletter'],
+    }),
+    getEnrollment: defineEndpoint({
+        method: 'GET',
+        path: '/newsletter/enrollments/:enrollmentId',
+        params: EnrollmentIdPath,
+        response: Enrollment,
+        plane: 'management',
+        summary: 'Get an enrollment by ID',
+        tags: ['newsletter'],
+    }),
+    cancelEnrollment: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/enrollments/:enrollmentId/cancel',
+        params: EnrollmentIdPath,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Cancel an active enrollment',
+        tags: ['newsletter'],
+    }),
+    pauseEnrollment: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/enrollments/:enrollmentId/pause',
+        params: EnrollmentIdPath,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Pause an active enrollment',
+        tags: ['newsletter'],
+    }),
+    resumeEnrollment: defineEndpoint({
+        method: 'POST',
+        path: '/newsletter/enrollments/:enrollmentId/resume',
+        params: EnrollmentIdPath,
+        response: NewsletterSuccessResult,
+        plane: 'management',
+        summary: 'Resume a paused enrollment',
+        tags: ['newsletter'],
+    }),
+};