NotificationService#

class NotificationService[source]#

Methods

get_all

Get all notifications for the current user.

patch_all

Update the read status of multiple notifications.

get_summary

Get a summary of the user's notifications.

patch

Update the read status for the given notification.

get_all(*, read=Nothing, page_size=20)[source]#

Get all notifications for the current user.

Parameters:
Returns:

A list of notifications.

Return type:

Response[NotificationCommentReplyNotificationAsJSON | NotificationGeneralFeedbackReplyNotificationAsJSON]

patch_all(json_body)[source]#

Update the read status of multiple notifications.

Parameters:
Returns:

The updated notifications in the same order as given in the body.

Return type:

Sequence[NotificationCommentReplyNotificationAsJSON | NotificationGeneralFeedbackReplyNotificationAsJSON]

get_summary()[source]#

Get a summary of the user’s notifications.

Provides a capped count of unread notifications for performance.

Returns:

A summary object with unread counts.

Parameters:

self (NotificationService[AuthenticatedClient]) –

Return type:

NotificationSummary

patch(json_body, *, notification_id)[source]#

Update the read status for the given notification.

Parameters:
Returns:

The updated notification.

Return type:

NotificationCommentReplyNotificationAsJSON | NotificationGeneralFeedbackReplyNotificationAsJSON