Class UsersManager

Manages API operations related to Users. Allows for creating, fetching, and updating user profiles.

Hierarchy (View Summary)

BaseManager
- UsersManager

Index

Constructors

Properties

Methods

create getByDiscordId getById getByIgn updateDiscordId updateIgn

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

create

create(dto: CreateUserDto): Promise<UserEntity>
Creates a new user profile in the database.
Parameters
- dto: CreateUserDto
  The data required to create a user.
Returns Promise<UserEntity>
A promise resolving to the newly created UserEntity.
Example
```
const newUser = await client.users.create({
 discordId: '466861191931756544',
 ign: 'andrew0w0'
});
```
- Defined in packages/sdk/src/managers/users/users.manager.ts:24

getByDiscordId

getByDiscordId(discordId: string): Promise<UserEntity>
Retrieves a user by their Discord snowflake ID.
Parameters
- discordId: string
  The Discord account ID.
Returns Promise<UserEntity>
A promise resolving to the UserEntity.
- Defined in packages/sdk/src/managers/users/users.manager.ts:58

getById

getById(id: number): Promise<UserEntity>
Retrieves a user by their internal database ID.
Parameters
- id: number
  The numeric ID of the user.
Returns Promise<UserEntity>
A promise resolving to the UserEntity.
Example
```
const user = await client.users.getById(1);
```
- Defined in packages/sdk/src/managers/users/users.manager.ts:38

getByIgn

getByIgn(ign: string): Promise<UserEntity>
Retrieves a user by their In-Game Name (IGN).
Parameters
- ign: string
  The exact Minecraft username.
Returns Promise<UserEntity>
A promise resolving to the UserEntity.
- Defined in packages/sdk/src/managers/users/users.manager.ts:48

updateDiscordId

updateDiscordId(id: number, dto: UpdateDiscordIdDto): Promise<UserEntity>
Direct API call to update a user's Discord ID. Note: If you already have a UserEntity, you can use user.updateDiscordId() instead.
Parameters
- id: number
  The numeric ID of the user.
- dto: UpdateDiscordIdDto
  The update payload.
Returns Promise<UserEntity>
A promise resolving to the updated UserEntity.
- Defined in packages/sdk/src/managers/users/users.manager.ts:82

updateIgn

updateIgn(id: number, dto: UpdateIgnDto): Promise<UserEntity>
Direct API call to update a user's IGN. Note: If you already have a UserEntity, you can use user.updateIgn() instead.
Parameters
- id: number
  The numeric ID of the user.
- dto: UpdateIgnDto
  The update payload.
Returns Promise<UserEntity>
A promise resolving to the updated UserEntity.
- Defined in packages/sdk/src/managers/users/users.manager.ts:70