api_types/model: Add types for updating messages and apply them.

Author: neiljp

zulipterminal/api_types.py

@@ -6,7 +6,7 @@
 
 from typing import Any, Dict, List, Optional, Union
 
-from typing_extensions import Literal, TypedDict
+from typing_extensions import Literal, NotRequired, TypedDict
 
 # These are documented in the zulip package (python-zulip-api repo)
 from zulip import EditPropagateMode  # one/all/later
@@ -36,9 +36,38 @@ class StreamComposition(TypedDict):
     subject: str  # TODO: Migrate to using topic
 
 
+# https://zulip.com/api/send-message
 Composition = Union[PrivateComposition, StreamComposition]
 
 
+class PrivateMessageUpdateRequest(TypedDict):
+    message_id: int
+    content: str
+
+
+class StreamMessageUpdateRequest(TypedDict):
+    message_id: int
+
+    # May update combination of content for specified message
+    # ...and/or topic of that message and potentially others (via mode)
+    # ...but content and stream may not be changed together
+    content: NotRequired[str]
+    topic: NotRequired[str]
+    propagate_mode: NotRequired[EditPropagateMode]
+
+    # Supported for stream moves in ZFL 9 (Zulip 3)
+    # Default values if not passed in ZFL 152 (Zulip 6)
+    send_notification_to_old_thread: NotRequired[bool]
+    send_notification_to_new_thread: NotRequired[bool]
+
+    # TODO: Implement message moves between streams
+    # stream_id: int
+
+
+# https://zulip.com/api/update-message
+MessageUpdateRequest = Union[PrivateMessageUpdateRequest, StreamMessageUpdateRequest]
+
+
 class Message(TypedDict, total=False):
     id: int
     sender_id: int

zulipterminal/model.py

@@ -34,9 +34,11 @@
     EditPropagateMode,
     Event,
     PrivateComposition,
+    PrivateMessageUpdateRequest,
     RealmEmojiData,
     RealmUser,
     StreamComposition,
+    StreamMessageUpdateRequest,
     Subscription,
 )
 from zulipterminal.config.keys import primary_key_for_command
@@ -561,7 +563,7 @@ def send_stream_message(self, stream: str, topic: str, content: str) -> bool:
         return message_was_sent
 
     def update_private_message(self, msg_id: int, content: str) -> bool:
-        request = {
+        request: PrivateMessageUpdateRequest = {
             "message_id": msg_id,
             "content": content,
         }
@@ -578,7 +580,7 @@ def update_stream_message(
         notify_old: bool = False,
         notify_new: bool = False,
     ) -> bool:
-        request = {
+        request: StreamMessageUpdateRequest = {
             "message_id": message_id,
             "propagate_mode": propagate_mode,
             "topic": topic,