valorant-api-types
Version:
A collection of documented endpoints and return types for the unofficial Valorant API
439 lines (438 loc) • 17.9 kB
TypeScript
import { z } from 'zod';
export declare const activateContractEndpoint: {
readonly name: "Activate Contract";
readonly description: "Activate a specific contract by ID";
readonly queryName: "Contracts_Activate";
readonly category: "Contract Endpoints";
readonly type: "pd";
readonly suffix: "contracts/v1/contracts/{puuid}/special/{contract id}";
readonly method: "POST";
readonly variables: Map<string, z.ZodString>;
readonly riotRequirements: {
readonly token: true;
readonly entitlement: true;
readonly clientVersion: true;
readonly clientPlatform: true;
};
readonly responses: {
readonly '200': z.ZodObject<{
Version: z.ZodNumber;
Subject: z.ZodString;
Contracts: z.ZodArray<z.ZodObject<{
ContractDefinitionID: z.ZodString;
ContractProgression: z.ZodObject<{
TotalProgressionEarned: z.ZodNumber;
TotalProgressionEarnedVersion: z.ZodNumber;
HighestRewardedLevel: z.ZodRecord<z.ZodString, z.ZodObject<{
Amount: z.ZodNumber;
Version: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
Version: number;
Amount: number;
}, {
Version: number;
Amount: number;
}>>;
}, "strip", z.ZodTypeAny, {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
}, {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
}>;
ProgressionLevelReached: z.ZodNumber;
ProgressionTowardsNextLevel: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
ContractDefinitionID: string;
ContractProgression: {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
};
ProgressionLevelReached: number;
ProgressionTowardsNextLevel: number;
}, {
ContractDefinitionID: string;
ContractProgression: {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
};
ProgressionLevelReached: number;
ProgressionTowardsNextLevel: number;
}>, "many">;
ProcessedMatches: z.ZodArray<z.ZodObject<{
ID: z.ZodString;
StartTime: z.ZodEffects<z.ZodNumber, Date, number>;
XPGrants: z.ZodNullable<z.ZodObject<{
GamePlayed: z.ZodNumber;
GameWon: z.ZodNumber;
RoundPlayed: z.ZodNumber;
RoundWon: z.ZodNumber;
Missions: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
Modifier: z.ZodObject<{
Value: z.ZodNumber;
BaseMultiplierValue: z.ZodNumber;
Modifiers: z.ZodArray<z.ZodObject<{
Value: z.ZodNumber;
Name: z.ZodEnum<["RESTRICTIONS_XP", "PREMIUM_CONTRACT_XP"]>;
BaseOnly: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}, {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}>, "many">;
}, "strip", z.ZodTypeAny, {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
}, {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
}>;
NumAFKRounds: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
}, {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
}>>;
RewardGrants: z.ZodNullable<z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>>;
MissionDeltas: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
ID: z.ZodString;
Objectives: z.ZodRecord<z.ZodString, z.ZodNumber>;
ObjectiveDeltas: z.ZodRecord<z.ZodString, z.ZodObject<{
ID: z.ZodString;
ProgressBefore: z.ZodNumber;
ProgressAfter: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>>;
}, "strip", z.ZodTypeAny, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}>>>;
ContractDeltas: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodObject<{
ID: z.ZodString;
TotalXPBefore: z.ZodNumber;
TotalXPAfter: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}>>>;
CouldProgressMissions: z.ZodBoolean;
}, "strip", z.ZodTypeAny, {
ID: string;
StartTime: Date;
XPGrants: {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
} | null;
RewardGrants: {} | null;
MissionDeltas: Record<string, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}> | null;
ContractDeltas: Record<string, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}> | null;
CouldProgressMissions: boolean;
}, {
ID: string;
StartTime: number;
XPGrants: {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
} | null;
RewardGrants: {} | null;
MissionDeltas: Record<string, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}> | null;
ContractDeltas: Record<string, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}> | null;
CouldProgressMissions: boolean;
}>, "many">;
ActiveSpecialContract: z.ZodString;
Missions: z.ZodArray<z.ZodObject<{
ID: z.ZodString;
Objectives: z.ZodRecord<z.ZodString, z.ZodNumber>;
Complete: z.ZodBoolean;
ExpirationTime: z.ZodEffects<z.ZodString, Date, string>;
}, "strip", z.ZodTypeAny, {
ID: string;
Objectives: Record<string, number>;
Complete: boolean;
ExpirationTime: Date;
}, {
ID: string;
Objectives: Record<string, number>;
Complete: boolean;
ExpirationTime: string;
}>, "many">;
MissionMetadata: z.ZodObject<{
NPECompleted: z.ZodBoolean;
WeeklyCheckpoint: z.ZodEffects<z.ZodString, Date, string>;
WeeklyRefillTime: z.ZodEffects<z.ZodString, Date, string>;
}, "strip", z.ZodTypeAny, {
NPECompleted: boolean;
WeeklyCheckpoint: Date;
WeeklyRefillTime: Date;
}, {
NPECompleted: boolean;
WeeklyCheckpoint: string;
WeeklyRefillTime: string;
}>;
}, "strip", z.ZodTypeAny, {
Subject: string;
Version: number;
Contracts: {
ContractDefinitionID: string;
ContractProgression: {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
};
ProgressionLevelReached: number;
ProgressionTowardsNextLevel: number;
}[];
ProcessedMatches: {
ID: string;
StartTime: Date;
XPGrants: {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
} | null;
RewardGrants: {} | null;
MissionDeltas: Record<string, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}> | null;
ContractDeltas: Record<string, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}> | null;
CouldProgressMissions: boolean;
}[];
Missions: {
ID: string;
Objectives: Record<string, number>;
Complete: boolean;
ExpirationTime: Date;
}[];
ActiveSpecialContract: string;
MissionMetadata: {
NPECompleted: boolean;
WeeklyCheckpoint: Date;
WeeklyRefillTime: Date;
};
}, {
Subject: string;
Version: number;
Contracts: {
ContractDefinitionID: string;
ContractProgression: {
TotalProgressionEarned: number;
TotalProgressionEarnedVersion: number;
HighestRewardedLevel: Record<string, {
Version: number;
Amount: number;
}>;
};
ProgressionLevelReached: number;
ProgressionTowardsNextLevel: number;
}[];
ProcessedMatches: {
ID: string;
StartTime: number;
XPGrants: {
GamePlayed: number;
GameWon: number;
RoundPlayed: number;
RoundWon: number;
Missions: {};
Modifier: {
Value: number;
BaseMultiplierValue: number;
Modifiers: {
Value: number;
Name: "RESTRICTIONS_XP" | "PREMIUM_CONTRACT_XP";
BaseOnly: boolean;
}[];
};
NumAFKRounds: number;
} | null;
RewardGrants: {} | null;
MissionDeltas: Record<string, {
ID: string;
Objectives: Record<string, number>;
ObjectiveDeltas: Record<string, {
ID: string;
ProgressBefore: number;
ProgressAfter: number;
}>;
}> | null;
ContractDeltas: Record<string, {
ID: string;
TotalXPBefore: number;
TotalXPAfter: number;
}> | null;
CouldProgressMissions: boolean;
}[];
Missions: {
ID: string;
Objectives: Record<string, number>;
Complete: boolean;
ExpirationTime: string;
}[];
ActiveSpecialContract: string;
MissionMetadata: {
NPECompleted: boolean;
WeeklyCheckpoint: string;
WeeklyRefillTime: string;
};
}>;
};
};
export type ActivateContractResponse = z.input<typeof activateContractEndpoint.responses['200']>;