This repository has been archived on 2023-11-06. You can view files and clone it, but cannot push or open issues or pull requests.
lfk-client-node/dist/services/StatsService.d.ts

71 lines
2.6 KiB
TypeScript

import type { ResponseStats } from '../models/ResponseStats';
import type { ResponseStatsOrgnisation } from '../models/ResponseStatsOrgnisation';
import type { ResponseStatsRunner } from '../models/ResponseStatsRunner';
import type { ResponseStatsTeam } from '../models/ResponseStatsTeam';
export declare class StatsService {
/**
* Get
* A very basic stats endpoint providing basic counters for a dashboard or simmilar
* @returns ResponseStats
* @throws ApiError
*/
static statsControllerGet(): Promise<ResponseStats>;
/**
* Get top runners by distance
* Returns the top ten runners by distance.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDistance(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by donations
* Returns the top ten runners by donations.
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByDonations(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by laptime
* Returns the top ten runners by fastest laptime on your selected track (track by id).
* @param track
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByLaptime(track?: number): Promise<Array<ResponseStatsRunner>>;
/**
* Get top runners by track time
* Returns the top ten fastest track times (with their runner and the runner's group).
* @returns ResponseStatsRunner
* @throws ApiError
*/
static statsControllerGetTopRunnersByTrackTime(): Promise<Array<ResponseStatsRunner>>;
/**
* Get top teams by distance
* Returns the top ten teams by distance.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDistance(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top teams by donations
* Returns the top ten teams by donations.
* @returns ResponseStatsTeam
* @throws ApiError
*/
static statsControllerGetTopTeamsByDonations(): Promise<Array<ResponseStatsTeam>>;
/**
* Get top orgs by distance
* Returns the top ten organizations by distance.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDistance(): Promise<Array<ResponseStatsOrgnisation>>;
/**
* Get top orgs by donations
* Returns the top ten organizations by donations.
* @returns ResponseStatsOrgnisation
* @throws ApiError
*/
static statsControllerGetTopOrgsByDonations(): Promise<Array<ResponseStatsOrgnisation>>;
}