Custom Types¶
Shared custom types and global type aliases.
- auraxium.types.CensusData: dict[str, str | int | float | CensusData | list[CensusData]]¶
Type alias for value types allowed in API requests.
- class auraxium.types.LocaleData(*, de=None, en=None, es=None, fr=None, it=None)¶
Container for localised strings.
Note that the
tr
locale is ignored as it was abandoned by the developers and is generally either missing or unpopulated.- classmethod empty()¶
Return an empty
LocaleData
instance.This is mostly provided to easily handle payloads who’s entire localised string field is NULL.
- model_fields = {'de': FieldInfo(annotation=Union[str, NoneType], required=False), 'en': FieldInfo(annotation=Union[str, NoneType], required=False), 'es': FieldInfo(annotation=Union[str, NoneType], required=False), 'fr': FieldInfo(annotation=Union[str, NoneType], required=False), 'it': FieldInfo(annotation=Union[str, NoneType], required=False)}¶
Metadata about the fields defined on the model, mapping of field names to [FieldInfo][pydantic.fields.FieldInfo].
This replaces Model.__fields__ from Pydantic V1.