smsaero: SMSAero API and HTTP client based on servant library.

[ bsd3, library, web ] [ Propose Tags ]

Please see README.md


[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1, 0.1.1, 0.2, 0.3, 0.4, 0.4.1, 0.5, 0.6, 0.6.1, 0.6.2, 0.7, 0.7.1
Change log CHANGELOG.md
Dependencies aeson, base (>=4.9 && <4.10), containers, http-api-data (>=0.2.3), http-client, servant (>=0.9), servant-client, servant-docs, text, time [details]
License BSD-3-Clause
Copyright (c) 2015-2016, GetShopTV
Author Nickolay Kudasov
Maintainer nickolay@getshoptv.com
Category Web
Home page https://github.com/GetShopTV/smsaero
Source repo head: git clone https://github.com/GetShopTV/smsaero.git
Uploaded by NickolayKudasov at 2016-12-09T10:50:56Z
Distributions
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 7409 total (31 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2016-12-09 [all 1 reports]

Readme for smsaero-0.7.1

[back to package description]

smsaero

Hackage Build Status

SMSAero API and HTTP client based on servant library.

Documentation

Library documentation is available on Hackage.

The original SMSAero API documentation (in Russian) is available here.

API documentation in English can be generated using pandoc:

$ stack exec pandoc --filter=docs/api-filter.hs -o docs/api.md api-intro.md

Note that you can generate this documentation in any format that pandoc supports (e.g. HTML, LaTeX, Markdown, etc.).

Usage

Import SMSAero and Control.Monad.Trans.Either module to interact with SMSAero:

>>> :s -XOverloadedStrings
>>> import SMSAero
>>> import Control.Monad.Trans.Either
>>> let credentials = SMSAeroAuth "user@example.com" "md5-password-hash"
>>> runEitherT $ smsAeroBalance credentials
Right (ResponseOK (BalanceResponse 10.0))

Contributing

Contributions and bug reports are welcome!

GetShopTV Team