feat: add controls to managing muted users in a subreddit

src/reddit/subreddit/controls.ts

@@ -265,6 +265,42 @@ export class SubredditControls extends BaseControls {
     return this.getAboutListingUsers(subreddit, "banned");
   }
 
+  /**
+   * Mute a user in a subreddit.
+   *
+   * This prevents the user from sending modmail to the subreddit for 72 hours.
+   *
+   * @param subreddit The name of the subreddit to mute the user in.
+   * @param username The username of the user to mute.
+   */
+  async muteUser(subreddit: string, username: string): Promise<void> {
+    await this.friend(subreddit, username, "muted");
+  }
+
+  /**
+   * Unmute a user in a subreddit.
+   *
+   * @param subreddit The name of the subreddit to unmute the user in.
+   * @param username The username of the user to unmute.
+   */
+  async unmuteUser(subreddit: string, username: string): Promise<void> {
+    await this.unfriend(subreddit, username, "muted");
+  }
+
+  /**
+   * Get the list of muted users for a subreddit.
+   *
+   * @note Due to the way Reddit implements Listings, this will only contain the
+   * first 1000 muted users.
+   *
+   * @param subreddit The name of the subreddit to get muted users for.
+   *
+   * @returns A listing of muted users.
+   */
+  getMutedUsers(subreddit: string): Listing<User> {
+    return this.getAboutListingUsers(subreddit, "muted");
+  }
+
   /** @internal */
   protected getSortedPosts(
     subreddit: string | undefined,

src/reddit/subreddit/object.ts

@@ -916,6 +916,38 @@ export class Subreddit extends Content implements SubredditData {
     return this.controls.getWikiContributors(this.displayName);
   }
 
+  /**
+   * Mute a user in this subreddit.
+   *
+   * This prevents the user from sending modmail to this subreddit for 72 hours.
+   *
+   * @param username The username of the user to mute.
+   */
+  async muteUser(username: string): Promise<void> {
+    return this.controls.muteUser(this.displayName, username);
+  }
+
+  /**
+   * Unmute a user in this subreddit.
+   *
+   * @param username The username of the user to unmute.
+   */
+  async unmuteUser(username: string): Promise<void> {
+    return this.controls.unmuteUser(this.displayName, username);
+  }
+
+  /**
+   * Get the list of muted users for this subreddit.
+   *
+   * @note Due to the way Reddit implements Listings, this will only contain the
+   * first 1000 muted users.
+   *
+   * @returns A listing of muted users.
+   */
+  getMutedUsers(): Listing<User> {
+    return this.controls.getMutedUsers(this.displayName);
+  }
+
   /**
    * Ban a user from this subreddit.
    *