module MijDiscord::Core::API::Server

Public Class Methods

add_emoji(auth, server_id, image, name, reason = nil) click to toggle source

Adds a custom emoji

# File lib/mij-discord/core/api/server.rb, line 403
def add_emoji(auth, server_id, image, name, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_emojis,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/emojis",
    { image: image, name: name }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
add_member_role(auth, server_id, user_id, role_id, reason = nil) click to toggle source

Adds a single role to a member discordapp.com/developers/docs/resources/guild#add-guild-member-role

# File lib/mij-discord/core/api/server.rb, line 275
def add_member_role(auth, server_id, user_id, role_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_members_uid_roles_rid,
    server_id,
    :put,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
    nil,
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
ban_user(auth, server_id, user_id, message_days, reason = nil) click to toggle source

Ban a user from a server and delete their messages from the last message_days days discordapp.com/developers/docs/resources/guild#create-guild-ban

# File lib/mij-discord/core/api/server.rb, line 184
def ban_user(auth, server_id, user_id, message_days, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_bans_uid,
    server_id,
    :put,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/bans/#{user_id}?delete-message-days=#{message_days}",
    nil,
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
bans(auth, server_id) click to toggle source

Get a server's banned users discordapp.com/developers/docs/resources/guild#get-guild-bans

# File lib/mij-discord/core/api/server.rb, line 172
def bans(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_bans,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/bans",
    Authorization: auth
  )
end
begin_prune(auth, server_id, days, reason = nil) click to toggle source

Begin server prune discordapp.com/developers/docs/resources/guild#begin-guild-prune

# File lib/mij-discord/core/api/server.rb, line 314
def begin_prune(auth, server_id, days, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_prune,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/prune",
    { days: days }.to_json,
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
channels(auth, server_id) click to toggle source

Get a server's channels list discordapp.com/developers/docs/resources/guild#get-guild-channels

# File lib/mij-discord/core/api/server.rb, line 77
def channels(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_channels,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/channels",
    Authorization: auth
  )
end
create(auth, name, region = :'eu-central') click to toggle source

Create a server discordapp.com/developers/docs/resources/guild#create-guild

# File lib/mij-discord/core/api/server.rb, line 7
def create(auth, name, region = :'eu-central')
  MijDiscord::Core::API.request(
    :guilds,
    nil,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds",
    { name: name, region: region.to_s }.to_json,
    Authorization: auth,
    content_type: :json
  )
end
create_channel(auth, server_id, name, type, bitrate, user_limit, permissions, nsfw, reason = nil) click to toggle source

Create a channel discordapp.com/developers/docs/resources/guild#create-guild-channel

# File lib/mij-discord/core/api/server.rb, line 89
def create_channel(auth, server_id, name, type, bitrate, user_limit, permissions, nsfw, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_channels,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/channels",
    { name: name, type: type, bitrate: bitrate, user_limit: user_limit, permission_overwrites: permissions, nsfw: nsfw }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
create_integration(auth, server_id, type, id) click to toggle source

Create a server integration discordapp.com/developers/docs/resources/guild#create-guild-integration

# File lib/mij-discord/core/api/server.rb, line 352
def create_integration(auth, server_id, type, id)
  MijDiscord::Core::API.request(
    :guilds_sid_integrations,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/integrations",
    { type: type, id: id }.to_json,
    Authorization: auth
  )
end
create_role(auth, server_id, name, color, hoist, mentionable, permissions, reason = nil) click to toggle source

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) discordapp.com/developers/docs/resources/guild#get-guild-roles

# File lib/mij-discord/core/api/server.rb, line 226
def create_role(auth, server_id, name, color, hoist, mentionable, permissions, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_roles,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/roles",
    { color: color, name: name, hoist: hoist, mentionable: mentionable, permissions: permissions }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
delete(auth, server_id) click to toggle source

Delete a server discordapp.com/developers/docs/resources/guild#delete-guild

# File lib/mij-discord/core/api/server.rb, line 65
def delete(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}",
    Authorization: auth
  )
end
delete_emoji(auth, server_id, emoji_id, reason = nil) click to toggle source

Deletes a custom emoji

# File lib/mij-discord/core/api/server.rb, line 431
def delete_emoji(auth, server_id, emoji_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_emojis_eid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/emojis/#{emoji_id}",
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
delete_integration(auth, server_id, integration_id) click to toggle source

Delete a server integration discordapp.com/developers/docs/resources/guild#delete-guild-integration

# File lib/mij-discord/core/api/server.rb, line 379
def delete_integration(auth, server_id, integration_id)
  MijDiscord::Core::API.request(
    :guilds_sid_integrations_iid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/integrations/#{integration_id}",
    Authorization: auth
  )
end
delete_role(auth, server_id, role_id, reason = nil) click to toggle source

Delete a role discordapp.com/developers/docs/resources/guild#delete-guild-role

# File lib/mij-discord/core/api/server.rb, line 262
def delete_role(auth, server_id, role_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_roles_rid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/roles/#{role_id}",
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
edit_emoji(auth, server_id, emoji_id, name, reason = nil) click to toggle source

Changes an emoji name

# File lib/mij-discord/core/api/server.rb, line 417
def edit_emoji(auth, server_id, emoji_id, name, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_emojis_eid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/emojis/#{emoji_id}",
    { name: name }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
integrations(auth, server_id) click to toggle source

Get server integrations discordapp.com/developers/docs/resources/guild#get-guild-integrations

# File lib/mij-discord/core/api/server.rb, line 340
def integrations(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_integrations,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/integrations",
    Authorization: auth
  )
end
invites(auth, server_id) click to toggle source

Get invites from server discordapp.com/developers/docs/resources/guild#get-guild-invites

# File lib/mij-discord/core/api/server.rb, line 328
def invites(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_invites,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/invites",
    Authorization: auth
  )
end
prune_count(auth, server_id, days) click to toggle source

Get server prune count discordapp.com/developers/docs/resources/guild#get-guild-prune-count

# File lib/mij-discord/core/api/server.rb, line 302
def prune_count(auth, server_id, days)
  MijDiscord::Core::API.request(
    :guilds_sid_prune,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/prune?days=#{days}",
    Authorization: auth
  )
end
regions(auth, server_id) click to toggle source

Available voice regions for this server

# File lib/mij-discord/core/api/server.rb, line 443
def regions(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_regions,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/regions",
    Authorization: auth
  )
end
remove_member(auth, server_id, user_id, reason = nil) click to toggle source

Remove user from server discordapp.com/developers/docs/resources/guild#remove-guild-member

# File lib/mij-discord/core/api/server.rb, line 158
def remove_member(auth, server_id, user_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_members_uid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members/#{user_id}",
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
remove_member_role(auth, server_id, user_id, role_id, reason = nil) click to toggle source

Removes a single role from a member discordapp.com/developers/docs/resources/guild#remove-guild-member-role

# File lib/mij-discord/core/api/server.rb, line 289
def remove_member_role(auth, server_id, user_id, role_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_members_uid_roles_rid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members/#{user_id}/roles/#{role_id}",
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
resolve(auth, server_id) click to toggle source

Get a server's data discordapp.com/developers/docs/resources/guild#get-guild

# File lib/mij-discord/core/api/server.rb, line 21
def resolve(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}",
    Authorization: auth
  )
end
resolve_member(auth, server_id, user_id) click to toggle source

Get a member's data discordapp.com/developers/docs/resources/guild#get-guild-member

# File lib/mij-discord/core/api/server.rb, line 119
def resolve_member(auth, server_id, user_id)
  MijDiscord::Core::API.request(
    :guilds_sid_members_uid,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members/#{user_id}",
    Authorization: auth
  )
end
resolve_members(auth, server_id, limit, after = nil) click to toggle source

Gets members from the server discordapp.com/developers/docs/resources/guild#list-guild-members

# File lib/mij-discord/core/api/server.rb, line 131
def resolve_members(auth, server_id, limit, after = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_members,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members?limit=#{limit}#{"&after=#{after}" if after}",
    Authorization: auth
  )
end
roles(auth, server_id) click to toggle source

Get server roles discordapp.com/developers/docs/resources/guild#get-guild-roles

# File lib/mij-discord/core/api/server.rb, line 211
def roles(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_roles,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/roles",
    Authorization: auth
  )
end
search_messages(auth, server_id, options) click to toggle source

Search messages (for userbots only) Not officially documented, reverse engineered from tracking Discord's network activity

# File lib/mij-discord/core/api/server.rb, line 467
def search_messages(auth, server_id, options)
  options = URI.encode_www_form(options)
  MijDiscord::Core::API.request(
    :guilds_guild_messages_search,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/messages/search?#{options}",
    Authorization: auth
  )
end
sync_integration(auth, server_id, integration_id) click to toggle source

Sync an integration discordapp.com/developers/docs/resources/guild#sync-guild-integration

# File lib/mij-discord/core/api/server.rb, line 391
def sync_integration(auth, server_id, integration_id)
  MijDiscord::Core::API.request(
    :guilds_sid_integrations_iid_sync,
    server_id,
    :post,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/integrations/#{integration_id}/sync",
    nil,
    Authorization: auth
  )
end
transfer_ownership(auth, server_id, user_id, reason = nil) click to toggle source

Transfer server ownership

# File lib/mij-discord/core/api/server.rb, line 50
def transfer_ownership(auth, server_id, user_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}",
    { owner_id: user_id }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
unban_user(auth, server_id, user_id, reason = nil) click to toggle source

Unban a user from a server discordapp.com/developers/docs/resources/guild#remove-guild-ban

# File lib/mij-discord/core/api/server.rb, line 198
def unban_user(auth, server_id, user_id, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_bans_uid,
    server_id,
    :delete,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/bans/#{user_id}",
    Authorization: auth,
    'X-Audit-Log-Reason': reason
  )
end
update(auth, server_id, name, region, icon, afk_channel_id, afk_timeout, reason = nil) click to toggle source

Update a server discordapp.com/developers/docs/resources/guild#modify-guild

# File lib/mij-discord/core/api/server.rb, line 33
def update(auth, server_id, name, region, icon, afk_channel_id, afk_timeout, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}",
    {
      name: name, region: region, icon: icon,
      afk_channel_id: afk_channel_id, afk_timeout: afk_timeout
    }.delete_if {|_, v| v.nil? }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
update_channel_position(auth, server_id, channel_id, position, reason = nil) click to toggle source

Update a channels position discordapp.com/developers/docs/resources/guild#modify-guild-channel

# File lib/mij-discord/core/api/server.rb, line 104
def update_channel_position(auth, server_id, channel_id, position, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_channels,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/channels",
    { id: channel_id, position: position }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
update_integration(auth, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons) click to toggle source

Update integration from server discordapp.com/developers/docs/resources/guild#modify-guild-integration

# File lib/mij-discord/core/api/server.rb, line 365
def update_integration(auth, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons)
  MijDiscord::Core::API.request(
    :guilds_sid_integrations_iid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/integrations/#{integration_id}",
    { expire_behavior: expire_behavior, expire_grace_period: expire_grace_period, enable_emoticons: enable_emoticons }.to_json,
    Authorization: auth,
    content_type: :json
  )
end
update_member(auth, server_id, user_id, reason = nil, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil) click to toggle source

Update a user properties discordapp.com/developers/docs/resources/guild#modify-guild-member

# File lib/mij-discord/core/api/server.rb, line 143
def update_member(auth, server_id, user_id, reason = nil, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil)
  MijDiscord::Core::API.request(
    :guilds_sid_members_uid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/members/#{user_id}",
    { roles: roles, nick: nick, mute: mute, deaf: deaf, channel_id: channel_id }.delete_if {|_,v| v.nil? }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
update_role(auth, server_id, role_id, name, color, hoist, mentionable, permissions, reason = nil) click to toggle source

Update a role 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) discordapp.com/developers/docs/resources/guild#modify-guild-role

# File lib/mij-discord/core/api/server.rb, line 244
def update_role(auth, server_id, role_id, name, color, hoist, mentionable, permissions, reason = nil)
  MijDiscord::Core::API.request(
    :guilds_sid_roles_rid,
    server_id,
    :patch,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/roles/#{role_id}",
    {
      color: color, name: name, hoist: hoist,
      mentionable: mentionable, permissions: permissions
    }.delete_if {|_, v| v.nil? }.to_json,
    Authorization: auth,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end
webhooks(auth, server_id) click to toggle source

Get server webhooks discordapp.com/developers/docs/resources/webhook#get-guild-webhooks

# File lib/mij-discord/core/api/server.rb, line 455
def webhooks(auth, server_id)
  MijDiscord::Core::API.request(
    :guilds_sid_webhooks,
    server_id,
    :get,
    "#{MijDiscord::Core::API::APIBASE_URL}/guilds/#{server_id}/webhooks",
    Authorization: auth
  )
end