Miosa.Email.Campaigns (Miosa v1.0.0)

Admin email campaign lifecycle (GET/POST/etc. /admin/email-campaigns).

Summary

Functions

cancel(client, campaign_id)

Cancel a campaign (POST /admin/email-campaigns/:campaign_id/cancel).

create(client, attrs)

Create an email campaign (POST /admin/email-campaigns).

deliveries(client, campaign_id, filters \\ %{})

List per-recipient delivery records (GET /admin/email-campaigns/:campaign_id/deliveries).

list(client, filters \\ %{})

List email campaigns (GET /admin/email-campaigns).

recipient_count(client, filters \\ %{})

Get estimated recipient count (GET /admin/email-campaigns/recipient-count).

send(client, campaign_id, opts \\ %{})

Trigger send for a campaign (POST /admin/email-campaigns/:campaign_id/send).

Functions

cancel(client, campaign_id)

@spec cancel(Miosa.Client.t(), String.t()) :: Miosa.Client.result(map())

Cancel a campaign (POST /admin/email-campaigns/:campaign_id/cancel).

create(client, attrs)

@spec create(Miosa.Client.t(), map()) :: Miosa.Client.result(map())

Create an email campaign (POST /admin/email-campaigns).

deliveries(client, campaign_id, filters \\ %{})

@spec deliveries(Miosa.Client.t(), String.t(), map()) :: Miosa.Client.result(list())

List per-recipient delivery records (GET /admin/email-campaigns/:campaign_id/deliveries).

list(client, filters \\ %{})

@spec list(Miosa.Client.t(), map()) :: Miosa.Client.result(list())

List email campaigns (GET /admin/email-campaigns).

recipient_count(client, filters \\ %{})

@spec recipient_count(Miosa.Client.t(), map()) :: Miosa.Client.result(map())

Get estimated recipient count (GET /admin/email-campaigns/recipient-count).

send(client, campaign_id, opts \\ %{})

@spec send(Miosa.Client.t(), String.t(), map()) :: Miosa.Client.result(map())

Trigger send for a campaign (POST /admin/email-campaigns/:campaign_id/send).