-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | A Haskell library to handle mailing lists in MailchimpSimple using its JSON API. -- @package MailchimpSimple @version 0.1.0.0 module MailchimpSimple.Logger -- | Constructor for the Log levels data LogLevels ERROR :: LogLevels DEBUG :: LogLevels INFO :: LogLevels writeLog :: LogLevels -> String -> String -> String -> IO () instance Show LogLevels instance Eq LogLevels instance Show Logger instance Eq Logger module MailchimpSimple.Types -- | JSON data structure for a single subscription data Subscription Subscription :: String -> String -> EmailId -> String -> Bool -> Bool -> Bool -> Bool -> Subscription -- | API key of the Mailchimp account s_apikey :: Subscription -> String -- | List ID of the mailing list, by calling s_id :: Subscription -> String -- | Example: jon@example.com s_email :: Subscription -> EmailId -- | Give html/text s_email_type :: Subscription -> String s_dou_opt :: Subscription -> Bool s_up_ex :: Subscription -> Bool s_rep_int :: Subscription -> Bool s_send :: Subscription -> Bool -- | Enum type JSON data structure for Email related variables data EmailId Email :: String -> EmailId EmailUniqueId :: String -> EmailId ListEmailId :: String -> EmailId data MailList MailList :: String -> Filters -> Int -> Int -> String -> String -> MailList -- | API key of the Mailchimp account l_apikey :: MailList -> String l_filters :: MailList -> Filters l_start :: MailList -> Int l_limit :: MailList -> Int l_sort_field :: MailList -> String l_sort_dir :: MailList -> String data Filters Filters :: String -> String -> Filters list_id :: Filters -> String list_name :: Filters -> String data Subscribers Subscribers :: String -> String -> String -> Subscribers -- | API key of the Mailchimp account su_apikey :: Subscribers -> String -- | List ID of the mailing list su_id :: Subscribers -> String su_status :: Subscribers -> String -- | JSON data structure for batch subscriptions data BatchSubscription BatchSubscription :: String -> String -> [Batch] -> Bool -> Bool -> Bool -> BatchSubscription -- | API key of the Mailchimp account b_apikey :: BatchSubscription -> String -- | List ID of the mailing list b_id :: BatchSubscription -> String -- | Array of tuples of email address and email type b_batch :: BatchSubscription -> [Batch] b_dou_opt :: BatchSubscription -> Bool b_up_ex :: BatchSubscription -> Bool b_rep_int :: BatchSubscription -> Bool data Batch Batch :: EmailId -> String -> Batch b_email :: Batch -> EmailId b_email_type :: Batch -> String data Campaign Campaign :: String -> String -> Options -> Content -> Campaign c_apikey :: Campaign -> String c_type :: Campaign -> String c_options :: Campaign -> Options c_content :: Campaign -> Content data Options Options :: String -> String -> String -> String -> String -> Int -> Options o_list_id :: Options -> String o_subject :: Options -> String o_from_email :: Options -> String o_from_name :: Options -> String o_to_name :: Options -> String o_template_id :: Options -> Int data Content HTML :: String -> Content Text :: String -> Content URL :: String -> Content data SendMail SendMail :: String -> String -> SendMail -- | API key of the Mailchimp account m_apikey :: SendMail -> String -- | Campaign ID of the campaign to be sent m_cid :: SendMail -> String data Template Template :: String -> TemplateTypes -> Template t_apikey :: Template -> String t_types :: Template -> TemplateTypes data TemplateTypes TemplateTypes :: Bool -> Bool -> Bool -> TemplateTypes user :: TemplateTypes -> Bool gallery :: TemplateTypes -> Bool base :: TemplateTypes -> Bool -- | Response JSON from 'lists/subscribe.json' call data SubscriptionResponse SubscriptionResponse :: String -> String -> String -> SubscriptionResponse email :: SubscriptionResponse -> String euid :: SubscriptionResponse -> String leid :: SubscriptionResponse -> String -- | Response JSON from 'lists/list.json' call, which lists the mailing -- lists in the given account with relevant API key data MailListResponse MailListResponse :: Maybe String -> Maybe String -> MailListResponse -- | List name l_name :: MailListResponse -> Maybe String -- | List ID l_id :: MailListResponse -> Maybe String -- | Response JSON from 'lists/members.json' call, which contains the -- details each subscriber in the given mailing list data ListSubscribersResponse ListSubscribersResponse :: Maybe String -> Maybe String -> Maybe String -> Maybe String -> ListSubscribersResponse -- | Subscriber's name s_name :: ListSubscribersResponse -> Maybe String -- | Subscriber's euid s_euid :: ListSubscribersResponse -> Maybe String s_list_name :: ListSubscribersResponse -> Maybe String s_emailType :: ListSubscribersResponse -> Maybe String -- | Response JSON from the 'lists/batch-subscribe.json' call, which -- contains the information of the subscriptions of each newly added -- member data BatchSubscriptionResponse BatchSubscriptionResponse :: Maybe Int -> [Maybe SubscriptionResponse] -> BatchSubscriptionResponse add_count :: BatchSubscriptionResponse -> Maybe Int adds :: BatchSubscriptionResponse -> [Maybe SubscriptionResponse] data SendMailResponse SendMailResponse :: Bool -> SendMailResponse complete :: SendMailResponse -> Bool data TemplateResponse TemplateResponse :: Maybe String -> Maybe Int -> TemplateResponse t_name :: TemplateResponse -> Maybe String t_id :: TemplateResponse -> Maybe Int instance Show EmailId instance Show Subscription instance Show Batch instance Show BatchSubscription instance Show Filters instance Show MailList instance Show Subscribers instance Show Options instance Generic Options instance Show Content instance Show Campaign instance Generic Campaign instance Show SendMail instance Generic SendMail instance Show TemplateTypes instance Generic TemplateTypes instance Show Template instance Generic Template instance Show SubscriptionResponse instance Show MailListResponse instance Generic MailListResponse instance Show ListSubscribersResponse instance Generic ListSubscribersResponse instance Show BatchSubscriptionResponse instance Generic BatchSubscriptionResponse instance Show SendMailResponse instance Generic SendMailResponse instance Show TemplateResponse instance Generic TemplateResponse instance Datatype D1Options instance Constructor C1_0Options instance Selector S1_0_0Options instance Selector S1_0_1Options instance Selector S1_0_2Options instance Selector S1_0_3Options instance Selector S1_0_4Options instance Selector S1_0_5Options instance Datatype D1Campaign instance Constructor C1_0Campaign instance Selector S1_0_0Campaign instance Selector S1_0_1Campaign instance Selector S1_0_2Campaign instance Selector S1_0_3Campaign instance Datatype D1SendMail instance Constructor C1_0SendMail instance Selector S1_0_0SendMail instance Selector S1_0_1SendMail instance Datatype D1TemplateTypes instance Constructor C1_0TemplateTypes instance Selector S1_0_0TemplateTypes instance Selector S1_0_1TemplateTypes instance Selector S1_0_2TemplateTypes instance Datatype D1Template instance Constructor C1_0Template instance Selector S1_0_0Template instance Selector S1_0_1Template instance Datatype D1MailListResponse instance Constructor C1_0MailListResponse instance Selector S1_0_0MailListResponse instance Selector S1_0_1MailListResponse instance Datatype D1ListSubscribersResponse instance Constructor C1_0ListSubscribersResponse instance Selector S1_0_0ListSubscribersResponse instance Selector S1_0_1ListSubscribersResponse instance Selector S1_0_2ListSubscribersResponse instance Selector S1_0_3ListSubscribersResponse instance Datatype D1BatchSubscriptionResponse instance Constructor C1_0BatchSubscriptionResponse instance Selector S1_0_0BatchSubscriptionResponse instance Selector S1_0_1BatchSubscriptionResponse instance Datatype D1SendMailResponse instance Constructor C1_0SendMailResponse instance Selector S1_0_0SendMailResponse instance Datatype D1TemplateResponse instance Constructor C1_0TemplateResponse instance Selector S1_0_0TemplateResponse instance Selector S1_0_1TemplateResponse instance ToJSON TemplateResponse instance FromJSON TemplateResponse instance ToJSON SendMailResponse instance FromJSON SendMailResponse instance ToJSON BatchSubscriptionResponse instance FromJSON BatchSubscriptionResponse instance ToJSON ListSubscribersResponse instance FromJSON ListSubscribersResponse instance ToJSON MailListResponse instance FromJSON MailListResponse instance ToJSON SubscriptionResponse instance FromJSON SubscriptionResponse instance ToJSON TemplateTypes instance FromJSON TemplateTypes instance ToJSON Template instance FromJSON Template instance ToJSON SendMail instance FromJSON SendMail instance FromJSON Content instance ToJSON Content instance ToJSON Options instance FromJSON Options instance ToJSON Campaign instance FromJSON Campaign instance ToJSON Subscribers instance FromJSON Subscribers instance ToJSON Filters instance FromJSON Filters instance ToJSON MailList instance FromJSON MailList instance ToJSON Batch instance FromJSON Batch instance ToJSON BatchSubscription instance FromJSON BatchSubscription instance ToJSON EmailId instance FromJSON EmailId instance ToJSON Subscription instance FromJSON Subscription module MailchimpSimple -- | Add a new subscriber addSubscriber :: String -> String -> String -> String -> IO (Either String SubscriptionResponse) -- | Add a batch of subscribers batchSubscribe :: String -> String -> [String] -> IO BatchSubscriptionResponse -- | List mailing lists in a particular account with the given API key listMailingLists :: String -> IO [MailListResponse] -- | List subscribers in a mailing list with the given list ID listSubscribers :: String -> String -> IO [ListSubscribersResponse] -- | Get the templates saved in hte Mailchimp account getTemplates :: String -> IO [TemplateResponse] -- | Create a new campaign and save it in the Campaigns list createCampaign :: String -> String -> String -> String -> String -> String -> String -> Int -> String -> IO (Maybe String) -- | Send a saved email campaign sendEmail :: String -> String -> IO (Either String SendMailResponse)