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

GuildWars 2 API Wrapper in Typescript

import type { z } from 'zod';
import { ApiBase } from '../../base/apiBase';
import { StoriesDTO, StoriesSeasonsDTO } from '../../models';
import { numberArrayType, stringArrayType } from '../v2apiUtils';
export declare class StoriesApi extends ApiBase {
    /**
     * Returns information about the Story Journal stories; including the personal story and Living World.
     */
    getStories(): Promise<z.infer<typeof numberArrayType>>;
    /**
     * Returns information about the Story Journal stories; including the personal story and Living World.
     *
     * @param ids - List of story ids, or "all"
     */
    getStories(ids: number[] | 'all'): Promise<z.infer<typeof StoriesDTO>>;
    /**
     * Returns information about the Story Journal story seasons; including the personal story and Living World.
     */
    getSeasons(): Promise<z.infer<typeof stringArrayType>>;
    /**
     * Returns information about the Story Journal story seasons; including the personal story and Living World.
     *
     * @param ids - List of season ids, or "all"
     */
    getSeasons(ids: string[] | 'all'): Promise<z.infer<typeof StoriesSeasonsDTO>>;
}