roboto.domain.users.record

Module Contents

UserRecord

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

Bases: pydantic.BaseModel

A wire-transmissible representation of a user.

Parameters

data Any

UserRecord.is_comment_mentions_enabled()

is_comment_mentions_enabled()#

Return type

bool

UserRecord.is_email_notifications_enabled()

is_email_notifications_enabled()#

Return type

bool

Attributes

UserRecord.is_service_user

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.

UserRecord.is_system_user

is_system_user bool | None = False #

Whether this is a system user for internal platform operations.

UserRecord.name

name str | None = None #

Human-readable display name for the user.

UserRecord.notification_channels_enabled

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

Mapping of notification channels to their enabled/disabled status.

UserRecord.notification_types_enabled

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

Mapping of notification types to their enabled/disabled status.

UserRecord.picture_url

picture_url str | None = None #

URL to the user’s profile picture.

UserRecord.user_id

user_id str #

Unique identifier for the user, typically an email address.