-- 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.0

module GitHub.Types.Base
data Repository
Repository :: Text -> Text -> Repository
repositoryOwnerName :: Repository -> Text
repositoryName :: Repository -> Text
data State
Pending :: State
Success :: State
Failure :: State
Error :: State
instance Eq Repository
instance Show Repository
instance Eq State
instance Show State
instance ToJSON State
instance FromJSON State
instance FromJSON Repository

module GitHub.Types.Repository
data CreateDeploymentStatusRequest
CreateDeploymentStatusRequest :: State -> Maybe Text -> Maybe Text -> CreateDeploymentStatusRequest
cdsState :: CreateDeploymentStatusRequest -> State
cdsTargetUrl :: CreateDeploymentStatusRequest -> Maybe Text
cdsDescription :: CreateDeploymentStatusRequest -> Maybe Text
instance Eq CreateDeploymentStatusRequest
instance Show CreateDeploymentStatusRequest
instance ToJSON CreateDeploymentStatusRequest

module GitHub.Types.Events
data Event
CommitCommentEventType :: CommitCommentEvent -> Event
DeploymentEventType :: DeploymentEvent -> Event
DeploymentStatusEventType :: DeploymentStatusEvent -> 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 -> Text -> Text -> Text -> DeploymentStatusEvent
deploymentStatusEventState :: DeploymentStatusEvent -> State
deploymentStatusEventTargetUrl :: DeploymentStatusEvent -> Text
deploymentStatusEventDeployment :: DeploymentStatusEvent -> Text
deploymentStatusEventDescription :: DeploymentStatusEvent -> Text
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 DeploymentEvent

module GitHub.Types