timechimp.api.users package

Module contents

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

Get all the users

Parameters

• version – the version of the endpoint to use

• to_json – convert the request response to a json object

Returns

TimeChimp users requests response object

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

Get a user by id

Parameters

• user_id – the unique id of the user

• version – the version of the endpoint to use

• to_json – convert the request response to a json object

Returns

TimeChimp users requests response object

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

Update a user

Parameters

• user – the dict containing the new users properties values

• version – the version of the endpoint to use

• to_json – convert the request response to a json object

Returns

TimeChimp users requests response object