Safe Haskell	None
Language	Haskell2010

Hercules.API.Accounts.Account

Documentation

data AccountType Source #

Constructors

User
Organization

Instances

Instances details

Eq AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods (==) :: AccountType -> AccountType -> Bool # (/=) :: AccountType -> AccountType -> Bool #
Show AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods showsPrec :: Int -> AccountType -> ShowS # show :: AccountType -> String # showList :: [AccountType] -> ShowS #
Generic AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Associated Types type Rep AccountType :: Type -> Type # Methods from :: AccountType -> Rep AccountType x # to :: Rep AccountType x -> AccountType #
ToJSON AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods toJSON :: AccountType -> Value # toEncoding :: AccountType -> Encoding # toJSONList :: [AccountType] -> Value # toEncodingList :: [AccountType] -> Encoding #
FromJSON AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods parseJSON :: Value -> Parser AccountType # parseJSONList :: Value -> Parser [AccountType] #
NFData AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods rnf :: AccountType -> () #
ToSchema AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account Methods declareNamedSchema :: Proxy AccountType -> Declare (Definitions Schema) NamedSchema #
type Rep AccountType Source #
Instance details Defined in Hercules.API.Accounts.Account type Rep AccountType = D1 ('MetaData "AccountType" "Hercules.API.Accounts.Account" "hercules-ci-api-0.6.0.0-9W1q58tM1hxFhTp0arxiaH" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Organization" 'PrefixI 'False) (U1 :: Type -> Type))

data MembershipRole Source #

Constructors

Member
Admin

Instances

Instances details

Eq MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods (==) :: MembershipRole -> MembershipRole -> Bool # (/=) :: MembershipRole -> MembershipRole -> Bool #
Show MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods showsPrec :: Int -> MembershipRole -> ShowS # show :: MembershipRole -> String # showList :: [MembershipRole] -> ShowS #
Generic MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Associated Types type Rep MembershipRole :: Type -> Type # Methods from :: MembershipRole -> Rep MembershipRole x # to :: Rep MembershipRole x -> MembershipRole #
ToJSON MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods toJSON :: MembershipRole -> Value # toEncoding :: MembershipRole -> Encoding # toJSONList :: [MembershipRole] -> Value # toEncodingList :: [MembershipRole] -> Encoding #
FromJSON MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods parseJSON :: Value -> Parser MembershipRole # parseJSONList :: Value -> Parser [MembershipRole] #
NFData MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods rnf :: MembershipRole -> () #
ToSchema MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account Methods declareNamedSchema :: Proxy MembershipRole -> Declare (Definitions Schema) NamedSchema #
type Rep MembershipRole Source #
Instance details Defined in Hercules.API.Accounts.Account type Rep MembershipRole = D1 ('MetaData "MembershipRole" "Hercules.API.Accounts.Account" "hercules-ci-api-0.6.0.0-9W1q58tM1hxFhTp0arxiaH" 'False) (C1 ('MetaCons "Member" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Admin" 'PrefixI 'False) (U1 :: Type -> Type))

data Account Source #

Constructors

Account

Fields

id :: Id Account
sourceHostingSiteSlug :: Text
slug :: Text
typ :: AccountType
displayName :: Text
imageURL :: Text
organization :: Maybe Organization
isInstalled :: Bool
Whether Hercules CI is installed on this account as an App.
An account that does not have an installation can not be properly accessed by Hercules, but may be visible nonetheless at times because of OAuth scopes.
As an example, non-installed accounts show up when a GitHub user signs in for the first time via OAuth, until they decide to install it on their GitHub user. Another example is GitHub organizations that don't have an installation yet.
isInstallable :: Bool
Whether the current user has permission in the to installing Hercules CI on this account.
membershipRole :: Maybe MembershipRole
sourceHostingSites :: Maybe (Map Text SourceHostingSite)

Instances

Instances details

Eq Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Show Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
Generic Account Source #
Instance details Defined in Hercules.API.Accounts.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
ToJSON Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods toJSON :: Account -> Value # toEncoding :: Account -> Encoding # toJSONList :: [Account] -> Value # toEncodingList :: [Account] -> Encoding #
FromJSON Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
NFData Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods rnf :: Account -> () #
ToSchema Account Source #
Instance details Defined in Hercules.API.Accounts.Account Methods declareNamedSchema :: Proxy Account -> Declare (Definitions Schema) NamedSchema #
type Rep Account Source #
Instance details Defined in Hercules.API.Accounts.Account type Rep Account = D1 ('MetaData "Account" "Hercules.API.Accounts.Account" "hercules-ci-api-0.6.0.0-9W1q58tM1hxFhTp0arxiaH" 'False) (C1 ('MetaCons "Account" 'PrefixI 'True) (((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Id Account)) :: S1 ('MetaSel ('Just "sourceHostingSiteSlug") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "slug") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "typ") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AccountType) :: S1 ('MetaSel ('Just "displayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "imageURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "organization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Organization)) :: S1 ('MetaSel ('Just "isInstalled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :: (S1 ('MetaSel ('Just "isInstallable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :: (S1 ('MetaSel ('Just "membershipRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MembershipRole)) :: S1 ('MetaSel ('Just "sourceHostingSites") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe (Map Text SourceHostingSite))))))))