ucsschool.kelvin.client.base module

class ucsschool.kelvin.client.base.KelvinObject(*, name: Optional[str] = None, ucsschool_roles: Optional[List[str]] = None, udm_properties: Optional[Dict[str, Any]] = None, dn: Optional[str] = None, url: Optional[str] = None, session: Optional[Session] = None, language: Optional[str] = None, **kwargs)[source]

Bases: ABC

as_dict() → Dict[str, Any][source]
async delete() → None[source]
async reload() → KelvinObjectType[source]

Reload properties of object from the Kelvin API.

Raises:

ucsschool.kelvin.client.NoObject – if the object cannot be found

Returns:

self

async save() → KelvinObjectType[source]
class ucsschool.kelvin.client.base.KelvinResource(session: Session, language: Optional[str] = None)[source]

Bases: ABC

class Meta[source]

Bases: object

kelvin_object

alias of KelvinObject

required_get_attrs: Iterable[str] = ('name',)
required_head_attrs: Iterable[str] = ('name',)
required_search_attrs: Iterable[str] = ('school',)
async exists(**kwargs) → bool[source]
async get(**kwargs) → KelvinObjectType[source]
async get_from_url(url: str) → KelvinObjectType[source]
async search(**kwargs) → AsyncIterator[KelvinObjectType][source]