Text.XML.Twiml.Internal.Twiml

Contents

• TwiML
  • Nouns
    • Client
    • Conference
    • Number
    • Queue
    • Sip
  • Verbs
    • Dial
    • End
    • Enqueue
    • Hangup
    • Hangup
    • Leave
    • Message
    • Pause
    • Play
    • Record
    • Redirect
    • Reject
    • Say
    • Sms

Description

Synopsis

• data MessagingTwiml = forall i . MessagingTwiml (IxFree MessagingVerbsF i Void)
• newtype MessagingVerbsF i a = MessagingVerbsF {
  • getMessagingVerbsF :: (MessageF i :+: (RedirectF i :+: (SmsF i :+: EndF i))) a
  }
• data VoiceTwiml = forall i . VoiceTwiml (IxFree VoiceVerbsF i Void)
• newtype VoiceVerbsF i a = VoiceVerbsF {
  • 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
  }
• type family Base d
• type IsTwimlLike f i = (Functor1 f, Base i `[i]` :<: f `[i]`)
• type TwimlLike f i = TwimlLike' f `[i]`
• type TwimlLike' f = IxFree f
• response :: IxFree VoiceVerbsF i Void -> VoiceTwiml
• data DialNoun = forall i . DialNoun (IxFree DialNounF i Void)
• newtype DialNounF i a = DialNounF {
  • getDialNounF :: (ClientF i :+: (ConferenceF i :+: (NumberF i :+: (QueueF i :+: SipF i)))) a
  }
• data Client
• data ClientF i a = (Proxy i ~ Proxy `[Client]`) => ClientF String ClientAttributes
• data ClientAttributes = ClientAttributes {
  • _clientUrl :: !(Maybe URL)
  • _clientMethod :: !(Maybe Method)
  }
• data Conference
• data ConferenceF i a = (Proxy i ~ Proxy `[Conference]`) => ConferenceF String ConferenceAttributes
• data ConferenceAttributes = ConferenceAttributes {
  • _conferenceMuted :: !(Maybe Bool)
  • _conferenceBeep :: !(Maybe Bool)
  • _conferenceStartOnEnter :: !(Maybe Bool)
  • _conferenceEndOnExit :: !(Maybe Bool)
  • _conferenceWaitURL :: !(Maybe URL)
  • _conferenceWaitMethod :: !(Maybe Method)
  • _conferenceMaxParticipants :: !(Maybe Natural)
  }
• data Number
• data NumberF i a = (Proxy i ~ Proxy `[Number]`) => NumberF String NumberAttributes
• data NumberAttributes = NumberAttributes {
  • _numberSendDigits :: !(Maybe Digits)
  • _numberUrl :: !(Maybe URL)
  • _numberMethod :: !(Maybe Method)
  }
• data Queue
• data QueueF i a = (Proxy i ~ Proxy `[Queue]`) => QueueF String QueueAttributes
• data QueueAttributes = QueueAttributes {
  • _queueUrl :: !(Maybe URL)
  • _queueMethod :: !(Maybe Method)
  }
• data Sip
• data SipF i a = (Proxy i ~ Proxy `[Sip]`) => SipF URL SipAttributes
• data SipAttributes = SipAttributes {
  • _sipUsername :: !(Maybe String)
  • _sipPassword :: !(Maybe String)
  • _sipTransport :: !(Maybe Transport)
  • _sipHeaders :: !(Maybe String)
  • _sipUrl :: !(Maybe URL)
  • _sipMethod :: !(Maybe Method)
  }
• data Dial
• data DialF i a = (Proxy i ~ Proxy `[Dial]`) => DialF EitherDialNounString DialAttributes a
• data DialAttributes = DialAttributes {
  • _dialAction :: !(Maybe URL)
  • _dialMethod :: !(Maybe Method)
  • _dialTimeout :: !(Maybe Natural)
  • _dialHangupOnStar :: !(Maybe Bool)
  • _dialTimeLimit :: !(Maybe Natural)
  • _dialCallerId :: !(Maybe String)
  • _dialRecord' :: !(Maybe Bool)
  }
• data End
• data EndF i a = (Proxy i ~ Proxy `[End]`) => EndF
• data Enqueue
• data EnqueueF i a = (Proxy i ~ Proxy `[Enqueue]`) => EnqueueF String EnqueueAttributes a
• data EnqueueAttributes = EnqueueAttributes {
  • _enqueueAction :: !(Maybe URL)
  • _enqueueMethod :: !(Maybe Method)
  • _enqueueWaitURL :: !(Maybe URL)
  • _enqueueWaitMethod :: !(Maybe Method)
  }
• data Gather
• data GatherF i a where
  • GatherF :: Nest i In Gather => GatherAttributes -> IxFree VoiceVerbsF i Void -> a -> GatherF `[Gather]` a
• data GatherAttributes = GatherAttributes {
  • _gatherAction :: Maybe URL
  • _gatherMethod :: Maybe Method
  • _gatherTimeout :: Maybe Natural
  • _gatherFinishOnKey :: Maybe Key
  • _gatherNumDigits :: Maybe Natural
  }
• type family Nest a i b
• data In
• data Hangup
• data HangupF i a = (Proxy i ~ Proxy `[Hangup]`) => HangupF
• data Leave
• data LeaveF i a = (Proxy i ~ Proxy `[Leave]`) => LeaveF
• data Message
• data MessageF i a = (Proxy i ~ Proxy `[Message]`) => MessageF String MessageAttributes a
• data MessageAttributes = MessageAttributes {
  • _messageTo :: !(Maybe String)
  • _messageFrom :: !(Maybe String)
  • _messageAction :: !(Maybe URL)
  • _messageMethod :: !(Maybe Method)
  • _messageStatusCallback :: !(Maybe URL)
  }
• data Pause
• data PauseF i a = (Proxy i ~ Proxy `[Pause]`) => PauseF PauseAttributes a
• data PauseAttributes = PauseAttributes {
  • _pauseDuration :: !(Maybe Natural)
  }
• data Play
• data PlayF i a = (Proxy i ~ Proxy `[Play]`) => PlayF MaybeURL PlayAttributes a
• data PlayAttributes = PlayAttributes {
  • _playLoop :: !(Maybe Natural)
  • _playDigits :: !(Maybe Digits)
  }
• data Record
• data RecordF i a = (Proxy i ~ Proxy `[Record]`) => RecordF RecordAttributes a
• data RecordAttributes = RecordAttributes {
  • _recordAction :: !(Maybe URL)
  • _recordMethod :: !(Maybe Method)
  • _recordTimeout :: !(Maybe Natural)
  • _recordFinishOnKey :: !(Maybe Key)
  • _recordMaxLength :: !(Maybe Natural)
  • _recordTranscribe :: !(Maybe Bool)
  • _recordTranscribeCallback :: !(Maybe URL)
  • _recordPlayBeep :: !(Maybe Bool)
  }
• data Redirect
• data RedirectF i a = (Proxy i ~ Proxy `[Redirect]`) => RedirectF URL RedirectAttributes
• data RedirectAttributes = RedirectAttributes {
  • _redirectMethod :: !(Maybe Method)
  }
• data Reject
• data RejectF i a = (Proxy i ~ Proxy `[Reject]`) => RejectF RejectAttributes
• data RejectAttributes = RejectAttributes {
  • _rejectReason :: !(Maybe Reason)
  }
• data Say
• data SayF i a = (Proxy i ~ Proxy `[Say]`) => SayF String SayAttributes a
• data SayAttributes = SayAttributes {
  • _sayVoice :: !(Maybe Voice)
  • _sayLoop :: !(Maybe Natural)
  }
• data Sms
• data SmsF i a = (Proxy i ~ Proxy `[Sms]`) => SmsF String SmsAttributes a
• data SmsAttributes = SmsAttributes {
  • _smsTo :: !(Maybe String)
  • _smsFrom :: !(Maybe String)
  • _smsAction :: !(Maybe URL)
  • _smsMethod :: !(Maybe Method)
  • _smsStatusCallback :: !(Maybe URL)
  }

TwiML

Nouns

Client

Conference

Number

Queue

Sip

Verbs

Dial

End

Enqueue

Hangup

Hangup

Leave

Message

Pause

Play

Record

Redirect

Reject

Say

Sms