flip_api.domain.interfaces.user
===============================

.. py:module:: flip_api.domain.interfaces.user


Classes
-------

.. autoapisummary::

   flip_api.domain.interfaces.user.IRoles
   flip_api.domain.interfaces.user.IUserProfileData
   flip_api.domain.interfaces.user.IRegisterUser
   flip_api.domain.interfaces.user.IUserResponse
   flip_api.domain.interfaces.user.IRegisterUserDto


Module Contents
---------------

.. py:class:: IRoles

   Bases: :py:obj:`pydantic.BaseModel`


   Model for user roles.


   .. py:attribute:: roles
      :type:  list[uuid.UUID]


.. py:class:: IUserProfileData

   Bases: :py:obj:`pydantic.BaseModel`


   Editable profile data stored by FLIP.


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: organisation
      :type:  str


.. py:class:: IRegisterUser

   Bases: :py:obj:`IUserProfileData`, :py:obj:`IRoles`


   Model for user data.


   .. py:attribute:: email
      :type:  pydantic.EmailStr


.. py:class:: IUserResponse

   Bases: :py:obj:`IRegisterUser`


   Model for user creation response.


   .. py:attribute:: user_id
      :type:  uuid.UUID


   .. py:attribute:: model_config


.. py:class:: IRegisterUserDto

   Bases: :py:obj:`pydantic.BaseModel`


   Data transfer object for registering a user.


   .. py:attribute:: user_id
      :type:  uuid.UUID


   .. py:attribute:: email
      :type:  pydantic.EmailStr


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: organisation
      :type:  str


   .. py:attribute:: roles
      :type:  list[uuid.UUID]