Control.Monad.Twilio

The Twilio monad

type Twilio = TwilioT IO

This monad allows you to make authenticated REST API requests to Twilio using your AccountSID and AuthToken.

runTwilio :: Credentials -> Twilio a -> IO a

Run zero or more REST API requests to Twilio.

runTwilio'

Arguments

:: IO String

Account SID

-> IO String

Authentication Token

-> Twilio a

-> IO a

Parse an AccountSID and AuthToken before running zero or more REST API requests to Twilio.

For example, you can fetch the Calls resource in the IO monad as follows:

module Main where

import Control.Monad.IO.Class (liftIO)
import System.Environment (getEnv)
import Twilio.Calls as Calls
import Twilio.Types

-- | Print calls.
main :: IO ()
main = runTwilio' (getEnv "ACCOUNT_SID")
                  (getEnv "AUTH_TOKEN")
     $ Calls.get >>= liftIO . print

The Twilio monad transformer

newtype TwilioT m a

This monad transformer allows you to make authenticated REST API requests to Twilio using your AccountSID and AuthToken.

Constructors

TwilioT (Monad m => (Credentials, AccountSID) -> RequestT m a)

Instances

MonadTrans TwilioT

Methods

lift :: Monad m => m a -> TwilioT m a

Monad m => Monad (TwilioT m)

Methods

(>>=) :: TwilioT m a -> (a -> TwilioT m b) -> TwilioT m b

(>>) :: TwilioT m a -> TwilioT m b -> TwilioT m b

return :: a -> TwilioT m a

fail :: String -> TwilioT m a

Functor (TwilioT m)

Methods

fmap :: (a -> b) -> TwilioT m a -> TwilioT m b

(<$) :: a -> TwilioT m b -> TwilioT m a

Applicative m => Applicative (TwilioT m)

Methods

pure :: a -> TwilioT m a

(<*>) :: TwilioT m (a -> b) -> TwilioT m a -> TwilioT m b

(*>) :: TwilioT m a -> TwilioT m b -> TwilioT m b

(<*) :: TwilioT m a -> TwilioT m b -> TwilioT m a

MonadIO m => MonadIO (TwilioT m)

Methods

liftIO :: IO a -> TwilioT m a

MonadThrow m => MonadThrow (TwilioT m)

Methods

throwM :: Exception e => e -> TwilioT m a

Monad m => MonadRequest (TwilioT m)

Methods

request :: (Response ByteString -> TwilioT m a) -> Request -> TwilioT m a

(MonadThrow m, Delete1 a) => Delete (a -> TwilioT m ())

Instances of Delete1 are instances of Delete.

Methods

delete :: a -> TwilioT m ()

(MonadThrow m, Post3 a b c r) => Post (a -> b -> c -> TwilioT m r)

Methods

post :: a -> b -> c -> TwilioT m r

(MonadThrow m, Post2 a b r) => Post (a -> b -> TwilioT m r)

Methods

post :: a -> b -> TwilioT m r

(MonadThrow m, Post1 a r) => Post (a -> TwilioT m r)

Instances of Post1 are instances of Post.

Methods

post :: a -> TwilioT m r

(MonadThrow m, Post0 r) => Post (TwilioT m r)

Instances of Post0 are instances of Post.

Methods

post :: TwilioT m r

(MonadThrow m, Get2 a b r) => Get (a -> b -> TwilioT m r)

Instances of Get2 are instances of Get.

Methods

get :: a -> b -> TwilioT m r

(MonadThrow m, Get1 a r) => Get (a -> TwilioT m r)

Instances of Get1 are instances of Get.

Methods

get :: a -> TwilioT m r

(MonadThrow m, Get0 r) => Get (TwilioT m r)

Instances of Get0 are instances of Get.

Methods

get :: TwilioT m r

Monad m => MonadReader (Credentials, AccountSID) (TwilioT m)

Methods

ask :: TwilioT m (Credentials, AccountSID)

local :: ((Credentials, AccountSID) -> (Credentials, AccountSID)) -> TwilioT m a -> TwilioT m a

reader :: ((Credentials, AccountSID) -> a) -> TwilioT m a

runTwilioT :: MonadIO m => Credentials -> TwilioT m a -> m a

Run zero or more REST API requests to Twilio, unwrapping the inner monad m.

runTwilioT'

Arguments

:: (Functor m, MonadThrow m, MonadIO m)

=> m String

Account SID

-> m String

Authentication Token

-> TwilioT m a

-> m a

Parse an AccountSID and AuthToken before running zero or more REST API requests to Twilio, unwrapping the inner monad m.

Types

type Credentials = (AccountSID, AuthToken)

Your AccountSID and AuthToken are used to make authenticated REST API requests to Twilio.

data TwilioException

The set of Exceptions that may be thrown when attempting to make requests against Twilio's REST API.

Constructors

InvalidSID !Text

InvalidAuthToken !Text

InvalidCredentials

UnexpectedResponse !(Response ByteString)

Instances

Eq TwilioException

Methods

(==) :: TwilioException -> TwilioException -> Bool

(/=) :: TwilioException -> TwilioException -> Bool

Show TwilioException

Methods

showsPrec :: Int -> TwilioException -> ShowS

show :: TwilioException -> String

showList :: [TwilioException] -> ShowS

Exception TwilioException

Methods

toException :: TwilioException -> SomeException

fromException :: SomeException -> Maybe TwilioException

displayException :: TwilioException -> String