battlenet-api-types
Version:
Typescript interfaces for Blizzard's Battle.net API
109 lines (100 loc) • 2.35 kB
text/typescript
/**
* @categoryDescription Connected Realm API
* Connected Realm API Return Types
* @module
*/
import { APISearch, APISearchResult, hrefStruct, linksStruct, refStruct, regionedNameStruct } from "../shared";
/**
* Connected Realms Index
*
* /data/wow/connected-realm/index
* @category Connected Realm API
*/
export interface APIConnectedRealmsIndex {
_links: linksStruct;
connected_realms: refStruct[];
}
/**
* Connected Realm
*
* /data/wow/connected-realm/{connectedRealmId}
* @category Connected Realm API
*/
export interface APIConnectedRealm {
_links: linksStruct;
id: number;
has_queue?: boolean;
status?: {
type?: string;
name?: string;
}
population?: {
type?: string;
name?: string;
}
realms?: APIConnectedRealmItem[];
mythic_leaderboards?: hrefStruct;
auctions?: hrefStruct;
}
/**
* Individual realm from @see APIConnectedRealm
* @category Connected Realm API
*/
export interface APIConnectedRealmItem {
id: number;
region: refStruct;
connected_realm: hrefStruct;
name: string;
category?: string;
locale?: string;
timezone?: string;
type?: {
type?: string;
name?: string;
}
is_tournament?: boolean;
slug: string;
}
/**
* Connected Realm Search
*
* /data/wow/search/connected-realm
* @category Connected Realm API
*/
export interface APIConnectedRealmSearch extends APISearch {
results: APIConnectedRealmSearchItem[];
}
/**
* @category Connected Realm API
*/
export interface APIConnectedRealmSearchItem extends APISearchResult {
data: {
realms: {
is_tournament: boolean;
timezone: string;
name: regionedNameStruct;
id: number;
region: {
name: regionedNameStruct;
id: number;
}
category: regionedNameStruct;
locale: string;
type: {
name: regionedNameStruct;
type: string;
}
slug: string;
}[]
id: number;
has_queue: boolean;
status: {
name: regionedNameStruct;
type: string;
}
population: {
name: regionedNameStruct;
type: string;
}
}
}