@cfwest/api-client
Version:
Unofficial CrossFire West ApiClient implementation.
26 lines (25 loc) • 931 B
TypeScript
import { Achievement, UserAchievement } from '../rest-models';
import { BaseApiModule } from './base-module';
/**
* ApiModule to handle everything related _'Achievements'_ related implementation.
* For more details about ApiModules see: [[ApiModule]]
*/
export declare class AchievementsApiModule extends BaseApiModule {
/**
* Query for a complete list of all available achievements.
*
* @returns A Promise which should be resolved into [[Achievement]]s.
*/
getAchievementList(): Promise<Achievement[] | undefined>;
/**
* Query a specific player's achievements.
*
* @param playerUSN The target player USN
*
* @see [[Achievement]]
* @see [[UserAchievement]]
*
* @returns A promise which resolves into an array of all [[UserAchievement]]s
*/
getUserAchievements(playerUSN: string): Promise<UserAchievement[] | undefined>;
}