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, roles = [], reason = nil) ⇒ Object


465
466
467
468
469
470
471
472
473
474
475
476
# File 'lib/discordrb/api/server.rb', line 465

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

.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://discord.com/developers/docs/resources/guild#add-guild-member


532
533
534
535
536
537
538
539
540
541
542
# File 'lib/discordrb/api/server.rb', line 532

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


293
294
295
296
297
298
299
300
301
302
303
# File 'lib/discordrb/api/server.rb', line 293

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, user_id = nil, action_type = nil, before = nil) ⇒ Object


358
359
360
361
362
363
364
365
366
# File 'lib/discordrb/api/server.rb', line 358

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

.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://discord.com/developers/docs/resources/guild#create-guild-ban


191
192
193
194
195
196
197
198
199
200
201
# File 'lib/discordrb/api/server.rb', line 191

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


179
180
181
182
183
184
185
186
187
# File 'lib/discordrb/api/server.rb', line 179

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


332
333
334
335
336
337
338
339
340
341
342
# File 'lib/discordrb/api/server.rb', line 332

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


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

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


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, position, reason = nil) ⇒ Object


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

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

.create_integration(token, server_id, type, id, reason = nil) ⇒ Object


382
383
384
385
386
387
388
389
390
391
392
# File 'lib/discordrb/api/server.rb', line 382

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,
    'X-Audit-Log-Reason': reason
  )
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://discord.com/developers/docs/resources/guild#get-guild-roles


233
234
235
236
237
238
239
240
241
242
243
244
# File 'lib/discordrb/api/server.rb', line 233

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


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

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


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

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, reason = nil) ⇒ Object


410
411
412
413
414
415
416
417
418
419
# File 'lib/discordrb/api/server.rb', line 410

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

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


280
281
282
283
284
285
286
287
288
289
# File 'lib/discordrb/api/server.rb', line 280

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, roles = nil, reason = nil) ⇒ Object


480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/discordrb/api/server.rb', line 480

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

.integrations(token, server_id) ⇒ Object


370
371
372
373
374
375
376
377
378
# File 'lib/discordrb/api/server.rb', line 370

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


346
347
348
349
350
351
352
353
354
# File 'lib/discordrb/api/server.rb', line 346

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_widget(token, server_id, enabled, channel_id, reason = nil) ⇒ Object Also known as: modify_embed


449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/discordrb/api/server.rb', line 449

def modify_widget(token, server_id, enabled, channel_id, reason = nil)
  Discordrb::API.request(
    :guilds_sid_embed,
    server_id,
    :patch,
    "#{Discordrb::API.api_base}/guilds/#{server_id}/widget",
    { 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


320
321
322
323
324
325
326
327
328
# File 'lib/discordrb/api/server.rb', line 320

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


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

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


165
166
167
168
169
170
171
172
173
174
175
# File 'lib/discordrb/api/server.rb', line 165

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


307
308
309
310
311
312
313
314
315
316
# File 'lib/discordrb/api/server.rb', line 307

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, with_counts = nil) ⇒ Object


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

def resolve(token, server_id, with_counts = nil)
  Discordrb::API.request(
    :guilds_sid,
    server_id,
    :get,
    "#{Discordrb::API.api_base}/guilds/#{server_id}#{'?with_counts=true' if with_counts}",
    Authorization: token
  )
end

.resolve_member(token, server_id, user_id) ⇒ Object


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

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


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

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

.roles(token, server_id) ⇒ Object


218
219
220
221
222
223
224
225
226
# File 'lib/discordrb/api/server.rb', line 218

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


423
424
425
426
427
428
429
430
431
432
# File 'lib/discordrb/api/server.rb', line 423

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


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

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


205
206
207
208
209
210
211
212
213
214
# File 'lib/discordrb/api/server.rb', line 205

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


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


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

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


396
397
398
399
400
401
402
403
404
405
406
# File 'lib/discordrb/api/server.rb', line 396

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: :undef, roles: :undef, mute: :undef, deaf: :undef, channel_id: :undef, communication_disabled_until: :undef, reason: nil) ⇒ Object


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

def update_member(token, server_id, user_id, nick: :undef, roles: :undef, mute: :undef, deaf: :undef, channel_id: :undef,
                  communication_disabled_until: :undef, 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,
      communication_disabled_until: communication_disabled_until
    }.reject { |_, v| v == :undef }.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://discord.com/developers/docs/resources/guild#batch-modify-guild-role


251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/discordrb/api/server.rb', line 251

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


266
267
268
269
270
271
272
273
274
275
276
# File 'lib/discordrb/api/server.rb', line 266

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


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

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

.widget(token, server_id) ⇒ Object Also known as: embed


436
437
438
439
440
441
442
443
444
# File 'lib/discordrb/api/server.rb', line 436

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