Campaigns

use Lettr\Laravel\Facades\Lettr;

use Lettr\Dto\Campaign\ListCampaignsFilter;
use Lettr\Enums\CampaignStatus;

$response = Lettr::campaigns()->list();

foreach ($response->campaigns as $campaign) {
    echo $campaign->name;               // "Spring Sale"
    echo $campaign->sentCount;          // 124
    echo $campaign->stats->uniqueOpens; // engagement stats are embedded

    if ($campaign->status === CampaignStatus::Sent) {
        echo 'Already delivered';
    }
}

echo $response->pagination->total;
echo $response->hasMore();

// Filter by status and paginate
$response = Lettr::campaigns()->list(
    ListCampaignsFilter::create()->status(CampaignStatus::Sent)->page(2)->perPage(50),
);

$campaign = Lettr::campaigns()->get('campaign-uuid');

echo $campaign->subject;
echo $campaign->htmlContent; // rendered HTML body — CampaignDetail only
echo $campaign->stats->clicks;

use DateTimeImmutable;
use Lettr\Dto\Campaign\ListCampaignEventsFilter;
use Lettr\Enums\EventType;

$cursor = null;

do {
    $response = Lettr::campaigns()->events('campaign-uuid', ListCampaignEventsFilter::create()
        ->eventType(EventType::Click)
        ->startDate(new DateTimeImmutable('-7 days'))
        ->cursor($cursor)); // null on the first iteration is fine

    foreach ($response->events as $event) {
        echo $event->email;
        echo $event->timestamp;
        echo $event->targetLinkUrl; // for click events
    }

    $cursor = $response->nextCursor;
} while ($response->hasMore());

use DateTimeImmutable;
use DateTimeZone;

// Dispatch a draft campaign immediately (asynchronous; transitions to "preparing")
$campaign = Lettr::campaigns()->send('campaign-uuid');

// Schedule for future delivery — accepts a DateTimeInterface or an ISO-8601 string.
// Calling schedule() on an already-scheduled campaign reschedules it.
Lettr::campaigns()->schedule(
    'campaign-uuid',
    new DateTimeImmutable('2026-06-01 09:00:00', new DateTimeZone('+02:00')),
);

// Cancel a scheduled send, returning the campaign to draft
Lettr::campaigns()->unschedule('campaign-uuid');