Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell98 |
Github.Data.Definitions
- data Error
- newtype GithubDate = GithubDate {}
- data Commit = Commit {}
- data Tree = Tree {}
- data GitTree = GitTree {}
- data GitCommit = GitCommit {}
- data GithubOwner
- data GitUser = GitUser {}
- data File = File {
- fileBlobUrl :: String
- fileStatus :: String
- fileRawUrl :: String
- fileAdditions :: Int
- fileSha :: String
- fileChanges :: Int
- filePatch :: String
- fileFilename :: String
- fileDeletions :: Int
- data Stats = Stats {
- statsAdditions :: Int
- statsTotal :: Int
- statsDeletions :: Int
- data Comment = Comment {}
- data NewComment = NewComment {}
- data EditComment = EditComment {}
- data Diff = Diff {
- diffStatus :: String
- diffBehindBy :: Int
- diffPatchUrl :: String
- diffUrl :: String
- diffBaseCommit :: Commit
- diffCommits :: [Commit]
- diffTotalCommits :: Int
- diffHtmlUrl :: String
- diffFiles :: [File]
- diffAheadBy :: Int
- diffDiffUrl :: String
- diffPermalinkUrl :: String
- data Gist = Gist {}
- data GistFile = GistFile {}
- data GistComment = GistComment {}
- data Blob = Blob {
- blobUrl :: String
- blobEncoding :: String
- blobContent :: String
- blobSha :: String
- blobSize :: Int
- data GitReference = GitReference {}
- data GitObject = GitObject {}
- data Issue = Issue {
- issueClosedAt :: Maybe GithubDate
- issueUpdatedAt :: GithubDate
- issueEventsUrl :: String
- issueHtmlUrl :: Maybe String
- issueClosedBy :: Maybe GithubOwner
- issueLabels :: [IssueLabel]
- issueNumber :: Int
- issueAssignee :: Maybe GithubOwner
- issueUser :: GithubOwner
- issueTitle :: String
- issuePullRequest :: Maybe PullRequestReference
- issueUrl :: String
- issueCreatedAt :: GithubDate
- issueBody :: Maybe String
- issueState :: String
- issueId :: Int
- issueComments :: Int
- issueMilestone :: Maybe Milestone
- data NewIssue = NewIssue {}
- data EditIssue = EditIssue {}
- data Milestone = Milestone {}
- data IssueLabel = IssueLabel {}
- data PullRequestReference = PullRequestReference {}
- data IssueComment = IssueComment {}
- data EventType
- data Event = Event {}
- data SimpleOrganization = SimpleOrganization {}
- data Organization = Organization {
- organizationType :: String
- organizationBlog :: Maybe String
- organizationLocation :: Maybe String
- organizationLogin :: String
- organizationFollowers :: Int
- organizationCompany :: Maybe String
- organizationAvatarUrl :: String
- organizationPublicGists :: Int
- organizationHtmlUrl :: String
- organizationEmail :: Maybe String
- organizationFollowing :: Int
- organizationPublicRepos :: Int
- organizationUrl :: String
- organizationCreatedAt :: GithubDate
- organizationName :: Maybe String
- organizationId :: Int
- data PullRequest = PullRequest {
- pullRequestClosedAt :: Maybe GithubDate
- pullRequestCreatedAt :: GithubDate
- pullRequestUser :: GithubOwner
- pullRequestPatchUrl :: String
- pullRequestState :: String
- pullRequestNumber :: Int
- pullRequestHtmlUrl :: String
- pullRequestUpdatedAt :: GithubDate
- pullRequestBody :: String
- pullRequestIssueUrl :: String
- pullRequestDiffUrl :: String
- pullRequestUrl :: String
- pullRequestLinks :: PullRequestLinks
- pullRequestMergedAt :: Maybe GithubDate
- pullRequestTitle :: String
- pullRequestId :: Int
- data DetailedPullRequest = DetailedPullRequest {
- detailedPullRequestClosedAt :: Maybe GithubDate
- detailedPullRequestCreatedAt :: GithubDate
- detailedPullRequestUser :: GithubOwner
- detailedPullRequestPatchUrl :: String
- detailedPullRequestState :: String
- detailedPullRequestNumber :: Int
- detailedPullRequestHtmlUrl :: String
- detailedPullRequestUpdatedAt :: GithubDate
- detailedPullRequestBody :: String
- detailedPullRequestIssueUrl :: String
- detailedPullRequestDiffUrl :: String
- detailedPullRequestUrl :: String
- detailedPullRequestLinks :: PullRequestLinks
- detailedPullRequestMergedAt :: Maybe GithubDate
- detailedPullRequestTitle :: String
- detailedPullRequestId :: Int
- detailedPullRequestMergedBy :: Maybe GithubOwner
- detailedPullRequestChangedFiles :: Int
- detailedPullRequestHead :: PullRequestCommit
- detailedPullRequestComments :: Int
- detailedPullRequestDeletions :: Int
- detailedPullRequestAdditions :: Int
- detailedPullRequestReviewComments :: Int
- detailedPullRequestBase :: PullRequestCommit
- detailedPullRequestCommits :: Int
- detailedPullRequestMerged :: Bool
- detailedPullRequestMergeable :: Maybe Bool
- data EditPullRequest = EditPullRequest {}
- data PullRequestLinks = PullRequestLinks {}
- data PullRequestCommit = PullRequestCommit {}
- data SearchReposResult = SearchReposResult {}
- data Repo = Repo {
- repoSshUrl :: Maybe String
- repoDescription :: Maybe String
- repoCreatedAt :: Maybe GithubDate
- repoHtmlUrl :: String
- repoSvnUrl :: Maybe String
- repoForks :: Maybe Int
- repoHomepage :: Maybe String
- repoFork :: Maybe Bool
- repoGitUrl :: Maybe String
- repoPrivate :: Bool
- repoCloneUrl :: Maybe String
- repoSize :: Maybe Int
- repoUpdatedAt :: Maybe GithubDate
- repoWatchers :: Maybe Int
- repoOwner :: GithubOwner
- repoName :: String
- repoLanguage :: Maybe String
- repoMasterBranch :: Maybe String
- repoPushedAt :: Maybe GithubDate
- repoId :: Int
- repoUrl :: String
- repoOpenIssues :: Maybe Int
- repoHasWiki :: Maybe Bool
- repoHasIssues :: Maybe Bool
- repoHasDownloads :: Maybe Bool
- repoParent :: Maybe RepoRef
- repoSource :: Maybe RepoRef
- repoHooksUrl :: String
- data RepoRef = RepoRef GithubOwner String
- data SearchCodeResult = SearchCodeResult {}
- data Code = Code {}
- data Content
- data ContentData = ContentData {}
- data Contributor
- data Languages = Languages {
- getLanguages :: [Language]
- data Language = Language String Int
- data Tag = Tag {}
- data Branch = Branch {}
- data BranchCommit = BranchCommit {}
- data DetailedOwner
- = DetailedUser {
- detailedOwnerCreatedAt :: GithubDate
- detailedOwnerType :: String
- detailedOwnerPublicGists :: Int
- detailedOwnerAvatarUrl :: String
- detailedOwnerFollowers :: Int
- detailedOwnerFollowing :: Int
- detailedOwnerHireable :: Maybe Bool
- detailedOwnerGravatarId :: Maybe String
- detailedOwnerBlog :: Maybe String
- detailedOwnerBio :: Maybe String
- detailedOwnerPublicRepos :: Int
- detailedOwnerName :: Maybe String
- detailedOwnerLocation :: Maybe String
- detailedOwnerCompany :: Maybe String
- detailedOwnerEmail :: Maybe String
- detailedOwnerUrl :: String
- detailedOwnerId :: Int
- detailedOwnerHtmlUrl :: String
- detailedOwnerLogin :: String
- | DetailedOrganization {
- detailedOwnerCreatedAt :: GithubDate
- detailedOwnerType :: String
- detailedOwnerPublicGists :: Int
- detailedOwnerAvatarUrl :: String
- detailedOwnerFollowers :: Int
- detailedOwnerFollowing :: Int
- detailedOwnerBlog :: Maybe String
- detailedOwnerBio :: Maybe String
- detailedOwnerPublicRepos :: Int
- detailedOwnerName :: Maybe String
- detailedOwnerLocation :: Maybe String
- detailedOwnerCompany :: Maybe String
- detailedOwnerUrl :: String
- detailedOwnerId :: Int
- detailedOwnerHtmlUrl :: String
- detailedOwnerLogin :: String
- = DetailedUser {
- data RepoWebhook = RepoWebhook {
- repoWebhookUrl :: String
- repoWebhookTestUrl :: String
- repoWebhookId :: Integer
- repoWebhookName :: String
- repoWebhookActive :: Bool
- repoWebhookEvents :: [RepoWebhookEvent]
- repoWebhookConfig :: Map String String
- repoWebhookLastResponse :: RepoWebhookResponse
- repoWebhookUpdatedAt :: GithubDate
- repoWebhookCreatedAt :: GithubDate
- data RepoWebhookEvent
- = WebhookWildcardEvent
- | WebhookCommitCommentEvent
- | WebhookCreateEvent
- | WebhookDeleteEvent
- | WebhookDeploymentEvent
- | WebhookDeploymentStatusEvent
- | WebhookForkEvent
- | WebhookGollumEvent
- | WebhookIssueCommentEvent
- | WebhookIssuesEvent
- | WebhookMemberEvent
- | WebhookPageBuildEvent
- | WebhookPublicEvent
- | WebhookPullRequestReviewCommentEvent
- | WebhookPullRequestEvent
- | WebhookPushEvent
- | WebhookReleaseEvent
- | WebhookStatusEvent
- | WebhookTeamAddEvent
- | WebhookWatchEvent
- data RepoWebhookResponse = RepoWebhookResponse {}
- data PullRequestEvent = PullRequestEvent {}
- data PullRequestEventType
- data PingEvent = PingEvent {}
- data EditPullRequestState
Documentation
Errors have been tagged according to their source, so you can more easily dispatch and handle them.
Constructors
HTTPConnectionError SomeException | A HTTP error occurred. The actual caught error is included. |
ParseError String | An error in the parser itself. |
JsonError String | The JSON is malformed or unexpected. |
UserError String | Incorrect input. |
newtype GithubDate Source
A date in the Github format, which is a special case of ISO-8601.
Constructors
GithubDate | |
Fields |
Constructors
Commit | |
Fields
|
Constructors
GitTree | |
Fields
|
Constructors
GitCommit | |
Fields
|
data GithubOwner Source
Constructors
GithubUser | |
Fields | |
GithubOrganization | |
Fields |
Constructors
GitUser | |
Fields
|
Constructors
File | |
Fields
|
Constructors
Stats | |
Fields
|
Constructors
Comment | |
Fields
|
data EditComment Source
Constructors
EditComment | |
Fields |
Constructors
Diff | |
Fields
|
Constructors
Gist | |
Fields
|
Constructors
GistFile | |
Fields |
data GistComment Source
Constructors
GistComment | |
data GitReference Source
Constructors
GitReference | |
Fields |
Constructors
GitObject | |
Fields
|
Constructors
Issue | |
Fields
|
Constructors
NewIssue | |
Fields
|
Constructors
EditIssue | |
Fields |
Constructors
Milestone | |
data IssueLabel Source
Constructors
IssueLabel | |
data PullRequestReference Source
Constructors
PullRequestReference | |
data IssueComment Source
Constructors
IssueComment | |
Data describing an Event
.
Constructors
Mentioned | The actor was @mentioned in an issue body. |
Subscribed | The actor subscribed to receive notifications for an issue. |
Unsubscribed | The issue was unsubscribed from by the actor. |
Referenced | The issue was referenced from a commit message. The commit_id attribute is the commit SHA1 of where that happened. |
Merged | The issue was merged by the actor. The commit_id attribute is the SHA1 of the HEAD commit that was merged. |
Assigned | The issue was assigned to the actor. |
Closed | The issue was closed by the actor. When the commit_id is present, it identifies the commit that closed the issue using “closes / fixes #NN” syntax. |
Reopened | The issue was reopened by the actor. |
ActorUnassigned | The issue was unassigned to the actor |
Labeled | A label was added to the issue. |
Unlabeled | A label was removed from the issue. |
Milestoned | The issue was added to a milestone. |
Demilestoned | The issue was removed from a milestone. |
Renamed | The issue title was changed. |
Locked | The issue was locked by the actor. |
Unlocked | The issue was unlocked by the actor. |
HeadRefDeleted | The pull request’s branch was deleted. |
HeadRefRestored | The pull request’s branch was restored. |
Constructors
Event | |
Fields
|
data SimpleOrganization Source
Constructors
SimpleOrganization | |
data Organization Source
Constructors
data PullRequest Source
Constructors
data DetailedPullRequest Source
Constructors
data PullRequestLinks Source
Constructors
PullRequestLinks | |
data PullRequestCommit Source
Constructors
PullRequestCommit | |
data SearchReposResult Source
Constructors
SearchReposResult | |
Fields
|
Constructors
Repo | |
Fields
|
Constructors
RepoRef GithubOwner String |
data SearchCodeResult Source
Constructors
SearchCodeResult | |
Fields
|
Constructors
Code | |
Constructors
ContentFile ContentData | |
ContentDirectory [ContentData] |
data ContentData Source
Constructors
ContentData | |
Fields
|
data Contributor Source
Constructors
KnownContributor Int String String String Int String | An existing Github user, with their number of contributions, avatar URL, login, URL, ID, and Gravatar ID. |
AnonymousContributor Int String | An unknown Github user with their number of contributions and recorded name. |
This is only used for the FromJSON instance.
Constructors
Languages | |
Fields
|
A programming language with the name and number of characters written in it.
Constructors
Tag | |
Fields
|
Constructors
Branch | |
Fields |
data BranchCommit Source
Constructors
BranchCommit | |
Fields |
data DetailedOwner Source
Constructors
data RepoWebhook Source
Constructors
data RepoWebhookEvent Source
Constructors
data RepoWebhookResponse Source
Constructors
RepoWebhookResponse | |
data PullRequestEvent Source
Constructors
PullRequestEvent | |
Constructors
PingEvent | |
Fields |
data EditPullRequestState Source
Constructors
EditPullRequestStateOpen | |
EditPullRequestStateClosed |