discordrb 3.5.0 → 3.6.0

data/lib/discordrb/data/role.rb

@@ -16,6 +16,7 @@ module Discordrb
 
     # @return [true, false] whether or not this role should be displayed separately from other users
     attr_reader :hoist
+    alias_method :hoist?, :hoist
 
     # @return [true, false] whether or not this role is managed by an integration or a bot
     attr_reader :managed
@@ -25,7 +26,7 @@ module Discordrb
     attr_reader :mentionable
     alias_method :mentionable?, :mentionable
 
-    # @return [ColourRGB] the role colour
+    # @return [ColourRGB] the primary colour of this role.
     attr_reader :colour
     alias_method :color, :colour
 
@@ -35,9 +36,23 @@ module Discordrb
     # @return [String, nil] The icon hash for this role.
     attr_reader :icon
 
-    # @return [Tags, nil] The role tags
+    # @return [Tags, nil] The role tags.
     attr_reader :tags
 
+    # @return [Integer] The flags for this role.
+    attr_reader :flags
+
+    # @return [String, nil] The unicode emoji of this role, or nil.
+    attr_reader :unicode_emoji
+
+    # @return [ColourRGB, nil] the secondary colour of this role.
+    attr_reader :secondary_colour
+    alias_method :secondary_color, :secondary_colour
+
+    # @return [ColourRGB, nil] the tertiary colour of this role.
+    attr_reader :tertiary_colour
+    alias_method :tertiary_color, :tertiary_colour
+
     # Wrapper for the role tags
     class Tags
       # @return [Integer, nil] The ID of the bot this role belongs to
@@ -48,16 +63,21 @@ module Discordrb
 
       # @return [true, false] Whether this is the guild's Booster role
       attr_reader :premium_subscriber
+      alias_method :premium_subscriber?, :premium_subscriber
 
       # @return [Integer, nil] The id of this role's subscription sku and listing
       attr_reader :subscription_listing_id
 
       # @return [true, false] Whether this role is available for purchase
       attr_reader :available_for_purchase
+      alias_method :available_for_purchase?, :available_for_purchase
 
       # @return [true, false] Whether this role is a guild's linked role
       attr_reader :guild_connections
+      alias_method :guild_connections?, :guild_connections
+      alias_method :server_connections?, :guild_connections
 
+      # @!visibility private
       def initialize(data)
         @bot_id = data['bot_id']&.resolve_id
         @integration_id = data['integration_id']&.resolve_id
@@ -92,7 +112,7 @@ module Discordrb
     def initialize(data, bot, server = nil)
       @bot = bot
       @server = server
-      @permissions = Permissions.new(data['permissions'], RoleWriter.new(self, @bot.token))
+      @permissions = Permissions.new(data['permissions'].to_i, RoleWriter.new(self, @bot.token))
       @name = data['name']
       @id = data['id'].to_i
 
@@ -102,11 +122,19 @@ module Discordrb
       @mentionable = data['mentionable']
       @managed = data['managed']
 
-      @colour = ColourRGB.new(data['color'])
+      colours = data['colors']
+      @colour = ColourRGB.new(colours['primary_color'])
 
       @icon = data['icon']
 
       @tags = Tags.new(data['tags']) if data['tags']
+
+      @flags = data['flags']
+
+      @unicode_emoji = data['unicode_emoji']
+
+      @tertiary_colour = ColourRGB.new(colours['tertiary_color']) if colours['tertiary_color']
+      @secondary_colour = ColourRGB.new(colours['secondary_color']) if colours['secondary_color']
     end
 
     # @return [String] a string that will mention this role, if it is mentionable.
@@ -133,16 +161,28 @@ module Discordrb
       @position = other.position
       @managed = other.managed
       @icon = other.icon
+      @flags = other.flags
+      @unicode_emoji = other.unicode_emoji
+      @secondary_colour = other.secondary_colour
+      @tertiary_colour = other.tertiary_colour
     end
 
     # Updates the data cache from a hash containing data
     # @note For internal use only
     # @!visibility private
     def update_data(new_data)
-      @name = new_data[:name] || new_data['name'] || @name
-      @hoist = new_data['hoist'] unless new_data['hoist'].nil?
-      @hoist = new_data[:hoist] unless new_data[:hoist].nil?
-      @colour = new_data[:colour] || (new_data['color'] ? ColourRGB.new(new_data['color']) : @colour)
+      @name = new_data['name']
+      @hoist = new_data['hoist']
+      @icon = new_data['icon']
+      @unicode_emoji = new_data['unicode_emoji']
+      @position = new_data['position']
+      @mentionable = new_data['mentionable']
+      @flags = new_data['flags']
+      colours = new_data['colors']
+      @permissions.bits = new_data['permissions'].to_i
+      @colour = ColourRGB.new(colours['primary_color'])
+      @secondary_color = ColourRGB.new(colours['secondary_color']) if colours['secondary_color']
+      @tertiary_colour = ColourRGB.new(colours['tertiary_color']) if colours['tertiary_color']
     end
 
     # Sets the role name to something new
@@ -163,18 +203,42 @@ module Discordrb
       update_role_data(mentionable: mentionable)
     end
 
-    # Sets the role colour to something new
-    # @param colour [ColourRGB] The new colour
+    # Sets the primary role colour to something new.
+    # @param colour [ColourRGB, Integer, nil] The new colour.
     def colour=(colour)
-      update_role_data(colour: colour)
+      update_colors(primary: colour)
+    end
+
+    # Sets the secondary role colour to something new.
+    # @param colour [ColourRGB, Integer, nil] The new secondary colour.
+    def secondary_colour=(colour)
+      update_colours(secondary: colour)
+    end
+
+    # Sets the tertiary role colour to something new.
+    # @param colour [ColourRGB, Integer, nil] The new tertiary colour.
+    def tertiary_colour=(colour)
+      update_colours(tertiary: colour)
+    end
+
+    # Sets whether the role colour should be a holographic style.
+    # @param holographic [true, false] whether the role colour should be a holographic style.
+    def holographic=(holographic)
+      update_colours(holographic: holographic)
     end
 
     # Upload a role icon for servers with the ROLE_ICONS feature.
-    # @param file [File]
+    # @param file [File, nil] File like object that responds to #read, or nil.
     def icon=(file)
       update_role_data(icon: file)
     end
 
+    # Set a role icon to a unicode emoji for servers with the ROLE_ICONS feature.
+    # @param emoji [String, nil] The new unicode emoji for this role, or nil.
+    def unicode_emoji=(emoji)
+      update_role_data(unicode_emoji: emoji)
+    end
+
     # @param format ['webp', 'png', 'jpeg']
     # @return [String] URL to the icon on Discord's CDN.
     def icon_url(format = 'webp')
@@ -183,7 +247,44 @@ module Discordrb
       Discordrb::API.role_icon_url(@id, @icon, format)
     end
 
+    # Get the icon that a role has displayed.
+    # @return [String, nil] Icon URL, the unicode emoji, or nil if this role doesn't have any icon.
+    # @note A role can have a unicode emoji, and an icon, but only the icon will be shown in the UI.
+    def display_icon
+      icon_url || unicode_emoji
+    end
+
+    # Set the icon this role is displaying.
+    # @param icon [File, String, nil] File like object that responds to #read, unicode emoji, or nil.
+    # @note Setting the icon to nil will remove the unicode emoji **and** the custom icon.
+    def display_icon=(icon)
+      if icon.nil?
+        update_role_data(unicode_emoji: nil, icon: nil)
+        return
+      end
+
+      if icon.respond_to?(:read)
+        update_role_data(unicode_emoji: nil, icon: icon)
+      else
+        update_role_data(unicode_emoji: icon, icon: nil)
+      end
+    end
+
+    # Whether or not the role is of the holographic style.
+    # @return [true, false]
+    def holographic?
+      !@tertiary_colour.nil?
+    end
+
+    # Whether or not the role has a two-point gradient.
+    # @return [true, false]
+    def gradient?
+      !@secondary_colour.nil? && @tertiary_colour.nil?
+    end
+
     alias_method :color=, :colour=
+    alias_method :secondary_color=, :secondary_colour=
+    alias_method :tertiary_color=, :tertiary_colour=
 
     # Changes this role's permissions to a fixed bitfield. This allows setting multiple permissions at once with just
     # one API call.
@@ -226,23 +327,51 @@ module Discordrb
       @server.delete_role(@id)
     end
 
+    # A rich interface designed to make working with role colours simple.
+    # @param primary [ColourRGB, Integer, nil] The new primary/base colour of this role, or nil to clear the primary colour.
+    # @param secondary [ColourRGB, Integer, nil] The new secondary colour of this role, or nil to clear the secondary colour.
+    # @param tertiary [ColourRGB, Integer,nil] The new tertiary colour of this role, or nil to clear the tertiary colour.
+    # @param holographic [true, false] Whether to apply or remove the holographic style to the role colour, overriding any other
+    #   arguments that were passed. Using this argument is recommended over passing individual colours.
+    def update_colours(primary: :undef, secondary: :undef, tertiary: :undef, holographic: :undef)
+      colours = {
+        primary_color: (primary == :undef ? @colour : primary)&.to_i,
+        tertiary_color: (tertiary == :undef ? @tertiary_colour : tertiary)&.to_i,
+        secondary_color: (secondary == :undef ? @secondary_colour : secondary)&.to_i
+      }
+
+      holographic_colours = {
+        primary_color: 11_127_295,
+        tertiary_color: 16_761_760,
+        secondary_color: 16_759_788
+      }
+
+      # Only set the tertiary_color to `nil` if holographic is explicitly set to false.
+      colours[:tertiary_color] = nil if holographic.is_a?(FalseClass) && holographic?
+
+      update_role_data(colours: holographic == true ? holographic_colours : colours)
+    end
+
+    alias_method :update_colors, :update_colours
+
     # The inspect method is overwritten to give more useful output
     def inspect
-      "<Role name=#{@name} permissions=#{@permissions.inspect} hoist=#{@hoist} colour=#{@colour.inspect} server=#{@server.inspect} position=#{@position} mentionable=#{@mentionable}>"
+      "<Role name=#{@name} permissions=#{@permissions.inspect} hoist=#{@hoist} colour=#{@colour.inspect} server=#{@server.inspect} position=#{@position} mentionable=#{@mentionable} unicode_emoji=#{@unicode_emoji} flags=#{@flags}>"
     end
 
     private
 
     def update_role_data(new_data)
-      API::Server.update_role(@bot.token, @server.id, @id,
-                              new_data[:name] || @name,
-                              (new_data[:colour] || @colour).combined,
-                              new_data[:hoist].nil? ? @hoist : new_data[:hoist],
-                              new_data[:mentionable].nil? ? @mentionable : new_data[:mentionable],
-                              new_data[:permissions] || @permissions.bits,
-                              nil,
-                              new_data.key?(:icon) ? new_data[:icon] : :undef)
-      update_data(new_data)
+      update_data(JSON.parse(API::Server.update_role(@bot.token, @server.id, @id,
+                                                     new_data[:name] || @name,
+                                                     :undef,
+                                                     new_data.key?(:hoist) ? new_data[:hoist] : :undef,
+                                                     new_data.key?(:mentionable) ? new_data[:mentionable] : :undef,
+                                                     new_data[:permissions] || @permissions.bits,
+                                                     nil,
+                                                     new_data.key?(:icon) ? new_data[:icon] : :undef,
+                                                     new_data.key?(:unicode_emoji) ? new_data[:unicode_emoji] : :undef,
+                                                     new_data.key?(:colours) ? new_data[:colours] : :undef)))
     end
   end
 end

data/lib/discordrb/data/server.rb

@@ -64,25 +64,20 @@ module Discordrb
     # @!visibility private
     def initialize(data, bot)
       @bot = bot
-      @owner_id = data['owner_id'].to_i
       @id = data['id'].to_i
       @members = {}
       @voice_states = {}
       @emoji = {}
 
-      process_channels(data['channels'])
       update_data(data)
 
       # Whether this server's members have been chunked (resolved using op 8 and GUILD_MEMBERS_CHUNK) yet
       @chunked = false
-
-      @booster_count = data['premium_subscription_count'] || 0
-      @boost_level = data['premium_tier']
     end
 
     # @return [Member] The server owner.
     def owner
-      @owner ||= member(@owner_id)
+      member(@owner_id)
     end
 
     # The default channel is the text channel on this server with the highest position
@@ -137,7 +132,7 @@ module Discordrb
       @bot.debug("Members for server #{@id} not chunked yet - initiating")
 
       # If the SERVER_MEMBERS intent flag isn't set, the gateway won't respond when we ask for members.
-      raise 'The :server_members intent is required to get server members' if (@bot.gateway.intents & INTENTS[:server_members]).zero?
+      raise 'The :server_members intent is required to get server members' if @bot.gateway.intents.nobits?(INTENTS[:server_members])
 
       @bot.request_chunks(@id)
       sleep 0.05 until @chunked
@@ -325,6 +320,11 @@ module Discordrb
       @channels.reject { |c| c.parent || c.category? }
     end
 
+    # @return [ServerPreview] the preview of this server shown in the discovery page.
+    def preview
+      @bot.server_preview(@id)
+    end
+
     # @return [String, nil] the widget URL to the server that displays the amount of online members in a
     #   stylish way. `nil` if the widget is not enabled.
     def widget_url
@@ -397,7 +397,7 @@ module Discordrb
     # @!visibility private
     def delete_role(role_id)
       @roles.reject! { |r| r.id == role_id }
-      @members.each do |_, member|
+      @members.each_value do |member|
         new_roles = member.roles.reject { |r| r.id == role_id }
         member.update_roles(new_roles)
       end
@@ -507,14 +507,19 @@ module Discordrb
     # Creates a role on this server which can then be modified. It will be initialized
     # with the regular role defaults the client uses unless specified, i.e. name is "new role",
     # permissions are the default, colour is the default etc.
-    # @param name [String] Name of the role to create
-    # @param colour [Integer, ColourRGB, #combined] The roles colour
-    # @param hoist [true, false]
-    # @param mentionable [true, false]
+    # @param name [String] Name of the role to create.
+    # @param colour [Integer, ColourRGB, #combined] The primary colour of the role to create.
+    # @param hoist [true, false] whether members of this role should be displayed seperately in the members list.
+    # @param mentionable [true, false] whether this role can mentioned by anyone in the server.
     # @param permissions [Integer, Array<Symbol>, Permissions, #bits] The permissions to write to the new role.
+    # @param icon [String, #read, nil] The base64 encoded image data, or a file like object that responds to #read.
+    # @param unicode_emoji [String, nil] The unicode emoji of the role to create, or nil.
+    # @param display_icon [String, File, #read, nil] The icon to display for the role. Overrides the **icon** and **unicode_emoji** parameters if passed.
     # @param reason [String] The reason the for the creation of this role.
+    # @param secondary_colour [Integer, ColourRGB, nil] The secondary colour of the role to create.
+    # @param tertiary_colour [Integer, ColourRGB, nil] The tertiary colour of the role to create.
     # @return [Role] the created role.
-    def create_role(name: 'new role', colour: 0, hoist: false, mentionable: false, permissions: 104_324_161, reason: nil)
+    def create_role(name: 'new role', colour: 0, hoist: false, mentionable: false, permissions: 104_324_161, secondary_colour: nil, tertiary_colour: nil, icon: nil, unicode_emoji: nil, display_icon: nil, reason: nil)
       colour = colour.respond_to?(:combined) ? colour.combined : colour
 
       permissions = if permissions.is_a?(Array)
@@ -525,7 +530,21 @@ module Discordrb
                       permissions
                     end
 
-      response = API::Server.create_role(@bot.token, @id, name, colour, hoist, mentionable, permissions, reason)
+      icon = icon.respond_to?(:read) ? Discordrb.encode64(icon) : icon
+
+      colours = {
+        primary_color: colour&.to_i,
+        tertiary_color: tertiary_colour&.to_i,
+        secondary_color: secondary_colour&.to_i
+      }
+
+      if display_icon.is_a?(String)
+        unicode_emoji = display_icon
+      elsif display_icon.respond_to?(:read)
+        icon = Discordrb.encode64(display_icon)
+      end
+
+      response = API::Server.create_role(@bot.token, @id, name, nil, hoist, mentionable, permissions&.to_s, reason, colours, icon, unicode_emoji)
 
       role = Role.new(JSON.parse(response), @bot, self)
       @roles << role
@@ -539,13 +558,9 @@ module Discordrb
     # @param reason [String] The reason the for the creation of this emoji.
     # @return [Emoji] The emoji that has been added.
     def add_emoji(name, image, roles = [], reason: nil)
-      image_string = image
-      if image.respond_to? :read
-        image_string = 'data:image/jpg;base64,'
-        image_string += Base64.strict_encode64(image.read)
-      end
+      image = image.respond_to?(:read) ? Discordrb.encode64(image) : image
 
-      data = JSON.parse(API::Server.add_emoji(@bot.token, @id, image_string, name, roles.map(&:resolve_id), reason))
+      data = JSON.parse(API::Server.add_emoji(@bot.token, @id, image, name, roles.map(&:resolve_id), reason))
       new_emoji = Emoji.new(data, @bot, self)
       @emoji[new_emoji.id] = new_emoji
     end
@@ -585,6 +600,17 @@ module Discordrb
       end
     end
 
+    # Searches a server for members that matches a username or a nickname.
+    # @param name [String] The username or nickname to search for.
+    # @param limit [Integer] The maximum number of members between 1-1000 to return. Returns 1 member by default.
+    # @return [Array<Member>, nil] An array of member objects that match the given parameters, or nil for no members.
+    def search_members(name:, limit: nil)
+      response = JSON.parse(API::Server.search_guild_members(@bot.token, @id, name, limit))
+      return nil if response.empty?
+
+      response.map { |mem| Member.new(mem, self, @bot) }
+    end
+
     # Retrieve banned users from this server.
     # @param limit [Integer] Number of users to return (up to maximum 1000, default 1000).
     # @param before_id [Integer] Consider only users before given user id.
@@ -599,10 +625,17 @@ module Discordrb
 
     # Bans a user from this server.
     # @param user [User, String, Integer] The user to ban.
-    # @param message_days [Integer] How many days worth of messages sent by the user should be deleted.
+    # @param message_days [Integer] How many days worth of messages sent by the user should be deleted. This is deprecated and will be removed in 4.0.
+    # @param message_seconds [Integer] How many seconds of messages sent by the user should be deleted.
     # @param reason [String] The reason the user is being banned.
-    def ban(user, message_days = 0, reason: nil)
-      API::Server.ban_user(@bot.token, @id, user.resolve_id, message_days, reason)
+    def ban(user, message_days = 0, message_seconds: nil, reason: nil)
+      delete_messages = if message_days != 0 && message_days
+                          message_days * 86_400
+                        else
+                          message_seconds || 0
+                        end
+
+      API::Server.ban_user!(@bot.token, @id, user.resolve_id, delete_messages, reason)
     end
 
     # Unbans a previously banned user from this server.
@@ -612,6 +645,20 @@ module Discordrb
       API::Server.unban_user(@bot.token, @id, user.resolve_id, reason)
     end
 
+    # Ban up to 200 users from this server in one go.
+    # @param users [Array<User, String, Integer>] Array of up to 200 users to ban.
+    # @param message_seconds [Integer] How many seconds of messages sent by the users should be deleted.
+    # @param reason [String] The reason these users are being banned.
+    # @return [BulkBan]
+    def bulk_ban(users:, message_seconds: 0, reason: nil)
+      raise ArgumentError, 'Can only ban between 1 and 200 users!' unless users.size.between?(1, 200)
+
+      return ban(users.first, 0, message_seconds: message_seconds, reason: reason) if users.size == 1
+
+      response = API::Server.bulk_ban(@bot.token, @id, users.map(&:resolve_id), message_seconds, reason)
+      BulkBan.new(JSON.parse(response), self, reason)
+    end
+
     # Kicks a user from this server.
     # @param user [User, String, Integer] The user to kick.
     # @param reason [String] The reason the user is being kicked.
@@ -627,22 +674,11 @@ module Discordrb
       API::Server.update_member(@bot.token, @id, user.resolve_id, channel_id: channel&.resolve_id)
     end
 
-    # Deletes this server. Be aware that this is permanent and impossible to undo, so be careful!
-    def delete
-      API::Server.delete(@bot.token, @id)
-    end
-
     # Leave the server.
     def leave
       API::User.leave_server(@bot.token, @id)
     end
 
-    # Transfers server ownership to another user.
-    # @param user [User, String, Integer] The user who should become the new owner.
-    def owner=(user)
-      API::Server.transfer_ownership(@bot.token, @id, user.resolve_id)
-    end
-
     # Sets the server's name.
     # @param name [String] The new server name.
     def name=(name)
@@ -674,10 +710,8 @@ module Discordrb
     # Sets the server's icon.
     # @param icon [String, #read] The new icon, in base64-encoded JPG format.
     def icon=(icon)
-      if icon.respond_to? :read
-        icon_string = 'data:image/jpg;base64,'
-        icon_string += Base64.strict_encode64(icon.read)
-        update_server_data(icon_id: icon_string)
+      if icon.respond_to?(:read)
+        update_server_data(icon_id: Discordrb.encode64(icon))
       else
         update_server_data(icon_id: icon)
       end
@@ -830,11 +864,11 @@ module Discordrb
       @afk_timeout = new_data[:afk_timeout] || new_data['afk_timeout'] || @afk_timeout
 
       afk_channel_id = new_data[:afk_channel_id] || new_data['afk_channel_id'] || @afk_channel
-      @afk_channel_id = afk_channel_id.nil? ? nil : afk_channel_id.resolve_id
+      @afk_channel_id = afk_channel_id&.resolve_id
       widget_channel_id = new_data[:widget_channel_id] || new_data['widget_channel_id'] || @widget_channel
-      @widget_channel_id = widget_channel_id.nil? ? nil : widget_channel_id.resolve_id
+      @widget_channel_id = widget_channel_id&.resolve_id
       system_channel_id = new_data[:system_channel_id] || new_data['system_channel_id'] || @system_channel
-      @system_channel_id = system_channel_id.nil? ? nil : system_channel_id.resolve_id
+      @system_channel_id = system_channel_id&.resolve_id
 
       @widget_enabled = new_data[:widget_enabled] || new_data['widget_enabled']
       @splash = new_data[:splash_id] || new_data['splash_id'] || @splash_id
@@ -848,6 +882,9 @@ module Discordrb
       @splash_id = new_data['splash'] || @splash_id
       @banner_id = new_data['banner'] || @banner_id
       @features = new_data['features'] ? new_data['features'].map { |element| element.downcase.to_sym } : @features || []
+      @booster_count = new_data['premium_subscription_count'] || @booster_count || 0
+      @boost_level = new_data['premium_tier'] || @boost_level
+      @owner_id = new_data['owner_id'].to_i
 
       process_channels(new_data['channels']) if new_data['channels']
       process_roles(new_data['roles']) if new_data['roles']
@@ -855,6 +892,7 @@ module Discordrb
       process_members(new_data['members']) if new_data['members']
       process_presences(new_data['presences']) if new_data['presences']
       process_voice_states(new_data['voice_states']) if new_data['voice_states']
+      process_active_threads(new_data['threads']) if new_data['threads']
     end
 
     # Adds a channel to this server's cache
@@ -972,6 +1010,19 @@ module Discordrb
         update_voice_state(element)
       end
     end
+
+    def process_active_threads(threads)
+      @channels ||= []
+      @channels_by_id ||= {}
+
+      return unless threads
+
+      threads.each do |element|
+        thread = @bot.ensure_channel(element, self)
+        @channels << thread
+        @channels_by_id[thread.id] = thread
+      end
+    end
   end
 
   # A ban entry on a server
@@ -1001,4 +1052,27 @@ module Discordrb
     alias_method :unban, :remove
     alias_method :lift, :remove
   end
+
+  # A bulk ban entry on a server
+  class BulkBan
+    # @return [Server] The server this bulk ban belongs to.
+    attr_reader :server
+
+    # @return [String, nil] The reason these users were banned.
+    attr_reader :reason
+
+    # @return [Array<Integer>] Array of user IDs that were banned.
+    attr_reader :banned_users
+
+    # @return [Array<Integer>] Array of user IDs that couldn't be banned.
+    attr_reader :failed_users
+
+    # @!visibility private
+    def initialize(data, server, reason)
+      @server = server
+      @reason = reason
+      @banned_users = data['banned_users']&.map(&:resolve_id) || []
+      @failed_users = data['failed_users']&.map(&:resolve_id) || []
+    end
+  end
 end

data/lib/discordrb/data/server_preview.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Discordrb
+  # Publicly accessible information about a discoverable server.
+  class ServerPreview
+    include IDObject
+    include ServerAttributes
+
+    # @return [String, nil] the ID of the server's invite splash screen.
+    # @see #splash_url
+    attr_reader :splash_id
+
+    # @return [String, nil] the ID of the server's discovery splash screen.
+    # @see #discovery_splash_url
+    attr_reader :discovery_splash_id
+
+    # @return [Hash<Integer => Emoji>] a hash of all the emojis usable on this server.
+    attr_reader :emojis
+
+    # @return [Array<Symbol>] the features of this server, e.g. `:banner` or `:verified`.
+    attr_reader :features
+
+    # @return [Integer] the approximate number of members on this server, offline or not.
+    attr_reader :member_count
+
+    # @return [Integer] the approximate number of members that aren't offline on this server.
+    attr_reader :presence_count
+
+    # @return [String, nil] the description of this server that's shown in the discovery tab.
+    attr_reader :description
+
+    # @!visibility private
+    def initialize(data, bot)
+      @bot = bot
+      @id = data['id'].to_i
+      @name = data['name']
+      @icon_id = data['icon']
+      @splash_id = data['splash']
+      @description = data['description']
+      @discovery_splash_id = data['discovery_splash']
+      @member_count = data['approximate_member_count']
+      @presence_count = data['approximate_presence_count']
+      @features = data['features'].map { |feature| feature.downcase.to_sym }
+      @emojis = data['emojis'].to_h { |emoji| [emoji['id'].to_i, Emoji.new(emoji, bot)] }
+    end
+
+    # Get the server associated with this server preview.
+    # @return [Server] the server associated with this server preview.
+    # @raise [Discordrb::Errors::NoPermission] this can happen when the bot is not in the associated server.
+    def server
+      @bot.server(@id)
+    end
+
+    # Utility method to get a server preview's splash URL.
+    # @param format [String] the URL will default to `webp`. You can otherwise specify one of `jpg` or `png` to override this.
+    # @return [String, nil] the URL to the server's splash image, or `nil` if the server doesn't have a splash image.
+    def splash_url(format = 'webp')
+      API.splash_url(@id, @splash_id, format) if @splash_id
+    end
+
+    # Utility method to get a server preview's discovery splash URL.
+    # @param format [String] the URL will default to `webp`. You can otherwise specify one of `jpg` or `png` to override this.
+    # @return [String, nil] the URL to the server's discovery splash image, or `nil` if the server doesn't have a discovery splash image.
+    def discovery_splash_url(format = 'webp')
+      API.discovery_splash_url(@id, @discovery_splash_id, format) if @discovery_splash_id
+    end
+  end
+end