Skip to content

Latest commit

 

History

History
62 lines (33 loc) · 2.03 KB

rest.rst

File metadata and controls

62 lines (33 loc) · 2.03 KB
Raw

REST Client Interface

auraxium.Client

count(type: type[auraxium.base.Ps2Object], **kwargs) -> int

find(type: type[auraxium.base.Ps2Object], results: int = 10, offset: int = 0, promote_exact: bool = False, check_case: bool = True, **kwargs) -> list[auraxium.base.Ps2Object]

get(type: type[auraxium.base.Ps2Object], check_case: bool = True, **kwargs) -> auraxium.base.Ps2Object | None

get_by_id(type: type[auraxium.base.Ps2Object], id: int) -> auraxium.base.Ps2Object | None

get_by_name(type: type[auraxium.base.Named], name: str, *, locale: str = 'en') -> auraxium.base.Named | None

latency() -> float

close() -> None

request(query: auraxium.census.Query, verb: str = 'get') -> auraxium.types.CensusData

Object Model Bases

auraxium.base

auraxium.base

Ps2Object

count(client: auraxium.Client, **kwargs) -> int

find(results: int = 10, , offset: int = 0, promote_exact: bool = False, check_case: bool = True, client: auraxium.Client,*kwargs) -> list[Ps2Object]

get(client: auraxium.Client, check_case: bool = True, **kwargs) -> Ps2Object | None

get_by_id(id: int, *, client: auraxium.Client) -> Ps2Object | None

query() -> auraxium.census.Query

Cached

alter_cache(size: int, ttu: float | None = None) -> None

get_by_id(id: int, *, client: auraxium.Client) -> Cached | None

Named

get_by_name(name: str, *, locale: str = 'en', client: auraxium.Client) -> Named | None

Proxy Objects

auraxium

InstanceProxy

resolve() -> auraxium.base.Ps2Object | None

SequenceProxy

flatten() -> list[auraxium.base.Ps2Object]