@sports-sdk/sleeper
Version:
A package for interacting with the Sleeper public API
1,094 lines (1,092 loc) • 52.3 kB
text/typescript
import { z } from 'zod';
import { League, SportsSdkClient } from '@sports-sdk/core';
declare const StateSchema: z.ZodObject<{
week: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
season_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<["pre", "post", "regular"]>>>;
season_start_date: z.ZodOptional<z.ZodNullable<z.ZodString>>;
season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
previous_season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
leg: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
league_season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
league_create_season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
display_week: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
week?: number | null | undefined;
season_type?: "pre" | "post" | "regular" | null | undefined;
season_start_date?: string | null | undefined;
season?: string | null | undefined;
previous_season?: string | null | undefined;
leg?: number | null | undefined;
league_season?: string | null | undefined;
league_create_season?: string | null | undefined;
display_week?: number | null | undefined;
}, {
week?: number | null | undefined;
season_type?: "pre" | "post" | "regular" | null | undefined;
season_start_date?: string | null | undefined;
season?: string | null | undefined;
previous_season?: string | null | undefined;
leg?: number | null | undefined;
league_season?: string | null | undefined;
league_create_season?: string | null | undefined;
display_week?: number | null | undefined;
}>;
type State = z.infer<typeof StateSchema>;
declare const UserSchema: z.ZodObject<{
user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
avatar: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
}, "strip", z.ZodTypeAny, {
user_id?: string | null | undefined;
username?: string | null | undefined;
display_name?: string | null | undefined;
avatar?: string | null | undefined;
}, {
user_id?: string | null | undefined;
username?: string | null | undefined;
display_name?: string | null | undefined;
avatar?: string | null | undefined;
}>;
type User = z.infer<typeof UserSchema>;
declare const UserInfoSchema: z.ZodObject<{
user_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
username: z.ZodOptional<z.ZodNullable<z.ZodString>>;
display_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
avatar: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>;
is_owner: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
}, "strip", z.ZodTypeAny, {
user_id?: string | null | undefined;
username?: string | null | undefined;
display_name?: string | null | undefined;
avatar?: string | null | undefined;
metadata?: Record<string, any> | null | undefined;
is_owner?: boolean | null | undefined;
}, {
user_id?: string | null | undefined;
username?: string | null | undefined;
display_name?: string | null | undefined;
avatar?: string | null | undefined;
metadata?: Record<string, any> | null | undefined;
is_owner?: boolean | null | undefined;
}>;
type UserInfo = z.infer<typeof UserInfoSchema>;
declare const LeagueInfoSchema: z.ZodObject<{
total_rosters: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
status: z.ZodOptional<z.ZodNullable<z.ZodEnum<["pre_draft", "drafting", "in_season", "complete"]>>>;
sport: z.ZodOptional<z.ZodNullable<z.ZodString>>;
settings: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>;
season_type: z.ZodOptional<z.ZodNullable<z.ZodEnum<["pre", "post", "regular"]>>>;
season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
scoring_settings: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>;
roster_positions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>;
previous_league_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
league_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
draft_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
avatar: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
}, "strip", z.ZodTypeAny, {
status?: "pre_draft" | "drafting" | "in_season" | "complete" | null | undefined;
season_type?: "pre" | "post" | "regular" | null | undefined;
season?: string | null | undefined;
avatar?: string | null | undefined;
total_rosters?: number | null | undefined;
sport?: string | null | undefined;
settings?: Record<string, any> | null | undefined;
scoring_settings?: Record<string, any> | null | undefined;
roster_positions?: string[] | null | undefined;
previous_league_id?: string | null | undefined;
name?: string | null | undefined;
league_id?: string | null | undefined;
draft_id?: string | null | undefined;
}, {
status?: "pre_draft" | "drafting" | "in_season" | "complete" | null | undefined;
season_type?: "pre" | "post" | "regular" | null | undefined;
season?: string | null | undefined;
avatar?: string | null | undefined;
total_rosters?: number | null | undefined;
sport?: string | null | undefined;
settings?: Record<string, any> | null | undefined;
scoring_settings?: Record<string, any> | null | undefined;
roster_positions?: string[] | null | undefined;
previous_league_id?: string | null | undefined;
name?: string | null | undefined;
league_id?: string | null | undefined;
draft_id?: string | null | undefined;
}>;
type LeagueInfo = z.infer<typeof LeagueInfoSchema>;
declare const RosterSettingsSchema: z.ZodObject<{
wins: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
waiver_position: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
waiver_budget_used: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
total_moves: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
ties: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
losses: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
fpts: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
}, {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
}>;
type RosterSettings = z.infer<typeof RosterSettingsSchema>;
declare const RosterSchema: z.ZodObject<{
taxi: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>;
starters: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>;
settings: z.ZodOptional<z.ZodNullable<z.ZodObject<{
wins: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
waiver_position: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
waiver_budget_used: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
total_moves: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
ties: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
losses: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
fpts: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
}, {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
}>>>;
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
reserve: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>>;
players: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>;
player_map: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
owner_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
league_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
keepers: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>>;
co_owners: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>>;
}, "strip", z.ZodTypeAny, {
metadata?: Record<string, any> | null | undefined;
settings?: {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
} | null | undefined;
league_id?: string | null | undefined;
taxi?: any[] | null | undefined;
starters?: any[] | null | undefined;
roster_id?: number | null | undefined;
reserve?: any[] | null | undefined;
players?: any[] | null | undefined;
player_map?: Record<string, any> | null | undefined;
owner_id?: string | null | undefined;
keepers?: string[] | null | undefined;
co_owners?: string[] | null | undefined;
}, {
metadata?: Record<string, any> | null | undefined;
settings?: {
wins?: number | null | undefined;
waiver_position?: number | null | undefined;
waiver_budget_used?: number | null | undefined;
total_moves?: number | null | undefined;
ties?: number | null | undefined;
losses?: number | null | undefined;
fpts?: number | null | undefined;
} | null | undefined;
league_id?: string | null | undefined;
taxi?: any[] | null | undefined;
starters?: any[] | null | undefined;
roster_id?: number | null | undefined;
reserve?: any[] | null | undefined;
players?: any[] | null | undefined;
player_map?: Record<string, any> | null | undefined;
owner_id?: string | null | undefined;
keepers?: string[] | null | undefined;
co_owners?: string[] | null | undefined;
}>;
type Roster = z.infer<typeof RosterSchema>;
declare const MatchupSchema: z.ZodObject<{
starters: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>;
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
players: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodAny]>, "many">>>;
matchup_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
points: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
custom_points: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
}, "strip", z.ZodTypeAny, {
starters?: any[] | null | undefined;
roster_id?: number | null | undefined;
players?: any[] | null | undefined;
matchup_id?: number | null | undefined;
points?: number | null | undefined;
custom_points?: number | null | undefined;
}, {
starters?: any[] | null | undefined;
roster_id?: number | null | undefined;
players?: any[] | null | undefined;
matchup_id?: number | null | undefined;
points?: number | null | undefined;
custom_points?: number | null | undefined;
}>;
type Matchup = z.infer<typeof MatchupSchema>;
declare const PlayoffMatchupSchema: z.ZodObject<{
r: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
m: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
t1: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodObject<{
w: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
w: number;
}, {
w: number;
}>]>>>;
t2: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodNumber, z.ZodObject<{
l: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
l: number;
}, {
l: number;
}>]>>>;
w: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
l: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
t1_from: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodObject<{
w: z.ZodOptional<z.ZodNumber>;
l: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
w?: number | undefined;
l?: number | undefined;
}, {
w?: number | undefined;
l?: number | undefined;
}>>>>;
t2_from: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodObject<{
w: z.ZodOptional<z.ZodNumber>;
l: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
w?: number | undefined;
l?: number | undefined;
}, {
w?: number | undefined;
l?: number | undefined;
}>>>>;
p: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodNumber>>>;
}, "strip", z.ZodTypeAny, {
w?: number | null | undefined;
l?: number | null | undefined;
r?: number | null | undefined;
m?: number | null | undefined;
t1?: number | {
w: number;
} | null | undefined;
t2?: number | {
l: number;
} | null | undefined;
t1_from?: {
w?: number | undefined;
l?: number | undefined;
} | null | undefined;
t2_from?: {
w?: number | undefined;
l?: number | undefined;
} | null | undefined;
p?: number | null | undefined;
}, {
w?: number | null | undefined;
l?: number | null | undefined;
r?: number | null | undefined;
m?: number | null | undefined;
t1?: number | {
w: number;
} | null | undefined;
t2?: number | {
l: number;
} | null | undefined;
t1_from?: {
w?: number | undefined;
l?: number | undefined;
} | null | undefined;
t2_from?: {
w?: number | undefined;
l?: number | undefined;
} | null | undefined;
p?: number | null | undefined;
}>;
type PlayoffMatchup = z.infer<typeof PlayoffMatchupSchema>;
declare const DraftPickSchema: z.ZodObject<{
season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
round: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
previous_owner_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
owner_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}, {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}>;
type DraftPick = z.infer<typeof DraftPickSchema>;
declare const WaiverBudgetSchema: z.ZodObject<{
sender: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
receiver: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}, {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}>;
type WaiverBudget = z.infer<typeof WaiverBudgetSchema>;
declare const TransactionPlayerSchema: z.ZodObject<{
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
player: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, "strip", z.ZodTypeAny, {
roster_id?: number | null | undefined;
player?: any;
}, {
roster_id?: number | null | undefined;
player?: any;
}>;
type TransactionPlayer = z.infer<typeof TransactionPlayerSchema>;
declare const TransactionSchema: z.ZodObject<{
type: z.ZodOptional<z.ZodNullable<z.ZodEnum<["trade", "free_agent", "waiver"]>>>;
transaction_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
status_updated: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
settings: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
roster_ids: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
leg: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
drops: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodNumber>, z.ZodArray<z.ZodObject<{
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
player: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, "strip", z.ZodTypeAny, {
roster_id?: number | null | undefined;
player?: any;
}, {
roster_id?: number | null | undefined;
player?: any;
}>, "many">, z.ZodNull]>>>;
draft_picks: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
round: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
previous_owner_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
owner_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}, {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}>, "many">>>;
creator: z.ZodOptional<z.ZodNullable<z.ZodString>>;
created: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
consenter_ids: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodNumber, "many">>>;
adds: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodRecord<z.ZodString, z.ZodNumber>, z.ZodArray<z.ZodObject<{
roster_id: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
player: z.ZodOptional<z.ZodNullable<z.ZodAny>>;
}, "strip", z.ZodTypeAny, {
roster_id?: number | null | undefined;
player?: any;
}, {
roster_id?: number | null | undefined;
player?: any;
}>, "many">, z.ZodNull]>>>;
waiver_budget: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
sender: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
receiver: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
amount: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}, {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}>, "many">>>;
}, "strip", z.ZodTypeAny, {
type?: "trade" | "free_agent" | "waiver" | null | undefined;
status?: string | null | undefined;
leg?: number | null | undefined;
metadata?: Record<string, any> | null | undefined;
settings?: Record<string, any> | null | undefined;
transaction_id?: string | null | undefined;
status_updated?: number | null | undefined;
roster_ids?: number[] | null | undefined;
drops?: Record<string, number> | {
roster_id?: number | null | undefined;
player?: any;
}[] | null | undefined;
draft_picks?: {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}[] | null | undefined;
creator?: string | null | undefined;
created?: number | null | undefined;
consenter_ids?: number[] | null | undefined;
adds?: Record<string, number> | {
roster_id?: number | null | undefined;
player?: any;
}[] | null | undefined;
waiver_budget?: {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}[] | null | undefined;
}, {
type?: "trade" | "free_agent" | "waiver" | null | undefined;
status?: string | null | undefined;
leg?: number | null | undefined;
metadata?: Record<string, any> | null | undefined;
settings?: Record<string, any> | null | undefined;
transaction_id?: string | null | undefined;
status_updated?: number | null | undefined;
roster_ids?: number[] | null | undefined;
drops?: Record<string, number> | {
roster_id?: number | null | undefined;
player?: any;
}[] | null | undefined;
draft_picks?: {
season?: string | null | undefined;
roster_id?: number | null | undefined;
owner_id?: number | null | undefined;
round?: number | null | undefined;
previous_owner_id?: number | null | undefined;
}[] | null | undefined;
creator?: string | null | undefined;
created?: number | null | undefined;
consenter_ids?: number[] | null | undefined;
adds?: Record<string, number> | {
roster_id?: number | null | undefined;
player?: any;
}[] | null | undefined;
waiver_budget?: {
sender?: number | null | undefined;
receiver?: number | null | undefined;
amount?: number | null | undefined;
}[] | null | undefined;
}>;
type Transaction = z.infer<typeof TransactionSchema>;
declare const DraftSettingsSchema: z.ZodObject<{
teams: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_wr: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_te: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_rb: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_qb: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_k: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_flex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_def: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_bn: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
rounds: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
pick_timer: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
}, {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
}>;
type DraftSettings = z.infer<typeof DraftSettingsSchema>;
declare const DraftMetadataSchema: z.ZodObject<{
scoring_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
}, {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
}>;
type DraftMetadata = z.infer<typeof DraftMetadataSchema>;
declare const DraftSchema: z.ZodObject<{
type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
start_time: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
sport: z.ZodOptional<z.ZodNullable<z.ZodString>>;
settings: z.ZodOptional<z.ZodNullable<z.ZodObject<{
teams: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_wr: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_te: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_rb: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_qb: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_k: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_flex: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_def: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
slots_bn: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
rounds: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
pick_timer: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
}, {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
}>>>;
season_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
season: z.ZodOptional<z.ZodNullable<z.ZodString>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
scoring_type: z.ZodOptional<z.ZodNullable<z.ZodString>>;
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
}, {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
}>>>;
league_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
last_picked: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
last_message_time: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
last_message_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
draft_order: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>>>;
slot_to_roster_id: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>>>;
draft_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
creators: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
created: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
type?: string | null | undefined;
status?: string | null | undefined;
season_type?: string | null | undefined;
season?: string | null | undefined;
metadata?: {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
} | null | undefined;
sport?: string | null | undefined;
settings?: {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
} | null | undefined;
league_id?: string | null | undefined;
draft_id?: string | null | undefined;
created?: number | null | undefined;
start_time?: number | null | undefined;
last_picked?: number | null | undefined;
last_message_time?: number | null | undefined;
last_message_id?: string | null | undefined;
draft_order?: Record<string, number> | null | undefined;
slot_to_roster_id?: Record<string, number> | null | undefined;
creators?: Record<string, any> | null | undefined;
}, {
type?: string | null | undefined;
status?: string | null | undefined;
season_type?: string | null | undefined;
season?: string | null | undefined;
metadata?: {
name?: string | null | undefined;
scoring_type?: string | null | undefined;
description?: string | null | undefined;
} | null | undefined;
sport?: string | null | undefined;
settings?: {
teams?: number | null | undefined;
slots_wr?: number | null | undefined;
slots_te?: number | null | undefined;
slots_rb?: number | null | undefined;
slots_qb?: number | null | undefined;
slots_k?: number | null | undefined;
slots_flex?: number | null | undefined;
slots_def?: number | null | undefined;
slots_bn?: number | null | undefined;
rounds?: number | null | undefined;
pick_timer?: number | null | undefined;
} | null | undefined;
league_id?: string | null | undefined;
draft_id?: string | null | undefined;
created?: number | null | undefined;
start_time?: number | null | undefined;
last_picked?: number | null | undefined;
last_message_time?: number | null | undefined;
last_message_id?: string | null | undefined;
draft_order?: Record<string, number> | null | undefined;
slot_to_roster_id?: Record<string, number> | null | undefined;
creators?: Record<string, any> | null | undefined;
}>;
type Draft = z.infer<typeof DraftSchema>;
declare const PlayerDraftMetadataSchema: z.ZodObject<{
team: z.ZodOptional<z.ZodNullable<z.ZodString>>;
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
sport: z.ZodOptional<z.ZodNullable<z.ZodString>>;
position: z.ZodOptional<z.ZodNullable<z.ZodString>>;
player_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
news_updated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
last_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
injury_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
first_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
}, {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
}>;
type PlayerDraftMetadata = z.infer<typeof PlayerDraftMetadataSchema>;
declare const PlayerDraftPickSchema: z.ZodObject<{
player_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
player: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodAny>>>;
picked_by: z.ZodOptional<z.ZodNullable<z.ZodString>>;
roster_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
round: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
draft_slot: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
pick_no: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodObject<{
team: z.ZodOptional<z.ZodNullable<z.ZodString>>;
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
sport: z.ZodOptional<z.ZodNullable<z.ZodString>>;
position: z.ZodOptional<z.ZodNullable<z.ZodString>>;
player_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
number: z.ZodOptional<z.ZodNullable<z.ZodString>>;
news_updated: z.ZodOptional<z.ZodNullable<z.ZodString>>;
last_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
injury_status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
first_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
}, {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
}>>>;
is_keeper: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodBoolean>>>;
draft_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
}, "strip", z.ZodTypeAny, {
metadata?: {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
} | null | undefined;
draft_id?: string | null | undefined;
roster_id?: string | null | undefined;
round?: number | null | undefined;
player?: any;
player_id?: string | null | undefined;
picked_by?: string | null | undefined;
draft_slot?: number | null | undefined;
pick_no?: number | null | undefined;
is_keeper?: boolean | null | undefined;
}, {
metadata?: {
number?: string | null | undefined;
status?: string | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: string | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
} | null | undefined;
draft_id?: string | null | undefined;
roster_id?: string | null | undefined;
round?: number | null | undefined;
player?: any;
player_id?: string | null | undefined;
picked_by?: string | null | undefined;
draft_slot?: number | null | undefined;
pick_no?: number | null | undefined;
is_keeper?: boolean | null | undefined;
}>;
type PlayerDraftPick = z.infer<typeof PlayerDraftPickSchema>;
declare const TrendingPlayerSchema: z.ZodObject<{
player_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
player: z.ZodOptional<z.ZodNullable<z.ZodOptional<z.ZodAny>>>;
count: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
}, "strip", z.ZodTypeAny, {
player?: any;
player_id?: string | null | undefined;
count?: number | null | undefined;
}, {
player?: any;
player_id?: string | null | undefined;
count?: number | null | undefined;
}>;
type TrendingPlayer = z.infer<typeof TrendingPlayerSchema>;
declare const PlayerSchema: z.ZodObject<{
player_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
first_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
last_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
position: z.ZodOptional<z.ZodNullable<z.ZodString>>;
team: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
number: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
height: z.ZodOptional<z.ZodNullable<z.ZodString>>;
weight: z.ZodOptional<z.ZodNullable<z.ZodString>>;
college: z.ZodOptional<z.ZodNullable<z.ZodString>>;
years_exp: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
fantasy_positions: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodArray<z.ZodString, "many">>>>;
depth_chart_position: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
depth_chart_order: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
metadata: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodAny>>>>;
yahoo_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
rotowire_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
espn_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
active: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
latest_news: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodAny>>>;
sport: z.ZodOptional<z.ZodNullable<z.ZodString>>;
full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
birth_date: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
search_rank: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
injury_status: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
injury_body_part: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
injury_notes: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
injury_start_date: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
practice_participation: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
practice_description: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
gsis_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
sportradar_id: z.ZodOptional<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>;
stats_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
fantasy_data_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
rotoworld_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
pff_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
swish_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
pandascore_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
oddsjam_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
dl_trading_id: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodUnion<[z.ZodString, z.ZodNumber]>>>>;
search_first_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
search_last_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
search_full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
hashtag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
news_updated: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodNumber>>>;
birth_city: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
birth_state: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
birth_country: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
high_school: z.ZodOptional<z.ZodNullable<z.ZodNullable<z.ZodString>>>;
}, "strip", z.ZodTypeAny, {
number?: number | null | undefined;
status?: string | null | undefined;
metadata?: Record<string, any> | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: number | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
height?: string | null | undefined;
weight?: string | null | undefined;
college?: string | null | undefined;
years_exp?: number | null | undefined;
fantasy_positions?: string[] | null | undefined;
depth_chart_position?: string | null | undefined;
depth_chart_order?: number | null | undefined;
yahoo_id?: string | number | null | undefined;
rotowire_id?: string | number | null | undefined;
espn_id?: string | number | null | undefined;
active?: boolean | null | undefined;
latest_news?: any;
full_name?: string | null | undefined;
birth_date?: string | null | undefined;
search_rank?: number | null | undefined;
injury_body_part?: string | null | undefined;
injury_notes?: string | null | undefined;
injury_start_date?: string | null | undefined;
practice_participation?: string | null | undefined;
practice_description?: string | null | undefined;
gsis_id?: string | number | null | undefined;
sportradar_id?: string | number | null | undefined;
stats_id?: string | number | null | undefined;
fantasy_data_id?: string | number | null | undefined;
rotoworld_id?: string | number | null | undefined;
pff_id?: string | number | null | undefined;
swish_id?: string | number | null | undefined;
pandascore_id?: string | number | null | undefined;
oddsjam_id?: string | number | null | undefined;
dl_trading_id?: string | number | null | undefined;
search_first_name?: string | null | undefined;
search_last_name?: string | null | undefined;
search_full_name?: string | null | undefined;
hashtag?: string | null | undefined;
birth_city?: string | null | undefined;
birth_state?: string | null | undefined;
birth_country?: string | null | undefined;
high_school?: string | null | undefined;
}, {
number?: number | null | undefined;
status?: string | null | undefined;
metadata?: Record<string, any> | null | undefined;
sport?: string | null | undefined;
team?: string | null | undefined;
position?: string | null | undefined;
player_id?: string | null | undefined;
news_updated?: number | null | undefined;
last_name?: string | null | undefined;
injury_status?: string | null | undefined;
first_name?: string | null | undefined;
height?: string | null | undefined;
weight?: string | null | undefined;
college?: string | null | undefined;
years_exp?: number | null | undefined;
fantasy_positions?: string[] | null | undefined;
depth_chart_position?: string | null | undefined;
depth_chart_order?: number | null | undefined;
yahoo_id?: string | number | null | undefined;
rotowire_id?: string | number | null | undefined;
espn_id?: string | number | null | undefined;
active?: boolean | null | undefined;
latest_news?: any;
full_name?: string | null | undefined;
birth_date?: string | null | undefined;
search_rank?: number | null | undefined;
injury_body_part?: string | null | undefined;
injury_notes?: string | null | undefined;
injury_start_date?: string | null | undefined;
practice_participation?: string | null | undefined;
practice_description?: string | null | undefined;
gsis_id?: string | number | null | undefined;
sportradar_id?: string | number | null | undefined;
stats_id?: string | number | null | undefined;
fantasy_data_id?: string | number | null | undefined;
rotoworld_id?: string | number | null | undefined;
pff_id?: string | number | null | undefined;
swish_id?: string | number | null | undefined;
pandascore_id?: string | number | null | undefined;
oddsjam_id?: string | number | null | undefined;
dl_trading_id?: string | number | null | undefined;
search_first_name?: string | null | undefined;
search_last_name?: string | null | undefined;
search_full_name?: string | null | undefined;
hashtag?: string | null | undefined;
birth_city?: string | null | undefined;
birth_state?: string | null | undefined;
birth_country?: string | null | undefined;
high_school?: string | null | undefined;
}>;
type Player = z.infer<typeof PlayerSchema>;
declare const SleeperClientLeaguesList: readonly [League.NBA, League.NFL, League.EPL, "LALIGA"];
type SleeperClientLeagues = typeof SleeperClientLeaguesList[number];
declare class SleeperClient<S extends SleeperClientLeagues> extends SportsSdkClient {
protected readonly league: S;
readonly leagueMappings: {
[K in S]: string;
};
constructor(league: S);
/**
* Sends a GET request to the specified URL path.
* @param path - The path to append to base URL to send the request to.
* @returns The response data from the API
* @throws Will throw an error if the request fails.
*/
private request;
/**
* Lookup the current state for the sport. The state consists of the current week in the league, season start date, current season, current week, etc.
* @returns The current state of the sport.
*/
stateLookup(): Promise<State>;
/**
* Lookup the user. This call is useful to determine the user ID for a given username. Usernames can change, but user IDs will not.
* @param user - The username to lookup.
* @returns The user details.
*/
userLookup(user: string): Promise<User>;
/**
* Lookup the leagues a user is in.
* @param user - The user to lookup leagues for.
* @param season - The season to lookup leagues for.
* @returns The user's leagues.
*/
getUserLeagues({ user, season }: {
season: string;
user: string;
}): Promise<Array<LeagueInfo>>;
/**
* Lookup the details for a specific league.
* @param league - The league to lookup.
* @returns The league details.
*/
getLeague(league: string): Promise<LeagueInfo>;
/**
* Get rosters for a specified league.
* @param league - The league to get rosters for.
* @returns The user's roster for the specified league.
*/
getLeagueRosters(league: string): Promise<Array<Roster>>;
/**
* Get a list of users for a specified league.
* @param league - The league to get users for.
* @returns The list of users for the specified league.
*/
getLeagueUsers(league: string): Promise<Array<UserInfo>>;
/**
* Get the matchup for a specified week in a specified league.
* @param league - The league to get matchups for.
* @param week - The week to get matchups for.
* @returns The user's matchup for the specified week.
*/
getLeagueMatchups({ league, week }: {
league: string;
week: number;
}): Promise<Array<Matchup>>;
/**
* Get a list describing the playoff bracket for a specified league.
* @param league - The league to get the playoff bracket for.
* @param bracket - The bracket to get the playoff bracket for.
* @returns The playoff bracket for the specified league.
*/
getLeaguePlayoffBracket({ league, bracket }: {
bracket: string;
league: string;
}): Promise<Array<PlayoffMatchup>>;
/**
* Get a list of all free agent transactions, waivers and trades for a specific league for a particular round.
* @param league - The league to get transactions for.
* @param week - The week to get transactions for.
* @returns The list of transactions for the specified user's roster.
*/
getLeagueTransactions({ league, week }: {
league: string;
week: number;
}): Promise<Array<Transaction>>;
/**
* Get a list of traded picks in a specific league.
* @param league - The league to get traded picks for.
* @returns The list of traded picks the user currently owns in the specified league.
*/
getLeagueTradedPicks(league: string): Promise<Array<DraftPick>>;
/**
* Get a list of details for all drafts for a specific user in season, including format and status.
* @param user - The user to get drafts for.
* @param sport - The sport to get drafts for.
* @returns The list of details for all drafts for the specified user.
*/
getUserDraft({ user, season }: {
season: string;
user: string;
}): Promise<Array<Draft>>;
/**
* Get a list of details for all drafts for a specified league, including format and status.
* @param league - The league to get drafts for.
* @returns The list of details for all drafts for the specified league.
*/
getLeagueDrafts(league: string): Promise<Array<Draft>>;
/**
* Get the details of a specific draft, including format, sta