clashofclans.js 2.0.0-dev.dedb83d → 2.0.0

package/CHANGELOG.md

@@ -2,15 +2,16 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## 2.0.0
+## 2.0.0 (2021-11-26)
 
 This new version is a complete TypeScript rewrite to convert everything from plain (literal JSON) objects to class (constructor) objects and support a lot more features.
 
 ### Features
 
--   EventManager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
--   Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53))
--   Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
 -   API Date Parser and Request Retries ([#26](https://github.com/clashperk/clashofclans.js/issues/26)) ([94585f3](https://github.com/clashperk/clashofclans.js/commit/94585f3a84a7175b2d07872f9eb9e42372b95e12))
--   Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
+-   EventManager and Custom Events ([#37](https://github.com/clashperk/clashofclans.js/issues/37)) ([5027ae6](https://github.com/clashperk/clashofclans.js/commit/5027ae663a8e07175e17384c7e5706f4a1a7afb4))
+-   Email Password Login ([#31](https://github.com/clashperk/clashofclans.js/issues/31)) ([4153cd3](https://github.com/clashperk/clashofclans.js/commit/4153cd37ea0e1c71550b9e892105b84d5a407e23))
 -   QueueThrottler and BatchThrottler ([#34](https://github.com/clashperk/clashofclans.js/issues/34)) ([3a8f051](https://github.com/clashperk/clashofclans.js/commit/3a8f051552e93b98f89bc7d524acdecddf242718))
+-   Override Request Options ([#36](https://github.com/clashperk/clashofclans.js/issues/36)) ([42d7fdd](https://github.com/clashperk/clashofclans.js/commit/42d7fdd36262cc46f23b731f8cffb9daea19d3b0))
+-   Internal Caching Options ([#53](https://github.com/clashperk/clashofclans.js/issues/53)) ([984451d](https://github.com/clashperk/clashofclans.js/commit/30ea3240c11866008d0dae514468c0fdbb34ffd0))
+-   Raw Data for Player Units ([#65](https://github.com/clashperk/clashofclans.js/pull/65)) ([aa1696](https://github.com/clashperk/clashofclans.js/commit/aa1696243d96d4fed0250b4282c60522a6482343))

package/README.md

@@ -39,12 +39,13 @@ const client = new Client();
 ```js
 const { Client, BatchThrottler } = require('clashofclans.js');
 const client = new Client({
+    cache: true,
     retryLimit: 1,
-    restRequestTimeout: 3000,
-    throttler: new BatchThrottler(30)
+    restRequestTimeout: 5000,
+    throttler: new BatchThrottler(20)
 });
 
-client.events.addClans(['#8P2QG08P']);
+client.events.addClans(['#8QU8J9LP', '#8P2QG08P']);
 client.events.setClanEvent({
     name: 'clanDescriptionChange',
     filter: (oldClan, newClan) => {

package/dist/client/Client.d.ts

@@ -21,6 +21,8 @@ export declare class Client extends EventEmitter {
     constructor(options?: ClientOptions);
     /** Contains various general-purpose utility methods. */
     get util(): typeof Util;
+    /** Whether the API is in maintenance break. */
+    get inMaintenance(): boolean;
     /**
      * Initialize the client to create keys.
      * @example
@@ -76,7 +78,7 @@ export declare class Client extends EventEmitter {
     private _getClanWars;
     /** Get information about clan war league. */
     getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<ClanWarLeagueGroup>;
-    /** Get information about CWL round by WarTag. */
+    /** Get info about a CWL round by WarTag. */
     getClanWarLeagueRound(warTag: string | {
         warTag: string;
         clanTag?: string;
@@ -99,9 +101,9 @@ export declare class Client extends EventEmitter {
     getClanRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedClan[]>;
     /** Get player rankings for a specific location. */
     getPlayerRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedPlayer[]>;
-    /** Get clan versus rankings for a specific location */
+    /** Get clan versus rankings for a specific location. */
     getVersusClanRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedClan[]>;
-    /** Get player versus rankings for a specific location */
+    /** Get player versus rankings for a specific location. */
     getVersusPlayerRanks(locationId: number | 'global', options?: SearchOptions): Promise<RankedPlayer[]>;
     /** Get list of clan labels. */
     getClanLabels(options?: SearchOptions): Promise<Label[]>;

package/dist/client/Client.js

@@ -25,6 +25,11 @@ class Client extends events_1.EventEmitter {
     get util() {
         return Util_1.Util;
     }
+    /** Whether the API is in maintenance break. */
+    get inMaintenance() {
+        // @ts-expect-error
+        return this.events._inMaintenance;
+    }
     /**
      * Initialize the client to create keys.
      * @example
@@ -88,7 +93,7 @@ class Client extends events_1.EventEmitter {
         }
         catch (e) {
             if (e instanceof HTTPError_1.HTTPError && [200, 403].includes(e.status)) {
-                return this.getLeagueWar({ clanTag: args.clanTag, round: args.round });
+                return this.getLeagueWar({ clanTag: args.clanTag, round: args.round }, options);
             }
             throw e;
         }
@@ -117,7 +122,7 @@ class Client extends events_1.EventEmitter {
             .map((round) => round.warTags)
             .flat()
             .reverse();
-        const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag: args.clanTag }, { ignoreRateLimit: true })));
+        const wars = await this.util.allSettled(warTags.map((warTag) => this.getClanWarLeagueRound({ warTag, clanTag: args.clanTag }, { ...options, ignoreRateLimit: true })));
         if (args.round && args.round in Constants_1.CWL_ROUNDS) {
             return wars.find((war) => war.state === state) ?? null;
         }
@@ -126,7 +131,7 @@ class Client extends events_1.EventEmitter {
     async _getCurrentLeagueWars(clanTag, options) {
         const data = await this.getClanWarLeagueGroup(clanTag, options);
         // @ts-expect-error
-        return data._getCurrentWars(clanTag);
+        return data._getCurrentWars(clanTag, options);
     }
     async _getClanWars(clanTag, options) {
         const date = new Date().getUTCDate();
@@ -134,11 +139,11 @@ class Client extends events_1.EventEmitter {
             return [await this.getClanWar(clanTag, options)];
         }
         try {
-            return this._getCurrentLeagueWars(clanTag);
+            return this._getCurrentLeagueWars(clanTag, options);
         }
         catch (e) {
             if (e instanceof HTTPError_1.HTTPError && [404].includes(e.status)) {
-                return [await this.getClanWar(clanTag)];
+                return [await this.getClanWar(clanTag, options)];
             }
             throw e;
         }
@@ -148,7 +153,7 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getClanWarLeagueGroup(clanTag, options);
         return new struct_1.ClanWarLeagueGroup(this, data);
     }
-    /** Get information about CWL round by WarTag. */
+    /** Get info about a CWL round by WarTag. */
     async getClanWarLeagueRound(warTag, options) {
         const args = typeof warTag === 'string' ? { warTag } : { warTag: warTag.warTag, clanTag: warTag.clanTag };
         const { data, maxAge, status, path } = await this.rest.getClanWarLeagueRound(args.warTag, options);
@@ -164,7 +169,7 @@ class Client extends events_1.EventEmitter {
     }
     /** Verify Player API token that can be found from the Game settings. */
     async verifyPlayerToken(playerTag, token, options) {
-        const { data } = await this.rest.postPlayerToken(playerTag, token, options);
+        const { data } = await this.rest.verifyPlayerToken(playerTag, token, options);
         return data.status === 'ok';
     }
     /** Get list of Leagues. */
@@ -203,12 +208,12 @@ class Client extends events_1.EventEmitter {
         const { data } = await this.rest.getPlayerRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedPlayer(this, entry));
     }
-    /** Get clan versus rankings for a specific location */
+    /** Get clan versus rankings for a specific location. */
     async getVersusClanRanks(locationId, options) {
         const { data } = await this.rest.getVersusClanRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedClan(entry));
     }
-    /** Get player versus rankings for a specific location */
+    /** Get player versus rankings for a specific location. */
     async getVersusPlayerRanks(locationId, options) {
         const { data } = await this.rest.getVersusPlayerRanks(locationId, options);
         return data.items.map((entry) => new struct_1.RankedPlayer(this, entry));

package/dist/client/EventManager.d.ts

@@ -15,18 +15,18 @@ export declare class EventManager {
     constructor(client: Client);
     /** Initialize the Event Manager to start pulling. */
     init(): Promise<string[]>;
-    /** Add a clan tag to clan events. */
-    addClans(...tags: string[]): this;
-    /** Delete a clan tag from clan events. */
-    deleteClans(...tags: string[]): this;
-    /** Add a player tag for player events. */
-    addPlayers(...tags: string[]): this;
-    /** Delete a player tag from player events. */
-    deletePlayers(...tags: string[]): this;
-    /** Add a clan tag for war events. */
-    addWars(...tags: string[]): this;
-    /** Delete a clan tag from war events. */
-    deleteWars(...tags: string[]): this;
+    /** Add clan tags to clan events. */
+    addClans(tags: string[] | string): this;
+    /** Delete clan tags from clan events. */
+    deleteClans(tags: string[] | string): this;
+    /** Add player tags for player events. */
+    addPlayers(tags: string[] | string): this;
+    /** Delete player tags from player events. */
+    deletePlayers(tags: string[] | string): this;
+    /** Add clan tags for war events. */
+    addWars(tags: string[] | string): this;
+    /** Delete clan tags from war events. */
+    deleteWars(tags: string[] | string): this;
     /**
      * Set your own custom clan event.
      *

package/dist/client/EventManager.js

@@ -31,45 +31,52 @@ class EventManager {
         this.warUpdateHandler();
         return Promise.resolve(this.client.eventNames());
     }
-    /** Add a clan tag to clan events. */
-    addClans(...tags) {
-        for (const tag of tags) {
+    /** Add clan tags to clan events. */
+    addClans(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._clanTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    /** Delete a clan tag from clan events. */
-    deleteClans(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete clan tags from clan events. */
+    deleteClans(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._clans.delete(key);
+            this._clanTags.delete(key);
         }
         return this;
     }
-    /** Add a player tag for player events. */
-    addPlayers(...tags) {
-        for (const tag of tags) {
+    /** Add player tags for player events. */
+    addPlayers(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._playerTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    /** Delete a player tag from player events. */
-    deletePlayers(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete player tags from player events. */
+    deletePlayers(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._players.delete(key);
+            this._playerTags.delete(key);
         }
         return this;
     }
-    /** Add a clan tag for war events. */
-    addWars(...tags) {
-        for (const tag of tags) {
+    /** Add clan tags for war events. */
+    addWars(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
             this._warTags.add(this.client.util.parseTag(tag));
         }
         return this;
     }
-    /** Delete a clan tag from war events. */
-    deleteWars(...tags) {
-        for (const tag of tags) {
-            this._warTags.delete(this.client.util.parseTag(tag));
+    /** Delete clan tags from war events. */
+    deleteWars(tags) {
+        for (const tag of Array.isArray(tags) ? tags : [tags]) {
+            const key = this.client.util.parseTag(tag);
+            this._wars.delete(`${key}:${1}`);
+            this._wars.delete(`${key}:${2}`);
+            this._warTags.delete(key);
         }
         return this;
     }
@@ -100,6 +107,10 @@ class EventManager {
      * @returns
      */
     setClanEvent(event) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
         this._events.clans.push(event);
         return this;
     }
@@ -109,6 +120,10 @@ class EventManager {
      * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setWarEvent(event) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
         this._events.wars.push(event);
         return this;
     }
@@ -118,6 +133,10 @@ class EventManager {
      * In order to emit the custom event, you must have this filter function that returns a boolean.
      */
     setPlayerEvent(event) {
+        if (!event.name)
+            throw new Error('Event name is required.');
+        if (typeof event.filter !== 'function')
+            throw new Error('Filter function is required.');
         this._events.players.push(event);
         return this;
     }
@@ -127,7 +146,7 @@ class EventManager {
             const res = await this.client.rest.getClans({ maxMembers: Math.floor(Math.random() * 40) + 10, limit: 1 });
             if (res.status === 200 && this._inMaintenance) {
                 this._inMaintenance = Boolean(false);
-                const duration = this._maintenanceStartTime.getTime() - Date.now();
+                const duration = Date.now() - this._maintenanceStartTime.getTime();
                 this._maintenanceStartTime = null;
                 this.client.emit(Constants_1.EVENTS.MAINTENANCE_END, duration);
             }
@@ -157,21 +176,21 @@ class EventManager {
         for (const tag of this._clanTags)
             await this.runClanUpdate(tag);
         this.client.emit(Constants_1.EVENTS.CLAN_LOOP_END);
-        setTimeout(this.clanUpdateHandler.bind(this), 10000);
+        setTimeout(this.clanUpdateHandler.bind(this), 10000).unref();
     }
     async playerUpdateHandler() {
         this.client.emit(Constants_1.EVENTS.PLAYER_LOOP_START);
         for (const tag of this._playerTags)
             await this.runPlayerUpdate(tag);
         this.client.emit(Constants_1.EVENTS.PLAYER_LOOP_END);
-        setTimeout(this.playerUpdateHandler.bind(this), 10000);
+        setTimeout(this.playerUpdateHandler.bind(this), 10000).unref();
     }
     async warUpdateHandler() {
         this.client.emit(Constants_1.EVENTS.WAR_LOOP_START);
         for (const tag of this._warTags)
             await this.runWarUpdate(tag);
         this.client.emit(Constants_1.EVENTS.WAR_LOOP_END);
-        setTimeout(this.warUpdateHandler.bind(this), 10000);
+        setTimeout(this.warUpdateHandler.bind(this), 10000).unref();
     }
     async runClanUpdate(tag) {
         if (this._inMaintenance)
@@ -222,8 +241,8 @@ class EventManager {
         const clanWars = await this.client._getClanWars(tag).catch(() => null);
         if (!clanWars?.length)
             return null;
-        clanWars.forEach(async (war, state) => {
-            const key = `${tag}:${state}`;
+        clanWars.forEach(async (war, index) => {
+            const key = `${tag}:${index}`;
             const cached = this._wars.get(key);
             if (!cached)
                 return this._wars.set(key, war);
@@ -238,7 +257,7 @@ class EventManager {
                 }
             }
             // check for war end
-            if (state === 1 && cached.warTag !== war.warTag) {
+            if (index === 1 && cached.warTag !== war.warTag) {
                 const data = await this.client.getLeagueWar({ clanTag: tag, round: 'PREVIOUS_ROUND' }).catch(() => null);
                 if (data && data.warTag === cached.warTag) {
                     for (const { name, filter } of this._events.wars) {

package/dist/rest/HTTPError.d.ts

@@ -1,6 +1,4 @@
-/**
- * Represents an HTTP Error.
- */
+/** Represents an HTTP Error. */
 export declare class HTTPError extends Error {
     /** The message of this error. */
     message: string;

package/dist/rest/HTTPError.js

@@ -19,9 +19,7 @@ const reasons = {
     404: 'notFound',
     504: 'requestAborted'
 };
-/**
- * Represents an HTTP Error.
- */
+/** Represents an HTTP Error. */
 class HTTPError extends Error {
     constructor(error, status, path, maxAge, method) {
         super();

package/dist/rest/RESTManager.d.ts

@@ -2,150 +2,55 @@ import { RequestHandler, SearchOptions, ClanSearchOptions, ClientOptions, Overri
 import { APIClan, APIClanList, APIClanMemberList, APIClanRankingList, APIClanVersusRankingList, APIClanWar, APIClanWarLeagueGroup, APIClanWarLog, APIGoldPassSeason, APILabelList, APILeague, APILeagueList, APILeagueSeasonList, APILocation, APILocationList, APIPlayer, APIPlayerRankingList, APIPlayerSeasonRankingList, APIPlayerVersusRankingList, APIVerifyToken, APIWarLeague, APIWarLeagueList } from '../types';
 /** Represents a REST Manager of the client. */
 export declare class RESTManager {
+    /** Request Handler for the RESTManager. */
     readonly handler: RequestHandler;
     constructor(options?: ClientOptions);
-    getClans(options: ClanSearchOptions): Promise<{
-        data: APIClanList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClan(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClan;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanMembers(clanTag: string, options?: SearchOptions): Promise<{
-        data: APIClanMemberList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<{
-        data: APIClanWarLog;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWar;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWarLeagueGroup;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<{
-        data: APIClanWar;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayer(playerTag: string, options?: OverrideOptions): Promise<{
-        data: APIPlayer;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    postPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<{
-        data: APIVerifyToken;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeagues(options?: SearchOptions): Promise<{
-        data: APILeagueList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<{
-        data: APILeague;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<{
-        data: APILeagueSeasonList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<{
-        data: APIPlayerSeasonRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getWarLeagues(options?: SearchOptions): Promise<{
-        data: APIWarLeagueList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<{
-        data: APIWarLeague;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLocations(options?: SearchOptions): Promise<{
-        data: APILocationList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getLocation(locationId: number, options?: OverrideOptions): Promise<{
-        data: APILocation;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIClanRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIPlayerRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIClanVersusRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<{
-        data: APIPlayerVersusRankingList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getClanLabels(options?: SearchOptions): Promise<{
-        data: APILabelList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getPlayerLabels(options?: SearchOptions): Promise<{
-        data: APILabelList;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
-    getGoldPassSeason(options?: OverrideOptions): Promise<{
-        data: APIGoldPassSeason;
-        maxAge: number;
-        status: number;
-        path: string;
-    }>;
+    /** Search all clans by name and/or filtering the results using various criteria. */
+    getClans(options: ClanSearchOptions): Promise<import("./RequestHandler").Response<APIClanList>>;
+    /** Get information about a clan. */
+    getClan(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClan>>;
+    /** Get list of clan members. */
+    getClanMembers(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanMemberList>>;
+    /** Get clan war log. */
+    getClanWarLog(clanTag: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanWarLog>>;
+    /** Get info about currently running war in the clan. */
+    getCurrentWar(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    /** Get information about clan war league. */
+    getClanWarLeagueGroup(clanTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWarLeagueGroup>>;
+    /** Get info about a CWL round by WarTag. */
+    getClanWarLeagueRound(warTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIClanWar>>;
+    /** Get information about a player by tag. */
+    getPlayer(playerTag: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIPlayer>>;
+    /** Verify Player API token that can be found from the Game settings. */
+    verifyPlayerToken(playerTag: string, token: string, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIVerifyToken>>;
+    /** Get list of Leagues. */
+    getLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueList>>;
+    /** Get a League info. */
+    getLeague(leagueId: string | number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILeague>>;
+    /** Get Legend League season Ids. */
+    getLeagueSeasons(leagueId: number, options?: SearchOptions): Promise<import("./RequestHandler").Response<APILeagueSeasonList>>;
+    /** Get Legend League season rankings by season Id. */
+    getSeasonRankings(leagueId: number, seasonId: string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerSeasonRankingList>>;
+    /** Get list of Clan War Leagues. */
+    getWarLeagues(options?: SearchOptions): Promise<import("./RequestHandler").Response<APIWarLeagueList>>;
+    /** Get info about a Clan War League. */
+    getWarLeague(leagueId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIWarLeague>>;
+    /** Get list of Locations. */
+    getLocations(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILocationList>>;
+    /** Get info about a Location. */
+    getLocation(locationId: number, options?: OverrideOptions): Promise<import("./RequestHandler").Response<APILocation>>;
+    /** Get clan rankings for a specific location. */
+    getClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanRankingList>>;
+    /** Get player rankings for a specific location. */
+    getPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerRankingList>>;
+    /** Get clan versus rankings for a specific location. */
+    getVersusClanRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIClanVersusRankingList>>;
+    /** Get player versus rankings for a specific location. */
+    getVersusPlayerRanks(locationId: number | string, options?: SearchOptions): Promise<import("./RequestHandler").Response<APIPlayerVersusRankingList>>;
+    /** Get list of clan labels. */
+    getClanLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    /** Get list of player labels. */
+    getPlayerLabels(options?: SearchOptions): Promise<import("./RequestHandler").Response<APILabelList>>;
+    /** Get info about gold pass season. */
+    getGoldPassSeason(options?: OverrideOptions): Promise<import("./RequestHandler").Response<APIGoldPassSeason>>;
 }