circlehs-0.0.3: The CircleCI REST API for Haskell

Copyright(c) Denis Shevchenko, 2016
LicenseMIT
Maintainerme@dshevchenko.biz
Stabilityalpha
Safe HaskellNone
LanguageHaskell2010

Network.CircleCI.Common.Types

Description

Common types for work with CircleCI API.

Synopsis

Documentation

newtype AccountAPIToken Source

CircleCI account API token. List of account API tokens can be found at https://circleci.com/account/api.

Constructors

AccountAPIToken Token 

type Token = Text Source

API token as text, for Servant.

type UserName = Text Source

GitHub user name.

type ProjectName = Text Source

GitHub project name.

type BranchName = Text Source

GitHub branch name.

newtype BuildNumber Source

Number of project's build on CircleCI.

Constructors

BuildNumber Int 

type Email = Text Source

User email address.

type CircleCIResponse a = ReaderT AccountAPIToken IO (Either ServantError a) Source

Monad for response from CircleCI.

data ProjectPoint Source

GitHub project identifier, composed from user name and project name.

Constructors

ProjectPoint 

Fields

userName :: UserName

GitHub user name.

projectName :: ProjectName

GitHub project name.

type ErrorMessage = Text Source

Message about some problem.