UNPKG

@cfwest/api-client

Version:

Unofficial CrossFire West ApiClient implementation.

48 lines (47 loc) 1.53 kB
import { AchievementsApiModule, RankingApiModule, RibbonsApiModule, UpdatesApiModule, UserWeaponsApiModule, WebShopApiModule } from './internal/api-modules'; import { HttpClient } from './internal/http'; /** * This class is the core component to communicate with [CrossFire West](https://crossfire.z8games.com/) Services. */ export declare class ApiClient { /** * Property to access the [[AchievementsApiModule]] */ readonly achievements: AchievementsApiModule; /** * Property to access the [[RankingApiModule]] */ readonly ranking: RankingApiModule; /** * Property to access the [[RibbonsApiModule]] */ readonly ribbons: RibbonsApiModule; /** * Property to access the [[UpdatesApiModule]] */ readonly updates: UpdatesApiModule; /** * Property to access the [[UserWeaponsApiModule]] */ readonly userWeapons: UserWeaponsApiModule; /** * Property to access the [[WebShopApiModule]] */ readonly webshop: WebShopApiModule; /** * Constructor to initiale an [[ApiClient]] instance. * @param options Optional options to configure the [[ApiClient]] */ constructor(options?: ApiClientOptions); private mergeConstructorOptions; private createApiModuleOptions; } /** * Options to modify [[ApiClient]]s behavior. */ export interface ApiClientOptions { /** * Specify the [[HttpClient]] implementation to use. */ httpClient: HttpClient; }