Web.MailChimp

Documentation

type Key = ByteString

A MailChimp API key.

data Client

A client for MailChimp.

Constructors

Client

Fields

• getLinks :: forall m. MonadIO m => m (Either ServantError Object)
• makeListClient :: ListId -> ListClient

  Create a client for a list.

makeClient

Arguments

:: Manager

A manager

-> Key

A key

-> Maybe Client

The client

Create a client for MailChimp.

data ListClient

A client for a list.

Constructors

ListClient

Fields

• listMemberClient :: ListMemberClient

type ListId = Id

A list ID.

data ListMemberClient

Constructors

ListMemberClient

Fields

• addListMember :: forall m. MonadIO m => ListMemberRequest -> m (Either ServantError ListMemberResponse)

  Add a new list member.

• getListMembers :: forall m. MonadIO m => m (Either ServantError [ListMemberResponse])

  Get information about members in a list.

• getListMember :: forall m. MonadIO m => ListMemberId -> m (Either ServantError ListMemberResponse)

  Get information about a specific list member.

• updateListMember :: forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)

  Update a list member.

• addOrUpdateListMember :: forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)

  Add or update a list member.

• deleteListMember :: forall m. MonadIO m => ListMemberId -> m (Either ServantError String)

  Remove a list member.

makeListMemberClient :: Manager -> Key -> ListId -> Maybe ListMemberClient

Create a client for a list members.

data ListMemberRequest

Constructors

ListMemberRequest

Fields

• listMemberEmailAddress :: Text
• listMemberMergeFields :: [(Text, Text)]
• listMemberStatus :: ListMemberStatus
• listMemberExtra :: [(Text, Value)]

Instances

Show ListMemberRequest

Methods

showsPrec :: Int -> ListMemberRequest -> ShowS

show :: ListMemberRequest -> String

showList :: [ListMemberRequest] -> ShowS

ToJSON ListMemberRequest

Methods

toJSON :: ListMemberRequest -> Value

toEncoding :: ListMemberRequest -> Encoding

makeListMemberRequest

Arguments

:: Text

Email

-> ListMemberStatus

-> ListMemberRequest

Create a list member request.

data ListMemberResponse

Constructors

ListMemberResponse

Fields

• listMemberId :: ListMemberId

Instances

Show ListMemberResponse

Methods

showsPrec :: Int -> ListMemberResponse -> ShowS

show :: ListMemberResponse -> String

showList :: [ListMemberResponse] -> ShowS

FromJSON ListMemberResponse

Methods

parseJSON :: Value -> Parser ListMemberResponse

type ListMemberId = Id

data ListMemberStatus

Constructors

Cleaned

Pending

Subscribed

Unsubscribed

Instances

Show ListMemberStatus

Methods

showsPrec :: Int -> ListMemberStatus -> ShowS

show :: ListMemberStatus -> String

showList :: [ListMemberStatus] -> ShowS

ToJSON ListMemberStatus

Methods

toJSON :: ListMemberStatus -> Value

toEncoding :: ListMemberStatus -> Encoding

type Id = Text

An ID.

version :: Version

makeManager :: IO Manager

Create a manager.