net.leanix.api

Class TodosApi

java.lang.Object

net.leanix.api.TodosApi

public class TodosApi
extends Object

Constructor Summary

Constructors

Constructor and Description
TodosApi()
TodosApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
TodoResponse	createTodo(TodoData body, UUID workspaceId) createTodo Saves a todo in the database
void	deleteTodo(UUID id, UUID workspaceId) deleteTodo deletes a todo item based on provided id.
ApiClient	getApiClient()
TodoResponse	getTodo(UUID id) getTodo Retrieves a todo by ID
TodoListResponse	getTodos(String type, String status, UUID factSheetId, UUID userId, UUID workspaceId, Boolean getArchived, Integer size, Integer page) getTodos Retrieves all todos a user can read.
void	setApiClient(ApiClient apiClient)
TodoResponse	updateTodo(UUID id, UUID workspaceId, TodoData body) updateTodo Updates a todo stored in the database.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TodosApi

public TodosApi()

TodosApi

public TodosApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createTodo

public TodoResponse createTodo(TodoData body,
                               UUID workspaceId)
                        throws ApiException

createTodo Saves a todo in the database

Parameters:

body - Creates a new Todo item (optional)

workspaceId - ID of the Workspace that the Todo shall be created in. (optional)

Returns:

TodoResponse

Throws:

ApiException - if fails to make API call

deleteTodo

public void deleteTodo(UUID id,
                       UUID workspaceId)
                throws ApiException

deleteTodo deletes a todo item based on provided id.

Parameters:

id - the id of the todo item (required)

workspaceId - the workspaceId in case that the SYSTEM deletes the todo (optional)

Throws:

ApiException - if fails to make API call

getTodo

public TodoResponse getTodo(UUID id)
                     throws ApiException

getTodo Retrieves a todo by ID

Parameters:

id - (required)

Returns:

TodoResponse

Throws:

ApiException - if fails to make API call

getTodos

public TodoListResponse getTodos(String type,
                                 String status,
                                 UUID factSheetId,
                                 UUID userId,
                                 UUID workspaceId,
                                 Boolean getArchived,
                                 Integer size,
                                 Integer page)
                          throws ApiException

getTodos Retrieves all todos a user can read.

Parameters:

type - Specifies the todo type (optional)

status - Specifies the todo status (optional)

factSheetId - Specifies the ID of the Fact Sheet the todo is connected to - only works with manual Todos (optional)

userId - Specify the user Id for the user to look for (optional)

workspaceId - Id of the workspace to get the TodoItems from. (optional)

getArchived - If set to true, then todos associated with archived factsheets are retrieved as well (optional, default to false)

size - Specifies the number of Todos to get, (optional, default to 10)

page - Specifies the page of Todos to get, (optional, default to 1)

Returns:

TodoListResponse

Throws:

ApiException - if fails to make API call

updateTodo

public TodoResponse updateTodo(UUID id,
                               UUID workspaceId,
                               TodoData body)
                        throws ApiException

updateTodo Updates a todo stored in the database.

Parameters:

id - (required)

workspaceId - ID of the Workspace that the Todo shall be updated in in case that the user is not assigned to one workspace (optional)

body - todo (optional)

Returns:

TodoResponse

Throws:

ApiException - if fails to make API call