mirror of
https://github.com/QuivrHQ/quivr.git
synced 2024-12-18 11:51:41 +03:00
0782df5e37
# Description - Notification module ## 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):
63 lines
1.6 KiB
Python
63 lines
1.6 KiB
Python
from abc import ABC, abstractmethod
|
|
from uuid import UUID
|
|
|
|
from modules.notification.dto.inputs import (
|
|
CreateNotificationProperties,
|
|
NotificationUpdatableProperties,
|
|
)
|
|
from modules.notification.dto.outputs import DeleteNotificationResponse
|
|
from modules.notification.entity.notification import Notification
|
|
|
|
|
|
class NotificationInterface(ABC):
|
|
@abstractmethod
|
|
def add_notification(
|
|
self, notification: CreateNotificationProperties
|
|
) -> Notification:
|
|
"""
|
|
Add a notification
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def update_notification_by_id(
|
|
self, notification_id: UUID, notification: NotificationUpdatableProperties
|
|
) -> Notification:
|
|
"""Update a notification by id"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def remove_notification_by_id(
|
|
self, notification_id: UUID
|
|
) -> DeleteNotificationResponse:
|
|
"""
|
|
Remove a notification by id
|
|
Args:
|
|
notification_id (UUID): The id of the notification
|
|
|
|
Returns:
|
|
str: Status message
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def remove_notifications_by_chat_id(self, chat_id: UUID) -> None:
|
|
"""
|
|
Remove all notifications for a chat
|
|
Args:
|
|
chat_id (UUID): The id of the chat
|
|
"""
|
|
pass
|
|
|
|
@abstractmethod
|
|
def get_notifications_by_chat_id(self, chat_id: UUID) -> list[Notification]:
|
|
"""
|
|
Get all notifications for a chat
|
|
Args:
|
|
chat_id (UUID): The id of the chat
|
|
|
|
Returns:
|
|
list[Notification]: The notifications
|
|
"""
|
|
pass
|