Class PunishmentsManager

Manages API operations related to User Punishments (Bans and Strikes).

Hierarchy (View Summary)

BaseManager
- PunishmentsManager

Index

Constructors

constructor

new PunishmentsManager(client: RankedClient): PunishmentsManager
Parameters
- client: RankedClient
Returns PunishmentsManager
Inherited from BaseManager.constructor
- Defined in packages/sdk/src/managers/base.manager.ts:11

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

addStrike

addStrike(userId: number, dto: AddStrikeDto): Promise<StrikeEntity>
Adds a new strike to a user. If the strike threshold is reached, this will automatically trigger a ban on the backend.
Parameters
- userId: number
  The internal database ID of the user.
- dto: AddStrikeDto
  The payload containing strike details.
Returns Promise<StrikeEntity>
A promise resolving to the newly created StrikeEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:91

banUser

banUser(userId: number, dto: BanUserDto): Promise<BanEntity>
Issues a new ban to a user. If the user already has an active ban, it will be replaced.
Parameters
- userId: number
  The internal database ID of the user to ban.
- dto: BanUserDto
  The payload containing ban details (reason, staffer, expiration).
Returns Promise<BanEntity>
A promise resolving to the newly created BanEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:57

clearAllStrikes

clearAllStrikes(userId: number): Promise<{ message: string }>
Clears all active strikes for a specific user.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<{ message: string }>
A promise resolving to an object containing the success message.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:115

getActiveBan

getActiveBan(userId: number): Promise<BanEntity | null>
Retrieves the currently active ban for a specific user, if any. Throws an error if the user is not currently banned.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<BanEntity | null>
A promise resolving to the BanEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:28

getActiveStrikes

getActiveStrikes(userId: number): Promise<StrikeEntity[]>
Retrieves all active strikes for a specific user.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<StrikeEntity[]>
A promise resolving to an array of StrikeEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:80

getBanById

getBanById(banId: number): Promise<BanEntity>
Retrieves a specific ban by its ID.
Parameters
- banId: number
  The unique ID of the ban.
Returns Promise<BanEntity>
A promise resolving to the BanEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:17

getBanHistory

getBanHistory(userId: number): Promise<BanEntity[]>
Retrieves the entire ban history for a specific user.
Parameters
- userId: number
  The internal database ID of the user.
Returns Promise<BanEntity[]>
A promise resolving to an array of BanEntity.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:46

removeStrike

removeStrike(
strikeId: number,
dto: RemoveStrikeDto,
): Promise<{ message: string }>
Removes a specific strike manually.
Parameters
- strikeId: number
  The unique ID of the strike to remove.
- dto: RemoveStrikeDto
  The payload containing removal details.
Returns Promise<{ message: string }>
A promise resolving to an object containing the success message.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:102

unbanUser

unbanUser(userId: number, dto: UnbanUserDto): Promise<void>
Lifts an active ban from a user.
Parameters
- userId: number
  The internal database ID of the user to unban.
- dto: UnbanUserDto
  The payload containing unban details.
Returns Promise<void>
A promise resolving when the unban is successful.
- Defined in packages/sdk/src/managers/punishments/punishments.manager.ts:68

Class PunishmentsManager

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PunishmentsManager

Properties

Protected Readonlyclient

Methods

addStrike

Parameters

Returns Promise<StrikeEntity>

banUser

Parameters

Returns Promise<BanEntity>

clearAllStrikes

Parameters

Returns Promise<{ message: string }>

getActiveBan

Parameters

Returns Promise<BanEntity | null>

getActiveStrikes

Parameters

Returns Promise<StrikeEntity[]>

getBanById

Parameters

Returns Promise<BanEntity>

getBanHistory

Parameters

Returns Promise<BanEntity[]>

removeStrike

Parameters

Returns Promise<{ message: string }>

unbanUser

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`client