Enhance Notification Management with New Endpoints and Response Structures

- Added new endpoints for retrieving notifications for both admins and users, improving the flexibility of the notification system.
- Implemented query parameters for filtering notifications by status, method, event type, type, and recipient, enhancing usability.
- Introduced new response structures for notifications, including pagination information, to provide better data handling in API responses.
- Updated API documentation with Swagger comments for the new endpoints and response formats, ensuring clarity for API consumers.
- Refactored notification handling logic to support the new features, promoting a more robust notification management system.

internal/notification/handler.go

@@ -4,6 +4,7 @@ import (
 	"github.com/asaskevich/govalidator"
 	"github.com/labstack/echo/v4"
 
+	"tm/internal/user"
 	"tm/pkg/logger"
 	"tm/pkg/response"
 )
@@ -32,6 +33,7 @@ func NewHandler(service Service, logger logger.Logger) *NotificationHandler {
 // @Success 201 {object} response.APIResponse "Notification created successfully"
 // @Failure 400 {object} response.APIResponse
 // @Failure 500 {object} response.APIResponse
+// @Security BearerAuth
 // @Router /admin/v1/notifications [post]
 func (h *NotificationHandler) Send(c echo.Context) error {
 	var req NotificationRequest
@@ -49,3 +51,151 @@ func (h *NotificationHandler) Send(c echo.Context) error {
 
 	return response.Created(c, nil, "Notification sent successfully")
 }
+
+// GetNotifications gets notifications
+// @Summary Get notifications
+// @Description Get notifications
+// @Tags Admin-Notification
+// @Accept json
+// @Produce json
+// @Param status query string false "Status filter"
+// @Param method query string false "Method filter"
+// @Param event_type query string false "Event type filter"
+// @Param type query string false "Type filter"
+// @Param recipient query string false "Recipient filter"
+// @Param limit query int false "Limit results"
+// @Param offset query int false "Offset results"
+// @Param sort_by query string false "Sort field"
+// @Param sort_order query string false "Sort order"
+// @Success 200 {object} response.APIResponse{data=NotificationListResponse}
+// @Failure 401 {object} response.APIResponse
+// @Failure 403 {object} response.APIResponse
+// @Failure 400 {object} response.APIResponse
+// @Failure 500 {object} response.APIResponse
+// @Security BearerAuth
+// @Router /admin/v1/notifications [get]
+func (h *NotificationHandler) GetNotifications(c echo.Context) error {
+	form, err := response.Parse[SearchForm](c)
+	if err != nil {
+		return response.BadRequest(c, "Invalid request format", err.Error())
+	}
+
+	// Validate form
+	if _, err := govalidator.ValidateStruct(form); err != nil {
+		return response.ValidationError(c, err.Error(), "")
+	}
+
+	pagination := response.NewPagination(c)
+
+	// Call service
+	notifications, err := h.service.GetNotifications(c.Request().Context(), form, pagination)
+	if err != nil {
+		return response.InternalServerError(c, "Failed to get notifications")
+	}
+
+	return response.Success(c, notifications, "Notifications retrieved successfully")
+}
+
+// MyAdminNotifications gets notifications for the admin
+// @Summary Get notifications for the admin
+// @Description Get notifications for the admin
+// @Tags Admin-Notification
+// @Accept json
+// @Produce json
+// @Param status query string false "Status filter"
+// @Param method query string false "Method filter"
+// @Param event_type query string false "Event type filter"
+// @Param type query string false "Type filter"
+// @Param recipient query string false "Recipient filter"
+// @Param limit query int false "Limit results"
+// @Param offset query int false "Offset results"
+// @Param sort_by query string false "Sort field"
+// @Param sort_order query string false "Sort order"
+// @Success 200 {object} response.APIResponse{data=NotificationListResponse}
+// @Failure 401 {object} response.APIResponse
+// @Failure 403 {object} response.APIResponse
+// @Failure 400 {object} response.APIResponse
+// @Failure 500 {object} response.APIResponse
+// @Security BearerAuth
+// @Router /admin/v1/notifications/my [get]
+func (h *NotificationHandler) AdminNotifications(c echo.Context) error {
+	userID, err := user.GetUserIDFromContext(c)
+	if err != nil {
+		return response.BadRequest(c, "User ID required", "User must be associated with a user")
+	}
+
+	form, err := response.Parse[SearchForm](c)
+	if err != nil {
+		return response.BadRequest(c, "Invalid request format", err.Error())
+	}
+
+	// Validate form
+	if _, err := govalidator.ValidateStruct(form); err != nil {
+		return response.ValidationError(c, err.Error(), "")
+	}
+
+	form.Recipient = userID
+	form.Status = "sent"
+
+	pagination := response.NewPagination(c)
+
+	// Call service
+	notifications, err := h.service.GetNotifications(c.Request().Context(), form, pagination)
+	if err != nil {
+		return response.InternalServerError(c, "Failed to get notifications")
+	}
+
+	return response.Success(c, notifications, "Notifications retrieved successfully")
+}
+
+// MyNotifications gets notifications for the user
+// @Summary Get notifications for the user
+// @Description Get notifications for the user
+// @Tags Notification
+// @Accept json
+// @Produce json
+// @Param status query string false "Status filter"
+// @Param method query string false "Method filter"
+// @Param event_type query string false "Event type filter"
+// @Param type query string false "Type filter"
+// @Param recipient query string false "Recipient filter"
+// @Param limit query int false "Limit results"
+// @Param offset query int false "Offset results"
+// @Param sort_by query string false "Sort field"
+// @Param sort_order query string false "Sort order"
+// @Success 200 {object} response.APIResponse{data=NotificationListResponse}
+// @Failure 401 {object} response.APIResponse
+// @Failure 403 {object} response.APIResponse
+// @Failure 400 {object} response.APIResponse
+// @Failure 500 {object} response.APIResponse
+// @Security BearerAuth
+// @Router /api/v1/notifications/my [get]
+func (h *NotificationHandler) CustomerNotifications(c echo.Context) error {
+	userID, err := user.GetUserIDFromContext(c)
+	if err != nil {
+		return response.BadRequest(c, "User ID required", "User must be associated with a user")
+	}
+
+	form, err := response.Parse[SearchForm](c)
+	if err != nil {
+		return response.BadRequest(c, "Invalid request format", err.Error())
+	}
+
+	// Validate form
+	if _, err := govalidator.ValidateStruct(form); err != nil {
+		return response.ValidationError(c, err.Error(), "")
+	}
+
+	form.Recipient = userID
+	form.Status = "sent"
+
+	pagination := response.NewPagination(c)
+
+	// Call service
+	notifications, err := h.service.GetNotifications(c.Request().Context(), form, pagination)
+	if err != nil {
+		return response.InternalServerError(c, "Failed to get notifications")
+	}
+
+	return response.Success(c, notifications, "Notifications retrieved successfully")
+}