timechimp.api.projects package

Module contents

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

Create a new project entry

Parameters

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

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project requests response object

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

Delete a project entry by id

Parameters

  • project_id – the JSON representation of the project entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project requests response object

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

Get all the projects

Parameters

  • version – the version of the endpoint to use “2”, get also inactive projects

  • params – the query parameters

  • to_json – convert the request response to a json object

Returns

TimeChimp projects requests response object

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

Get the projects by customer

Parameters

  • customer_id – the unique id of the the customer

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project s requests response object

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

Get a project by id

Parameters

  • project_id – the unique id of the project

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project s requests response object

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

Get the projects by insight

Parameters

  • insight_id – the unique id of the

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp project s requests response object

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

Update a project

Parameters

  • version – the version of the endpoint to use

  • project – the dict containing the new project s properties values

  • to_json – convert the request response to a json object

Returns

TimeChimp project s requests response object