-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Bindings for the MailChimp API
--   
--   Haskell bindings for the MailChimp API.
@package mailchimp
@version 0.1.0


module Web.MailChimp.Tutorial


module Web.MailChimp

-- | A MailChimp API key.
type Key = ByteString

-- | A client for MailChimp.
data Client
Client :: (forall m. MonadIO m => m (Either ServantError Object)) -> (ListId -> ListClient) -> Client
[getLinks] :: Client -> forall m. MonadIO m => m (Either ServantError Object)

-- | Create a client for a list.
[makeListClient] :: Client -> ListId -> ListClient

-- | Create a client for MailChimp.
makeClient :: Manager -> Key -> Maybe Client

-- | A client for a list.
data ListClient
ListClient :: ListMemberClient -> ListClient
[listMemberClient] :: ListClient -> ListMemberClient

-- | A list ID.
type ListId = Id
data ListMemberClient
ListMemberClient :: (forall m. MonadIO m => ListMemberRequest -> m (Either ServantError ListMemberResponse)) -> (forall m. MonadIO m => m (Either ServantError [ListMemberResponse])) -> (forall m. MonadIO m => ListMemberId -> m (Either ServantError ListMemberResponse)) -> (forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)) -> (forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)) -> (forall m. MonadIO m => ListMemberId -> m (Either ServantError String)) -> ListMemberClient

-- | Add a new list member.
[addListMember] :: ListMemberClient -> forall m. MonadIO m => ListMemberRequest -> m (Either ServantError ListMemberResponse)

-- | Get information about members in a list.
[getListMembers] :: ListMemberClient -> forall m. MonadIO m => m (Either ServantError [ListMemberResponse])

-- | Get information about a specific list member.
[getListMember] :: ListMemberClient -> forall m. MonadIO m => ListMemberId -> m (Either ServantError ListMemberResponse)

-- | Update a list member.
[updateListMember] :: ListMemberClient -> forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)

-- | Add or update a list member.
[addOrUpdateListMember] :: ListMemberClient -> forall m. MonadIO m => ListMemberId -> ListMemberRequest -> m (Either ServantError ListMemberResponse)

-- | Remove a list member.
[deleteListMember] :: ListMemberClient -> forall m. MonadIO m => ListMemberId -> m (Either ServantError String)

-- | Create a client for a list members.
makeListMemberClient :: Manager -> Key -> ListId -> Maybe ListMemberClient
data ListMemberRequest
ListMemberRequest :: Text -> [(Text, Text)] -> ListMemberStatus -> [(Text, Value)] -> ListMemberRequest
[listMemberEmailAddress] :: ListMemberRequest -> Text
[listMemberMergeFields] :: ListMemberRequest -> [(Text, Text)]
[listMemberStatus] :: ListMemberRequest -> ListMemberStatus
[listMemberExtra] :: ListMemberRequest -> [(Text, Value)]

-- | Create a list member request.
makeListMemberRequest :: Text -> ListMemberStatus -> ListMemberRequest
data ListMemberResponse
ListMemberResponse :: ListMemberId -> ListMemberResponse
[listMemberId] :: ListMemberResponse -> ListMemberId
type ListMemberId = Id
data ListMemberStatus
Cleaned :: ListMemberStatus
Pending :: ListMemberStatus
Subscribed :: ListMemberStatus
Unsubscribed :: ListMemberStatus

-- | An ID.
type Id = Text
version :: Version

-- | Create a manager.
makeManager :: IO Manager