Template
westfarn
f2eb4b7152
## Summary Closes #11. Mirrors ai_ml_operations/monica_site#15. - Direct-mail compose can target the postcard mailing list **or** find and select one or two USPS carrier routes by ZIP (optional radius). - Estimated cost is shown per route and for the selection (PCM design pricing, else `PCM_POSTCARD_PRICE_*` fallback). - Selected routes order through PCM `POST /order/postcard/with-list-count` — occupant addresses are not imported into Contacts. - Not official EDDM postage; PCM FirstClass/Standard purchased occupant lists on carrier routes. ## Test plan - [ ] Campaign compose: mailing-list audience still quotes list size × per-piece cost. - [ ] Switch to USPS carrier routes, search a ZIP, pick 1–2 routes, confirm household count + estimated cost. - [ ] Saving without a selection is rejected; saving with a quote creates one contact-less Message and shows the route panel on the report. - [ ] Send places `/order/postcard/with-list-count` (not per-recipient `/order/postcard`). - [ ] `uv run python manage.py test directmail.tests.CarrierRoutePostcardTests directmail.tests.PostcardDesignPickTests` Reviewed-on: #12
127 lines
4.2 KiB
Python
127 lines
4.2 KiB
Python
from django.conf import settings
|
|
from django.db import models
|
|
|
|
from contacts.models import Channel, Contact
|
|
from core.models import TimeStampedModel, UUIDPrimaryKeyModel
|
|
|
|
|
|
class MessageTemplate(UUIDPrimaryKeyModel, TimeStampedModel):
|
|
name = models.CharField(max_length=120)
|
|
channel = models.CharField(max_length=16, choices=Channel.choices)
|
|
subject = models.CharField(max_length=255, blank=True)
|
|
body = models.TextField()
|
|
postcard_front = models.JSONField(default=dict, blank=True)
|
|
postcard_back = models.JSONField(default=dict, blank=True)
|
|
|
|
def __str__(self) -> str:
|
|
return f"{self.name} ({self.channel})"
|
|
|
|
|
|
class Campaign(UUIDPrimaryKeyModel, TimeStampedModel):
|
|
class Status(models.TextChoices):
|
|
DRAFT = "draft", "Draft"
|
|
SCHEDULED = "scheduled", "Scheduled"
|
|
SENDING = "sending", "Sending"
|
|
COMPLETED = "completed", "Completed"
|
|
CANCELLED = "cancelled", "Cancelled"
|
|
|
|
class Audience(models.TextChoices):
|
|
POSTCARD_OPT_IN = "postcard_opt_in", "Mailing list · postcard opt-in"
|
|
CARRIER_ROUTE = "carrier_route", "USPS carrier routes"
|
|
|
|
name = models.CharField(max_length=120)
|
|
channel = models.CharField(max_length=16, choices=Channel.choices)
|
|
audience = models.CharField(
|
|
max_length=32,
|
|
choices=Audience.choices,
|
|
blank=True,
|
|
default="",
|
|
)
|
|
template = models.ForeignKey(
|
|
MessageTemplate,
|
|
null=True,
|
|
blank=True,
|
|
on_delete=models.SET_NULL,
|
|
related_name="directmail_campaigns",
|
|
)
|
|
status = models.CharField(
|
|
max_length=16, choices=Status.choices, default=Status.DRAFT
|
|
)
|
|
scheduled_for = models.DateTimeField(null=True, blank=True)
|
|
created_by = models.ForeignKey(
|
|
settings.AUTH_USER_MODEL,
|
|
null=True,
|
|
blank=True,
|
|
on_delete=models.SET_NULL,
|
|
related_name="directmail_campaigns_created",
|
|
)
|
|
subject_override = models.CharField(max_length=255, blank=True)
|
|
body_override = models.TextField(blank=True)
|
|
# Set when completion summary email is sent (campaign COMPLETED).
|
|
notify_sent_at = models.DateTimeField(null=True, blank=True)
|
|
# PCM purchased-list targeting (ZIP/CRRT codes, listCountID, quote).
|
|
route_targeting = models.JSONField(default=dict, blank=True)
|
|
|
|
class Meta:
|
|
ordering = ["-created_at"]
|
|
|
|
def __str__(self) -> str:
|
|
return self.name
|
|
|
|
|
|
class Message(UUIDPrimaryKeyModel, TimeStampedModel):
|
|
class Status(models.TextChoices):
|
|
DRAFT = "draft", "Draft"
|
|
SCHEDULED = "scheduled", "Scheduled"
|
|
QUEUED = "queued", "Queued"
|
|
SENT = "sent", "Sent"
|
|
DELIVERED = "delivered", "Delivered"
|
|
OPENED = "opened", "Opened"
|
|
CLICKED = "clicked", "Clicked"
|
|
FAILED = "failed", "Failed"
|
|
BOUNCED = "bounced", "Bounced"
|
|
SUPPRESSED = "suppressed", "Suppressed"
|
|
|
|
campaign = models.ForeignKey(
|
|
Campaign, on_delete=models.CASCADE, related_name="messages"
|
|
)
|
|
contact = models.ForeignKey(
|
|
Contact,
|
|
null=True,
|
|
blank=True,
|
|
on_delete=models.CASCADE,
|
|
related_name="directmail_messages",
|
|
)
|
|
channel = models.CharField(max_length=16, choices=Channel.choices)
|
|
status = models.CharField(
|
|
max_length=16, choices=Status.choices, default=Status.DRAFT
|
|
)
|
|
provider = models.CharField(max_length=64, blank=True)
|
|
provider_message_id = models.CharField(max_length=255, blank=True)
|
|
scheduled_for = models.DateTimeField(null=True, blank=True)
|
|
sent_at = models.DateTimeField(null=True, blank=True)
|
|
error = models.TextField(blank=True)
|
|
body_snapshot = models.TextField(blank=True)
|
|
|
|
class Meta:
|
|
ordering = ["-created_at"]
|
|
|
|
def __str__(self) -> str:
|
|
who = self.contact or "carrier-route mailing"
|
|
return f"{self.channel} → {who} ({self.status})"
|
|
|
|
|
|
class ProviderEvent(TimeStampedModel):
|
|
message = models.ForeignKey(
|
|
Message,
|
|
null=True,
|
|
blank=True,
|
|
on_delete=models.SET_NULL,
|
|
related_name="events",
|
|
)
|
|
provider = models.CharField(max_length=64)
|
|
event_type = models.CharField(max_length=64)
|
|
payload = models.JSONField(default=dict, blank=True)
|
|
|
|
|