valorant-api-types
Version:
A collection of documented endpoints and return types for the unofficial Valorant API
554 lines (553 loc) • 22.1 kB
TypeScript
import { z } from 'zod';
export declare const refreshCompetitiveTierEndpoint: {
readonly name: "Refresh Competitive Tier";
readonly description: "Refresh the competitive tier of the specified player";
readonly queryName: "Party_RefreshCompetitiveTier";
readonly category: "Party Endpoints";
readonly type: "glz";
readonly method: "POST";
readonly suffix: "parties/v1/parties/{party id}/members/{puuid}/refreshCompetitiveTier";
readonly riotRequirements: {
readonly token: true;
readonly entitlement: true;
readonly clientVersion: true;
readonly clientPlatform: true;
};
readonly responses: {
readonly '200': z.ZodObject<{
ID: z.ZodString;
MUCName: z.ZodString;
VoiceRoomID: z.ZodString;
Version: z.ZodNumber;
ClientVersion: z.ZodString;
Members: z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
CompetitiveTier: z.ZodNumber;
PlayerIdentity: z.ZodObject<{
Subject: z.ZodString;
PlayerCardID: z.ZodString;
PlayerTitleID: z.ZodString;
AccountLevel: z.ZodNumber;
PreferredLevelBorderID: z.ZodUnion<[z.ZodString, z.ZodLiteral<"">]>;
Incognito: z.ZodBoolean;
HideAccountLevel: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}, {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
}>;
SeasonalBadgeInfo: z.ZodNull;
IsOwner: z.ZodOptional<z.ZodBoolean>;
QueueEligibleRemainingAccountLevels: z.ZodNumber;
Pings: z.ZodArray<z.ZodObject<{
Ping: z.ZodNumber;
GamePodID: z.ZodString;
}, "strip", z.ZodTypeAny, {
Ping: number;
GamePodID: string;
}, {
Ping: number;
GamePodID: string;
}>, "many">;
IsReady: z.ZodBoolean;
IsModerator: z.ZodBoolean;
UseBroadcastHUD: z.ZodBoolean;
PlatformType: z.ZodLiteral<"PC">;
}, "strip", z.ZodTypeAny, {
IsOwner?: boolean | undefined;
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: null;
QueueEligibleRemainingAccountLevels: number;
Pings: {
Ping: number;
GamePodID: string;
}[];
IsReady: boolean;
IsModerator: boolean;
UseBroadcastHUD: boolean;
PlatformType: "PC";
}, {
IsOwner?: boolean | undefined;
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: null;
QueueEligibleRemainingAccountLevels: number;
Pings: {
Ping: number;
GamePodID: string;
}[];
IsReady: boolean;
IsModerator: boolean;
UseBroadcastHUD: boolean;
PlatformType: "PC";
}>, "many">;
State: z.ZodString;
PreviousState: z.ZodString;
StateTransitionReason: z.ZodString;
Accessibility: z.ZodUnion<[z.ZodLiteral<"OPEN">, z.ZodLiteral<"CLOSED">]>;
CustomGameData: z.ZodObject<{
Settings: z.ZodObject<{
Map: z.ZodString;
Mode: z.ZodString;
UseBots: z.ZodBoolean;
GamePod: z.ZodString;
GameRules: z.ZodNullable<z.ZodObject<{
AllowGameModifiers: z.ZodOptional<z.ZodEffects<z.ZodString, boolean, string>>;
IsOvertimeWinByTwo: z.ZodOptional<z.ZodEffects<z.ZodString, boolean, string>>;
PlayOutAllRounds: z.ZodOptional<z.ZodEffects<z.ZodString, boolean, string>>;
SkipMatchHistory: z.ZodOptional<z.ZodEffects<z.ZodString, boolean, string>>;
TournamentMode: z.ZodOptional<z.ZodEffects<z.ZodString, boolean, string>>;
}, "strip", z.ZodTypeAny, {
AllowGameModifiers?: boolean | undefined;
IsOvertimeWinByTwo?: boolean | undefined;
PlayOutAllRounds?: boolean | undefined;
SkipMatchHistory?: boolean | undefined;
TournamentMode?: boolean | undefined;
}, {
AllowGameModifiers?: string | undefined;
IsOvertimeWinByTwo?: string | undefined;
PlayOutAllRounds?: string | undefined;
SkipMatchHistory?: string | undefined;
TournamentMode?: string | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: boolean | undefined;
IsOvertimeWinByTwo?: boolean | undefined;
PlayOutAllRounds?: boolean | undefined;
SkipMatchHistory?: boolean | undefined;
TournamentMode?: boolean | undefined;
} | null;
}, {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: string | undefined;
IsOvertimeWinByTwo?: string | undefined;
PlayOutAllRounds?: string | undefined;
SkipMatchHistory?: string | undefined;
TournamentMode?: string | undefined;
} | null;
}>;
Membership: z.ZodObject<{
teamOne: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
teamTwo: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
teamSpectate: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
teamOneCoaches: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
teamTwoCoaches: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
}, {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
}>;
MaxPartySize: z.ZodNumber;
AutobalanceEnabled: z.ZodBoolean;
AutobalanceMinPlayers: z.ZodNumber;
HasRecoveryData: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Settings: {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: boolean | undefined;
IsOvertimeWinByTwo?: boolean | undefined;
PlayOutAllRounds?: boolean | undefined;
SkipMatchHistory?: boolean | undefined;
TournamentMode?: boolean | undefined;
} | null;
};
Membership: {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
};
MaxPartySize: number;
AutobalanceEnabled: boolean;
AutobalanceMinPlayers: number;
HasRecoveryData: boolean;
}, {
Settings: {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: string | undefined;
IsOvertimeWinByTwo?: string | undefined;
PlayOutAllRounds?: string | undefined;
SkipMatchHistory?: string | undefined;
TournamentMode?: string | undefined;
} | null;
};
Membership: {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
};
MaxPartySize: number;
AutobalanceEnabled: boolean;
AutobalanceMinPlayers: number;
HasRecoveryData: boolean;
}>;
MatchmakingData: z.ZodObject<{
QueueID: z.ZodString;
PreferredGamePods: z.ZodArray<z.ZodString, "many">;
SkillDisparityRRPenalty: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
QueueID: string;
PreferredGamePods: string[];
SkillDisparityRRPenalty: number;
}, {
QueueID: string;
PreferredGamePods: string[];
SkillDisparityRRPenalty: number;
}>;
Invites: z.ZodNull;
Requests: z.ZodArray<z.ZodUnknown, "many">;
QueueEntryTime: z.ZodEffects<z.ZodString, Date, string>;
ErrorNotification: z.ZodObject<{
ErrorType: z.ZodString;
ErroredPlayers: z.ZodNullable<z.ZodArray<z.ZodObject<{
Subject: z.ZodString;
}, "strip", z.ZodTypeAny, {
Subject: string;
}, {
Subject: string;
}>, "many">>;
}, "strip", z.ZodTypeAny, {
ErrorType: string;
ErroredPlayers: {
Subject: string;
}[] | null;
}, {
ErrorType: string;
ErroredPlayers: {
Subject: string;
}[] | null;
}>;
RestrictedSeconds: z.ZodNumber;
EligibleQueues: z.ZodArray<z.ZodString, "many">;
QueueIneligibilities: z.ZodArray<z.ZodString, "many">;
CheatData: z.ZodObject<{
GamePodOverride: z.ZodString;
ForcePostGameProcessing: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
GamePodOverride: string;
ForcePostGameProcessing: boolean;
}, {
GamePodOverride: string;
ForcePostGameProcessing: boolean;
}>;
XPBonuses: z.ZodArray<z.ZodUnknown, "many">;
InviteCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
ID: string;
MUCName: string;
VoiceRoomID: string;
Version: number;
ClientVersion: string;
Members: {
IsOwner?: boolean | undefined;
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: null;
QueueEligibleRemainingAccountLevels: number;
Pings: {
Ping: number;
GamePodID: string;
}[];
IsReady: boolean;
IsModerator: boolean;
UseBroadcastHUD: boolean;
PlatformType: "PC";
}[];
State: string;
PreviousState: string;
StateTransitionReason: string;
Accessibility: "OPEN" | "CLOSED";
CustomGameData: {
Settings: {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: boolean | undefined;
IsOvertimeWinByTwo?: boolean | undefined;
PlayOutAllRounds?: boolean | undefined;
SkipMatchHistory?: boolean | undefined;
TournamentMode?: boolean | undefined;
} | null;
};
Membership: {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
};
MaxPartySize: number;
AutobalanceEnabled: boolean;
AutobalanceMinPlayers: number;
HasRecoveryData: boolean;
};
MatchmakingData: {
QueueID: string;
PreferredGamePods: string[];
SkillDisparityRRPenalty: number;
};
Invites: null;
Requests: unknown[];
QueueEntryTime: Date;
ErrorNotification: {
ErrorType: string;
ErroredPlayers: {
Subject: string;
}[] | null;
};
RestrictedSeconds: number;
EligibleQueues: string[];
QueueIneligibilities: string[];
CheatData: {
GamePodOverride: string;
ForcePostGameProcessing: boolean;
};
XPBonuses: unknown[];
InviteCode: string;
}, {
ID: string;
MUCName: string;
VoiceRoomID: string;
Version: number;
ClientVersion: string;
Members: {
IsOwner?: boolean | undefined;
Subject: string;
CompetitiveTier: number;
PlayerIdentity: {
Subject: string;
PlayerCardID: string;
PlayerTitleID: string;
AccountLevel: number;
PreferredLevelBorderID: string;
Incognito: boolean;
HideAccountLevel: boolean;
};
SeasonalBadgeInfo: null;
QueueEligibleRemainingAccountLevels: number;
Pings: {
Ping: number;
GamePodID: string;
}[];
IsReady: boolean;
IsModerator: boolean;
UseBroadcastHUD: boolean;
PlatformType: "PC";
}[];
State: string;
PreviousState: string;
StateTransitionReason: string;
Accessibility: "OPEN" | "CLOSED";
CustomGameData: {
Settings: {
Map: string;
Mode: string;
UseBots: boolean;
GamePod: string;
GameRules: {
AllowGameModifiers?: string | undefined;
IsOvertimeWinByTwo?: string | undefined;
PlayOutAllRounds?: string | undefined;
SkipMatchHistory?: string | undefined;
TournamentMode?: string | undefined;
} | null;
};
Membership: {
teamOne: {
Subject: string;
}[] | null;
teamTwo: {
Subject: string;
}[] | null;
teamSpectate: {
Subject: string;
}[] | null;
teamOneCoaches: {
Subject: string;
}[] | null;
teamTwoCoaches: {
Subject: string;
}[] | null;
};
MaxPartySize: number;
AutobalanceEnabled: boolean;
AutobalanceMinPlayers: number;
HasRecoveryData: boolean;
};
MatchmakingData: {
QueueID: string;
PreferredGamePods: string[];
SkillDisparityRRPenalty: number;
};
Invites: null;
Requests: unknown[];
QueueEntryTime: string;
ErrorNotification: {
ErrorType: string;
ErroredPlayers: {
Subject: string;
}[] | null;
};
RestrictedSeconds: number;
EligibleQueues: string[];
QueueIneligibilities: string[];
CheatData: {
GamePodOverride: string;
ForcePostGameProcessing: boolean;
};
XPBonuses: unknown[];
InviteCode: string;
}>;
};
};
export type RefreshCompetitiveTierResponse = z.input<typeof refreshCompetitiveTierEndpoint.responses['200']>;