Update API types

This commit is contained in:
Samuel Elliott 2022-07-23 17:44:44 +01:00
parent dddb15aceb
commit a32c3dec72
No known key found for this signature in database
GPG Key ID: 8420C7CDE43DC4D6
3 changed files with 27 additions and 15 deletions

View File

@ -71,6 +71,8 @@ export interface Announcement {
distributionDate: number;
title: string;
description: string;
link?: string;
linkText?: string;
}
/** /v3/Friend/List */

View File

@ -277,7 +277,7 @@ export interface CoralJwtPayload extends JwtPayload {
exp: number;
iat: number;
iss: 'api-lp1.znc.srv.nintendo.net';
/** Coral user ID (CurrentUser.id, not CurrentUser.nsaID) */
/** Coral user ID (CurrentUser.id, not CurrentUser.nsaId) */
sub: number;
typ: 'id_token';
}
@ -288,11 +288,11 @@ export interface CoralWebServiceJwtPayload extends JwtPayload {
iat: number;
iss: 'api-lp1.znc.srv.nintendo.net';
jti: string;
/** Coral user ID (CurrentUser.id, not CurrentUser.nsaID) */
/** Coral user ID (CurrentUser.id, not CurrentUser.nsaId) */
sub: number;
links: {
networkServiceAccount: {
/** NSA ID (CurrentUser.nsaID) */
/** NSA ID (CurrentUser.nsaId) */
id: string;
};
};

View File

@ -24,7 +24,7 @@ export interface User {
acceptedNotification: {
all: boolean;
};
notices: unknown[];
notices: string[];
createdAt: number;
updatedAt: number;
}
@ -71,13 +71,7 @@ export interface PairedDevice {
device: Device;
nintendoAccountId: string;
label: string;
parentalControlSettingState: {
deviceId: string;
targetEtag: string;
synchronizationStatus: 'SYNCHRONIZED';
createdAt: number;
updatedAt: number;
};
parentalControlSettingState: ParentalControlSettingState;
hasNewMonthlySummary: boolean;
hasFirstDailySummary: boolean;
createdAt: number;
@ -110,13 +104,18 @@ export interface Device {
};
lastOnlineCheckedAt: number;
alarmSetting: {
visibility: 'VISIBLE';
visibility: AlarmStatus;
invisibleUntil: number;
};
createdAt: number;
updatedAt: number;
}
export enum AlarmStatus {
VISIBLE = 'VISIBLE',
INVISIBLE = 'INVISIBLE',
}
/** GET /v1/devices/{deviceId}/daily_summaries */
export interface DailySummaries {
count: number;
@ -129,11 +128,11 @@ export interface DailySummary {
date: string; // "2022-03-14"
result: DailySummaryResult;
playingTime: number;
exceededTime: null;
exceededTime: number | null;
disabledTime: number;
miscTime: number;
importantInfos: ImportantInfo[];
notices: unknown[];
notices: Notice[];
observations: Observation[];
playedApps: PlayedTitle[];
anonymousPlayer: AnonymousPlayer | null;
@ -146,10 +145,14 @@ export interface DailySummary {
export enum DailySummaryResult {
CALCULATING = 'CALCULATING',
ACHIEVED = 'ACHIEVED',
UNACHIEVED = 'UNACHIEVED',
}
export enum ImportantInfo {
DID_WRONG_UNLOCK_CODE = 'DID_WRONG_UNLOCK_CODE',
}
export enum Notice {
DID_ALARM_MAKE_INVISIBLE = 'DID_ALARM_MAKE_INVISIBLE',
}
export interface Title {
applicationId: string;
@ -270,7 +273,14 @@ export enum MonthlySummaryTitleRankingPosition {
export interface ParentalControlSettingState {
deviceId: string;
targetEtag: string;
synchronizationStatus: 'SYNCHRONIZED';
synchronizationStatus: SynchronizationStatus;
createdAt: number;
updatedAt: number;
}
export enum SynchronizationStatus {
SYNCHRONIZED = 'SYNCHRONIZED',
NOTIFIED = 'NOTIFIED',
PENDING = 'PENDING',
FAILED = 'FAILED',
}