api: Add InitialSnapshot.mutedUsers

Co-authored-by: Chris Bobbe <[email protected]>

Author: 2 people

lib/api/model/initial_snapshot.dart

@@ -44,6 +44,8 @@ class InitialSnapshot {
 
   // final List<…> mutedTopics; // TODO(#422) we ignore this feature on older servers
 
+  final List<MutedUserItem> mutedUsers;
+
   final Map<String, RealmEmojiItem> realmEmoji;
 
   final List<RecentDmConversation> recentPrivateConversations;
@@ -132,6 +134,7 @@ class InitialSnapshot {
     required this.serverTypingStartedExpiryPeriodMilliseconds,
     required this.serverTypingStoppedWaitPeriodMilliseconds,
     required this.serverTypingStartedWaitPeriodMilliseconds,
+    required this.mutedUsers,
     required this.realmEmoji,
     required this.recentPrivateConversations,
     required this.savedSnippets,

lib/api/model/initial_snapshot.g.dart

@@ -110,6 +110,25 @@ class CustomProfileFieldExternalAccountData {
   Map<String, dynamic> toJson() => _$CustomProfileFieldExternalAccountDataToJson(this);
 }
 
+/// An item in the [InitialSnapshot.mutedUsers].
+///
+/// For docs, search for "muted_users:"
+/// in <https://zulip.com/api/register-queue>.
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUserItem {
+  final int id;
+
+  // Mobile doesn't use the timestamp; ignore.
+  // final int timestamp;
+
+  const MutedUserItem({required this.id});
+
+  factory MutedUserItem.fromJson(Map<String, dynamic> json) =>
+    _$MutedUserItemFromJson(json);
+
+  Map<String, dynamic> toJson() => _$MutedUserItemToJson(this);
+}
+
 /// An item in [InitialSnapshot.realmEmoji] or [RealmEmojiUpdateEvent].
 ///
 /// For docs, search for "realm_emoji:"

lib/api/model/model.dart

@@ -1098,6 +1098,7 @@ InitialSnapshot initialSnapshot({
   int? serverTypingStartedExpiryPeriodMilliseconds,
   int? serverTypingStoppedWaitPeriodMilliseconds,
   int? serverTypingStartedWaitPeriodMilliseconds,
+  List<MutedUserItem>? mutedUsers,
   Map<String, RealmEmojiItem>? realmEmoji,
   List<RecentDmConversation>? recentPrivateConversations,
   List<SavedSnippet>? savedSnippets,
@@ -1134,6 +1135,7 @@ InitialSnapshot initialSnapshot({
       serverTypingStoppedWaitPeriodMilliseconds ?? 5000,
     serverTypingStartedWaitPeriodMilliseconds:
       serverTypingStartedWaitPeriodMilliseconds ?? 10000,
+    mutedUsers: mutedUsers ?? [],
     realmEmoji: realmEmoji ?? {},
     recentPrivateConversations: recentPrivateConversations ?? [],
     savedSnippets: savedSnippets ?? [],