-----------------------------------------------------------------------------
-- |
-- License     :  BSD-3-Clause
-- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
--
-- The organization members API as described on
-- <http://developer.github.com/v3/orgs/members/>.
module GitHub.Endpoints.Organizations.Members (
    membersOf,
    membersOf',
    membersOfR,
    membersOfWithR,
    isMemberOf,
    isMemberOf',
    isMemberOfR,
    orgInvitationsR,
    module GitHub.Data,
    ) where

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

-- | All the users who are members of the specified organization,
-- | with or without authentication.
--
-- > membersOf' (Just $ OAuth "token") "thoughtbot"
membersOf' :: Maybe Auth -> Name Organization -> IO (Either Error (Vector SimpleUser))
membersOf' :: Maybe Auth
-> Name Organization -> IO (Either Error (Vector SimpleUser))
membersOf' auth :: Maybe Auth
auth org :: Name Organization
org =
    Maybe Auth
-> GenRequest 'MtJSON 'RO (Vector SimpleUser)
-> IO (Either Error (Vector SimpleUser))
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtJSON 'RO (Vector SimpleUser)
 -> IO (Either Error (Vector SimpleUser)))
-> GenRequest 'MtJSON 'RO (Vector SimpleUser)
-> IO (Either Error (Vector SimpleUser))
forall a b. (a -> b) -> a -> b
$ Name Organization
-> FetchCount -> GenRequest 'MtJSON 'RO (Vector SimpleUser)
forall (k :: RW).
Name Organization -> FetchCount -> Request k (Vector SimpleUser)
membersOfR Name Organization
org FetchCount
FetchAll

-- | All the users who are members of the specified organization,
-- | without authentication.
--
-- > membersOf "thoughtbot"
membersOf :: Name Organization -> IO (Either Error (Vector SimpleUser))
membersOf :: Name Organization -> IO (Either Error (Vector SimpleUser))
membersOf = Maybe Auth
-> Name Organization -> IO (Either Error (Vector SimpleUser))
membersOf' Maybe Auth
forall a. Maybe a
Nothing

-- | All the users who are members of the specified organization.
--
-- See <https://developer.github.com/v3/orgs/members/#members-list>
membersOfR :: Name Organization -> FetchCount -> Request k (Vector SimpleUser)
membersOfR :: Name Organization -> FetchCount -> Request k (Vector SimpleUser)
membersOfR organization :: Name Organization
organization =
    Paths -> QueryString -> FetchCount -> Request k (Vector SimpleUser)
forall a (mt :: RW).
FromJSON a =>
Paths -> QueryString -> FetchCount -> Request mt (Vector a)
pagedQuery ["orgs", Name Organization -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Organization
organization, "members"] []

-- | 'membersOfR' with filters.
--
-- See <https://developer.github.com/v3/orgs/members/#members-list>
membersOfWithR :: Name Organization -> OrgMemberFilter -> OrgMemberRole -> FetchCount -> Request k (Vector SimpleUser)
membersOfWithR :: Name Organization
-> OrgMemberFilter
-> OrgMemberRole
-> FetchCount
-> Request k (Vector SimpleUser)
membersOfWithR org :: Name Organization
org f :: OrgMemberFilter
f r :: OrgMemberRole
r =
    Paths -> QueryString -> FetchCount -> Request k (Vector SimpleUser)
forall a (mt :: RW).
FromJSON a =>
Paths -> QueryString -> FetchCount -> Request mt (Vector a)
pagedQuery ["orgs", Name Organization -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Organization
org, "members"] [("filter", ByteString -> Maybe ByteString
forall a. a -> Maybe a
Just ByteString
f'), ("role", ByteString -> Maybe ByteString
forall a. a -> Maybe a
Just ByteString
r')]
  where
    f' :: ByteString
f' = case OrgMemberFilter
f of
        OrgMemberFilter2faDisabled -> "2fa_disabled"
        OrgMemberFilterAll         -> "all"
    r' :: ByteString
r' = case OrgMemberRole
r of
        OrgMemberRoleAll    -> "all"
        OrgMemberRoleAdmin  -> "admin"
        OrgMemberRoleMember -> "member"

-- | Check if a user is a member of an organization,
-- | with or without authentication.
--
-- > isMemberOf' (Just $ OAuth "token") "phadej" "haskell-infra"
isMemberOf' :: Maybe Auth -> Name User -> Name Organization -> IO (Either Error Bool)
isMemberOf' :: Maybe Auth
-> Name User -> Name Organization -> IO (Either Error Bool)
isMemberOf' auth :: Maybe Auth
auth user :: Name User
user org :: Name Organization
org =
    Maybe Auth
-> GenRequest 'MtStatus 'RO Bool -> IO (Either Error Bool)
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtStatus 'RO Bool -> IO (Either Error Bool))
-> GenRequest 'MtStatus 'RO Bool -> IO (Either Error Bool)
forall a b. (a -> b) -> a -> b
$ Name User -> Name Organization -> GenRequest 'MtStatus 'RO Bool
forall (rw :: RW).
Name User -> Name Organization -> GenRequest 'MtStatus rw Bool
isMemberOfR Name User
user Name Organization
org

-- | Check if a user is a member of an organization,
-- | without authentication.
--
-- > isMemberOf "phadej" "haskell-infra"
isMemberOf :: Name User -> Name Organization -> IO (Either Error Bool)
isMemberOf :: Name User -> Name Organization -> IO (Either Error Bool)
isMemberOf = Maybe Auth
-> Name User -> Name Organization -> IO (Either Error Bool)
isMemberOf' Maybe Auth
forall a. Maybe a
Nothing

-- | Check if a user is a member of an organization.
--
-- See <https://developer.github.com/v3/orgs/members/#check-membership>
isMemberOfR :: Name User -> Name Organization -> GenRequest 'MtStatus rw Bool
isMemberOfR :: Name User -> Name Organization -> GenRequest 'MtStatus rw Bool
isMemberOfR user :: Name User
user org :: Name Organization
org =
    Paths -> QueryString -> GenRequest 'MtStatus rw Bool
forall (mt :: MediaType *) (rw :: RW) a.
Paths -> QueryString -> GenRequest mt rw a
Query [ "orgs", Name Organization -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Organization
org, "members", Name User -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name User
user ] []

-- | List pending organization invitations
--
-- See <https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations>
orgInvitationsR :: Name Organization -> FetchCount -> Request 'RA (Vector Invitation)
orgInvitationsR :: Name Organization -> FetchCount -> Request 'RA (Vector Invitation)
orgInvitationsR org :: Name Organization
org = Paths
-> QueryString -> FetchCount -> Request 'RA (Vector Invitation)
forall a (mt :: RW).
FromJSON a =>
Paths -> QueryString -> FetchCount -> Request mt (Vector a)
pagedQuery ["orgs", Name Organization -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Organization
org, "invitations"] []