Module: MijDiscord::Core::API::Server

Defined in:
lib/mij-discord/core/api/server.rb

Class Method Summary collapse

Class Method Details

.add_emoji(auth, server_id, image, name, reason = nil) ⇒ Object

Adds a custom emoji



403
404
405
406
407
408
409
410
411
412
413
414
 
# 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) ⇒ Object

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



275
276
277
278
279
280
281
282
283
284
285
 
# 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) ⇒ Object

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



184
185
186
187
188
189
190
191
192
193
194
 
# 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) ⇒ Object

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



172
173
174
175
176
177
178
179
180
 
# 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) ⇒ Object

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



314
315
316
317
318
319
320
321
322
323
324
 
# 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) ⇒ Object

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



77
78
79
80
81
82
83
84
85
 
# 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') ⇒ Object

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



7
8
9
10
11
12
13
14
15
16
17
 
# 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) ⇒ Object

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



89
90
91
92
93
94
95
96
97
98
99
100
 
# 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) ⇒ Object

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



352
353
354
355
356
357
358
359
360
361
 
# 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) ⇒ Object

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



226
227
228
229
230
231
232
233
234
235
236
237
 
# 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) ⇒ Object

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



65
66
67
68
69
70
71
72
73
 
# 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) ⇒ Object

Deletes a custom emoji



431
432
433
434
435
436
437
438
439
440
 
# 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) ⇒ Object

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



379
380
381
382
383
384
385
386
387
 
# 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) ⇒ Object

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



262
263
264
265
266
267
268
269
270
271
 
# 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) ⇒ Object

Changes an emoji name



417
418
419
420
421
422
423
424
425
426
427
428
 
# 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) ⇒ Object

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



340
341
342
343
344
345
346
347
348
 
# 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) ⇒ Object

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



328
329
330
331
332
333
334
335
336
 
# 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) ⇒ Object

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



302
303
304
305
306
307
308
309
310
 
# 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) ⇒ Object

Available voice regions for this server



443
444
445
446
447
448
449
450
451
 
# 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) ⇒ Object

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



158
159
160
161
162
163
164
165
166
167
168
 
# 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) ⇒ Object

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



289
290
291
292
293
294
295
296
297
298
 
# 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) ⇒ Object

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



21
22
23
24
25
26
27
28
29
 
# 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) ⇒ Object

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



119
120
121
122
123
124
125
126
127
 
# 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) ⇒ Object

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



131
132
133
134
135
136
137
138
139
 
# 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) ⇒ Object

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



211
212
213
214
215
216
217
218
219
 
# 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) ⇒ Object

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



467
468
469
470
471
472
473
474
475
476
 
# 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) ⇒ Object

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



391
392
393
394
395
396
397
398
399
400
 
# 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) ⇒ Object

Transfer server ownership



50
51
52
53
54
55
56
57
58
59
60
61
 
# 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) ⇒ Object

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



198
199
200
201
202
203
204
205
206
207
 
# 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) ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# 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) ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
 
# 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) ⇒ Object

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



365
366
367
368
369
370
371
372
373
374
375
 
# 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) ⇒ Object

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



143
144
145
146
147
148
149
150
151
152
153
154
 
# 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) ⇒ Object

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# 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) ⇒ Object

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



455
456
457
458
459
460
461
462
463
 
# 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