module Gitlab::Client::Todos

Defines methods related to todos @see docs.gitlab.com/ce/api/todos.html

Public Instance Methods

mark_all_todos_as_done() click to toggle source

Marks all todos for the current user as done

@example

Gitlab.mark_all_todos_as_done

@return [void] This API call returns an empty response body.

# File lib/gitlab/client/todos.rb, line 42
def mark_all_todos_as_done
  post('/todos/mark_as_done')
end
mark_todo_as_done(id) click to toggle source

Marks a single pending todo for the current user as done.

@example

Gitlab.mark_todo_as_done(42)

@param [Integer] id The ID of the todo. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/todos.rb, line 32
def mark_todo_as_done(id)
  post("/todos/#{id}/mark_as_done")
end
todos(options = {}) click to toggle source

Gets a list of todos.

@example

Gitlab.todos
Gitlab.todos({ action: 'assigned' })
Gitlab.todos({ state: 'pending' })

@param [Hash] options A customizable set of options. @option options [Integer] :action The action to be filtered. Can be ‘assigned`, `mentioned`, `build_failed`, `marked`, or `approval_required`. @option options [Integer] :author_id The ID of an author @option options [Integer] :project_id The ID of a project @option options [Integer] :state The state of the todo. Can be either `pending` or `done` @option options [Integer] :type The type of a todo. Can be either `Issue` or `MergeRequest` @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/todos.rb, line 21
def todos(options = {})
  get('/todos', query: options)
end