Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.domain.users.operations

Module Contents

CreateUserRequest

class roboto.domain.users.operations.CreateUserRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to create a new user.

Parameters

data Any

Attributes

CreateUserRequest.default_notification_channels

default_notification_channels list[roboto.notifications.NotificationChannel] | None #

Default notification channels to enable for the user.

CreateUserRequest.default_notification_types

default_notification_types list[roboto.notifications.NotificationType] | None #

Default notification types to enable for the user.

CreateUserRequest.is_service_user

is_service_user bool = False #

Whether this is a service user for automated operations.

CreateUserRequest.is_system_user

is_system_user bool = False #

Whether this is a system user for internal platform operations.

CreateUserRequest.name

name str | None = None #

Human-readable display name for the user.

CreateUserRequest.picture_url

picture_url str | None = None #

URL to the user’s profile picture.

CreateUserRequest.user_id

user_id str #

Unique identifier for the user, typically an email address.

UpdateUserRequest

class roboto.domain.users.operations.UpdateUserRequest(/, **data)#View Source

Bases: pydantic.BaseModel

Request payload to update an existing user.

Parameters

data Any

Attributes

UpdateUserRequest.name

name str | None = None #

Updated display name for the user.

UpdateUserRequest.notification_channels_enabled

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

Updated notification channel preferences.

UpdateUserRequest.notification_types_enabled

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

Updated notification type preferences.

UpdateUserRequest.picture_url

picture_url str | None = None #

Updated URL to the user’s profile picture.

UpdateUserRequest.validate_non_empty_string()

classmethod validate_non_empty_string(value, info)#View Source

Parameters

value Optional[str]
info pydantic.ValidationInfo

Return type

Optional[str]

Was this page helpful?