Copyright | (c) OnRock Engineering 2018 |
---|---|
License | MIT |
Maintainer | Kyle Van Berendonck <[email protected]> |
Safe Haskell | Trustworthy |
Language | Haskell2010 |
GitHub.Data.Webhooks.Payload
Contents
Description
This module contains types that represent GitHub webhook's payload contents.
- newtype URL = URL Text
- getUrl :: URL -> Text
- data OwnerType
- data HookIssue = HookIssue {
- whIssueUrl :: !URL
- whIssueLabelsUrl :: !URL
- whIssueCommentsUrl :: !URL
- whIssueEventsUrl :: !URL
- whIssueHtmlUrl :: !URL
- whIssueId :: !Int
- whIssueNumber :: !Int
- whIssueTitle :: !Text
- whIssueUser :: !HookUser
- whIssueLabels :: !(Vector HookIssueLabels)
- whIssueState :: IssueState
- whIssueIsLocked :: !Bool
- whIssueAssignee :: !(Maybe HookUser)
- whIssueMilestone :: !(Maybe HookMilestone)
- whIssueCommentCount :: !Int
- whIssueCreatedAt :: !UTCTime
- whIssueUpdatedAt :: !UTCTime
- whIssueClosedAt :: !(Maybe UTCTime)
- whIssueBody :: !Text
- data HookRepository = HookRepository {
- whRepoId :: !Int
- whRepoName :: !Text
- whRepoFullName :: !Text
- whRepoOwner :: !(Either HookSimpleUser HookUser)
- whRepoIsPrivate :: !Bool
- whRepoHtmlUrl :: !URL
- whRepoDescription :: !Text
- whRepoIsAFork :: !Bool
- whRepoUrl :: !URL
- whRepoForksUrl :: !URL
- whRepoKeysUrl :: !URL
- whRepoCollaboratorsUrl :: !URL
- whRepoTeamsUrl :: !URL
- whRepoHooksUrl :: !URL
- whRepoIssueEventsUrl :: !URL
- whRepoEventsUrl :: !URL
- whRepoAssigneesUrl :: !URL
- whRepoBranchesUrl :: !URL
- whRepoTagsUrl :: !URL
- whRepoBlobsUrl :: !URL
- whRepoGitTagsUrl :: !URL
- whRepoGitRefsUrl :: !URL
- whRepoTreesUrl :: !URL
- whRepoStatusesUrl :: !URL
- whRepoLanguagesUrl :: !URL
- whRepoStargazersUrl :: !URL
- whRepoContributorsUrl :: !URL
- whRepoSubscribersUrl :: !URL
- whRepoSubscriptionUrl :: !URL
- whRepoCommitsUrl :: !URL
- whRepoGitCommitsUrl :: !URL
- whRepoCommentsUrl :: !URL
- whRepoIssueCommentsUrl :: !URL
- whRepoContentsUrl :: !URL
- whRepoCompareUrl :: !URL
- whRepoMergesUrl :: !URL
- whRepoArchiveUrl :: !URL
- whRepoDownloadsUrl :: !URL
- whRepoIssuesUrl :: !URL
- whRepoPullsUrl :: !URL
- whRepoMilestonesUrl :: !URL
- whRepoNotificationsUrl :: !URL
- whRepoLabelsUrl :: !URL
- whRepoReleasesUrl :: !URL
- whRepoCreatedAt :: !UTCTime
- whRepoUpdatedAt :: !UTCTime
- whRepoPushedAt :: !UTCTime
- whRepoGitUrl :: !URL
- whRepoSshUrl :: !URL
- whRepoCloneUrl :: !URL
- whRepoSvnUrl :: !URL
- whRepoHomepage :: !(Maybe URL)
- whRepoSize :: !Int
- whRepoStargazersCount :: !Int
- whRepoWatchersCount :: !Int
- whRepoLanguage :: !(Maybe Text)
- whRepoHasIssues :: !Bool
- whRepoHasDownloads :: !Bool
- whRepoHasWiki :: !Bool
- whRepoHasPages :: !Bool
- whRepoForkCount :: !Int
- whRepoMirrorUrl :: !(Maybe URL)
- whRepoOpenIssuesCount :: !Int
- whRepoDefaultBranchName :: !Text
- data HookRepositorySimple = HookRepositorySimple {
- whSimplRepoId :: !Int
- whSimplRepoName :: !Text
- whSimplRepoFullName :: !Text
- data HookRepositoryLabel = HookRepositoryLabel {
- whRepoLabelUrl :: !URL
- whRepoLabelName :: !Text
- whRepoLabelColor :: !Text
- data HookUser = HookUser {
- whUserLogin :: !Text
- whUserId :: !Int
- whUserAvatarUrl :: !URL
- whUserGravatarId :: !URL
- whUserUrl :: !URL
- whUserHtmlUrl :: !URL
- whUserFollowersUrl :: !URL
- whUserFollowingUrl :: !URL
- whUserGistsUrl :: !URL
- whUserStarredUrl :: !URL
- whUserSubscriptionsUrl :: !URL
- whUserOrganizationsUrl :: !URL
- whUserReposUrl :: !URL
- whUserEventsUrl :: !URL
- whUserReceivedEventsUrl :: !URL
- whUserType :: !OwnerType
- whUserIsAdminOfSite :: !Bool
- data HookSimpleUser = HookSimpleUser {
- whSimplUserName :: !Text
- whSimplUserEmail :: !Text
- whSimplUserLogin :: !(Maybe Text)
- data HookOrganization = HookOrganization {
- whOrgLogin :: !Text
- whOrgId :: !Int
- whOrgUrl :: !URL
- whOrgReposUrl :: !URL
- whOrgEventsUrl :: !URL
- whOrgHooksUrl :: !(Maybe URL)
- whOrgIssuesUrl :: !(Maybe URL)
- whOrgMembersUrl :: !URL
- whOrgPublicMembersUrl :: !URL
- whOrgAvatarUrl :: !URL
- whOrgDescription :: !Text
- data HookOrganizationInvitation = HookOrganizationInvitation {}
- data HookOrganizationMembership = HookOrganizationMembership {}
- data HookTeam = HookTeam {
- whTeamName :: !Text
- whTeamId :: !Int
- whTeamSlug :: !Text
- whTeamPermission :: !Text
- whTeamUrl :: !URL
- whTeamMembersUrl :: !URL
- whTeamRepositoriesUrl :: !URL
- data HookMilestone = HookMilestone {
- whMilestoneUrl :: !URL
- whMilestoneHtmlUrl :: !URL
- whMilestoneLabelsUrl :: !URL
- whMilestoneId :: !Int
- whMilestoneNumber :: !Int
- whMilestoneTitle :: !Text
- whMilestoneDescription :: !(Maybe Text)
- whMilestoneCreator :: !HookUser
- whMilestoneOpenIssues :: !Int
- whMilestoneClosedIssues :: !Int
- whMilestoneState :: !MilestoneState
- whMilestoneCreatedAt :: !UTCTime
- whMilestoneUpdatedAt :: !UTCTime
- whMilestoneDueOn :: !(Maybe UTCTime)
- whMilestoneClosedAt :: !(Maybe UTCTime)
- data HookMembership = HookMembership {
- whMembershipUrl :: !URL
- whMembershipState :: !MembershipState
- whMembershipRole :: !MembershipRole
- whMembershipOrgUrl :: !URL
- whMembershipUser :: !HookUser
- data HookProject = HookProject {
- whProjectOwnerUrl :: !URL
- whProjectUrl :: !URL
- whProjectColumnsUrl :: !URL
- whProjectId :: !Int
- whProjectName :: !Text
- whProjectBody :: !Text
- whProjectNumber :: !Int
- whProjectState :: !ProjectState
- whProjectCreator :: !HookUser
- whProjectCreatedAt :: !UTCTime
- whProjectUpdatedAt :: !UTCTime
- data HookProjectCard = HookProjectCard {}
- data HookProjectColumn = HookProjectColumn {}
- data HookIssueLabels = HookIssueLabels {
- whIssueLabelId :: !(Maybe Int)
- whIssueLabelUrl :: !URL
- whIssueLabelName :: !Text
- whIssueLabelColor :: !Text
- whIssueLabelIsDefault :: !Bool
- data HookCommit = HookCommit {
- whCommitSha :: !Text
- whCommitUrl :: !URL
- whCommitHtmlUrl :: !(Maybe URL)
- whCommitCommentsUrl :: !(Maybe URL)
- whCommitAuthor :: !(Either HookSimpleUser HookUser)
- whCommitCommitter :: !(Either HookSimpleUser HookUser)
- data HookRelease = HookRelease {
- whReleaseUrl :: !URL
- whReleaseAssetsUrl :: !URL
- whReleaseUploadUrl :: !URL
- whReleaseHtmlUrl :: !URL
- whReleaseId :: !Int
- whReleaseTagName :: !Text
- whReleaseTargetCommitish :: !Text
- whReleaseName :: !(Maybe Text)
- whReleaseIsDraft :: !Bool
- whReleaseAuthor :: !HookUser
- whReleaseIsPreRelease :: !Bool
- whReleaseCreatedAt :: !UTCTime
- whReleasePublishedAt :: !(Maybe UTCTime)
- whReleaseTarballUrl :: !URL
- whReleaseZipballUrl :: !URL
- whReleaseBody :: !(Maybe Text)
- data HookPullRequest = HookPullRequest {
- whPullReqUrl :: !URL
- whPullReqId :: !Int
- whPullReqHtmlUrl :: !URL
- whPullReqDiffUrl :: !URL
- whPullReqPatchUrl :: !URL
- whPullReqIssueUrl :: !URL
- whPullReqNumber :: !Int
- whPullReqState :: !Text
- whPullReqIsLocked :: !Bool
- whPullReqTitle :: !Text
- whPullReqUser :: !HookUser
- whPullReqBody :: !Text
- whPullReqCreatedAt :: !UTCTime
- whPullReqUpdatedAt :: !UTCTime
- whPullReqClosedAt :: !(Maybe UTCTime)
- whPullReqMergedAt :: !(Maybe UTCTime)
- whPullReqMergeCommitSha :: !(Maybe Text)
- whPullReqAssignee :: !(Maybe HookUser)
- whPullReqMilestone :: !(Maybe HookMilestone)
- whPullReqCommitsUrl :: !URL
- whPullReqRevCommentsUrl :: !URL
- whPullReqRevCommentUrl :: !URL
- whPullReqCommentsUrl :: !URL
- whPullReqStatusesUrl :: !URL
- whPullReqBase :: !PullRequestTarget
- whPullReqHead :: !PullRequestTarget
- whPullReqCommentCount :: !(Maybe Int)
- whPullReqRevCommentCount :: !(Maybe Int)
- whPullReqCommitCount :: !(Maybe Int)
- whPullReqAdditionsCount :: !(Maybe Int)
- whPullReqDeletionsCount :: !(Maybe Int)
- whPullReqFileChangeCount :: !(Maybe Int)
- data PullRequestTarget = PullRequestTarget {}
- data HookPullRequestReview = HookPullRequestReview {}
- data HookInstallation = HookInstallation {}
- data HookDeployment = HookDeployment {
- whDeploymentUrl :: !URL
- whDeploymentId :: !Int
- whDeploymentSha :: !Text
- whDeploymentRef :: !Text
- whDeploymentTask :: !Text
- whDeploymentEnv :: !Text
- whDeploymentDescription :: !(Maybe Text)
- whDeploymentCreator :: !HookUser
- whDeploymentCreatedAt :: !UTCTime
- whDeploymentUpdatedAt :: !UTCTime
- whDeploymentStatusesUrl :: !URL
- whDeploymentRepoUrl :: !URL
- data HookDeploymentStatus = HookDeploymentStatus {
- whDeploymentStatusUrl :: !URL
- whDeploymentStatusId :: !Int
- whDeploymentStatusState :: !Text
- whDeploymentStatusCreator :: !HookUser
- whDeploymentStatusDesc :: !(Maybe Text)
- whDeploymentStatusTargetUrl :: !(Maybe URL)
- whDeploymentStatusCreatedAt :: !UTCTime
- whDeploymentStatusUpdatedAt :: !UTCTime
- whDeploymentStatusDeplUrl :: !URL
- whDeploymentStatusRepoUrl :: !URL
- data HookWikiPage = HookWikiPage {
- whWikiPageName :: !Text
- whWikiPageTitle :: !Text
- whWikiPageSummary :: !(Maybe Text)
- wkWikiPageAction :: !Text
- whWikiPageSha :: !Text
- whWikiPageHtmlUrl :: URL
- data HookPageBuildResult = HookPageBuildResult {}
- data HookIssueComment = HookIssueComment {}
- data HookCommitComment = HookCommitComment {
- whCommitCommentUrl :: !URL
- whCommitCommentHtmlUrl :: !URL
- whCommitCommentId :: !Int
- whCommitCommentUser :: !HookUser
- whCommitCommentPos :: !(Maybe Int)
- whCommitCommentLine :: !(Maybe Int)
- whCommitCommentPath :: !(Maybe Text)
- whCommitCommentCommitSha :: !Text
- whCommitCommentCreatedAt :: !UTCTime
- whCommitCommentUpdatedAt :: !UTCTime
- whCommitCommentBody :: !Text
- data HookPullRequestReviewComment = HookPullRequestReviewComment {
- whPullReqRevComUrl :: !URL
- whPullReqRevComId :: !Int
- whPullReqRevComDiffHunk :: !Text
- whPullReqRevComPath :: !Text
- whPullReqRevComPos :: !Int
- whPullReqRevComOrigPos :: !Int
- whPullReqRevComCommitSha :: !Text
- whPullReqRevComOrigSha :: !Text
- whPullReqRevComUser :: !HookUser
- whPullReqRevComBody :: !Text
- whPullReqRevComCreatedAt :: !UTCTime
- whPullReqRevComUpdatedAt :: !UTCTime
- whPullReqRevComHtmlUrl :: !URL
- whPullReqRevComPullReqUrl :: !URL
Construction Types
Represents an internet address that would be suitable to query
for more information. The GitHub API only returns valid URL
s.
Represents the owner of the repository.
Constructors
OwnerUser | |
OwnerOrganization |
Webhook Types
Represents the "issue" field in the IssueCommentEvent
and IssueEvent
payload.
Constructors
HookIssue | |
Fields
|
data HookRepository Source #
Represents the "repository" field in all types of payload.
Constructors
data HookRepositorySimple Source #
Represents the "repositories_added" and "repositories_removed"
field in the InstallationRepositoriesEvent
payload.
Constructors
HookRepositorySimple | |
Fields
|
data HookRepositoryLabel Source #
Represents the "label" field in the LabelEvent
payload.
Constructors
HookRepositoryLabel | |
Fields
|
Represents the "user" field in all types of payload.
Constructors
HookUser | |
Fields
|
data HookSimpleUser Source #
Constructors
HookSimpleUser | |
Fields
|
data HookOrganization Source #
Represents the "organization" field in all types of payload.
Constructors
HookOrganization | |
Fields
|
data HookOrganizationInvitation Source #
Represents the "invitation" field in the OrganizationEvent
payload.
Constructors
HookOrganizationInvitation | |
Fields
|
Instances
data HookOrganizationMembership Source #
Represents the "membership" field in the OrganizationEvent
payload.
Constructors
HookOrganizationMembership | |
Fields |
Instances
Represents the "team" field in the TeamEvent
and
TeamAddEvent
payload.
Constructors
HookTeam | |
Fields
|
data HookMilestone Source #
Represents the "milestone" field in the MilestoneEvent
payload.
Constructors
HookMilestone | |
Fields
|
data HookMembership Source #
Constructors
HookMembership | |
Fields
|
data HookProject Source #
Represents the "project" field in the ProjectEvent
payload.
Constructors
HookProject | |
Fields
|
Instances
data HookProjectCard Source #
Represents the "project_card" field in the ProjectCardEvent
payload.
Constructors
HookProjectCard | |
Fields
|
data HookProjectColumn Source #
Represents the "project_column" field in the ProjectColumnEvent
payload.
Constructors
HookProjectColumn | |
Fields |
data HookIssueLabels Source #
Represents the "issue.labels" field in the
IssueCommentEvent
and IssueEvent
payloads.
Constructors
HookIssueLabels | |
Fields
|
data HookCommit Source #
Constructors
HookCommit | |
Fields
|
Instances
data HookRelease Source #
Constructors
HookRelease | |
Fields
|
Instances
data HookPullRequest Source #
Constructors
data PullRequestTarget Source #
Constructors
PullRequestTarget | |
Fields |
data HookPullRequestReview Source #
Represents the "pull_request" field in the PullRequestReviewEvent
payload.
Constructors
HookPullRequestReview | |
Fields |
data HookInstallation Source #
Represents the "installation" field in the InstallationEvent
payload.
Constructors
HookInstallation | |
Fields |
data HookDeployment Source #
Represents the "deployment" field in the
DeploymentEvent
and DeploymentStatusEvent
payload.
Constructors
HookDeployment | |
Fields
|
data HookDeploymentStatus Source #
Represents the "deployment_status" field in the
DeploymentStatusEvent
payload.
Constructors
data HookWikiPage Source #
Represents the "pages" field in the GollumEvent
payload.
Constructors
HookWikiPage | |
Fields
|
Instances
data HookPageBuildResult Source #
Represents the "build" field in the PageBuildEvent
payload.
Constructors
HookPageBuildResult | |
Fields
|
data HookIssueComment Source #
Represents the "issue" field in IssueComentEvent
payload.
Constructors
HookIssueComment | |
Fields |
data HookCommitComment Source #
Represents the "comment" field in the CommitCommentEvent
payload.
Constructors
HookCommitComment | |
Fields
|
data HookPullRequestReviewComment Source #
Represents the "pull_request" field in the
PullRequestReviewCommentEvent
payload.
Constructors
Instances