Hercules.API.Accounts

Documentation

data AccountsAPI auth f

Constructors

AccountsAPI

Fields

• myAccount :: f :- (Summary "The account of the authenticated user." :> ("accounts" :> ("me" :> (auth :> Get '[JSON] Account))))
• findAccounts :: f :- (Summary "Accounts that the authenticated user owns, admins or collaborates with." :> ("accounts" :> (QueryParam "site" (Name SourceHostingSite) :> (QueryParam "name" (Name Account) :> (auth :> Get '[JSON] [Account])))))
• getAccountSettings :: f :- (Summary "Retrieve the account settings" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("settings" :> (auth :> Get '[JSON] AccountSettings)))))
• patchAccountSettings :: f :- (Summary "Update the account settings" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("settings" :> (ReqBody '[JSON] AccountSettingsPatch :> (auth :> Patch '[JSON] AccountSettings))))))
• postCLIAuthorizationRequest :: f :- (Summary "Create a request to authorize the CLI." :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (ReqBody '[JSON] CLIAuthorizationRequestCreate :> Post '[JSON] CLIAuthorizationRequestCreateResponse))))))
• getCLIAuthorizationRequestStatus :: f :- (Summary "Check the request status" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> ("status" :> (Capture "temporaryToken" Text :> Get '[JSON] CLIAuthorizationRequestStatus)))))))
• getCLIAuthorizationRequest :: f :- (Summary "Retrieve the request" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (Capture "browserToken" Text :> (auth :> Get '[JSON] CLIAuthorizationRequest)))))))
• confirmCLIAuthorizationRequest :: f :- (Summary "Retrieve the request" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (Capture "browserToken" Text :> ("confirm" :> (auth :> Post '[JSON] NoContent))))))))
• postDisableAllProjects :: f :- (Summary "Disable all projects in the account." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("disable-all-projects" :> (auth :> Post '[JSON] Int)))))

Instances

Generic (AccountsAPI auth f)

Defined in Hercules.API.Accounts

Associated Types

type Rep (AccountsAPI auth f) :: Type -> Type

Methods

from :: AccountsAPI auth f -> Rep (AccountsAPI auth f) x

to :: Rep (AccountsAPI auth f) x -> AccountsAPI auth f

type Rep (AccountsAPI auth f)

Defined in Hercules.API.Accounts

type Rep (AccountsAPI auth f) = D1 ('MetaData "AccountsAPI" "Hercules.API.Accounts" "hercules-ci-api-0.6.0.1-L0iUsBHZSJOKN1YKeFqdwV" 'False) (C1 ('MetaCons "AccountsAPI" 'PrefixI 'True) (((S1 ('MetaSel ('Just "myAccount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "The account of the authenticated user." :> ("accounts" :> ("me" :> (auth :> Get '[JSON] Account)))))) :*: S1 ('MetaSel ('Just "findAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Accounts that the authenticated user owns, admins or collaborates with." :> ("accounts" :> (QueryParam "site" (Name SourceHostingSite) :> (QueryParam "name" (Name Account) :> (auth :> Get '[JSON] [Account])))))))) :*: (S1 ('MetaSel ('Just "getAccountSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Retrieve the account settings" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("settings" :> (auth :> Get '[JSON] AccountSettings))))))) :*: S1 ('MetaSel ('Just "patchAccountSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Update the account settings" :> ("accounts" :> (Capture "accountId" (Id Account) :> ("settings" :> (ReqBody '[JSON] AccountSettingsPatch :> (auth :> Patch '[JSON] AccountSettings)))))))))) :*: ((S1 ('MetaSel ('Just "postCLIAuthorizationRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Create a request to authorize the CLI." :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (ReqBody '[JSON] CLIAuthorizationRequestCreate :> Post '[JSON] CLIAuthorizationRequestCreateResponse)))))))) :*: S1 ('MetaSel ('Just "getCLIAuthorizationRequestStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Check the request status" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> ("status" :> (Capture "temporaryToken" Text :> Get '[JSON] CLIAuthorizationRequestStatus)))))))))) :*: (S1 ('MetaSel ('Just "getCLIAuthorizationRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Retrieve the request" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (Capture "browserToken" Text :> (auth :> Get '[JSON] CLIAuthorizationRequest))))))))) :*: (S1 ('MetaSel ('Just "confirmCLIAuthorizationRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Retrieve the request" :> ("auth" :> ("cli" :> ("authorization" :> ("request" :> (Capture "browserToken" Text :> ("confirm" :> (auth :> Post '[JSON] NoContent)))))))))) :*: S1 ('MetaSel ('Just "postDisableAllProjects") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (f :- (Summary "Disable all projects in the account." :> ("accounts" :> (Capture "accountId" (Id Account) :> ("disable-all-projects" :> (auth :> Post '[JSON] Int))))))))))))