mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-18 20:01:52 +03:00
8d54187713
# Description Please include a summary of the changes and the related issue. Please also include relevant motivation and context. ## Checklist before requesting a review Please delete options that are not relevant. - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my code - [ ] I have commented hard-to-understand areas - [ ] I have ideally added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] Any dependent changes have been merged ## Screenshots (if appropriate): --------- Co-authored-by: Stan Girard <girard.stanislas@gmail.com>
63 lines
1.4 KiB
Python
63 lines
1.4 KiB
Python
from abc import ABC, abstractmethod
|
|
from uuid import UUID
|
|
|
|
from modules.user.dto.inputs import UserUpdatableProperties
|
|
from modules.user.entity.user_identity import UserIdentity
|
|
|
|
|
|
class UsersInterface(ABC):
|
|
@abstractmethod
|
|
def create_user_identity(self, id: UUID) -> UserIdentity:
|
|
"""
|
|
Create a user identity
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def update_user_properties(
|
|
self,
|
|
user_id: UUID,
|
|
user_identity_updatable_properties: UserUpdatableProperties,
|
|
) -> UserIdentity:
|
|
"""
|
|
Update the user properties
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_user_identity(self, user_id: UUID) -> UserIdentity:
|
|
"""
|
|
Get the user identity
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_user_id_by_user_email(self, email: str) -> UUID | None:
|
|
"""
|
|
Get the user id by user email
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_user_email_by_user_id(self, user_id: UUID) -> str:
|
|
"""
|
|
Get the user email by user id
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def delete_user_data(self, user_id: str):
|
|
"""
|
|
Delete a user.
|
|
|
|
- `user_id`: The ID of the user to delete.
|
|
|
|
This endpoint deletes a user from the system.
|
|
"""
|
|
@abstractmethod
|
|
def get_user_credits(self, user_id: UUID) -> int:
|
|
"""
|
|
Get user remaining credits
|
|
"""
|
|
pass
|