| License | BSD-3-Clause |
|---|---|
| Maintainer | Oleg Grenrus <oleg.grenrus@iki.fi> |
| Safe Haskell | None |
| Language | Haskell2010 |
GitHub.Data.Definitions
Description
- data Error
- = HTTPError !HttpException
- | ParseError !Text
- | JsonError !Text
- | UserError !Text
- data OwnerType
- data SimpleUser = SimpleUser {
- simpleUserId :: !(Id User)
- simpleUserLogin :: !(Name User)
- simpleUserAvatarUrl :: !Text
- simpleUserUrl :: !Text
- simpleUserType :: !OwnerType
- data SimpleOrganization = SimpleOrganization {}
- data SimpleOwner = SimpleOwner {
- simpleOwnerId :: !(Id Owner)
- simpleOwnerLogin :: !(Name Owner)
- simpleOwnerUrl :: !Text
- simpleOwnerAvatarUrl :: !Text
- simpleOwnerType :: !OwnerType
- data User = User {
- userId :: !(Id User)
- userLogin :: !(Name User)
- userName :: !(Maybe Text)
- userType :: !OwnerType
- userCreatedAt :: !UTCTime
- userPublicGists :: !Int
- userAvatarUrl :: !Text
- userFollowers :: !Int
- userFollowing :: !Int
- userHireable :: !(Maybe Bool)
- userBlog :: !(Maybe Text)
- userBio :: !(Maybe Text)
- userPublicRepos :: !Int
- userLocation :: !(Maybe Text)
- userCompany :: !(Maybe Text)
- userEmail :: !(Maybe Text)
- userUrl :: !Text
- userHtmlUrl :: !Text
- data Organization = Organization {
- organizationId :: !(Id Organization)
- organizationLogin :: !(Name Organization)
- organizationName :: !(Maybe Text)
- organizationType :: !OwnerType
- organizationBlog :: !(Maybe Text)
- organizationLocation :: !(Maybe Text)
- organizationFollowers :: !Int
- organizationCompany :: !(Maybe Text)
- organizationAvatarUrl :: !Text
- organizationPublicGists :: !Int
- organizationHtmlUrl :: !Text
- organizationEmail :: !(Maybe Text)
- organizationFollowing :: !Int
- organizationPublicRepos :: !Int
- organizationUrl :: !Text
- organizationCreatedAt :: !UTCTime
- newtype Owner = Owner (Either User Organization)
- fromOwner :: Owner -> Either User Organization
- parseUser :: Object -> Parser User
- parseOrganization :: Object -> Parser Organization
- data OrgMemberFilter
- data OrgMemberRole
Documentation
Errors have been tagged according to their source, so you can more easily dispatch and handle them.
Constructors
| HTTPError !HttpException | A HTTP error occurred. The actual caught error is included. |
| ParseError !Text | An error in the parser itself. |
| JsonError !Text | The JSON is malformed or unexpected. |
| UserError !Text | Incorrect input. |
Type of the repository owners.
Constructors
| OwnerUser | |
| OwnerOrganization |
data SimpleUser Source
Constructors
| SimpleUser | |
Fields
| |
data SimpleOrganization Source
Constructors
| SimpleOrganization | |
Fields | |
data SimpleOwner Source
Sometimes we don't know the type of the owner, e.g. in Repo
Constructors
| SimpleOwner | |
Fields
| |
Constructors
| User | |
Fields
| |
data Organization Source
Constructors
| Organization | |
Fields
| |
In practic, you cam't have concrete values of Owner.
Constructors
| Owner (Either User Organization) |
data OrgMemberFilter Source
Filter members returned in the list.
Constructors
| OrgMemberFilter2faDisabled | Members without two-factor authentication enabled. Available for organization owners. |
| OrgMemberFilterAll | All members the authenticated user can see. |
data OrgMemberRole Source
Filter members returned by their role.
Constructors
| OrgMemberRoleAll | All members of the organization, regardless of role. |
| OrgMemberRoleAdmin | Organization owners. |
| OrgMemberRoleMember | Non-owner organization members. |