project_api module

class project_api.ProjectApi(key: str)

Bases: clockify.wrapper.Wrapper

create_project(project: clockify.model.project_model.Project) → clockify.model.project_model.Project

Create one Project and return it as a Project object.

Parameters

project (Project) – Clockify Project to create.

Returns

Created Project object.

Return type

Project

delete_project(workspace_id: str, project_id: str) → clockify.model.project_model.Project

Delete a Project and return it as a Project object.

Parameters

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

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

Returns

Deleted Project object.

Return type

Project

get_project(workspace_id: str, project_id: str) → clockify.model.project_model.Project

Return one Project object.

Parameters

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

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

Returns

Project object.

Return type

Project

get_projects(workspace_id: str, params: clockify.model.project_model.ProjectGetParams = ProjectGetParams(hydrated=None, archived=None, name=None, page=1, page_size=50, billable=None, clients=None, contains_client=None, client_status=None, users=None, contains_users=None, user_status=None, is_template=None, sort_column=None, sort_order=None)) → List[clockify.model.project_model.Project]

Return list of Project objects.

Parameters

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

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

Returns

List of Project Objects

Return type

List[Project]

update_project(project: clockify.model.project_model.Project) → clockify.model.project_model.Project

Update a Project and return it as a Project object.

Parameters

project (Project) – Project to update.

Returns

Updated Project object.

Return type

Project