Class Guilds

Constructors

constructor

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

Methods

awardMember

awardMember(guildID: string, memberID: string, amount: number): 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:85

awardRole

awardRole(guildID: string, roleID: number, amount: number): Promise<void>
Award every member 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:99

bulkAwardXP

bulkAwardXP(
guildID: string,
options: BulkXPOptions,
): Promise<{ totalsByUserId: { [key: string]: number } }>
Bulk Award XP Members
Parameters
- guildID: string
  ID of the guild
- options: BulkXPOptions
  Members to award XP
Returns Promise<{ totalsByUserId: { [key: string]: number } }>
- Defined in lib/routes/Guilds.ts:113

bulkSetXP

bulkSetXP(
guildID: string,
options: BulkXPOptions,
): Promise<{ totalsByUserId: { [key: string]: number } }>
Bulk set XP Members
Parameters
- guildID: string
  ID of the guild
- options: BulkXPOptions
  Members to set XP
Returns Promise<{ totalsByUserId: { [key: string]: number } }>
- Defined in lib/routes/Guilds.ts:125

createBan

createBan(
    guildID: string,
    memberID: string,
    reason?: string,
): 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.
- Optionalreason: string
  The reason of the ban.
Returns Promise<BannedMember>
- Defined in lib/routes/Guilds.ts:137

createCategory

createCategory(
guildID: string,
options: { groupId?: string; name: string },
): Promise<Category>
Create a guild category.
Parameters
- guildID: string
  ID of the guild to create a category in.
- options: { groupId?: string; name: string }
  Options to create a category.
  - OptionalgroupId?: string
    Group ID
    
    Description
    The ID of the group. If not provided, the category will be created in the "Server home" group from serverId.
  - name: string
    Description
    Name of the category
Returns Promise<Category>
- Defined in lib/routes/Guilds.ts:153

createCategoryPermission

createCategoryPermission(
    guildID: string,
    categoryID: number,
    targetID: string | number,
    options: { permissions: Record<string, never> },
): 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: { permissions: Record<string, never> }
  Permission options
  
  Warning: targetID must have the correct type (number=role, string=user).
  - permissions: Record<string, never>
    Description
    A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type
Returns Promise<Permission>
- Defined in lib/routes/Guilds.ts:169

createChannel

createChannel<T extends AnyChannel = AnyChannel>(
    guildID: string,
    name: string,
    type: APIChannelCategories,
    options?: CreateChannelOptions,
): 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)
- Optionaloptions: CreateChannelOptions
  New channel's additional options.
Returns Promise<T>
- Defined in lib/routes/Guilds.ts:193

createGroup

createGroup(
    guildID: string,
    options: {
        description?: string;
        emoteId?: number;
        isPublic?: boolean;
        name: string;
    },
): Promise<Group>
Create a guild group.
Parameters
- guildID: string
  The ID of the guild to create a group in.
- options: { description?: string; emoteId?: number; isPublic?: boolean; name: string }
  Create options
  - Optionaldescription?: string
    Description
    
    Description
    The description associated with the group
  - OptionalemoteId?: number
    Description
    The emote to associate with the group
  - OptionalisPublic?: boolean
    Is public
    
    Description
    Is this group open for anyone to join?
    
    Default
    false
  - name: string
    Description
    The name of the group
Returns Promise<Group>
- Defined in lib/routes/Guilds.ts:226

createRole

createRole(
    guildID: string,
    options: {
        colors?: number[];
        isDisplayedSeparately?: boolean;
        isMentionable?: boolean;
        isSelfAssignable?: boolean;
        name: string;
        permissions: string[];
    },
): Promise<Role>
Create a guild role.
Parameters
- guildID: string
  ID of the server you want to create the role in.
- options: {
      colors?: number[];
      isDisplayedSeparately?: boolean;
      isMentionable?: boolean;
      isSelfAssignable?: boolean;
      name: string;
      permissions: string[];
  }
  Create options
  - Optionalcolors?: number[]
    Description
    An array of integer values corresponding to the decimal RGB representation for a color. The first color is solid, and a second color indicates a gradient
  - OptionalisDisplayedSeparately?: boolean
    Display Separately
    
    Description
    If set, the role will be displayed separately in the channel member list
    
    Default
    false
  - OptionalisMentionable?: boolean
    Mentionable
    
    Description
    If set, this role can be mentioned
    
    Default
    false
  - OptionalisSelfAssignable?: boolean
    Self Assignable
    
    Description
    If set, this roll will be self assigned
    
    Default
    false
  - name: string
    Role name
    
    Description
    The role's name
  - permissions: string[]
    Description
    Permissions must be a collection of valid permissions as defined in the Enums/Permissions section
Returns Promise<Role>
- Defined in lib/routes/Guilds.ts:238

deleteCategory

deleteCategory(guildID: string, categoryID: number): Promise<Category>
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<Category>
- Defined in lib/routes/Guilds.ts:250

deleteCategoryPermission

deleteCategoryPermission(
    guildID: string,
    categoryID: number,
    targetID: string | number,
): 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:262

deleteGroup

deleteGroup(guildID: string, groupID: string): 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:282

deleteRole

deleteRole(guildID: string, roleID: number): 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:293

editCategory

editCategory(
    guildID: string,
    categoryID: number,
    options: { name?: string; priority?: number },
): Promise<Category>
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: { name?: string; priority?: number }
  Options to update a category.
  - Optionalname?: string
    Description
    Name of the category
  - Optionalpriority?: number
    Priority
    
    Description
    The priority of the category will determine its position relative to other categories in the group. The higher the value, the higher up it will be displayed in the UI. Returned values can be null, in which case sorting will be done by createdAt in descending order. Due to legacy issues, sending a null value is not possible
Returns Promise<Category>
- Defined in lib/routes/Guilds.ts:305

editCategoryPermission

editCategoryPermission(
    guildID: string,
    categoryID: number,
    targetID: string | number,
    options: { permissions: Record<string, never> },
): 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: { permissions: Record<string, never> }
  Edit options
  
  Warning: targetID must have the correct type (number=role, string=user).
  - permissions: Record<string, never>
    Description
    A JSON object of Enums/Permissions with true, false or null values. Permission list can only contain relevant permissions for the channel type
Returns Promise<Permission>
- Defined in lib/routes/Guilds.ts:321

editGroup

editGroup(
    guildID: string,
    groupID: string,
    options: {
        description?: string;
        emoteId?: number;
        isPublic?: boolean;
        name?: string;
    },
): Promise<Group>
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: { description?: string; emoteId?: number; isPublic?: boolean; name?: string }
  Edit options
  - Optionaldescription?: string
    Description
    
    Description
    The description associated with the group Note - this property cannot be modified on a home group
  - OptionalemoteId?: number
    Description
    The emote to associate with the group
  - OptionalisPublic?: boolean
    Is public
    
    Description
    Is this group open for anyone to join? Note - this property cannot be modified on a home group
  - Optionalname?: string
    Description
    The name of the group
Returns Promise<Group>
- Defined in lib/routes/Guilds.ts:345

editMember

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

editRole

editRole(
    guildID: string,
    roleID: number,
    options: {
        colors?: number[];
        isDisplayedSeparately?: boolean;
        isMentionable?: boolean;
        isSelfAssignable?: boolean;
        name?: string;
        permissions?: string[];
        priority?: number;
    },
): Promise<Role>
Edit a guild role.
Parameters
- guildID: string
  ID of the server
- roleID: number
  ID of the role to edit
- options: {
      colors?: number[];
      isDisplayedSeparately?: boolean;
      isMentionable?: boolean;
      isSelfAssignable?: boolean;
      name?: string;
      permissions?: string[];
      priority?: number;
  }
  Edit options
  - Optionalcolors?: number[]
    Description
    An array of integer values corresponding to the decimal RGB representation for a color. The first color is solid, and a second color indicates a gradient
  - OptionalisDisplayedSeparately?: boolean
    Display Separately
    
    Description
    If set, the role will be displayed separately in the channel member list
  - OptionalisMentionable?: boolean
    Mentionable
    
    Description
    If set, this role can be mentioned
  - OptionalisSelfAssignable?: boolean
    Self Assignable
    
    Description
    If set, this roll will be self assigned
  - Optionalname?: string
    Role name
    
    Description
    The role's name
  - Optionalpermissions?: string[]
    Description
    Permissions must be a collection of valid permissions as defined in the Enums/Permissions section
  - Optionalpriority?: number
    Priority
    
    Description
    The priority the role will be in relation to other roles in the server. The higher the value, the more precedence the role has over lower priority roles, and the higher up it will be displayed in the UI. Values can be zero or negative!
Returns Promise<Role>
- Defined in lib/routes/Guilds.ts:381

editRolePermission

editRolePermission(
    guildID: string,
    roleID: number,
    options: { permissions: Record<string, never> },
): Promise<Role>
Edit role permission.
Parameters
- guildID: string
  ID of the guild.
- roleID: number
  ID of the role.
- options: { permissions: Record<string, never> }
  Permission to edit.
  - permissions: Record<string, never>
    Description
    A JSON object of Enums/Permissions with true or false values.
Returns Promise<Role>
- Defined in lib/routes/Guilds.ts:394

get

get(guildID: string): 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:406

getBan

getBan(guildID: string, memberID: string): 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:416

getBans

getBans(guildID: string): 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:433

getCategory

getCategory(guildID: string, categoryID: number): Promise<Category>
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<Category>
- Defined in lib/routes/Guilds.ts:454

getCategoryPermission

getCategoryPermission(
    guildID: string,
    categoryID: number,
    targetID: string | number,
): 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:468

getCategoryPermissions

getCategoryPermissions(
guildID: string,
categoryID: number,
): 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:484

getCategoryRolePermissions

getCategoryRolePermissions(
guildID: string,
categoryID: number,
): 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:499

getCategoryUserPermissions

getCategoryUserPermissions(
guildID: string,
categoryID: number,
): 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:514

getGroup

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

getGroups

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

getMember

getMember(guildID: string, memberID: string): 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:555

getMemberPermission

getMemberPermission(guildID: string, memberID: string): 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:570

getMemberRoles

getMemberRoles(guildID: string, memberID: string): Promise<number[]>
Get a list of role IDs of a specific member within a guild.
Parameters
- guildID: string
  ID of the guild the member is in.
- memberID: string
  ID of the member to get roles from.
Returns Promise<number[]>
- Defined in lib/routes/Guilds.ts:583

getMembers

getMembers(guildID: string): 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:594

getRole

getRole(guildID: string, roleID: number): Promise<Role>
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<Role>
- Defined in lib/routes/Guilds.ts:615

getRoles

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

getSubscription

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

getSubscriptions

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

memberAddGroup

memberAddGroup(groupID: string, memberID: string): 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:670

memberAddRole

memberAddRole(guildID: string, memberID: string, roleID: number): 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:683

memberRemoveGroup

memberRemoveGroup(groupID: string, memberID: string): 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:695

memberRemoveRole

memberRemoveRole(
    guildID: string,
    memberID: string,
    roleID: number,
): 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:708

removeBan

removeBan(guildID: string, memberID: string): 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:720

removeMember

removeMember(guildID: string, memberID: string): 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:732

setMemberXP

setMemberXP(guildID: string, memberID: string, amount: number): 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:745

Class Guilds

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Guilds

Methods

awardMember

Parameters

Returns Promise<number>

awardRole

Parameters

Returns Promise<void>

bulkAwardXP

Parameters

Returns Promise<{ totalsByUserId: { [key: string]: number } }>

bulkSetXP

Parameters

Returns Promise<{ totalsByUserId: { [key: string]: number } }>

createBan

Parameters

Returns Promise<BannedMember>

createCategory

Parameters

OptionalgroupId?: string

Description

name: string

Description

Returns Promise<Category>

createCategoryPermission

Parameters

permissions: Record<string, never>

Description

Returns Promise<Permission>

createChannel

Type Parameters

Parameters

Returns Promise<T>

createGroup

Parameters

Optionaldescription?: string

Description

OptionalemoteId?: number

Description

OptionalisPublic?: boolean

Description

Default

name: string

Description

Returns Promise<Group>

createRole

Parameters

Optionalcolors?: number[]

Description

OptionalisDisplayedSeparately?: boolean

Description

Default

OptionalisMentionable?: boolean

Description

Default

OptionalisSelfAssignable?: boolean

Description

Default

name: string

Description

permissions: string[]

Description

Returns Promise<Role>

deleteCategory

Parameters

Returns Promise<Category>

deleteCategoryPermission

Parameters

Returns Promise<void>

deleteGroup

Parameters

Returns Promise<void>

deleteRole

`Optional`groupId?: string

`Optional`description?: string

`Optional`emoteId?: number

`Optional`isPublic?: boolean

`Optional`colors?: number[]

`Optional`isDisplayedSeparately?: boolean

`Optional`isMentionable?: boolean

`Optional`isSelfAssignable?: boolean

`Optional`name?: string

`Optional`priority?: number

`Optional`description?: string

`Optional`emoteId?: number

`Optional`isPublic?: boolean

`Optional`name?: string

`Optional`colors?: number[]

`Optional`isDisplayedSeparately?: boolean

`Optional`isMentionable?: boolean

`Optional`isSelfAssignable?: boolean

`Optional`name?: string

`Optional`permissions?: string[]

`Optional`priority?: number