github-0.20: Access to the GitHub API, v3.

LicenseBSD-3-Clause
MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
Safe HaskellNone
LanguageHaskell2010

GitHub.Endpoints.Gists

Description

The gists API as described at http://developer.github.com/v3/gists/.

Synopsis

Documentation

gists :: Name Owner -> IO (Either Error (Vector Gist)) Source #

The list of all public gists created by the user.

gists "mike-burns"

gists' :: Maybe Auth -> Name Owner -> IO (Either Error (Vector Gist)) Source #

The list of all gists created by the user

gists' (Just ("github-username", "github-password")) "mike-burns"

gist :: Name Gist -> IO (Either Error Gist) Source #

A specific gist, given its id.

gist "225074"

gist' :: Maybe Auth -> Name Gist -> IO (Either Error Gist) Source #

A specific gist, given its id, with authentication credentials

gist' (Just ("github-username", "github-password")) "225074"

starGist :: Auth -> Name Gist -> IO (Either Error ()) Source #

Star a gist by the authenticated user.

starGist ("github-username", "github-password") "225074"

starGistR :: Name Gist -> Request RW () Source #

Star a gist by the authenticated user. See https://developer.github.com/v3/gists/#star-a-gist

unstarGist :: Auth -> Name Gist -> IO (Either Error ()) Source #

Unstar a gist by the authenticated user.

unstarGist ("github-username", "github-password") "225074"

unstarGistR :: Name Gist -> Request RW () Source #

Unstar a gist by the authenticated user. See https://developer.github.com/v3/gists/#unstar-a-gist

deleteGist :: Auth -> Name Gist -> IO (Either Error ()) Source #

Delete a gist by the authenticated user.

deleteGist ("github-username", "github-password") "225074"

deleteGistR :: Name Gist -> Request RW () Source #

Delete a gist by the authenticated user. See https://developer.github.com/v3/gists/#delete-a-gist