timechimp.api.tags package

Module contents

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

Create a new tag entry

Parameters

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

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp tag requests response object

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

Delete a tag entry by id

Parameters

  • tag_id – the JSON representation of the tag entry to create

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp tag requests response object

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

Get all tags

Parameters

  • version – the version of the endpoint to use

  • to_json – convert the request response to a json object

Returns

TimeChimp tags requests response object

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

Get a tag by id

Parameters

  • version – the version of the endpoint to use

  • tag_id – the unique id of the tag

  • to_json – convert the request response to a json object

Returns

TimeChimp tags requests response object

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

Update a tag

Parameters

  • version – the version of the endpoint to use

  • tag – the dict containing the new tags properties values

  • to_json – convert the request response to a json object

Returns

TimeChimp tags requests response object