Guild

HTTP Rest API implementation for the following Resource:

• https://discord.com/developers/docs/resources/guild

Summary

Functions

Guild.getGuildAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { withCounts: boolean?, }) → future.FutureLike<string, apiTypes.GetGuildResponse>Guild.getGuildPreviewAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildPreviewResponse>Guild.modifyGuildAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildResponse>Guild.deleteGuildAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.DeleteGuildResponse>Guild.getGuildChannelsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildChannelsResponse>Guild.createGuildChannelAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.CreateGuildChannelRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateGuildChannelResponse>Guild.getGuildRoleMemberCountsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildRoleMemberCountsResponse>Guild.modifyGuildChannelPositionsAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildChannelPositionsRequest) → future.FutureLike<string, apiTypes.ModifyGuildChannelPositionsResponse>Guild.listActiveGuildThreadsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.ListActiveGuildThreadsResponse>Guild.getGuildMemberAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildMemberResponse>Guild.listGuildMembersAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { limit: number?, after: string?, }) → future.FutureLike<string, apiTypes.ListGuildMembersResponse>Guild.searchGuildMessagesAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: apiTypes.SearchGuildMessagesRequest) → future.FutureLike<string, apiTypes.SearchGuildMessagesResponse>Guild.searchGuildMembersAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { query: string, limit: number?, }) → future.FutureLike<string, apiTypes.SearchGuildMembersResponse>Guild.addGuildMemberAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, jsonParams: apiTypes.AddGuildMemberRequest) → future.FutureLike<string, apiTypes.AddGuildMemberResponse>Guild.modifyGuildMemberAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildMemberRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildMemberResponse>Guild.modifyCurrentMemberAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyCurrentMemberRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyCurrentMemberResponse>Guild.addGuildMemberRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, roleId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.AddGuildMemberRoleResponse>Guild.removeGuildMemberRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, roleId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.RemoveGuildMemberRoleResponse>Guild.removeGuildMemberAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.RemoveGuildMemberResponse>Guild.getGuildBansAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { limit: number?, before: apiTypes.Snowflake?, after: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.GetGuildBansResponse>Guild.getGuildBanAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildBanResponse>Guild.createGuildBanAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, jsonParams: apiTypes.CreateGuildBanRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateGuildBanResponse>Guild.removeGuildBanAsync(instance: request.Request, guildId: apiTypes.Snowflake, userId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.RemoveGuildBanResponse>Guild.bulkGuildBanAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.BulkGuildBanRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.BulkGuildBanResponse>Guild.getGuildRolesAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildRolesResponse>Guild.getGuildRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, roleId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildRoleResponse>Guild.createGuildRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.CreateGuildRoleRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateGuildRoleResponse>Guild.modifyGuildRolePositionsAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildRolePositionsRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildRolePositionsResponse>Guild.modifyGuildRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, roleId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildRoleRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildRoleResponse>Guild.modifyGuildMFALevelAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildMFALevelRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildMFALevelResponse>Guild.deleteGuildRoleAsync(instance: request.Request, guildId: apiTypes.Snowflake, roleId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteGuildRoleResponse>Guild.getGuildPruneCountAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { days: number, includeRoles: string, }) → future.FutureLike<string, apiTypes.GetGuildPruneCountResponse>Guild.beginGuildPruneAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.BeginGuildPruneRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.BeginGuildPruneResponse>Guild.getGuildVoiceRegionsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildVoiceRegionsResponse>Guild.getGuildInvitesAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildInvitesResponse>Guild.getGuildIntegrationsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildIntegrationsResponse>Guild.deleteGuildIntegrationAsync(instance: request.Request, guildId: apiTypes.Snowflake, integrationId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteGuildIntegrationResponse>Guild.getGuildWidgetSettingsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildWidgetSettingsResponse>Guild.modifyGuildWidgetAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildWidgetRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildWidgetResponse>Guild.getGuildWidgetAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildWidgetResponse>Guild.getGuildVanityURLAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildVanityUrlResponse>Guild.getGuildWidgetImageAsync(instance: request.Request, guildId: apiTypes.Snowflake, urlParams: { style: (&quot;shield&quot; | &quot;banner1&quot; | &quot;banner2&quot; | &quot;banner3&quot; | &quot;banner4&quot;)?, }) → future.FutureLike<string, apiTypes.GetGuildWidgetImageResponse>Guild.getGuildWelcomeScreenAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildWelcomeScreenResponse>Guild.modifyGuildWelcomeScreenAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildWelcomeScreenRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildWelcomeScreenResponse>Guild.getGuildOnboardingAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildOnboardingResponse>Guild.modifyGuildOnboardingAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildOnboardingRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildOnboardingResponse>Guild.listDefaultSoundboardSoundsAsync(instance: request.Request) → future.FutureLike<string, apiTypes.ListDefaultSoundboardSoundsResponse>Guild.listGuildSoundboardSoundsAsync(instance: request.Request, guildId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.ListGuildSoundboardSoundsResponse>Guild.getGuildSoundboardSoundAsync(instance: request.Request, guildId: apiTypes.Snowflake, soundId: apiTypes.Snowflake) → future.FutureLike<string, apiTypes.GetGuildSoundboardSoundResponse>Guild.createGuildSoundboardSoundAsync(instance: request.Request, guildId: apiTypes.Snowflake, jsonParams: apiTypes.CreateGuildSoundboardSoundRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.CreateGuildSoundboardSoundResponse>Guild.modifyGuildSoundboardSoundAsync(instance: request.Request, guildId: apiTypes.Snowflake, soundId: apiTypes.Snowflake, jsonParams: apiTypes.ModifyGuildSoundboardSoundRequest, auditLogReason: string?) → future.FutureLike<string, apiTypes.ModifyGuildSoundboardSoundResponse>Guild.deleteGuildSoundboardSoundAsync(instance: request.Request, guildId: apiTypes.Snowflake, soundId: apiTypes.Snowflake, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteGuildSoundboardSoundResponse>

Functions

getGuildAsync

Guild . getGuildAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, GetGuildResponse>

https://discord.com/developers/docs/resources/guild#get-guild

Parameters

instance: Request
guildId: Snowflake
urlParams: { { withCounts: boolean?, } }

Returns

FutureLike<string, GetGuildResponse>

getGuildPreviewAsync

Guild . getGuildPreviewAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildPreviewResponse>

https://discord.com/developers/docs/resources/guild#get-guild-preview

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildPreviewResponse>

modifyGuildAsync

Guild . modifyGuildAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildResponse>

https://discord.com/developers/docs/resources/guild#modify-guild

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildResponse>

deleteGuildAsync

Guild . deleteGuildAsync ( instance ,  guildId )  -> FutureLike<string, DeleteGuildResponse>

https://discord.com/developers/docs/resources/guild#delete-guild

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, DeleteGuildResponse>

getGuildChannelsAsync

Guild . getGuildChannelsAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildChannelsResponse>

https://discord.com/developers/docs/resources/guild#get-guild-channels

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildChannelsResponse>

createGuildChannelAsync

Guild . createGuildChannelAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, CreateGuildChannelResponse>

https://discord.com/developers/docs/resources/guild#create-guild-channel

Parameters

instance: Request
guildId: Snowflake
jsonParams: CreateGuildChannelRequest
auditLogReason: string?

Returns

FutureLike<string, CreateGuildChannelResponse>

getGuildRoleMemberCountsAsync

Guild . getGuildRoleMemberCountsAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildRoleMemberCountsResponse>

https://docs.discord.com/developers/resources/guild#get-guild-role-member-counts

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildRoleMemberCountsResponse>

modifyGuildChannelPositionsAsync

Guild . modifyGuildChannelPositionsAsync ( instance ,  guildId ,  jsonParams )  -> FutureLike<string, ModifyGuildChannelPositionsResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-channel-positions

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildChannelPositionsRequest

Returns

FutureLike<string, ModifyGuildChannelPositionsResponse>

listActiveGuildThreadsAsync

Guild . listActiveGuildThreadsAsync ( instance ,  guildId )  -> FutureLike<string, ListActiveGuildThreadsResponse>

https://discord.com/developers/docs/resources/guild#list-active-guild-threads

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, ListActiveGuildThreadsResponse>

getGuildMemberAsync

Guild . getGuildMemberAsync ( instance ,  guildId ,  userId )  -> FutureLike<string, GetGuildMemberResponse>

https://discord.com/developers/docs/resources/guild#get-guild-member

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake

Returns

FutureLike<string, GetGuildMemberResponse>

listGuildMembersAsync

Guild . listGuildMembersAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, ListGuildMembersResponse>

https://discord.com/developers/docs/resources/guild#list-guild-members

Parameters

instance: Request
guildId: Snowflake
urlParams: { limit: number?, after: string?, }

Returns

FutureLike<string, ListGuildMembersResponse>

searchGuildMessagesAsync

Guild . searchGuildMessagesAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, SearchGuildMessagesResponse>

https://docs.discord.com/developers/resources/message#search-guild-messages

Parameters

instance: Request
guildId: Snowflake
urlParams: SearchGuildMessagesRequest

Returns

FutureLike<string, SearchGuildMessagesResponse>

searchGuildMembersAsync

Guild . searchGuildMembersAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, SearchGuildMembersResponse>

https://discord.com/developers/docs/resources/guild#search-guild-members

Parameters

instance: Request
guildId: Snowflake
urlParams: { query: string, limit: number?, }

Returns

FutureLike<string, SearchGuildMembersResponse>

addGuildMemberAsync

Guild . addGuildMemberAsync ( instance ,  guildId ,  userId ,  jsonParams )  -> FutureLike<string, AddGuildMemberResponse>

https://discord.com/developers/docs/resources/guild#add-guild-member

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
jsonParams: AddGuildMemberRequest

Returns

FutureLike<string, AddGuildMemberResponse>

modifyGuildMemberAsync

Guild . modifyGuildMemberAsync ( instance ,  guildId ,  userId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildMemberResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-member

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
jsonParams: ModifyGuildMemberRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildMemberResponse>

modifyCurrentMemberAsync

Guild . modifyCurrentMemberAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyCurrentMemberResponse>

https://discord.com/developers/docs/resources/guild#modify-current-member

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyCurrentMemberRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyCurrentMemberResponse>

addGuildMemberRoleAsync

Guild . addGuildMemberRoleAsync ( instance ,  guildId ,  userId ,  roleId ,  auditLogReason )  -> FutureLike<string, AddGuildMemberRoleResponse>

https://discord.com/developers/docs/resources/guild#add-guild-member-role

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, AddGuildMemberRoleResponse>

removeGuildMemberRoleAsync

Guild . removeGuildMemberRoleAsync ( instance ,  guildId ,  userId ,  roleId ,  auditLogReason )  -> FutureLike<string, RemoveGuildMemberRoleResponse>

https://discord.com/developers/docs/resources/guild#remove-guild-member-role

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
roleId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, RemoveGuildMemberRoleResponse>

removeGuildMemberAsync

Guild . removeGuildMemberAsync ( instance ,  guildId ,  userId ,  auditLogReason )  -> FutureLike<string, RemoveGuildMemberResponse>

https://discord.com/developers/docs/resources/guild#remove-guild-member

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, RemoveGuildMemberResponse>

getGuildBansAsync

Guild . getGuildBansAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, GetGuildBansResponse>

https://discord.com/developers/docs/resources/guild#get-guild-bans

Parameters

instance: Request
guildId: Snowflake
urlParams: { limit: number?, before: apiTypes.Snowflake?, after: apiTypes.Snowflake?, }

Returns

FutureLike<string, GetGuildBansResponse>

getGuildBanAsync

Guild . getGuildBanAsync ( instance ,  guildId ,  userId )  -> FutureLike<string, GetGuildBanResponse>

https://discord.com/developers/docs/resources/guild#get-guild-ban

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake

Returns

FutureLike<string, GetGuildBanResponse>

createGuildBanAsync

Guild . createGuildBanAsync ( instance ,  guildId ,  userId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, CreateGuildBanResponse>

https://discord.com/developers/docs/resources/guild#create-guild-ban

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
jsonParams: CreateGuildBanRequest
auditLogReason: string?

Returns

FutureLike<string, CreateGuildBanResponse>

removeGuildBanAsync

Guild . removeGuildBanAsync ( instance ,  guildId ,  userId ,  auditLogReason )  -> FutureLike<string, RemoveGuildBanResponse>

https://discord.com/developers/docs/resources/guild#remove-guild-ban

Parameters

instance: Request
guildId: Snowflake
userId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, RemoveGuildBanResponse>

bulkGuildBanAsync

Guild . bulkGuildBanAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, BulkGuildBanResponse>

https://discord.com/developers/docs/resources/guild#bulk-guild-ban

Parameters

instance: Request
guildId: Snowflake
jsonParams: BulkGuildBanRequest
auditLogReason: string?

Returns

FutureLike<string, BulkGuildBanResponse>

getGuildRolesAsync

Guild . getGuildRolesAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildRolesResponse>

https://discord.com/developers/docs/resources/guild#get-guild-roles

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildRolesResponse>

getGuildRoleAsync

Guild . getGuildRoleAsync ( instance ,  guildId ,  roleId )  -> FutureLike<string, GetGuildRoleResponse>

https://discord.com/developers/docs/resources/guild#get-guild-role

Parameters

instance: Request
guildId: Snowflake
roleId: Snowflake

Returns

FutureLike<string, GetGuildRoleResponse>

createGuildRoleAsync

Guild . createGuildRoleAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, CreateGuildRoleResponse>

https://discord.com/developers/docs/resources/guild#create-guild-role

Parameters

instance: Request
guildId: Snowflake
jsonParams: CreateGuildRoleRequest
auditLogReason: string?

Returns

FutureLike<string, CreateGuildRoleResponse>

modifyGuildRolePositionsAsync

Guild . modifyGuildRolePositionsAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildRolePositionsResponse>

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

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildRolePositionsRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildRolePositionsResponse>

modifyGuildRoleAsync

Guild . modifyGuildRoleAsync ( instance ,  guildId ,  roleId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildRoleResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-role

Parameters

instance: Request
guildId: Snowflake
roleId: Snowflake
jsonParams: ModifyGuildRoleRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildRoleResponse>

modifyGuildMFALevelAsync

Guild . modifyGuildMFALevelAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildMFALevelResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-mfa-level

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildMFALevelRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildMFALevelResponse>

deleteGuildRoleAsync

Guild . deleteGuildRoleAsync ( instance ,  guildId ,  roleId ,  auditLogReason )  -> FutureLike<string, DeleteGuildRoleResponse>

https://discord.com/developers/docs/resources/guild#delete-guild-role

Parameters

instance: Request
guildId: Snowflake
roleId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, DeleteGuildRoleResponse>

getGuildPruneCountAsync

Guild . getGuildPruneCountAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, GetGuildPruneCountResponse>

https://discord.com/developers/docs/resources/guild#get-guild-prune-count

Parameters

instance: Request
guildId: Snowflake
urlParams: { days: number, includeRoles: string, }

Returns

FutureLike<string, GetGuildPruneCountResponse>

beginGuildPruneAsync

Guild . beginGuildPruneAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, BeginGuildPruneResponse>

https://discord.com/developers/docs/resources/guild#begin-guild-prune

Parameters

instance: Request
guildId: Snowflake
jsonParams: BeginGuildPruneRequest
auditLogReason: string?

Returns

FutureLike<string, BeginGuildPruneResponse>

getGuildVoiceRegionsAsync

Guild . getGuildVoiceRegionsAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildVoiceRegionsResponse>

https://discord.com/developers/docs/resources/guild#get-guild-voice-regions

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildVoiceRegionsResponse>

getGuildInvitesAsync

Guild . getGuildInvitesAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildInvitesResponse>

https://discord.com/developers/docs/resources/guild#get-guild-invites

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildInvitesResponse>

getGuildIntegrationsAsync

Guild . getGuildIntegrationsAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildIntegrationsResponse>

https://discord.com/developers/docs/resources/guild#get-guild-integrations

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildIntegrationsResponse>

deleteGuildIntegrationAsync

Guild . deleteGuildIntegrationAsync ( instance ,  guildId ,  integrationId ,  auditLogReason )  -> FutureLike<string, DeleteGuildIntegrationResponse>

https://discord.com/developers/docs/resources/guild#delete-guild-integration

Parameters

instance: Request
guildId: Snowflake
integrationId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, DeleteGuildIntegrationResponse>

getGuildWidgetSettingsAsync

Guild . getGuildWidgetSettingsAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildWidgetSettingsResponse>

https://discord.com/developers/docs/resources/guild#get-guild-widget-settings

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildWidgetSettingsResponse>

modifyGuildWidgetAsync

Guild . modifyGuildWidgetAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildWidgetResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-widget

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildWidgetRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildWidgetResponse>

getGuildWidgetAsync

Guild . getGuildWidgetAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildWidgetResponse>

https://discord.com/developers/docs/resources/guild#get-guild-widget

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildWidgetResponse>

getGuildVanityURLAsync

Guild . getGuildVanityURLAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildVanityUrlResponse>

https://discord.com/developers/docs/resources/guild#get-guild-vanity-url

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildVanityUrlResponse>

getGuildWidgetImageAsync

Guild . getGuildWidgetImageAsync ( instance ,  guildId ,  urlParams )  -> FutureLike<string, GetGuildWidgetImageResponse>

https://discord.com/developers/docs/resources/guild#get-guild-widget-image

Parameters

instance: Request
guildId: Snowflake
urlParams: { { style: ("shield" | "banner1" | "banner2" | "banner3" | "banner4")?, } }

Returns

FutureLike<string, GetGuildWidgetImageResponse>

getGuildWelcomeScreenAsync

Guild . getGuildWelcomeScreenAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildWelcomeScreenResponse>

https://discord.com/developers/docs/resources/guild#get-guild-welcome-screen

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildWelcomeScreenResponse>

modifyGuildWelcomeScreenAsync

Guild . modifyGuildWelcomeScreenAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildWelcomeScreenResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-welcome-screen

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildWelcomeScreenRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildWelcomeScreenResponse>

getGuildOnboardingAsync

Guild . getGuildOnboardingAsync ( instance ,  guildId )  -> FutureLike<string, GetGuildOnboardingResponse>

https://discord.com/developers/docs/resources/guild#get-guild-onboarding

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, GetGuildOnboardingResponse>

modifyGuildOnboardingAsync

Guild . modifyGuildOnboardingAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildOnboardingResponse>

https://discord.com/developers/docs/resources/guild#modify-guild-onboarding

Parameters

instance: Request
guildId: Snowflake
jsonParams: ModifyGuildOnboardingRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildOnboardingResponse>

listDefaultSoundboardSoundsAsync

Guild . listDefaultSoundboardSoundsAsync ( instance )  -> FutureLike<string, ListDefaultSoundboardSoundsResponse>

https://discord.com/developers/docs/resources/soundboard#list-default-soundboard-sounds

Parameters

instance: Request

Returns

FutureLike<string, ListDefaultSoundboardSoundsResponse>

listGuildSoundboardSoundsAsync

Guild . listGuildSoundboardSoundsAsync ( instance ,  guildId )  -> FutureLike<string, ListGuildSoundboardSoundsResponse>

https://discord.com/developers/docs/resources/soundboard#list-guild-soundboard-sounds

Parameters

instance: Request
guildId: Snowflake

Returns

FutureLike<string, ListGuildSoundboardSoundsResponse>

getGuildSoundboardSoundAsync

Guild . getGuildSoundboardSoundAsync ( instance ,  guildId ,  soundId )  -> FutureLike<string, GetGuildSoundboardSoundResponse>

https://discord.com/developers/docs/resources/soundboard#get-guild-soundboard-sound

Parameters

instance: Request
guildId: Snowflake
soundId: Snowflake

Returns

FutureLike<string, GetGuildSoundboardSoundResponse>

createGuildSoundboardSoundAsync

Guild . createGuildSoundboardSoundAsync ( instance ,  guildId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, CreateGuildSoundboardSoundResponse>

https://discord.com/developers/docs/resources/soundboard#create-guild-soundboard-sound

Parameters

instance: Request
guildId: Snowflake
jsonParams: CreateGuildSoundboardSoundRequest
auditLogReason: string?

Returns

FutureLike<string, CreateGuildSoundboardSoundResponse>

modifyGuildSoundboardSoundAsync

Guild . modifyGuildSoundboardSoundAsync ( instance ,  guildId ,  soundId ,  jsonParams ,  auditLogReason )  -> FutureLike<string, ModifyGuildSoundboardSoundResponse>

https://discord.com/developers/docs/resources/soundboard#modify-guild-soundboard-sound

Parameters

instance: Request
guildId: Snowflake
soundId: Snowflake
jsonParams: ModifyGuildSoundboardSoundRequest
auditLogReason: string?

Returns

FutureLike<string, ModifyGuildSoundboardSoundResponse>

deleteGuildSoundboardSoundAsync

Guild . deleteGuildSoundboardSoundAsync ( instance ,  guildId ,  soundId ,  auditLogReason )  -> FutureLike<string, DeleteGuildSoundboardSoundResponse>

https://discord.com/developers/docs/resources/soundboard#delete-guild-soundboard-sound

Parameters

instance: Request
guildId: Snowflake
soundId: Snowflake
auditLogReason: string?

Returns

FutureLike<string, DeleteGuildSoundboardSoundResponse>