timechimp.api.project_users package

Module contents

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

Create a new project user entry

Parameters

  • project_user – the JSON representation of the project user entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project user requests response object

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

Delete a project user entry by id

Parameters

  • project_user_id – the JSON representation of the project user entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project user requests response object

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

Get all project users

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

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

Get a project user by id

Parameters

  • version – the version of the endpoint to use

  • project_user_id – the unique id of the project user

  • to_json – convert the request response to a json object

Returns

TimeChimp project users requests response object

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

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

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

Get the project users by user

Parameters

  • version – the version of the endpoint to use

  • user_id – the unique id of the user

  • to_json – convert the request response to a json object

Returns

TimeChimp project users requests response object

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

Import project users from TimeChimp

Parameters

  • version – the version of the endpoint to use

  • project_user – the dict containing the new project users properties values

  • to_json – convert the request response to a json object

Returns

TimeChimp project users requests response object