guildwars2-ts
Version:
GuildWars 2 API Wrapper in Typescript
156 lines (155 loc) • 7.15 kB
TypeScript
import { z } from 'zod';
/**
* /v2/pvp/seasons definition.
*/
export declare const PvPSeasonDTO: z.ZodArray<z.ZodObject<{
/** The season's UUID. */
id: z.ZodString;
/** The season's name. */
name: z.ZodString;
/** ISO timestamp for season start. Missing in early seasons. */
start: z.ZodOptional<z.ZodString>;
/** ISO timestamp for season end. Missing in early seasons. */
end: z.ZodOptional<z.ZodString>;
/** Whether the season is currently active. */
active: z.ZodBoolean;
/** A list of divisions. */
divisions: z.ZodArray<z.ZodObject<{
/** The division's name. */
name: z.ZodString;
/** Flags applying to the division. */
flags: z.ZodArray<z.ZodEnum<{
Repeatable: "Repeatable";
CanLosePoints: "CanLosePoints";
CanLoseTiers: "CanLoseTiers";
}>>;
/** Path to the large icon. */
large_icon: z.ZodString;
/** Path to the small icon. */
small_icon: z.ZodString;
/** Path to the pip icon. */
pip_icon: z.ZodString;
/** A list of tiers. */
tiers: z.ZodArray<z.ZodObject<{
/** The number of pipes contained in each tier. */
points: z.ZodNumber;
}, z.core.$strict>>;
}, z.core.$strict>>;
/** Contains details about the season's ranks */
ranks: z.ZodOptional<z.ZodArray<z.ZodObject<{
/** The rank's name. */
name: z.ZodString;
/** The rank's description. */
description: z.ZodString;
/** The full icon URL. */
icon: z.ZodString;
/** The full URL for the rank's overlay icon. */
overlay: z.ZodString;
/** The full URL for a small variant of the rank's overlay icon. */
overlay_small: z.ZodString;
/** The tiers of the rank. */
tiers: z.ZodArray<z.ZodObject<{
/** The minimum PvP rating required for the tier. */
rating: z.ZodNumber;
}, z.core.$strict>>;
}, z.core.$strict>>>;
/** Contains details on the current leaderboards. */
leaderboards: z.ZodObject<{
/** The leaderboard ladder. Missing in early seasons. */
ladder: z.ZodOptional<z.ZodObject<{
/** The ladder settings. */
settings: z.ZodObject<{
/** Setting name. NOTE: Broken, always empty. */
name: z.ZodString;
/** Duration setting. NOTE: Broken, always null. Supposed to be a number. */
duration: z.ZodNull;
/** Indicates the primary scoring component. */
scoring: z.ZodString;
/** The ladder tiers. */
tiers: z.ZodArray<z.ZodObject<{
/** Two numbers, a maximum, followed by minimum. */
range: z.ZodArray<z.ZodNumber>;
}, z.core.$strict>>;
}, z.core.$strict>;
/** Array used as reference to select player/guild scoring method. */
scorings: z.ZodArray<z.ZodObject<{
/** The id for this scoring method, used as a reference in other endpoints. */
id: z.ZodString;
/** Which variable type the content is saved as. */
type: z.ZodString;
/** Description of the scoring method (if any). */
description: z.ZodString;
/** Should represent the scoring method, such as "wins", "losses", and "skill rating". */
name: z.ZodString;
/** Will describe how the scoring is ordered. */
ordering: z.ZodString;
}, z.core.$strict>>;
}, z.core.$strict>>;
/** The leaderboard guild. Only present for early seasons. */
guild: z.ZodOptional<z.ZodObject<{
/** The ladder settings. */
settings: z.ZodObject<{
/** Setting name. NOTE: Broken, always empty. */
name: z.ZodString;
/** Duration setting. NOTE: Broken, always null. Supposed to be a number. */
duration: z.ZodNull;
/** Indicates the primary scoring component. */
scoring: z.ZodString;
/** The ladder tiers. */
tiers: z.ZodArray<z.ZodObject<{
/** The tier color. */
color: z.ZodString;
/** The tier type. */
type: z.ZodString;
/** The tier name. */
name: z.ZodString;
/** Two numbers, a maximum, followed by minimum. */
range: z.ZodArray<z.ZodNumber>;
}, z.core.$strict>>;
}, z.core.$strict>;
/** Array used as reference to select player/guild scoring method. */
scorings: z.ZodArray<z.ZodObject<{
/** The id for this scoring method, used as a reference in other endpoints. */
id: z.ZodString;
/** Which variable type the content is saved as. */
type: z.ZodString;
/** Description of the scoring method (if any). */
description: z.ZodString;
/** Should represent the scoring method, such as "wins", "losses", and "skill rating". */
name: z.ZodString;
/** Will describe how the scoring is ordered. */
ordering: z.ZodString;
}, z.core.$strict>>;
}, z.core.$strict>>;
/** The leaderboard guild. Only present for early seasons. */
legendary: z.ZodOptional<z.ZodObject<{
/** The ladder settings. */
settings: z.ZodObject<{
/** Setting name. NOTE: Broken, always empty. */
name: z.ZodString;
/** Duration setting. NOTE: Broken, always null. Supposed to be a number. */
duration: z.ZodNull;
/** Indicates the primary scoring component. */
scoring: z.ZodString;
/** The ladder tiers. */
tiers: z.ZodArray<z.ZodObject<{
/** Two numbers, a maximum, followed by minimum. */
range: z.ZodArray<z.ZodNumber>;
}, z.core.$strict>>;
}, z.core.$strict>;
/** Array used as reference to select player/guild scoring method. */
scorings: z.ZodArray<z.ZodObject<{
/** The id for this scoring method, used as a reference in other endpoints. */
id: z.ZodString;
/** Which variable type the content is saved as. */
type: z.ZodString;
/** Description of the scoring method (if any). */
description: z.ZodString;
/** Should represent the scoring method, such as "wins", "losses", and "skill rating". */
name: z.ZodString;
/** Will describe how the scoring is ordered. */
ordering: z.ZodString;
}, z.core.$strict>>;
}, z.core.$strict>>;
}, z.core.$strict>;
}, z.core.$strict>>;