github-types-0.1.0.1: Type definitions for objects used by the GitHub v3 API

Safe HaskellNone
LanguageHaskell2010

GitHub.Types.Events

Synopsis

Documentation

data Event Source

All events which can be produced by GitHub.

See https://developer.github.com/v3/activity/events/types/

Constructors

CommitCommentEventType CommitCommentEvent 
DeploymentEventType DeploymentEvent 
DeploymentStatusEventType DeploymentStatusEvent 

Instances

eventParser :: Text -> Value -> Parser Event Source

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 Event an instance of FromJSON. But if you know the type, you can use this parser.

data CommitCommentEvent Source

Constructors

CommitCommentEvent 

Fields

commitCommentEventRepository :: Repository
 

Instances

data DeploymentEvent Source

Constructors

DeploymentEvent 

Fields

deploymentEventId :: Int

The deployment Id (UNDOCUMENTED).

deploymentEventSha :: Text
 
deploymentEventName :: Text

Name of repository for this deployment, formatted as :owner/:repo.

deploymentEventPayload :: Value

The optional extra information for this deployment.

deploymentEventEnvironment :: Text

The optional environment to deploy to. Default: "production"

deploymentEventDescription :: Maybe Text

The optional human-readable description added to the deployment.

deploymentEventRepository :: Repository

The repository for which the deployment was created (UNDOCUMENTED).

Instances

data DeploymentStatusEvent Source

Constructors

DeploymentStatusEvent 

Fields

deploymentStatusEventState :: State

The new state.

deploymentStatusEventTargetUrl :: Maybe Text

The optional link added to the status.

deploymentStatusEventDeployment :: Deployment

The deployment that this status is associated with.

deploymentStatusEventDescription :: Maybe Text

The optional human-readable description added to the status.

Instances