roboto.notifications

Submodules

Package Contents

EmailLifecycleStatus

class roboto.notifications.EmailLifecycleStatus#

Bases: roboto.compat.StrEnum

Notification email lifecycle status enum

Attributes

EmailLifecycleStatus.Bounce

Bounce = 'Bounce' #

EmailLifecycleStatus.Click

Click = 'Click' #

EmailLifecycleStatus.Complaint

Complaint = 'Complaint' #

EmailLifecycleStatus.Delivery

Delivery = 'Delivery' #

EmailLifecycleStatus.DeliveryDelay

DeliveryDelay = 'DeliveryDelay' #

EmailLifecycleStatus.Failed

Failed = 'Failed' #

EmailLifecycleStatus.Initiated

Initiated = 'Initiated' #

EmailLifecycleStatus.Open

Open = 'Open' #

EmailLifecycleStatus.Reject

Reject = 'Reject' #

EmailLifecycleStatus.RenderingFailure

RenderingFailure = 'RenderingFailure' #

EmailLifecycleStatus.Send

Send = 'Send' #

EmailLifecycleStatus.Subscription

Subscription = 'Subscription' #

NotificationChannel

class roboto.notifications.NotificationChannel#

Bases: roboto.compat.StrEnum

Notification channel enum

Attributes

NotificationChannel.Email

Email = 'email' #

NotificationChannel.WebUi

WebUi = 'web_ui' #

NotificationRecord

class roboto.notifications.NotificationRecord(/, **data)#

Bases: pydantic.BaseModel, roboto.notifications.validator.LifecycleStatusValidator

A wire-transmissible representation of a notification.

Parameters

data Any

Attributes

NotificationRecord.channels

channels list[roboto.notifications.validator.NotificationChannel] = None #

NotificationRecord.created

created datetime.datetime #

NotificationRecord.lifecycle_status

lifecycle_status dict[roboto.notifications.validator.NotificationChannel, str] = None #

NotificationRecord.modified

modified datetime.datetime #

NotificationRecord.notification_id

notification_id str #

NotificationRecord.notification_type

notification_type roboto.notifications.validator.NotificationType #

NotificationRecord.notifier_id

notifier_id str #

NotificationRecord.org_id

org_id str #

NotificationRecord.read_status

read_status roboto.notifications.validator.ReadStatus #

NotificationRecord.user_id

user_id str #

NotificationType

class roboto.notifications.NotificationType#

Bases: roboto.compat.StrEnum

Notification type enum

Attributes

NotificationType.CommentMention

CommentMention = 'comment_mention' #

NotificationsClient

class roboto.notifications.NotificationsClient(http_client)#

Parameters

http_client roboto.http.HttpClient

NotificationsClient.batch_update_notifications()

batch_update_notifications(updates)#

Parameters

updates list[roboto.notifications.http_resources.UpdateNotificationRequest]

Return type

dict[str, Any]

NotificationsClient.delete_notification()

delete_notification(notification_id)#

Parameters

notification_id str

Return type

None

NotificationsClient.get_notifications()

get_notifications()#

Return type

dict[str, Any]

NotificationsClient.update_notification()

update_notification(notification_id, org_id=None, read_status=None, lifecycle_status=None)#

Parameters

notification_id str

org_id Optional[str]

read_status Optional[str]

lifecycle_status Optional[dict[roboto.notifications.record.NotificationChannel, str]]

Return type

Any

ReadStatus

class roboto.notifications.ReadStatus#

Bases: roboto.compat.StrEnum

Notification read status enum

Attributes

ReadStatus.Read

Read = 'read' #

ReadStatus.Unread

Unread = 'unread' #

UpdateNotificationRequest

class roboto.notifications.UpdateNotificationRequest(/, **data)#

Bases: pydantic.BaseModel, roboto.notifications.validator.LifecycleStatusValidator

Request payload to update a notification

Parameters

data Any

Attributes

UpdateNotificationRequest.lifecycle_status

lifecycle_status dict[roboto.notifications.record.NotificationChannel, str] | None = None #

UpdateNotificationRequest.notification_id

notification_id str #

UpdateNotificationRequest.read_status

read_status roboto.notifications.record.ReadStatus | None = None #

WebUiLifecycleStatus

class roboto.notifications.WebUiLifecycleStatus#

Bases: roboto.compat.StrEnum

Notification web ui status enum

Attributes

WebUiLifecycleStatus.Acknowledged

Acknowledged = 'Acknowledged' #