RubyDoc.info: Class: LibDiscord::Client – Documentation for lib_discord (1.1.0)

#add_guild_member(guild_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Add Guild Member"

# File 'lib/lib_discord/client.rb', line 1914

def add_guild_member(guild_id, user_id, body, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/members/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#add_guild_member_role(guild_id, user_id, role_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
role_id (#to_s) —

Role ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Add Guild Member Role"

# File 'lib/lib_discord/client.rb', line 1986

def add_guild_member_role(guild_id, user_id, role_id, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/members/#{user_id}/roles/#{role_id}"),
    headers: auditlog(reason)
  )
end

#add_member_to_lobby(lobby_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Add a Member to a Lobby"

# File 'lib/lib_discord/client.rb', line 2594

def add_member_to_lobby(lobby_id, user_id, body, reason: nil)
  json_request(
    :put,
    discord("/lobbies/#{lobby_id}/members/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#add_thread_member(channel_id, user_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Add Thread Member"

# File 'lib/lib_discord/client.rb', line 1105

def add_thread_member(channel_id, user_id, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/thread-members/#{user_id}"),
    headers: auditlog(reason)
  )
end

#batch_edit_application_command_permissions(application_id, guild_id, body, reason: nil) ⇒ `Response`

Deprecated.

This endpoint has been disabled with updates to command permissions (Permissions v2). Instead, you can edit each application command permissions (though you should be careful to handle any potential rate limits).

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Batch Edit Application Command Permissions"

# File 'lib/lib_discord/client.rb', line 574

def batch_edit_application_command_permissions(application_id, guild_id, body, reason: nil)
  json_request(
    :put,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/permissions"),
    body:,
    headers: auditlog(reason)
  )
end

#begin_guild_prune(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Begin Guild Prune"

# File 'lib/lib_discord/client.rb', line 2252

def begin_guild_prune(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/prune"),
    body:,
    headers: auditlog(reason)
  )
end

#bulk_delete_messages(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Bulk Delete Messages"

# File 'lib/lib_discord/client.rb', line 2882

def bulk_delete_messages(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/messages/bulk-delete"),
    body:,
    headers: auditlog(reason)
  )
end

#bulk_guild_ban(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Bulk Guild Ban"

# File 'lib/lib_discord/client.rb', line 2102

def bulk_guild_ban(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/bulk-ban"),
    body:,
    headers: auditlog(reason)
  )
end

#bulk_overwrite_global_application_commands(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Bulk Overwrite Global Application Commands"

# File 'lib/lib_discord/client.rb', line 390

def bulk_overwrite_global_application_commands(application_id, body, reason: nil)
  json_request(
    :put,
    discord("/applications/#{application_id}/commands"),
    body:,
    headers: auditlog(reason)
  )
end

#bulk_overwrite_guild_application_commands(application_id, guild_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Bulk Overwrite Guild Application Commands"

# File 'lib/lib_discord/client.rb', line 497

def bulk_overwrite_guild_application_commands(application_id, guild_id, body, reason: nil)
  json_request(
    :put,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands"),
    body:,
    headers: auditlog(reason)
  )
end

#consume_entitlement(application_id, entitlement_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
entitlement_id (#to_s) —

Entitlement ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Consume an Entitlement"

# File 'lib/lib_discord/client.rb', line 1441

def consume_entitlement(application_id, entitlement_id, reason: nil)
  json_request(
    :post,
    discord("/applications/#{application_id}/entitlements/#{entitlement_id}/consume"),
    headers: auditlog(reason)
  )
end

#create_application_emoji(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Application Emoji"

# File 'lib/lib_discord/client.rb', line 1355

def create_application_emoji(application_id, body, reason: nil)
  json_request(
    :post,
    discord("/applications/#{application_id}/emojis"),
    body:,
    headers: auditlog(reason)
  )
end

#create_auto_moderation_rule(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Auto Moderation Rule"

# File 'lib/lib_discord/client.rb', line 755

def create_auto_moderation_rule(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/auto-moderation/rules"),
    body:,
    headers: auditlog(reason)
  )
end

#create_channel_invite(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Channel Invite"

# File 'lib/lib_discord/client.rb', line 892

def create_channel_invite(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/invites"),
    body:,
    headers: auditlog(reason)
  )
end

#create_dm(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create DM"

# File 'lib/lib_discord/client.rb', line 3401

def create_dm(body, reason: nil)
  json_request(
    :post,
    discord("/users/@me/channels"),
    body:,
    headers: auditlog(reason)
  )
end

#create_followup_message(application_id, interaction_token, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Followup Message"

# File 'lib/lib_discord/client.rb', line 232

def create_followup_message(application_id, interaction_token, body, reason: nil)
  json_request(
    :post,
    discord("/webhooks/#{application_id}/#{interaction_token}"),
    body:,
    headers: auditlog(reason)
  )
end

#create_global_application_command(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Global Application Command"

# File 'lib/lib_discord/client.rb', line 323

def create_global_application_command(application_id, body, reason: nil)
  json_request(
    :post,
    discord("/applications/#{application_id}/commands"),
    body:,
    headers: auditlog(reason)
  )
end

#create_group_dm(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Group DM"

# File 'lib/lib_discord/client.rb', line 3417

def create_group_dm(body, reason: nil)
  json_request(
    :post,
    discord("/users/@me/channels"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild"

# File 'lib/lib_discord/client.rb', line 1718

def create_guild(body, reason: nil)
  json_request(
    :post,
    discord("/guilds"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_application_command(application_id, guild_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Application Command"

# File 'lib/lib_discord/client.rb', line 426

def create_guild_application_command(application_id, guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_ban(guild_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Ban"

# File 'lib/lib_discord/client.rb', line 2069

def create_guild_ban(guild_id, user_id, body, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/bans/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_channel(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Channel"

# File 'lib/lib_discord/client.rb', line 1814

def create_guild_channel(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/channels"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_emoji(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Emoji"

# File 'lib/lib_discord/client.rb', line 1273

def create_guild_emoji(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/emojis"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_from_guild_template(template_code, body, reason: nil) ⇒ `Response`

Parameters:

template_code (#to_s) —

Template Code
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild from Guild Template"

# File 'lib/lib_discord/client.rb', line 1616

def create_guild_from_guild_template(template_code, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/templates/#{template_code}"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_role(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Role"

# File 'lib/lib_discord/client.rb', line 2150

def create_guild_role(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/roles"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_scheduled_event(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Scheduled Event"

# File 'lib/lib_discord/client.rb', line 1510

def create_guild_scheduled_event(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/scheduled-events"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_soundboard_sound(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Soundboard Sound"

# File 'lib/lib_discord/client.rb', line 3023

def create_guild_soundboard_sound(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/soundboard-sounds"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_sticker(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Sticker"

# File 'lib/lib_discord/client.rb', line 3220

def create_guild_sticker(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/stickers"),
    body:,
    headers: auditlog(reason)
  )
end

#create_guild_template(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Guild Template"

# File 'lib/lib_discord/client.rb', line 1648

def create_guild_template(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/templates"),
    body:,
    headers: auditlog(reason)
  )
end

#create_interaction_response(interaction_id, interaction_token, body, reason: nil) ⇒ `Response`

Parameters:

interaction_id (#to_s) —

Interaction ID
interaction_token (#to_s) —

Interaction Token
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Interaction Response"

# File 'lib/lib_discord/client.rb', line 164

def create_interaction_response(interaction_id, interaction_token, body, reason: nil)
  json_request(
    :post,
    discord("/interactions/#{interaction_id}/#{interaction_token}/callback"),
    body:,
    headers: auditlog(reason)
  )
end

#create_lobby(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Lobby"

# File 'lib/lib_discord/client.rb', line 2529

def create_lobby(body, reason: nil)
  json_request(
    :post,
    discord("/lobbies"),
    body:,
    headers: auditlog(reason)
  )
end

#create_message(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Message"

# File 'lib/lib_discord/client.rb', line 2711

def create_message(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/messages"),
    body:,
    headers: auditlog(reason)
  )
end

#create_reaction(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
emoji (#to_s) —

Emoji
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Reaction"

# File 'lib/lib_discord/client.rb', line 2745

def create_reaction(channel_id, message_id, emoji, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me"),
    headers: auditlog(reason)
  )
end

#create_stage_instance(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Stage Instance"

# File 'lib/lib_discord/client.rb', line 3077

def create_stage_instance(body, reason: nil)
  json_request(
    :post,
    discord("/stage-instances"),
    body:,
    headers: auditlog(reason)
  )
end

#create_test_entitlement(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Test Entitlement"

# File 'lib/lib_discord/client.rb', line 1456

def create_test_entitlement(application_id, body, reason: nil)
  json_request(
    :post,
    discord("/applications/#{application_id}/entitlements"),
    body:,
    headers: auditlog(reason)
  )
end

#create_webhook(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Create Webhook"

# File 'lib/lib_discord/client.rb', line 3568

def create_webhook(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/webhooks"),
    body:,
    headers: auditlog(reason)
  )
end

#crosspost_message(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Crosspost Message"

# File 'lib/lib_discord/client.rb', line 2728

def crosspost_message(channel_id, message_id, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/messages/#{message_id}/crosspost"),
    headers: auditlog(reason)
  )
end

#delete_all_reactions(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete All Reactions"

# File 'lib/lib_discord/client.rb', line 2815

def delete_all_reactions(channel_id, message_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions"),
    headers: auditlog(reason)
  )
end

#delete_all_reactions_for_emoji(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
emoji (#to_s) —

Emoji
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete All Reactions for Emoji"

# File 'lib/lib_discord/client.rb', line 2832

def delete_all_reactions_for_emoji(channel_id, message_id, emoji, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}"),
    headers: auditlog(reason)
  )
end

#delete_application_emoji(application_id, emoji_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
emoji_id (#to_s) —

Emoji ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Application Emoji"

# File 'lib/lib_discord/client.rb', line 1390

def delete_application_emoji(application_id, emoji_id, reason: nil)
  json_request(
    :delete,
    discord("/applications/#{application_id}/emojis/#{emoji_id}"),
    headers: auditlog(reason)
  )
end

#delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
auto_moderation_rule_id (#to_s) —

Auto Moderation Rule ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Auto Moderation Rule"

# File 'lib/lib_discord/client.rb', line 790

def delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/auto-moderation/rules/#{auto_moderation_rule_id}"),
    headers: auditlog(reason)
  )
end

#delete_channel(channel_id, reason: nil) ⇒ `Response` Also known as: close_channel

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete/Close Channel"

# File 'lib/lib_discord/client.rb', line 841

def delete_channel(channel_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}"),
    headers: auditlog(reason)
  )
end

#delete_channel_permission(channel_id, overwrite_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
overwrite_id (#to_s) —

Overwrite ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Channel Permission"

# File 'lib/lib_discord/client.rb', line 909

def delete_channel_permission(channel_id, overwrite_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/permissions/#{overwrite_id}"),
    headers: auditlog(reason)
  )
end

#delete_followup_message(application_id, interaction_token, message_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Followup Message"

# File 'lib/lib_discord/client.rb', line 286

def delete_followup_message(application_id, interaction_token, message_id, reason: nil)
  json_request(
    :delete,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/#{message_id}"),
    headers: auditlog(reason)
  )
end

#delete_global_application_command(application_id, command_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
command_id (#to_s) —

Command ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Global Application Command"

# File 'lib/lib_discord/client.rb', line 374

def delete_global_application_command(application_id, command_id, reason: nil)
  json_request(
    :delete,
    discord("/applications/#{application_id}/commands/#{command_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild"

# File 'lib/lib_discord/client.rb', line 1783

def delete_guild(guild_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_application_command(application_id, guild_id, command_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
command_id (#to_s) —

Command ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Application Command"

# File 'lib/lib_discord/client.rb', line 480

def delete_guild_application_command(application_id, guild_id, command_id, reason: nil)
  json_request(
    :delete,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_emoji(guild_id, emoji_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
emoji_id (#to_s) —

Emoji ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Emoji"

# File 'lib/lib_discord/client.rb', line 1308

def delete_guild_emoji(guild_id, emoji_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/emojis/#{emoji_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_integration(guild_id, integration_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
integration_id (#to_s) —

Integration ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Integration"

# File 'lib/lib_discord/client.rb', line 2314

def delete_guild_integration(guild_id, integration_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/integrations/#{integration_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_role(guild_id, role_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
role_id (#to_s) —

Role ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Role"

# File 'lib/lib_discord/client.rb', line 2219

def delete_guild_role(guild_id, role_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/roles/#{role_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
guild_scheduled_event_id (#to_s) —

Guild Scheduled Event ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Scheduled Event"

# File 'lib/lib_discord/client.rb', line 1563

def delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/scheduled-events/#{guild_scheduled_event_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_soundboard_sound(guild_id, sound_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sound_id (#to_s) —

Sound ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Soundboard Sound"

# File 'lib/lib_discord/client.rb', line 3058

def delete_guild_soundboard_sound(guild_id, sound_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/soundboard-sounds/#{sound_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_sticker(guild_id, sticker_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sticker_id (#to_s) —

Sticker ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Sticker"

# File 'lib/lib_discord/client.rb', line 3255

def delete_guild_sticker(guild_id, sticker_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/stickers/#{sticker_id}"),
    headers: auditlog(reason)
  )
end

#delete_guild_template(guild_id, template_code, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
template_code (#to_s) —

Template Code
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Guild Template"

# File 'lib/lib_discord/client.rb', line 1699

def delete_guild_template(guild_id, template_code, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/templates/#{template_code}"),
    headers: auditlog(reason)
  )
end

#delete_invite(invite_code, reason: nil) ⇒ `Response`

Parameters:

invite_code (#to_s) —

Invite Code
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Invite"

# File 'lib/lib_discord/client.rb', line 2510

def delete_invite(invite_code, reason: nil)
  json_request(
    :delete,
    discord("/invites/#{invite_code}"),
    headers: auditlog(reason)
  )
end

#delete_lobby(lobby_id, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Lobby"

# File 'lib/lib_discord/client.rb', line 2577

def delete_lobby(lobby_id, reason: nil)
  json_request(
    :delete,
    discord("/lobbies/#{lobby_id}"),
    headers: auditlog(reason)
  )
end

#delete_message(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Message"

# File 'lib/lib_discord/client.rb', line 2866

def delete_message(channel_id, message_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/messages/#{message_id}"),
    headers: auditlog(reason)
  )
end

#delete_original_interaction_response(application_id, interaction_token, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Original Interaction Response"

# File 'lib/lib_discord/client.rb', line 215

def delete_original_interaction_response(application_id, interaction_token, reason: nil)
  json_request(
    :delete,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/@original"),
    headers: auditlog(reason)
  )
end

#delete_own_reaction(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
emoji (#to_s) —

Emoji
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Own Reaction"

# File 'lib/lib_discord/client.rb', line 2762

def delete_own_reaction(channel_id, message_id, emoji, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/@me"),
    headers: auditlog(reason)
  )
end

#delete_stage_instance(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Stage Instance"

# File 'lib/lib_discord/client.rb', line 3125

def delete_stage_instance(channel_id, reason: nil)
  json_request(
    :delete,
    discord("/stage-instances/#{channel_id}"),
    headers: auditlog(reason)
  )
end

#delete_test_entitlement(application_id, entitlement_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
entitlement_id (#to_s) —

Entitlement ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Test Entitlement"

# File 'lib/lib_discord/client.rb', line 1473

def delete_test_entitlement(application_id, entitlement_id, reason: nil)
  json_request(
    :delete,
    discord("/applications/#{application_id}/entitlements/#{entitlement_id}"),
    headers: auditlog(reason)
  )
end

#delete_user_reaction(channel_id, message_id, emoji, user_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
emoji (#to_s) —

Emoji
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete User Reaction"

# File 'lib/lib_discord/client.rb', line 2780

def delete_user_reaction(channel_id, message_id, emoji, user_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}/#{user_id}"),
    headers: auditlog(reason)
  )
end

#delete_webhook(webhook_id, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Webhook"

# File 'lib/lib_discord/client.rb', line 3680

def delete_webhook(webhook_id, reason: nil)
  json_request(
    :delete,
    discord("/webhooks/#{webhook_id}"),
    headers: auditlog(reason)
  )
end

#delete_webhook_message(webhook_id, webhook_token, message_id, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Webhook Message"

# File 'lib/lib_discord/client.rb', line 3809

def delete_webhook_message(webhook_id, webhook_token, message_id, reason: nil)
  json_request(
    :delete,
    discord("/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}"),
    headers: auditlog(reason)
  )
end

#delete_webhook_with_token(webhook_id, webhook_token, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Delete Webhook with Token"

# File 'lib/lib_discord/client.rb', line 3696

def delete_webhook_with_token(webhook_id, webhook_token, reason: nil)
  json_request(
    :delete,
    discord("/webhooks/#{webhook_id}/#{webhook_token}"),
    headers: auditlog(reason)
  )
end

#edit_application_command_permissions(application_id, guild_id, command_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
command_id (#to_s) —

Command ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Application Command Permissions"

# File 'lib/lib_discord/client.rb', line 549

def edit_application_command_permissions(application_id, guild_id, command_id, body, reason: nil)
  json_request(
    :put,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}/permissions"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_channel_permissions(channel_id, overwrite_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
overwrite_id (#to_s) —

Overwrite ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Channel Permissions"

# File 'lib/lib_discord/client.rb', line 860

def edit_channel_permissions(channel_id, overwrite_id, body, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/permissions/#{overwrite_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_current_application(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Current Application"

# File 'lib/lib_discord/client.rb', line 666

def edit_current_application(body, reason: nil)
  json_request(
    :patch,
    discord("/applications/@me"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_followup_message(application_id, interaction_token, message_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
message_id (#to_s) —

Message ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Followup Message"

# File 'lib/lib_discord/client.rb', line 268

def edit_followup_message(application_id, interaction_token, message_id, body, reason: nil)
  json_request(
    :patch,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/#{message_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_global_application_command(application_id, command_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
command_id (#to_s) —

Command ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Global Application Command"

# File 'lib/lib_discord/client.rb', line 357

def edit_global_application_command(application_id, command_id, body, reason: nil)
  json_request(
    :patch,
    discord("/applications/#{application_id}/commands/#{command_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_guild_application_command(application_id, guild_id, command_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
command_id (#to_s) —

Command ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Guild Application Command"

# File 'lib/lib_discord/client.rb', line 462

def edit_guild_application_command(application_id, guild_id, command_id, body, reason: nil)
  json_request(
    :patch,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_message(channel_id, message_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Message"

# File 'lib/lib_discord/client.rb', line 2849

def edit_message(channel_id, message_id, body, reason: nil)
  json_request(
    :patch,
    discord("/channels/#{channel_id}/messages/#{message_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_original_interaction_response(application_id, interaction_token, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Original Interaction Response"

# File 'lib/lib_discord/client.rb', line 198

def edit_original_interaction_response(application_id, interaction_token, body, reason: nil)
  json_request(
    :patch,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/@original"),
    body:,
    headers: auditlog(reason)
  )
end

#edit_webhook_message(webhook_id, webhook_token, message_id, body, query = {}, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
message_id (#to_s) —

Message ID
body (#to_json) —

Request body
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Edit Webhook Message"

# File 'lib/lib_discord/client.rb', line 3790

def edit_webhook_message(webhook_id, webhook_token, message_id, body, query = {}, reason: nil)
  json_request(
    :patch,
    discord("/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}"),
    body:,
    query:,
    headers: auditlog(reason)
  )
end

#end_poll(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "End Poll"

# File 'lib/lib_discord/client.rb', line 2922

def end_poll(channel_id, message_id, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/polls/#{message_id}/expire"),
    headers: auditlog(reason)
  )
end

#execute_github_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Execute GitHub-Compatible Webhook

# File 'lib/lib_discord/client.rb', line 3751

def execute_github_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil)
  json_request(
    :post,
    discord("/webhooks/#{webhook_id}/#{webhook_token}/github"),
    query:,
    headers: auditlog(reason)
  )
end

#execute_slack_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Execute Slack-Compatible Webhook"

# File 'lib/lib_discord/client.rb', line 3733

def execute_slack_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil)
  json_request(
    :post,
    discord("/webhooks/#{webhook_id}/#{webhook_token}/slack"),
    query:,
    headers: auditlog(reason)
  )
end

#execute_webhook(webhook_id, webhook_token, body, query = {}, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
body (#to_json) —

Request body
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Execute Webhook"

# File 'lib/lib_discord/client.rb', line 3714

def execute_webhook(webhook_id, webhook_token, body, query = {}, reason: nil)
  json_request(
    :post,
    discord("/webhooks/#{webhook_id}/#{webhook_token}"),
    body:,
    query:,
    headers: auditlog(reason)
  )
end

#follow_announcement_channel(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Follow Announcement Channel"

# File 'lib/lib_discord/client.rb', line 925

def follow_announcement_channel(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/followers"),
    body:,
    headers: auditlog(reason)
  )
end

#get_answer_voters(channel_id, message_id, answer_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
answer_id (#to_s) —

Answer ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Answer Voters"

# File 'lib/lib_discord/client.rb', line 2905

def get_answer_voters(channel_id, message_id, answer_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/polls/#{message_id}/answers/#{answer_id}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_application_activity_instance(application_id, instance_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
instance_id (#to_s) —

Activity Instance ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Application Activity Instance"

# File 'lib/lib_discord/client.rb', line 683

def get_application_activity_instance(application_id, instance_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/activity-instances/#{instance_id}"),
    headers: auditlog(reason)
  )
end

#get_application_command_permissions(application_id, guild_id, command_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
command_id (#to_s) —

Command ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Application Command Permissions"

# File 'lib/lib_discord/client.rb', line 531

def get_application_command_permissions(application_id, guild_id, command_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}/permissions"),
    headers: auditlog(reason)
  )
end

#get_application_emoji(application_id, emoji_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
emoji_id (#to_s) —

Emoji ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Application Emoji"

# File 'lib/lib_discord/client.rb', line 1339

def get_application_emoji(application_id, emoji_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/emojis/#{emoji_id}"),
    headers: auditlog(reason)
  )
end

#get_application_role_connection_metadata_records(application_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Application Role Connection Metadata Records"

# File 'lib/lib_discord/client.rb', line 619

def get_application_role_connection_metadata_records(application_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/role-connections/metadata"),
    headers: auditlog(reason)
  )
end

#get_authorize_url(query = {}) ⇒ `URI`

Get the URL for starting the OAuth2 Authorization flow.

Parameters:

query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().

Returns:

(URI) —

OAuth2 Authorization URL, with query parameters added.

See Also:

Discord documentation "Authorization Code Grant"

# File 'lib/lib_discord/client.rb', line 3866

def get_authorize_url(query = {})
  uri = URI(discord("/oauth2/authorize", prefix: ""))
  uri.query = URI.encode_www_form(query)
  uri
end

#get_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
auto_moderation_rule_id (#to_s) —

Auto Moderation Rule ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Auto Moderation Rule"

# File 'lib/lib_discord/client.rb', line 739

def get_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/auto-moderation/rules/#{auto_moderation_rule_id}"),
    headers: auditlog(reason)
  )
end

#get_channel(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Channel"

# File 'lib/lib_discord/client.rb', line 809

def get_channel(channel_id, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}"),
    headers: auditlog(reason)
  )
end

#get_channel_invites(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Channel Invites"

# File 'lib/lib_discord/client.rb', line 876

def get_channel_invites(channel_id, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/invites"),
    headers: auditlog(reason)
  )
end

#get_channel_message(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Channel Message"

# File 'lib/lib_discord/client.rb', line 2695

def get_channel_message(channel_id, message_id, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/messages/#{message_id}"),
    headers: auditlog(reason)
  )
end

#get_channel_messages(channel_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Channel Messages"

# File 'lib/lib_discord/client.rb', line 2678

def get_channel_messages(channel_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/messages"),
    query:,
    headers: auditlog(reason)
  )
end

#get_channel_webhooks(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Channel Webhooks"

# File 'lib/lib_discord/client.rb', line 3584

def get_channel_webhooks(channel_id, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/webhooks"),
    headers: auditlog(reason)
  )
end

#get_current_application(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current Application"



655
656
657

# File 'lib/lib_discord/client.rb', line 655

def get_current_application(reason: nil)
  json_request(:get, discord("/applications/@me"), headers: auditlog(reason))
end

#get_current_user(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User"

# File 'lib/lib_discord/client.rb', line 3310

def get_current_user(reason: nil)
  json_request(
    :get, discord("/users/@me"),
    headers: auditlog(reason)
  )
end

#get_current_user_application_role_connection(application_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User Application Role Connection"

# File 'lib/lib_discord/client.rb', line 3447

def get_current_user_application_role_connection(application_id, reason: nil)
  json_request(
    :get,
    discord("/users/@me/applications/#{application_id}/role-connections"),
    headers: auditlog(reason)
  )
end

#get_current_user_connections(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User Connections"

# File 'lib/lib_discord/client.rb', line 3432

def get_current_user_connections(reason: nil)
  json_request(
    :get,
    discord("/users/@me/connections"),
    headers: auditlog(reason)
  )
end

#get_current_user_guild_member(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User Guild Member"

# File 'lib/lib_discord/client.rb', line 3371

def get_current_user_guild_member(guild_id, reason: nil)
  json_request(
    :get,
    discord("/users/@me/guilds/#{guild_id}/member"),
    headers: auditlog(reason)
  )
end

#get_current_user_guilds(query = {}, reason: nil) ⇒ `Response`

Parameters:

query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User Guilds"

# File 'lib/lib_discord/client.rb', line 3355

def get_current_user_guilds(query = {}, reason: nil)
  json_request(
    :get,
    discord("/users/@me/guilds"),
    query:,
    headers: auditlog(reason)
  )
end

#get_current_user_voice_state(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Current User Voice State"

# File 'lib/lib_discord/client.rb', line 3497

def get_current_user_voice_state(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/voice-states/@me"),
    headers: auditlog(reason)
  )
end

#get_entitlement(application_id, entitlement_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
entitlement_id (#to_s) —

Entitlement ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Entitlement"

# File 'lib/lib_discord/client.rb', line 1425

def get_entitlement(application_id, entitlement_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/entitlements/#{entitlement_id}"),
    headers: auditlog(reason)
  )
end

#get_followup_message(application_id, interaction_token, message_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Followup Message"

# File 'lib/lib_discord/client.rb', line 250

def get_followup_message(application_id, interaction_token, message_id, reason: nil)
  json_request(
    :get,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/#{message_id}"),
    headers: auditlog(reason)
  )
end

#get_gateway(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Gateway"



593
594
595

# File 'lib/lib_discord/client.rb', line 593

def get_gateway(reason: nil)
  json_request(:get, discord("/gateway"), headers: auditlog(reason))
end

#get_gateway_bot(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Gateway Bot"



603
604
605

# File 'lib/lib_discord/client.rb', line 603

def get_gateway_bot(reason: nil)
  json_request(:get, discord("/gateway/bot"), headers: auditlog(reason))
end

#get_global_application_command(application_id, command_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
command_id (#to_s) —

Command ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Global Application Command"

# File 'lib/lib_discord/client.rb', line 340

def get_global_application_command(application_id, command_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/commands/#{command_id}"),
    headers: auditlog(reason)
  )
end

#get_global_application_commands(application_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Global Application Commands"

# File 'lib/lib_discord/client.rb', line 306

def get_global_application_commands(application_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/commands"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild"

# File 'lib/lib_discord/client.rb', line 1735

def get_guild(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_application_command(application_id, guild_id, command_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
command_id (#to_s) —

Command ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Application Command"

# File 'lib/lib_discord/client.rb', line 444

def get_guild_application_command(application_id, guild_id, command_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/#{command_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_application_command_permissions(application_id, guild_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Application Command Permissions"

# File 'lib/lib_discord/client.rb', line 514

def get_guild_application_command_permissions(application_id, guild_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands/permissions"),
    headers: auditlog(reason)
  )
end

#get_guild_application_commands(application_id, guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Application Commands"

# File 'lib/lib_discord/client.rb', line 408

def get_guild_application_commands(application_id, guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/guilds/#{guild_id}/commands"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_audit_log(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Audit Log"

# File 'lib/lib_discord/client.rb', line 703

def get_guild_audit_log(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/audit-logs"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_ban(guild_id, user_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Ban"

# File 'lib/lib_discord/client.rb', line 2052

def get_guild_ban(guild_id, user_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/bans/#{user_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_bans(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Bans"

# File 'lib/lib_discord/client.rb', line 2035

def get_guild_bans(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/bans"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_channels(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Channels"

# File 'lib/lib_discord/client.rb', line 1798

def get_guild_channels(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/channels"),
    headers: auditlog(reason)
  )
end

#get_guild_emoji(guild_id, emoji_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
emoji_id (#to_s) —

Emoji ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Emoji"

# File 'lib/lib_discord/client.rb', line 1257

def get_guild_emoji(guild_id, emoji_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/emojis/#{emoji_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_integrations(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Integrations"

# File 'lib/lib_discord/client.rb', line 2298

def get_guild_integrations(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/integrations"),
    headers: auditlog(reason)
  )
end

#get_guild_invites(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Invites"

# File 'lib/lib_discord/client.rb', line 2283

def get_guild_invites(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/invites"),
    headers: auditlog(reason)
  )
end

#get_guild_member(guild_id, user_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Member"

# File 'lib/lib_discord/client.rb', line 1863

def get_guild_member(guild_id, user_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/members/#{user_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_onboarding(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Onboarding"

# File 'lib/lib_discord/client.rb', line 2440

def get_guild_onboarding(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/onboarding"),
    headers: auditlog(reason)
  )
end

#get_guild_preview(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Preview"

# File 'lib/lib_discord/client.rb', line 1751

def get_guild_preview(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/preview"),
    headers: auditlog(reason)
  )
end

#get_guild_prune_count(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Prune Count"

# File 'lib/lib_discord/client.rb', line 2235

def get_guild_prune_count(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/prune"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_role(guild_id, role_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
role_id (#to_s) —

Role ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Role"

# File 'lib/lib_discord/client.rb', line 2134

def get_guild_role(guild_id, role_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/roles/#{role_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_roles(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Roles"

# File 'lib/lib_discord/client.rb', line 2118

def get_guild_roles(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/roles"),
    headers: auditlog(reason)
  )
end

#get_guild_scheduled_event(guild_id, guild_scheduled_event_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
guild_scheduled_event_id (#to_s) —

Guild Scheduled Event ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Scheduled Event"

# File 'lib/lib_discord/client.rb', line 1528

def get_guild_scheduled_event(guild_id, guild_scheduled_event_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/scheduled-events/#{guild_scheduled_event_id}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_scheduled_event_users(guild_id, guild_scheduled_event_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
guild_scheduled_event_id (#to_s) —

Guild Scheduled Event ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Scheduled Event Users"

# File 'lib/lib_discord/client.rb', line 1580

def get_guild_scheduled_event_users(guild_id, guild_scheduled_event_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/scheduled-events/#{guild_scheduled_event_id}/users"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_soundboard_sound(guild_id, sound_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sound_id (#to_s) —

Sound ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Soundboard Sound"

# File 'lib/lib_discord/client.rb', line 3007

def get_guild_soundboard_sound(guild_id, sound_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/soundboard-sounds/#{sound_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_sticker(guild_id, sticker_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sticker_id (#to_s) —

Sticker ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Sticker"

# File 'lib/lib_discord/client.rb', line 3204

def get_guild_sticker(guild_id, sticker_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/stickers/#{sticker_id}"),
    headers: auditlog(reason)
  )
end

#get_guild_template(template_code, reason: nil) ⇒ `Response`

Parameters:

template_code (#to_s) —

Template Code
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Template"

# File 'lib/lib_discord/client.rb', line 1600

def get_guild_template(template_code, reason: nil)
  json_request(
    :get,
    discord("/guilds/templates/#{template_code}"),
    headers: auditlog(reason)
  )
end

#get_guild_templates(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Templates"

# File 'lib/lib_discord/client.rb', line 1632

def get_guild_templates(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/templates"),
    headers: auditlog(reason)
  )
end

#get_guild_vanity_url(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Vanity URL"

# File 'lib/lib_discord/client.rb', line 2376

def get_guild_vanity_url(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/vanity-url"),
    headers: auditlog(reason)
  )
end

#get_guild_voice_regions(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Voice Regions"

# File 'lib/lib_discord/client.rb', line 2268

def get_guild_voice_regions(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/regions"),
    headers: auditlog(reason)
  )
end

#get_guild_webhooks(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Webhooks"

# File 'lib/lib_discord/client.rb', line 3599

def get_guild_webhooks(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/webhooks"),
    headers: auditlog(reason)
  )
end

#get_guild_welcome_screen(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Welcome Screen"

# File 'lib/lib_discord/client.rb', line 2408

def get_guild_welcome_screen(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/welcome-screen"),
    headers: auditlog(reason)
  )
end

#get_guild_widget(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Widget"

# File 'lib/lib_discord/client.rb', line 2361

def get_guild_widget(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/widget.json"),
    headers: auditlog(reason)
  )
end

#get_guild_widget_image(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Widget Image"

# File 'lib/lib_discord/client.rb', line 2392

def get_guild_widget_image(guild_id, query = {}, reason: nil)
  net_request(
    :get,
    discord("/guilds/#{guild_id}/widget.png"),
    query:,
    headers: auditlog(reason)
  )
end

#get_guild_widget_settings(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Guild Widget Settings"

# File 'lib/lib_discord/client.rb', line 2329

def get_guild_widget_settings(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/widget"),
    headers: auditlog(reason)
  )
end

#get_install_url(query = {}) ⇒ `URI`

Get the URL for installing an application.

Parameters:

query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().

Returns:

(URI) —

Application installation URL, with query parameters added.

See Also:

Discord documentation "Install Links"

3880	# File 'lib/lib_discord/client.rb', line 3880 def get_install_url(query = {}) = get_authorize_url(query)

#get_invite(invite_code, query = {}, reason: nil) ⇒ `Response`

Parameters:

invite_code (#to_s) —

Invite Code
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Invite"

# File 'lib/lib_discord/client.rb', line 2494

def get_invite(invite_code, query = {}, reason: nil)
  json_request(
    :get,
    discord("/invites/#{invite_code}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_lobby(lobby_id, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Lobby"

# File 'lib/lib_discord/client.rb', line 2545

def get_lobby(lobby_id, reason: nil)
  json_request(
    :get,
    discord("/lobbies/#{lobby_id}"),
    headers: auditlog(reason)
  )
end

#get_original_interaction_response(application_id, interaction_token, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
interaction_token (#to_s) —

Interaction Token
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Original Interaction Response"

# File 'lib/lib_discord/client.rb', line 181

def get_original_interaction_response(application_id, interaction_token, reason: nil)
  json_request(
    :get,
    discord("/webhooks/#{application_id}/#{interaction_token}/messages/@original"),
    headers: auditlog(reason)
  )
end

#get_pinned_messages(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Pinned Messages"

# File 'lib/lib_discord/client.rb', line 956

def get_pinned_messages(channel_id, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/pins"),
    headers: auditlog(reason)
  )
end

#get_reactions(channel_id, message_id, emoji, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
emoji (#to_s) —

Emoji
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Reactions"

# File 'lib/lib_discord/client.rb', line 2798

def get_reactions(channel_id, message_id, emoji, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/messages/#{message_id}/reactions/#{emoji}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_sku_subscription(sku_id, subscription_id, reason: nil) ⇒ `Response`

Parameters:

sku_id (#to_s) —

SKU ID
subscription_id (#to_s) —

Subscription ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get SKU Subscription"

# File 'lib/lib_discord/client.rb', line 3292

def get_sku_subscription(sku_id, subscription_id, reason: nil)
  json_request(
    :get,
    discord("/skus/#{sku_id}/subscriptions/#{subscription_id}"),
    headers: auditlog(reason)
  )
end

#get_stage_instance(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Stage Instance"

# File 'lib/lib_discord/client.rb', line 3093

def get_stage_instance(channel_id, reason: nil)
  json_request(
    :get,
    discord("/stage-instances/#{channel_id}"),
    headers: auditlog(reason)
  )
end

#get_sticker(sticker_id, reason: nil) ⇒ `Response`

Parameters:

sticker_id (#to_s) —

Sticker ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Sticker"

# File 'lib/lib_discord/client.rb', line 3144

def get_sticker(sticker_id, reason: nil)
  json_request(
    :get,
    discord("/stickers/#{sticker_id}"),
    headers: auditlog(reason)
  )
end

#get_sticker_pack(pack_id, reason: nil) ⇒ `Response`

Parameters:

sticker_id (#to_s) —

Sticker Pack ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Sticker Pack"

# File 'lib/lib_discord/client.rb', line 3173

def get_sticker_pack(pack_id, reason: nil)
  json_request(
    :get,
    discord("/sticker-packs/#{pack_id}"),
    headers: auditlog(reason)
  )
end

#get_thread_member(channel_id, user_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
user_id (#to_s) —

User ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Thread Member"

# File 'lib/lib_discord/client.rb', line 1153

def get_thread_member(channel_id, user_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/thread-members/#{user_id}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_user(user_id, reason: nil) ⇒ `Response`

Parameters:

user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get User"

# File 'lib/lib_discord/client.rb', line 3324

def get_user(user_id, reason: nil)
  json_request(
    :get,
    discord("/users/#{user_id}"),
    headers: auditlog(reason)
  )
end

#get_user_voice_state(guild_id, user_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get User Voice State"

# File 'lib/lib_discord/client.rb', line 3513

def get_user_voice_state(guild_id, user_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/voice-states/#{user_id}"),
    headers: auditlog(reason)
  )
end

#get_webhook(webhook_id, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Webhook"

# File 'lib/lib_discord/client.rb', line 3614

def get_webhook(webhook_id, reason: nil)
  json_request(
    :get,
    discord("/webhooks/#{webhook_id}"),
    headers: auditlog(reason)
  )
end

#get_webhook_message(webhook_id, webhook_token, message_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
message_id (#to_s) —

Message ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Webhook Message"

# File 'lib/lib_discord/client.rb', line 3770

def get_webhook_message(webhook_id, webhook_token, message_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/webhooks/#{webhook_id}/#{webhook_token}/messages/#{message_id}"),
    query:,
    headers: auditlog(reason)
  )
end

#get_webhook_with_token(webhook_id, webhook_token, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Get Webhook with Token"

# File 'lib/lib_discord/client.rb', line 3630

def get_webhook_with_token(webhook_id, webhook_token, reason: nil)
  json_request(
    :get,
    discord("/webhooks/#{webhook_id}/#{webhook_token}"),
    headers: auditlog(reason)
  )
end

#group_dm_add_recipient(channel_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Group DM Add Recipient"

# File 'lib/lib_discord/client.rb', line 1005

def group_dm_add_recipient(channel_id, user_id, body, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/recipients/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#group_dm_remove_recipient(channel_id, user_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Group DM Remove Recipient"

# File 'lib/lib_discord/client.rb', line 1022

def group_dm_remove_recipient(channel_id, user_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/recipients/#{user_id}"),
    headers: auditlog(reason)
  )
end

#join_thread(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Join Thread"

# File 'lib/lib_discord/client.rb', line 1089

def join_thread(channel_id, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/thread-members/@me"),
    headers: auditlog(reason)
  )
end

#leave_guild(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Leave Guild"

# File 'lib/lib_discord/client.rb', line 3386

def leave_guild(guild_id, reason: nil)
  json_request(
    :delete,
    discord("/users/@me/guilds/#{guild_id}"),
    headers: auditlog(reason)
  )
end

#leave_lobby(lobby_id, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Leave Lobby"

# File 'lib/lib_discord/client.rb', line 2626

def leave_lobby(lobby_id, reason: nil)
  json_request(
    :delete,
    discord("/lobbies/#{lobby_id}/members/@me"),
    headers: auditlog(reason)
  )
end

#leave_thread(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Leave Thread"

# File 'lib/lib_discord/client.rb', line 1120

def leave_thread(channel_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/thread-members/@me"),
    headers: auditlog(reason)
  )
end

#link_channel_to_lobby(lobby_id, body, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Link Channel to Lobby"

# File 'lib/lib_discord/client.rb', line 2642

def link_channel_to_lobby(lobby_id, body, reason: nil)
  json_request(
    :patch,
    discord("/lobbies/#{lobby_id}/channel-linking"),
    body:,
    headers: auditlog(reason)
  )
end

#list_active_guild_threads(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Active Guild Threads"

# File 'lib/lib_discord/client.rb', line 1847

def list_active_guild_threads(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/threads/active"),
    headers: auditlog(reason)
  )
end

#list_application_emojis(application_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Application Emojis"

# File 'lib/lib_discord/client.rb', line 1323

def list_application_emojis(application_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/emojis"),
    headers: auditlog(reason)
  )
end

#list_auto_moderation_rules_for_guild(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Auto Moderation Rules for Guild"

# File 'lib/lib_discord/client.rb', line 723

def list_auto_moderation_rules_for_guild(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/auto-moderation/rules"),
    headers: auditlog(reason)
  )
end

#list_default_soundboard_sounds(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Default Soundboard Sounds"

# File 'lib/lib_discord/client.rb', line 2976

def list_default_soundboard_sounds(reason: nil)
  json_request(
    :get,
    discord("/soundboard-default-sounds"),
    headers: auditlog(reason)
  )
end

#list_entitlements(application_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Entitlements"

# File 'lib/lib_discord/client.rb', line 1409

def list_entitlements(application_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/entitlements"),
    headers: auditlog(reason)
  )
end

#list_guild_emojis(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Guild Emojis"

# File 'lib/lib_discord/client.rb', line 1241

def list_guild_emojis(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/emojis"),
    headers: auditlog(reason)
  )
end

#list_guild_members(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Guild Members"

# File 'lib/lib_discord/client.rb', line 1879

def list_guild_members(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/members"),
    query:,
    headers: auditlog(reason)
  )
end

#list_guild_soundboard_sounds(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Guild Soundboard Sounds"

# File 'lib/lib_discord/client.rb', line 2991

def list_guild_soundboard_sounds(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/soundboard-sounds"),
    headers: auditlog(reason)
  )
end

#list_guild_stickers(guild_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Guild Stickers"

# File 'lib/lib_discord/client.rb', line 3188

def list_guild_stickers(guild_id, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/stickers"),
    headers: auditlog(reason)
  )
end

#list_joined_private_archived_threads(channel_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Joined Private Archived Threads"

# File 'lib/lib_discord/client.rb', line 1221

def list_joined_private_archived_threads(channel_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/users/@me/threads/archived/private"),
    query:,
    headers: auditlog(reason)
  )
end

#list_private_archived_threads(channel_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Private Archived Threads"

# File 'lib/lib_discord/client.rb', line 1204

def list_private_archived_threads(channel_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/threads/archived/private"),
    query:,
    headers: auditlog(reason)
  )
end

#list_public_archived_threads(channel_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Public Archived Threads"

# File 'lib/lib_discord/client.rb', line 1187

def list_public_archived_threads(channel_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/threads/archived/public"),
    query:,
    headers: auditlog(reason)
  )
end

#list_scheduled_events_for_guild(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Scheduled Events for Guild"

# File 'lib/lib_discord/client.rb', line 1493

def list_scheduled_events_for_guild(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/scheduled-events"),
    query:,
    headers: auditlog(reason)
  )
end

#list_sku_subscriptions(sku_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

sku_id (#to_s) —

SKU ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List SKU Subscriptions"

# File 'lib/lib_discord/client.rb', line 3275

def list_sku_subscriptions(sku_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/skus/#{sku_id}/subscriptions"),
    query:,
    headers: auditlog(reason)
  )
end

#list_skus(application_id, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List SKUs"

# File 'lib/lib_discord/client.rb', line 2941

def list_skus(application_id, reason: nil)
  json_request(
    :get,
    discord("/applications/#{application_id}/skus"),
    headers: auditlog(reason)
  )
end

#list_sticker_packs(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Sticker Packs"

# File 'lib/lib_discord/client.rb', line 3158

def list_sticker_packs(reason: nil)
  json_request(
    :get,
    discord("/sticker-packs"),
    headers: auditlog(reason)
  )
end

#list_thread_members(channel_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Thread Members"

# File 'lib/lib_discord/client.rb', line 1170

def list_thread_members(channel_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/channels/#{channel_id}/thread-members"),
    query:,
    headers: auditlog(reason)
  )
end

#list_voice_regions(reason: nil) ⇒ `Response`

Parameters:

reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "List Voice Regions"

# File 'lib/lib_discord/client.rb', line 3482

def list_voice_regions(reason: nil)
  json_request(
    :get,
    discord("/voice/regions"),
    headers: auditlog(reason)
  )
end

#modify_application_emoji(application_id, emoji_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
emoji_id (#to_s) —

Emoji ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Application Emoji"

# File 'lib/lib_discord/client.rb', line 1373

def modify_application_emoji(application_id, emoji_id, body, reason: nil)
  json_request(
    :patch,
    discord("/applications/#{application_id}/emojis/#{emoji_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_auto_moderation_rule(guild_id, auto_moderation_rule_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
auto_moderation_rule_id (#to_s) —

Auto Moderation Rule ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Auto Moderation Rule"

# File 'lib/lib_discord/client.rb', line 773

def modify_auto_moderation_rule(guild_id, auto_moderation_rule_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/auto-moderation/rules/#{auto_moderation_rule_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_channel(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Channel"

# File 'lib/lib_discord/client.rb', line 825

def modify_channel(channel_id, body, reason: nil)
  json_request(
    :patch,
    discord("/channels/#{channel_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_current_member(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Current Member"

# File 'lib/lib_discord/client.rb', line 1949

def modify_current_member(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/members/@me"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_current_user(body, reason: nil) ⇒ `Response`

Parameters:

body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Current User"

# File 'lib/lib_discord/client.rb', line 3339

def modify_current_user(body, reason: nil)
  json_request(
    :patch,
    discord("/users/@me"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_current_user_nick(guild_id, body, reason: nil) ⇒ `Response`

Deprecated.

Use #modify_current_member instead.

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Current User Nick"

# File 'lib/lib_discord/client.rb', line 1968

def modify_current_user_nick(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/members/@me/nick"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_current_user_voice_state(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Current User Voice State"

# File 'lib/lib_discord/client.rb', line 3529

def modify_current_user_voice_state(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/voice-states/@me"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild"

# File 'lib/lib_discord/client.rb', line 1767

def modify_guild(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_channel_positions(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Channel Positions"

# File 'lib/lib_discord/client.rb', line 1831

def modify_guild_channel_positions(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/channels"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_emoji(guild_id, emoji_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
emoji_id (#to_s) —

Emoji ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Emoji"

# File 'lib/lib_discord/client.rb', line 1291

def modify_guild_emoji(guild_id, emoji_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/emojis/#{emoji_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_incident_actions(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Incident Actions"

# File 'lib/lib_discord/client.rb', line 2473

def modify_guild_incident_actions(guild_id, body, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/incident-actions"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_member(guild_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Member"

# File 'lib/lib_discord/client.rb', line 1932

def modify_guild_member(guild_id, user_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/members/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_mfa_level(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild MFA level"

# File 'lib/lib_discord/client.rb', line 2202

def modify_guild_mfa_level(guild_id, body, reason: nil)
  json_request(
    :post,
    discord("/guilds/#{guild_id}/mfa"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_onboarding(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Onboarding"

# File 'lib/lib_discord/client.rb', line 2456

def modify_guild_onboarding(guild_id, body, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/onboarding"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_role(guild_id, role_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
role_id (#to_s) —

Role ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Role"

# File 'lib/lib_discord/client.rb', line 2185

def modify_guild_role(guild_id, role_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/roles/#{role_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_role_positions(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Role Positions"

# File 'lib/lib_discord/client.rb', line 2167

def modify_guild_role_positions(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/roles"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_scheduled_event(guild_id, guild_scheduled_event_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
guild_scheduled_event_id (#to_s) —

Guild Scheduled Event ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Scheduled Event"

# File 'lib/lib_discord/client.rb', line 1546

def modify_guild_scheduled_event(guild_id, guild_scheduled_event_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/scheduled-events/#{guild_scheduled_event_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_soundboard_sound(guild_id, sound_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sound_id (#to_s) —

Sound ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Soundboard Sound"

# File 'lib/lib_discord/client.rb', line 3041

def modify_guild_soundboard_sound(guild_id, sound_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/soundboard-sounds/#{sound_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_sticker(guild_id, sticker_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
sticker_id (#to_s) —

Sticker ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Sticker"

# File 'lib/lib_discord/client.rb', line 3238

def modify_guild_sticker(guild_id, sticker_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/stickers/#{sticker_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_template(guild_id, template_code, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
template_code (#to_s) —

Template Code
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Template"

# File 'lib/lib_discord/client.rb', line 1682

def modify_guild_template(guild_id, template_code, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/templates/#{template_code}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_welcome_screen(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Welcome Screen"

# File 'lib/lib_discord/client.rb', line 2424

def modify_guild_welcome_screen(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/welcome-screen"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_guild_widget(guild_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Guild Widget"

# File 'lib/lib_discord/client.rb', line 2345

def modify_guild_widget(guild_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/widget"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_lobby(lobby_id, body, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Lobby"

# File 'lib/lib_discord/client.rb', line 2561

def modify_lobby(lobby_id, body, reason: nil)
  json_request(
    :patch,
    discord("/lobbies/#{lobby_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_stage_instance(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Stage Instance"

# File 'lib/lib_discord/client.rb', line 3109

def modify_stage_instance(channel_id, body, reason: nil)
  json_request(
    :patch,
    discord("/stage-instances/#{channel_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_user_voice_state(guild_id, user_id, body, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify User Voice State"

# File 'lib/lib_discord/client.rb', line 3547

def modify_user_voice_state(guild_id, user_id, body, reason: nil)
  json_request(
    :patch,
    discord("/guilds/#{guild_id}/voice-states/#{user_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_webhook(webhook_id, body, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Webhook"

# File 'lib/lib_discord/client.rb', line 3646

def modify_webhook(webhook_id, body, reason: nil)
  json_request(
    :patch,
    discord("/webhooks/#{webhook_id}"),
    body:,
    headers: auditlog(reason)
  )
end

#modify_webhook_with_token(webhook_id, webhook_token, body, reason: nil) ⇒ `Response`

Parameters:

webhook_id (#to_s) —

Webhook ID
webhook_token (#to_s) —

Webhook Token
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Modify Webhook with Token"

# File 'lib/lib_discord/client.rb', line 3664

def modify_webhook_with_token(webhook_id, webhook_token, body, reason: nil)
  json_request(
    :patch,
    discord("/webhooks/#{webhook_id}/#{webhook_token}"),
    body:,
    headers: auditlog(reason)
  )
end

#oauth2_request_token(user, pass, query) ⇒ `Response`

Parameters:

user (#to_s) —

HTTP basic authorization username
pass (#to_s) —

HTTP basic authorization password
query (Object) —

HTTP query parameters. query is formatted via URI.encode_www_form().

Returns:

(Response)

# File 'lib/lib_discord/client.rb', line 3826

def oauth2_request_token(user, pass, query)
  net_request(
    :post,
    discord("/oauth2/token"),
    body: URI.encode_www_form(query),
    headers: {
      "Authorization" => "Basic " + base64_strictencode("#{user}:#{pass}"),
      "Content-Type" => "application/x-www-form-urlencoded"
    }
  )
end

#oauth2_revoke_token(user, pass, query) ⇒ `Response`

Parameters:

user (#to_s) —

HTTP basic authorization username
pass (#to_s) —

HTTP basic authorization password
query (Object) —

HTTP query parameters. query is formatted via URI.encode_www_form().

Returns:

(Response)

See Also:

Discord documentation "Token Revocation example"

# File 'lib/lib_discord/client.rb', line 3846

def oauth2_revoke_token(user, pass, query)
  net_request(
    :post,
    discord("/oauth2/token/revoke"),
    body: URI.encode_www_form(query),
    headers: {
      "Authorization" => "Basic " + base64_strictencode("#{user}:#{pass}"),
      "Content-Type" => "application/x-www-form-urlencoded"
    }
  )
end

#pin_message(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Pin Message"

# File 'lib/lib_discord/client.rb', line 972

def pin_message(channel_id, message_id, reason: nil)
  json_request(
    :put,
    discord("/channels/#{channel_id}/pins/#{message_id}"),
    headers: auditlog(reason)
  )
end

#remove_guild_ban(guild_id, user_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Remove Guild Ban"

# File 'lib/lib_discord/client.rb', line 2086

def remove_guild_ban(guild_id, user_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/bans/#{user_id}"),
    headers: auditlog(reason)
  )
end

#remove_guild_member(guild_id, user_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Remove Guild Member"

# File 'lib/lib_discord/client.rb', line 2019

def remove_guild_member(guild_id, user_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/members/#{user_id}"),
    headers: auditlog(reason)
  )
end

#remove_guild_member_role(guild_id, user_id, role_id, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
user_id (#to_s) —

User ID
role_id (#to_s) —

Role ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Remove Guild Member Role"

# File 'lib/lib_discord/client.rb', line 2003

def remove_guild_member_role(guild_id, user_id, role_id, reason: nil)
  json_request(
    :delete,
    discord("/guilds/#{guild_id}/members/#{user_id}/roles/#{role_id}"),
    headers: auditlog(reason)
  )
end

#remove_member_from_lobby(lobby_id, user_id, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Remove a Member from a Lobby"

# File 'lib/lib_discord/client.rb', line 2611

def remove_member_from_lobby(lobby_id, user_id, reason: nil)
  json_request(
    :delete,
    discord("/lobbies/#{lobby_id}/members/#{user_id}"),
    headers: auditlog(reason)
  )
end

#remove_thread_member(channel_id, user_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
user_id (#to_s) —

User ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Remove Thread Member"

# File 'lib/lib_discord/client.rb', line 1136

def remove_thread_member(channel_id, user_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/thread-members/#{user_id}"),
    headers: auditlog(reason)
  )
end

#search_guild_members(guild_id, query = {}, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
query (Object) (defaults to: {}) —

HTTP query parameters. query is formatted via URI.encode_www_form().
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Search Guild Members"

# File 'lib/lib_discord/client.rb', line 1896

def search_guild_members(guild_id, query = {}, reason: nil)
  json_request(
    :get,
    discord("/guilds/#{guild_id}/members/search"),
    query:,
    headers: auditlog(reason)
  )
end

#send_soundboard_sound(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Send Soundboard Sound"

# File 'lib/lib_discord/client.rb', line 2961

def send_soundboard_sound(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/send-soundboard-sound"),
    body:,
    headers: auditlog(reason)
  )
end

#start_thread_from_message(channel_id, message_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Start Thread from Message"

# File 'lib/lib_discord/client.rb', line 1039

def start_thread_from_message(channel_id, message_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/messages/#{message_id}/threads"),
    body:,
    headers: auditlog(reason)
  )
end

#start_thread_in_forum_or_media_channel(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Start Thread in Forum or Media Channel"

# File 'lib/lib_discord/client.rb', line 1073

def start_thread_in_forum_or_media_channel(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/threads"),
    body:,
    headers: auditlog(reason)
  )
end

#start_thread_without_message(channel_id, body, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Start Thread without Message"

# File 'lib/lib_discord/client.rb', line 1056

def start_thread_without_message(channel_id, body, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/threads"),
    body:,
    headers: auditlog(reason)
  )
end

#sync_guild_template(guild_id, template_code, reason: nil) ⇒ `Response`

Parameters:

guild_id (#to_s) —

Guild ID
template_code (#to_s) —

Template Code
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Sync Guild Template"

# File 'lib/lib_discord/client.rb', line 1665

def sync_guild_template(guild_id, template_code, reason: nil)
  json_request(
    :put,
    discord("/guilds/#{guild_id}/templates/#{template_code}"),
    headers: auditlog(reason)
  )
end

#trigger_typing_indicator(channel_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Trigger Typing Indicator"

# File 'lib/lib_discord/client.rb', line 941

def trigger_typing_indicator(channel_id, reason: nil)
  json_request(
    :post,
    discord("/channels/#{channel_id}/typing"),
    headers: auditlog(reason)
  )
end

#unlink_channel_from_lobby(lobby_id, reason: nil) ⇒ `Response`

Parameters:

lobby_id (#to_s) —

Lobby ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Unlink Channel from Lobby"

# File 'lib/lib_discord/client.rb', line 2658

def unlink_channel_from_lobby(lobby_id, reason: nil)
  json_request(
    :patch,
    discord("/lobbies/#{lobby_id}/channel-linking"),
    headers: auditlog(reason)
  )
end

#unpin_message(channel_id, message_id, reason: nil) ⇒ `Response`

Parameters:

channel_id (#to_s) —

Channel ID
message_id (#to_s) —

Message ID
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Unpin Message"

# File 'lib/lib_discord/client.rb', line 988

def unpin_message(channel_id, message_id, reason: nil)
  json_request(
    :delete,
    discord("/channels/#{channel_id}/pins/#{message_id}"),
    headers: auditlog(reason)
  )
end

#update_application_role_connection_metadata_records(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Update Application Role Connection Metadata Records"

# File 'lib/lib_discord/client.rb', line 636

def update_application_role_connection_metadata_records(application_id, body, reason: nil)
  json_request(
    :put,
    discord("/applications/#{application_id}/role-connections/metadata"),
    body:,
    headers: auditlog(reason)
  )
end

#update_current_user_application_role_connection(application_id, body, reason: nil) ⇒ `Response`

Parameters:

application_id (#to_s) —

Application ID
body (#to_json) —

Request body
reason (#to_s) (defaults to: nil) —

A short message describing the purpose of this request, sent via the X-Audit-Log-Reason header. If the given endpoint supports the Audit Log, Discord will enter the message into the server’s audit log.

Returns:

(Response)

See Also:

Discord documentation "Update Current User Application Role Connection"

# File 'lib/lib_discord/client.rb', line 3463

def update_current_user_application_role_connection(application_id, body, reason: nil)
  json_request(
    :put,
    discord("/users/@me/applications/#{application_id}/role-connection"),
    body:,
    headers: auditlog(reason)
  )
end

Class: LibDiscord::Client

Overview

Instance Method Summary collapse

Constructor Details

#initialize(auth = nil, user_agent: "LibDiscord (#{LibDiscord::PROJECT_URL}, #{LibDiscord.version})", logger: nil) ⇒ self

Examples:

hook in your own logger and app-specific user-agent

Suppress all stdout logger output.

Make a request to a public endpoint.

Instance Method Details

#add_guild_member(guild_id, user_id, body, reason: nil) ⇒ Response

#add_guild_member_role(guild_id, user_id, role_id, reason: nil) ⇒ Response

#add_member_to_lobby(lobby_id, user_id, body, reason: nil) ⇒ Response

#add_thread_member(channel_id, user_id, reason: nil) ⇒ Response

#batch_edit_application_command_permissions(application_id, guild_id, body, reason: nil) ⇒ Response

#begin_guild_prune(guild_id, body, reason: nil) ⇒ Response

#bulk_delete_messages(channel_id, body, reason: nil) ⇒ Response

#bulk_guild_ban(guild_id, body, reason: nil) ⇒ Response

#bulk_overwrite_global_application_commands(application_id, body, reason: nil) ⇒ Response

#bulk_overwrite_guild_application_commands(application_id, guild_id, body, reason: nil) ⇒ Response

#consume_entitlement(application_id, entitlement_id, reason: nil) ⇒ Response

#create_application_emoji(application_id, body, reason: nil) ⇒ Response

#create_auto_moderation_rule(guild_id, body, reason: nil) ⇒ Response

#create_channel_invite(channel_id, body, reason: nil) ⇒ Response

#create_dm(body, reason: nil) ⇒ Response

#create_followup_message(application_id, interaction_token, body, reason: nil) ⇒ Response

#create_global_application_command(application_id, body, reason: nil) ⇒ Response

#create_group_dm(body, reason: nil) ⇒ Response

#create_guild(body, reason: nil) ⇒ Response

#create_guild_application_command(application_id, guild_id, body, reason: nil) ⇒ Response

#create_guild_ban(guild_id, user_id, body, reason: nil) ⇒ Response

#create_guild_channel(guild_id, body, reason: nil) ⇒ Response

#create_guild_emoji(guild_id, body, reason: nil) ⇒ Response

#create_guild_from_guild_template(template_code, body, reason: nil) ⇒ Response

#create_guild_role(guild_id, body, reason: nil) ⇒ Response

#create_guild_scheduled_event(guild_id, body, reason: nil) ⇒ Response

#create_guild_soundboard_sound(guild_id, body, reason: nil) ⇒ Response

#create_guild_sticker(guild_id, body, reason: nil) ⇒ Response

#create_guild_template(guild_id, body, reason: nil) ⇒ Response

#create_interaction_response(interaction_id, interaction_token, body, reason: nil) ⇒ Response

#create_lobby(body, reason: nil) ⇒ Response

#create_message(channel_id, body, reason: nil) ⇒ Response

#create_reaction(channel_id, message_id, emoji, reason: nil) ⇒ Response

#create_stage_instance(body, reason: nil) ⇒ Response

#create_test_entitlement(application_id, body, reason: nil) ⇒ Response

#create_webhook(channel_id, body, reason: nil) ⇒ Response

#crosspost_message(channel_id, message_id, reason: nil) ⇒ Response

#delete_all_reactions(channel_id, message_id, reason: nil) ⇒ Response

#delete_all_reactions_for_emoji(channel_id, message_id, emoji, reason: nil) ⇒ Response

#delete_application_emoji(application_id, emoji_id, reason: nil) ⇒ Response

#delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil) ⇒ Response

#delete_channel(channel_id, reason: nil) ⇒ Response Also known as: close_channel

#delete_channel_permission(channel_id, overwrite_id, reason: nil) ⇒ Response

#delete_followup_message(application_id, interaction_token, message_id, reason: nil) ⇒ Response

#delete_global_application_command(application_id, command_id, reason: nil) ⇒ Response

#delete_guild(guild_id, reason: nil) ⇒ Response

#delete_guild_application_command(application_id, guild_id, command_id, reason: nil) ⇒ Response

#delete_guild_emoji(guild_id, emoji_id, reason: nil) ⇒ Response

#delete_guild_integration(guild_id, integration_id, reason: nil) ⇒ Response

#delete_guild_role(guild_id, role_id, reason: nil) ⇒ Response

#delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, reason: nil) ⇒ Response

#delete_guild_soundboard_sound(guild_id, sound_id, reason: nil) ⇒ Response

#delete_guild_sticker(guild_id, sticker_id, reason: nil) ⇒ Response

#delete_guild_template(guild_id, template_code, reason: nil) ⇒ Response

#delete_invite(invite_code, reason: nil) ⇒ Response

#delete_lobby(lobby_id, reason: nil) ⇒ Response

#delete_message(channel_id, message_id, reason: nil) ⇒ Response

#delete_original_interaction_response(application_id, interaction_token, reason: nil) ⇒ Response

#delete_own_reaction(channel_id, message_id, emoji, reason: nil) ⇒ Response

#delete_stage_instance(channel_id, reason: nil) ⇒ Response

#delete_test_entitlement(application_id, entitlement_id, reason: nil) ⇒ Response

#delete_user_reaction(channel_id, message_id, emoji, user_id, reason: nil) ⇒ Response

#delete_webhook(webhook_id, reason: nil) ⇒ Response

#delete_webhook_message(webhook_id, webhook_token, message_id, reason: nil) ⇒ Response

#delete_webhook_with_token(webhook_id, webhook_token, reason: nil) ⇒ Response

#edit_application_command_permissions(application_id, guild_id, command_id, body, reason: nil) ⇒ Response

#edit_channel_permissions(channel_id, overwrite_id, body, reason: nil) ⇒ Response

#edit_current_application(body, reason: nil) ⇒ Response

#edit_followup_message(application_id, interaction_token, message_id, body, reason: nil) ⇒ Response

#edit_global_application_command(application_id, command_id, body, reason: nil) ⇒ Response

#initialize(auth = nil, user_agent: "LibDiscord (#{LibDiscord::PROJECT_URL}, #{LibDiscord.version})", logger: nil) ⇒ `self`

Suppress all `stdout` logger output.

#add_guild_member(guild_id, user_id, body, reason: nil) ⇒ `Response`

#add_guild_member_role(guild_id, user_id, role_id, reason: nil) ⇒ `Response`

#add_member_to_lobby(lobby_id, user_id, body, reason: nil) ⇒ `Response`

#add_thread_member(channel_id, user_id, reason: nil) ⇒ `Response`

#batch_edit_application_command_permissions(application_id, guild_id, body, reason: nil) ⇒ `Response`

#begin_guild_prune(guild_id, body, reason: nil) ⇒ `Response`

#bulk_delete_messages(channel_id, body, reason: nil) ⇒ `Response`

#bulk_guild_ban(guild_id, body, reason: nil) ⇒ `Response`

#bulk_overwrite_global_application_commands(application_id, body, reason: nil) ⇒ `Response`

#bulk_overwrite_guild_application_commands(application_id, guild_id, body, reason: nil) ⇒ `Response`

#consume_entitlement(application_id, entitlement_id, reason: nil) ⇒ `Response`

#create_application_emoji(application_id, body, reason: nil) ⇒ `Response`

#create_auto_moderation_rule(guild_id, body, reason: nil) ⇒ `Response`

#create_channel_invite(channel_id, body, reason: nil) ⇒ `Response`

#create_dm(body, reason: nil) ⇒ `Response`

#create_followup_message(application_id, interaction_token, body, reason: nil) ⇒ `Response`

#create_global_application_command(application_id, body, reason: nil) ⇒ `Response`

#create_group_dm(body, reason: nil) ⇒ `Response`

#create_guild(body, reason: nil) ⇒ `Response`

#create_guild_application_command(application_id, guild_id, body, reason: nil) ⇒ `Response`

#create_guild_ban(guild_id, user_id, body, reason: nil) ⇒ `Response`

#create_guild_channel(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_emoji(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_from_guild_template(template_code, body, reason: nil) ⇒ `Response`

#create_guild_role(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_scheduled_event(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_soundboard_sound(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_sticker(guild_id, body, reason: nil) ⇒ `Response`

#create_guild_template(guild_id, body, reason: nil) ⇒ `Response`

#create_interaction_response(interaction_id, interaction_token, body, reason: nil) ⇒ `Response`

#create_lobby(body, reason: nil) ⇒ `Response`

#create_message(channel_id, body, reason: nil) ⇒ `Response`

#create_reaction(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

#create_stage_instance(body, reason: nil) ⇒ `Response`

#create_test_entitlement(application_id, body, reason: nil) ⇒ `Response`

#create_webhook(channel_id, body, reason: nil) ⇒ `Response`

#crosspost_message(channel_id, message_id, reason: nil) ⇒ `Response`

#delete_all_reactions(channel_id, message_id, reason: nil) ⇒ `Response`

#delete_all_reactions_for_emoji(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

#delete_application_emoji(application_id, emoji_id, reason: nil) ⇒ `Response`

#delete_auto_moderation_rule(guild_id, auto_moderation_rule_id, reason: nil) ⇒ `Response`

#delete_channel(channel_id, reason: nil) ⇒ `Response` Also known as: close_channel

#delete_channel_permission(channel_id, overwrite_id, reason: nil) ⇒ `Response`

#delete_followup_message(application_id, interaction_token, message_id, reason: nil) ⇒ `Response`

#delete_global_application_command(application_id, command_id, reason: nil) ⇒ `Response`

#delete_guild(guild_id, reason: nil) ⇒ `Response`

#delete_guild_application_command(application_id, guild_id, command_id, reason: nil) ⇒ `Response`

#delete_guild_emoji(guild_id, emoji_id, reason: nil) ⇒ `Response`

#delete_guild_integration(guild_id, integration_id, reason: nil) ⇒ `Response`

#delete_guild_role(guild_id, role_id, reason: nil) ⇒ `Response`

#delete_guild_scheduled_event(guild_id, guild_scheduled_event_id, reason: nil) ⇒ `Response`

#delete_guild_soundboard_sound(guild_id, sound_id, reason: nil) ⇒ `Response`

#delete_guild_sticker(guild_id, sticker_id, reason: nil) ⇒ `Response`

#delete_guild_template(guild_id, template_code, reason: nil) ⇒ `Response`

#delete_invite(invite_code, reason: nil) ⇒ `Response`

#delete_lobby(lobby_id, reason: nil) ⇒ `Response`

#delete_message(channel_id, message_id, reason: nil) ⇒ `Response`

#delete_original_interaction_response(application_id, interaction_token, reason: nil) ⇒ `Response`

#delete_own_reaction(channel_id, message_id, emoji, reason: nil) ⇒ `Response`

#delete_stage_instance(channel_id, reason: nil) ⇒ `Response`

#delete_test_entitlement(application_id, entitlement_id, reason: nil) ⇒ `Response`

#delete_user_reaction(channel_id, message_id, emoji, user_id, reason: nil) ⇒ `Response`

#delete_webhook(webhook_id, reason: nil) ⇒ `Response`

#delete_webhook_message(webhook_id, webhook_token, message_id, reason: nil) ⇒ `Response`

#delete_webhook_with_token(webhook_id, webhook_token, reason: nil) ⇒ `Response`

#edit_application_command_permissions(application_id, guild_id, command_id, body, reason: nil) ⇒ `Response`

#edit_channel_permissions(channel_id, overwrite_id, body, reason: nil) ⇒ `Response`

#edit_current_application(body, reason: nil) ⇒ `Response`

#edit_followup_message(application_id, interaction_token, message_id, body, reason: nil) ⇒ `Response`

#edit_global_application_command(application_id, command_id, body, reason: nil) ⇒ `Response`

#edit_guild_application_command(application_id, guild_id, command_id, body, reason: nil) ⇒ `Response`

#edit_message(channel_id, message_id, body, reason: nil) ⇒ `Response`

#edit_original_interaction_response(application_id, interaction_token, body, reason: nil) ⇒ `Response`

#edit_webhook_message(webhook_id, webhook_token, message_id, body, query = {}, reason: nil) ⇒ `Response`

#end_poll(channel_id, message_id, reason: nil) ⇒ `Response`

#execute_github_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil) ⇒ `Response`

#execute_slack_compatible_webhook(webhook_id, webhook_token, query = {}, reason: nil) ⇒ `Response`

#execute_webhook(webhook_id, webhook_token, body, query = {}, reason: nil) ⇒ `Response`