// Copyright 2016 The go-github AUTHORS. All rights reserved.

//

// Use of this source code is governed by a BSD-style

// license that can be found in the LICENSE file.

// These event types are shared between the Events API and used as Webhook payloads.

package github

import "encoding/json"

// RequestedAction is included in a CheckRunEvent when a user has invoked an action,

// i.e. when the CheckRunEvent's Action field is "requested_action".

type RequestedAction struct {

Identifier string `json:"identifier"` // The integrator reference of the action requested by the user.

}

// BranchProtectionRuleEvent triggered when a check suite is "created", "edited", or "deleted".

// The Webhook event name is "branch_protection_rule".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#branch_protection_rule

type BranchProtectionRuleEvent struct {

}

// CheckRunEvent is triggered when a check run is "created", "completed", or "rerequested".

// The Webhook event name is "check_run".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_run

type CheckRunEvent struct {

}

// CheckSuiteEvent is triggered when a check suite is "completed", "requested", or "rerequested".

// The Webhook event name is "check_suite".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#check_suite

type CheckSuiteEvent struct {

}

// CommitCommentEvent is triggered when a commit comment is created.

// The Webhook event name is "commit_comment".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#commit_comment

type CommitCommentEvent struct {

}

// ContentReferenceEvent is triggered when the body or comment of an issue or

// pull request includes a URL that matches a configured content reference

// domain.

// The Webhook event name is "content_reference".

//

// GitHub API docs: https://developer.github.com/webhooks/event-payloads/#content_reference

type ContentReferenceEvent struct {

}

// CreateEvent represents a created repository, branch, or tag.

// The Webhook event name is "create".

//

// Note: webhooks will not receive this event for created repositories.

// Additionally, webhooks will not receive this event for tags if more

// than three tags are pushed at once.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/github-event-types#createevent

type CreateEvent struct {

}

// DeleteEvent represents a deleted branch or tag.

// The Webhook event name is "delete".

//

// Note: webhooks will not receive this event for tags if more than three tags

// are deleted at once.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/github-event-types#deleteevent

type DeleteEvent struct {

}

// DeployKeyEvent is triggered when a deploy key is added or removed from a repository.

// The Webhook event name is "deploy_key".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deploy_key

type DeployKeyEvent struct {

}

// DeploymentEvent represents a deployment.

// The Webhook event name is "deployment".

//

// Events of this type are not visible in timelines, they are only used to trigger hooks.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment

type DeploymentEvent struct {

}

// DeploymentStatusEvent represents a deployment status.

// The Webhook event name is "deployment_status".

//

// Events of this type are not visible in timelines, they are only used to trigger hooks.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#deployment_status

type DeploymentStatusEvent struct {

}

// ForkEvent is triggered when a user forks a repository.

// The Webhook event name is "fork".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#fork

type ForkEvent struct {

}

// GitHubAppAuthorizationEvent is triggered when a user's authorization for a

// GitHub Application is revoked.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#github_app_authorization

type GitHubAppAuthorizationEvent struct {

}

// Page represents a single Wiki page.

type Page struct {

}

// GollumEvent is triggered when a Wiki page is created or updated.

// The Webhook event name is "gollum".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#gollum

type GollumEvent struct {

}

// EditChange represents the changes when an issue, pull request, or comment has

// been edited.

type EditChange struct {

}

// EditTitle represents a pull-request title change.

type EditTitle struct {

From *string `json:"from,omitempty"`

}

// EditBody represents a change of pull-request body.

type EditBody struct {

From *string `json:"from,omitempty"`

}

// EditBase represents the change of a pull-request base branch.

type EditBase struct {

Ref *EditRef `json:"ref,omitempty"`

SHA *EditSHA `json:"sha,omitempty"`

}

// EditRef represents a ref change of a pull-request.

type EditRef struct {

From *string `json:"from,omitempty"`

}

// EditSHA represents a sha change of a pull-request.

type EditSHA struct {

From *string `json:"from,omitempty"`

}

// ProjectChange represents the changes when a project has been edited.

type ProjectChange struct {

Name *ProjectName `json:"name,omitempty"`

Body *ProjectBody `json:"body,omitempty"`

}

// ProjectName represents a project name change.

type ProjectName struct {

From *string `json:"from,omitempty"`

}

// ProjectBody represents a project body change.

type ProjectBody struct {

From *string `json:"from,omitempty"`

}

// ProjectCardChange represents the changes when a project card has been edited.

type ProjectCardChange struct {

Note *ProjectCardNote `json:"note,omitempty"`

}

// ProjectCardNote represents a change of a note of a project card.

type ProjectCardNote struct {

From *string `json:"from,omitempty"`

}

// ProjectColumnChange represents the changes when a project column has been edited.

type ProjectColumnChange struct {

Name *ProjectColumnName `json:"name,omitempty"`

}

// ProjectColumnName represents a project column name change.

type ProjectColumnName struct {

From *string `json:"from,omitempty"`

}

// TeamChange represents the changes when a team has been edited.

type TeamChange struct {

}

// TeamDescription represents a team description change.

type TeamDescription struct {

From *string `json:"from,omitempty"`

}

// TeamName represents a team name change.

type TeamName struct {

From *string `json:"from,omitempty"`

}

// TeamPrivacy represents a team privacy change.

type TeamPrivacy struct {

From *string `json:"from,omitempty"`

}

// TeamRepository represents a team repository permission change.

type TeamRepository struct {

Permissions *TeamPermissions `json:"permissions,omitempty"`

}

// TeamPermissions represents a team permission change.

type TeamPermissions struct {

From *TeamPermissionsFrom `json:"from,omitempty"`

}

// TeamPermissionsFrom represents a team permission change.

type TeamPermissionsFrom struct {

}

// InstallationEvent is triggered when a GitHub App has been installed, uninstalled, suspend, unsuspended

// or new permissions have been accepted.

// The Webhook event name is "installation".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation

type InstallationEvent struct {

}

// InstallationRepositoriesEvent is triggered when a repository is added or

// removed from an installation. The Webhook event name is "installation_repositories".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#installation_repositories

type InstallationRepositoriesEvent struct {

}

// IssueCommentEvent is triggered when an issue comment is created on an issue

// or pull request.

// The Webhook event name is "issue_comment".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issue_comment

type IssueCommentEvent struct {

}

// IssuesEvent is triggered when an issue is opened, edited, deleted, transferred,

// pinned, unpinned, closed, reopened, assigned, unassigned, labeled, unlabeled,

// locked, unlocked, milestoned, or demilestoned.

// The Webhook event name is "issues".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#issues

type IssuesEvent struct {

}

// LabelEvent is triggered when a repository's label is created, edited, or deleted.

// The Webhook event name is "label"

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#label

type LabelEvent struct {

}

// MarketplacePurchaseEvent is triggered when a user purchases, cancels, or changes

// their GitHub Marketplace plan.

// Webhook event name "marketplace_purchase".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#marketplace_purchase

type MarketplacePurchaseEvent struct {

}

// MemberEvent is triggered when a user is added as a collaborator to a repository.

// The Webhook event name is "member".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#member

type MemberEvent struct {

}

// MembershipEvent is triggered when a user is added or removed from a team.

// The Webhook event name is "membership".

//

// Events of this type are not visible in timelines, they are only used to

// trigger organization webhooks.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#membership

type MembershipEvent struct {

}

// MetaEvent is triggered when the webhook that this event is configured on is deleted.

// This event will only listen for changes to the particular hook the event is installed on.

// Therefore, it must be selected for each hook that you'd like to receive meta events for.

// The Webhook event name is "meta".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#meta

type MetaEvent struct {

}

// MilestoneEvent is triggered when a milestone is created, closed, opened, edited, or deleted.

// The Webhook event name is "milestone".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#milestone

type MilestoneEvent struct {

}

// OrganizationEvent is triggered when an organization is deleted and renamed, and when a user is added,

// removed, or invited to an organization.

// Events of this type are not visible in timelines. These events are only used to trigger organization hooks.

// Webhook event name is "organization".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#organization

type OrganizationEvent struct {

}

// OrgBlockEvent is triggered when an organization blocks or unblocks a user.

// The Webhook event name is "org_block".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#org_block

type OrgBlockEvent struct {

}

// PackageEvent represents activity related to GitHub Packages.

// The Webhook event name is "package".

//

// This event is triggered when a GitHub Package is published or updated.

//

// GitHub API docs: https://developer.github.com/webhooks/event-payloads/#package

type PackageEvent struct {

}

// PageBuildEvent represents an attempted build of a GitHub Pages site, whether

// successful or not.

// The Webhook event name is "page_build".

//

// This event is triggered on push to a GitHub Pages enabled branch (gh-pages

// for project pages, master for user and organization pages).

//

// Events of this type are not visible in timelines, they are only used to trigger hooks.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#page_build

type PageBuildEvent struct {

}

// PingEvent is triggered when a Webhook is added to GitHub.

//

// GitHub API docs: https://developer.github.com/webhooks/#ping-event

type PingEvent struct {

}

// ProjectEvent is triggered when project is created, modified or deleted.

// The webhook event name is "project".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project

type ProjectEvent struct {

}

// ProjectCardEvent is triggered when a project card is created, updated, moved, converted to an issue, or deleted.

// The webhook event name is "project_card".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project_card

type ProjectCardEvent struct {

}

// ProjectColumnEvent is triggered when a project column is created, updated, moved, or deleted.

// The webhook event name is "project_column".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#project_column

type ProjectColumnEvent struct {

}

// PublicEvent is triggered when a private repository is open sourced.

// According to GitHub: "Without a doubt: the best GitHub event."

// The Webhook event name is "public".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#public

type PublicEvent struct {

}

// PullRequestEvent is triggered when a pull request is assigned, unassigned, labeled,

// unlabeled, opened, edited, closed, reopened, synchronize, ready_for_review,

// locked, unlocked, a pull request review is requested, or a review request is removed.

// The Webhook event name is "pull_request".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/github-event-types#pullrequestevent

type PullRequestEvent struct {

}

// PullRequestReviewEvent is triggered when a review is submitted on a pull

// request.

// The Webhook event name is "pull_request_review".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review

type PullRequestReviewEvent struct {

}

// PullRequestReviewCommentEvent is triggered when a comment is created on a

// portion of the unified diff of a pull request.

// The Webhook event name is "pull_request_review_comment".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#pull_request_review_comment

type PullRequestReviewCommentEvent struct {

}

// PullRequestTargetEvent is triggered when a pull request is assigned, unassigned, labeled,

// unlabeled, opened, edited, closed, reopened, synchronize, ready_for_review,

// locked, unlocked, a pull request review is requested, or a review request is removed.

// The Webhook event name is "pull_request_target".

//

// GitHub API docs: https://docs.github.com/en/actions/reference/events-that-trigger-workflows#pull_request_target

type PullRequestTargetEvent struct {

}

// PushEvent represents a git push to a GitHub repository.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#push

type PushEvent struct {

}

func (p PushEvent) String() string {

return Stringify(p)

}

// HeadCommit represents a git commit in a GitHub PushEvent.

type HeadCommit struct {

}

func (p HeadCommit) String() string {

return Stringify(p)

}

// PushEventRepository represents the repo object in a PushEvent payload.

type PushEventRepository struct {

}

// PushEventRepoOwner is a basic representation of user/org in a PushEvent payload.

type PushEventRepoOwner struct {

Name *string `json:"name,omitempty"`

Email *string `json:"email,omitempty"`

}

// ReleaseEvent is triggered when a release is published, unpublished, created,

// edited, deleted, or prereleased.

// The Webhook event name is "release".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#release

type ReleaseEvent struct {

}

// RepositoryEvent is triggered when a repository is created, archived, unarchived,

// renamed, edited, transferred, made public, or made private. Organization hooks are

// also trigerred when a repository is deleted.

// The Webhook event name is "repository".

//

// Events of this type are not visible in timelines, they are only used to

// trigger organization webhooks.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository

type RepositoryEvent struct {

}

// RepositoryDispatchEvent is triggered when a client sends a POST request to the repository dispatch event endpoint.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository_dispatch

type RepositoryDispatchEvent struct {

}

// RepositoryVulnerabilityAlertEvent is triggered when a security alert is created, dismissed, or resolved.

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#repository_vulnerability_alert

type RepositoryVulnerabilityAlertEvent struct {

}

// RepositoryVulnerabilityAlert represents a repository security alert.

type RepositoryVulnerabilityAlert struct {

}

// StarEvent is triggered when a star is added or removed from a repository.

// The Webhook event name is "star".

//

// GitHub API docs: https://docs.github.com/en/developers/webhooks-and-events/webhook-events-and-payloads#star

type StarEvent struct {