Module

FPO.Dto.GroupDto

All DTOs and data representations related to groups.

#GroupID​

type GroupID = Int

#GroupOverview​

newtype GroupOverview

Represents a group overview entity, as returned by the GET /groups endpoint.

Constructors

Instances

#getGroupOverviewID​

getGroupOverviewID :: GroupOverview -> Int

#getGroupOverviewName​

getGroupOverviewName :: GroupOverview -> String

#GroupCreate​

newtype GroupCreate

A group creation request DTO, as sent to the POST /groups endpoint. The groupCreateUsers field is an optional array of user UUIDs to add as members when the group is created.

Constructors

Instances

#GroupDto​

newtype GroupDto

Represents a group entity, as returned by the GET /groups/{groupID} endpoint.

Constructors

Instances

#getGroupName​

getGroupName :: GroupDto -> String

#getGroupDescription​

getGroupDescription :: GroupDto -> String

#isUserInGroup​

isUserInGroup :: GroupDto -> UserID -> Boolean

#GroupMemberDto​

newtype GroupMemberDto

Represents a group member entity, as returned by the GET /groups/{groupID} endpoint.

Constructors

Instances

#getUserInfoName​

getUserInfoName :: GroupMemberDto -> String

#getUserInfoRole​

getUserInfoRole :: GroupMemberDto -> Role

#getUserInfoID​

getUserInfoID :: GroupMemberDto -> UserID

#GroupPatch​

newtype GroupPatch

A group patch request DTO, as sent to the PATCH /groups/{groupID} endpoint. Both fields are optional, but at least one must be provided. patchDescription is a Maybe (Maybe String) to allow:

  • Nothing: don't change description
  • Just Nothing: set description to null
  • Just (Just "...") : set description to new value

Constructors

Instances

Modules