| Copyright | (c) 2015, GetShopTV |
|---|---|
| License | BSD3 |
| Maintainer | nickolay@getshoptv.com |
| Stability | experimental |
| Safe Haskell | None |
| Language | Haskell2010 |
SMSAero.API
Contents
Description
This module describes SMSAero API and defines corresponding types.
- type SMSAeroAPI = RequireAuth :> (AnswerJson :> (("send" :> SendApi) :<|> (("status" :> StatusApi) :<|> (("balance" :> SmsAeroGet BalanceResponse) :<|> (("senders" :> SmsAeroGet SendersResponse) :<|> ("sign" :> SmsAeroGet SignResponse))))))
- type SendApi = RequiredQueryParam "to" Phone :> (RequiredQueryParam "text" MessageBody :> (RequiredQueryParam "from" Signature :> (QueryParam "date" SMSAeroDate :> SmsAeroGet SendResponse)))
- type StatusApi = RequiredQueryParam "id" MessageId :> SmsAeroGet MessageStatus
- data SmsAeroJson
- data AnswerJson
- data RequireAuth
- data RequiredQueryParam sym a
- type SmsAeroGet a = Get `[SmsAeroJson]` (SmsAeroResponse a)
- data SMSAeroAuth = SMSAeroAuth {
- authUser :: Text
- authPassword :: Text
- newtype Signature = Signature {
- getSignature :: Text
- newtype MessageId = MessageId Int64
- newtype MessageBody = MessageBody Text
- newtype Phone = Phone {}
- newtype SMSAeroDate = SMSAeroDate {}
- data SmsAeroResponse a
- = ResponseOK a
- | ResponseReject Text
- data SendResponse
- data MessageStatus
- newtype BalanceResponse = BalanceResponse Double
- newtype SendersResponse = SendersResponse [Signature]
- data SignResponse
API
type SMSAeroAPI = RequireAuth :> (AnswerJson :> (("send" :> SendApi) :<|> (("status" :> StatusApi) :<|> (("balance" :> SmsAeroGet BalanceResponse) :<|> (("senders" :> SmsAeroGet SendersResponse) :<|> ("sign" :> SmsAeroGet SignResponse)))))) Source
SMSAero API.
type SendApi = RequiredQueryParam "to" Phone :> (RequiredQueryParam "text" MessageBody :> (RequiredQueryParam "from" Signature :> (QueryParam "date" SMSAeroDate :> SmsAeroGet SendResponse))) Source
SMSAero API to send a message.
type StatusApi = RequiredQueryParam "id" MessageId :> SmsAeroGet MessageStatus Source
SMSAero API to check message status.
Combinators
data SmsAeroJson Source
Content type for SMSAero JSON answer (it has JSON body but "text/plain" Content-Type).
Instances
| Accept * SmsAeroJson Source | |
| ToJSON a => MimeRender * SmsAeroJson a Source | |
| FromJSON a => MimeUnrender * SmsAeroJson a Source |
data AnswerJson Source
Implicit parameter that tells SMSAero to respond with JSON.
Instances
| HasDocs * sub => HasDocs * ((:>) * * AnswerJson sub) Source | |
| HasClient sub => HasClient ((:>) * * AnswerJson sub) Source | |
| type Client ((:>) * * AnswerJson sub) = Client sub Source |
data RequireAuth Source
SMSAero authentication credentials.
Instances
| HasDocs * sub => HasDocs * ((:>) * * RequireAuth sub) Source | |
| HasClient sub => HasClient ((:>) * * RequireAuth sub) Source | |
| type Client ((:>) * * RequireAuth sub) = SMSAeroAuth -> Client sub Source |
data RequiredQueryParam sym a Source
Like QueryParam, but always required.
Instances
| (KnownSymbol sym, ToParam * (QueryParam * sym a), HasDocs * sub) => HasDocs * ((:>) * * (RequiredQueryParam sym a) sub) Source | |
| (HasClient sub, KnownSymbol sym, ToText a) => HasClient ((:>) * * (RequiredQueryParam sym a) sub) Source | |
| type Client ((:>) * * (RequiredQueryParam sym a) sub) = a -> Client sub Source |
type SmsAeroGet a = Get `[SmsAeroJson]` (SmsAeroResponse a) Source
Regular SMSAero GET API.
Types
data SMSAeroAuth Source
SMSAero authentication data.
Constructors
| SMSAeroAuth | |
Fields
| |
Instances
SMSAero sender's signature. This is used for the "from" field.
Constructors
| Signature | |
Fields
| |
SMSAero sent message id.
Phone number.
newtype SMSAeroDate Source
Date. Textually SMSAeroDate is represented as a number of seconds since 01 Jan 1970.
Constructors
| SMSAeroDate | |
Fields | |
Instances
Responses
data SmsAeroResponse a Source
Every SMSAero response is either rejected or provides some info.
Constructors
| ResponseOK a | Some useful payload. |
| ResponseReject Text | Rejection reason. |
Instances
data SendResponse Source
SMSAero response to a send request.
Constructors
| SendAccepted MessageId | Message accepted. |
| SendNoCredits | No credits to send a message. |
data MessageStatus Source
SMSAero message status.
Constructors
| StatusDeliverySuccess | Message is successfully delivered. |
| StatusDeliveryFailure | Message delivery has failed. |
| StatusSmscSubmit | Message submitted to SMSC. |
| StatusSmscReject | Message rejected by SMSC. |
| StatusQueue | Message queued. |
| StatusWaitStatus | Wait for message status. |
Instances
newtype BalanceResponse Source
SMSAero response to a balance request. This is a number of available messages to send.
Constructors
| BalanceResponse Double |
newtype SendersResponse Source
SMSAero response to a senders request. This is just a list of available signatures.
Constructors
| SendersResponse [Signature] |
data SignResponse Source
SMSAero response to a sign request.
Constructors
| SignApproved | Signature is approved. |
| SignRejected | Signature is rejected. |
| SignPending | Signature is pending. |
Instances