@wise-old-man/utils 2.0.0-beta.1 → 2.0.0-beta.2

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export type Achievement$1 = {
+export type Prisma_Base_Achievement = {
   playerId: number
   name: string
   metric: Metric
@@ -22,7 +22,7 @@ export type Competition = {
 }
 
 
-export type Delta$1 = {
+export type Prisma_Base_Delta = {
   id: number
   playerId: number
   period: Period
@@ -93,6 +93,8 @@ export type Delta$1 = {
   theatre_of_blood: number
   theatre_of_blood_hard_mode: number
   thermonuclear_smoke_devil: number
+  tombs_of_amascut: number
+  tombs_of_amascut_expert: number
   tzkal_zuk: number
   tztok_jad: number
   venenatis: number
@@ -166,7 +168,7 @@ export type Participation = {
 }
 
 
-export type Player$1 = {
+export type Prisma_Base_Player = {
   id: number
   username: string
   displayName: string
@@ -186,7 +188,7 @@ export type Player$1 = {
 }
 
 
-export type Record$1 = {
+export type Prisma_Base_Record = {
   id: number
   playerId: number
   period: Period
@@ -196,7 +198,7 @@ export type Record$1 = {
 }
 
 
-export type Snapshot$1 = {
+export type Prisma_Base_Snapshot = {
   id: number
   playerId: number
   importedAt: Date | null
@@ -345,6 +347,10 @@ export type Snapshot$1 = {
   theatre_of_bloodKills: number
   thermonuclear_smoke_devilRank: number
   thermonuclear_smoke_devilKills: number
+  tombs_of_amascutRank: number
+  tombs_of_amascutKills: number
+  tombs_of_amascut_expertRank: number
+  tombs_of_amascut_expertKills: number
   tzkal_zukRank: number
   tzkal_zukKills: number
   tztok_jadRank: number
@@ -509,6 +515,8 @@ declare const Boss: {
     readonly THEATRE_OF_BLOOD: "theatre_of_blood";
     readonly THEATRE_OF_BLOOD_HARD_MODE: "theatre_of_blood_hard_mode";
     readonly THERMONUCLEAR_SMOKE_DEVIL: "thermonuclear_smoke_devil";
+    readonly TOMBS_OF_AMASCUT: "tombs_of_amascut";
+    readonly TOMBS_OF_AMASCUT_EXPERT: "tombs_of_amascut_expert";
     readonly TZKAL_ZUK: "tzkal_zuk";
     readonly TZTOK_JAD: "tztok_jad";
     readonly VENENATIS: "venenatis";
@@ -567,6 +575,8 @@ declare const Metric: {
     readonly THEATRE_OF_BLOOD: "theatre_of_blood";
     readonly THEATRE_OF_BLOOD_HARD_MODE: "theatre_of_blood_hard_mode";
     readonly THERMONUCLEAR_SMOKE_DEVIL: "thermonuclear_smoke_devil";
+    readonly TOMBS_OF_AMASCUT: "tombs_of_amascut";
+    readonly TOMBS_OF_AMASCUT_EXPERT: "tombs_of_amascut_expert";
     readonly TZKAL_ZUK: "tzkal_zuk";
     readonly TZTOK_JAD: "tztok_jad";
     readonly VENENATIS: "venenatis";
@@ -1211,22 +1221,6 @@ declare function findCountry(countryIdentifier: string): CountryDetails | undefi
 declare function findCountryByName(countryName: string): CountryDetails | undefined;
 declare function findCountryByCode(countryCode: string): CountryDetails | undefined;
 
-declare type Achievement = Omit<Achievement$1, 'threshold'> & {
-    threshold: number;
-};
-declare type Record = Omit<Record$1, 'value'> & {
-    value: number;
-};
-declare type Delta = Omit<Delta$1, 'overall'> & {
-    overall: number;
-};
-declare type Snapshot = Omit<Snapshot$1, 'overallExperience'> & {
-    overallExperience: number;
-};
-declare type Player = Omit<Player$1, 'exp'> & {
-    exp: number;
-};
-
 declare const MAX_LEVEL = 99;
 declare const MAX_VIRTUAL_LEVEL = 126;
 declare const MAX_SKILL_EXP = 200000000;
@@ -1234,17 +1228,7 @@ declare const SKILL_EXP_AT_99 = 13034431;
 declare const CAPPED_MAX_TOTAL_XP: number;
 declare function getExpForLevel(level: number): number;
 declare function getLevel(exp: number, virtual?: boolean): number;
-declare function getCombatLevelFromExp(attack: number, strength: number, defence: number, ranged: number, magic: number, hitpoints: number, prayer: number): number;
-declare function getCombatLevel(snapshot: Snapshot): number;
-declare function get200msCount(snapshot: any): number;
-declare function getMinimumExp(snapshot: Snapshot): number;
-declare function getCappedExp(snapshot: Snapshot, max: number): number;
-declare function getTotalLevel(snapshot: Snapshot): number;
-declare function isF2p(snapshot: Snapshot): boolean;
-declare function isLvl3(snapshot: Snapshot): boolean;
-declare function is1Def(snapshot: Snapshot): boolean;
-declare function is10HP(snapshot: Snapshot): boolean;
-declare function isZerker(snapshot: Snapshot): boolean;
+declare function getCombatLevel(attack: number, strength: number, defence: number, ranged: number, magic: number, hitpoints: number, prayer: number): number;
 
 declare const GROUP_ROLES: ("magic" | "slayer" | "hunter" | "achiever" | "adamant" | "adept" | "administrator" | "admiral" | "adventurer" | "air" | "anchor" | "apothecary" | "archer" | "armadylean" | "artillery" | "artisan" | "asgarnian" | "assassin" | "assistant" | "astral" | "athlete" | "attacker" | "bandit" | "bandosian" | "barbarian" | "battlemage" | "beast" | "berserker" | "blisterwood" | "blood" | "blue" | "bob" | "body" | "brassican" | "brawler" | "brigadier" | "brigand" | "bronze" | "bruiser" | "bulwark" | "burglar" | "burnt" | "cadet" | "captain" | "carry" | "champion" | "chaos" | "cleric" | "collector" | "colonel" | "commander" | "competitor" | "completionist" | "constructor" | "cook" | "coordinator" | "corporal" | "cosmic" | "councillor" | "crafter" | "crew" | "crusader" | "cutpurse" | "death" | "defender" | "defiler" | "deputy_owner" | "destroyer" | "diamond" | "diseased" | "doctor" | "dogsbody" | "dragon" | "dragonstone" | "druid" | "duellist" | "earth" | "elite" | "emerald" | "enforcer" | "epic" | "executive" | "expert" | "explorer" | "farmer" | "feeder" | "fighter" | "fire" | "firemaker" | "firestarter" | "fisher" | "fletcher" | "forager" | "fremennik" | "gamer" | "gatherer" | "general" | "gnome_child" | "gnome_elder" | "goblin" | "gold" | "goon" | "green" | "grey" | "guardian" | "guthixian" | "harpoon" | "healer" | "hellcat" | "helper" | "herbologist" | "hero" | "holy" | "hoarder" | "ignitor" | "illusionist" | "imp" | "infantry" | "inquisitor" | "iron" | "jade" | "justiciar" | "kandarin" | "karamjan" | "kharidian" | "kitten" | "knight" | "labourer" | "law" | "leader" | "learner" | "legacy" | "legend" | "legionnaire" | "lieutenant" | "looter" | "lumberjack" | "magician" | "major" | "maple" | "marshal" | "master" | "maxed" | "mediator" | "medic" | "mentor" | "member" | "merchant" | "mind" | "miner" | "minion" | "misthalinian" | "mithril" | "moderator" | "monarch" | "morytanian" | "mystic" | "myth" | "natural" | "nature" | "necromancer" | "ninja" | "noble" | "novice" | "nurse" | "oak" | "officer" | "onyx" | "opal" | "oracle" | "orange" | "owner" | "page" | "paladin" | "pawn" | "pilgrim" | "pine" | "pink" | "prefect" | "priest" | "private" | "prodigy" | "proselyte" | "prospector" | "protector" | "pure" | "purple" | "pyromancer" | "quester" | "racer" | "raider" | "ranger" | "record_chaser" | "recruit" | "recruiter" | "red_topaz" | "red" | "rogue" | "ruby" | "rune" | "runecrafter" | "sage" | "sapphire" | "saradominist" | "saviour" | "scavenger" | "scholar" | "scourge" | "scout" | "scribe" | "seer" | "senator" | "sentry" | "serenist" | "sergeant" | "shaman" | "sheriff" | "short_green_guy" | "skiller" | "skulled" | "smiter" | "smith" | "smuggler" | "sniper" | "soul" | "specialist" | "speed_runner" | "spellcaster" | "squire" | "staff" | "steel" | "strider" | "striker" | "summoner" | "superior" | "supervisor" | "teacher" | "templar" | "therapist" | "thief" | "tirannian" | "trialist" | "trickster" | "tzkal" | "tztok" | "unholy" | "vagrant" | "vanguard" | "walker" | "wanderer" | "warden" | "warlock" | "warrior" | "water" | "wild" | "willow" | "wily" | "wintumber" | "witch" | "wizard" | "worker" | "wrath" | "xerician" | "yellow" | "yew" | "zamorakian" | "zarosian" | "zealot" | "zenyte")[];
 declare const PRIVELEGED_GROUP_ROLES: GroupRole[];
@@ -1331,6 +1315,8 @@ declare const MetricProps: {
     theatre_of_blood: BossProperties;
     theatre_of_blood_hard_mode: BossProperties;
     thermonuclear_smoke_devil: BossProperties;
+    tombs_of_amascut: BossProperties;
+    tombs_of_amascut_expert: BossProperties;
     tzkal_zuk: BossProperties;
     tztok_jad: BossProperties;
     venenatis: BossProperties;
@@ -1366,11 +1352,11 @@ declare const MetricProps: {
 };
 declare const METRICS: string[];
 declare const SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
-declare const BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
+declare const BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tombs_of_amascut" | "tombs_of_amascut_expert" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
 declare const ACTIVITIES: string[];
 declare const VIRTUALS: ("ehp" | "ehb")[];
 declare const REAL_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
-declare const F2P_BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
+declare const F2P_BOSSES: ("abyssal_sire" | "alchemical_hydra" | "barrows_chests" | "bryophyta" | "callisto" | "cerberus" | "chambers_of_xeric" | "chambers_of_xeric_challenge_mode" | "chaos_elemental" | "chaos_fanatic" | "commander_zilyana" | "corporeal_beast" | "crazy_archaeologist" | "dagannoth_prime" | "dagannoth_rex" | "dagannoth_supreme" | "deranged_archaeologist" | "general_graardor" | "giant_mole" | "grotesque_guardians" | "hespori" | "kalphite_queen" | "king_black_dragon" | "kraken" | "kreearra" | "kril_tsutsaroth" | "mimic" | "nex" | "nightmare" | "phosanis_nightmare" | "obor" | "sarachnis" | "scorpia" | "skotizo" | "tempoross" | "the_gauntlet" | "the_corrupted_gauntlet" | "theatre_of_blood" | "theatre_of_blood_hard_mode" | "thermonuclear_smoke_devil" | "tombs_of_amascut" | "tombs_of_amascut_expert" | "tzkal_zuk" | "tztok_jad" | "venenatis" | "vetion" | "vorkath" | "wintertodt" | "zalcano" | "zulrah")[];
 declare const MEMBER_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare const COMBAT_SKILLS: ("overall" | "attack" | "defence" | "strength" | "hitpoints" | "ranged" | "prayer" | "magic" | "cooking" | "woodcutting" | "fletching" | "fishing" | "firemaking" | "crafting" | "smithing" | "mining" | "herblore" | "agility" | "thieving" | "slayer" | "farming" | "runecrafting" | "hunter" | "construction")[];
 declare function findMetric(metricName: string): Metric | null;
@@ -1421,6 +1407,19 @@ declare function formatNumber(num: number, withLetters?: boolean): string | -1;
 declare function padNumber(value: number): string;
 declare function round(num: number, cases: number): number;
 
+declare type Achievement = Omit<Prisma_Base_Achievement, 'threshold'> & {
+    threshold: number;
+};
+declare type Record = Omit<Prisma_Base_Record, 'value'> & {
+    value: number;
+};
+declare type Snapshot = Omit<Prisma_Base_Snapshot, 'overallExperience'> & {
+    overallExperience: number;
+};
+declare type Player = Omit<Prisma_Base_Player, 'exp'> & {
+    exp: number;
+};
+
 interface AchievementTemplate {
     name: string;
     metric: Metric;
@@ -1493,6 +1492,13 @@ interface PlayerDeltasMap {
         [virtual in Virtual]?: VirtualDelta;
     };
 }
+interface DeltaLeaderboardEntry {
+    player: Player;
+    playerId: number;
+    startDate: Date;
+    endDate: Date;
+    gained: number;
+}
 
 declare type SnapshotFragment = Omit<Snapshot, 'id'>;
 declare enum SnapshotDataSource {
@@ -1577,7 +1583,7 @@ interface VirtualHiscoresItem {
     value: number;
 }
 interface GroupHiscoresEntry {
-    membership: MembershipWithPlayer;
+    player: Player;
     data: SkillHiscoresItem | BossHiscoresItem | ActivityHiscoresItem | VirtualHiscoresItem;
 }
 interface GroupStatistics {
@@ -1625,6 +1631,13 @@ interface Team {
     name: string;
     participants: string[];
 }
+declare type Top5ProgressResult = Array<{
+    player: Player;
+    history: Array<{
+        value: number;
+        date: Date;
+    }>;
+}>;
 
 declare type ExperienceMap = {
     [skill in Skill]?: number;
@@ -1683,23 +1696,130 @@ declare type AlgorithmCache = {
     [a in EfficiencyAlgorithmType]: EfficiencyAlgorithm;
 };
 
+declare type NameChangeDetails = {
+    nameChange: NameChange;
+    data?: {
+        isNewOnHiscores: boolean;
+        isOldOnHiscores: boolean;
+        isNewTracked: boolean;
+        hasNegativeGains: boolean;
+        timeDiff: number;
+        hoursDiff: number;
+        ehpDiff: number;
+        ehbDiff: number;
+        oldStats: FormattedSnapshot;
+        newStats: FormattedSnapshot;
+    };
+};
+
 declare type PlayerResolvable = Partial<Pick<Player, 'id' | 'username'>>;
 interface PlayerDetails extends Player {
     combatLevel: number;
     latestSnapshot: FormattedSnapshot;
 }
 
-declare type PaginationOptions = Partial<{
-    limit: number;
-    offset: number;
-}>;
+declare type RecordLeaderboardEntry = Record & {
+    player: Player;
+};
 
+interface GenericCountMessageResponse {
+    count: number;
+    message: string;
+}
+interface GenericMessageResponse {
+    message: string;
+}
 declare type TimeRangeFilter = {
     period: Period | string;
 } | {
     startDate: Date;
     endDate: Date;
 };
+interface BasePlayerFilter {
+    country?: Country;
+    playerType?: PlayerType;
+    playerBuild?: PlayerBuild;
+}
+/**
+ * Groups Client Types
+ */
+interface GroupMemberFragment {
+    username: string;
+    role?: GroupRole;
+}
+interface CreateGroupPayload {
+    name: string;
+    clanChat?: string;
+    homeworld?: number;
+    description?: string;
+    members: Array<GroupMemberFragment>;
+}
+declare type EditGroupPayload = Partial<CreateGroupPayload>;
+interface CreateGroupResponse {
+    group: GroupWithMemberships;
+    verificationCode: string;
+}
+interface ChangeMemberRolePayload {
+    username: string;
+    role: GroupRole;
+}
+declare type GetGroupGainsFilter = {
+    metric: Metric;
+} & TimeRangeFilter;
+interface GroupRecordsFilter {
+    metric: Metric;
+    period: Period;
+}
+/**
+ * Competitions Client Types
+ */
+interface CompetitionsSearchFilter {
+    title?: string;
+    metric?: Metric;
+    type?: CompetitionType;
+    status?: CompetitionStatus;
+}
+declare type CreateCompetitionPayload = {
+    title: string;
+    metric: Metric;
+    startsAt: Date;
+    endsAt: Date;
+    groupId?: number;
+    groupVerificationCode?: string;
+} & ({
+    participants: string[];
+} | {
+    teams: Team[];
+});
+declare type EditCompetitionPayload = {
+    title?: string;
+    metric?: Metric;
+    startsAt?: Date;
+    endsAt?: Date;
+    participants?: string[];
+    teams?: Team[];
+};
+declare type CreateCompetitionResponse = {
+    competition: CompetitionWithParticipations;
+    verificationCode: string;
+};
+/**
+ * Name Changes Client Types
+ */
+declare type NameChangesSearchFilter = {
+    username?: string;
+    status?: NameChangeStatus;
+};
+/**
+ * Record Client Types
+ */
+interface RecordLeaderboardFilter extends BasePlayerFilter {
+    metric: Metric;
+    period: Period | string;
+}
+/**
+ * Player Client Types
+ */
 interface PlayerRecordsFilter {
     period: Period | string;
     metric: Metric;
@@ -1708,92 +1828,308 @@ interface AssertPlayerTypeResponse {
     player: Player;
     changed: boolean;
 }
-interface ImportPlayerResponse {
-    count: number;
-    message: string;
-}
-declare type SearchPlayersResponse = Player[];
-declare type UpdatePlayerResponse = PlayerDetails;
-declare type GetPlayerDetailsResponse = PlayerDetails;
-declare type GetPlayerAchievementsResponse = ExtendedAchievement[];
-declare type GetPlayerAchievementProgressResponse = AchievementProgress[];
-declare type GetPlayerCompetitionsResponse = ParticipationWithCompetition[];
-declare type GetPlayerGroupsResponse = MembershipWithGroup[];
-declare type GetPlayerRecordsResponse = Record[];
-declare type GetPlayerNamesResponse = NameChange[];
-declare type GetPlayerSnapshotsResponse = FormattedSnapshot[];
 declare type GetPlayerGainsResponse<T extends PlayerDeltasArray | PlayerDeltasMap> = {
     startsAt: Date;
     endsAt: Date;
     data: T;
 };
+/**
+ * Efficiency Client Types
+ */
+declare type EfficiencyAlgorithmTypeUnion = `${EfficiencyAlgorithmType}`;
+interface EfficiencyLeaderboardsFilter extends BasePlayerFilter {
+    metric: typeof Metric.EHP | typeof Metric.EHB | 'ehp+ehb';
+}
+/**
+ * Delta Client Types
+ */
+interface DeltaLeaderboardFilter extends BasePlayerFilter {
+    metric: Metric;
+    period: Period | string;
+}
+
+declare class DeltasClient {
+    /**
+     * Fetches the current top leaderboard for a specific metric, period, playerType, playerBuild and country.
+     * @returns A list of deltas, with their respective players, values and dates included.
+     */
+    getDeltaLeaderboard(filter: DeltaLeaderboardFilter): Promise<DeltaLeaderboardEntry[]>;
+}
+
+declare type PaginationOptions = Partial<{
+    limit: number;
+    offset: number;
+}>;
+
+declare class GroupsClient {
+    /**
+     * Searches for groups that match a partial name.
+     * @returns A list of groups.
+     */
+    searchGroups(name: string, pagination?: PaginationOptions): Promise<GroupListItem[]>;
+    /**
+     * Fetches a group's details.
+     * @returns A group details object.
+     */
+    getGroupDetails(id: number): Promise<GroupListItem>;
+    /**
+     * Fetches a group's entire members list.
+     * @returns A list of memberships, with players included.
+     */
+    getGroupMembers(id: number): Promise<MembershipWithPlayer[]>;
+    /**
+     * Creates a new group.
+     * @returns The newly created group, and the verification code that authorizes future changes to it.
+     */
+    createGroup(payload: CreateGroupPayload): Promise<CreateGroupResponse>;
+    /**
+     * Edits an existing group.
+     * @returns The updated group.
+     */
+    editGroup(id: number, payload: EditGroupPayload, verificationCode: string): Promise<GroupWithMemberships>;
+    /**
+     * Deletes an existing group.
+     * @returns A confirmation message.
+     */
+    deleteGroup(id: number, verificationCode: string): Promise<GenericMessageResponse>;
+    /**
+     * Adds all (valid) given usernames (and roles) to a group, ignoring duplicates.
+     * @returns The number of members added and a confirmation message.
+     */
+    addMembers(id: number, members: GroupMemberFragment[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Remove all given usernames from a group, ignoring usernames that aren't members.
+     * @returns The number of members removed and a confirmation message.
+     */
+    removeMembers(id: number, usernames: string[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Changes a player's role in a given group.
+     * @returns The updated membership, with player included.
+     */
+    changeRole(id: number, payload: ChangeMemberRolePayload, verificationCode: string): Promise<MembershipWithPlayer>;
+    /**
+     * Adds an "update" request to the queue, for each outdated group member.
+     * @returns The number of players to be updated and a confirmation message.
+     */
+    updateAll(id: number, verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Fetches all of the groups's competitions
+     * @returns A list of competitions.
+     */
+    getGroupCompetitions(id: number, pagination?: PaginationOptions): Promise<CompetitionListItem[]>;
+    getGroupGains(id: number, filter: GetGroupGainsFilter, pagination?: PaginationOptions): Promise<DeltaLeaderboardEntry[]>;
+    /**
+     * Fetches a group members' latest achievements.
+     * @returns A list of achievements.
+     */
+    getGroupAchievements(id: number, pagination?: PaginationOptions): Promise<ExtendedAchievement[]>;
+    /**
+     * Fetches a group's record leaderboard for a specific metric and period.
+     * @returns A list of records, including their respective players.
+     */
+    getGroupRecords(id: number, filter: GroupRecordsFilter, pagination?: PaginationOptions): Promise<RecordLeaderboardEntry[]>;
+    /**
+     * Fetches a group's hiscores for a specific metric.
+     * @returns A list of hiscores entries (value, rank), including their respective players.
+     */
+    getGroupHiscores(id: number, metric: Metric, pagination?: PaginationOptions): Promise<GroupHiscoresEntry[]>;
+    /**
+     * Fetches a group members' latest name changes.
+     * @returns A list of name change (approved) requests.
+     */
+    getGroupNameChanges(id: number, pagination?: PaginationOptions): Promise<NameChange[]>;
+    /**
+     * Fetches a group's general statistics.
+     * @returns An object with a few statistic values and an average stats snapshot.
+     */
+    getGroupStatistics(id: number): Promise<GroupStatistics>;
+}
+
 declare class PlayersClient {
-    searchPlayers(partialUsername: string, pagination?: PaginationOptions): Promise<SearchPlayersResponse>;
+    /**
+     * Searches players by partial username.
+     * @returns A list of players.
+     */
+    searchPlayers(partialUsername: string, pagination?: PaginationOptions): Promise<Player[]>;
+    /**
+     * Updates/tracks a player.
+     * @returns The player's new details, including the latest snapshot.
+     */
     updatePlayer(player: PlayerResolvable): Promise<PlayerDetails>;
+    /**
+     * Asserts (and attempts to fix, if necessary) a player's game-mode type.
+     * @returns The updated player, and an indication of whether the type was changed.
+     */
     assertPlayerType(player: PlayerResolvable): Promise<AssertPlayerTypeResponse>;
-    importPlayer(player: PlayerResolvable): Promise<ImportPlayerResponse>;
+    /**
+     * Attempts to import a player's snapshot history from CrystalMathLabs.
+     * @returns The number of snapshots that were imported.
+     */
+    importPlayer(player: PlayerResolvable): Promise<GenericCountMessageResponse>;
+    /**
+     * Fetches a player's details.
+     * @returns The player's details, including the latest snapshot.
+     */
     getPlayerDetails(player: PlayerResolvable): Promise<PlayerDetails>;
-    getPlayerAchievements(player: PlayerResolvable): Promise<GetPlayerAchievementsResponse>;
-    getPlayerAchievementProgress(player: PlayerResolvable): Promise<GetPlayerAchievementProgressResponse>;
-    getPlayerCompetitions(player: PlayerResolvable, pagination?: PaginationOptions): Promise<GetPlayerCompetitionsResponse>;
-    getPlayerGroups(player: PlayerResolvable, pagination?: PaginationOptions): Promise<GetPlayerGroupsResponse>;
+    /**
+     * Fetches a player's current achievements.
+     * @returns A list of achievements.
+     */
+    getPlayerAchievements(player: PlayerResolvable): Promise<ExtendedAchievement[]>;
+    /**
+     * Fetches a player's current achievement progress.
+     * @returns A list of achievements (completed or otherwise), with their respective relative/absolute progress percentage.
+     */
+    getPlayerAchievementProgress(player: PlayerResolvable): Promise<AchievementProgress[]>;
+    /**
+     * Fetches all of the player's competition participations.
+     * @returns A list of participations, with the respective competition included.
+     */
+    getPlayerCompetitions(player: PlayerResolvable, pagination?: PaginationOptions): Promise<ParticipationWithCompetition[]>;
+    /**
+     * Fetches all of the player's group memberships.
+     * @returns A list of memberships, with the respective group included.
+     */
+    getPlayerGroups(player: PlayerResolvable, pagination?: PaginationOptions): Promise<MembershipWithGroup[]>;
+    /**
+     * Fetches a player's gains, for a specific period or time range, as a [metric: data] map.
+     * @returns A map of each metric's gained data.
+     */
     getPlayerGains(player: PlayerResolvable, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasMap>>;
+    /**
+     * Fetches a player's gains, for a specific period or time range, as an array.
+     * @returns An array of each metric's gained data.
+     */
     getPlayerGainsAsArray(player: PlayerResolvable, options: TimeRangeFilter): Promise<GetPlayerGainsResponse<PlayerDeltasArray>>;
-    getPlayerRecords(player: PlayerResolvable, options?: PlayerRecordsFilter): Promise<GetPlayerRecordsResponse>;
-    getPlayerSnapshots(player: PlayerResolvable, options?: TimeRangeFilter): Promise<GetPlayerSnapshotsResponse>;
-    getPlayerNames(player: PlayerResolvable): Promise<GetPlayerNamesResponse>;
+    /**
+     * Fetches all of the player's records.
+     * @returns A list of records.
+     */
+    getPlayerRecords(player: PlayerResolvable, options?: PlayerRecordsFilter): Promise<Record[]>;
+    /**
+     * Fetches all of the player's past snapshots.
+     * @returns A list of snapshots.
+     */
+    getPlayerSnapshots(player: PlayerResolvable, options?: TimeRangeFilter): Promise<FormattedSnapshot[]>;
+    /**
+     * Fetches all of the player's approved name changes.
+     * @returns A list of name changes.
+     */
+    getPlayerNames(player: PlayerResolvable): Promise<NameChange[]>;
 }
 
-interface RecordLeaderboardFilter {
-    metric: Metric;
-    period: Period | string;
-    country?: Country;
-    playerType?: PlayerType;
-    playerBuild?: PlayerBuild;
-}
-declare type GetRecordLeaderboardResponse = Array<Record & {
-    player: Player;
-}>;
 declare class RecordsClient {
-    getRecordLeaderboard(filter: RecordLeaderboardFilter): Promise<GetRecordLeaderboardResponse>;
+    /**
+     * Fetches the current records leaderboard for a specific metric, period, playerType, playerBuild and country.
+     * @returns A list of records, with their respective players, dates and values included.
+     */
+    getRecordLeaderboard(filter: RecordLeaderboardFilter): Promise<RecordLeaderboardEntry[]>;
 }
 
-interface DeltaLeaderboardFilter {
-    metric: Metric;
-    period: Period | string;
-    country?: Country;
-    playerType?: PlayerType;
-    playerBuild?: PlayerBuild;
-}
-declare type GetDeltaLeaderboardResponse = Array<{
-    startDate: Date;
-    endDate: Date;
-    gained: number;
-    player: Player;
-}>;
-declare class DeltasClient {
-    getDeltaLeaderboard(filter: DeltaLeaderboardFilter): Promise<GetDeltaLeaderboardResponse>;
+declare class EfficiencyClient {
+    /**
+     * Fetches the current efficiency leaderboard for a specific virtual metric, playerType, playerBuild and country.
+     * @returns A list of players.
+     */
+    getEfficiencyLeaderboards(filter: EfficiencyLeaderboardsFilter, pagination?: PaginationOptions): Promise<Player[]>;
+    /**
+     * Fetches the top EHP (Efficient Hours Played) rates.
+     * @returns A list of skilling methods and their bonus exp ratios.
+     */
+    getEHPRates(algorithmType: EfficiencyAlgorithmTypeUnion): Promise<SkillMetaConfig>;
+    /**
+     * Fetches the top EHB (Efficient Hours Bossed) rates.
+     * @returns A list of bosses and their respective "per-hour" kill rates.
+     */
+    getEHBRates(algorithmType: EfficiencyAlgorithmTypeUnion): Promise<BossMetaConfig[]>;
 }
 
-interface EfficiencyLeaderboardsFilter {
-    metric: typeof Metric.EHP | typeof Metric.EHB | 'ehp+ehb';
-    country?: Country;
-    playerType?: PlayerType;
-    playerBuild?: PlayerBuild;
+declare class NameChangesClient {
+    /**
+     * Searches for name changes that match a name and/or status filter.
+     * @returns A list of name changes.
+     */
+    searchNameChanges(filter: NameChangesSearchFilter, pagination?: PaginationOptions): Promise<NameChange[]>;
+    /**
+     * Submits a name change request between two usernames (old and new).
+     * @returns A pending name change request, to be reviewed and resolved at a later date.
+     */
+    submitNameChange(oldName: string, newName: string): Promise<NameChange>;
+    /**
+     * Gets details on a specific name change request.
+     * @returns The name change request's details, which includes all data required to review.
+     */
+    getNameChangeDetails(id: number): Promise<NameChangeDetails>;
 }
-declare type GetEfficiencyLeaderboardsResponse = Player[];
-declare class EfficiencyClient {
-    getEfficiencyLeaderboards(filter: EfficiencyLeaderboardsFilter, pagination?: PaginationOptions): Promise<GetEfficiencyLeaderboardsResponse>;
-    getEHPRates(algorithmType: `${EfficiencyAlgorithmType}`): Promise<SkillMetaConfig>;
-    getEHBRates(algorithmType: `${EfficiencyAlgorithmType}`): Promise<BossMetaConfig[]>;
+
+declare class CompetitionsClient {
+    /**
+     * Searches for competitions that match a title, type, metric and status filter.
+     * @returns A list of competitions.
+     */
+    searchCompetitions(filter: CompetitionsSearchFilter, pagination?: PaginationOptions): Promise<CompetitionListItem[]>;
+    /**
+     * Fetches the competition's full details, including all the participants and their progress.
+     * @returns A competition with a list of participants.
+     */
+    getCompetitionDetails(id: number, previewMetric?: Metric): Promise<CompetitionDetails>;
+    /**
+     * Fetches all the values (exp, kc, etc) in chronological order within the bounds
+     * of the competition, for the top 5 participants.
+     * @returns A list of competition progress objects, including the player and their value history over time.
+     */
+    getCompetitionTopHistory(id: number, previewMetric?: Metric): Promise<Top5ProgressResult>;
+    /**
+     * Creates a new competition.
+     * @returns The newly created competition, and the verification code that authorizes future changes to it.
+     */
+    createCompetition(payload: CreateCompetitionPayload): Promise<CreateCompetitionResponse>;
+    /**
+     * Edits an existing competition.
+     * @returns The updated competition.
+     */
+    editCompetition(id: number, payload: EditCompetitionPayload, verificationCode: string): Promise<CompetitionWithParticipations>;
+    /**
+     * Deletes an existing competition.
+     * @returns A confirmation message.
+     */
+    deleteCompetition(id: number, verificationCode: string): Promise<GenericMessageResponse>;
+    /**
+     * Adds all (valid) given participants to a competition, ignoring duplicates.
+     * @returns The number of participants added and a confirmation message.
+     */
+    addParticipants(id: number, participants: string[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Remove all given usernames from a competition, ignoring usernames that aren't competing.
+     * @returns The number of participants removed and a confirmation message.
+     */
+    removeParticipants(id: number, participants: string[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Adds all (valid) given teams to a team competition, ignoring duplicates.
+     * @returns The number of participants added and a confirmation message.
+     */
+    addTeams(id: number, teams: Team[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Remove all given team names from a competition, ignoring names that don't exist.
+     * @returns The number of participants removed and a confirmation message.
+     */
+    removeTeams(id: number, teamNames: string[], verificationCode: string): Promise<GenericCountMessageResponse>;
+    /**
+     * Adds an "update" request to the queue, for each outdated competition participant.
+     * @returns The number of players to be updated and a confirmation message.
+     */
+    updateAll(id: number, verificationCode: string): Promise<GenericCountMessageResponse>;
 }
 
 declare class WOMClient {
+    deltas: DeltasClient;
+    groups: GroupsClient;
     players: PlayersClient;
     records: RecordsClient;
-    deltas: DeltasClient;
     efficiency: EfficiencyClient;
+    nameChanges: NameChangesClient;
+    competitions: CompetitionsClient;
     constructor();
 }
 
-export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COUNTRY_CODES, CompetitionDetails, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, Country, CountryDetails, CountryProps, Delta, DeltaLeaderboardFilter, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, F2P_BOSSES, FormattedSnapshot, GROUP_ROLES, GetDeltaLeaderboardResponse, GetEfficiencyLeaderboardsResponse, GetPlayerAchievementProgressResponse, GetPlayerAchievementsResponse, GetPlayerCompetitionsResponse, GetPlayerDetailsResponse, GetPlayerGainsResponse, GetPlayerGroupsResponse, GetPlayerNamesResponse, GetPlayerRecordsResponse, GetPlayerSnapshotsResponse, GetRecordLeaderboardResponse, GroupHiscoresEntry, GroupListItem, GroupRole, GroupRoleProps, GroupStatistics, GroupWithMemberships, ImportPlayerResponse, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeStatus, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerResolvable, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, SearchPlayersResponse, Skill, SkillDelta, SkillMetaConfig, SkillValue, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, UpdatePlayerResponse, VIRTUALS, Virtual, VirtualDelta, VirtualValue, WOMClient, findCompetitionStatus, findCompetitionType, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, get200msCount, getCappedExp, getCombatLevel, getCombatLevelFromExp, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumBossKc, getMinimumExp, getParentVirtualMetric, getTotalLevel, is10HP, is1Def, isActivity, isBoss, isF2p, isLvl3, isSkill, isVirtualMetric, isZerker, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };
+export { ACTIVITIES, Achievement, AchievementDefinition, AchievementProgress, AchievementTemplate, Activity, ActivityDelta, ActivityValue, AlgorithmCache, AssertPlayerTypeResponse, BOSSES, Bonus, BonusType, Boss, BossDelta, BossMetaConfig, BossValue, CAPPED_MAX_TOTAL_XP, CMLGroupData, COMBAT_SKILLS, COMPETITION_STATUSES, COMPETITION_TYPES, COUNTRY_CODES, ChangeMemberRolePayload, CompetitionDetails, CompetitionListItem, CompetitionStatus, CompetitionStatusProps, CompetitionType, CompetitionTypeProps, CompetitionWithParticipations, CompetitionsSearchFilter, Country, CountryDetails, CountryProps, CreateCompetitionPayload, CreateCompetitionResponse, CreateGroupPayload, CreateGroupResponse, DeltaLeaderboardEntry, DeltaLeaderboardFilter, EditCompetitionPayload, EditGroupPayload, EfficiencyAlgorithm, EfficiencyAlgorithmType, EfficiencyAlgorithmTypeUnion, EfficiencyLeaderboardsFilter, EfficiencyMap, ExperienceMap, ExtendedAchievement, F2P_BOSSES, FormattedSnapshot, GROUP_ROLES, GenericCountMessageResponse, GenericMessageResponse, GetGroupGainsFilter, GetPlayerGainsResponse, GroupHiscoresEntry, GroupListItem, GroupMemberFragment, GroupRecordsFilter, GroupRole, GroupRoleProps, GroupStatistics, GroupWithMemberships, KillcountMap, MAX_LEVEL, MAX_SKILL_EXP, MAX_VIRTUAL_LEVEL, MEMBER_SKILLS, METRICS, MeasuredDeltaProgress, MemberInput, MembershipWithGroup, MembershipWithPlayer, Metric, MetricMeasure, MetricProps, MetricType, MigrationDataSource, NameChangeDetails, NameChangeStatus, NameChangesSearchFilter, PERIODS, PLAYER_BUILDS, PLAYER_TYPES, PRIVELEGED_GROUP_ROLES, ParticipationWithCompetition, ParticipationWithPlayer, ParticipationWithPlayerAndProgress, Period, PeriodProps, Player, PlayerBuild, PlayerBuildProps, PlayerDeltasArray, PlayerDeltasMap, PlayerDetails, PlayerRecordsFilter, PlayerResolvable, PlayerType, PlayerTypeProps, REAL_SKILLS, Record, RecordLeaderboardEntry, RecordLeaderboardFilter, SKILLS, SKILL_EXP_AT_99, Skill, SkillDelta, SkillMetaConfig, SkillValue, Snapshot, SnapshotDataSource, SnapshotFragment, Team, TempleGroupData, TimeRangeFilter, Top5ProgressResult, VIRTUALS, Virtual, VirtualDelta, VirtualValue, WOMClient, findCompetitionStatus, findCompetitionType, findCountry, findCountryByCode, findCountryByName, findGroupRole, findMetric, findPeriod, findPlayerBuild, findPlayerType, formatNumber, getCombatLevel, getExpForLevel, getLevel, getMetricMeasure, getMetricName, getMetricRankKey, getMetricValueKey, getMinimumBossKc, getParentVirtualMetric, isActivity, isBoss, isSkill, isVirtualMetric, padNumber, parseMetricAbbreviation, parsePeriodExpression, round };