Class UserEntity

constructor

• new UserEntity(client: RankedClient, data: User): UserEntity

  Instantiates a new UserEntity.

  Parameters

  • client: RankedClient

    The active SDK client instance.

  • data: User

    The raw user data from the API.

  Returns UserEntity

discordId

id

ign

partyId

registeredAt

updatedAt

addNote

• addNote(content: string, stafferId: string): Promise<NoteEntity>

  Adds a new note to this user's profile.

  Parameters

  • content: string

    The content of the note to add.

  • stafferId: string

    The Discord ID of the staff member adding the note.

  Returns Promise<NoteEntity>

  A promise resolving to the newly created NoteEntity.

ban

• ban(dto: BanUserDto): Promise<BanEntity>

  Bans the user with the specified details.

  Parameters

  • dto: BanUserDto

    The details of the ban, including reason, duration, and staffer information.

  Returns Promise<BanEntity>

  A promise resolving to the newly created BanEntity.

  Example

  await user.ban({ reason: 'Violation of rules', bannedBy: 'stafferId' });
  Copy

clearStrikes

• clearStrikes(): Promise<number>

  Clears all active strikes for this user.

  Returns Promise<number>

  A promise resolving to the number of strikes that were cleared.

createParty

• createParty(): Promise<PartyEntity>

  Creates a new party with this user as the leader.

  Returns Promise<PartyEntity>

  A promise resolving to the newly created PartyEntity.

getActiveStrikes

• getActiveStrikes(): Promise<StrikeEntity[]>

  Retrieves all active strikes for this user.

  Returns Promise<StrikeEntity[]>

  A promise resolving to an array of StrikeEntity representing the user's active strikes.

getBanHistory

• getBanHistory(): Promise<BanEntity[]>

  Retrieves the user's entire ban history.

  Returns Promise<BanEntity[]>

  A promise resolving to an array of BanEntity.

getCurrentStats

• getCurrentStats(rankedSystemId: string): Promise<StatisticsEntity>

  Fetches the user's statistics for the currently active season of a specific ranked system.

  Parameters

  • rankedSystemId: string

    The system uuid (e.g., '123e4567-e89b-12d3-a456-426614174000').

  Returns Promise<StatisticsEntity>

  A promise resolving to a StatisticsEntity.

getFullHistory

• getFullHistory(): Promise<
      { bans: BanEntity[]; notes: NoteEntity[]; strikes: StrikeEntity[] },
  >

  Returns Promise<{ bans: BanEntity[]; notes: NoteEntity[]; strikes: StrikeEntity[] }>

getGamesHistory

• getGamesHistory(limit?: number): Promise<GameEntity[]>

  Fetches the user's recent game history.

  Parameters

  • limit: number = 10

    The maximum number of recent games to retrieve (default is 10).

  Returns Promise<GameEntity[]>

  A promise resolving to an array of GameEntity representing the user's recent games.

getNotes

• getNotes(): Promise<NoteEntity[]>

  Fetches all notes associated with this user.

  Returns Promise<NoteEntity[]>

  A promise resolving to an array of NoteEntity representing the user's notes.

getParty

• getParty(): Promise<PartyEntity | null>

  Fetches the party this user currently belongs to.

  Returns Promise<PartyEntity | null>

  A promise resolving to the PartyEntity, or null if the user is solo.

getRank

• getRank(rankedSystemId: string): Promise<RankEntity>

  Fetches the user's current rank for a specific ranked system based on their ELO.

  Parameters

  • rankedSystemId: string

    The system uuid (e.g., '123e4567-e89b-12d3-a456-426614174000').

  Returns Promise<RankEntity>

  A promise resolving to a RankEntity representing the user's current rank.

getStatistics

• getStatistics(seasonId: string): Promise<StatisticsEntity>

  Fetches the user's statistics for a specific competitive season.

  Parameters

  • seasonId: string

    The uuid of the season.

  Returns Promise<StatisticsEntity>

  A promise resolving to a StatisticsEntity.

getStrikesHistory

• getStrikesHistory(): Promise<StrikeEntity[]>

  Retrieves the user's strike history, including both active and removed strikes.

  Returns Promise<StrikeEntity[]>

  A promise resolving to an array of StrikeEntity representing the user's strike history.

grantPermission

• grantPermission(node: string): Promise<UserPermissionEntity>

  Grants a permission node directly to this user (bypassing roles).

  Parameters

  • node: string

    The permission node to grant.

  Returns Promise<UserPermissionEntity>

  A promise resolving to the updated UserPermissionEntity.

  Example

  await user.grantPermission('system.bypass.cooldown');
  Copy

hasPermission

• hasPermission(node: string, activeRoles?: string[]): Promise<boolean>

  Checks if the user has the specified permission.

  Parameters

  • node: string

    The permission node to check.

  • OptionalactiveRoles: string[]

    The roles to consider for permission checking.

  Returns Promise<boolean>

  A promise resolving to true if the user has the permission, or false otherwise.

  Example

  const canBan = await user.hasPermission('command.admin.ban');
  if (!canBan) return 'Access Denied';
  Copy

isBanned

• isBanned(): Promise<boolean>

  Checks if the user currently has an active ban.

  Returns Promise<boolean>

  A promise resolving to true if the user is currently banned, or false otherwise.

  Example

  const isBanned = await user.isBanned();
  console.log(isBanned); // true or false
  Copy

revokePermission

• revokePermission(node: string): Promise<UserPermissionEntity>

  Revokes a specific permission node directly from this user.

  Parameters

  • node: string

    The permission node to revoke.

  Returns Promise<UserPermissionEntity>

  A promise resolving to the updated UserPermissionEntity.

strike

• strike(dto: AddStrikeDto): Promise<StrikeEntity>

  Issues a strike to this user.

  Parameters

  • dto: AddStrikeDto

    The strike details.

  Returns Promise<StrikeEntity>

  A promise resolving to the newly created StrikeEntity.

unban

• unban(dto: UnbanUserDto): Promise<BanEntity>

  Lifts an active ban from this user.

  Parameters

  • dto: UnbanUserDto

    The unban details.

  Returns Promise<BanEntity>

  A promise resolving to the updated BanEntity.

unstrike

• unstrike(strikeId: number, dto: RemoveStrikeDto): Promise<StrikeEntity>

  Removes a specific strike from this user.

  Parameters

  • strikeId: number

    The unique ID of the strike to remove.

  • dto: RemoveStrikeDto

    The details of the strike removal.

  Returns Promise<StrikeEntity>

  A promise resolving to the updated StrikeEntity.

updateDiscordId

• updateDiscordId(newDiscordId: string): Promise<UserEntity>

  Updates the user's linked Discord ID.

  Parameters

  • newDiscordId: string

    The new Discord snowflake ID.

  Returns Promise<UserEntity>

  A promise resolving to the updated UserEntity instance.

  Example

  await user.updateDiscordId('466861191931756544');
  console.log(user.discordId); // '466861191931756544'
  Copy

updateIgn

• updateIgn(newIgn: string): Promise<UserEntity>

  Updates the user's In-Game Name (IGN) and syncs the entity with the backend.

  Parameters

  • newIgn: string

    The new Minecraft name.

  Returns Promise<UserEntity>

  A promise resolving to the updated UserEntity instance.

  Example

  await user.updateIgn('andrew0w0');
  console.log(user.ign); // 'andrew0w0'
  Copy