timechimp.api.project_notes package

Module contents

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

Create a new project note entry

Parameters

  • project_note – the JSON representation of the project note entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project note requests response object

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

Delete a project note entry by id

Parameters

  • project_note_id – the JSON representation of the project note entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project note requests response object

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

Get all project notes

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 notes requests response object

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

Get a project note by id

Parameters

  • version – the version of the endpoint to use

  • project_note_id – the unique id of the project note

  • to_json – convert the request response to a json object

Returns

TimeChimp project notes requests response object

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

Get the project notes 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 notes requests response object

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

Import project notes from TimeChimp

Parameters

  • version – the version of the endpoint to use

  • project_note – the dict containing the new project notes properties values

  • to_json – convert the request response to a json object

Returns

TimeChimp project notes requests response object