module Gitlab::Client::GroupBoards

def create_group_board(group, name)

Returns:
  • (Gitlab::ObjectifiedHash) - Information about created group issue board.

Parameters:
  • name (String) -- The name of the new board.
  • group (Integer, String) -- The ID or name of a group. 
def create_group_board(group, name)
  body = { name: name }
  post("/groups/#{url_encode group}/boards", body: body)
end

def create_group_board_list(group, board_id, label_id)

Returns:
  • (Gitlab::ObjectifiedHash) - Information about created group issue board list.

Parameters:
  • label_id (Integer) -- The ID of a label.
  • board_id (Integer) -- The ID of the group issue board.
  • group (Integer, String) -- The ID or name of a group. 
def create_group_board_list(group, board_id, label_id)
  body = { label_id: label_id }
  post("/groups/#{url_encode group}/boards/#{board_id}/lists", body: body)
end

def delete_group_board(group, id)

Returns:
  • (void) - This API call returns an empty response body.

Parameters:
  • id (Integer) -- The ID of the issue board.
  • group (Integer, String) -- The ID or name of a group. 
def delete_group_board(group, id)
  delete("/groups/#{url_encode group}/boards/#{id}")
end

def delete_group_board_list(group, board_id, id)

Returns:
  • (void) - This API call returns an empty response body.

Parameters:
  • list_id (Integer) -- The ID of a boards list.
  • board_id (Integer) -- The ID of the group issue board.
  • group (Integer, String) -- The ID or name of a group. 
def delete_group_board_list(group, board_id, id)
  delete("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}")
end

def edit_group_board(group, id, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about updated group issue board.

Options Hash: (**options)
  • :weight(optional) (Integer) -- The weight range from 0 to 9, to which the board should be scoped to.
  • :labels(optional) (String) -- Comma-separated list of label names which the board should be scoped to.
  • :milestone_id(optional) (Integer) -- The milestone the board should be scoped to.
  • :assignee_id(optional) (Integer) -- The assignee the board should be scoped to.
  • :name(optional) (String) -- The new name of the board.

Parameters:
  • options (Hash) -- A customizable set of options.
  • id (Integer) -- The ID of the issue board.
  • group (Integer, String) -- The ID or name of a group. 
def edit_group_board(group, id, options = {})
  put("/groups/#{url_encode group}/boards/#{id}", body: options)
end

def edit_group_board_list(group, board_id, id, options = {})

Returns:
  • (Gitlab::ObjectifiedHash) - Information about updated group issue board list.

Options Hash: (**options)
  • :position(required) (String) -- The position of the list.

Parameters:
  • options (Hash) -- A customizable set of options.
  • list_id (Integer) -- The ID of a boards list.
  • board_id (Integer) -- The ID of the group issue board.
  • group (Integer, String) -- The ID or name of a group. 
def edit_group_board_list(group, board_id, id, options = {})
  put("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}", body: options)
end

def group_board(group, id)

Returns:
  • (Gitlab::ObjectifiedHash) - Returns information about a group issue board

Parameters:
  • id (Integer) -- The ID of the issue board.
  • group (Integer, String) -- The ID or name of a group. 
def group_board(group, id)
  get("/groups/#{url_encode group}/boards/#{id}")
end

def group_board_list(group, board_id, id)

Returns:
  • (Gitlab::ObjectifiedHash) - Returns information about a single group issue board list

Parameters:
  • list_id (Integer) -- The ID of a boards list.
  • board_id (Integer) -- The ID of the group issue board.
  • group (Integer, String) -- The ID or name of a group. 
def group_board_list(group, board_id, id)
  get("/groups/#{url_encode group}/boards/#{board_id}/lists/#{id}")
end

def group_board_lists(group, board_id)

Returns:
  • (Array) - List of boards lists of the group

Parameters:
  • board_id (Integer) -- The ID of the group issue board.
  • group (Integer, String) -- The ID or name of a group. 
def group_board_lists(group, board_id)
  get("/groups/#{url_encode group}/boards/#{board_id}/lists")
end

def group_boards(group)

Returns:
  • (Array) - List of issue boards of the group

Parameters:
  • group (Integer, String) -- The ID or name of a group. 
def group_boards(group)
  get("/groups/#{url_encode group}/boards")
end