Zulip server and web application. Open-source team chat that helps teams stay productive and focused.
from typing import Annotated, Literal
from django.core.exceptions import ValidationError
from django.core.validators import URLValidator
from pydantic import AfterValidator, BaseModel, ConfigDict, Field
from zerver.lib.types import PropagateMode, UserGroupMembersDict
from zerver.models.realms import RealmExportSlug
def check_url(val: str) -> str:
try:
URLValidator()(val)
except ValidationError: # nocoverage
raise AssertionError(f"{val} is not a URL")
return val
Url = Annotated[str, AfterValidator(check_url)]
ReactionType = Literal["realm_emoji", "unicode_emoji", "zulip_extra_emoji"]
# BaseEventModel is the BaseModel for events
class BaseEventModel(BaseModel):
# An undeclared field is a schema bug; fail at construction rather
# than silently dropping it from the event clients receive.
model_config = ConfigDict(extra="forbid")
class BaseEvent(BaseEventModel):
pass
class AlertWordsEvent(BaseEvent):
type: Literal["alert_words"] = "alert_words"
alert_words: list[str]
class Attachment(BaseEventModel):
id: int
name: str
size: int
path_id: str
create_time: int
message_ids: list[int]
class AttachmentAddEvent(BaseEvent):
type: Literal["attachment"] = "attachment"
op: Literal["add"] = "add"
attachment: Attachment
upload_space_used: int
class AttachmentFieldForAttachmentRemoveEvent(BaseEventModel):
id: int
class AttachmentRemoveEvent(BaseEvent):
type: Literal["attachment"] = "attachment"
op: Literal["remove"] = "remove"
attachment: AttachmentFieldForAttachmentRemoveEvent
upload_space_used: int
class AttachmentUpdateEvent(BaseEvent):
type: Literal["attachment"] = "attachment"
op: Literal["update"] = "update"
attachment: Attachment
upload_space_used: int
class ChannelFolderForChannelFolderAddEvent(BaseEventModel):
id: int
name: str
description: str
rendered_description: str
order: int
date_created: int
creator_id: int | None
is_archived: bool
class ChannelFolderAddEvent(BaseEvent):
type: Literal["channel_folder"] = "channel_folder"
op: Literal["add"] = "add"
channel_folder: ChannelFolderForChannelFolderAddEvent
class ChannelFolderDataForUpdate(BaseEventModel):
# TODO: fix types to avoid optional fields
name: str | None = None
description: str | None = None
rendered_description: str | None = None
is_archived: bool | None = None
class ChannelFolderReorderEvent(BaseEvent):
type: Literal["channel_folder"] = "channel_folder"
op: Literal["reorder"] = "reorder"
order: list[int]
class ChannelFolderUpdateEvent(BaseEvent):
type: Literal["channel_folder"] = "channel_folder"
op: Literal["update"] = "update"
channel_folder_id: int
data: ChannelFolderDataForUpdate
class DetailedCustomProfileCore(BaseEventModel):
id: int
type: int
name: str
hint: str
field_data: str
order: int
required: bool
editable_by_user: bool
class DetailedCustomProfile(DetailedCustomProfileCore):
# TODO: fix types to avoid optional fields
display_in_profile_summary: bool | None = None
use_for_user_matching: bool | None = None
class CustomProfileFieldsEvent(BaseEvent):
type: Literal["custom_profile_fields"] = "custom_profile_fields"
fields: list[DetailedCustomProfile]
class StreamGroup(BaseEventModel):
name: str
id: int
description: str
streams: list[int]
class DefaultStreamGroupsEvent(BaseEvent):
type: Literal["default_stream_groups"] = "default_stream_groups"
default_stream_groups: list[StreamGroup]
class DefaultStreamsEvent(BaseEvent):
type: Literal["default_streams"] = "default_streams"
default_streams: list[int]
class DeleteMessageCoreEvent(BaseEvent):
type: Literal["delete_message"] = "delete_message"
message_type: Literal["private", "stream"]
class DeleteMessageEvent(DeleteMessageCoreEvent):
# TODO: fix types to avoid optional fields
message_id: int | None = None
message_ids: list[int] | None = None
stream_id: int | None = None
topic: str | None = None
class TopicLink(BaseEventModel):
text: str
url: str
class DirectMessageDisplayRecipient(BaseEventModel):
id: int
is_mirror_dummy: bool
email: str
full_name: str
class MessageFieldForDirectMessageEvent(BaseEventModel):
avatar_url: str | None
client: str
content: str
content_type: Literal["text/html"]
id: int
is_me_message: bool
reactions: list[dict[str, object]]
recipient_id: int
sender_realm_str: str
sender_email: str
sender_full_name: str
sender_id: int
subject: str
topic_links: list[TopicLink]
submessages: list[dict[str, object]]
timestamp: int
type: str
display_recipient: list[DirectMessageDisplayRecipient]
class DirectMessageEvent(BaseEvent):
type: Literal["message"]
flags: list[str]
message: MessageFieldForDirectMessageEvent
class DraftFieldsCore(BaseEventModel):
id: int
type: Literal["", "private", "stream"]
to: list[int]
topic: str
content: str
class DraftFields(DraftFieldsCore):
# TODO: fix types to avoid optional fields
timestamp: int | None = None
class DraftsAddEvent(BaseEvent):
type: Literal["drafts"] = "drafts"
op: Literal["add"] = "add"
drafts: list[DraftFields]
class DraftsRemoveEvent(BaseEvent):
type: Literal["drafts"] = "drafts"
op: Literal["remove"] = "remove"
draft_id: int
class DraftsUpdateEvent(BaseEvent):
type: Literal["drafts"] = "drafts"
op: Literal["update"] = "update"
draft: DraftFields
class HasGoogleMeetTokenEvent(BaseEvent):
type: Literal["has_google_meet_token"] = "has_google_meet_token"
value: bool
class HasWebexTokenEvent(BaseEvent):
type: Literal["has_webex_token"] = "has_webex_token"
value: bool
class HasZoomTokenEvent(BaseEvent):
type: Literal["has_zoom_token"] = "has_zoom_token"
value: bool
class HeartbeatEvent(BaseEvent):
type: Literal["heartbeat"]
class InvitesChangedEvent(BaseEvent):
type: Literal["invites_changed"] = "invites_changed"
class MessageFieldForMessageEvent(BaseEventModel):
avatar_url: str | None
client: str
content: str
content_type: Literal["text/html"]
id: int
is_me_message: bool
reactions: list[dict[str, object]]
recipient_id: int
sender_realm_str: str
sender_email: str
sender_full_name: str
sender_id: int
subject: str
topic_links: list[TopicLink]
submessages: list[dict[str, object]]
timestamp: int
type: str
display_recipient: str
stream_id: int
class MessageEvent(BaseEvent):
type: Literal["message"]
flags: list[str]
message: MessageFieldForMessageEvent
class MutedTopicsEvent(BaseEvent):
type: Literal["muted_topics"] = "muted_topics"
muted_topics: list[list[str | int]]
class MutedUser(BaseEventModel):
id: int
timestamp: int
class MutedUsersEvent(BaseEvent):
type: Literal["muted_users"] = "muted_users"
muted_users: list[MutedUser]
class OnboardingSteps(BaseEventModel):
type: str
name: str
class OnboardingStepsEvent(BaseEvent):
type: Literal["onboarding_steps"] = "onboarding_steps"
onboarding_steps: list[OnboardingSteps]
class DeviceAddEvent(BaseEvent):
type: Literal["device"] = "device"
op: Literal["add"] = "add"
device_id: int
class DeviceRemoveEvent(BaseEvent):
type: Literal["device"] = "device"
op: Literal["remove"] = "remove"
device_id: int
class DeviceUpdateEvent(BaseEvent):
type: Literal["device"] = "device"
op: Literal["update"] = "update"
device_id: int
push_key_id: int | None = None
push_token_id: str | None = None
pending_push_token_id: str | None = None
push_token_last_updated_timestamp: int | None = None
push_registration_error_code: str | None = None
class NavigationViewFields(BaseEventModel):
fragment: str
is_pinned: bool
name: str | None
class NavigationViewAddEvent(BaseEvent):
type: Literal["navigation_view"] = "navigation_view"
op: Literal["add"] = "add"
navigation_view: NavigationViewFields
class NavigationViewRemoveEvent(BaseEvent):
type: Literal["navigation_view"] = "navigation_view"
op: Literal["remove"] = "remove"
fragment: str
class NavigationViewFieldsForUpdate(BaseEventModel):
is_pinned: bool | None = None
name: str | None = None
class NavigationViewUpdateEvent(BaseEvent):
type: Literal["navigation_view"] = "navigation_view"
op: Literal["update"] = "update"
fragment: str
data: NavigationViewFieldsForUpdate
class LegacyPresence(BaseEventModel):
status: Literal["active", "idle"]
timestamp: int
client: str
pushable: bool
class LegacyPresenceCoreEvent(BaseEvent):
type: Literal["presence"]
user_id: int
server_timestamp: float | int
presence: dict[str, LegacyPresence]
class LegacyPresenceEvent(LegacyPresenceCoreEvent):
# TODO: fix types to avoid optional fields
email: str | None = None
class ModernPresence(BaseEventModel):
active_timestamp: int
idle_timestamp: int
class ModernPresenceEvent(BaseEvent):
type: Literal["presence"]
presences: dict[str, ModernPresence]
class ReactionAddEvent(BaseEvent):
type: Literal["reaction"] = "reaction"
op: Literal["add"] = "add"
message_id: int
emoji_name: str
emoji_code: str
reaction_type: ReactionType
user_id: int
class ReactionRemoveEvent(BaseEvent):
type: Literal["reaction"] = "reaction"
op: Literal["remove"] = "remove"
message_id: int
emoji_name: str
emoji_code: str
reaction_type: ReactionType
user_id: int
class BotServicesOutgoing(BaseEventModel):
base_url: Url
interface: int
token: str
class BotServicesEmbedded(BaseEventModel):
service_name: str
config_data: dict[str, str]
class Bot(BaseEventModel):
user_id: int
default_all_public_streams: bool
default_events_register_stream: str | None
default_sending_stream: str | None
services: list[BotServicesOutgoing | BotServicesEmbedded]
class RealmBotAddEvent(BaseEvent):
type: Literal["realm_bot"] = "realm_bot"
op: Literal["add"] = "add"
bot: Bot
class BotTypeForDelete(BaseEventModel):
user_id: int
class RealmBotDeleteEvent(BaseEvent):
type: Literal["realm_bot"] = "realm_bot"
op: Literal["delete"] = "delete"
bot: BotTypeForDelete
class BotTypeForUpdateCore(BaseEventModel):
user_id: int
class BotTypeForUpdate(BotTypeForUpdateCore):
# TODO: fix types to avoid optional fields
default_all_public_streams: bool | None = None
default_events_register_stream: str | None = None
default_sending_stream: str | None = None
services: list[BotServicesOutgoing | BotServicesEmbedded] | None = None
class RealmBotUpdateEvent(BaseEvent):
type: Literal["realm_bot"] = "realm_bot"
op: Literal["update"] = "update"
bot: BotTypeForUpdate
class RealmDeactivatedEvent(BaseEvent):
type: Literal["realm"] = "realm"
op: Literal["deactivated"] = "deactivated"
realm_id: int
class RealmDomain(BaseEventModel):
domain: str
allow_subdomains: bool
class RealmDomainsAddEvent(BaseEvent):
type: Literal["realm_domains"] = "realm_domains"
op: Literal["add"] = "add"
realm_domain: RealmDomain
class RealmDomainsChangeEvent(BaseEvent):
type: Literal["realm_domains"] = "realm_domains"
op: Literal["change"] = "change"
realm_domain: RealmDomain
class RealmDomainsRemoveEvent(BaseEvent):
type: Literal["realm_domains"] = "realm_domains"
op: Literal["remove"] = "remove"
domain: str
class RealmEmoji(BaseEventModel):
id: str
name: str
source_url: str
deactivated: bool
author_id: int
still_url: str | None
class RealmEmojiAddEvent(BaseEvent):
type: Literal["realm_emoji"] = "realm_emoji"
op: Literal["add"] = "add"
emoji: RealmEmoji
class RealmEmojiUpdateData(BaseEventModel):
deactivated: bool | None = None
class RealmEmojiUpdateOneEvent(BaseEvent):
type: Literal["realm_emoji"] = "realm_emoji"
op: Literal["update_one"] = "update_one"
emoji_id: str
data: RealmEmojiUpdateData
class RealmEmojiUpdateEvent(BaseEvent):
type: Literal["realm_emoji"]
op: Literal["update"]
realm_emoji: dict[str, RealmEmoji]
class RealmExportConsentEvent(BaseEvent):
type: Literal["realm_export_consent"] = "realm_export_consent"
user_id: int
consented: bool
class Export(BaseEventModel):
id: int
export_time: float | int
acting_user_id: int
export_url: str | None
deleted_timestamp: float | int | None
failed_timestamp: float | int | None
pending: bool
export_from_prior_server: bool
export_type: RealmExportSlug
class RealmExportEvent(BaseEvent):
type: Literal["realm_export"] = "realm_export"
exports: list[Export]
class RealmLinkifier(BaseEventModel):
pattern: str
url_template: str
id: int
example_input: str | None = None
reverse_template: str | None = None
alternative_url_templates: list[str] = []
class RealmLinkifiersEvent(BaseEvent):
type: Literal["realm_linkifiers"] = "realm_linkifiers"
realm_linkifiers: list[RealmLinkifier]
class RealmPlayground(BaseEventModel):
id: int
name: str
pygments_language: str
url_template: str
class RealmPlaygroundsEvent(BaseEvent):
type: Literal["realm_playgrounds"] = "realm_playgrounds"
realm_playgrounds: list[RealmPlayground]
class AuthenticationMethodDictCore(BaseEventModel):
enabled: bool
available: bool
class AuthenticationMethodDict(AuthenticationMethodDictCore):
# TODO: fix types to avoid optional fields
unavailable_reason: str | None = None
class RealmUpdateDictData(BaseEventModel):
# Every field is optional: each event sets only the subset of
# fields that changed, and unset fields are omitted when the event
# is sent.
allow_message_editing: bool | None = None
message_content_edit_limit_seconds: int | None = None
topics_policy: str | None = None
mandatory_topics: bool | None = None
description: str | None = None
rendered_description: str | None = None
authentication_methods: dict[str, AuthenticationMethodDict] | None = None
plan_type: int | None = None
upload_quota_mib: int | None = None
max_file_upload_size_mib: int | None = None
icon_url: str | None = None
icon_source: str | None = None
logo_url: str | None = None
logo_source: str | None = None
night_logo_url: str | None = None
night_logo_source: str | None = None
moderation_request_channel_id: int | None = None
new_stream_announcements_stream_id: int | None = None
signup_announcements_stream_id: int | None = None
zulip_update_announcements_stream_id: int | None = None
create_multiuse_invite_group: int | UserGroupMembersDict | None = None
can_access_all_users_group: int | UserGroupMembersDict | None = None
can_add_custom_emoji_group: int | UserGroupMembersDict | None = None
can_add_subscribers_group: int | UserGroupMembersDict | None = None
can_create_bots_group: int | UserGroupMembersDict | None = None
can_create_groups: int | UserGroupMembersDict | None = None
can_create_public_channel_group: int | UserGroupMembersDict | None = None
can_create_private_channel_group: int | UserGroupMembersDict | None = None
can_create_web_public_channel_group: int | UserGroupMembersDict | None = None
can_create_write_only_bots_group: int | UserGroupMembersDict | None = None
can_delete_any_message_group: int | UserGroupMembersDict | None = None
can_delete_own_message_group: int | UserGroupMembersDict | None = None
can_invite_users_group: int | UserGroupMembersDict | None = None
can_manage_all_groups: int | UserGroupMembersDict | None = None
can_manage_billing_group: int | UserGroupMembersDict | None = None
can_mention_many_users_group: int | UserGroupMembersDict | None = None
can_move_messages_between_channels_group: int | UserGroupMembersDict | None = None
can_move_messages_between_topics_group: int | UserGroupMembersDict | None = None
can_resolve_topics_group: int | UserGroupMembersDict | None = None
can_set_delete_message_policy_group: int | UserGroupMembersDict | None = None
can_set_topics_policy_group: int | UserGroupMembersDict | None = None
can_summarize_topics_group: int | UserGroupMembersDict | None = None
direct_message_initiator_group: int | UserGroupMembersDict | None = None
direct_message_permission_group: int | UserGroupMembersDict | None = None
workplace_users_group: int | UserGroupMembersDict | None = None
class RealmUpdateDictEvent(BaseEvent):
type: Literal["realm"] = "realm"
op: Literal["update_dict"] = "update_dict"
property: Literal["default", "icon", "logo", "night_logo"]
data: RealmUpdateDictData
class RealmUpdateEvent(BaseEvent):
type: Literal["realm"] = "realm"
op: Literal["update"] = "update"
property: str
value: bool | int | str | None
rendered_description: str | None = None
class RealmUserCore(BaseEventModel):
user_id: int
email: str
avatar_url: str | None
avatar_version: int
full_name: str
is_admin: bool
is_owner: bool
is_guest: bool
role: Literal[100, 200, 300, 400, 600]
is_active: bool
is_imported_stub: bool
timezone: str
date_joined: str
delivery_email: str | None
# TODO: fix types to avoid optional fields
is_deleted: bool | None = None
class RealmHumanUser(RealmUserCore):
is_bot: Literal[False]
profile_data: dict[str, dict[str, object]]
class RealmBotUser(RealmUserCore):
is_bot: Literal[True]
bot_type: int
bot_owner_id: int | None
# TODO: fix types to avoid optional fields
is_system_bot: bool | None = None
class RealmUserAddEvent(BaseEvent):
type: Literal["realm_user"] = "realm_user"
op: Literal["add"] = "add"
person: Annotated[RealmHumanUser | RealmBotUser, Field(discriminator="is_bot")]
class RemovedUser(BaseEventModel):
user_id: int
full_name: str
class RealmUserRemoveEvent(BaseEvent):
type: Literal["realm_user"] = "realm_user"
op: Literal["remove"] = "remove"
person: RemovedUser
class RealmUserSettingsDefaultsUpdateEvent(BaseEvent):
type: Literal["realm_user_settings_defaults"] = "realm_user_settings_defaults"
op: Literal["update"] = "update"
property: str
value: bool | int | str
class PersonAvatarFields(BaseEventModel):
user_id: int
avatar_source: str
avatar_url: str | None
avatar_url_medium: str | None
avatar_version: int
class PersonBotOwnerId(BaseEventModel):
user_id: int
bot_owner_id: int
class CustomProfileFieldCore(BaseEventModel):
id: int
value: str | None
class CustomProfileField(CustomProfileFieldCore):
# TODO: fix types to avoid optional fields
rendered_value: str | None = None
class PersonCustomProfileField(BaseEventModel):
user_id: int
custom_profile_field: CustomProfileField
class PersonDeliveryEmail(BaseEventModel):
user_id: int
delivery_email: str | None
class PersonEmail(BaseEventModel):
user_id: int
new_email: str
class PersonFullName(BaseEventModel):
user_id: int
full_name: str
class PersonRole(BaseEventModel):
user_id: int
role: Literal[100, 200, 300, 400, 600]
class PersonTimezone(BaseEventModel):
user_id: int
email: str
timezone: str
class PersonIsActive(BaseEventModel):
user_id: int
is_active: bool
class PersonIsImportedStub(BaseEventModel):
user_id: int
is_imported_stub: bool
class PersonDateJoined(BaseEventModel):
user_id: int
date_joined: str
class RealmUserUpdateEvent(BaseEvent):
type: Literal["realm_user"] = "realm_user"
op: Literal["update"] = "update"
person: (
PersonAvatarFields
| PersonBotOwnerId
| PersonCustomProfileField
| PersonDateJoined
| PersonDeliveryEmail
| PersonEmail
| PersonFullName
| PersonRole
| PersonTimezone
| PersonIsActive
| PersonIsImportedStub
)
class RestartEvent(BaseEvent):
type: Literal["restart"]
zulip_version: str
zulip_merge_base: str
zulip_feature_level: int
server_generation: int
class SavedSnippetFields(BaseEventModel):
id: int
title: str
content: str
date_created: int
class SavedSnippetsAddEvent(BaseEvent):
type: Literal["saved_snippets"] = "saved_snippets"
op: Literal["add"] = "add"
saved_snippet: SavedSnippetFields
class SavedSnippetsUpdateEvent(BaseEvent):
type: Literal["saved_snippets"] = "saved_snippets"
op: Literal["update"] = "update"
saved_snippet: SavedSnippetFields
class SavedSnippetsRemoveEvent(BaseEvent):
type: Literal["saved_snippets"] = "saved_snippets"
op: Literal["remove"] = "remove"
saved_snippet_id: int
class ScheduledMessageFieldsCore(BaseEventModel):
scheduled_message_id: int
type: Literal["private", "stream"]
to: list[int] | int
content: str
rendered_content: str
scheduled_delivery_timestamp: int
failed: bool
class ScheduledMessageFields(ScheduledMessageFieldsCore):
# TODO: fix types to avoid optional fields
topic: str | None = None
class ScheduledMessagesAddEvent(BaseEvent):
type: Literal["scheduled_messages"] = "scheduled_messages"
op: Literal["add"] = "add"
scheduled_messages: list[ScheduledMessageFields]
class ScheduledMessagesRemoveEvent(BaseEvent):
type: Literal["scheduled_messages"] = "scheduled_messages"
op: Literal["remove"] = "remove"
scheduled_message_id: int
class ScheduledMessagesUpdateEvent(BaseEvent):
type: Literal["scheduled_messages"] = "scheduled_messages"
op: Literal["update"] = "update"
scheduled_message: ScheduledMessageFields
class ReminderFields(BaseEventModel):
reminder_id: int
type: Literal["private"]
to: list[int]
content: str
rendered_content: str
scheduled_delivery_timestamp: int
failed: bool
reminder_target_message_id: int
class RemindersAddEvent(BaseEvent):
type: Literal["reminders"] = "reminders"
op: Literal["add"] = "add"
reminders: list[ReminderFields]
class RemindersRemoveEvent(BaseEvent):
type: Literal["reminders"] = "reminders"
op: Literal["remove"] = "remove"
reminder_id: int
class BasicStreamFields(BaseEventModel):
is_archived: bool
can_add_subscribers_group: int | UserGroupMembersDict
can_administer_channel_group: int | UserGroupMembersDict
can_create_topic_group: int | UserGroupMembersDict
can_delete_any_message_group: int | UserGroupMembersDict
can_delete_own_message_group: int | UserGroupMembersDict
can_move_messages_out_of_channel_group: int | UserGroupMembersDict
can_move_messages_within_channel_group: int | UserGroupMembersDict
can_remove_subscribers_group: int | UserGroupMembersDict
can_resolve_topics_group: int | UserGroupMembersDict
can_send_message_group: int | UserGroupMembersDict
can_subscribe_group: int | UserGroupMembersDict
creator_id: int | None
date_created: int
default_push_notifications: bool
description: str
first_message_id: int | None
folder_id: int | None
is_recently_active: bool
history_public_to_subscribers: bool
invite_only: bool
is_announcement_only: bool
is_web_public: bool
message_retention_days: int | None
name: str
rendered_description: str
stream_id: int
stream_post_policy: int
stream_weekly_traffic: int | None
subscriber_count: int
topics_policy: str
class StreamCreateEvent(BaseEvent):
type: Literal["stream"] = "stream"
op: Literal["create"] = "create"
streams: list[BasicStreamFields]
class StreamDeleteEvent(BaseEvent):
type: Literal["stream"] = "stream"
op: Literal["delete"] = "delete"
# Streams is a legacy field for backwards-compatibility, and will
# be removed in the future.
streams: list[dict[Literal["stream_id"], int]]
stream_ids: list[int]
class StreamUpdateCoreEvent(BaseEvent):
type: Literal["stream"] = "stream"
op: Literal["update"] = "update"
property: str
value: bool | int | str | UserGroupMembersDict | None
name: str
stream_id: int
class StreamUpdateEvent(StreamUpdateCoreEvent):
# TODO: fix types to avoid optional fields
rendered_description: str | None = None
history_public_to_subscribers: bool | None = None
is_web_public: bool | None = None
class SubmessageEvent(BaseEvent):
type: Literal["submessage"] = "submessage"
message_id: int
submessage_id: int
sender_id: int
msg_type: str
content: str
class SingleSubscription(BaseEventModel):
is_archived: bool
can_add_subscribers_group: int | UserGroupMembersDict
can_administer_channel_group: int | UserGroupMembersDict
can_create_topic_group: int | UserGroupMembersDict
can_delete_any_message_group: int | UserGroupMembersDict
can_delete_own_message_group: int | UserGroupMembersDict
can_move_messages_out_of_channel_group: int | UserGroupMembersDict
can_move_messages_within_channel_group: int | UserGroupMembersDict
can_remove_subscribers_group: int | UserGroupMembersDict
can_resolve_topics_group: int | UserGroupMembersDict
can_send_message_group: int | UserGroupMembersDict
can_subscribe_group: int | UserGroupMembersDict
creator_id: int | None
date_created: int
default_push_notifications: bool
description: str
first_message_id: int | None
folder_id: int | None
is_recently_active: bool
history_public_to_subscribers: bool
invite_only: bool
is_announcement_only: bool
is_web_public: bool
message_retention_days: int | None
name: str
rendered_description: str
stream_id: int
stream_post_policy: int
stream_weekly_traffic: int | None
audible_notifications: bool | None
color: str
desktop_notifications: bool | None
email_notifications: bool | None
in_home_view: bool
is_muted: bool
pin_to_top: bool
push_notifications: bool | None
subscriber_count: int
subscribers: list[int]
topics_policy: str
wildcard_mentions_notify: bool | None
class SubscriptionAddEvent(BaseEvent):
type: Literal["subscription"] = "subscription"
op: Literal["add"] = "add"
subscriptions: list[SingleSubscription]
class SubscriptionPeerAddEvent(BaseEvent):
type: Literal["subscription"] = "subscription"
op: Literal["peer_add"] = "peer_add"
user_ids: list[int]
stream_ids: list[int]
class SubscriptionPeerRemoveEvent(BaseEvent):
type: Literal["subscription"] = "subscription"
op: Literal["peer_remove"] = "peer_remove"
user_ids: list[int]
stream_ids: list[int]
class RemoveSub(BaseEventModel):
name: str
stream_id: int
class SubscriptionRemoveEvent(BaseEvent):
type: Literal["subscription"] = "subscription"
op: Literal["remove"] = "remove"
subscriptions: list[RemoveSub]
class SubscriptionUpdateEvent(BaseEvent):
type: Literal["subscription"] = "subscription"
op: Literal["update"] = "update"
property: str
stream_id: int
value: bool | int | str
class TypingPerson(BaseEventModel):
email: str
user_id: int
class TypingStartCoreEvent(BaseEvent):
type: Literal["typing"] = "typing"
op: Literal["start"] = "start"
message_type: Literal["direct", "stream"]
sender: TypingPerson
class TypingStartEvent(TypingStartCoreEvent):
# TODO: fix types to avoid optional fields
recipients: list[TypingPerson] | None = None
stream_id: int | None = None
topic: str | None = None
class TypingStopCoreEvent(BaseEvent):
type: Literal["typing"] = "typing"
op: Literal["stop"] = "stop"
message_type: Literal["direct", "stream"]
sender: TypingPerson
class TypingStopEvent(TypingStopCoreEvent):
# TODO: fix types to avoid optional fields
recipients: list[TypingPerson] | None = None
stream_id: int | None = None
topic: str | None = None
class RecipientFieldForTypingEditChannelMessage(BaseEventModel):
type: Literal["channel"]
channel_id: int
topic: str
class RecipientFieldForTypingEditDirectMessage(BaseEventModel):
type: Literal["direct"]
user_ids: list[int]
class TypingEditMessageStartEvent(BaseEvent):
type: Literal["typing_edit_message"] = "typing_edit_message"
op: Literal["start"] = "start"
sender_id: int
message_id: int
recipient: RecipientFieldForTypingEditChannelMessage | RecipientFieldForTypingEditDirectMessage
class TypingEditMessageStopEvent(BaseEvent):
type: Literal["typing_edit_message"] = "typing_edit_message"
op: Literal["stop"] = "stop"
sender_id: int
message_id: int
recipient: RecipientFieldForTypingEditChannelMessage | RecipientFieldForTypingEditDirectMessage
class UpdateMessageCoreEvent(BaseEvent):
type: Literal["update_message"]
user_id: int | None
edit_timestamp: int
message_id: int
flags: list[str]
message_ids: list[int]
rendering_only: bool
class UpdateMessageOptionalFields(BaseEventModel):
# TODO: fix types to avoid optional fields
stream_id: int | None = None
stream_name: str | None = None
is_me_message: bool | None = None
orig_content: str | None = None
orig_rendered_content: str | None = None
content: str | None = None
rendered_content: str | None = None
topic_links: list[TopicLink] | None = None
subject: str | None = None
new_stream_id: int | None = None
propagate_mode: PropagateMode | None = None
orig_subject: str | None = None
class UpdateMessageEvent(UpdateMessageCoreEvent, UpdateMessageOptionalFields):
pass
class UpdateMessageFlagsAddEvent(BaseEvent):
type: Literal["update_message_flags"] = "update_message_flags"
op: Literal["add"] = "add"
operation: Literal["add"] = "add"
flag: str
messages: list[int]
all: bool
class MessageDetailsCore(BaseEventModel):
type: Literal["private", "stream"]
class MessageDetails(MessageDetailsCore):
# TODO: fix types to avoid optional fields
mentioned: bool | None = None
user_ids: list[int] | None = None
stream_id: int | None = None
topic: str | None = None
unmuted_stream_msg: bool | None = None
class UpdateMessageFlagsRemoveCoreEvent(BaseEvent):
type: Literal["update_message_flags"] = "update_message_flags"
op: Literal["remove"] = "remove"
operation: Literal["remove"] = "remove"
flag: str
messages: list[int]
all: bool
class UpdateMessageFlagsRemoveEvent(UpdateMessageFlagsRemoveCoreEvent):
# TODO: fix types to avoid optional fields
message_details: dict[str, MessageDetails] | None = None
class Group(BaseEventModel):
id: int
name: str
creator_id: int | None
date_created: int | None
members: list[int]
direct_subgroup_ids: list[int]
description: str
is_system_group: bool
can_add_members_group: int | UserGroupMembersDict
can_join_group: int | UserGroupMembersDict
can_leave_group: int | UserGroupMembersDict
can_manage_group: int | UserGroupMembersDict
can_mention_group: int | UserGroupMembersDict
can_remove_members_group: int | UserGroupMembersDict
deactivated: bool
class UrlEmbedDataEvent(BaseEvent):
type: Literal["url_embed_data"] = "url_embed_data"
content: str
rendered_content: str
class UserGroupAddEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["add"] = "add"
group: Group
class UserGroupAddMembersEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["add_members"] = "add_members"
group_id: int
user_ids: list[int]
class UserGroupAddSubgroupsEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["add_subgroups"] = "add_subgroups"
group_id: int
direct_subgroup_ids: list[int]
class UserGroupRemoveEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["remove"] = "remove"
group_id: int
class UserGroupRemoveMembersEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["remove_members"] = "remove_members"
group_id: int
user_ids: list[int]
class UserGroupRemoveSubgroupsEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["remove_subgroups"] = "remove_subgroups"
group_id: int
direct_subgroup_ids: list[int]
class UserGroupDataCore(BaseEventModel):
pass
class UserGroupData(UserGroupDataCore):
# TODO: fix types to avoid optional fields
name: str | None = None
description: str | None = None
can_add_members_group: int | UserGroupMembersDict | None = None
can_join_group: int | UserGroupMembersDict | None = None
can_leave_group: int | UserGroupMembersDict | None = None
can_manage_group: int | UserGroupMembersDict | None = None
can_mention_group: int | UserGroupMembersDict | None = None
can_remove_members_group: int | UserGroupMembersDict | None = None
deactivated: bool | None = None
class UserGroupUpdateEvent(BaseEvent):
type: Literal["user_group"] = "user_group"
op: Literal["update"] = "update"
group_id: int
data: UserGroupData
class UserSettingsUpdateCoreEvent(BaseEvent):
type: Literal["user_settings"] = "user_settings"
op: Literal["update"] = "update"
property: str
value: bool | int | str
class UserSettingsUpdateEvent(UserSettingsUpdateCoreEvent):
# TODO: fix types to avoid optional fields
language_name: str | None = None
class UserStatusCoreEvent(BaseEvent):
type: Literal["user_status"] = "user_status"
user_id: int
class UserStatusEvent(UserStatusCoreEvent):
# TODO: fix types to avoid optional fields
away: bool | None = None
status_text: str | None = None
emoji_name: str | None = None
emoji_code: str | None = None
reaction_type: ReactionType | None = None
class UserTopicEvent(BaseEvent):
type: Literal["user_topic"] = "user_topic"
stream_id: int
topic_name: str
last_updated: int
visibility_policy: int
class WebReloadClientEvent(BaseEvent):
type: Literal["web_reload_client"]
immediate: bool