time_entry_api module

class time_entry_api.TimeEntryApi(key: str)

Bases: clockify.wrapper.Wrapper

add_time_entry(workspace_id: str, user_id: str, time_entry: clockify.model.time_entry_model.CreateTimeEntryDTO) → clockify.model.time_entry_model.TimeEntry

Add new TimeEntry and return it as a TimeEntry object.

Parameters

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

  • user_id (str) – ID of the clockify user.

  • time_entry (CreateTimeEntryDTO) – TimeEntry to create.

Returns

Added TimeEntry object.

Return type

TimeEntry

get_time_entries(workspace_id: str, user_id: str, params: clockify.model.time_entry_model.TimeEntryGetParams = TimeEntryGetParams(description=None, start=None, end=None, project=None, task=None, tags=None, project_required=None, task_required=None, hydrated=None, in_progress=None, page=1, page_size=50)) → List[clockify.model.time_entry_model.TimeEntry]

Return list of TimeEntry object.

Parameters

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

  • user_id (str) – ID of the clockify user.

  • params (TimeEntryGetParams, optional) – Path params. Defaults to TimeEntryGetParams().

Returns

List of TimeEntry objects.

Return type

List[TimeEntry]

get_time_entry(workspace_id: str, time_entry_id: str) → clockify.model.time_entry_model.TimeEntry

Return one TimeEntry object

Parameters

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

  • time_entry_id (str) – ID of the clockify time-entry.

Returns

TimeEntry object.

Return type

TimeEntry