wire-api-0.1.0
Safe HaskellSafe-Inferred
LanguageGHC2021

Wire.API.Team.Member

Synopsis

TeamMember

type TeamMember = TeamMember' 'Required Source #

mkTeamMember :: UserId -> PermissionType tag -> Maybe (UserId, UTCTimeMillis) -> UserLegalHoldStatus -> TeamMember' tag Source #

userId :: Lens' TeamMember UserId Source #

permissions :: Lens (TeamMember' tag1) (TeamMember' tag2) (PermissionType tag1) (PermissionType tag2) Source #

invitation :: Lens' TeamMember (Maybe (UserId, UTCTimeMillis)) Source #

legalHoldStatus :: forall tag. Lens' (TeamMember' tag) UserLegalHoldStatus Source #

ntmNewTeamMember :: NewTeamMember' tag -> TeamMember' tag Source #

setOptionalPerms :: (TeamMember -> Bool) -> TeamMember -> TeamMember' 'Optional Source #

setOptionalPermsMany :: (TeamMember -> Bool) -> TeamMemberList -> TeamMemberList' 'Optional Source #

teamMemberObjectSchema :: ObjectSchema SwaggerDoc TeamMember Source #

TeamMemberList

type TeamMemberList = TeamMemberList' 'Required Source #

type TeamMemberListOptPerms = TeamMemberList' 'Optional Source #

newtype TeamMembersPage Source #

Constructors

TeamMembersPage 

Fields

Instances

Instances details
FromJSON TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

parseJSON :: Value -> Parser TeamMembersPage Source #

parseJSONList :: Value -> Parser [TeamMembersPage] Source #

ToJSON TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

toJSON :: TeamMembersPage -> Value Source #

toEncoding :: TeamMembersPage -> Encoding Source #

toJSONList :: [TeamMembersPage] -> Value Source #

toEncodingList :: [TeamMembersPage] -> Encoding Source #

Generic TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type Rep TeamMembersPage :: Type -> Type #

Methods

from :: TeamMembersPage -> Rep TeamMembersPage x #

to :: Rep TeamMembersPage x -> TeamMembersPage #

Show TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

showsPrec :: Int -> TeamMembersPage -> ShowS #

show :: TeamMembersPage -> String #

showList :: [TeamMembersPage] -> ShowS #

Eq TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

(==) :: TeamMembersPage -> TeamMembersPage -> Bool #

(/=) :: TeamMembersPage -> TeamMembersPage -> Bool #

ToSchema TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

declareNamedSchema :: Proxy TeamMembersPage -> Declare (Definitions Schema) NamedSchema Source #

ToSchema TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

schema :: ValueSchema NamedSwaggerDoc TeamMembersPage Source #

type Rep TeamMembersPage Source # 
Instance details

Defined in Wire.API.Team.Member

type Rep TeamMembersPage

type TeamMembersPagingState = MultiTablePagingState TeamMembersPagingName TeamMembersTable Source #

teamMemberPagingState :: PageWithState TeamMember -> TeamMembersPagingState Source #

newTeamMemberList :: [TeamMember] -> ListType -> TeamMemberList Source #

teamMembers :: forall tag tag. Lens (TeamMemberList' tag) (TeamMemberList' tag) [TeamMember' tag] [TeamMember' tag] Source #

teamMemberListType :: forall tag. Lens' (TeamMemberList' tag) ListType Source #

type HardTruncationLimit = 2000 :: Nat Source #

hardTruncationLimit :: Integral a => a Source #

data NewListType Source #

Like ListType, but without backwards-compatible and boolean-blind json serialization.

Constructors

NewListComplete 
NewListTruncated 

Instances

Instances details
Arbitrary NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

arbitrary :: Gen NewListType Source #

shrink :: NewListType -> [NewListType] Source #

FromJSON NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

parseJSON :: Value -> Parser NewListType Source #

parseJSONList :: Value -> Parser [NewListType] Source #

ToJSON NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

toJSON :: NewListType -> Value Source #

toEncoding :: NewListType -> Encoding Source #

toJSONList :: [NewListType] -> Value Source #

toEncodingList :: [NewListType] -> Encoding Source #

Generic NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type Rep NewListType :: Type -> Type #

Methods

from :: NewListType -> Rep NewListType x #

to :: Rep NewListType x -> NewListType #

Show NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

showsPrec :: Int -> NewListType -> ShowS #

show :: NewListType -> String #

showList :: [NewListType] -> ShowS #

Eq NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

(==) :: NewListType -> NewListType -> Bool #

(/=) :: NewListType -> NewListType -> Bool #

Ord NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

compare :: NewListType -> NewListType -> Ordering #

(<) :: NewListType -> NewListType -> Bool #

(<=) :: NewListType -> NewListType -> Bool #

(>) :: NewListType -> NewListType -> Bool #

(>=) :: NewListType -> NewListType -> Bool #

max :: NewListType -> NewListType -> NewListType #

min :: NewListType -> NewListType -> NewListType #

ToSchema NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

declareNamedSchema :: Proxy NewListType -> Declare (Definitions Schema) NamedSchema Source #

ToSchema NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

schema :: ValueSchema NamedSwaggerDoc NewListType Source #

type Rep NewListType Source # 
Instance details

Defined in Wire.API.Team.Member

type Rep NewListType = D1 ('MetaData "NewListType" "Wire.API.Team.Member" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "NewListComplete" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "NewListTruncated" 'PrefixI 'False) (U1 :: Type -> Type))

toNewListType :: ListType -> NewListType Source #

data ListType Source #

Constructors

ListComplete 
ListTruncated 

Instances

Instances details
Arbitrary ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

arbitrary :: Gen ListType Source #

shrink :: ListType -> [ListType] Source #

FromJSON ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

parseJSON :: Value -> Parser ListType Source #

parseJSONList :: Value -> Parser [ListType] Source #

ToJSON ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

toJSON :: ListType -> Value Source #

toEncoding :: ListType -> Encoding Source #

toJSONList :: [ListType] -> Value Source #

toEncodingList :: [ListType] -> Encoding Source #

Generic ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type Rep ListType :: Type -> Type #

Methods

from :: ListType -> Rep ListType x #

to :: Rep ListType x -> ListType #

Show ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

showsPrec :: Int -> ListType -> ShowS #

show :: ListType -> String #

showList :: [ListType] -> ShowS #

Eq ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

(==) :: ListType -> ListType -> Bool #

(/=) :: ListType -> ListType -> Bool #

Ord ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

compare :: ListType -> ListType -> Ordering #

(<) :: ListType -> ListType -> Bool #

(<=) :: ListType -> ListType -> Bool #

(>) :: ListType -> ListType -> Bool #

(>=) :: ListType -> ListType -> Bool #

max :: ListType -> ListType -> ListType #

min :: ListType -> ListType -> ListType #

ToSchema ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

declareNamedSchema :: Proxy ListType -> Declare (Definitions Schema) NamedSchema Source #

ToSchema ListType Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

schema :: ValueSchema NamedSwaggerDoc ListType Source #

type Rep ListType Source # 
Instance details

Defined in Wire.API.Team.Member

type Rep ListType = D1 ('MetaData "ListType" "Wire.API.Team.Member" "wire-api-0.1.0-3915FetN8WgFcCGrbk6Vve" 'False) (C1 ('MetaCons "ListComplete" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ListTruncated" 'PrefixI 'False) (U1 :: Type -> Type))

NewTeamMember

type NewTeamMember = NewTeamMember' 'Required Source #

type TeamMemberOptPerms = TeamMember' 'Optional Source #

mkNewTeamMember :: UserId -> PermissionType 'Required -> Maybe (UserId, UTCTimeMillis) -> NewTeamMember Source #

nUserId :: forall tag. Lens' (NewTeamMember' tag) UserId Source #

nPermissions :: forall tag tag. Lens (NewTeamMember' tag) (NewTeamMember' tag) (PermissionType tag) (PermissionType tag) Source #

optionalPermissions :: TeamMemberOptPerms -> Maybe Permissions Source #

nInvitation :: forall tag. Lens' (NewTeamMember' tag) (Maybe (UserId, UTCTimeMillis)) Source #

TeamMemberDeleteData

data TeamMemberDeleteData Source #

Instances

Instances details
Arbitrary TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

arbitrary :: Gen TeamMemberDeleteData Source #

shrink :: TeamMemberDeleteData -> [TeamMemberDeleteData] Source #

FromJSON TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

parseJSON :: Value -> Parser TeamMemberDeleteData Source #

parseJSONList :: Value -> Parser [TeamMemberDeleteData] Source #

ToJSON TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

toJSON :: TeamMemberDeleteData -> Value Source #

toEncoding :: TeamMemberDeleteData -> Encoding Source #

toJSONList :: [TeamMemberDeleteData] -> Value Source #

toEncodingList :: [TeamMemberDeleteData] -> Encoding Source #

Show TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

showsPrec :: Int -> TeamMemberDeleteData -> ShowS #

show :: TeamMemberDeleteData -> String #

showList :: [TeamMemberDeleteData] -> ShowS #

Eq TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

(==) :: TeamMemberDeleteData -> TeamMemberDeleteData -> Bool #

(/=) :: TeamMemberDeleteData -> TeamMemberDeleteData -> Bool #

ToSchema TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

declareNamedSchema :: Proxy TeamMemberDeleteData -> Declare (Definitions Schema) NamedSchema Source #

ToSchema TeamMemberDeleteData Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

schema :: ValueSchema NamedSwaggerDoc TeamMemberDeleteData Source #

newTeamMemberDeleteData :: Maybe PlainTextPassword6 -> TeamMemberDeleteData Source #

tmdAuthPassword :: Iso' TeamMemberDeleteData (Maybe PlainTextPassword6) Source #

Permissions

isAdminOrOwner :: Permissions -> Bool Source #

permissionsRole :: Permissions -> Maybe Role Source #

rolePermissions :: Role -> Permissions Source #

class IsPerm perm where Source #

See Note [hidden team roles]

Minimal complete definition

roleHasPerm, roleGrantsPerm

Associated Types

type PermError (e :: perm) :: GalleyError Source #

Methods

roleHasPerm :: Role -> perm -> Bool Source #

roleGrantsPerm :: Role -> perm -> Bool Source #

hasPermission :: TeamMember -> perm -> Bool Source #

mayGrantPermission :: TeamMember -> perm -> Bool Source #

Instances

Instances details
IsPerm HiddenPerm Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type PermError e :: GalleyError Source #

Methods

roleHasPerm :: Role -> HiddenPerm -> Bool Source #

roleGrantsPerm :: Role -> HiddenPerm -> Bool Source #

hasPermission :: TeamMember -> HiddenPerm -> Bool Source #

mayGrantPermission :: TeamMember -> HiddenPerm -> Bool Source #

IsPerm Perm Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type PermError e :: GalleyError Source #

Methods

roleHasPerm :: Role -> Perm -> Bool Source #

roleGrantsPerm :: Role -> Perm -> Bool Source #

hasPermission :: TeamMember -> Perm -> Bool Source #

mayGrantPermission :: TeamMember -> Perm -> Bool Source #

data HiddenPerm Source #

See Note [hidden team roles]

Constructors

ChangeLegalHoldTeamSettings 
ChangeLegalHoldUserSettings 
ViewLegalHoldUserSettings 
ChangeTeamFeature 
ChangeTeamSearchVisibility 
ViewTeamSearchVisibility 
ViewSameTeamEmails 
ReadIdp 
CreateUpdateDeleteIdp 
CreateReadDeleteScimToken 
DownloadTeamMembersCsv

this has its own permission because we're not sure how efficient this end-point is. better not let all team members play with it unless we have to.

ChangeTeamMemberProfiles 
SearchContacts 

Instances

Instances details
Show HiddenPerm Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

showsPrec :: Int -> HiddenPerm -> ShowS #

show :: HiddenPerm -> String #

showList :: [HiddenPerm] -> ShowS #

Eq HiddenPerm Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

(==) :: HiddenPerm -> HiddenPerm -> Bool #

(/=) :: HiddenPerm -> HiddenPerm -> Bool #

Ord HiddenPerm Source # 
Instance details

Defined in Wire.API.Team.Member

Methods

compare :: HiddenPerm -> HiddenPerm -> Ordering #

(<) :: HiddenPerm -> HiddenPerm -> Bool #

(<=) :: HiddenPerm -> HiddenPerm -> Bool #

(>) :: HiddenPerm -> HiddenPerm -> Bool #

(>=) :: HiddenPerm -> HiddenPerm -> Bool #

max :: HiddenPerm -> HiddenPerm -> HiddenPerm #

min :: HiddenPerm -> HiddenPerm -> HiddenPerm #

IsPerm HiddenPerm Source # 
Instance details

Defined in Wire.API.Team.Member

Associated Types

type PermError e :: GalleyError Source #

Methods

roleHasPerm :: Role -> HiddenPerm -> Bool Source #

roleGrantsPerm :: Role -> HiddenPerm -> Bool Source #

hasPermission :: TeamMember -> HiddenPerm -> Bool Source #

mayGrantPermission :: TeamMember -> HiddenPerm -> Bool Source #

type PermError (p :: HiddenPerm) Source # 
Instance details

Defined in Wire.API.Team.Member

type PermError (p :: HiddenPerm) = OperationDenied