guildwars2-ts/dist/apis/homestead/homestead.d.ts

GuildWars 2 API Wrapper in Typescript

import type { z } from 'zod';
import { ApiBase } from '../../base/apiBase';
import { HomesteadDecorationsCategoriesDTO, HomesteadDecorationsDTO, HomesteadGlyphsDTO } from '../../models';
import { numberArrayType, stringArrayType } from '../v2apiUtils';
/**
 * /v2/homestead Api
 */
export declare class HomesteadApi extends ApiBase {
    /**
     * Returns information about all available homestead decorations.
     */
    getDecorations(): Promise<z.infer<typeof numberArrayType>>;
    /**
     * Returns information about all available homestead decorations.
     *
     * @param ids - List of decoration ids
     */
    getDecorations(ids: number[]): Promise<z.infer<typeof HomesteadDecorationsDTO>>;
    /**
     * Returns information about all categories for homestead decorations.
     */
    getCategories(): Promise<z.infer<typeof numberArrayType>>;
    /**
     * Returns information about all categories for homestead decorations.
     *
     * @param ids - List of decoration category ids
     */
    getCategories(ids: number[]): Promise<z.infer<typeof HomesteadDecorationsCategoriesDTO>>;
    /**
     * Returns information about all available homestead glyphs.
     */
    getGlyphs(): Promise<z.infer<typeof stringArrayType>>;
    /**
     * Returns information about all available homestead glyphs.
     *
     * @param ids - List of glyph ids
     */
    getGlyphs(ids: string[]): Promise<z.infer<typeof HomesteadGlyphsDTO>>;
}