@spec cancel(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Cancels a broadcast. A scheduled broadcast goes back to draft; one that is sending stops.

@spec clicked_links(String.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.List.t(Sendio.Broadcasts.ClickedLink.t()))

Lists the links clicked in a broadcast, by clicks.

Options

• :limit - Maximum number of links to return (1-100, default: 20)
• :after - Cursor for pagination
• :before - Cursor for pagination

@spec create(Sendio.Client.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Creates a new broadcast.

Without send: true this saves a draft, and a draft may leave any field empty. With send: true the broadcast needs :from, :subject, an :html or :text body and an audience (:segment_id, :segment_ids or audience: "all").

Options

• :name - Internal friendly name for the broadcast
• :from - The sender email address
• :subject - The email subject
• :reply_to - Reply-to email addresses
• :html - The HTML content
• :text - The plain text content ("" opts out of the generated text part)
• :preview_text - Preview text for email clients
• :topic_id - Scope broadcast to a specific topic
• :segment_id - The segment to send to
• :segment_ids - Several segments to send to (a contact in more than one gets one email)
• :exclude_segment_ids - Segments whose members never get the broadcast
• :audience - "segments" (the default) or "all" (every contact)
• :unsubscribe_scope - "all" or "list" (unsubscribe from the broadcast's segments only)
• :tracking - false turns off open and click tracking (default true)
• :template_engine - "simple" merge tags (the default) or "handlebars"
• :send - true sends the broadcast (or schedules it with :scheduled_at) right away
• :scheduled_at - When to send it, ISO 8601 or natural language; requires send: true

@spec duplicate(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Duplicates a broadcast into a new draft named after it with " (copy)" appended.

@spec estimate(Sendio.Client.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Estimate.t())

Estimates how many contacts an audience reaches, before anything is saved.

Options

• :segment_id, :segment_ids, :exclude_segment_ids, :audience and :topic_id, as in create/2

@spec get(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Gets a broadcast by ID.

@spec get_version(Sendio.Client.t(), String.t(), integer() | String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Version.t())

Gets a version of a broadcast by its version number or ID.

@spec list(Keyword.t()) ::
  Sendio.Client.response(Sendio.List.t(Sendio.Broadcasts.Broadcast.t()))

Lists broadcasts, newest first.

Options

• :limit - Maximum number of broadcasts to return (1-100)
• :after - Cursor for pagination (broadcast ID to start after)
• :before - Cursor for pagination (broadcast ID to start before)
• :status - Only broadcasts with this status ("draft", "scheduled", "queued", "sent", ...)
• :segment_id - Only broadcasts sent to this segment
• :search - Only broadcasts whose name matches

@spec list_versions(String.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.List.t(Sendio.Broadcasts.Version.t()))

Lists the saved versions of a broadcast, newest first.

Options

• :limit - Maximum number of versions to return (1-100)
• :after - Cursor for pagination
• :before - Cursor for pagination

@spec recipients(Sendio.Client.t(), String.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.List.t(Sendio.Broadcasts.Recipient.t()))

Lists the recipients of a broadcast for an event type.

Options

• :type - Required: "sent", "delivered", "opened", "clicked", "bounced", "complained", "unsubscribed" or "suppressed"
• :email - Only recipients whose email contains this value
• :bounce_type - With type: "bounced": "permanent", "transient" or "undetermined"
• :limit - Maximum number of recipients to return (1-100, default: 20)
• :after - Cursor for pagination
• :before - Cursor for pagination

@spec remove(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Empty.t())

Removes a draft or scheduled broadcast.

@spec restore_version(Sendio.Client.t(), String.t(), integer() | String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Version.t())

Restores a version into a draft or scheduled broadcast, saved as a new version.

@spec send(String.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

@spec send(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Sends a draft broadcast.

Options

• :scheduled_at - Optional datetime to schedule the broadcast

@spec stats(Sendio.Client.t(), String.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Stats.t())

Gets the delivery and engagement stats of a broadcast.

@spec test(Sendio.Client.t(), String.t(), String.t() | [String.t()]) ::
  Sendio.Client.response(Sendio.Broadcasts.TestResult.t())

Sends a test of a broadcast to 1 to 5 addresses, personalized with a sample contact and with the subject prefixed [Test].

@spec update(Sendio.Client.t(), String.t(), Keyword.t()) ::
  Sendio.Client.response(Sendio.Broadcasts.Broadcast.t())

Updates a broadcast. Only the options given are changed.

Once a broadcast is sending or sent, only its :name can be changed.

Options

The same as create/2 without :send and :scheduled_at: :name, :from, :subject, :reply_to, :html, :text, :preview_text, :topic_id, :segment_id, :segment_ids, :exclude_segment_ids, :audience, :unsubscribe_scope, :tracking and :template_engine.

@spec update_version(
  Sendio.Client.t(),
  String.t(),
  integer() | String.t(),
  Keyword.t()
) ::
  Sendio.Client.response(Sendio.Broadcasts.Version.t())

Labels a version of a broadcast. A version's content cannot change.

Options

• :name - The version's name
• :comment - The version's comment