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


-- | Microsoft Graph API
--   
--   Bindings to the Microsoft Graph API
@package ms-graph-api
@version 0.6.0.0

module MSGraphAPI.User

module Network.OAuth2.Provider.AzureAD

-- | Configuration object of the OAuth2 application
data OAuthCfg
OAuthCfg :: Text -> ClientId -> ClientSecret -> [Scope] -> AuthorizeState -> URI -> OAuthCfg

-- | application name
[$sel:oacAppName:OAuthCfg] :: OAuthCfg -> Text

-- | app client ID : see <a>https://stackoverflow.com/a/70670961</a>
[$sel:oacClientId:OAuthCfg] :: OAuthCfg -> ClientId

-- | app client secret "
[$sel:oacClientSecret:OAuthCfg] :: OAuthCfg -> ClientSecret

-- | OAuth2 and OIDC scopes
[$sel:oacScopes:OAuthCfg] :: OAuthCfg -> [Scope]

-- | OAuth2 <tt>state</tt> (a random string,
--   <a>https://www.rfc-editor.org/rfc/rfc6749#section-10.12</a> )
[$sel:oacAuthState:OAuthCfg] :: OAuthCfg -> AuthorizeState

-- | OAuth2 redirect URI
[$sel:oacRedirectURI:OAuthCfg] :: OAuthCfg -> URI
data AzureAD

-- | 
--   <a>https://learn.microsoft.com/en-us/azure/active-directory/develop/userinfo</a>
data AzureADUser

-- | NB : scopes <tt>openid</tt> and <tt>offline_access</tt> are ALWAYS
--   requested since the library assumes we have access to refresh tokens
--   and ID tokens
--   
--   Reference on Microsoft Graph permissions :
--   <a>https://learn.microsoft.com/en-us/graph/permissions-reference</a>
azureADApp :: OAuthCfg -> IdpApplication 'AuthorizationCode AzureAD
instance GHC.Show.Show Network.OAuth2.Provider.AzureAD.AzureAD
instance GHC.Classes.Eq Network.OAuth2.Provider.AzureAD.AzureAD
instance GHC.Show.Show Network.OAuth2.Provider.AzureAD.AzureADUser
instance GHC.Classes.Ord Network.OAuth2.Provider.AzureAD.AzureADUser
instance GHC.Classes.Eq Network.OAuth2.Provider.AzureAD.AzureADUser
instance Data.Aeson.Types.FromJSON.FromJSON Network.OAuth2.Provider.AzureAD.AzureADUser


-- | OAuth user session
module Network.OAuth2.Session

-- | Decode the App Service ID token header
--   <tt>X-MS-TOKEN-AAD-ID-TOKEN</tt>, look its user up in the local token
--   store, supply token <tt>t</tt> to continuation. If the user
--   <tt>sub</tt> cannot be found in the token store the browser is
--   redirected to the login URI.
--   
--   Special case of <a>aadHeaderIdToken</a>
withAADUser :: MonadIO m => Tokens UserSub t -> Text -> (t -> Action m ()) -> Action m ()

-- | Login endpoint
--   
--   see <a>azureADApp</a>
loginEndpoint :: MonadIO m => IdpApplication 'AuthorizationCode AzureAD -> RoutePattern -> Scotty m ()

-- | The identity provider redirects the client to the <tt>reply</tt>
--   endpoint as part of the OAuth flow :
--   <a>https://learn.microsoft.com/en-us/graph/auth-v2-user?view=graph-rest-1.0&amp;tabs=http#authorization-response</a>
--   
--   see <a>azureADApp</a>
replyEndpoint :: MonadIO m => IdpApplication 'AuthorizationCode AzureAD -> Tokens UserSub OAuth2Token -> Manager -> RoutePattern -> Scotty m ()

-- | transactional token store
type Tokens uid t = TVar (TokensData uid t)

-- | Create an empty <a>Tokens</a> object
newTokens :: (MonadIO m, Ord uid) => m (Tokens uid t)

-- | <tt>sub</tt> field
data UserSub

-- | Look up a user identifier and return their current token, if any
lookupUser :: (MonadIO m, Ord uid) => Tokens uid t -> uid -> m (Maybe t)

-- | Remove a user, i.e. they will have to authenticate once more
expireUser :: (MonadIO m, Ord uid) => Tokens uid t -> uid -> m ()

-- | return a list representation of the <a>Tokens</a> object
tokensToList :: MonadIO m => Tokens k a -> m [(k, a)]
type Scotty = ScottyT Text
type Action = ActionT Text
instance GHC.Classes.Eq Network.OAuth2.Session.OAuthSessionError
instance (GHC.Show.Show uid, GHC.Show.Show t) => GHC.Show.Show (Network.OAuth2.Session.TokensData uid t)
instance (GHC.Classes.Eq uid, GHC.Classes.Eq t) => GHC.Classes.Eq (Network.OAuth2.Session.TokensData uid t)
instance GHC.Exception.Type.Exception Network.OAuth2.Session.OAuthSessionError
instance GHC.Show.Show Network.OAuth2.Session.OAuthSessionError


-- | Common functions for the MS Graph API v1.0
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/overview?view=graph-rest-1.0&amp;preserve-view=true</a>
module MSGraphAPI.Internal.Common

-- | <pre>
--   GET https://graph.microsoft.com/v1.0/...
--   </pre>
get :: FromJSON a => [Text] -> Option 'Https -> AccessToken -> Req a

-- | <pre>
--   GET https://graph.microsoft.com/v1.0/...
--   </pre>
--   
--   Returns the response body as a bytestring, e.g. for endpoints that
--   download files or general bytestring payloads
getLbs :: [Text] -> Option 'Https -> AccessToken -> Req ByteString

-- | Like <a>get</a> but catches <a>HttpException</a>s to allow pattern
--   matching
getE :: FromJSON a => [Text] -> Option 'Https -> AccessToken -> Req (Either HttpException a)

-- | <pre>
--   POST https://graph.microsoft.com/v1.0/...
--   </pre>
post :: (ToJSON a, FromJSON b) => [Text] -> Option 'Https -> a -> AccessToken -> Req b

-- | Like <a>post</a> but catches <a>HttpException</a>s to allow pattern
--   matching
postE :: (ToJSON a, FromJSON b) => [Text] -> Option 'Https -> a -> AccessToken -> Req (Either HttpException b)

-- | Run a computation in the <a>Req</a> monad with the given
--   <a>HttpConfig</a>. In the case of an exceptional situation an
--   <a>HttpException</a> will be thrown.
runReq :: MonadIO m => HttpConfig -> Req a -> m a

-- | Specialized version of <a>try</a> to <a>HttpException</a>s
--   
--   This can be used to catch exceptions of composite <a>Req</a>
--   statements, e.g. around a <tt>do</tt> block
tryReq :: Req a -> Req (Either HttpException a)

-- | a collection of items with key <tt>value</tt>
data Collection a
Collection :: [a] -> Collection a
[cValue] :: Collection a -> [a]

-- | drop the prefix and lowercase first character
--   
--   e.g. <tt>userDisplayName</tt> <tt>-&gt;</tt> <tt>displayName</tt>
aesonOptions :: String -> Options
instance GHC.Generics.Generic (MSGraphAPI.Internal.Common.Collection a)
instance GHC.Show.Show a => GHC.Show.Show (MSGraphAPI.Internal.Common.Collection a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (MSGraphAPI.Internal.Common.Collection a)
instance Data.Aeson.Types.FromJSON.FromJSON a => Data.Aeson.Types.FromJSON.FromJSON (MSGraphAPI.Internal.Common.Collection a)


-- | User
module MSGraphAPI.Users.User
data User
User :: Text -> Text -> Text -> User
[uId] :: User -> Text
[uUserPrincipalName] :: User -> Text
[uDisplayName] :: User -> Text

-- | Get user information
--   
--   <pre>
--   GET /users/{user-id}
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/user-get?view=graph-rest-1.0&amp;tabs=http#request</a>
get :: Text -> AccessToken -> Req User

-- | Get information on signed-in user
--   
--   Calling the /me endpoint requires a signed-in user and therefore a
--   delegated permission. Application permissions are not supported when
--   using the /me endpoint.
--   
--   <pre>
--   GET /me
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/user-get?view=graph-rest-1.0&amp;tabs=http#request-1</a>
getMe :: AccessToken -> Req User
instance GHC.Generics.Generic MSGraphAPI.Users.User.User
instance GHC.Show.Show MSGraphAPI.Users.User.User
instance GHC.Classes.Ord MSGraphAPI.Users.User.User
instance GHC.Classes.Eq MSGraphAPI.Users.User.User
instance Data.Aeson.Types.FromJSON.FromJSON MSGraphAPI.Users.User.User

module MSGraphAPI.Files.DriveItem
data DriveItem
DriveItem :: Text -> Text -> LocalTime -> DriveItem
[diId] :: DriveItem -> Text
[diName] :: DriveItem -> Text
[diLastModifiedDateTime] :: DriveItem -> LocalTime

-- | download a complete file from user's directory
--   
--   <pre>
--   GET /me/drive/items/{item-id}/content
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/driveitem-get-content?view=graph-rest-1.0&amp;tabs=http#request</a>
downloadFileMe :: Text -> AccessToken -> Req ByteString

-- | download a file from a drive
--   
--   <pre>
--   GET /drives/{drive-id}/items/{item-id}/content
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/driveitem-get-content?view=graph-rest-1.0&amp;tabs=http#request</a>
downloadFile :: Text -> Text -> AccessToken -> Req ByteString
instance GHC.Generics.Generic MSGraphAPI.Files.DriveItem.DriveItem
instance GHC.Show.Show MSGraphAPI.Files.DriveItem.DriveItem
instance GHC.Classes.Ord MSGraphAPI.Files.DriveItem.DriveItem
instance GHC.Classes.Eq MSGraphAPI.Files.DriveItem.DriveItem
instance Data.Aeson.Types.FromJSON.FromJSON MSGraphAPI.Files.DriveItem.DriveItem


-- | User
module MSGraphAPI.Users.Group

-- | Groups are collections of principals with shared access to resources
--   in Microsoft services or in your app. Different principals such as
--   users, other groups, devices, and applications can be part of groups.
--   
--   
--   httpstea:/<i>learn.microsoft.com</i>en-us<i>graph</i>api<i>resources</i>groups-overview?view=graph-rest-1.0&amp;tabs=http
data Group
Group :: Text -> Text -> Text -> Group
[gId] :: Group -> Text
[gDisplayName] :: Group -> Text
[gDescription] :: Group -> Text

-- | Get the teams in Microsoft Teams that the user is a direct member of.
--   
--   <pre>
--   GET /users/{id | user-principal-name}/joinedTeams
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/user-list-joinedteams?view=graph-rest-1.0&amp;tabs=http</a>
getUserJoinedTeams :: Text -> AccessToken -> Req (Collection Group)

-- | Get the <a>DriveItem</a>s in the <a>Group</a> storage, starting from
--   the root item
--   
--   <pre>
--   GET /groups/{group-id}/drive/root/children
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/driveitem-list-children?view=graph-rest-1.0&amp;tabs=http</a>
getGroupsDriveItems :: Text -> AccessToken -> Req (Collection DriveItem)
instance GHC.Generics.Generic MSGraphAPI.Users.Group.Group
instance GHC.Show.Show MSGraphAPI.Users.Group.Group
instance GHC.Classes.Ord MSGraphAPI.Users.Group.Group
instance GHC.Classes.Eq MSGraphAPI.Users.Group.Group
instance Data.Aeson.Types.FromJSON.FromJSON MSGraphAPI.Users.Group.Group

module MSGraphAPI.Drive

-- | Get drive of current user
getDriveMe :: AccessToken -> Req Drive

-- | List children in the root of the current user's drive
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/driveitem-list-children?view=graph-rest-1.0&amp;tabs=http#list-children-in-the-root-of-the-current-users-drive</a>
getDriveItemsMe :: AccessToken -> Req (Collection DriveItem)

-- | List children in the root of the current user's drive
--   
--   <pre>
--   GET /drives/{drive-id}/items/{item-id}/children
--   </pre>
--   
--   
--   <a>https://learn.microsoft.com/en-us/graph/api/driveitem-list-children?view=graph-rest-1.0&amp;tabs=http#list-children-in-the-root-of-the-current-users-drive</a>
getDriveItemChildren :: Text -> Text -> AccessToken -> Req (Collection DriveItem)
data Drive
Drive :: Text -> Drive
[dId] :: Drive -> Text
data DriveItem
DriveItem :: Text -> Maybe Int64 -> DriveItem
[diName] :: DriveItem -> Text
[diSize] :: DriveItem -> Maybe Int64
instance GHC.Generics.Generic MSGraphAPI.Drive.Drive
instance GHC.Show.Show MSGraphAPI.Drive.Drive
instance GHC.Classes.Eq MSGraphAPI.Drive.Drive
instance GHC.Generics.Generic MSGraphAPI.Drive.DriveItem
instance GHC.Show.Show MSGraphAPI.Drive.DriveItem
instance GHC.Classes.Eq MSGraphAPI.Drive.DriveItem
instance Data.Aeson.Types.FromJSON.FromJSON MSGraphAPI.Drive.DriveItem
instance Data.Aeson.Types.FromJSON.FromJSON MSGraphAPI.Drive.Drive