| Safe Haskell | None |
|---|
Leankit.Api
Contents
- getBoards :: Credentials -> IO [BoardShort]
- getBoardsMaybe :: Credentials -> IO (Maybe [BoardShort])
- getBoardsEither :: Credentials -> IO (Either String [BoardShort])
- getBoard :: Credentials -> BoardID -> IO Board
- getBoardMaybe :: Credentials -> BoardID -> IO (Maybe Board)
- getBoardEither :: Credentials -> BoardID -> IO (Either String Board)
- getCard :: Credentials -> BoardID -> CardID -> IO Card
- getCardMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe Card)
- getCardEither :: Credentials -> BoardID -> CardID -> IO (Either String Card)
- getBoardIdentifiers :: Credentials -> BoardID -> IO BoardIdentifierSet
- getBoardIdentifiersMaybe :: Credentials -> BoardID -> IO (Maybe BoardIdentifierSet)
- getBoardIdentifiersEither :: Credentials -> BoardID -> IO (Either String BoardIdentifierSet)
- getNewerIfExists :: Credentials -> BoardID -> Int -> IO (Maybe Board)
- getNewerIfExistsMaybe :: Credentials -> BoardID -> Int -> IO (Maybe Board)
- getNewerIfExistsEither :: Credentials -> BoardID -> Int -> IO (Either String Board)
- getBoardHistorySince :: Credentials -> BoardID -> Int -> IO [BoardHistoryItem]
- getBoardHistorySinceMaybe :: Credentials -> BoardID -> Int -> IO (Maybe [BoardHistoryItem])
- getBoardHistorySinceEither :: Credentials -> BoardID -> Int -> IO (Either String [BoardHistoryItem])
- getCardByExternalId :: Credentials -> BoardID -> String -> IO Card
- getCardByExternalIdMaybe :: Credentials -> BoardID -> String -> IO (Maybe Card)
- getCardByExternalIdEither :: Credentials -> BoardID -> String -> IO (Either String Card)
- getBackLog :: Credentials -> BoardID -> IO [Lane]
- getBackLogMaybe :: Credentials -> BoardID -> IO (Maybe [Lane])
- getBackLogEither :: Credentials -> BoardID -> IO (Either String [Lane])
- getArchive :: Credentials -> BoardID -> IO [LaneLayout]
- getArchiveMaybe :: Credentials -> BoardID -> IO (Maybe [LaneLayout])
- getArchiveEither :: Credentials -> BoardID -> IO (Either String [LaneLayout])
- getCardHistory :: Credentials -> BoardID -> CardID -> IO [CardHistoryItem]
- getCardHistoryMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe [CardHistoryItem])
- getCardHistoryEither :: Credentials -> BoardID -> CardID -> IO (Either String [CardHistoryItem])
- getCardComments :: Credentials -> BoardID -> CardID -> IO [CardComment]
- getCardCommentsMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe [CardComment])
- getCardCommentsEither :: Credentials -> BoardID -> CardID -> IO (Either String [CardComment])
- data Credentials = Credentials String String String
How to use this library
This is a thin read-only library for Leankit API. It's using curl for network and
Getting all the boards:
import Leankit.Api import Leankit.Types.Common let c = Credentials "myaccount" "username" "password" getBoardEither c $ BoardID 12345
getBoards
API functions for : http://myaccount.leankit.com/Api/Boards
getBoards :: Credentials -> IO [BoardShort]Source
getBoardsMaybe :: Credentials -> IO (Maybe [BoardShort])Source
getBoardsEither :: Credentials -> IO (Either String [BoardShort])Source
getBoard
API functions for : http://myaccount.leankit.com/Api/Boards/{boardId}
getBoardMaybe :: Credentials -> BoardID -> IO (Maybe Board)Source
getBoardEither :: Credentials -> BoardID -> IO (Either String Board)Source
getCard
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/GetCard/{cardId}
getCardMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe Card)Source
getCardEither :: Credentials -> BoardID -> CardID -> IO (Either String Card)Source
getBoardIdentifiers
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/GetBoardIdentifiers
getNewerIfExists
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/BoardVersion{version}GetNewerIfExists
getNewerIfExists :: Credentials -> BoardID -> Int -> IO (Maybe Board)Source
getNewerIfExistsMaybe :: Credentials -> BoardID -> Int -> IO (Maybe Board)Source
getNewerIfExistsEither :: Credentials -> BoardID -> Int -> IO (Either String Board)Source
getBoardHistorySince
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/BoardVersion{version}GetBoardHistorySince
getBoardHistorySince :: Credentials -> BoardID -> Int -> IO [BoardHistoryItem]Source
getBoardHistorySinceMaybe :: Credentials -> BoardID -> Int -> IO (Maybe [BoardHistoryItem])Source
getBoardHistorySinceEither :: Credentials -> BoardID -> Int -> IO (Either String [BoardHistoryItem])Source
getCardByExternalId
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/GetCardByExternalId/BZ123
getCardByExternalId :: Credentials -> BoardID -> String -> IO CardSource
getCardByExternalIdMaybe :: Credentials -> BoardID -> String -> IO (Maybe Card)Source
getCardByExternalIdEither :: Credentials -> BoardID -> String -> IO (Either String Card)Source
getBackLog
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/Backlog
getBackLog :: Credentials -> BoardID -> IO [Lane]Source
getBackLogMaybe :: Credentials -> BoardID -> IO (Maybe [Lane])Source
getBackLogEither :: Credentials -> BoardID -> IO (Either String [Lane])Source
getArchive
API functions for : http://myaccount.leankit.com/Api/Board/{boardId}/Archive
getArchive :: Credentials -> BoardID -> IO [LaneLayout]Source
getArchiveMaybe :: Credentials -> BoardID -> IO (Maybe [LaneLayout])Source
getArchiveEither :: Credentials -> BoardID -> IO (Either String [LaneLayout])Source
getCardHistory
API functions for : http://myaccount.leankit.com/Api/Card/History/{boardId}/{cardId}
getCardHistory :: Credentials -> BoardID -> CardID -> IO [CardHistoryItem]Source
getCardHistoryMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe [CardHistoryItem])Source
getCardHistoryEither :: Credentials -> BoardID -> CardID -> IO (Either String [CardHistoryItem])Source
getCardComments
API functions for : http://myaccount.leankit.com/Api/Card/GetComments/{boardId}/{cardId}
getCardComments :: Credentials -> BoardID -> CardID -> IO [CardComment]Source
getCardCommentsMaybe :: Credentials -> BoardID -> CardID -> IO (Maybe [CardComment])Source
getCardCommentsEither :: Credentials -> BoardID -> CardID -> IO (Either String [CardComment])Source
Credentials
This symbol is defined as Credentials