timechimp.api.project_tasks package

Module contents

timechimp.api.project_tasks.create(project_task: dict, version: str = '1', to_json: bool = False) → Union[requests.models.Response, dict]

Create a new project task entry

Parameters

  • project_task – the JSON representation of the project task entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project task requests response object

timechimp.api.project_tasks.delete(project_task_id: int, version: str = '1', to_json: bool = False) → Union[requests.models.Response, dict]

Delete a project task entry by id

Parameters

  • project_task_id – the JSON representation of the project task entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project task requests response object

timechimp.api.project_tasks.get_all(version: str = '1', params: Optional[dict] = None, to_json: bool = False) → Union[requests.models.Response, List[dict]]

Get all project tasks

Parameters

  • version – the version of the endpoint to use

  • params – the query parameters

  • to_json – convert the request response to a json object

Returns

TimeChimp project tasks requests response object

timechimp.api.project_tasks.get_by_id(project_task_id: int, version: str = '1', to_json: bool = False) → Union[requests.models.Response, dict]

Get a project task by id

Parameters

  • version – the version of the endpoint to use

  • project_task_id – the unique id of the project task

  • to_json – convert the request response to a json object

Returns

TimeChimp project tasks requests response object

timechimp.api.project_tasks.get_by_project(project_id: int, version: str = '1', to_json: bool = False) → Union[requests.models.Response, List[dict]]

Get the project tasks by project

Parameters

  • version – the version of the endpoint to use

  • project_id – the unique id of the project

  • to_json – convert the request response to a json object

Returns

TimeChimp project tasks requests response object

timechimp.api.project_tasks.get_by_task(task_id: int, version: str = '1', to_json: bool = False) → Union[requests.models.Response, List[dict]]

Get the project tasks by task

Parameters

  • version – the version of the endpoint to use

  • task_id – the unique id of the task

  • to_json – convert the request response to a json object

Returns

TimeChimp project tasks requests response object

timechimp.api.project_tasks.update(project_task: dict, version: str = '1', to_json: bool = False) → Union[requests.models.Response, dict]

Import project tasks from TimeChimp

Parameters

  • version – the version of the endpoint to use

  • project_task – the dict containing the new project tasks properties values

  • to_json – convert the request response to a json object

Returns

TimeChimp project tasks requests response object