roboto.notifications

Submodules

• roboto.notifications.http_client
• roboto.notifications.http_resources
• roboto.notifications.record
• roboto.notifications.validator

Package Contents

class roboto.notifications.EmailLifecycleStatus

Bases: str, enum.Enum

Notification email lifecycle status enum

Bounce = 'Bounce'

Click = 'Click'

Complaint = 'Complaint'

Delivery = 'Delivery'

DeliveryDelay = 'DeliveryDelay'

Failed = 'Failed'

Initiated = 'Initiated'

Open = 'Open'

Reject = 'Reject'

RenderingFailure = 'RenderingFailure'

Send = 'Send'

Subscription = 'Subscription'

class roboto.notifications.NotificationChannel

Bases: str, enum.Enum

Notification channel enum

Email = 'email'

WebUi = 'web_ui'

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

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

A wire-transmissible representation of a notification.

Parameters:

data (Any)

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

created: datetime.datetime

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

modified: datetime.datetime

notification_id: str

notification_type: roboto.notifications.validator.NotificationType

notifier_id: str

org_id: str

read_status: roboto.notifications.validator.ReadStatus

user_id: str

class roboto.notifications.NotificationType

Bases: str, enum.Enum

Notification type enum

CommentMention = 'comment_mention'

class roboto.notifications.NotificationsClient(http_client)

Parameters:

http_client (roboto.http.HttpClient)

batch_update_notifications(updates)

Parameters:

updates (list[roboto.notifications.http_resources.UpdateNotificationRequest])

Return type:

dict[str, Any]

delete_notification(notification_id)

Parameters:

notification_id (str)

Return type:

None

get_notifications()

Return type:

dict[str, Any]

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

class roboto.notifications.ReadStatus

Bases: str, enum.Enum

Notification read status enum

Read = 'read'

Unread = 'unread'

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

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

Request payload to update a notification

Parameters:

data (Any)

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

notification_id: str

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

class roboto.notifications.WebUiLifecycleStatus

Bases: str, enum.Enum

Notification web ui status enum

Acknowledged = 'Acknowledged'