Skip to main content

nexla_sdk.resources.notifications

Classes​

NotificationsResource​

Defined in nexla_sdk/resources/notifications.py:13

Resource for managing notifications.

Methods:

  • create_channel_setting(self, data: nexla_sdk.models.notifications.requests.NotificationChannelSettingCreate) -> nexla_sdk.models.notifications.responses.NotificationChannelSetting
    • Source: nexla_sdk/resources/notifications.py:185
    • Create notification channel setting.
  • create_setting(self, data: nexla_sdk.models.notifications.requests.NotificationSettingCreate) -> nexla_sdk.models.notifications.responses.NotificationSetting
    • Source: nexla_sdk/resources/notifications.py:271
    • Create notification setting.
  • delete(self, notification_id: int) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:34
    • Delete notification.
  • delete_all(self) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:77
    • Delete all notifications.
  • delete_channel_setting(self, setting_id: int) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:230
    • Delete notification channel setting.
  • delete_setting(self, setting_id: int) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:316
    • Delete notification setting.
  • get(self, notification_id: int, expand: bool = False) -> nexla_sdk.models.notifications.responses.Notification
    • Source: nexla_sdk/resources/notifications.py:21
    • Get single notification by ID.
  • get_channel_setting(self, setting_id: int) -> nexla_sdk.models.notifications.responses.NotificationChannelSetting
    • Source: nexla_sdk/resources/notifications.py:199
    • Get notification channel setting.
  • get_count(self, read: Optional[int] = None) -> nexla_sdk.models.notifications.responses.NotificationCount
    • Source: nexla_sdk/resources/notifications.py:87
    • Get notification count.
  • get_resource_settings(self, resource_type: str, resource_id: int, expand: bool = False, filter_overridden: bool = False, notification_type_id: Optional[int] = None) -> List[nexla_sdk.models.notifications.responses.NotificationSetting]
    • Source: nexla_sdk/resources/notifications.py:347
    • Get notification settings for a resource.
  • get_setting(self, setting_id: int) -> nexla_sdk.models.notifications.responses.NotificationSetting
    • Source: nexla_sdk/resources/notifications.py:285
    • Get notification setting.
  • get_settings_by_type(self, notification_type_id: int, expand: bool = False) -> List[nexla_sdk.models.notifications.responses.NotificationSetting]
    • Source: nexla_sdk/resources/notifications.py:329
    • Get notification settings for a type.
  • get_type(self, event_type: str, resource_type: str) -> nexla_sdk.models.notifications.responses.NotificationType
    • Source: nexla_sdk/resources/notifications.py:154
    • Get specific notification type.
  • get_types(self, status: Optional[str] = None) -> List[nexla_sdk.models.notifications.responses.NotificationType]
    • Source: nexla_sdk/resources/notifications.py:139
    • Get all notification types.
  • list(self, read: Optional[int] = None, level: Optional[str] = None, from_timestamp: Optional[int] = None, to_timestamp: Optional[int] = None, **kwargs) -> List[nexla_sdk.models.notifications.responses.Notification]
    • Source: nexla_sdk/resources/notifications.py:46
    • List notifications.
  • list_channel_settings(self) -> List[nexla_sdk.models.notifications.responses.NotificationChannelSetting]
    • Source: nexla_sdk/resources/notifications.py:174
    • List notification channel settings.
  • list_settings(self, event_type: Optional[str] = None, resource_type: Optional[str] = None, status: Optional[str] = None) -> List[nexla_sdk.models.notifications.responses.NotificationSetting]
    • Source: nexla_sdk/resources/notifications.py:244
    • List notification settings.
  • mark_read(self, notification_ids: Union[List[int], str]) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:102
    • Mark notifications as read.
  • mark_unread(self, notification_ids: Union[List[int], str]) -> Dict[str, Any]
    • Source: nexla_sdk/resources/notifications.py:120
    • Mark notifications as unread.
  • update_channel_setting(self, setting_id: int, data: nexla_sdk.models.notifications.requests.NotificationChannelSettingUpdate) -> nexla_sdk.models.notifications.responses.NotificationChannelSetting
    • Source: nexla_sdk/resources/notifications.py:213
    • Update notification channel setting.
  • update_setting(self, setting_id: int, data: nexla_sdk.models.notifications.requests.NotificationSettingUpdate) -> nexla_sdk.models.notifications.responses.NotificationSetting
    • Source: nexla_sdk/resources/notifications.py:299
    • Update notification setting.