-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Type definitions for objects used by the GitHub v3 API
--   
--   This package includes (some) type definitions for objects which are
--   consumed or produced by the GitHub v3 API.
@package github-types
@version 0.1.0.2

module GitHub.Types.Base
data Owner
Owner :: Int -> Text -> Text -> Text -> Owner
ownerId :: Owner -> Int
ownerLogin :: Owner -> Text
ownerName :: Owner -> Text
ownerType :: Owner -> Text
data Repository
Repository :: Int -> Text -> Text -> Owner -> Repository
repositoryId :: Repository -> Int
repositoryName :: Repository -> Text
repositoryFullName :: Repository -> Text
repositoryOwner :: Repository -> Owner
data State
Pending :: State
Success :: State
Failure :: State
Error :: State
instance Eq Owner
instance Show Owner
instance Eq Repository
instance Show Repository
instance Eq State
instance Show State
instance ToJSON State
instance FromJSON State
instance FromJSON Repository
instance FromJSON Owner

module GitHub.Types.Repository
data CreateDeploymentStatusRequest
CreateDeploymentStatusRequest :: State -> Maybe Text -> Maybe Text -> CreateDeploymentStatusRequest
cdsState :: CreateDeploymentStatusRequest -> State
cdsTargetUrl :: CreateDeploymentStatusRequest -> Maybe Text
cdsDescription :: CreateDeploymentStatusRequest -> Maybe Text
data Deployment
Deployment :: Int -> Text -> Text -> Text -> Text -> Value -> Deployment
deploymentId :: Deployment -> Int
deploymentSha :: Deployment -> Text
deploymentRef :: Deployment -> Text
deploymentEnvironment :: Deployment -> Text
deploymentDescription :: Deployment -> Text
deploymentPayload :: Deployment -> Value
instance Eq CreateDeploymentStatusRequest
instance Show CreateDeploymentStatusRequest
instance Eq Deployment
instance Show Deployment
instance FromJSON Deployment
instance ToJSON CreateDeploymentStatusRequest

module GitHub.Types.Events

-- | All events which can be produced by GitHub.
--   
--   See
--   https:<i></i>developer.github.com<i>v3</i>activity<i>events</i>types/
data Event
CommitCommentEventType :: CommitCommentEvent -> Event
DeploymentEventType :: DeploymentEvent -> Event
DeploymentStatusEventType :: DeploymentStatusEvent -> Event

-- | Since the event type is included through different means
--   (X-GitHub-Event header, or inline in the JSON object), it's not
--   possible to make <a>Event</a> an instance of <a>FromJSON</a>. But if
--   you know the type, you can use this parser.
eventParser :: Text -> Value -> Parser Event
data CommitCommentEvent
CommitCommentEvent :: Repository -> CommitCommentEvent
commitCommentEventRepository :: CommitCommentEvent -> Repository
data DeploymentEvent
DeploymentEvent :: Int -> Text -> Text -> Value -> Text -> Maybe Text -> Repository -> DeploymentEvent

-- | The deployment Id (UNDOCUMENTED).
deploymentEventId :: DeploymentEvent -> Int
deploymentEventSha :: DeploymentEvent -> Text

-- | Name of repository for this deployment, formatted as :owner/:repo.
deploymentEventName :: DeploymentEvent -> Text

-- | The optional extra information for this deployment.
deploymentEventPayload :: DeploymentEvent -> Value

-- | The optional environment to deploy to. Default: <a>production</a>
deploymentEventEnvironment :: DeploymentEvent -> Text

-- | The optional human-readable description added to the deployment.
deploymentEventDescription :: DeploymentEvent -> Maybe Text

-- | The repository for which the deployment was created (UNDOCUMENTED).
deploymentEventRepository :: DeploymentEvent -> Repository
data DeploymentStatusEvent
DeploymentStatusEvent :: State -> Maybe Text -> Deployment -> Maybe Text -> Repository -> DeploymentStatusEvent

-- | The new state.
deploymentStatusEventState :: DeploymentStatusEvent -> State

-- | The optional link added to the status.
deploymentStatusEventTargetUrl :: DeploymentStatusEvent -> Maybe Text

-- | The deployment that this status is associated with.
deploymentStatusEventDeployment :: DeploymentStatusEvent -> Deployment

-- | The optional human-readable description added to the status.
deploymentStatusEventDescription :: DeploymentStatusEvent -> Maybe Text

-- | The repository for which the deployment was created (UNDOCUMENTED).
deploymentStatusEventRepository :: DeploymentStatusEvent -> Repository
instance Eq CommitCommentEvent
instance Show CommitCommentEvent
instance Eq DeploymentEvent
instance Show DeploymentEvent
instance Eq DeploymentStatusEvent
instance Show DeploymentStatusEvent
instance Eq Event
instance Show Event
instance FromJSON DeploymentStatusEvent
instance FromJSON DeploymentEvent
instance FromJSON CommitCommentEvent

module GitHub.Types