Class RankedSystemEntity

constructor

• new RankedSystemEntity(
      client: RankedClient,
      data: RankedSystem,
  ): RankedSystemEntity

  Instantiates a new RankedSystemEntity.

  Parameters

  • client: RankedClient

    The active SDK client instance.

  • data: RankedSystem

    The raw ranked system data from the API.

  Returns RankedSystemEntity

displayname

id

main

delete

• delete(): Promise<void>

  Soft deletes this ranked system and cascades the deletion to its seasons, ranks, and queues.

  Returns Promise<void>

  A promise resolving when the deletion is complete.

getCurrentSeason

• getCurrentSeason(): Promise<SeasonEntity>

  Fetches the currently active season for this ranked system.

  Returns Promise<SeasonEntity>

  A promise resolving to the active SeasonEntity.

startNewSeason

• startNewSeason(name: string): Promise<SeasonEntity>

  Starts a new season for this ranked system. Automatically ends any currently active season.

  Parameters

  • name: string

    The name of the new season (e.g., 'Season 2').

  Returns Promise<SeasonEntity>

  A promise resolving to the newly created SeasonEntity.

update

• update(dto: UpdateRankedSystemDto): Promise<RankedSystemEntity>

  Updates this ranked system's configuration.

  Parameters

  • dto: UpdateRankedSystemDto

    The fields to update.

  Returns Promise<RankedSystemEntity>

  A promise resolving to the updated RankedSystemEntity.