TodosApi
Class: TodosApi
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:23
Manages todos and todo threads in the CodeBolt platform.
Todos are task items that can be organized into threads for tracking work, features, bugs, and other development activities. This API provides full CRUD operations, bulk actions, statistics, and import/export capabilities for managing todo workflows.
Constructors
Constructor
new TodosApi(http: HttpClient): TodosApi;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:24
Parameters
| Parameter | Type |
|---|---|
http | HttpClient |
Returns
TodosApi
Methods
archiveThread()
archiveThread(threadId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:74
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<void>
bulkCreate()
bulkCreate(data: BulkCreateTodosRequest): Promise<TodoItem[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:54
Parameters
| Parameter | Type |
|---|---|
data | BulkCreateTodosRequest |
Returns
Promise<TodoItem[]>
create()
create(data: CreateTodoRequest): Promise<TodoItem>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:50
Parameters
| Parameter | Type |
|---|---|
data | CreateTodoRequest |
Returns
Promise<TodoItem>
createThread()
createThread(data: CreateTodoThreadRequest): Promise<TodoList>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:34
Parameters
| Parameter | Type |
|---|---|
data | CreateTodoThreadRequest |
Returns
Promise<TodoList>
delete()
delete(todoId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:66
Parameters
| Parameter | Type |
|---|---|
todoId | string |
Returns
Promise<void>
deleteAllCompleted()
deleteAllCompleted(params?: TodoListParams): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:70
Parameters
| Parameter | Type |
|---|---|
params? | TodoListParams |
Returns
Promise<void>
exportTodos()
exportTodos(params?: TodoExportParams): Promise<unknown>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:42
Parameters
| Parameter | Type |
|---|---|
params? | TodoExportParams |
Returns
Promise<unknown>
get()
get(todoId: string): Promise<TodoItem>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:46
Parameters
| Parameter | Type |
|---|---|
todoId | string |
Returns
Promise<TodoItem>
getAll()
getAll(params?: TodoListParams): Promise<TodoItem[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:26
Parameters
| Parameter | Type |
|---|---|
params? | TodoListParams |
Returns
Promise<TodoItem[]>
getStats()
getStats(params?: TodoListParams): Promise<TodoStats>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:38
Parameters
| Parameter | Type |
|---|---|
params? | TodoListParams |
Returns
Promise<TodoStats>
getThreads()
getThreads(): Promise<TodoList[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:30
Returns
Promise<TodoList[]>
importTodos()
importTodos(data: ImportTodosRequest): Promise<TodoItem[]>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:58
Parameters
| Parameter | Type |
|---|---|
data | ImportTodosRequest |
Returns
Promise<TodoItem[]>
unarchiveThread()
unarchiveThread(threadId: string): Promise<void>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:78
Parameters
| Parameter | Type |
|---|---|
threadId | string |
Returns
Promise<void>
update()
update(todoId: string, data: UpdateTodoRequest): Promise<TodoItem>;
Defined in: CodeBolt/packages/pluginSdk/src/api/todos.api.ts:62
Parameters
| Parameter | Type |
|---|---|
todoId | string |
data | UpdateTodoRequest |
Returns
Promise<TodoItem>