Module: Discordrb::API::Server

Defined in:
lib/discordrb/api/server.rb

Overview

API calls for Server

Class Method Summary collapse

Class Method Details

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

Adds a custom emoji



456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/discordrb/api/server.rb', line 456

def add_emoji(token, server_id, image, name, reason = nil)
  Discordrb::API.request(
    :guilds_sid_emojis,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis",
    { image: image, name: name }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.add_member(token, server_id, user_id, access_token, nick = nil, roles = [], mute = false, deaf = false) ⇒ Object

Adds a member to a server with an OAuth2 Bearer token that has been granted guilds.join https://discordapp.com/developers/docs/resources/guild#add-guild-member



520
521
522
523
524
525
526
527
528
529
530
 
# File 'lib/discordrb/api/server.rb', line 520

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

.add_member_role(token, server_id, user_id, role_id, reason = nil) ⇒ Object

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



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/discordrb/api/server.rb', line 289

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

.audit_logs(token, server_id, limit, userid = nil, actiontype = nil, before = nil) ⇒ Object

Gets a server's audit logs https://discordapp.com/developers/docs/resources/audit-log#get-guild-audit-log



354
355
356
357
358
359
360
361
362
 
# File 'lib/discordrb/api/server.rb', line 354

def audit_logs(token, server_id, limit, userid = nil, actiontype = 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=#{userid}" if userid}#{"&action_type=#{actiontype}" if actiontype}#{"&before=#{before}" if before}",
    Authorization: token
  )
end

.ban_user(token, 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 https://discordapp.com/developers/docs/resources/guild#create-guild-ban



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/discordrb/api/server.rb', line 187

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}&reason=#{reason}",
    nil,
    Authorization: token
  )
end

.bans(token, server_id) ⇒ Object

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



175
176
177
178
179
180
181
182
183
 
# File 'lib/discordrb/api/server.rb', line 175

def bans(token, server_id)
  Discordrb::API.request(
    :guilds_sid_bans,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/bans",
    Authorization: token
  )
end

.begin_prune(token, server_id, days, reason = nil) ⇒ Object

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



328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/discordrb/api/server.rb', line 328

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,
    'X-Audit-Log-Reason': reason
  )
end

.channels(token, server_id) ⇒ Object

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



76
77
78
79
80
81
82
83
84
 
# File 'lib/discordrb/api/server.rb', line 76

def channels(token, server_id)
  Discordrb::API.request(
    :guilds_sid_channels,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
    Authorization: token
  )
end

.create(token, name, region = :'eu-central') ⇒ Object

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



9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/discordrb/api/server.rb', line 9

def create(token, name, region = :'eu-central')
  Discordrb::API.request(
    :guilds,
    nil,
    :post,
    "#{Discordrb::API.api_base}/guilds",
    { name: name, region: region.to_s }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, reason = nil) ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/discordrb/api/server.rb', line 88

def create_channel(token, server_id, name, type, topic, bitrate, user_limit, permission_overwrites, parent_id, nsfw, rate_limit_per_user, reason = nil)
  Discordrb::API.request(
    :guilds_sid_channels,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/channels",
    { 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 }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.create_integration(token, server_id, type, id) ⇒ Object

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



378
379
380
381
382
383
384
385
386
387
 
# File 'lib/discordrb/api/server.rb', line 378

def create_integration(token, server_id, type, id)
  Discordrb::API.request(
    :guilds_sid_integrations,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
    { type: type, id: id },
    Authorization: token
  )
end

.create_role(token, server_id, name, colour, hoist, mentionable, packed_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) https://discordapp.com/developers/docs/resources/guild#get-guild-roles



229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/discordrb/api/server.rb', line 229

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",
    { color: colour, name: name, hoist: hoist, mentionable: mentionable, permissions: packed_permissions }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.delete(token, server_id) ⇒ Object

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



64
65
66
67
68
69
70
71
72
 
# File 'lib/discordrb/api/server.rb', line 64

def delete(token, server_id)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :delete,
    "#{Discordrb::API.api_base}/guilds/#{server_id}",
    Authorization: token
  )
end

.delete_emoji(token, server_id, emoji_id, reason = nil) ⇒ Object

Deletes a custom emoji



484
485
486
487
488
489
490
491
492
493
 
# File 'lib/discordrb/api/server.rb', line 484

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

.delete_integration(token, server_id, integration_id) ⇒ Object

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



405
406
407
408
409
410
411
412
413
 
# File 'lib/discordrb/api/server.rb', line 405

def delete_integration(token, server_id, integration_id)
  Discordrb::API.request(
    :guilds_sid_integrations_iid,
    server_id,
    :delete,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
    Authorization: token
  )
end

.delete_role(token, server_id, role_id, reason = nil) ⇒ Object

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



276
277
278
279
280
281
282
283
284
285
 
# File 'lib/discordrb/api/server.rb', line 276

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,
    'X-Audit-Log-Reason': reason
  )
end

.edit_emoji(token, server_id, emoji_id, name, reason = nil) ⇒ Object

Changes an emoji name



470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/discordrb/api/server.rb', line 470

def edit_emoji(token, server_id, emoji_id, name, reason = nil)
  Discordrb::API.request(
    :guilds_sid_emojis_eid,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/emojis/#{emoji_id}",
    { name: name }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.embed(token, server_id) ⇒ Object

Retrieves a server's embed information https://discordapp.com/developers/docs/resources/guild#get-guild-embed



430
431
432
433
434
435
436
437
438
 
# File 'lib/discordrb/api/server.rb', line 430

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

.integrations(token, server_id) ⇒ Object

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



366
367
368
369
370
371
372
373
374
 
# File 'lib/discordrb/api/server.rb', line 366

def integrations(token, server_id)
  Discordrb::API.request(
    :guilds_sid_integrations,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations",
    Authorization: token
  )
end

.invites(token, server_id) ⇒ Object

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



342
343
344
345
346
347
348
349
350
 
# File 'lib/discordrb/api/server.rb', line 342

def invites(token, server_id)
  Discordrb::API.request(
    :guilds_sid_invites,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/invites",
    Authorization: token
  )
end

.modify_embed(token, server_id, enabled, channel_id, reason = nil) ⇒ Object

Modify a server's embed settings https://discordapp.com/developers/docs/resources/guild#modify-guild-embed



442
443
444
445
446
447
448
449
450
451
452
453
 
# File 'lib/discordrb/api/server.rb', line 442

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

.prune_count(token, server_id, days) ⇒ Object

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



316
317
318
319
320
321
322
323
324
 
# File 'lib/discordrb/api/server.rb', line 316

def prune_count(token, server_id, days)
  Discordrb::API.request(
    :guilds_sid_prune,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/prune?days=#{days}",
    Authorization: token
  )
end

.regions(token, server_id) ⇒ Object

Available voice regions for this server



496
497
498
499
500
501
502
503
504
 
# File 'lib/discordrb/api/server.rb', line 496

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

.remove_member(token, server_id, user_id, reason = nil) ⇒ Object

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



161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/discordrb/api/server.rb', line 161

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,
    'X-Audit-Log-Reason': reason
  )
end

.remove_member_role(token, server_id, user_id, role_id, reason = nil) ⇒ Object

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



303
304
305
306
307
308
309
310
311
312
 
# File 'lib/discordrb/api/server.rb', line 303

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

.resolve(token, server_id) ⇒ Object

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



23
24
25
26
27
28
29
30
31
 
# File 'lib/discordrb/api/server.rb', line 23

def resolve(token, server_id)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}",
    Authorization: token
  )
end

.resolve_member(token, server_id, user_id) ⇒ Object

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



117
118
119
120
121
122
123
124
125
 
# File 'lib/discordrb/api/server.rb', line 117

def resolve_member(token, server_id, user_id)
  Discordrb::API.request(
    :guilds_sid_members_uid,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}",
    Authorization: token
  )
end

.resolve_members(token, server_id, limit, after = nil) ⇒ Object

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



129
130
131
132
133
134
135
136
137
 
# File 'lib/discordrb/api/server.rb', line 129

def resolve_members(token, server_id, limit, after = nil)
  Discordrb::API.request(
    :guilds_sid_members,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/members?limit=#{limit}#{"&after=#{after}" if after}",
    Authorization: token
  )
end

.roles(token, server_id) ⇒ Object

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



214
215
216
217
218
219
220
221
222
 
# File 'lib/discordrb/api/server.rb', line 214

def roles(token, server_id)
  Discordrb::API.request(
    :guilds_sid_roles,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/roles",
    Authorization: token
  )
end

.sync_integration(token, server_id, integration_id) ⇒ Object

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



417
418
419
420
421
422
423
424
425
426
 
# File 'lib/discordrb/api/server.rb', line 417

def sync_integration(token, server_id, integration_id)
  Discordrb::API.request(
    :guilds_sid_integrations_iid_sync,
    server_id,
    :post,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}/sync",
    nil,
    Authorization: token
  )
end

.transfer_ownership(token, server_id, user_id, reason = nil) ⇒ Object

Transfer server ownership



49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/discordrb/api/server.rb', line 49

def transfer_ownership(token, server_id, user_id, reason = nil)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}",
    { owner_id: user_id }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.unban_user(token, server_id, user_id, reason = nil) ⇒ Object

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



201
202
203
204
205
206
207
208
209
210
 
# File 'lib/discordrb/api/server.rb', line 201

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,
    'X-Audit-Log-Reason': reason
  )
end

.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) ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/discordrb/api/server.rb', line 35

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, 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,
    'X-Audit-Log-Reason': reason
  )
end

.update_channel_positions(token, server_id, positions) ⇒ Object

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



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/discordrb/api/server.rb', line 103

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",
    positions.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_integration(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons) ⇒ Object

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



391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/discordrb/api/server.rb', line 391

def update_integration(token, server_id, integration_id, expire_behavior, expire_grace_period, enable_emoticons)
  Discordrb::API.request(
    :guilds_sid_integrations_iid,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/integrations/#{integration_id}",
    { expire_behavior: expire_behavior, expire_grace_period: expire_grace_period, enable_emoticons: enable_emoticons }.to_json,
    Authorization: token,
    content_type: :json
  )
end

.update_member(token, server_id, user_id, nick: nil, roles: nil, mute: nil, deaf: nil, channel_id: nil, reason: nil) ⇒ Object

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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/discordrb/api/server.rb', line 141

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,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/members/#{user_id}", {
      roles: roles,
      nick: nick,
      mute: mute,
      deaf: deaf,
      channel_id: channel_id
    }.reject { |_, v| v.nil? }.to_json,
    Authorization: token,
    content_type: :json,
    'X-Audit-Log-Reason': reason
  )
end

.update_role(token, server_id, role_id, name, colour, hoist = false, mentionable = false, packed_permissions = 104_324_161, 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) https://discordapp.com/developers/docs/resources/guild#batch-modify-guild-role



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/discordrb/api/server.rb', line 247

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,
    :patch,
    "#{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(token, server_id, roles) ⇒ Object

Update role positions https://discordapp.com/developers/docs/resources/guild#modify-guild-role-positions



262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/discordrb/api/server.rb', line 262

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

.webhooks(token, server_id) ⇒ Object

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



508
509
510
511
512
513
514
515
516
 
# File 'lib/discordrb/api/server.rb', line 508

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