TodosApi API

The todosApi module of the @codebolt/plugin-sdk.

import plugin from '@codebolt/plugin-sdk';

Quick Reference

Method	Description
archiveThread
bulkCreate
create
createThread
delete
deleteAllCompleted
exportTodos
get
getAll
getStats
getThreads
importTodos
unarchiveThread
update

Methods

---

archiveThread

plugin.todosApi.archiveThread(threadId: string): Promise<void>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<void>

Full reference →

---

bulkCreate

plugin.todosApi.bulkCreate(data: BulkCreateTodosRequest): Promise<TodoItem[]>

Parameter	Type	Required	Description
data	BulkCreateTodosRequest	Yes

Returns: Promise<TodoItem[]>

Full reference →

---

create

plugin.todosApi.create(data: CreateTodoRequest): Promise<TodoItem>

Parameter	Type	Required	Description
data	CreateTodoRequest	Yes

Returns: Promise<TodoItem>

Full reference →

---

createThread

plugin.todosApi.createThread(data: CreateTodoThreadRequest): Promise<TodoList>

Parameter	Type	Required	Description
data	CreateTodoThreadRequest	Yes

Returns: Promise<TodoList>

Full reference →

---

delete

plugin.todosApi.delete(todoId: string): Promise<void>

Parameter	Type	Required	Description
todoId	string	Yes

Returns: Promise<void>

Full reference →

---

deleteAllCompleted

plugin.todosApi.deleteAllCompleted(params?: TodoListParams): Promise<void>

Parameter	Type	Required	Description
params	TodoListParams	No

Returns: Promise<void>

Full reference →

---

exportTodos

plugin.todosApi.exportTodos(params?: TodoExportParams): Promise<unknown>

Parameter	Type	Required	Description
params	TodoExportParams	No

Returns: Promise<unknown>

Full reference →

---

get

plugin.todosApi.get(todoId: string): Promise<TodoItem>

Parameter	Type	Required	Description
todoId	string	Yes

Returns: Promise<TodoItem>

Full reference →

---

getAll

plugin.todosApi.getAll(params?: TodoListParams): Promise<TodoItem[]>

Parameter	Type	Required	Description
params	TodoListParams	No

Returns: Promise<TodoItem[]>

Full reference →

---

getStats

plugin.todosApi.getStats(params?: TodoListParams): Promise<TodoStats>

Parameter	Type	Required	Description
params	TodoListParams	No

Returns: Promise<TodoStats>

Full reference →

---

getThreads

plugin.todosApi.getThreads(): Promise<TodoList[]>

No parameters.

Returns: Promise<TodoList[]>

Full reference →

---

importTodos

plugin.todosApi.importTodos(data: ImportTodosRequest): Promise<TodoItem[]>

Parameter	Type	Required	Description
data	ImportTodosRequest	Yes

Returns: Promise<TodoItem[]>

Full reference →

---

unarchiveThread

plugin.todosApi.unarchiveThread(threadId: string): Promise<void>

Parameter	Type	Required	Description
threadId	string	Yes

Returns: Promise<void>

Full reference →

---

update

plugin.todosApi.update(todoId: string, data: UpdateTodoRequest): Promise<TodoItem>

Parameter	Type	Required	Description
todoId	string	Yes
data	UpdateTodoRequest	Yes

Returns: Promise<TodoItem>

Full reference →