Web.MailChimp.List.Member

Documentation

type ListMemberApi = (ReqBody '[JSON] ListMemberRequest :> Post '[JSON] ListMemberResponse) :<|> ((QueryParam "offset" Int :> Get '[JSON] ListMembersResponse) :<|> ((Capture "subscriber_hash" ListMemberId :> Get '[JSON] ListMemberResponse) :<|> ((Capture "subscriber_hash" ListMemberId :> (ReqBody '[JSON] ListMemberRequest :> Patch '[JSON] ListMemberResponse)) :<|> ((Capture "subscriber_hash" ListMemberId :> (ReqBody '[JSON] ListMemberRequest :> Put '[JSON] ListMemberResponse)) :<|> (Capture "subscriber_hash" ListMemberId :> Delete '[JSON] String)))))

data ListMemberClient

Constructors

ListMemberClient

Fields

• addListMember :: ListMemberRequest -> ClientM ListMemberResponse

  Add a new list member.

• getListMembers :: Maybe Int -> ClientM ListMembersResponse

  Get information about members in a list.

• getListMember :: ListMemberId -> ClientM ListMemberResponse

  Get information about a specific list member.

• updateListMember :: ListMemberId -> ListMemberRequest -> ClientM ListMemberResponse

  Update a list member.

• addOrUpdateListMember :: ListMemberId -> ListMemberRequest -> ClientM ListMemberResponse

  Add or update a list member.

• deleteListMember :: ListMemberId -> ClientM String

  Remove a list member.

Instances

Generic ListMemberClient

Associated Types

type Rep ListMemberClient :: * -> *

Methods

from :: ListMemberClient -> Rep ListMemberClient x

to :: Rep ListMemberClient x -> ListMemberClient

Generic ListMemberClient

Associated Types

type Code ListMemberClient :: [[*]]

Methods

from :: ListMemberClient -> Rep ListMemberClient

to :: Rep ListMemberClient -> ListMemberClient

(~) * (Client * ListMemberApi) client => ClientLike client ListMemberClient

Methods

mkClient :: client -> ListMemberClient

type Rep ListMemberClient

type Rep ListMemberClient = D1 (MetaData "ListMemberClient" "Web.MailChimp.List.Member" "mailchimp-0.3.0-76eHjVCU8YXF07lc4HTWdQ" False) (C1 (MetaCons "ListMemberClient" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "addListMember") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListMemberRequest -> ClientM ListMemberResponse))) ((:*:) (S1 (MetaSel (Just Symbol "getListMembers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Int -> ClientM ListMembersResponse))) (S1 (MetaSel (Just Symbol "getListMember") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListMemberId -> ClientM ListMemberResponse))))) ((:*:) (S1 (MetaSel (Just Symbol "updateListMember") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListMemberId -> ListMemberRequest -> ClientM ListMemberResponse))) ((:*:) (S1 (MetaSel (Just Symbol "addOrUpdateListMember") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListMemberId -> ListMemberRequest -> ClientM ListMemberResponse))) (S1 (MetaSel (Just Symbol "deleteListMember") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ListMemberId -> ClientM String)))))))

type Code ListMemberClient

type Code ListMemberClient = GCode ListMemberClient

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

toJSONList :: [ListMemberRequest] -> Value

toEncodingList :: [ListMemberRequest] -> Encoding

makeListMemberRequest

Arguments

:: Text

Email

-> ListMemberStatus

-> ListMemberRequest

Create a list member request.

data ListMemberResponse

Constructors

ListMemberResponse

Fields

• listMemberId :: ListMemberId
• listMemberResponseEmail :: Text
• listMemberResponseStatus :: ListMemberStatus

Instances

Show ListMemberResponse

Methods

showsPrec :: Int -> ListMemberResponse -> ShowS

show :: ListMemberResponse -> String

showList :: [ListMemberResponse] -> ShowS

FromJSON ListMemberResponse

Methods

parseJSON :: Value -> Parser ListMemberResponse

parseJSONList :: Value -> Parser [ListMemberResponse]

data ListMembersResponse

Constructors

ListMembersResponse

Fields

• listMembersMembers :: [ListMemberResponse]

Instances

Show ListMembersResponse

Methods

showsPrec :: Int -> ListMembersResponse -> ShowS

show :: ListMembersResponse -> String

showList :: [ListMembersResponse] -> ShowS

FromJSON ListMembersResponse

Methods

parseJSON :: Value -> Parser ListMembersResponse

parseJSONList :: Value -> Parser [ListMembersResponse]

getAllListMembers :: ListMemberClient -> ClientM [ListMemberResponse]

Since: 0.3.0

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

toJSONList :: [ListMemberStatus] -> Value

toEncodingList :: [ListMemberStatus] -> Encoding

FromJSON ListMemberStatus

Methods

parseJSON :: Value -> Parser ListMemberStatus

parseJSONList :: Value -> Parser [ListMemberStatus]