UpdateableModule¶

class UpdateableModule(api)[source]¶

Bases: _JsonConvertibleModule

API for updating entities.

Parameters:

api¶

Api object to use for API connection.

Methods

update

Update an entity with the specified ID.

update(id, name=None, description=None)[source]¶

Update an entity with the specified ID.

Parameters:

id : int¶

ID of the entity to update.

name : str, optional¶

New name of the entity.

description : str, optional¶

New description of the entity.

Returns:

Entity with updated information.

Return type:

dict