-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Haskell OAuth2 authentication client
--   
--   Haskell OAuth2 authentication client. Tested with the following
--   services:
--   
--   <ul>
--   <li>Google:
--   <a>https://developers.google.com/accounts/docs/OAuth2WebServer</a></li>
--   <li>Github: <a>http://developer.github.com/v3/oauth/</a></li>
--   <li>Facebook:
--   <a>http://developers.facebook.com/docs/facebook-login/</a></li>
--   <li>Fitbit: <a>http://dev.fitbit.com/docs/oauth2/</a></li>
--   <li>StackExchange:
--   <a>https://api.stackexchange.com/docs/authentication</a></li>
--   <li>DropBox:
--   <a>https://www.dropbox.com/developers/reference/oauth-guide</a></li>
--   <li>Weibo: <a>http://open.weibo.com/wiki/Oauth2</a></li>
--   <li>Douban:
--   <a>http://developers.douban.com/wiki/?title=oauth2</a></li>
--   </ul>
@package hoauth2
@version 1.7.2

module Network.OAuth.OAuth2.AuthorizationRequest

-- | Authorization Code Grant Error Responses
--   <a>https://tools.ietf.org/html/rfc6749#section-4.1.2.1</a> Implicit
--   Grant Error Responses
--   <a>https://tools.ietf.org/html/rfc6749#section-4.2.2.1</a>
data Errors
InvalidRequest :: Errors
UnauthorizedClient :: Errors
AccessDenied :: Errors
UnsupportedResponseType :: Errors
InvalidScope :: Errors
ServerError :: Errors
TemporarilyUnavailable :: Errors
instance GHC.Generics.Generic Network.OAuth.OAuth2.AuthorizationRequest.Errors
instance GHC.Classes.Eq Network.OAuth.OAuth2.AuthorizationRequest.Errors
instance GHC.Show.Show Network.OAuth.OAuth2.AuthorizationRequest.Errors
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.AuthorizationRequest.Errors
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.AuthorizationRequest.Errors


-- | A simple OAuth2 Haskell binding. (This is supposed to be independent
--   of the http client used.)
module Network.OAuth.OAuth2.Internal

-- | Query Parameter Representation
data OAuth2
OAuth2 :: Text -> Text -> URI -> URI -> Maybe URI -> OAuth2
[oauthClientId] :: OAuth2 -> Text
[oauthClientSecret] :: OAuth2 -> Text
[oauthOAuthorizeEndpoint] :: OAuth2 -> URI
[oauthAccessTokenEndpoint] :: OAuth2 -> URI
[oauthCallback] :: OAuth2 -> Maybe URI
newtype AccessToken
AccessToken :: Text -> AccessToken
[atoken] :: AccessToken -> Text
newtype RefreshToken
RefreshToken :: Text -> RefreshToken
[rtoken] :: RefreshToken -> Text
newtype IdToken
IdToken :: Text -> IdToken
[idtoken] :: IdToken -> Text
newtype ExchangeToken
ExchangeToken :: Text -> ExchangeToken
[extoken] :: ExchangeToken -> Text

-- | The gained Access Token. Use <tt>Data.Aeson.decode</tt> to decode
--   string to <tt>AccessToken</tt>. The <tt>refreshToken</tt> is special
--   in some cases, e.g.
--   <a>https://developers.google.com/accounts/docs/OAuth2</a>
data OAuth2Token
OAuth2Token :: AccessToken -> Maybe RefreshToken -> Maybe Int -> Maybe Text -> Maybe IdToken -> OAuth2Token
[accessToken] :: OAuth2Token -> AccessToken
[refreshToken] :: OAuth2Token -> Maybe RefreshToken
[expiresIn] :: OAuth2Token -> Maybe Int
[tokenType] :: OAuth2Token -> Maybe Text
[idToken] :: OAuth2Token -> Maybe IdToken

-- | Parse JSON data into <a>OAuth2Token</a>
data OAuth2Error a
OAuth2Error :: Either Text a -> Maybe Text -> Maybe (URIRef Absolute) -> OAuth2Error a
[error] :: OAuth2Error a -> Either Text a
[errorDescription] :: OAuth2Error a -> Maybe Text
[errorUri] :: OAuth2Error a -> Maybe (URIRef Absolute)
parseOAuth2Error :: FromJSON err => ByteString -> OAuth2Error err
mkDecodeOAuth2Error :: ByteString -> String -> OAuth2Error err

-- | Is either <a>Left</a> containing an error or <a>Right</a> containg a
--   result
type OAuth2Result err a = Either (OAuth2Error err) a

-- | type synonym of post body content
type PostBody = [(ByteString, ByteString)]
type QueryParams = [(ByteString, ByteString)]

-- | Prepare the authorization URL. Redirect to this URL asking for user
--   interactive authentication.
authorizationUrl :: OAuth2 -> URI

-- | Prepare the URL and the request body query for fetching an access
--   token.
accessTokenUrl :: OAuth2 -> ExchangeToken -> (URI, PostBody)

-- | Prepare the URL and the request body query for fetching an access
--   token, with optional grant type.
accessTokenUrl' :: OAuth2 -> ExchangeToken -> Maybe Text -> (URI, PostBody)

-- | Using a Refresh Token. Obtain a new access token by sending a refresh
--   token to the Authorization server.
refreshAccessTokenUrl :: OAuth2 -> RefreshToken -> (URI, PostBody)

-- | For <tt>GET</tt> method API.
appendAccessToken :: URIRef a -> AccessToken -> URIRef a

-- | Create <a>QueryParams</a> with given access token value.
accessTokenToParam :: AccessToken -> [(ByteString, ByteString)]
appendQueryParams :: [(ByteString, ByteString)] -> URIRef a -> URIRef a
uriToRequest :: MonadThrow m => URI -> m Request
requestToUri :: Request -> URI
hostLens :: Lens' Request ByteString
portLens :: Lens' Request Int
instance GHC.Generics.Generic (Network.OAuth.OAuth2.Internal.OAuth2Error a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Network.OAuth.OAuth2.Internal.OAuth2Error a)
instance GHC.Show.Show a => GHC.Show.Show (Network.OAuth.OAuth2.Internal.OAuth2Error a)
instance GHC.Generics.Generic Network.OAuth.OAuth2.Internal.OAuth2Token
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.OAuth2Token
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.Internal.ExchangeToken
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.Internal.ExchangeToken
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.ExchangeToken
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.Internal.IdToken
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.Internal.IdToken
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.IdToken
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.Internal.RefreshToken
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.Internal.RefreshToken
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.RefreshToken
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.Internal.AccessToken
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.Internal.AccessToken
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.AccessToken
instance GHC.Classes.Eq Network.OAuth.OAuth2.Internal.OAuth2
instance GHC.Show.Show Network.OAuth.OAuth2.Internal.OAuth2
instance Data.Aeson.Types.FromJSON.FromJSON err => Data.Aeson.Types.FromJSON.FromJSON (Network.OAuth.OAuth2.Internal.OAuth2Error err)
instance Data.Aeson.Types.ToJSON.ToJSON err => Data.Aeson.Types.ToJSON.ToJSON (Network.OAuth.OAuth2.Internal.OAuth2Error err)
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.Internal.OAuth2Token
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.Internal.OAuth2Token

module Network.OAuth.OAuth2.TokenRequest

-- | Token Error Responses
--   <a>https://tools.ietf.org/html/rfc6749#section-5.2</a>
data Errors
InvalidRequest :: Errors
InvalidClient :: Errors
InvalidGrant :: Errors
UnauthorizedClient :: Errors
UnsupportedGrantType :: Errors
InvalidScope :: Errors
instance GHC.Generics.Generic Network.OAuth.OAuth2.TokenRequest.Errors
instance GHC.Classes.Eq Network.OAuth.OAuth2.TokenRequest.Errors
instance GHC.Show.Show Network.OAuth.OAuth2.TokenRequest.Errors
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth.OAuth2.TokenRequest.Errors
instance Data.Aeson.Types.ToJSON.ToJSON Network.OAuth.OAuth2.TokenRequest.Errors


-- | A simple http client to request OAuth2 tokens and several utils.
module Network.OAuth.OAuth2.HttpClient

-- | Request OAuth2 Token method: POST authenticate in header
fetchAccessToken :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)

-- | Request OAuth2 Token method: POST authenticate in both header and body
fetchAccessToken2 :: Manager -> OAuth2 -> ExchangeToken -> IO (OAuth2Result Errors OAuth2Token)

-- | <i>Deprecated: Use refreshAccessToken since this method will be
--   removed in future release</i>
fetchRefreshToken :: Manager -> OAuth2 -> RefreshToken -> IO (OAuth2Result Errors OAuth2Token)

-- | Request a new AccessToken with the Refresh Token.
refreshAccessToken :: Manager -> OAuth2 -> RefreshToken -> IO (OAuth2Result Errors OAuth2Token)

-- | Conduct post request and return response as JSON.
doJSONPostRequest :: FromJSON err => FromJSON a => Manager -> OAuth2 -> URI -> PostBody -> IO (OAuth2Result err a)

-- | Conduct post request and return response as JSON or Query String.

-- | <i>Deprecated: Use doJSONPostRequest since this function would be
--   removed in future release.</i>
doFlexiblePostRequest :: FromJSON err => FromJSON a => Manager -> OAuth2 -> URI -> PostBody -> IO (OAuth2Result err a)

-- | Conduct post request.
doSimplePostRequest :: FromJSON err => Manager -> OAuth2 -> URI -> PostBody -> IO (OAuth2Result err ByteString)

-- | Conduct an authorized GET request and return response as JSON.
authGetJSON :: FromJSON err => FromJSON a => Manager -> AccessToken -> URI -> IO (OAuth2Result err a)

-- | Conduct an authorized GET request.
authGetBS :: FromJSON err => Manager -> AccessToken -> URI -> IO (OAuth2Result err ByteString)

-- | same to <a>authGetBS</a> but set access token to query parameter
--   rather than header
authGetBS2 :: FromJSON err => Manager -> AccessToken -> URI -> IO (OAuth2Result err ByteString)

-- | Conduct POST request and return response as JSON.
authPostJSON :: FromJSON err => FromJSON a => Manager -> AccessToken -> URI -> PostBody -> IO (OAuth2Result err a)

-- | Conduct POST request.
authPostBS :: FromJSON err => Manager -> AccessToken -> URI -> PostBody -> IO (OAuth2Result err ByteString)

-- | Conduct POST request with access token in the request body rather
--   header
authPostBS2 :: FromJSON err => Manager -> AccessToken -> URI -> PostBody -> IO (OAuth2Result err ByteString)

-- | Conduct POST request with access token in the header and null in body
authPostBS3 :: FromJSON err => Manager -> AccessToken -> URI -> IO (OAuth2Result err ByteString)

-- | Send an HTTP request including the Authorization header with the
--   specified access token.
authRequest :: FromJSON err => Request -> (Request -> Request) -> Manager -> IO (OAuth2Result err ByteString)

-- | Parses a <tt>Response</tt> to to <tt>OAuth2Result</tt>
handleResponse :: FromJSON err => Response ByteString -> OAuth2Result err ByteString

-- | Parses a <tt>OAuth2Result BSL.ByteString</tt> into <tt>FromJSON a
--   =&gt; a</tt>
parseResponseJSON :: FromJSON err => FromJSON a => OAuth2Result err ByteString -> OAuth2Result err a

-- | Try <a>parseResponseJSON</a>, if failed then parses the
--   <tt>OAuth2Result BSL.ByteString</tt> that contains not JSON but a
--   Query String.
parseResponseFlexible :: FromJSON err => FromJSON a => OAuth2Result err ByteString -> OAuth2Result err a

-- | Set several header values: + userAgennt : <tt>hoauth2</tt> + accept :
--   `application/json` + authorization : <tt>Bearer</tt> <tt>xxxxx</tt> if
--   <a>AccessToken</a> provided.
updateRequestHeaders :: Maybe AccessToken -> Request -> Request

-- | Set the HTTP method to use.
setMethod :: StdMethod -> Request -> Request


-- | A lightweight oauth2 haskell binding.
module Network.OAuth.OAuth2