github-0.14.0: Access to the Github API, v3.

Safe HaskellNone
LanguageHaskell2010

Github.All

Contents

Description

This module re-exports all request constructrors and data definitions from this package.

The missing endpoints lists are exhausive, they indicate endpoints we know are missing.

Synopsis

Activity

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

Starring

See https://developer.github.com/v3/activity/starring/

Missing endpoints:

  • Check if you are starring a repository
  • Star a repository
  • Unstar a repository

stargazersForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector GithubOwner) Source

List Stargazers. See https://developer.github.com/v3/activity/starring/#list-stargazers

reposStarredByR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector Repo) Source

List repositories being starred. See https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

myStarredR :: Maybe Count -> GithubRequest True (Vector Repo) Source

All the repos starred by the authenticated user.

Watching

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

Missing endpoints:

  • Get a Repository Subscription
  • Set a Repository Subscription
  • Delete a Repository Subscription

watchersForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector GithubOwner) Source

List watchers. See https://developer.github.com/v3/activity/watching/#list-watchers

reposWatchedByR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector Repo) Source

List repositories being watched. See https://developer.github.com/v3/activity/watching/#list-repositories-being-watched

Gists

See https://developer.github.com/v3/gists/

Missing endpoints:

  • Get a specific revision of a gist
  • Create a gist
  • Edit a gist
  • List gist commits
  • Star a gist
  • Unstar a gist
  • Check if a gist is starred
  • Fork a gist
  • List gist forks
  • Delete a gist

gistsR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector Gist) Source

List gists. See https://developer.github.com/v3/gists/#list-gists

gistR :: Name Gist -> GithubRequest k Gist Source

Get a single gist. See https://developer.github.com/v3/gists/#get-a-single-gist

Comments

See https://developer.github.com/v3/gists/comments/

Missing endpoints: * Create a comment * Edit a comment * Delete a comment

commentsOnR :: Name Gist -> Maybe Count -> GithubRequest k (Vector GistComment) Source

List comments on a gist. See https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist

gistCommentR :: Id GistComment -> GithubRequest k GistComment Source

Get a single comment. See https://developer.github.com/v3/gists/comments/#get-a-single-comment

Git Data

See https://developer.github.com/v3/git/

Blobs

See https://developer.github.com/v3/git/blobs/

blobR :: Name GithubOwner -> Name Repo -> Name Blob -> GithubRequest k Blob Source

Get a blob. See https://developer.github.com/v3/git/blobs/#get-a-blob

Commits

See https://developer.github.com/v3/git/commits/

gitCommitR :: Name GithubOwner -> Name Repo -> Name GitCommit -> GithubRequest k GitCommit Source

Get a commit. See https://developer.github.com/v3/git/commits/#get-a-commit

References

See https://developer.github.com/v3/git/refs/

referenceR :: Name GithubOwner -> Name Repo -> Name GitReference -> GithubRequest k GitReference Source

Get a reference. See https://developer.github.com/v3/git/refs/#get-a-reference

referencesR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector GitReference) Source

Get all References. See https://developer.github.com/v3/git/refs/#get-all-references

createReferenceR :: Name GithubOwner -> Name Repo -> NewGitReference -> GithubRequest True GitReference Source

Create a reference. See https://developer.github.com/v3/git/refs/#create-a-reference

Trees

See https://developer.github.com/v3/git/trees/

treeR :: Name GithubOwner -> Name Repo -> Name Tree -> GithubRequest k Tree Source

Get a Tree. See https://developer.github.com/v3/git/trees/#get-a-tree

nestedTreeR :: Name GithubOwner -> Name Repo -> Name Tree -> GithubRequest k Tree Source

Get a Tree Recursively. See https://developer.github.com/v3/git/trees/#get-a-tree-recursively

Issues

See https://developer.github.com/v3/issues/

Missing endpoints:

  • List issues

issueR :: Name GithubOwner -> Name Repo -> Id Issue -> GithubRequest k Issue Source

Get a single issue. See https://developer.github.com/v3/issues/#get-a-single-issue

issuesForRepoR :: Name GithubOwner -> Name Repo -> [IssueLimitation] -> Maybe Count -> GithubRequest k (Vector Issue) Source

List issues for a repository. See https://developer.github.com/v3/issues/#list-issues-for-a-repository

createIssueR :: Name GithubOwner -> Name Repo -> NewIssue -> GithubRequest True Issue Source

Create an issue. See https://developer.github.com/v3/issues/#create-an-issue

editIssueR :: Name GithubOwner -> Name Repo -> Id Issue -> EditIssue -> GithubRequest True Issue Source

Edit an issue. See https://developer.github.com/v3/issues/#edit-an-issue

Comments

See https://developer.github.com/v3/issues/comments/

Missing endpoints:

  • Delete comment

commentR :: Name GithubOwner -> Name Repo -> Id Comment -> GithubRequest k IssueComment Source

Get a single comment. See https://developer.github.com/v3/issues/comments/#get-a-single-comment

commentsR :: Name GithubOwner -> Name Repo -> Id Issue -> Maybe Count -> GithubRequest k (Vector IssueComment) Source

List comments on an issue. See https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

createCommentR :: Name GithubOwner -> Name Repo -> Id Issue -> Text -> GithubRequest True Comment Source

Create a comment. See https://developer.github.com/v3/issues/comments/#create-a-comment

editCommentR :: Name GithubOwner -> Name Repo -> Id Comment -> Text -> GithubRequest True Comment Source

Edit a comment. See https://developer.github.com/v3/issues/comments/#edit-a-comment

Events

See https://developer.github.com/v3/issues/events/

eventsForIssueR :: Name GithubOwner -> Name Repo -> Id Issue -> Maybe Count -> GithubRequest k (Vector Event) Source

List events for an issue. See https://developer.github.com/v3/issues/events/#list-events-for-an-issue

eventsForRepoR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector Event) Source

List events for a repository. See https://developer.github.com/v3/issues/events/#list-events-for-a-repository

eventR :: Name GithubOwner -> Name Repo -> Id Event -> GithubRequest k Event Source

Get a single event. See https://developer.github.com/v3/issues/events/#get-a-single-event

Labels

See https://developer.github.com/v3/issues/labels/

labelsOnRepoR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector IssueLabel) Source

List all labels for this repository. See https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository

labelR :: Name GithubOwner -> Name Repo -> Name IssueLabel -> GithubRequest k IssueLabel Source

Get a single label. See https://developer.github.com/v3/issues/labels/#get-a-single-label

createLabelR :: Name GithubOwner -> Name Repo -> Name IssueLabel -> String -> GithubRequest True IssueLabel Source

Create a label. See https://developer.github.com/v3/issues/labels/#create-a-label

updateLabelR Source

Arguments

:: Name GithubOwner 
-> Name Repo 
-> Name IssueLabel

old label name

-> Name IssueLabel

new label name

-> String

new color

-> GithubRequest True IssueLabel 

Update a label. See https://developer.github.com/v3/issues/labels/#update-a-label

deleteLabelR :: Name GithubOwner -> Name Repo -> Name IssueLabel -> GithubRequest True () Source

Delete a label. See https://developer.github.com/v3/issues/labels/#delete-a-label

labelsOnIssueR :: Name GithubOwner -> Name Repo -> Id Issue -> Maybe Count -> GithubRequest k (Vector IssueLabel) Source

List labels on an issue. See https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue

addLabelsToIssueR :: Foldable f => Name GithubOwner -> Name Repo -> Id Issue -> f (Name IssueLabel) -> GithubRequest True (Vector IssueLabel) Source

Add lables to an issue. See https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue

removeLabelFromIssueR :: Name GithubOwner -> Name Repo -> Id Issue -> Name IssueLabel -> GithubRequest True () Source

Remove a label from an issue. See https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue

replaceAllLabelsForIssueR :: Foldable f => Name GithubOwner -> Name Repo -> Id Issue -> f (Name IssueLabel) -> GithubRequest True (Vector IssueLabel) Source

Replace all labels on an issue. See https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue

Sending an empty list will remove all labels from the issue.

removeAllLabelsFromIssueR :: Name GithubOwner -> Name Repo -> Id Issue -> GithubRequest True () Source

Remove all labels from an issue. See https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue

labelsOnMilestoneR :: Name GithubOwner -> Name Repo -> Id Milestone -> Maybe Count -> GithubRequest k (Vector IssueLabel) Source

Get labels for every issue in a milestone. See https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone

Milestone

See https://developer.github.com/v3/issues/milestones/

Missing endpoints:

  • Create a milestone
  • Update a milestone
  • Delete a milestone

milestonesR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector Milestone) Source

List milestones for a repository. See https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository

milestoneR :: Name GithubOwner -> Name Repo -> Id Milestone -> GithubRequest k Milestone Source

Get a single milestone. See https://developer.github.com/v3/issues/milestones/#get-a-single-milestone

Organizations

See https://developer.github.com/v3/orgs/

Missing endpoints:

  • List your organizations
  • List all organizations
  • Edit an organization

publicOrganizationsForR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector SimpleOrganization) Source

List user organizations. See https://developer.github.com/v3/orgs/#list-user-organizations

publicOrganizationR :: Name Organization -> GithubRequest k Organization Source

Get an organization. See https://developer.github.com/v3/orgs/#get-an-organization

Members

See https://developer.github.com/v3/orgs/members/

Missing endpoints: All except Members List

membersOfR :: Name Organization -> Maybe Count -> GithubRequest k (Vector SimpleOwner) Source

All the users who are members of the specified organization.

See https://developer.github.com/v3/orgs/members/#members-list

Teams

See https://developer.github.com/v3/orgs/teams/

Missing endpoints:

  • List team members
  • Get team member (deprecated)
  • Add team member (deprecated)
  • Remove team member (deprecated)
  • List team repos
  • Check if a team manages a repository
  • Add team repository
  • Remove team repository

teamsOfR :: Name Organization -> Maybe Count -> GithubRequest k (Vector SimpleTeam) Source

List teams. See https://developer.github.com/v3/orgs/teams/#list-teams

teamInfoForR :: Id Team -> GithubRequest k Team Source

Get team. See https://developer.github.com/v3/orgs/teams/#get-team

createTeamForR :: Name Organization -> CreateTeam -> GithubRequest True Team Source

Create team. See https://developer.github.com/v3/orgs/teams/#create-team

editTeamR :: Id Team -> EditTeam -> GithubRequest True Team Source

Edit team. See https://developer.github.com/v3/orgs/teams/#edit-team

deleteTeamR :: Id Team -> GithubRequest True () Source

Delete team. See https://developer.github.com/v3/orgs/teams/#delete-team

teamMembershipInfoForR :: Id Team -> Name GithubOwner -> GithubRequest k TeamMembership Source

Get team membership. See <https://developer.github.com/v3/orgs/teams/#get-team-membership

addTeamMembershipForR :: Id Team -> Name GithubOwner -> Role -> GithubRequest True TeamMembership Source

Add team membership. See https://developer.github.com/v3/orgs/teams/#add-team-membership

deleteTeamMembershipForR :: Id Team -> Name GithubOwner -> GithubRequest True () Source

Remove team membership. See https://developer.github.com/v3/orgs/teams/#remove-team-membership

listTeamsCurrentR :: Maybe Count -> GithubRequest True (Vector Team) Source

List user teams. See https://developer.github.com/v3/orgs/teams/#list-user-teams

Pull Requests

See https://developer.github.com/v3/pulls/

pullRequestsForR Source

Arguments

:: Name GithubOwner 
-> Name Repo 
-> Maybe String

State

-> Maybe Count 
-> GithubRequest k (Vector SimplePullRequest) 

List pull requests. See https://developer.github.com/v3/pulls/#list-pull-requests

pullRequestR :: Name GithubOwner -> Name Repo -> Id PullRequest -> GithubRequest k PullRequest Source

Get a single pull request. See https://developer.github.com/v3/pulls/#get-a-single-pull-request

createPullRequestR :: Name GithubOwner -> Name Repo -> CreatePullRequest -> GithubRequest True PullRequest Source

Create a pull request. See https://developer.github.com/v3/pulls/#create-a-pull-request

updatePullRequestR :: Name GithubOwner -> Name Repo -> Id PullRequest -> EditPullRequest -> GithubRequest True PullRequest Source

Update a pull request. See https://developer.github.com/v3/pulls/#update-a-pull-request

pullRequestCommitsR :: Name GithubOwner -> Name Repo -> Id PullRequest -> Maybe Count -> GithubRequest k (Vector Commit) Source

List commits on a pull request. See https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

pullRequestFilesR :: Name GithubOwner -> Name Repo -> Id PullRequest -> Maybe Count -> GithubRequest k (Vector File) Source

List pull requests files. See https://developer.github.com/v3/pulls/#list-pull-requests-files

isPullRequestMergedR :: Name GithubOwner -> Name Repo -> Id PullRequest -> GithubRequest k Status Source

Get if a pull request has been merged. See https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

mergePullRequestR :: Name GithubOwner -> Name Repo -> Id PullRequest -> Maybe String -> GithubRequest True Status Source

Merge a pull request (Merge Button). https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button

Review comments

See https://developer.github.com/v3/pulls/comments/

Missing endpoints:

  • List comments in a repository
  • Create a comment
  • Edit a comment
  • Delete a comment

pullRequestReviewCommentsR :: Name GithubOwner -> Name Repo -> Id PullRequest -> Maybe Count -> GithubRequest k (Vector Comment) Source

List comments on a pull request. See https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request

pullRequestReviewCommentR :: Name GithubOwner -> Name Repo -> Id Comment -> GithubRequest k Comment Source

Get a single comment. See https://developer.github.com/v3/pulls/comments/#get-a-single-comment

Repositories

See https://developer.github.com/v3/repos/

Missing endpoints:

  • List all public repositories
  • List Teams
  • Get Branch
  • Enabling and disabling branch protection

currentUserReposR :: RepoPublicity -> Maybe Count -> GithubRequest k (Vector Repo) Source

List your repositories. See https://developer.github.com/v3/repos/#list-your-repositories

userReposR :: Name GithubOwner -> RepoPublicity -> Maybe Count -> GithubRequest k (Vector Repo) Source

List user repositories. See https://developer.github.com/v3/repos/#list-user-repositories

Collaborators

See https://developer.github.com/v3/repos/collaborators/

collaboratorsOnR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector GithubOwner) Source

List collaborators. See https://developer.github.com/v3/repos/collaborators/#list-collaborators

isCollaboratorOnR Source

Arguments

:: Name GithubOwner

Repository owner

-> Name Repo

Repository name

-> Name GithubOwner

Collaborator?

-> GithubRequest k Status 

Check if a user is a collaborator. See https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator

Comments

See https://developer.github.com/v3/repos/comments/

Missing endpoints:

  • Create a commit comment
  • Update a commit comment
  • Delete a commit comment

commentsForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector Comment) Source

List commit comments for a repository. See https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository

commitCommentsForR :: Name GithubOwner -> Name Repo -> Name Commit -> Maybe Count -> GithubRequest k (Vector Comment) Source

List comments for a single commit. See https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit

commitCommentForR :: Name GithubOwner -> Name Repo -> Id Comment -> GithubRequest k Comment Source

Get a single commit comment. See https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment

Commits

See https://developer.github.com/v3/repos/commits/

commitsForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector Commit) Source

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitsWithOptionsForR :: Name GithubOwner -> Name Repo -> Maybe Count -> [CommitQueryOption] -> GithubRequest k (Vector Commit) Source

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitR :: Name GithubOwner -> Name Repo -> Name Commit -> GithubRequest k Commit Source

Get a single commit. See https://developer.github.com/v3/repos/commits/#get-a-single-commit

diffR :: Name GithubOwner -> Name Repo -> Name Commit -> Name Commit -> GithubRequest k Diff Source

Compare two commits. See https://developer.github.com/v3/repos/commits/#compare-two-commits

Forks

See https://developer.github.com/v3/repos/forks/

Missing endpoints:

  • Create a fork

forksForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector Repo) Source

List forks. See https://developer.github.com/v3/repos/forks/#list-forks

Webhooks

See https://developer.github.com/v3/repos/hooks/

webhooksForR :: Name GithubOwner -> Name Repo -> Maybe Count -> GithubRequest k (Vector RepoWebhook) Source

List hooks. See https://developer.github.com/v3/repos/hooks/#list-hooks

webhookForR :: Name GithubOwner -> Name Repo -> Id RepoWebhook -> GithubRequest k RepoWebhook Source

Get single hook. See https://developer.github.com/v3/repos/hooks/#get-single-hook

createRepoWebhookR :: Name GithubOwner -> Name Repo -> NewRepoWebhook -> GithubRequest True RepoWebhook Source

Create a hook. See https://developer.github.com/v3/repos/hooks/#create-a-hook

editRepoWebhookR :: Name GithubOwner -> Name Repo -> Id RepoWebhook -> EditRepoWebhook -> GithubRequest True RepoWebhook Source

Edit a hook. See https://developer.github.com/v3/repos/hooks/#edit-a-hook

testPushRepoWebhookR :: Name GithubOwner -> Name Repo -> Id RepoWebhook -> GithubRequest True Status Source

Test a push hook. See https://developer.github.com/v3/repos/hooks/#test-a-push-hook

pingRepoWebhookR :: Name GithubOwner -> Name Repo -> Id RepoWebhook -> GithubRequest True Status Source

Ping a hook. See https://developer.github.com/v3/repos/hooks/#ping-a-hook

deleteRepoWebhookR :: Name GithubOwner -> Name Repo -> Id RepoWebhook -> GithubRequest True () Source

Delete a hook. See https://developer.github.com/v3/repos/hooks/#delete-a-hook

Search

See https://developer.github.com/v3/search/

Missing endpoints:

  • Search users

searchReposR :: Text -> GithubRequest k SearchReposResult Source

Search repositories. See https://developer.github.com/v3/search/#search-repositories

searchCodeR :: Text -> GithubRequest k SearchCodeResult Source

Search code. See https://developer.github.com/v3/search/#search-code

searchIssuesR :: Text -> GithubRequest k SearchIssuesResult Source

Search issues. See https://developer.github.com/v3/search/#search-issues

Users

See https://developer.github.com/v3/users/

Missing endpoints:

  • Update the authenticated user
  • Get all users

userInfoForR :: Name GithubOwner -> GithubRequest k GithubOwner Source

Get a single user. See https://developer.github.com/v3/users/#get-a-single-user

userInfoCurrentR :: GithubRequest True GithubOwner Source

Get the authenticated user. See https://developer.github.com/v3/users/#get-the-authenticated-user

Followers

See https://developer.github.com/v3/users/followers/

Missing endpoints:

  • Check if you are following a user
  • Check if one user follows another
  • Follow a user
  • Unfollow a user

usersFollowingR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector SimpleOwner) Source

List followers of a user. See https://developer.github.com/v3/users/followers/#list-followers-of-a-user

usersFollowedByR :: Name GithubOwner -> Maybe Count -> GithubRequest k (Vector SimpleOwner) Source

List users followed by another user. See https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user

Data definitions

module Github.Data