Hercules.API.Accounts.Account

Documentation

data AccountType

Constructors

User

Organization

Instances

FromJSON AccountType

Defined in Hercules.API.Accounts.Account

Methods

parseJSON :: Value -> Parser AccountType

parseJSONList :: Value -> Parser [AccountType]

ToJSON AccountType

Defined in Hercules.API.Accounts.Account

Methods

toJSON :: AccountType -> Value

toEncoding :: AccountType -> Encoding

toJSONList :: [AccountType] -> Value

toEncodingList :: [AccountType] -> Encoding

Generic AccountType

Defined in Hercules.API.Accounts.Account

Associated Types

type Rep AccountType :: Type -> Type

Methods

from :: AccountType -> Rep AccountType x

to :: Rep AccountType x -> AccountType

Show AccountType

Defined in Hercules.API.Accounts.Account

Methods

showsPrec :: Int -> AccountType -> ShowS

show :: AccountType -> String

showList :: [AccountType] -> ShowS

NFData AccountType

Defined in Hercules.API.Accounts.Account

Methods

rnf :: AccountType -> ()

Eq AccountType

Defined in Hercules.API.Accounts.Account

Methods

(==) :: AccountType -> AccountType -> Bool

(/=) :: AccountType -> AccountType -> Bool

ToSchema AccountType

Defined in Hercules.API.Accounts.Account

Methods

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

ToSchema AccountType

Defined in Hercules.API.Accounts.Account

Methods

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

type Rep AccountType

Defined in Hercules.API.Accounts.Account

type Rep AccountType = D1 ('MetaData "AccountType" "Hercules.API.Accounts.Account" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "User" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Organization" 'PrefixI 'False) (U1 :: Type -> Type))

data MembershipRole

Constructors

Member

Admin

Instances

FromJSON MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

parseJSON :: Value -> Parser MembershipRole

parseJSONList :: Value -> Parser [MembershipRole]

ToJSON MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

toJSON :: MembershipRole -> Value

toEncoding :: MembershipRole -> Encoding

toJSONList :: [MembershipRole] -> Value

toEncodingList :: [MembershipRole] -> Encoding

Generic MembershipRole

Defined in Hercules.API.Accounts.Account

Associated Types

type Rep MembershipRole :: Type -> Type

Methods

from :: MembershipRole -> Rep MembershipRole x

to :: Rep MembershipRole x -> MembershipRole

Show MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

showsPrec :: Int -> MembershipRole -> ShowS

show :: MembershipRole -> String

showList :: [MembershipRole] -> ShowS

NFData MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

rnf :: MembershipRole -> ()

Eq MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

(==) :: MembershipRole -> MembershipRole -> Bool

(/=) :: MembershipRole -> MembershipRole -> Bool

ToSchema MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

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

ToSchema MembershipRole

Defined in Hercules.API.Accounts.Account

Methods

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

type Rep MembershipRole

Defined in Hercules.API.Accounts.Account

type Rep MembershipRole = D1 ('MetaData "MembershipRole" "Hercules.API.Accounts.Account" "hercules-ci-api-0.8.4.0-inplace" 'False) (C1 ('MetaCons "Member" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Admin" 'PrefixI 'False) (U1 :: Type -> Type))

data Account

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 Forge)
• manageInstallationURL :: Maybe Text
• installationIsSelection :: Maybe Bool

Instances

FromJSON Account

Defined in Hercules.API.Accounts.Account

Methods

parseJSON :: Value -> Parser Account

parseJSONList :: Value -> Parser [Account]

ToJSON Account

Defined in Hercules.API.Accounts.Account

Methods

toJSON :: Account -> Value

toEncoding :: Account -> Encoding

toJSONList :: [Account] -> Value

toEncodingList :: [Account] -> Encoding

Generic Account

Defined in Hercules.API.Accounts.Account

Associated Types

type Rep Account :: Type -> Type

Methods

from :: Account -> Rep Account x

to :: Rep Account x -> Account

Show Account

Defined in Hercules.API.Accounts.Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

NFData Account

Defined in Hercules.API.Accounts.Account

Methods

rnf :: Account -> ()

Eq Account

Defined in Hercules.API.Accounts.Account

Methods

(==) :: Account -> Account -> Bool

(/=) :: Account -> Account -> Bool

ToSchema Account

Defined in Hercules.API.Accounts.Account

Methods

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

ToSchema Account

Defined in Hercules.API.Accounts.Account

Methods

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

type Rep Account

Defined in Hercules.API.Accounts.Account

type Rep Account = D1 ('MetaData "Account" "Hercules.API.Accounts.Account" "hercules-ci-api-0.8.4.0-inplace" '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 Forge)))) :*: (S1 ('MetaSel ('Just "manageInstallationURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "installationIsSelection") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))