SMSAero.API

This module describes SMSAero API and defines corresponding types.

API

type SMSAeroAPI = RequireAuth :> (AnswerJson :> (("send" :> SendApi) :<|> (("status" :> StatusApi) :<|> (("balance" :> SmsAeroGet BalanceResponse) :<|> (("senders" :> SmsAeroGet SendersResponse) :<|> ("sign" :> SmsAeroGet SignResponse))))))

SMSAero API.

type SendApi = RequiredQueryParam "to" Phone :> (RequiredQueryParam "text" MessageBody :> (RequiredQueryParam "from" Signature :> (QueryParam "date" SMSAeroDate :> SmsAeroGet SendResponse)))

SMSAero API to send a message.

type StatusApi = RequiredQueryParam "id" MessageId :> SmsAeroGet StatusResponse

SMSAero API to check message status.

Combinators

data SmsAeroJson

Content type for SMSAero JSON answer (it has JSON body but "text/plain" Content-Type).

Instances

Accept * SmsAeroJson

ToJSON a => MimeRender * SmsAeroJson a

FromJSON a => MimeUnrender * SmsAeroJson a

data AnswerJson

Implicit parameter that tells SMSAero to respond with JSON.

Instances

HasDocs * sub => HasDocs * ((:>) * * AnswerJson sub)

HasClient sub => HasClient ((:>) * * AnswerJson sub)

type Client ((:>) * * AnswerJson sub) = Client sub

data RequireAuth

SMSAero authentication credentials.

Instances

HasDocs * sub => HasDocs * ((:>) * * RequireAuth sub)

HasClient sub => HasClient ((:>) * * RequireAuth sub)

type Client ((:>) * * RequireAuth sub) = SMSAeroAuth -> Client sub

data RequiredQueryParam sym a

Like QueryParam, but always required.

Instances

(KnownSymbol sym, ToParam * (QueryParam * sym a), HasDocs * sub) => HasDocs * ((:>) * * (RequiredQueryParam sym a) sub)

(HasClient sub, KnownSymbol sym, ToText a) => HasClient ((:>) * * (RequiredQueryParam sym a) sub)

type Client ((:>) * * (RequiredQueryParam sym a) sub) = a -> Client sub

type SmsAeroGet a = Get `[SmsAeroJson]` (SmsAeroResponse a)

Regular SMSAero GET API.

Types

data SMSAeroAuth

SMSAero authentication data.

Constructors

SMSAeroAuth

Fields

authUser :: Text

Username.

authPassword :: Text

MD5 hash of a password.

Instances

ToJSON SMSAeroAuth

FromJSON SMSAeroAuth

newtype Signature

SMSAero sender's signature. This is used for the "from" field.

Constructors

Signature

Fields

getSignature :: Text

Instances

Show Signature

ToJSON Signature

FromJSON Signature

FromText Signature

ToText Signature

ToParam * (QueryParam * "from" Signature)

newtype MessageId

SMSAero sent message id.

Constructors

MessageId Integer

Instances

Show MessageId

ToJSON MessageId

FromJSON MessageId

FromText MessageId

ToText MessageId

ToParam * (QueryParam * "id" MessageId)

newtype MessageBody

SMSAero message body.

Constructors

MessageBody Text

Instances

Show MessageBody

ToJSON MessageBody

FromJSON MessageBody

FromText MessageBody

ToText MessageBody

ToParam * (QueryParam * "text" MessageBody)

newtype Phone

Phone number.

Constructors

Phone

Fields

getPhone :: Integer

Instances

Show Phone

FromText Phone

ToText Phone

ToParam * (QueryParam * "to" Phone)

newtype SMSAeroDate

Date. Textually SMSAeroDate is represented as a number of seconds since 01 Jan 1970.

Constructors

SMSAeroDate

Fields

getSMSAeroDate :: UTCTime

Instances

Show SMSAeroDate

FromText SMSAeroDate

ToText SMSAeroDate

ToParam * (QueryParam * "date" SMSAeroDate)

Responses

data SmsAeroResponse a

Every SMSAero response is either rejected or provides some info.

Constructors

ResponseOK a

Some useful payload.

ResponseReject Text

Rejection reason.

Instances

ToSample * (SmsAeroResponse SignResponse) (SmsAeroResponse SignResponse)

ToSample * (SmsAeroResponse SendersResponse) (SmsAeroResponse SendersResponse)

ToSample * (SmsAeroResponse BalanceResponse) (SmsAeroResponse BalanceResponse)

ToSample * (SmsAeroResponse StatusResponse) (SmsAeroResponse StatusResponse)

ToSample * (SmsAeroResponse SendResponse) (SmsAeroResponse SendResponse)

Show a => Show (SmsAeroResponse a)

Generic (SmsAeroResponse a)

ToJSON a => ToJSON (SmsAeroResponse a)

FromJSON a => FromJSON (SmsAeroResponse a)

type Rep (SmsAeroResponse a)

data SendResponse

SMSAero response to a send request.

Constructors

SendAccepted MessageId

Message accepted.

SendNoCredits

No credits to send a message.

Instances

Show SendResponse

Generic SendResponse

ToJSON SendResponse

FromJSON SendResponse

ToSample * (SmsAeroResponse SendResponse) (SmsAeroResponse SendResponse)

type Rep SendResponse

data StatusResponse

SMSAero response to a status request.

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

Bounded StatusResponse

Enum StatusResponse

Show StatusResponse

Generic StatusResponse

ToJSON StatusResponse

FromJSON StatusResponse

FromText StatusResponse

ToText StatusResponse

ToSample * (SmsAeroResponse StatusResponse) (SmsAeroResponse StatusResponse)

type Rep StatusResponse

newtype BalanceResponse

SMSAero response to a balance request. This is a number of available messages to send.

Constructors

BalanceResponse Double

Instances

Show BalanceResponse

ToJSON BalanceResponse

FromJSON BalanceResponse

ToSample * (SmsAeroResponse BalanceResponse) (SmsAeroResponse BalanceResponse)

newtype SendersResponse

SMSAero response to a senders request. This is just a list of available signatures.

Constructors

SendersResponse [Signature]

Instances

Show SendersResponse

ToJSON SendersResponse

FromJSON SendersResponse

ToSample * (SmsAeroResponse SendersResponse) (SmsAeroResponse SendersResponse)

data SignResponse

SMSAero response to a sign request.

Constructors

SignApproved

Signature is approved.

SignRejected

Signature is rejected.

SignPending

Signature is pending.

Instances

Bounded SignResponse

Enum SignResponse

Show SignResponse

Generic SignResponse

ToJSON SignResponse

FromJSON SignResponse

FromText SignResponse

ToText SignResponse

ToSample * (SmsAeroResponse SignResponse) (SmsAeroResponse SignResponse)

type Rep SignResponse