"""
Contains Kontaktweg class
"""
from typing import TYPE_CHECKING, Annotated, Literal, Optional
from pydantic import Field
from ..enum.comtyp import ComTyp
from ..utils import postprocess_docstring
from .com import COM
if TYPE_CHECKING:
from ..enum.kontaktart import Kontaktart
# pylint: disable=too-few-public-methods
[docs]
@postprocess_docstring
class Kontaktweg(COM):
"""
Die Komponente wird dazu verwendet, die Kontaktwege innerhalb des BOs Person darzustellen
.. raw:: html
<object data="../_static/images/bo4e/com/Kontakt.svg" type="image/svg+xml"></object>
.. HINT::
`Kontakt JSON Schema <https://json-schema.app/view/%23?url=https://raw.githubusercontent.com/BO4E/BO4E-Schemas/{__gh_version__}/src/bo4e_schemas/com/Kontakt.json>`_
"""
typ: Annotated[Literal[ComTyp.KONTAKTWEG], Field(alias="_typ")] = ComTyp.KONTAKTWEG
kontaktart: Optional["Kontaktart"] = None
"""Gibt die Kontaktart des Kontaktes an."""
beschreibung: Optional[str] = None
"""Spezifikation, beispielsweise "Durchwahl", "Sammelnummer" etc."""
kontaktwert: Optional[str] = None
"""Die Nummer oder E-Mail-Adresse."""
ist_bevorzugter_kontaktweg: Optional[bool] = None
"""Gibt an, ob es sich um den bevorzugten Kontaktweg handelt."""