@barbarbar338/bhapi/dist/brawlhalla.d.ts

Brawlhalla API wrapper for NodeJS and web

import { AxiosResponse } from "axios";
import { Clan, GloryData, PlayerRanked, PlayerStats, RankingResponse, RankingsOptions, RankingTypes, StaticAllLegends, StaticLegend } from "./types";
/**
 * Get Brawlhalla ID from player name
 *
 * @param {string} name Player name
 * @returns {number} Brawlhalla ID of the player
 */
export declare const getBHIDFromName: (name: string) => Promise<number>;
/**
 * Get player stats by Brawlhalla ID
 *
 * @param {number} brawlhallaId Brawlhalla ID of the player
 * @returns {Promise<AxiosResponse<PlayerStats>>} Player stats
 */
export declare const getStatsByBHID: (brawlhallaId: number) => Promise<AxiosResponse<PlayerStats>>;
/**
 * Get player stats by name
 *
 * @param {string} name Player name
 * @returns {Promise<AxiosResponse<PlayerStats>>} Player stats
 */
export declare const getStatsByName: (name: string) => Promise<AxiosResponse<PlayerStats, any, {}>>;
/**
 * Get player ranked stats by Brawlhalla ID
 *
 * @param {number} brawlhallaId Brawlhalla ID of the player
 * @returns {Promise<AxiosResponse<PlayerRanked>>} Player ranked stats
 */
export declare const getRankedByBHID: (brawlhallaId: number) => Promise<AxiosResponse<PlayerRanked>>;
/**
 * Get clan by ID
 *
 * @param {number} clanID Brawlhalla clan ID
 * @returns {Promise<AxiosResponse<Clan>>} Clan data
 */
export declare const getClanByID: (clanID: number) => Promise<AxiosResponse<Clan>>;
/**
 * Get all legends
 *
 * @returns {Promise<AxiosResponse<StaticAllLegends[]>>} All legends
 */
export declare const getAllLegends: () => Promise<AxiosResponse<StaticAllLegends[]>>;
/**
 * Get legend by ID
 *
 * @param {number} legendID Brawlhalla legend ID
 * @returns {Promise<AxiosResponse<StaticLegend>>} Legend data
 */
export declare const getLegendByID: (legendID: number) => Promise<AxiosResponse<StaticLegend>>;
/**
 * Get legend by name
 *
 * @param {string} name Legend name
 * @returns {Promise<AxiosResponse<StaticLegend>>} Legend data
 */
export declare const getLegendByName: (name: string) => Promise<AxiosResponse<StaticLegend>>;
/**
 * Get glory data by Brawlhalla ID
 *
 * @param {number} brawlhallaId Brawlhalla ID of the player
 * @returns {Promise<GloryData>} Glory data
 */
export declare const getGloryByBHID: (brawlhallaId: number) => Promise<GloryData>;
/**
 * Get player rankings
 *
 * @param {RankingsOptions<RankingTypes>} rankingOptions Ranking options
 * @returns {Promise<AxiosResponse<RankingResponse<RankingTypes>>>} Player rankings
 */
export declare const getRankings: <T extends RankingTypes>({ page, region, type, }: RankingsOptions<T>) => Promise<AxiosResponse<RankingResponse<T>>>;
//# sourceMappingURL=brawlhalla.d.ts.map