-- The Release API, as described at
-- <https://developer.github.com/v3/repos/releases/>.
module GitHub.Endpoints.Repos.Releases (
    releases,
    releases',
    releasesR,
    release,
    release',
    releaseR,
    latestRelease,
    latestRelease',
    latestReleaseR,
    releaseByTagName,
    releaseByTagName',
    releaseByTagNameR,
    module GitHub.Data,
    ) where

import GitHub.Data
import GitHub.Internal.Prelude
import GitHub.Request
import Prelude ()

-- | All releases for the given repo.
--
-- > releases "calleerlandsson" "pick"
releases :: Name Owner -> Name Repo -> IO (Either Error  (Vector Release))
releases :: Name Owner -> Name Repo -> IO (Either Error (Vector Release))
releases = Maybe Auth
-> Name Owner -> Name Repo -> IO (Either Error (Vector Release))
releases' Maybe Auth
forall a. Maybe a
Nothing

-- | All releases for the given repo with authentication.
--
-- > releases' (Just $ BasicAuth "github-username" "github-password") "calleerlandsson" "pick"
releases' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error  (Vector Release))
releases' :: Maybe Auth
-> Name Owner -> Name Repo -> IO (Either Error (Vector Release))
releases' auth :: Maybe Auth
auth user :: Name Owner
user repo :: Name Repo
repo =
    Maybe Auth
-> GenRequest 'MtJSON 'RO (Vector Release)
-> IO (Either Error (Vector Release))
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtJSON 'RO (Vector Release)
 -> IO (Either Error (Vector Release)))
-> GenRequest 'MtJSON 'RO (Vector Release)
-> IO (Either Error (Vector Release))
forall a b. (a -> b) -> a -> b
$ Name Owner
-> Name Repo
-> FetchCount
-> GenRequest 'MtJSON 'RO (Vector Release)
forall (k :: RW).
Name Owner -> Name Repo -> FetchCount -> Request k (Vector Release)
releasesR Name Owner
user Name Repo
repo FetchCount
FetchAll

-- | List releases for a repository.
-- See <https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository>
releasesR :: Name Owner -> Name Repo -> FetchCount -> Request k (Vector Release)
releasesR :: Name Owner -> Name Repo -> FetchCount -> Request k (Vector Release)
releasesR user :: Name Owner
user repo :: Name Repo
repo =
    Paths -> QueryString -> FetchCount -> Request k (Vector Release)
forall a (mt :: RW).
FromJSON a =>
Paths -> QueryString -> FetchCount -> Request mt (Vector a)
pagedQuery ["repos", Name Owner -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Owner
user, Name Repo -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Repo
repo, "releases"] []

-- | Query a single release.
--
-- > release "calleerlandsson" "pick"
release :: Name Owner -> Name Repo -> Id Release -> IO (Either Error Release)
release :: Name Owner -> Name Repo -> Id Release -> IO (Either Error Release)
release = Maybe Auth
-> Name Owner
-> Name Repo
-> Id Release
-> IO (Either Error Release)
release' Maybe Auth
forall a. Maybe a
Nothing

-- | Query a single release with authentication.
--
-- > release' (Just $ BasicAuth "github-username" "github-password") "calleerlandsson" "pick"
release' :: Maybe Auth -> Name Owner -> Name Repo -> Id Release -> IO (Either Error Release)
release' :: Maybe Auth
-> Name Owner
-> Name Repo
-> Id Release
-> IO (Either Error Release)
release' auth :: Maybe Auth
auth user :: Name Owner
user repo :: Name Repo
repo reqReleaseId :: Id Release
reqReleaseId =
    Maybe Auth
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtJSON 'RO Release -> IO (Either Error Release))
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall a b. (a -> b) -> a -> b
$ Name Owner
-> Name Repo -> Id Release -> GenRequest 'MtJSON 'RO Release
forall (k :: RW).
Name Owner -> Name Repo -> Id Release -> Request k Release
releaseR Name Owner
user Name Repo
repo Id Release
reqReleaseId

-- | Get a single release.
-- See <https://developer.github.com/v3/repos/releases/#get-a-single-release>
releaseR :: Name Owner -> Name Repo -> Id Release -> Request k Release
releaseR :: Name Owner -> Name Repo -> Id Release -> Request k Release
releaseR user :: Name Owner
user repo :: Name Repo
repo reqReleaseId :: Id Release
reqReleaseId =
    Paths -> QueryString -> Request k Release
forall (mt :: RW) a. Paths -> QueryString -> Request mt a
query ["repos", Name Owner -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Owner
user, Name Repo -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Repo
repo, "releases", Id Release -> Text
forall a. IsPathPart a => a -> Text
toPathPart Id Release
reqReleaseId ] []

-- | Query latest release.
--
-- > latestRelease "calleerlandsson" "pick"
latestRelease :: Name Owner -> Name Repo -> IO (Either Error Release)
latestRelease :: Name Owner -> Name Repo -> IO (Either Error Release)
latestRelease = Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error Release)
latestRelease' Maybe Auth
forall a. Maybe a
Nothing

-- | Query latest release with authentication.
--
-- > latestRelease' (Just $ BasicAuth "github-username" "github-password") "calleerlandsson" "pick"
latestRelease' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error Release)
latestRelease' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error Release)
latestRelease' auth :: Maybe Auth
auth user :: Name Owner
user repo :: Name Repo
repo  =
    Maybe Auth
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtJSON 'RO Release -> IO (Either Error Release))
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall a b. (a -> b) -> a -> b
$ Name Owner -> Name Repo -> GenRequest 'MtJSON 'RO Release
forall (k :: RW). Name Owner -> Name Repo -> Request k Release
latestReleaseR Name Owner
user Name Repo
repo

-- | Get the latest release.
-- See <https://developer.github.com/v3/repos/releases/#get-the-latest-release>
latestReleaseR :: Name Owner -> Name Repo -> Request k Release
latestReleaseR :: Name Owner -> Name Repo -> Request k Release
latestReleaseR user :: Name Owner
user repo :: Name Repo
repo =
    Paths -> QueryString -> Request k Release
forall (mt :: RW) a. Paths -> QueryString -> Request mt a
query ["repos", Name Owner -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Owner
user, Name Repo -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Repo
repo, "releases", "latest" ] []

-- | Query release by tag name.
--
-- > releaseByTagName "calleerlandsson" "pick"
releaseByTagName :: Name Owner -> Name Repo -> Text -> IO (Either Error Release)
releaseByTagName :: Name Owner -> Name Repo -> Text -> IO (Either Error Release)
releaseByTagName = Maybe Auth
-> Name Owner -> Name Repo -> Text -> IO (Either Error Release)
releaseByTagName' Maybe Auth
forall a. Maybe a
Nothing

-- | Query release by tag name with authentication.
--
-- > releaseByTagName' (Just $ BasicAuth "github-username" "github-password") "calleerlandsson" "pick"
releaseByTagName' :: Maybe Auth -> Name Owner -> Name Repo -> Text -> IO (Either Error Release)
releaseByTagName' :: Maybe Auth
-> Name Owner -> Name Repo -> Text -> IO (Either Error Release)
releaseByTagName' auth :: Maybe Auth
auth user :: Name Owner
user repo :: Name Repo
repo reqTagName :: Text
reqTagName =
    Maybe Auth
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall am (mt :: MediaType *) a.
(AuthMethod am, ParseResponse mt a) =>
Maybe am -> GenRequest mt 'RO a -> IO (Either Error a)
executeRequestMaybe Maybe Auth
auth (GenRequest 'MtJSON 'RO Release -> IO (Either Error Release))
-> GenRequest 'MtJSON 'RO Release -> IO (Either Error Release)
forall a b. (a -> b) -> a -> b
$ Name Owner -> Name Repo -> Text -> GenRequest 'MtJSON 'RO Release
forall (k :: RW).
Name Owner -> Name Repo -> Text -> Request k Release
releaseByTagNameR Name Owner
user Name Repo
repo Text
reqTagName

-- | Get a release by tag name
-- See <https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name>
releaseByTagNameR :: Name Owner -> Name Repo -> Text -> Request k Release
releaseByTagNameR :: Name Owner -> Name Repo -> Text -> Request k Release
releaseByTagNameR user :: Name Owner
user repo :: Name Repo
repo reqTagName :: Text
reqTagName =
    Paths -> QueryString -> Request k Release
forall (mt :: RW) a. Paths -> QueryString -> Request mt a
query ["repos", Name Owner -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Owner
user, Name Repo -> Text
forall a. IsPathPart a => a -> Text
toPathPart Name Repo
repo, "releases", "tags" , Text
reqTagName ] []

{-
--  TODO: implement the following:
    https://developer.github.com/v3/repos/releases/#create-a-release
    https://developer.github.com/v3/repos/releases/#edit-a-release
    https://developer.github.com/v3/repos/releases/#delete-a-release
    https://developer.github.com/v3/repos/releases/#list-assets-for-a-release
    https://developer.github.com/v3/repos/releases/#upload-a-release-asset
    https://developer.github.com/v3/repos/releases/#get-a-single-release-asset
    https://developer.github.com/v3/repos/releases/#edit-a-release-asset
    https://developer.github.com/v3/repos/releases/#delete-a-release-asset
-}