discordrb 3.1.1 → 3.4.0

data/lib/discordrb/api/invite.rb

@@ -1,33 +1,36 @@
+# frozen_string_literal: true
+
 # API calls for Invite object
 module Discordrb::API::Invite
   module_function
 
   # Resolve an invite
-  # https://discordapp.com/developers/docs/resources/invite#get-invite
-  def resolve(token, invite_code)
+  # https://discord.com/developers/docs/resources/invite#get-invite
+  def resolve(token, invite_code, counts = true)
     Discordrb::API.request(
       :invite_code,
       nil,
       :get,
-      "#{Discordrb::API.api_base}/invite/#{invite_code}",
+      "#{Discordrb::API.api_base}/invite/#{invite_code}#{counts ? '?with_counts=true' : ''}",
       Authorization: token
     )
   end
 
   # Delete an invite by code
-  # https://discordapp.com/developers/docs/resources/invite#delete-invite
-  def delete(token, code)
+  # https://discord.com/developers/docs/resources/invite#delete-invite
+  def delete(token, code, reason = nil)
     Discordrb::API.request(
       :invites_code,
       nil,
       :delete,
       "#{Discordrb::API.api_base}/invites/#{code}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Join a server using an invite
-  # https://discordapp.com/developers/docs/resources/invite#accept-invite
+  # https://discord.com/developers/docs/resources/invite#accept-invite
   def accept(token, invite_code)
     Discordrb::API.request(
       :invite_code,

data/lib/discordrb/api/server.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 # API calls for Server
 module Discordrb::API::Server
   module_function
 
   # Create a server
-  # https://discordapp.com/developers/docs/resources/guild#create-guild
-  def create(token, name, region = :london)
+  # https://discord.com/developers/docs/resources/guild#create-guild
+  def create(token, name, region = :'eu-central')
     Discordrb::API.request(
       :guilds,
       nil,
@@ -17,33 +19,34 @@ module Discordrb::API::Server
   end
 
   # Get a server's data
-  # https://discordapp.com/developers/docs/resources/guild#get-guild
-  def resolve(token, server_id)
+  # https://discord.com/developers/docs/resources/guild#get-guild
+  def resolve(token, server_id, with_counts = nil)
     Discordrb::API.request(
       :guilds_sid,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}#{'?with_counts=true' if with_counts}",
       Authorization: token
     )
   end
 
   # Update a server
-  # https://discordapp.com/developers/docs/resources/guild#modify-guild
-  def update(token, server_id, name, region, icon, afk_channel_id, afk_timeout)
+  # https://discord.com/developers/docs/resources/guild#modify-guild
+  def update(token, server_id, name, region, icon, afk_channel_id, afk_timeout, splash, default_message_notifications, verification_level, explicit_content_filter, system_channel_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}",
-      { name: name, region: region, icon: icon, afk_channel_id: afk_channel_id, afk_timeout: afk_timeout }.to_json,
+      { name: name, region: region, icon: icon, afk_channel_id: afk_channel_id, afk_timeout: afk_timeout, splash: splash, default_message_notifications: default_message_notifications, verification_level: verification_level, explicit_content_filter: explicit_content_filter, system_channel_id: system_channel_id }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Transfer server ownership
-  def transfer_ownership(token, server_id, user_id)
+  def transfer_ownership(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid,
       server_id,
@@ -51,12 +54,13 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}",
       { owner_id: user_id }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Delete a server
-  # https://discordapp.com/developers/docs/resources/guild#delete-guild
+  # https://discord.com/developers/docs/resources/guild#delete-guild
   def delete(token, server_id)
     Discordrb::API.request(
       :guilds_sid,
@@ -68,7 +72,7 @@ module Discordrb::API::Server
   end
 
   # Get a server's channels list
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-channels
+  # https://discord.com/developers/docs/resources/guild#get-guild-channels
   def channels(token, server_id)
     Discordrb::API.request(
       :guilds_sid_channels,
@@ -80,35 +84,36 @@ module Discordrb::API::Server
   end
 
   # Create a channel
-  # https://discordapp.com/developers/docs/resources/guild#create-guild-channel
-  def create_channel(token, server_id, name, type)
+  # https://discord.com/developers/docs/resources/guild#create-guild-channel
+  def create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, position, reason = nil)
     Discordrb::API.request(
       :guilds_sid_channels,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
-      { name: name, type: type }.to_json,
+      { name: name, type: type, topic: topic, bitrate: bitrate, user_limit: user_limit, permission_overwrites: permission_overwrites, parent_id: parent_id, nsfw: nsfw, rate_limit_per_user: rate_limit_per_user, position: position }.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Update a channels position
-  # https://discordapp.com/developers/docs/resources/guild#modify-guild-channel
-  def update_channel(token, server_id, channel_id, position)
+  # https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions
+  def update_channel_positions(token, server_id, positions)
     Discordrb::API.request(
       :guilds_sid_channels,
       server_id,
       :patch,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
-      { id: channel_id, position: position }.to_json,
+      positions.to_json,
       Authorization: token,
       content_type: :json
     )
   end
 
   # Get a member's data
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-member
+  # https://discord.com/developers/docs/resources/guild#get-guild-member
   def resolve_member(token, server_id, user_id)
     Discordrb::API.request(
       :guilds_sid_members_uid,
@@ -120,7 +125,7 @@ module Discordrb::API::Server
   end
 
   # Gets members from the server
-  # https://discordapp.com/developers/docs/resources/guild#list-guild-members
+  # https://discord.com/developers/docs/resources/guild#list-guild-members
   def resolve_members(token, server_id, limit, after = nil)
     Discordrb::API.request(
       :guilds_sid_members,
@@ -132,8 +137,8 @@ module Discordrb::API::Server
   end
 
   # Update a user properties
-  # https://discordapp.com/developers/docs/resources/guild#modify-guild-member
-  def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil)
+  # https://discord.com/developers/docs/resources/guild#modify-guild-member
+  def update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil, reason: nil)
     Discordrb::API.request(
       :guilds_sid_members_uid,
       server_id,
@@ -144,27 +149,29 @@ module Discordrb::API::Server
         mute: mute,
         deaf: deaf,
         channel_id: channel_id
-      }.reject { |_, v| v.nil? }.to_json,
+      }.compact.to_json,
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Remove user from server
-  # https://discordapp.com/developers/docs/resources/guild#remove-guild-member
-  def remove_member(token, server_id, user_id)
+  # https://discord.com/developers/docs/resources/guild#remove-guild-member
+  def remove_member(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_members_uid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
       Authorization: token,
-      content_type: :json
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get a server's banned users
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-bans
+  # https://discord.com/developers/docs/resources/guild#get-guild-bans
   def bans(token, server_id)
     Discordrb::API.request(
       :guilds_sid_bans,
@@ -176,32 +183,34 @@ module Discordrb::API::Server
   end
 
   # Ban a user from a server and delete their messages from the last message_days days
-  # https://discordapp.com/developers/docs/resources/guild#create-guild-ban
-  def ban_user(token, server_id, user_id, message_days)
+  # https://discord.com/developers/docs/resources/guild#create-guild-ban
+  def ban_user(token, server_id, user_id, message_days, reason = nil)
+    reason = URI.encode_www_form_component(reason) if reason
     Discordrb::API.request(
       :guilds_sid_bans_uid,
       server_id,
       :put,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}&reason=#{reason}",
       nil,
       Authorization: token
     )
   end
 
   # Unban a user from a server
-  # https://discordapp.com/developers/docs/resources/guild#remove-guild-ban
-  def unban_user(token, server_id, user_id)
+  # https://discord.com/developers/docs/resources/guild#remove-guild-ban
+  def unban_user(token, server_id, user_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_bans_uid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/bans/#{user_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get server roles
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-roles
+  # https://discord.com/developers/docs/resources/guild#get-guild-roles
   def roles(token, server_id)
     Discordrb::API.request(
       :guilds_sid_roles,
@@ -212,16 +221,21 @@ module Discordrb::API::Server
     )
   end
 
-  # Create a role (parameters such as name and colour will have to be set by update_role afterwards)
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-roles
-  def create_role(token, server_id)
+  # Create a role (parameters such as name and colour if not set can be set by update_role afterwards)
+  # Permissions are the Discord defaults; allowed: invite creation, reading/sending messages,
+  # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
+  # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
+  # https://discord.com/developers/docs/resources/guild#get-guild-roles
+  def create_role(token, server_id, name, colour, hoist, mentionable, packed_permissions, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
-      nil,
-      Authorization: token
+      { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
     )
   end
 
@@ -229,8 +243,8 @@ module Discordrb::API::Server
   # Permissions are the Discord defaults; allowed: invite creation, reading/sending messages,
   # sending TTS messages, embedding links, sending files, reading the history, mentioning everybody,
   # connecting to voice, speaking and voice activity (push-to-talk isn't mandatory)
-  # https://discordapp.com/developers/docs/resources/guild#batch-modify-guild-role
-  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 36_953_089)
+  # https://discord.com/developers/docs/resources/guild#batch-modify-guild-role
+  def update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles_rid,
       server_id,
@@ -238,49 +252,93 @@ module Discordrb::API::Server
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
       { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
       Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Update role positions
+  # https://discord.com/developers/docs/resources/guild#modify-guild-role-positions
+  def update_role_positions(token, server_id, roles)
+    Discordrb::API.request(
+      :guilds_sid_roles,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
+      roles.to_json,
+      Authorization: token,
       content_type: :json
     )
   end
 
   # Delete a role
-  # https://discordapp.com/developers/docs/resources/guild#delete-guild-role
-  def delete_role(token, server_id, role_id)
+  # https://discord.com/developers/docs/resources/guild#delete-guild-role
+  def delete_role(token, server_id, role_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_roles_rid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/roles/#{role_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Adds a single role to a member
+  # https://discord.com/developers/docs/resources/guild#add-guild-member-role
+  def add_member_role(token, server_id, user_id, role_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_members_uid_roles_rid,
+      server_id,
+      :put,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
+      nil,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Removes a single role from a member
+  # https://discord.com/developers/docs/resources/guild#remove-guild-member-role
+  def remove_member_role(token, server_id, user_id, role_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_members_uid_roles_rid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get server prune count
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-prune-count
-  def prune_count(token, server_id)
+  # https://discord.com/developers/docs/resources/guild#get-guild-prune-count
+  def prune_count(token, server_id, days)
     Discordrb::API.request(
       :guilds_sid_prune,
       server_id,
       :get,
-      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/prune?days=#{days}",
       Authorization: token
     )
   end
 
   # Begin server prune
-  # https://discordapp.com/developers/docs/resources/guild#begin-guild-prune
-  def begin_prune(token, server_id, days)
+  # https://discord.com/developers/docs/resources/guild#begin-guild-prune
+  def begin_prune(token, server_id, days, reason = nil)
     Discordrb::API.request(
       :guilds_sid_prune,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/prune",
       { days: days },
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Get invites from server
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-invites
+  # https://discord.com/developers/docs/resources/guild#get-guild-invites
   def invites(token, server_id)
     Discordrb::API.request(
       :guilds_sid_invites,
@@ -291,8 +349,20 @@ module Discordrb::API::Server
     )
   end
 
+  # Gets a server's audit logs
+  # https://discord.com/developers/docs/resources/audit-log#get-guild-audit-log
+  def audit_logs(token, server_id, limit, user_id = nil, action_type = nil, before = nil)
+    Discordrb::API.request(
+      :guilds_sid_auditlogs,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/audit-logs?limit=#{limit}#{"&user_id=#{user_id}" if user_id}#{"&action_type=#{action_type}" if action_type}#{"&before=#{before}" if before}",
+      Authorization: token
+    )
+  end
+
   # Get server integrations
-  # https://discordapp.com/developers/docs/resources/guild#get-guild-integrations
+  # https://discord.com/developers/docs/resources/guild#get-guild-integrations
   def integrations(token, server_id)
     Discordrb::API.request(
       :guilds_sid_integrations,
@@ -305,19 +375,20 @@ module Discordrb::API::Server
 
   # Create a server integration
   # https://discordapp.com/developers/docs/resources/guild#create-guild-integration
-  def create_integration(token, server_id, type, id)
+  def create_integration(token, server_id, type, id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_integrations,
       server_id,
       :post,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
       { type: type, id: id },
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Update integration from server
-  # https://discordapp.com/developers/docs/resources/guild#modify-guild-integration
+  # https://discord.com/developers/docs/resources/guild#modify-guild-integration
   def update_integration(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons)
     Discordrb::API.request(
       :guilds_sid_integrations_iid,
@@ -332,18 +403,19 @@ module Discordrb::API::Server
 
   # Delete a server integration
   # https://discordapp.com/developers/docs/resources/guild#delete-guild-integration
-  def delete_integration(token, server_id, integration_id)
+  def delete_integration(token, server_id, integration_id, reason = nil)
     Discordrb::API.request(
       :guilds_sid_integrations_iid,
       server_id,
       :delete,
       "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
-      Authorization: token
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
     )
   end
 
   # Sync an integration
-  # https://discordapp.com/developers/docs/resources/guild#sync-guild-integration
+  # https://discord.com/developers/docs/resources/guild#sync-guild-integration
   def sync_integration(token, server_id, integration_id)
     Discordrb::API.request(
       :guilds_sid_integrations_iid_sync,
@@ -354,4 +426,111 @@ module Discordrb::API::Server
       Authorization: token
     )
   end
+
+  # Retrieves a server's embed information
+  # https://discord.com/developers/docs/resources/guild#get-guild-embed
+  def embed(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_embed,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      Authorization: token
+    )
+  end
+
+  # Modify a server's embed settings
+  # https://discord.com/developers/docs/resources/guild#modify-guild-embed
+  def modify_embed(token, server_id, enabled, channel_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_embed,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/embed",
+      { enabled: enabled, channel_id: channel_id }.to_json,
+      Authorization: token,
+      'X-Audit-Log-Reason': reason,
+      content_type: :json
+    )
+  end
+
+  # Adds a custom emoji.
+  # https://discord.com/developers/docs/resources/emoji#create-guild-emoji
+  def add_emoji(token, server_id, image, name, roles = [], reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_emojis,
+      server_id,
+      :post,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis",
+      { image: image, name: name, roles: roles }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Changes an emoji name and/or roles.
+  # https://discord.com/developers/docs/resources/emoji#modify-guild-emoji
+  def edit_emoji(token, server_id, emoji_id, name, roles = nil, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_emojis_eid,
+      server_id,
+      :patch,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
+      { name: name, roles: roles }.to_json,
+      Authorization: token,
+      content_type: :json,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Deletes a custom emoji
+  # https://discord.com/developers/docs/resources/emoji#delete-guild-emoji
+  def delete_emoji(token, server_id, emoji_id, reason = nil)
+    Discordrb::API.request(
+      :guilds_sid_emojis_eid,
+      server_id,
+      :delete,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
+      Authorization: token,
+      'X-Audit-Log-Reason': reason
+    )
+  end
+
+  # Available voice regions for this server
+  def regions(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_regions,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/regions",
+      Authorization: token
+    )
+  end
+
+  # Get server webhooks
+  # https://discord.com/developers/docs/resources/webhook#get-guild-webhooks
+  def webhooks(token, server_id)
+    Discordrb::API.request(
+      :guilds_sid_webhooks,
+      server_id,
+      :get,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/webhooks",
+      Authorization: token
+    )
+  end
+
+  # Adds a member to a server with an OAuth2 Bearer token that has been granted `guilds.join`
+  # https://discord.com/developers/docs/resources/guild#add-guild-member
+  def add_member(token, server_id, user_id, access_token, nick = nil, roles = [], mute = false, deaf = false)
+    Discordrb::API.request(
+      :guilds_sid_members_uid,
+      server_id,
+      :put,
+      "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
+      { access_token: access_token, nick: nick, roles: roles, mute: mute, deaf: deaf }.to_json,
+      content_type: :json,
+      Authorization: token
+    )
+  end
 end