HasClient * sub => HasClient * ((:>) * * AnswerJson sub) Source #
Associated Types type Client ((:>) * * AnswerJson sub) (api :: (:>) * * AnswerJson sub) :: * # Methods clientWithRoute :: Proxy ((* :> ) AnswerJson sub) api -> Req -> Client (( :> *) AnswerJson sub) api #
HasDocs * sub => HasDocs * ((:>) * * AnswerJson sub) Source #
Methods docsFor :: Proxy ((* :> *) AnswerJson sub) api -> (Endpoint, Action) -> DocOptions -> API #
type Client * ((:>) * * AnswerJson sub) Source #
type Client * ((:>) * * AnswerJson sub) = Client * sub

data RequireAuth Source #

SMSAero authentication credentials.

Instances

HasClient * sub => HasClient * ((:>) * * RequireAuth sub) Source #
Associated Types type Client ((:>) * * RequireAuth sub) (api :: (:>) * * RequireAuth sub) :: * # Methods clientWithRoute :: Proxy ((* :> ) RequireAuth sub) api -> Req -> Client (( :> *) RequireAuth sub) api #
HasDocs * sub => HasDocs * ((:>) * * RequireAuth sub) Source #
Methods docsFor :: Proxy ((* :> *) RequireAuth sub) api -> (Endpoint, Action) -> DocOptions -> API #
type Client * ((:>) * * RequireAuth sub) Source #
type Client * ((:>) * * RequireAuth sub) = SMSAeroAuth -> Client * sub

data RequiredQueryParam sym a Source #

Like QueryParam, but always required.

Instances

(HasClient * sub, KnownSymbol sym, ToHttpApiData a) => HasClient * ((:>) * * (RequiredQueryParam sym a) sub) Source #
Associated Types type Client ((:>) * * (RequiredQueryParam sym a) sub) (api :: (:>) * * (RequiredQueryParam sym a) sub) :: * # Methods clientWithRoute :: Proxy ((* :> ) (RequiredQueryParam sym a) sub) api -> Req -> Client (( :> *) (RequiredQueryParam sym a) sub) api #
(KnownSymbol sym, ToParam * (QueryParam * sym a), HasDocs * sub) => HasDocs * ((:>) * * (RequiredQueryParam sym a) sub) Source #
Methods docsFor :: Proxy ((* :> *) (RequiredQueryParam sym a) sub) api -> (Endpoint, Action) -> DocOptions -> API #
type Client * ((:>) * * (RequiredQueryParam sym a) sub) Source #
type Client * ((:>) * * (RequiredQueryParam sym a) sub) = a -> Client * sub

type SmsAeroGet a = Get '[JSON] (SmsAeroResponse a) Source #

Regular SMSAero GET API.

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

Eq a => Eq (SmsAeroResponse a) Source #
Methods (==) :: SmsAeroResponse a -> SmsAeroResponse a -> Bool # (/=) :: SmsAeroResponse a -> SmsAeroResponse a -> Bool #
Show a => Show (SmsAeroResponse a) Source #
Methods showsPrec :: Int -> SmsAeroResponse a -> ShowS # show :: SmsAeroResponse a -> String # showList :: [SmsAeroResponse a] -> ShowS #
Generic (SmsAeroResponse a) Source #
Associated Types type Rep (SmsAeroResponse a) :: * -> * # Methods from :: SmsAeroResponse a -> Rep (SmsAeroResponse a) x # to :: Rep (SmsAeroResponse a) x -> SmsAeroResponse a #
ToJSON a => ToJSON (SmsAeroResponse a) Source #
Methods toJSON :: SmsAeroResponse a -> Value # toEncoding :: SmsAeroResponse a -> Encoding # toJSONList :: [SmsAeroResponse a] -> Value # toEncodingList :: [SmsAeroResponse a] -> Encoding #
FromJSON a => FromJSON (SmsAeroResponse a) Source #
Methods parseJSON :: Value -> Parser (SmsAeroResponse a) # parseJSONList :: Value -> Parser [SmsAeroResponse a] #
ToSample (SmsAeroResponse SignResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SignResponse) -> [(Text, SmsAeroResponse SignResponse)] #
ToSample (SmsAeroResponse SendersResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SendersResponse) -> [(Text, SmsAeroResponse SendersResponse)] #
ToSample (SmsAeroResponse BalanceResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse BalanceResponse) -> [(Text, SmsAeroResponse BalanceResponse)] #
ToSample (SmsAeroResponse MessageStatus) Source #
Methods toSamples :: Proxy * (SmsAeroResponse MessageStatus) -> [(Text, SmsAeroResponse MessageStatus)] #
ToSample (SmsAeroResponse SendResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SendResponse) -> [(Text, SmsAeroResponse SendResponse)] #
type Rep (SmsAeroResponse a) Source #
type Rep (SmsAeroResponse a) = D1 (MetaData "SmsAeroResponse" "SMSAero.API" "smsaero-0.7.1-H6NkdSadZaVHPXjZJqwGmk" False) ((:+:) (C1 (MetaCons "ResponseOK" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 a))) (C1 (MetaCons "ResponseReject" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))))

data SendResponse Source #

SMSAero response to a send request.

Constructors

SendAccepted MessageId	Message accepted.
SendNoCredits	No credits to send a message.

Instances

Eq SendResponse Source #
Methods (==) :: SendResponse -> SendResponse -> Bool # (/=) :: SendResponse -> SendResponse -> Bool #
Show SendResponse Source #
Methods showsPrec :: Int -> SendResponse -> ShowS # show :: SendResponse -> String # showList :: [SendResponse] -> ShowS #
Generic SendResponse Source #
Associated Types type Rep SendResponse :: * -> * # Methods from :: SendResponse -> Rep SendResponse x # to :: Rep SendResponse x -> SendResponse #
ToJSON SendResponse Source #
Methods toJSON :: SendResponse -> Value # toEncoding :: SendResponse -> Encoding # toJSONList :: [SendResponse] -> Value # toEncodingList :: [SendResponse] -> Encoding #
FromJSON SendResponse Source #
Methods parseJSON :: Value -> Parser SendResponse # parseJSONList :: Value -> Parser [SendResponse] #
ToSample (SmsAeroResponse SendResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SendResponse) -> [(Text, SmsAeroResponse SendResponse)] #
type Rep SendResponse Source #
type Rep SendResponse = D1 (MetaData "SendResponse" "SMSAero.API" "smsaero-0.7.1-H6NkdSadZaVHPXjZJqwGmk" False) ((:+:) (C1 (MetaCons "SendAccepted" PrefixI False) (S1 (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 MessageId))) (C1 (MetaCons "SendNoCredits" PrefixI False) U1))

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

Bounded MessageStatus Source #
Methods minBound :: MessageStatus # maxBound :: MessageStatus #
Enum MessageStatus Source #
Methods succ :: MessageStatus -> MessageStatus # pred :: MessageStatus -> MessageStatus # toEnum :: Int -> MessageStatus # fromEnum :: MessageStatus -> Int # enumFrom :: MessageStatus -> [MessageStatus] # enumFromThen :: MessageStatus -> MessageStatus -> [MessageStatus] # enumFromTo :: MessageStatus -> MessageStatus -> [MessageStatus] # enumFromThenTo :: MessageStatus -> MessageStatus -> MessageStatus -> [MessageStatus] #
Eq MessageStatus Source #
Methods (==) :: MessageStatus -> MessageStatus -> Bool # (/=) :: MessageStatus -> MessageStatus -> Bool #
Read MessageStatus Source #
Methods readsPrec :: Int -> ReadS MessageStatus # readList :: ReadS [MessageStatus] # readPrec :: ReadPrec MessageStatus # readListPrec :: ReadPrec [MessageStatus] #
Show MessageStatus Source #
Methods showsPrec :: Int -> MessageStatus -> ShowS # show :: MessageStatus -> String # showList :: [MessageStatus] -> ShowS #
Generic MessageStatus Source #
Associated Types type Rep MessageStatus :: * -> * # Methods from :: MessageStatus -> Rep MessageStatus x # to :: Rep MessageStatus x -> MessageStatus #
ToJSON MessageStatus Source #
Methods toJSON :: MessageStatus -> Value # toEncoding :: MessageStatus -> Encoding # toJSONList :: [MessageStatus] -> Value # toEncodingList :: [MessageStatus] -> Encoding #
FromJSON MessageStatus Source #
Methods parseJSON :: Value -> Parser MessageStatus # parseJSONList :: Value -> Parser [MessageStatus] #
ToHttpApiData MessageStatus Source #
Methods toUrlPiece :: MessageStatus -> Text # toHeader :: MessageStatus -> ByteString # toQueryParam :: MessageStatus -> Text #
FromHttpApiData MessageStatus Source #
Methods parseUrlPiece :: Text -> Either Text MessageStatus # parseHeader :: ByteString -> Either Text MessageStatus # parseQueryParam :: Text -> Either Text MessageStatus #
ToSample (SmsAeroResponse MessageStatus) Source #
Methods toSamples :: Proxy * (SmsAeroResponse MessageStatus) -> [(Text, SmsAeroResponse MessageStatus)] #
type Rep MessageStatus Source #
type Rep MessageStatus = D1 (MetaData "MessageStatus" "SMSAero.API" "smsaero-0.7.1-H6NkdSadZaVHPXjZJqwGmk" False) ((:+:) ((:+:) (C1 (MetaCons "StatusDeliverySuccess" PrefixI False) U1) ((:+:) (C1 (MetaCons "StatusDeliveryFailure" PrefixI False) U1) (C1 (MetaCons "StatusSmscSubmit" PrefixI False) U1))) ((:+:) (C1 (MetaCons "StatusSmscReject" PrefixI False) U1) ((:+:) (C1 (MetaCons "StatusQueue" PrefixI False) U1) (C1 (MetaCons "StatusWaitStatus" PrefixI False) U1))))

type CheckSendingResponse = Map MessageId MessageStatus Source #

SMSAero response to a checksending request.

newtype BalanceResponse Source #

SMSAero response to a balance request (balance in rubles).

Constructors

BalanceResponse Double

Instances

Eq BalanceResponse Source #
Methods (==) :: BalanceResponse -> BalanceResponse -> Bool # (/=) :: BalanceResponse -> BalanceResponse -> Bool #
Show BalanceResponse Source #
Methods showsPrec :: Int -> BalanceResponse -> ShowS # show :: BalanceResponse -> String # showList :: [BalanceResponse] -> ShowS #
ToJSON BalanceResponse Source #
Methods toJSON :: BalanceResponse -> Value # toEncoding :: BalanceResponse -> Encoding # toJSONList :: [BalanceResponse] -> Value # toEncodingList :: [BalanceResponse] -> Encoding #
FromJSON BalanceResponse Source #
Methods parseJSON :: Value -> Parser BalanceResponse # parseJSONList :: Value -> Parser [BalanceResponse] #
ToSample (SmsAeroResponse BalanceResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse BalanceResponse) -> [(Text, SmsAeroResponse BalanceResponse)] #

type CheckTariffResponse = Map ChannelName Double Source #

SMSAero response to a checktarif request.

newtype SendersResponse Source #

Constructors

SendersResponse [Signature]

Instances

Eq SendersResponse Source #
Methods (==) :: SendersResponse -> SendersResponse -> Bool # (/=) :: SendersResponse -> SendersResponse -> Bool #
Show SendersResponse Source #
Methods showsPrec :: Int -> SendersResponse -> ShowS # show :: SendersResponse -> String # showList :: [SendersResponse] -> ShowS #
ToJSON SendersResponse Source #
Methods toJSON :: SendersResponse -> Value # toEncoding :: SendersResponse -> Encoding # toJSONList :: [SendersResponse] -> Value # toEncodingList :: [SendersResponse] -> Encoding #
FromJSON SendersResponse Source #
Methods parseJSON :: Value -> Parser SendersResponse # parseJSONList :: Value -> Parser [SendersResponse] #
ToSample (SmsAeroResponse SendersResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SendersResponse) -> [(Text, SmsAeroResponse SendersResponse)] #

data SignResponse Source #

SMSAero response to a sign request.

Constructors

SignApproved	Signature is approved.
SignRejected	Signature is rejected.
SignPending	Signature is pending.

Instances

Bounded SignResponse Source #
Methods minBound :: SignResponse # maxBound :: SignResponse #
Enum SignResponse Source #
Methods succ :: SignResponse -> SignResponse # pred :: SignResponse -> SignResponse # toEnum :: Int -> SignResponse # fromEnum :: SignResponse -> Int # enumFrom :: SignResponse -> [SignResponse] # enumFromThen :: SignResponse -> SignResponse -> [SignResponse] # enumFromTo :: SignResponse -> SignResponse -> [SignResponse] # enumFromThenTo :: SignResponse -> SignResponse -> SignResponse -> [SignResponse] #
Eq SignResponse Source #
Methods (==) :: SignResponse -> SignResponse -> Bool # (/=) :: SignResponse -> SignResponse -> Bool #
Show SignResponse Source #
Methods showsPrec :: Int -> SignResponse -> ShowS # show :: SignResponse -> String # showList :: [SignResponse] -> ShowS #
Generic SignResponse Source #
Associated Types type Rep SignResponse :: * -> * # Methods from :: SignResponse -> Rep SignResponse x # to :: Rep SignResponse x -> SignResponse #
ToJSON SignResponse Source #
Methods toJSON :: SignResponse -> Value # toEncoding :: SignResponse -> Encoding # toJSONList :: [SignResponse] -> Value # toEncodingList :: [SignResponse] -> Encoding #
FromJSON SignResponse Source #
Methods parseJSON :: Value -> Parser SignResponse # parseJSONList :: Value -> Parser [SignResponse] #
ToHttpApiData SignResponse Source #
Methods toUrlPiece :: SignResponse -> Text # toHeader :: SignResponse -> ByteString # toQueryParam :: SignResponse -> Text #
FromHttpApiData SignResponse Source #
Methods parseUrlPiece :: Text -> Either Text SignResponse # parseHeader :: ByteString -> Either Text SignResponse # parseQueryParam :: Text -> Either Text SignResponse #
ToSample (SmsAeroResponse SignResponse) Source #
Methods toSamples :: Proxy * (SmsAeroResponse SignResponse) -> [(Text, SmsAeroResponse SignResponse)] #
type Rep SignResponse Source #
type Rep SignResponse = D1 (MetaData "SignResponse" "SMSAero.API" "smsaero-0.7.1-H6NkdSadZaVHPXjZJqwGmk" False) ((:+:) (C1 (MetaCons "SignApproved" PrefixI False) U1) ((:+:) (C1 (MetaCons "SignRejected" PrefixI False) U1) (C1 (MetaCons "SignPending" PrefixI False) U1)))

newtype GroupResponse Source #

SMSAero response to an addgroup/delgroup request.

Constructors

GroupResponse Text

Instances

Eq GroupResponse Source #
Methods (==) :: GroupResponse -> GroupResponse -> Bool # (/=) :: GroupResponse -> GroupResponse -> Bool #
Show GroupResponse Source #
Methods showsPrec :: Int -> GroupResponse -> ShowS # show :: GroupResponse -> String # showList :: [GroupResponse] -> ShowS #
ToJSON GroupResponse Source #
Methods toJSON :: GroupResponse -> Value # toEncoding :: GroupResponse -> Encoding # toJSONList :: [GroupResponse] -> Value # toEncodingList :: [GroupResponse] -> Encoding #
FromJSON GroupResponse Source #
Methods parseJSON :: Value -> Parser GroupResponse # parseJSONList :: Value -> Parser [GroupResponse] #

newtype PhoneResponse Source #

SMSAero response to an addphone/delphone request.

Constructors

PhoneResponse Text

Instances

Eq PhoneResponse Source #
Methods (==) :: PhoneResponse -> PhoneResponse -> Bool # (/=) :: PhoneResponse -> PhoneResponse -> Bool #
Show PhoneResponse Source #
Methods showsPrec :: Int -> PhoneResponse -> ShowS # show :: PhoneResponse -> String # showList :: [PhoneResponse] -> ShowS #
ToJSON PhoneResponse Source #
Methods toJSON :: PhoneResponse -> Value # toEncoding :: PhoneResponse -> Encoding # toJSONList :: [PhoneResponse] -> Value # toEncodingList :: [PhoneResponse] -> Encoding #
FromJSON PhoneResponse Source #
Methods parseJSON :: Value -> Parser PhoneResponse # parseJSONList :: Value -> Parser [PhoneResponse] #

newtype BlacklistResponse Source #

SMSAero response to an addblacklist request.

Constructors

BlacklistResponse Text

Instances

Eq BlacklistResponse Source #
Methods (==) :: BlacklistResponse -> BlacklistResponse -> Bool # (/=) :: BlacklistResponse -> BlacklistResponse -> Bool #
Show BlacklistResponse Source #
Methods showsPrec :: Int -> BlacklistResponse -> ShowS # show :: BlacklistResponse -> String # showList :: [BlacklistResponse] -> ShowS #
ToJSON BlacklistResponse Source #
Methods toJSON :: BlacklistResponse -> Value # toEncoding :: BlacklistResponse -> Encoding # toJSONList :: [BlacklistResponse] -> Value # toEncodingList :: [BlacklistResponse] -> Encoding #
FromJSON BlacklistResponse Source #
Methods parseJSON :: Value -> Parser BlacklistResponse # parseJSONList :: Value -> Parser [BlacklistResponse] #

Orphan instances

ToParam * (QueryParam * "date" SMSAeroDate) Source #
Methods toParam :: Proxy (QueryParam * "date" SMSAeroDate) t -> DocQueryParam #
ToParam * (QueryParam * "digital" DigitalChannel) Source #
Methods toParam :: Proxy (QueryParam * "digital" DigitalChannel) t -> DocQueryParam #
ToParam * (QueryParam * "from" Signature) Source #
Methods toParam :: Proxy (QueryParam * "from" Signature) t -> DocQueryParam #
ToParam * (QueryParam * "group" Group) Source #
Methods toParam :: Proxy (QueryParam * "group" Group) t -> DocQueryParam #
ToParam * (QueryParam * "id" MessageId) Source #
Methods toParam :: Proxy (QueryParam * "id" MessageId) t -> DocQueryParam #
ToParam * (QueryParam * "text" MessageBody) Source #
Methods toParam :: Proxy (QueryParam * "text" MessageBody) t -> DocQueryParam #
ToParam * (QueryParam * "to" Phone) Source #
Methods toParam :: Proxy (QueryParam * "to" Phone) t -> DocQueryParam #
ToParam * (QueryParam * "type" SendType) Source #
Methods toParam :: Proxy (QueryParam * "type" SendType) t -> DocQueryParam #