valorant-api-types
Version:
A collection of documented endpoints and return types for the unofficial Valorant API
220 lines (219 loc) • 7.78 kB
TypeScript
import { z } from 'zod';
export declare const settingsEndpoint: {
readonly name: "Settings";
readonly description: "Get a list of client settings";
readonly category: "Local Endpoints";
readonly type: "local";
readonly suffix: "player-preferences/v1/data-json/Ares.PlayerSettings";
readonly riotRequirements: {
readonly localAuth: true;
};
readonly responses: {
readonly '200': z.ZodObject<{
data: z.ZodObject<{
actionMappings: z.ZodArray<z.ZodObject<{
alt: z.ZodBoolean;
bindIndex: z.ZodNumber;
characterName: z.ZodString;
cmd: z.ZodBoolean;
ctrl: z.ZodBoolean;
key: z.ZodString;
name: z.ZodString;
shift: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}, {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}>, "many">;
axisMappings: z.ZodArray<z.ZodUnknown, "many">;
boolSettings: z.ZodArray<z.ZodObject<{
settingEnum: z.ZodString;
value: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
value: boolean;
settingEnum: string;
}, {
value: boolean;
settingEnum: string;
}>, "many">;
floatSettings: z.ZodArray<z.ZodObject<{
settingEnum: z.ZodString;
value: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
value: number;
settingEnum: string;
}, {
value: number;
settingEnum: string;
}>, "many">;
intSettings: z.ZodArray<z.ZodObject<{
settingEnum: z.ZodString;
value: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
value: number;
settingEnum: string;
}, {
value: number;
settingEnum: string;
}>, "many">;
roamingSetttingsVersion: z.ZodNumber;
settingsProfiles: z.ZodArray<z.ZodUnknown, "many">;
stringSettings: z.ZodArray<z.ZodObject<{
settingEnum: z.ZodString;
value: z.ZodString;
}, "strip", z.ZodTypeAny, {
value: string;
settingEnum: string;
}, {
value: string;
settingEnum: string;
}>, "many">;
}, "strip", z.ZodTypeAny, {
actionMappings: {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}[];
axisMappings: unknown[];
boolSettings: {
value: boolean;
settingEnum: string;
}[];
floatSettings: {
value: number;
settingEnum: string;
}[];
intSettings: {
value: number;
settingEnum: string;
}[];
roamingSetttingsVersion: number;
settingsProfiles: unknown[];
stringSettings: {
value: string;
settingEnum: string;
}[];
}, {
actionMappings: {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}[];
axisMappings: unknown[];
boolSettings: {
value: boolean;
settingEnum: string;
}[];
floatSettings: {
value: number;
settingEnum: string;
}[];
intSettings: {
value: number;
settingEnum: string;
}[];
roamingSetttingsVersion: number;
settingsProfiles: unknown[];
stringSettings: {
value: string;
settingEnum: string;
}[];
}>;
modified: z.ZodNumber;
type: z.ZodLiteral<"Ares.PlayerSettings">;
}, "strip", z.ZodTypeAny, {
type: "Ares.PlayerSettings";
data: {
actionMappings: {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}[];
axisMappings: unknown[];
boolSettings: {
value: boolean;
settingEnum: string;
}[];
floatSettings: {
value: number;
settingEnum: string;
}[];
intSettings: {
value: number;
settingEnum: string;
}[];
roamingSetttingsVersion: number;
settingsProfiles: unknown[];
stringSettings: {
value: string;
settingEnum: string;
}[];
};
modified: number;
}, {
type: "Ares.PlayerSettings";
data: {
actionMappings: {
shift: boolean;
name: string;
key: string;
alt: boolean;
bindIndex: number;
characterName: string;
cmd: boolean;
ctrl: boolean;
}[];
axisMappings: unknown[];
boolSettings: {
value: boolean;
settingEnum: string;
}[];
floatSettings: {
value: number;
settingEnum: string;
}[];
intSettings: {
value: number;
settingEnum: string;
}[];
roamingSetttingsVersion: number;
settingsProfiles: unknown[];
stringSettings: {
value: string;
settingEnum: string;
}[];
};
modified: number;
}>;
};
};
export type SettingsResponse = z.input<typeof settingsEndpoint.responses['200']>;