Class Guilds

Constructors

constructor

new Guilds(manager): Guilds
Parameters
- manager: RESTManager
Returns Guilds
- Defined in lib/routes/Guilds.ts:78

Methods

awardMember

awardMember(guildID, memberID, amount): Promise<number>
Award a member using the built-in EXP system.
Parameters
- guildID: string
  ID of a guild.
- memberID: string
  ID of a member.
- amount: number
  Amount of experience.
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:312

awardRole

awardRole(guildID, roleID, amount): Promise<void>
Award every members of a guild having a role using the built-in EXP system.
Parameters
- guildID: string
  ID of a guild.
- roleID: number
  ID of a role.
- amount: number
  Amount of experience.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:340

bulkAwardXP

bulkAwardXP(guildID, options): Promise<POSTBulkAwardXPResponse>
Bulk Award XP Members
Parameters
- guildID: string
  ID of the guild
- options: POSTBulkAwardXPBody
  Members to award XP
Returns Promise<POSTBulkAwardXPResponse>
- Defined in lib/routes/Guilds.ts:582

bulkSetXP

bulkSetXP(guildID, options): Promise<PUTBulkSetXPResponse>
Bulk set XP Members
Parameters
- guildID: string
  ID of the guild
- options: PUTBulkSetXPBody
  Members to set XP
Returns Promise<PUTBulkSetXPResponse>
- Defined in lib/routes/Guilds.ts:595

createBan

createBan(guildID, memberID, reason?): Promise<BannedMember>
Ban a guild member.
Parameters
- guildID: string
  ID of the guild the member is in.
- memberID: string
  ID of the member to ban.
- Optional reason: string
  The reason of the ban.
Returns Promise<BannedMember>
- Defined in lib/routes/Guilds.ts:247

createCategory

createCategory(guildID, options): Promise<GuildCategory>
Create a guild category.
Parameters
- guildID: string
  ID of the guild to create a category in.
- options: POSTCreateCategoryBody
  Options to create a category.
Returns Promise<GuildCategory>
- Defined in lib/routes/Guilds.ts:608

createCategoryPermission

createCategoryPermission(guildID, categoryID, targetID, options): Promise<Permission>
Create a channel category permission assigned to a user or role.
Parameters
- guildID: string
  ID of the guild where the channel is in
- categoryID: number
  ID of the category
- targetID: string | number
  ID of the user (string) or role (number) to assign the permission to
- options: POSTChannelCategoryUserPermissionBody
  Permission options
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<Permission>
- Defined in lib/routes/Guilds.ts:663

createChannel

createChannel<T>(guildID, name, type, options?): Promise<T>
Create a channel in a specified guild.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- guildID: string
  ID of a guild.
- name: string
  Name of the new channel.
- type: APIChannelCategories
  Type of the new channel. (e.g: chat)
- Optional options: CreateChannelOptions
  New channel's additional options.
Returns Promise<T>
- Defined in lib/routes/Guilds.ts:355

createGroup

createGroup(guildID, options): Promise<GuildGroup>
Create a guild group.
Parameters
- guildID: string
  The ID of the guild to create a group in.
- options: POSTGuildGroupBody
  Create options
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:493

createRole

createRole(guildID, options): Promise<GuildRole>
Create a guild role.
Parameters
- guildID: string
  ID of the server you want to create the role in.
- options: POSTGuildRoleBody
  Create options
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:431

createWebhook

createWebhook(guildID, channelID, name): Promise<Webhook>
Create a webhook
Parameters
- guildID: string
  ID of a guild.
- channelID: string
  ID of a channel.
- name: string
  Name of the new webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:271

deleteCategory

deleteCategory(guildID, categoryID): Promise<GuildCategory>
Delete a guild category.
Parameters
- guildID: string
  ID of the guild to create a category in.
- categoryID: number
  ID of the category you want to read.
Returns Promise<GuildCategory>
- Defined in lib/routes/Guilds.ts:647

deleteCategoryPermission

deleteCategoryPermission(guildID, categoryID, targetID): Promise<void>
Delete a category permission.
Parameters
- guildID: string
  ID of the guild where the channel is in
- categoryID: number
  ID of the category
- targetID: string | number
  ID of the user or role to delete the permission from
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:762

deleteChannel

deleteChannel(channelID): Promise<void>
Delete a channel.
Parameters
- channelID: string
  ID of the channel to delete.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:395

deleteGroup

deleteGroup(guildID, groupID): Promise<void>
Delete a guild group
Parameters
- guildID: string
  ID of the guild where the group is in.
- groupID: string
  ID of the group to delete.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:520

deleteRole

deleteRole(guildID, roleID): Promise<void>
Delete a guild role.
Parameters
- guildID: string
  ID of the guild where the role to delete is in
- roleID: number
  ID of the role to delete
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:458

deleteWebhook

deleteWebhook(guildID, webhookID): Promise<void>
Delete a webhook
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of an existent webhook.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:300

editCategory

editCategory(guildID, categoryID, options): Promise<GuildCategory>
Edit a guild category.
Parameters
- guildID: string
  ID of the guild to create a category in.
- categoryID: number
  ID of the category you want to read.
- options: PATCHUpdateCategoryBody
  Options to update a category.
Returns Promise<GuildCategory>
- Defined in lib/routes/Guilds.ts:634

editCategoryPermission

editCategoryPermission(guildID, categoryID, targetID, options): Promise<Permission>
Update a category permission.
Parameters
- guildID: string
  ID of the server the category is in
- categoryID: number
  ID of the category
- targetID: string | number
  ID of the user (string) or role (number) to assign the permission to.
- options: PATCHChannelCategoryUserPermissionBody
  Edit options
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<Permission>
- Defined in lib/routes/Guilds.ts:685

editChannel

editChannel<T>(channelID, options): Promise<T>
Edit a channel.
Type Parameters
- T extends AnyChannel = AnyChannel
Parameters
- channelID: string
  ID of the channel to edit.
- options: EditChannelOptions
  Channel edit options.
Returns Promise<T>
- Defined in lib/routes/Guilds.ts:379

editGroup

editGroup(guildID, groupID, options): Promise<GuildGroup>
Edit a guild group.
Parameters
- guildID: string
  The ID of the guild where the group to edit is in
- groupID: string
  The ID of the group to edit.
- options: PATCHGuildGroupBody
  Edit options
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:507

editMember

editMember(guildID, memberID, options): Promise<void>
Edit a member.
Parameters
- guildID: string
  ID of the guild the member is in.
- memberID: string
  ID of the the member to edit.
- options: EditMemberOptions
  Edit options.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:214

editRole

editRole(guildID, roleID, options): Promise<GuildRole>
Edit a guild role.
Parameters
- guildID: string
  ID of the server
- roleID: number
  ID of the role to edit
- options: PATCHGuildRoleBody
  Edit options
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:445

editRolePermission

editRolePermission(guildID, roleID, options): Promise<GuildRole>
Edit role permission.
Parameters
- guildID: string
  ID of the guild.
- roleID: number
  ID of the role.
- options: PATCHGuildRoleUpdateBody
  Permission to edit.
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:569

editWebhook

editWebhook(guildID, webhookID, options): Promise<Webhook>
Update a webhook
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of an existent webhook.
- options: EditWebhookOptions
  Edit options.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:287

getBan

getBan(guildID, memberID): Promise<BannedMember>
Get a ban.
Parameters
- guildID: string
  ID of the guild.
- memberID: string
  ID of the banned member.
Returns Promise<BannedMember>
- Defined in lib/routes/Guilds.ts:146

getBans

getBans(guildID): Promise<BannedMember[]>
This method is used to get a list of guild ban.
Parameters
- guildID: string
  ID of the guild.
Returns Promise<BannedMember[]>
- Defined in lib/routes/Guilds.ts:156

getCategory

getCategory(guildID, categoryID): Promise<GuildCategory>
Read a guild category.
Parameters
- guildID: string
  ID of the guild to create a category in.
- categoryID: number
  ID of the category you want to read.
Returns Promise<GuildCategory>
- Defined in lib/routes/Guilds.ts:621

getCategoryPermission

getCategoryPermission(guildID, categoryID, targetID): Promise<Permission>
Get permission coming from a category.
Parameters
- guildID: string
  ID of the guild where the channel is in
- categoryID: number
  ID of the category the permission is in
- targetID: string | number
  ID of the user (string) or role (number) to get the permission for
  
  Warning: targetID must have the correct type (number=role, string=user).
Returns Promise<Permission>
- Defined in lib/routes/Guilds.ts:706

getCategoryPermissions

getCategoryPermissions(guildID, categoryID): Promise<Permission[]>
Get permissions of a category.
Parameters
- guildID: string
  ID of the server the category is in.
- categoryID: number
  ID of the category the permissions are in
Returns Promise<Permission[]>
- Defined in lib/routes/Guilds.ts:722

getCategoryRolePermissions

getCategoryRolePermissions(guildID, categoryID): Promise<Permission[]>
Get role permissions from a specified category.
Parameters
- guildID: string
  ID of the guild where the channel is in
- categoryID: number
  ID of the category the permissions are in
Returns Promise<Permission[]>
- Defined in lib/routes/Guilds.ts:749

getCategoryUserPermissions

getCategoryUserPermissions(guildID, categoryID): Promise<Permission[]>
Get user permissions from a specified category.
Parameters
- guildID: string
  ID of the guild where the channel is in
- categoryID: number
  ID of the category the permissions are in
Returns Promise<Permission[]>
- Defined in lib/routes/Guilds.ts:737

getGroup

getGroup(guildID, groupID): Promise<GuildGroup>
Get a guild group.
Parameters
- guildID: string
  ID of the guild.
- groupID: string
  ID of the group to get.
Returns Promise<GuildGroup>
- Defined in lib/routes/Guilds.ts:481

getGroups

getGroups(guildID): Promise<GuildGroup[]>
Get guild groups.
Parameters
- guildID: string
  ID of the guild.
Returns Promise<GuildGroup[]>
- Defined in lib/routes/Guilds.ts:469

getGuild

getGuild(guildID): Promise<Guild>
This method is used to get a specific Guild.

Note: Guild = Server
Parameters
- guildID: string
  The ID of the guild you'd like to get.
Returns Promise<Guild>
- Defined in lib/routes/Guilds.ts:87

getMember

getMember(guildID, memberID): Promise<Member>
This method is used to get a specific guild member.
Parameters
- guildID: string
  The ID of the Guild.
- memberID: string
  The ID of the Guild Member to get.
Returns Promise<Member>
- Defined in lib/routes/Guilds.ts:125

getMemberPermission

getMemberPermission(guildID, memberID): Promise<Permissions[]>
Get guild member permissions.
Parameters
- guildID: string
  ID of the guild.
- memberID: string
  ID of the member.
Returns Promise<Permissions[]>
- Defined in lib/routes/Guilds.ts:556

getMembers

getMembers(guildID): Promise<Member[]>
This method is used to get a list of guild member.
Parameters
- guildID: string
  ID of the guild to get members.
Returns Promise<Member[]>
- Defined in lib/routes/Guilds.ts:135

getRole

getRole(guildID, roleID): Promise<GuildRole>
Get a guild role.
Parameters
- guildID: string
  ID of the guild where the role is.
- roleID: number
  ID of the role to get.
Returns Promise<GuildRole>
- Defined in lib/routes/Guilds.ts:419

getRoles

getRoles(guildID): Promise<GuildRole[]>
Get every guild roles from a guild.
Parameters
- guildID: string
  ID of the guild where roles are.
Returns Promise<GuildRole[]>
- Defined in lib/routes/Guilds.ts:407

getSubscription

getSubscription(guildID, subscriptionID): Promise<GuildSubscription>
Get guild subscriptions.
Parameters
- guildID: string
  ID of the guild.
- subscriptionID: string
  ID of the subscription to get.
Returns Promise<GuildSubscription>
- Defined in lib/routes/Guilds.ts:544

getSubscriptions

getSubscriptions(guildID): Promise<GuildSubscription[]>
Get guild subscriptions.
Parameters
- guildID: string
  ID of the guild.
Returns Promise<GuildSubscription[]>
- Defined in lib/routes/Guilds.ts:532

getWebhook

getWebhook(guildID, webhookID): Promise<Webhook>
This method is used to get a specific webhook.
Parameters
- guildID: string
  ID of a guild.
- webhookID: string
  ID of a webhook.
Returns Promise<Webhook>
- Defined in lib/routes/Guilds.ts:98

getWebhooks

getWebhooks(guildID, channelID): Promise<Webhook[]>
This method is used to get a list of Webhook.
Parameters
- guildID: string
  ID of a guild.
- channelID: string
  ID of a channel.
Returns Promise<Webhook[]>
- Defined in lib/routes/Guilds.ts:109

memberAddGroup

memberAddGroup(groupID, memberID): Promise<void>
Add a member to a group
Parameters
- groupID: string
  ID of a guild group.
- memberID: string
  ID of a member.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:167

memberAddRole

memberAddRole(guildID, memberID, roleID): Promise<void>
Add a role to a member
Parameters
- guildID: string
  ID of a guild.
- memberID: string
  ID of a member.
- roleID: number
  ID of a role.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:190

memberRemoveGroup

memberRemoveGroup(groupID, memberID): Promise<void>
Remove a member from a group
Parameters
- groupID: string
  ID of a guild group.
- memberID: string
  ID of a member.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:178

memberRemoveRole

memberRemoveRole(guildID, memberID, roleID): Promise<void>
Remove a role from a member
Parameters
- guildID: string
  ID of a guild.
- memberID: string
  ID of a member.
- roleID: number
  ID of a role.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:202

removeBan

removeBan(guildID, memberID): Promise<void>
Unban a guild member.
Parameters
- guildID: string
  ID of the guild the member was in.
- memberID: string
  ID of the member to unban.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:259

removeMember

removeMember(guildID, memberID): Promise<void>
Remove a member from a guild.
Parameters
- guildID: string
  The ID of the guild the member is in.
- memberID: string
  The ID of the member to kick.
Returns Promise<void>
- Defined in lib/routes/Guilds.ts:235

setMemberXP

setMemberXP(guildID, memberID, amount): Promise<number>
Set a member's xp using the built-in EXP system.
Parameters
- guildID: string
  ID of a guild.
- memberID: string
  ID of a member.
- amount: number
  Total amount of experience.
Returns Promise<number>
- Defined in lib/routes/Guilds.ts:326

Class Guilds

Index

Constructors

Methods

Constructors

constructor

Parameters

manager: RESTManager

Returns Guilds

Methods

awardMember

Parameters

guildID: string

memberID: string

amount: number

Returns Promise<number>

awardRole

Parameters

guildID: string

roleID: number

amount: number

Returns Promise<void>

bulkAwardXP

Parameters

guildID: string

options: POSTBulkAwardXPBody

Returns Promise<POSTBulkAwardXPResponse>

bulkSetXP

Parameters

guildID: string

options: PUTBulkSetXPBody

Returns Promise<PUTBulkSetXPResponse>

createBan

Parameters

guildID: string

memberID: string

Optional reason: string

Returns Promise<BannedMember>

createCategory

Parameters

guildID: string

options: POSTCreateCategoryBody

Returns Promise<GuildCategory>

createCategoryPermission

Parameters

guildID: string

categoryID: number

targetID: string | number

options: POSTChannelCategoryUserPermissionBody

Returns Promise<Permission>

createChannel

Type Parameters

T extends AnyChannel = AnyChannel

Parameters

guildID: string

name: string

type: APIChannelCategories

Optional options: CreateChannelOptions

Returns Promise<T>

createGroup

Parameters

guildID: string

options: POSTGuildGroupBody

Returns Promise<GuildGroup>

createRole

Parameters

guildID: string

options: POSTGuildRoleBody

Returns Promise<GuildRole>

createWebhook

Parameters

guildID: string

channelID: string

name: string

Returns Promise<Webhook>

deleteCategory

Parameters

guildID: string

categoryID: number

Returns Promise<GuildCategory>

`Optional` reason: string

`Optional` options: CreateChannelOptions