roboto.domain.users.record

Module Contents

class roboto.domain.users.record.UserRecord(/, **data)

Bases: pydantic.BaseModel

A wire-transmissible representation of a user.

Parameters:

data (Any)

is_comment_mentions_enabled()

Return type:

bool

is_email_notifications_enabled()

Return type:

bool

is_service_user: bool = False

Whether this is a service user for automated operations.

Service users can be used to perform actions on behalf of customers. For example, a service user can be associated with a Trigger, which will then invoke its corresponding Action as the service user.

is_system_user: bool | None = False

Whether this is a system user for internal platform operations.

name: str | None = None

Human-readable display name for the user.

notification_channels_enabled: dict[roboto.notifications.NotificationChannel, bool] = None

Mapping of notification channels to their enabled/disabled status.

notification_types_enabled: dict[roboto.notifications.NotificationType, bool] = None

Mapping of notification types to their enabled/disabled status.

picture_url: str | None = None

URL to the user’s profile picture.

user_id: str

Unique identifier for the user, typically an email address.