Safe Haskell	None
Language	Haskell2010

UserManagement.Group

Synopsis

data Group = Group {
- groupID :: GroupID
- groupName :: Text
- groupDescription :: Maybe Text
- groupMembers :: [UserInfo]
}
data GroupCreate = GroupCreate {
- groupCreateName :: Text
- groupCreateDescription :: Maybe Text
- groupCreateUsers :: Maybe [UserID]
}
data GroupPatch = GroupPatch {
- patchName :: Maybe Text
- patchDescription :: Maybe (Maybe Text)
}
type GroupID = Int64
data GroupOverview = GroupOverview {
- groupOverviewID :: GroupID
- groupOverviewName :: Text
- groupOverviewDescription :: Maybe Text
}

Documentation

data Group Source #

Represents all information about a single group

Constructors

Group
Fields groupID :: GroupID groupName :: Text groupDescription :: Maybe Text groupMembers :: [UserInfo]

Instances

Instances details

ToJSON Group Source #

Instance details

Defined in UserManagement.Group

Methods

toJSON :: Group -> Value

toEncoding :: Group -> Encoding

toJSONList :: [Group] -> Value

toEncodingList :: [Group] -> Encoding

omitField :: Group -> Bool

Generic Group Source #

Instance details

Defined in UserManagement.Group

Associated Types

type Rep Group

Instance details

Defined in UserManagement.Group

type Rep Group = D1 ('MetaData "Group" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Group" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GroupID) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "groupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserInfo]))))

Methods

from :: Group -> Rep Group x #

to :: Rep Group x -> Group #

ToSchema Group Source #

Instance details

Defined in UserManagement.Group

Methods

declareNamedSchema :: Proxy Group -> Declare (Definitions Schema) NamedSchema

type Rep Group Source #

Instance details

Defined in UserManagement.Group

type Rep Group = D1 ('MetaData "Group" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "Group" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GroupID) :*: S1 ('MetaSel ('Just "groupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "groupDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupMembers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [UserInfo]))))

data GroupCreate Source #

Constructors

GroupCreate
Fields groupCreateName :: Text groupCreateDescription :: Maybe Text groupCreateUsers :: Maybe [UserID]

Instances

Instances details

FromJSON GroupCreate Source #

Instance details

Defined in UserManagement.Group

Methods

parseJSON :: Value -> Parser GroupCreate

parseJSONList :: Value -> Parser [GroupCreate]

omittedField :: Maybe GroupCreate

Generic GroupCreate Source #

Instance details

Defined in UserManagement.Group

Associated Types

type Rep GroupCreate

Instance details

Defined in UserManagement.Group

type Rep GroupCreate = D1 ('MetaData "GroupCreate" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupCreateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "groupCreateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupCreateUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [UserID])))))

Methods

from :: GroupCreate -> Rep GroupCreate x #

to :: Rep GroupCreate x -> GroupCreate #

Eq GroupCreate Source #

Instance details

Defined in UserManagement.Group

Methods

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

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

ToSchema GroupCreate Source #

Instance details

Defined in UserManagement.Group

Methods

declareNamedSchema :: Proxy GroupCreate -> Declare (Definitions Schema) NamedSchema

type Rep GroupCreate Source #

Instance details

Defined in UserManagement.Group

type Rep GroupCreate = D1 ('MetaData "GroupCreate" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupCreate" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupCreateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: (S1 ('MetaSel ('Just "groupCreateDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "groupCreateUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe [UserID])))))

data GroupPatch Source #

Represents a PATCH request for updating a group's name and/or description

Constructors

GroupPatch
Fields patchName :: Maybe Text patchDescription :: Maybe (Maybe Text)

Instances

Instances details

FromJSON GroupPatch Source #

Instance details

Defined in UserManagement.Group

Methods

parseJSON :: Value -> Parser GroupPatch

parseJSONList :: Value -> Parser [GroupPatch]

omittedField :: Maybe GroupPatch

Generic GroupPatch Source #

Instance details

Defined in UserManagement.Group

Associated Types

type Rep GroupPatch

Instance details

Defined in UserManagement.Group

type Rep GroupPatch = D1 ('MetaData "GroupPatch" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupPatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "patchDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text)))))

Methods

from :: GroupPatch -> Rep GroupPatch x #

to :: Rep GroupPatch x -> GroupPatch #

Eq GroupPatch Source #

Instance details

Defined in UserManagement.Group

Methods

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

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

ToSchema GroupPatch Source #

Instance details

Defined in UserManagement.Group

Methods

declareNamedSchema :: Proxy GroupPatch -> Declare (Definitions Schema) NamedSchema

type Rep GroupPatch Source #

Instance details

Defined in UserManagement.Group

type Rep GroupPatch = D1 ('MetaData "GroupPatch" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupPatch" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "patchDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Maybe Text)))))

type GroupID = Int64 Source #

data GroupOverview Source #

List of GroupIds and GroupName pairs

Constructors

GroupOverview
Fields groupOverviewID :: GroupID groupOverviewName :: Text groupOverviewDescription :: Maybe Text

Instances

Instances details

ToJSON GroupOverview Source #

Instance details

Defined in UserManagement.Group

Methods

toJSON :: GroupOverview -> Value

toEncoding :: GroupOverview -> Encoding

toJSONList :: [GroupOverview] -> Value

toEncodingList :: [GroupOverview] -> Encoding

omitField :: GroupOverview -> Bool

Generic GroupOverview Source #

Instance details

Defined in UserManagement.Group

Associated Types

type Rep GroupOverview

Instance details

Defined in UserManagement.Group

type Rep GroupOverview = D1 ('MetaData "GroupOverview" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupOverview" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupOverviewID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GroupID) :*: (S1 ('MetaSel ('Just "groupOverviewName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupOverviewDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))

Methods

from :: GroupOverview -> Rep GroupOverview x #

to :: Rep GroupOverview x -> GroupOverview #

ToSchema GroupOverview Source #

Instance details

Defined in UserManagement.Group

Methods

declareNamedSchema :: Proxy GroupOverview -> Declare (Definitions Schema) NamedSchema

type Rep GroupOverview Source #

Instance details

Defined in UserManagement.Group

type Rep GroupOverview = D1 ('MetaData "GroupOverview" "UserManagement.Group" "backend-0.1.0.0-2H73EnUlGVcEtlIi2XNQz3" 'False) (C1 ('MetaCons "GroupOverview" 'PrefixI 'True) (S1 ('MetaSel ('Just "groupOverviewID") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GroupID) :*: (S1 ('MetaSel ('Just "groupOverviewName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "groupOverviewDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))))