Skip to content

messaging.campaigns

campaigns

Campaign messaging DTOs and protocols.

Classes

CampaignBatchDTO

Bases: BaseDTO

One campaign batch payload for the worker callback contract.

Source code in src/codex_platform/messaging/campaigns/dto.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
class CampaignBatchDTO(BaseDTO):
    """One campaign batch payload for the worker callback contract."""

    schema_version: int = PAYLOAD_SCHEMA_VERSION
    campaign_id: str
    template_name: str | None = None
    html_content: str | None = None
    subject: str
    recipients: list[CampaignRecipientDraft]
    base_context: dict[str, Any] = {}
    callback_url: str
    callback_token: str

    @model_validator(mode="after")
    def validate_rendering_mode(self) -> CampaignBatchDTO:
        """Require exactly one campaign rendering mode."""

        if bool(self.template_name) == bool(self.html_content):
            raise ValueError("exactly one of template_name or html_content must be set")
        return self
Functions
validate_rendering_mode()

Require exactly one campaign rendering mode.

Source code in src/codex_platform/messaging/campaigns/dto.py 
37
38
39
40
41
42
43
@model_validator(mode="after")
def validate_rendering_mode(self) -> CampaignBatchDTO:
    """Require exactly one campaign rendering mode."""

    if bool(self.template_name) == bool(self.html_content):
        raise ValueError("exactly one of template_name or html_content must be set")
    return self

CampaignRecipientDraft

Bases: BaseDTO

Recipient data needed by a campaign batch worker.

Source code in src/codex_platform/messaging/campaigns/dto.py 
13
14
15
16
17
18
19
20
21
class CampaignRecipientDraft(BaseDTO):
    """Recipient data needed by a campaign batch worker."""

    recipient_id: str
    email: str
    first_name: str = ""
    last_name: str = ""
    locale: str = "de"
    unsubscribe_token: str | None = None

CampaignDispatcher

Bases: Protocol

Enqueues campaign batches for worker-side delivery.

Source code in src/codex_platform/messaging/campaigns/protocols.py 
10
11
12
13
14
15
class CampaignDispatcher(Protocol):
    """Enqueues campaign batches for worker-side delivery."""

    def enqueue_batch(self, batch: CampaignBatchDTO) -> str:
        """Enqueue a batch and return the backend job identifier."""
        ...
Functions
enqueue_batch(batch)

Enqueue a batch and return the backend job identifier.

Source code in src/codex_platform/messaging/campaigns/protocols.py 
13
14
15
def enqueue_batch(self, batch: CampaignBatchDTO) -> str:
    """Enqueue a batch and return the backend job identifier."""
    ...