RateLimit.hs

-----------------------------------------------------------------------------
-- |
-- License     :  BSD-3-Clause
-- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
--
-- The Github RateLimit API, as described at
-- <http://developer.github.com/v3/rate_limit/>.
module GitHub.Endpoints.RateLimit (
    rateLimitR,
    rateLimit,
    rateLimit',
    module GitHub.Data,
    ) where

import GitHub.Data
import GitHub.Internal.Prelude
import GitHub.Request
import Prelude ()

-- | Get your current rate limit status (Note: Accessing this endpoint does not count against your rate limit.)
-- With authentication.
rateLimit' :: Maybe Auth -> IO (Either Error RateLimit)
rateLimit' auth = executeRequestMaybe auth rateLimitR

-- | Get your current rate limit status (Note: Accessing this endpoint does not count against your rate limit.)
-- Without authentication.
rateLimit :: IO (Either Error RateLimit)
rateLimit = rateLimit' Nothing

-- | Get your current rate limit status.
-- <https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status>
rateLimitR :: Request k RateLimit
rateLimitR = query ["rate_limit"] []