Source code for pyairtable.models.collaborator

from typing import TypeAlias

from pyairtable.models._base import AirtableModel

UserId: TypeAlias = str


class Collaborator(AirtableModel):
    """
    Represents an Airtable user being passed from the API.

    This is only used in contexts involving other models (e.g. :class:`~pyairtable.models.Comment`).
    In contexts where API values are returned as ``dict``, we will return
    collaborator information as a ``dict`` as well.
    """

    #: Airtable's unique ID for the user, in the format ``usrXXXXXXXXXXXXXX``.
    id: UserId

    #: The email address of the user.
    email: str | None = None

    #: The display name of the user.
    name: str | None = None