NotificationService

class NotificationService

Methods

get_all	Get all notifications for the current user.
patch_all	Update the read status of multiple notifications.
patch	Update the read status for the given notification.

get_all(*, has_unread=False, extra_parameters=None)

Get all notifications for the current user.

Parameters:

• has_unread (bool) – If considered true a short digest will be sent, i.e. a single object with one key has_unread with a boolean value. Please use this if you simply want to check if there are unread notifications.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (NotificationService[AuthenticatedClient]) –

Returns:

Either a list of notifications or a HasUnreadNotifcationJSON based on the has_unread query parameter.

Return type:

NotificationsJSON | HasUnreadNotifcationJSON

patch_all(json_body, *, extra_parameters=None)

Update the read status of multiple notifications.

Parameters:

• json_body (Union[dict, list, PatchAllNotificationData]) – The body of the request. See PatchAllNotificationData for information about the possible fields. You can provide this data as a PatchAllNotificationData or as a dictionary.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (NotificationService[AuthenticatedClient]) –

Returns:

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

Return type:

NotificationsJSON

patch(json_body, *, notification_id, extra_parameters=None)

Update the read status for the given notification.

Parameters:

• json_body (Union[dict, list, PatchNotificationData]) – The body of the request. See PatchNotificationData for information about the possible fields. You can provide this data as a PatchNotificationData or as a dictionary.

• notification_id (int) – The id of the notification to update.

• extra_parameters (Optional[Mapping[str, Union[str, bool, int, float]]]) – The extra query parameters you might want to add. By default no extra query parameters are added.

• self (NotificationService[AuthenticatedClient]) –

Returns:

The updated notification.

Return type:

NotificationCommentReplyNotificationAsJSON | NotificationGeneralFeedbackReplyNotificationAsJSON