twiml-0.2.0.0: TwiML library for Haskell

Copyright(C) 2014-15 Mark Andrus Roberts
LicenseBSD-style (see the file LICENSE)
MaintainerMark Andrus Roberts <markandrusroberts@gmail.com>
Stabilityprovisional
Safe HaskellNone
LanguageHaskell98

Text.XML.Twiml.Internal.Twiml

Contents

Description

This module defines all of the TwiML verbs and nouns in a single place (mainly due to a few mutually-recursive definitions). This modules also exposeses the internals of each TwiML's attributes.

Prefer the definitions re-exported by the Text.XML.Twiml and Text.XML.Twiml.Verbs modules to those exported here.

Synopsis

TwiML

data MessagingTwiml Source

Constructors

forall i . MessagingTwiml (IxFree MessagingVerbsF i Void) 

Instances

newtype MessagingVerbsF i a Source

Constructors

MessagingVerbsF 

Fields

getMessagingVerbsF :: (MessageF i :+: (RedirectF i :+: (SmsF i :+: EndF i))) a
 

Instances

data VoiceTwiml Source

Constructors

forall i . VoiceTwiml (IxFree VoiceVerbsF i Void) 

Instances

newtype VoiceVerbsF i a Source

Constructors

VoiceVerbsF 

Fields

getVoiceVerbsF :: (SayF i :+: (PlayF i :+: (GatherF i :+: (SmsF i :+: (DialF i :+: (EnqueueF i :+: (LeaveF i :+: (HangupF i :+: (RecordF i :+: (RedirectF i :+: (RejectF i :+: (PauseF i :+: EndF i)))))))))))) a
 

Instances

Functor (VoiceVerbsF i) Source 
Show1 [*] VoiceVerbsF Source 
Functor1 [*] VoiceVerbsF Source 
(:<:) (f i) ((:+:) * (SayF i) ((:+:) * (PlayF i) ((:+:) * (GatherF i) ((:+:) * (SmsF i) ((:+:) * (DialF i) ((:+:) * (EnqueueF i) ((:+:) * (LeaveF i) ((:+:) * (HangupF i) ((:+:) * (RecordF i) ((:+:) * (RedirectF i) ((:+:) * (RejectF i) ((:+:) * (PauseF i) (EndF i))))))))))))) => (f i) :<: (VoiceVerbsF i) Source 
Show a => Show (VoiceVerbsF i a) Source 
Generic (VoiceVerbsF i a) Source 
ToXML a => ToXML (VoiceVerbsF i a) Source 
ToXML (IxFree * VoiceVerbsF i Void) Source 
type Rep (VoiceVerbsF i a) Source 

type family Base d Source

Base maps the empty data declaration for a TwiML verb to its corresponding base functor.

Equations

Base Dial = DialF 
Base End = EndF 
Base Enqueue = EnqueueF 
Base Gather = GatherF 
Base Hangup = HangupF 
Base Leave = LeaveF 
Base Message = MessageF 
Base Pause = PauseF 
Base Play = PlayF 
Base Record = RecordF 
Base Redirect = RedirectF 
Base Reject = RejectF 
Base Say = SayF 
Base Sms = SmsF 
Base Client = ClientF 
Base Conference = ConferenceF 
Base Number = NumberF 
Base Queue = QueueF 
Base Sip = SipF 

type IsTwimlLike f i = (Functor1 f, Base i `[i]` :<: f `[i]`) Source

type TwimlLike f i = TwimlLike' f `[i]` Source

type TwimlLike' f = IxFree f Source

response :: IxFree VoiceVerbsF i Void -> VoiceTwiml Source

Nouns

data DialNoun Source

Constructors

forall i . DialNoun (IxFree DialNounF i Void) 

Instances

newtype DialNounF i a Source

Constructors

DialNounF 

Fields

getDialNounF :: (ClientF i :+: (ConferenceF i :+: (NumberF i :+: (QueueF i :+: SipF i)))) a
 

Instances

Client

data Client Source

data ClientF i a Source

Constructors

(Proxy i ~ Proxy `[Client]`) => ClientF String ClientAttributes 

Instances

data ClientAttributes Source

Constructors

ClientAttributes 

Fields

_clientUrl :: !(Maybe URL)
 
_clientMethod :: !(Maybe Method)
 

Instances

Conference

data Conference Source

data ConferenceF i a Source

Constructors

(Proxy i ~ Proxy `[Conference]`) => ConferenceF String ConferenceAttributes 

Instances

data ConferenceAttributes Source

Constructors

ConferenceAttributes 

Fields

_conferenceMuted :: !(Maybe Bool)
 
_conferenceBeep :: !(Maybe Bool)
 
_conferenceStartOnEnter :: !(Maybe Bool)
 
_conferenceEndOnExit :: !(Maybe Bool)
 
_conferenceWaitURL :: !(Maybe URL)
 
_conferenceWaitMethod :: !(Maybe Method)
 
_conferenceMaxParticipants :: !(Maybe Natural)
 

Instances

Number

data Number Source

data NumberF i a Source

Constructors

(Proxy i ~ Proxy `[Number]`) => NumberF String NumberAttributes 

Instances

data NumberAttributes Source

Constructors

NumberAttributes 

Fields

_numberSendDigits :: !(Maybe Digits)
 
_numberUrl :: !(Maybe URL)
 
_numberMethod :: !(Maybe Method)
 

Instances

Queue

data Queue Source

data QueueF i a Source

Constructors

(Proxy i ~ Proxy `[Queue]`) => QueueF String QueueAttributes 

Instances

data QueueAttributes Source

Constructors

QueueAttributes 

Fields

_queueUrl :: !(Maybe URL)
 
_queueMethod :: !(Maybe Method)
 

Instances

Sip

data Sip Source

data SipF i a Source

Constructors

(Proxy i ~ Proxy `[Sip]`) => SipF URL SipAttributes 

Instances

data SipAttributes Source

Constructors

SipAttributes 

Fields

_sipUsername :: !(Maybe String)
 
_sipPassword :: !(Maybe String)
 
_sipTransport :: !(Maybe Transport)
 
_sipHeaders :: !(Maybe String)
 
_sipUrl :: !(Maybe URL)
 
_sipMethod :: !(Maybe Method)
 

Instances

Verbs

Dial

data Dial Source

data DialF i a Source

Constructors

(Proxy i ~ Proxy `[Dial]`) => DialF EitherDialNounString DialAttributes a 

Instances

data DialAttributes Source

Constructors

DialAttributes 

Fields

_dialAction :: !(Maybe URL)
 
_dialMethod :: !(Maybe Method)
 
_dialTimeout :: !(Maybe Natural)
 
_dialHangupOnStar :: !(Maybe Bool)
 
_dialTimeLimit :: !(Maybe Natural)
 
_dialCallerId :: !(Maybe String)
 
_dialRecord' :: !(Maybe Bool)
 

Instances

End

data End Source

data EndF i a Source

Constructors

(Proxy i ~ Proxy `[End]`) => EndF 

Instances

Enqueue

data Enqueue Source

data EnqueueF i a Source

Constructors

(Proxy i ~ Proxy `[Enqueue]`) => EnqueueF String EnqueueAttributes a 

Instances

data EnqueueAttributes Source

Constructors

EnqueueAttributes 

Fields

_enqueueAction :: !(Maybe URL)
 
_enqueueMethod :: !(Maybe Method)
 
_enqueueWaitURL :: !(Maybe URL)
 
_enqueueWaitMethod :: !(Maybe Method)
 

Instances

Hangup

data Gather Source

data GatherF i a where Source

Constructors

GatherF :: Nest i In Gather => GatherAttributes -> IxFree VoiceVerbsF i Void -> a -> GatherF `[Gather]` a 

Instances

data GatherAttributes Source

See https://www.twilio.com/docs/api/twiml/gather#attributes.

Constructors

GatherAttributes 

Fields

_gatherAction :: Maybe URL
 
_gatherMethod :: Maybe Method
 
_gatherTimeout :: Maybe Natural
 
_gatherFinishOnKey :: Maybe Key
 
_gatherNumDigits :: Maybe Natural
 

Instances

type family Nest a i b Source

Equations

Nest i In Gather = (Record ∉ i, Gather ∉ i, Sms ∉ i, Dial ∉ i, Enqueue ∉ i, Leave ∉ i, Hangup ∉ i, Redirect ∉ i, Reject ∉ i) 

data In Source

Hangup

data Hangup Source

data HangupF i a Source

Constructors

(Proxy i ~ Proxy `[Hangup]`) => HangupF 

Instances

Leave

data Leave Source

data LeaveF i a Source

Constructors

(Proxy i ~ Proxy `[Leave]`) => LeaveF 

Instances

Message

data Message Source

data MessageF i a Source

Constructors

(Proxy i ~ Proxy `[Message]`) => MessageF String MessageAttributes a 

Instances

data MessageAttributes Source

Constructors

MessageAttributes 

Fields

_messageTo :: !(Maybe String)
 
_messageFrom :: !(Maybe String)
 
_messageAction :: !(Maybe URL)
 
_messageMethod :: !(Maybe Method)
 
_messageStatusCallback :: !(Maybe URL)
 

Instances

Pause

data Pause Source

data PauseF i a Source

Constructors

(Proxy i ~ Proxy `[Pause]`) => PauseF PauseAttributes a 

Instances

data PauseAttributes Source

Constructors

PauseAttributes 

Fields

_pauseDuration :: !(Maybe Natural)
 

Instances

Play

data Play Source

data PlayF i a Source

Constructors

(Proxy i ~ Proxy `[Play]`) => PlayF MaybeURL PlayAttributes a 

Instances

data PlayAttributes Source

Constructors

PlayAttributes 

Fields

_playLoop :: !(Maybe Natural)
 
_playDigits :: !(Maybe Digits)
 

Instances

Record

data Record Source

data RecordF i a Source

Constructors

(Proxy i ~ Proxy `[Record]`) => RecordF RecordAttributes a 

Instances

data RecordAttributes Source

Constructors

RecordAttributes 

Fields

_recordAction :: !(Maybe URL)
 
_recordMethod :: !(Maybe Method)
 
_recordTimeout :: !(Maybe Natural)
 
_recordFinishOnKey :: !(Maybe Key)
 
_recordMaxLength :: !(Maybe Natural)
 
_recordTranscribe :: !(Maybe Bool)
 
_recordTranscribeCallback :: !(Maybe URL)
 
_recordPlayBeep :: !(Maybe Bool)
 

Instances

Redirect

data Redirect Source

data RedirectF i a Source

Constructors

(Proxy i ~ Proxy `[Redirect]`) => RedirectF URL RedirectAttributes 

Instances

data RedirectAttributes Source

Constructors

RedirectAttributes 

Fields

_redirectMethod :: !(Maybe Method)
 

Instances

Reject

data Reject Source

data RejectF i a Source

Constructors

(Proxy i ~ Proxy `[Reject]`) => RejectF RejectAttributes 

Instances

data RejectAttributes Source

Constructors

RejectAttributes 

Fields

_rejectReason :: !(Maybe Reason)
 

Instances

Say

data Say Source

data SayF i a Source

Constructors

(Proxy i ~ Proxy `[Say]`) => SayF String SayAttributes a 

Instances

data SayAttributes Source

Constructors

SayAttributes 

Fields

_sayVoice :: !(Maybe Voice)
 
_sayLoop :: !(Maybe Natural)
 

Instances

Sms

data Sms Source

data SmsF i a Source

Constructors

(Proxy i ~ Proxy `[Sms]`) => SmsF String SmsAttributes a 

Instances

data SmsAttributes Source

Constructors

SmsAttributes 

Fields

_smsTo :: !(Maybe String)
 
_smsFrom :: !(Maybe String)
 
_smsAction :: !(Maybe URL)
 
_smsMethod :: !(Maybe Method)
 
_smsStatusCallback :: !(Maybe URL)
 

Instances