Copyright	(c) Rob Stewart Heriot-Watt University 2021
License	BSD3
Maintainer	robstewart57@gmail.com
Stability	stable
Safe Haskell	None
Language	Haskell2010

GitLab.API.Boards

Description

Synopsis

projectIssueBoards :: Project -> GitLab [IssueBoard]
projectIssueBoards' :: Int -> GitLab (Either (Response ByteString) [IssueBoard])
projectIssueBoard :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
projectIssueBoard' :: Int -> Int -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
createIssueBoard :: Project -> Text -> GitLab (Maybe IssueBoard)
createIssueBoard' :: Int -> Text -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
updateIssueBoard' :: Int -> Int -> UpdateBoardAttrs -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
deleteIssueBoard :: Project -> IssueBoard -> GitLab (Either (Response ByteString) (Maybe ()))
deleteIssueBoard' :: Int -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
projectBoardLists :: Project -> IssueBoard -> GitLab [BoardIssue]
projectBoardLists' :: Int -> Int -> GitLab (Either (Response ByteString) [BoardIssue])
boardList :: Project -> IssueBoard -> Int -> GitLab (Maybe BoardIssue)
boardList' :: Int -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe BoardIssue))
createBoardList :: Project -> IssueBoard -> CreateBoardAttrs -> GitLab (Maybe BoardIssue)
createBoardList' :: Int -> Int -> CreateBoardAttrs -> GitLab (Either (Response ByteString) (Maybe BoardIssue))
reorderBoardList :: Project -> IssueBoard -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe BoardIssue))
reorderBoardList' :: Int -> Int -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe BoardIssue))
deleteBoardList :: Project -> IssueBoard -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
deleteBoardList' :: Int -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
data UpdateBoardAttrs = UpdateBoardAttrs {
- updateBoard_new_name :: Maybe String
- updateBoard_assignee_id :: Maybe Int
- updateBoard_milestone_id :: Maybe Int
- updateBoard_labels :: Maybe String
- updateBoard_weight :: Maybe Int
}
noUpdateBoardAttrs :: UpdateBoardAttrs
updateBoardAttrs :: UpdateBoardAttrs -> [GitLabParam]
data CreateBoardAttrs = CreateBoardAttrs {
- createBoard_label_id :: Maybe Int
- createBoard_assignee_id :: Maybe Int
- createBoard_milestone_id :: Maybe Int
}
noCreateBoardAttrs :: CreateBoardAttrs
createBoardAttrs :: CreateBoardAttrs -> [GitLabParam]

Documentation

projectIssueBoards Source #

Arguments

:: Project	the project
-> GitLab [IssueBoard]

returns all issue boards for a project.

projectIssueBoards' Source #

Arguments

:: Int	project ID
-> GitLab (Either (Response ByteString) [IssueBoard])

returns all issue boards for a project given its project ID.

projectIssueBoard Source #

Arguments

:: Project	the project
-> Int	the board ID
-> GitLab (Either (Response ByteString) (Maybe IssueBoard))

returns all issue boards for a project.

projectIssueBoard' Source #

Arguments

:: Int	the project ID
-> Int	the board ID
-> GitLab (Either (Response ByteString) (Maybe IssueBoard))

returns all issue boards for a project.

createIssueBoard Source #

Arguments

:: Project	the project
-> Text	board name
-> GitLab (Maybe IssueBoard)

Creates a project issue board.

createIssueBoard' Source #

Arguments

:: Int	the project ID
-> Text	board name
-> GitLab (Either (Response ByteString) (Maybe IssueBoard))

Creates a project issue board.

updateIssueBoard' Source #

Arguments

:: Int	the project ID
-> Int	the board ID
-> UpdateBoardAttrs	attributes for updating boards
-> GitLab (Either (Response ByteString) (Maybe IssueBoard))

Updates a project issue board.

deleteIssueBoard Source #

Arguments

:: Project	the project
-> IssueBoard	the board
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes a project issue board.

deleteIssueBoard' Source #

Arguments

:: Int	the project ID
-> Int	the board ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Deletes a project issue board.

projectBoardLists Source #

Arguments

:: Project	the project
-> IssueBoard	the board
-> GitLab [BoardIssue]

Get a list of the board’s lists. Does not include open and closed lists.

projectBoardLists' Source #

Arguments

:: Int	project ID
-> Int	board ID
-> GitLab (Either (Response ByteString) [BoardIssue])

Get a list of the board’s lists. Does not include open and closed lists.

boardList Source #

Arguments

:: Project	the project
-> IssueBoard	the board
-> Int	list ID
-> GitLab (Maybe BoardIssue)

Get a list of the board’s lists. Does not include open and closed lists.

boardList' Source #

Arguments

:: Int	project ID
-> Int	board ID
-> Int	list ID
-> GitLab (Either (Response ByteString) (Maybe BoardIssue))

Get a list of the board’s lists. Does not include open and closed lists.

createBoardList Source #

Arguments

:: Project	the project
-> IssueBoard	the board
-> CreateBoardAttrs	attributes for creating boards
-> GitLab (Maybe BoardIssue)

Creates a new issue board list.

createBoardList' Source #

Arguments

:: Int	project ID
-> Int	board ID
-> CreateBoardAttrs	attributes for creating the board
-> GitLab (Either (Response ByteString) (Maybe BoardIssue))

Creates a new issue board list.

reorderBoardList Source #

Arguments

:: Project	project
-> IssueBoard	board
-> Int	list ID
-> Int	the position of the list
-> GitLab (Either (Response ByteString) (Maybe BoardIssue))

Updates an existing issue board list. This call is used to change list position.

reorderBoardList' Source #

Arguments

:: Int	project ID
-> Int	board ID
-> Int	list ID
-> Int	the position of the list
-> GitLab (Either (Response ByteString) (Maybe BoardIssue))

Updates an existing issue board list. This call is used to change list position.

deleteBoardList Source #

Arguments

:: Project	project
-> IssueBoard	board
-> Int	list ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Only for administrators and project owners. Deletes a board list.

deleteBoardList' Source #

Arguments

:: Int	project ID
-> Int	board ID
-> Int	list ID
-> GitLab (Either (Response ByteString) (Maybe ()))

Only for administrators and project owners. Deletes a board list.

data UpdateBoardAttrs Source #

Constructors

UpdateBoardAttrs
Fields updateBoard_new_name :: Maybe String updateBoard_assignee_id :: Maybe Int updateBoard_milestone_id :: Maybe Int updateBoard_labels :: Maybe String updateBoard_weight :: Maybe Int

noUpdateBoardAttrs :: UpdateBoardAttrs Source #

no attributes for board update.

updateBoardAttrs :: UpdateBoardAttrs -> [GitLabParam] Source #

data CreateBoardAttrs Source #

exactly one parameter must be provided.

Constructors

CreateBoardAttrs
Fields createBoard_label_id :: Maybe Int createBoard_assignee_id :: Maybe Int createBoard_milestone_id :: Maybe Int

noCreateBoardAttrs :: CreateBoardAttrs Source #

no attributes for board creation.

createBoardAttrs :: CreateBoardAttrs -> [GitLabParam] Source #