ExChimp.List (ExChimp v0.1.0) View Source

List-oriented API calls.

Link to this section Summary

Link to this section Types

Specs

member_status() :: :subscribed | :unsubscribed | :cleaned | :pending

Link to this section Functions

Link to this function

add_member(api_key, list_id, status, email)

View Source

Specs

add_member(binary(), binary(), member_status(), binary()) ::
  {:ok, map()} | {:error, binary()}
Link to this function

add_member(api_key, list_id, status, email, merge_fields, other_fields \\ %{})

View Source

Specs

add_member(binary(), binary(), member_status(), binary(), map(), map()) ::
  {:ok, map()} | {:error, binary()}

Specs

all(binary()) :: {:ok, [map()]}
Link to this function

destroy_member(api_key, list_id, email)

View Source

Specs

destroy_member(binary(), binary(), binary()) ::
  {:ok, map()} | {:error, binary()}
Link to this function

members(api_key, list_id)

View Source

Specs

members(binary(), binary()) :: {:ok, map()} | {:error, binary()}