Class RankedSystemsManager

Manages API operations related to Ranked Systems and their Seasons.

Hierarchy (View Summary)

BaseManager
- RankedSystemsManager

Index

Constructors

Properties

Methods

create getAll getById getCurrentSeason getMain remove startSeason update

Constructors

constructor

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

Properties

`Protected` `Readonly`client

client: RankedClient

Methods

create

create(dto: CreateRankedSystemDto): Promise<RankedSystemEntity>
Creates a new Ranked System.
Parameters
- dto: CreateRankedSystemDto
  The configuration for the new system.
Returns Promise<RankedSystemEntity>
A promise resolving to the new RankedSystemEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:17

getAll

getAll(): Promise<RankedSystemEntity[]>
Retrieves all configured Ranked Systems.

Returns Promise<RankedSystemEntity[]>
A promise resolving to an array of RankedSystemEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:26

getById

getById(id: string): Promise<RankedSystemEntity>
Retrieves a specific Ranked System by its ID.
Parameters
- id: string
  The unique ID of the ranked system.
Returns Promise<RankedSystemEntity>
A promise resolving to the RankedSystemEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:36

getCurrentSeason

getCurrentSeason(rankedSystemId: string): Promise<SeasonEntity>
Retrieves the currently active season for a Ranked System.
Parameters
- rankedSystemId: string
  The ID of the ranked system.
Returns Promise<SeasonEntity>
A promise resolving to the active SeasonEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:97

getMain

getMain(): Promise<RankedSystemEntity>
Retrieves the main Ranked System, which is used as the default for new users and seasons.

Returns Promise<RankedSystemEntity>
A promise resolving to the main RankedSystemEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:45

remove

remove(id: string): Promise<void>
Soft deletes a Ranked System.
Parameters
- id: string
  The ID of the ranked system to delete.
Returns Promise<void>
A promise resolving when the deletion is successful.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:67

startSeason

startSeason(rankedSystemId: string, name: string): Promise<SeasonEntity>
Starts a new season for a specific Ranked System.
Parameters
- rankedSystemId: string
  The ID of the parent ranked system.
- name: string
  The name of the new season.
Returns Promise<SeasonEntity>
A promise resolving to the new SeasonEntity.
Example
```
 const newSeason = await client.rankedSystems.startSeason('system-123', 'Winter 2024');
 console.log(`Started: ${newSeason.name}`);
```
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:86

update

update(id: string, dto: UpdateRankedSystemDto): Promise<RankedSystemEntity>
Updates a Ranked System. Note: You can also use system.update() if you already have the entity.
Parameters
- id: string
  The ID of the ranked system.
- dto: UpdateRankedSystemDto
  The fields to update.
Returns Promise<RankedSystemEntity>
A promise resolving to the updated RankedSystemEntity.
- Defined in packages/sdk/src/managers/ranked/ranked.manager.ts:57