task_api module

class task_api.TaskApi(key: str)

Bases: clockify.wrapper.Wrapper

create_task(workspace_id: str, task: clockify.model.task_model.Task) → clockify.model.task_model.Task

Create a task and return it as a Task object.

Parameters

• workspace_id (str) – ID of the clockify workspace.

• task (Task) – Task to create.

Returns

Created Task object.

Return type

Task

delete_task(workspace_id: str, project_id: str, task_id: str) → clockify.model.task_model.Task

Delete a task and return it as a Task object.

Parameters

• workspace_id (str) – ID of the clockify workspace.

• project_id (str) – ID of the clockify project.

• task_id (str) – ID of the clockify task.

Returns

Deleted Task object.

Return type

Task

get_task(workspace_id: str, project_id: str, task_id: str) → clockify.model.task_model.Task

Return one Task object

Parameters

• workspace_id (str) – ID of the clockify workspace.

• project_id (str) – ID of the clockify project.

• task_id (str) – ID of the clockify task.

Returns

Task object.

Return type

Task

get_tasks(workspace_id: str, project_id: str, params: clockify.model.task_model.TaskGetParams = TaskGetParams(is_active=None, name=None, page=1, page_size=50, strict_name_search=None, sort_column=None, sort_order=None)) → List[clockify.model.task_model.Task]

Get list of Task object.

Parameters

• workspace_id (str) – ID of the clockify workspace.

• project_id (str) – ID of the clockify project.

• params (TaskGetParams, optional) – Path parameters. Defaults to TaskGetParams().

Returns

List of Task objects.

Return type

List[Task]

update_task(workspace_id: str, task: clockify.model.task_model.Task) → clockify.model.task_model.Task

Update a task and return it as a Task object.

Parameters

• workspace_id (str) – ID of the clockify workspace.

• task (Task) – Task to update.

Returns

Updated Task object.

Return type

Task