User Domain Schemas

Pydantic & Struct Data Transfer Objects (DTOs) for the Users sub-domain.

Utility Definitions

class RoleSlug(*values)

Bases: StrEnum

Available user role slugs.

SUPERUSER = 'superuser'

FITNESS_TRAINER = 'fitness-trainer'

class PasswordValidator

Bases: RegexValidator

Validator for user passwords.

—

User Information Models

class User(id: UUID, name: str | None, email: str, is_active: bool, is_superuser: bool, role_name: str, role_slug: str, created_at: datetime, updated_at: datetime)

Bases: CamelizedBaseStruct

User properties to use for a response.

id: UUID

name: str | None

email: str

is_active: bool

is_superuser: bool

role_name: str

role_slug: str

created_at: datetime

updated_at: datetime

class UserAuth(id: UUID, name: str | None, email: str, is_active: bool, is_superuser: bool, role_slug: str)

Bases: CamelizedBaseStruct

User model used for authentication context.

id: UUID

name: str | None

email: str

is_active: bool

is_superuser: bool

role_slug: str

—

User CRUD Models

class UserCreate

Bases: CamelizedBaseSchema

Properties required to create a new user.

Fields:

• email (pydantic.networks.EmailStr)

• is_active (bool)

• is_superuser (bool)

• name (str | None)

• password (str)

field name: str | None = None

field email: EmailStr [Required]

field password: Annotated[str, MinLen(min_length=3), MaxLen(max_length=20)] [Required]

Constraints:

• min_length = 3

• max_length = 20

field is_active: bool = True (alias 'isActive')

field is_superuser: bool = False (alias 'isSuperuser')

class UserUpdate

Bases: CamelizedBaseSchema

Data transfer object for optional user account updates.

Fields:

• email (pydantic.networks.EmailStr | None)

• is_active (bool | None)

• is_superuser (bool | None)

• name (str | None)

• password (str | None)

field name: str | None = None

field email: EmailStr | None = None

field password: Annotated[str, MinLen(min_length=3), MaxLen(max_length=20)] | None = None

field is_active: bool | None = None (alias 'isActive')

field is_superuser: bool | None = None (alias 'isSuperuser')

—

User Authentication Models

class AccountRegister

Bases: CamelizedBaseSchema

Information provided by a user during public registration.

Fields:

• confirm_password (str)

• email (pydantic.networks.EmailStr)

• name (str | None)

• password (str)

field name: str | None = None

field email: EmailStr [Required]

field password: Annotated[str, PasswordValidator] [Required]

field confirm_password: str [Required] (alias 'confirmPassword')

AccountRegister.check_passwords_match() → Self

Ensure the ‘password’ and ‘confirm_password’ fields match.

class PasswordUpdate

Bases: CamelizedBaseSchema

Input data for password rotation.

Fields:

• current_password (str)

• new_password (str)

field current_password: str [Required] (alias 'currentPassword')

field new_password: Annotated[str, PasswordValidator] [Required] (alias 'newPassword')

—

Role Management Models

class UserRoleAdd

Bases: CamelizedBaseSchema

Payload for granting a specific role to a user.

Fields:

• role_slug (app.domain.users.schemas.RoleSlug)

field role_slug: RoleSlug [Required] (alias 'roleSlug')

class UserRoleRevoke

Bases: UserRoleAdd

Payload for revoking a specific role from a user.

field role_slug: RoleSlug [Required] (alias 'roleSlug')