bungie-net-core
Version:
An easy way to interact with the Bungie.net API
45 lines (44 loc) • 2 kB
TypeScript
/**
* Bungie.Net API
* These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
*
* Contact: support@bungie.com
*
* NOTE: This class is auto generated by the bungie-net-core code generator program
* Repository: {@link https://github.com/owens1127/bungie-net-core}
* Do not edit these files manually.
*/
import { BungieHttpProtocol } from './..';
import { BungieNetResponse } from '../interfaces/BungieNetResponse';
import { CoreSettingsConfiguration } from '../models/Common/Models/CoreSettingsConfiguration';
import { CoreSystem } from '../models/Common/Models/CoreSystem';
import { GlobalAlert } from '../models/GlobalAlert';
/**
* List of available localization cultures
* @see {@link https://bungie-net.github.io/#.GetAvailableLocales}
*/
export declare function getAvailableLocales(http: BungieHttpProtocol): Promise<BungieNetResponse<{
[key: string]: string;
}>>;
/**
* Get the common settings used by the Bungie.Net environment.
* @see {@link https://bungie-net.github.io/#.GetCommonSettings}
*/
export declare function getCommonSettings(http: BungieHttpProtocol): Promise<BungieNetResponse<CoreSettingsConfiguration>>;
/**
* Get the user-specific system overrides that should be respected alongside common
* systems.
* @see {@link https://bungie-net.github.io/#.GetUserSystemOverrides}
*/
export declare function getUserSystemOverrides(http: BungieHttpProtocol): Promise<BungieNetResponse<{
[key: string]: CoreSystem;
}>>;
/**
* Gets any active global alert for display in the forum banners, help pages, etc.
* Usually used for DOC alerts.
* @see {@link https://bungie-net.github.io/#.GetGlobalAlerts}
*/
export declare function getGlobalAlerts(http: BungieHttpProtocol, params: {
/** Determines whether Streaming Alerts are included in results */
includestreaming?: boolean;
}): Promise<BungieNetResponse<GlobalAlert[]>>;