guildwars2-ts/dist/apis/misc/continents.d.ts

GuildWars 2 API Wrapper in Typescript

import type { z } from 'zod';
import { ApiBase } from '../../base/apiBase';
import { ContinentsDTO, ContinentsFloorsDTO, ContinentsMapsDTO, ContinentsRegionsDTO } from '../../models';
import { numberArrayType } from '../v2apiUtils';
/**
 * /v2/continents api
 */
export declare class ContinentsApi extends ApiBase {
    /**
     * Returns information about continents, their floors, regions, and maps.
     *
     * NOTE: Refer to the function overload types for usage.
     * Endpoint priority is as follows -> maps > regions > floors > continents > none
     * As such, for example, maps is present, all previous arguments must be of type number
     */
    get(): Promise<z.infer<typeof numberArrayType>>;
    /**
     * Returns information about continents, their floors, regions, and maps.
     *
     * @param continents - Continent ids, or "all"
     */
    get(continents: number[] | 'all'): Promise<z.infer<typeof ContinentsDTO>>;
    /**
     * Returns information about continents, their floors, regions, and maps.
     *
     * @param continents - Continent id.
     * @param floors - Floor ids, or "all".
     */
    get(continents: number, floors: number[] | 'all'): Promise<z.infer<typeof ContinentsFloorsDTO>>;
    /**
     * Returns information about continents, their floors, regions, and maps.
     *
     * @param continents - Continent id.
     * @param floors - Floor id.
     * @param regions - Region ids, or "all".
     */
    get(continents: number, floors: number, regions: number[] | 'all'): Promise<z.infer<typeof ContinentsRegionsDTO>>;
    /**
     * Returns information about continents, their floors, regions, and maps.
     *
     * @param continents - Continent id.
     * @param floors - Floor id.
     * @param regions - Region id.
     * @param maps - Map ids, or "all".
     */
    get(continents: number, floors: number, regions: number, maps: number[] | 'all'): Promise<z.infer<typeof ContinentsMapsDTO>>;
}