speedruncom.js 1.1.0 → 1.2.1

package/dist/interfaces.d.ts

@@ -6,7 +6,7 @@ export interface Category {
     /**
      * ID of the category.
      */
-    id: string;
+    readonly id: string;
     /**
      * Name of the category.
      */
@@ -16,15 +16,15 @@ export interface Category {
      * This is never actually used in site pages.
      * The URL is permanent and can never update, even when changing the category name.
      */
-    url: string;
+    readonly url: string;
     /**
      * A global, site-wide position order number for the category.
      */
-    pos: number;
+    readonly pos: number;
     /**
      * ID of the game the category is on.
      */
-    gameId: string;
+    readonly gameId: string;
     /**
      * Whether or not the category is miscellaneous.
      */
@@ -70,15 +70,15 @@ export interface ChallengeModerator {
     /**
      * ID of the challenge being moderated.
      */
-    challengeId: string;
+    readonly challengeId: string;
     /**
      * ID of the user moderating.
      */
-    userId: string;
+    readonly userId: string;
     /**
      * `GamePowerLevel` of the moderator.
      */
-    level: Enums.GamePowerLevel;
+    readonly level: Enums.GamePowerLevel;
 }
 /**
  * A current status of a challenge.
@@ -87,27 +87,27 @@ export interface ChallengeStanding {
     /**
      * ID of the challenge.
      */
-    challengeId: string;
+    readonly challengeId: string;
     /**
      * todo
      */
-    place: number;
+    readonly place: number;
     /**
      * todo
      */
-    registeredPlayerIds: string[];
+    readonly registeredPlayerIds: string[];
     /**
      * todo
      */
-    prizeAmount: number;
+    readonly prizeAmount: number;
     /**
      * todo
      */
-    unregisteredPlayers: string[];
+    readonly unregisteredPlayers: string[];
     /**
      * todo
      */
-    prizeCurrency: string;
+    readonly prizeCurrency: string;
 }
 /**
  * A currency reward for getting a certain ranking in a challenge.
@@ -116,123 +116,252 @@ export interface ChallengePrize {
     /**
      * The ranking in the challenge for the reward.
      */
-    place: number;
+    readonly place: number;
     /**
      * The amount of money rewarded to the player in the `place`.
      */
-    amount: number;
+    readonly amount: number;
 }
 /**
- * todo: is this just unused?
+ * Configuration settings of a challenge.
  */
 export interface ChallengePrizeConfig {
-    prizePool: number;
-    currency: string;
-    prizes: ChallengePrize[];
+    /**
+     * TODO
+     */
+    readonly prizePool: number;
+    /**
+     * TODO
+     */
+    readonly currency: string;
+    readonly prizes: ChallengePrize[];
 }
-/**Sitewide rank based on all challenges entered.*/
+/**
+ * A single user's site-wide ranking details based on all challenges entered.
+ */
 export interface GlobalChallengeRanking {
-    userId: string;
-    rank: number;
-    totalEarnings: number;
-    firstPlaces: number;
-    secondPlaces: number;
-    thirdPlaces: number;
-    challengesEntered: number;
+    /**
+     * ID of the user.
+     */
+    readonly userId: string;
+    /**
+     * The user's site-wide rank.
+     */
+    readonly rank: number;
+    readonly totalEarnings: number;
+    /**
+     * The amount of first place ranks the user has achieved in challenges.
+     */
+    readonly firstPlaces: number;
+    /**
+     * The amount of second place ranks the user has achieved in challenges.
+     */
+    readonly secondPlaces: number;
+    /**
+     * The amount of third place ranks the user has achieved in challenges.
+     */
+    readonly thirdPlaces: number;
+    /**
+     * The total amount of challenges the user has entered.
+     */
+    readonly challengesEntered: number;
 }
+/**
+ * A site challenge.
+ */
 export interface Challenge {
-    id: string;
-    name: string;
-    announcement: string;
-    url: string;
-    gameId: string;
-    createDate: number;
-    updateDate: number;
-    startDate: number;
-    endDate: number;
-    state: Enums.ChallengeState;
-    description: string;
-    rules: string;
-    numPlayers: number;
-    exactPlayers: boolean;
-    playerMatchMode: Enums.PlayerMatchMode;
-    timeDirection: Enums.TimeDirection;
-    enforceMs: boolean;
-    coverImagePath: string;
-    contest: boolean;
-    contestRules: string;
-    runCommentsMode: Enums.ItemPermissionType;
-    prizeConfig: ChallengePrizeConfig;
+    /**
+     * ID of the challenge.
+     */
+    readonly id: string;
+    /**
+     * Name of the challenge.
+     */
+    readonly name: string;
+    /**
+     * todo
+     */
+    readonly announcement: string;
+    /**
+     * Subpath URL of the challenge.
+     */
+    readonly url: string;
+    /**
+     * ID of the game the challenge is based on.
+     */
+    readonly gameId: string;
+    /**
+     * UNIX timestamp of when the challenge was created.
+     */
+    readonly createDate: number;
+    /**
+     * UNIX timestamp of when the challenge settings were last updated.
+     */
+    readonly updateDate: number;
+    /**
+     * todo
+     */
+    readonly startDate: number;
+    /**
+     * todo
+     */
+    readonly endDate: number;
+    /**
+     * `ChallengeState` of the challenge.
+     */
+    readonly state: Enums.ChallengeState;
+    /**
+     * Description of the challenge.
+     */
+    readonly description: string;
+    /**
+     * Rules of the challenge (not to be confused with `contestRules`).
+     */
+    readonly rules: string;
+    /**
+     *
+     */
+    readonly numPlayers: number;
+    readonly exactPlayers: boolean;
+    readonly playerMatchMode: Enums.PlayerMatchMode;
+    readonly timeDirection: Enums.TimeDirection;
+    readonly enforceMs: boolean;
+    /**
+     * Subpath URL of the challenge's cover image.
+     * check if opt todo
+     */
+    readonly coverImagePath: string;
+    readonly contest: boolean;
+    readonly contestRules: string;
+    readonly runCommentsMode: Enums.ItemPermissionType;
+    /**
+     * `ChallengePrizeConfig` of the challenge.
+     */
+    readonly prizeConfig: ChallengePrizeConfig;
 }
-/**User reward for completing a Challenge.*/
+/**
+ * Player reward for completing a Challenge.
+ */
 export interface Title {
-    id: string;
-    title: string;
-    comment: string;
-    referenceUrl: string;
+    /**
+     * ID of the title.
+     */
+    readonly id: string;
+    /**
+     * Title of the challenge.
+     */
+    readonly title: string;
+    /**
+     * Description of how the challenge is rewarded to players.
+     */
+    readonly comment: string;
+    /**
+     * Subpath URL of the challenge that rewards the title.
+     */
+    readonly referenceUrl: string;
 }
+/**
+ * Permissions of a comment section.
+ */
 export interface CommentPermissions {
-    canManage: boolean;
-    canViewComments: boolean;
-    canPostComments: boolean;
-    canEditComments: boolean;
-    canDeleteComments: boolean;
-    cannotViewReasons: string[];
-    cannotPostReasons: string[];
+    /**
+     * Whether or not
+     */
+    readonly canManage: boolean;
+    /**
+     * Whether or
+     */
+    readonly canViewComments: boolean;
+    readonly canPostComments: boolean;
+    /**
+     * Whether or not editing comments is allowed.
+     */
+    readonly canEditComments: boolean;
+    /**
+     * Whether or not deleting comments is allowsed.
+     */
+    readonly canDeleteComments: boolean;
+    /**
+     * Reasons for not being able to not view a thread.
+     */
+    readonly cannotViewReasons: string[];
+    /**
+     * Reasons for not being able to post a comment.
+     */
+    readonly cannotPostReasons: string[];
 }
 export interface CommentableProperties {
-    disabled: boolean;
-    locked: boolean;
+    readonly disabled: boolean;
+    readonly locked: boolean;
 }
 export interface Commentable {
-    itemType: Enums.ItemType;
-    itemId: string;
-    properties: CommentableProperties;
+    readonly itemType: Enums.ItemType;
+    readonly itemId: string;
+    readonly properties: CommentableProperties;
     /**Permissions of the logged in user. If not logged in; `canPostComments` is `false`.*/
-    permissions: CommentPermissions;
+    readonly permissions: CommentPermissions;
 }
 export interface Comment {
-    id: string;
-    itemType: Enums.ItemType;
-    itemId: string;
-    date: number;
-    userId: string;
+    readonly id: string;
+    readonly itemType: Enums.ItemType;
+    readonly itemId: string;
+    readonly date: number;
+    readonly userId: string;
     /**May be omitted on deleted comments.*/
-    text?: string;
-    parentId?: string;
-    deleted: boolean;
-    deletedUserId?: string;
+    readonly text?: string;
+    readonly parentId?: string;
+    readonly deleted: boolean;
+    readonly deletedUserId?: string;
 }
 export interface Like {
-    itemType: Enums.ItemType;
-    itemId: string;
-    userId: string;
-    date: number;
+    readonly itemType: Enums.ItemType;
+    readonly itemId: string;
+    readonly userId: string;
+    readonly date: number;
 }
 export interface SocialNetwork {
-    id: Enums.SocialConnection;
-    name: string;
-    major: boolean;
-    pos: number;
-    pattern: string;
+    /**
+     * `SocialConnection` of the social network.
+     */
+    readonly id: Enums.SocialConnection;
+    /**
+     * Name of the social network.
+     */
+    readonly name: string;
+    /**
+     * Arbitrary and unknown determination of if the platform is popular.
+     *
+     * This does not have to do with if the platform is depricated or not.
+     */
+    readonly major: boolean;
+    /**
+     * Site-wide ordering method of the platform.
+     */
+    readonly pos: number;
+    /**
+     * Either a URL with a `[id]` placeholder of where the entered value would be stored, `popup` when there is complex authentication of the social network, or an empty string when the value you enter is exactly what the end result will be.
+     *
+     * Example: `https://www.youtube.com/user/[id]`
+     */
+    readonly pattern: string;
 }
 export interface Area {
-    id: string;
-    name: string;
-    fullName: string;
-    label: string;
-    flagIcon: string;
-    lbFlagIcon: string;
-    lbName: string;
+    readonly id: string;
+    readonly name: string;
+    readonly fullName: string;
+    readonly label: string;
+    readonly flagIcon: string;
+    readonly lbFlagIcon: string;
+    readonly lbName: string;
 }
 export interface Color {
-    id: string;
-    name: string;
-    darkColor: string;
+    readonly id: string;
+    readonly name: string;
+    readonly darkColor: string;
     /**@deprecated `darkColor` is always used on the site*/
-    lightColor: string;
+    readonly lightColor: string;
     /**@deprecated colors now seem to be sorted by their name's ascending alphabetical order (A-Z)*/
-    pos: number;
+    readonly pos: number;
 }
 /**
  * A 'category' of threads, being site-wide such as *The Site* and *Supporter* or representing the forum section that every game has.
@@ -241,83 +370,83 @@ export interface Forum {
     /**
      * `id` of this forum section.
      */
-    id: string;
+    readonly id: string;
     /**
      * Name of the forum. If this is the game's forum, it is the game name.
      */
-    name: string;
+    readonly name: string;
     /**
      * Page URL of the forum. If this is the game's forum, it is the game's page URL.
      */
-    url: string;
+    readonly url: string;
     /**
      * A description used to describe site-wide forums.
      */
-    description?: string;
+    readonly description?: string;
     /**
      * The `ForumType` the forum is.
      */
-    type: Enums.ForumType;
+    readonly type: Enums.ForumType;
     /**
      * The amount of threads inside of a forum.
      */
-    threadCount: number;
+    readonly threadCount: number;
     /**
      * The amont of combined posts of every thread in the forum.
      */
-    postCount: number;
+    readonly postCount: number;
     /**
      * The ID of the latest post in any thread in the forum.
      */
-    lastPostId: string;
+    readonly lastPostId: string;
     /**
      * The `userId` of the latest post in any thread in the forum.
      */
-    lastPostUserId: string;
+    readonly lastPostUserId: string;
     /**
      * The UNIX timestamp of when the latest post in any thread in the forum was posted.
      */
-    lastPostDate: number;
+    readonly lastPostDate: number;
     /**
      *
      */
-    touchDate: number;
+    readonly touchDate: number;
 }
 export interface Thread {
-    id: string;
-    name: string;
-    gameId: string;
-    forumId: string;
-    userId: string;
-    replies: number;
-    created: number;
-    lastCommentId: string;
-    lastCommentUserId: string;
-    lastCommentDate: number;
-    sticky: boolean;
-    locked: boolean;
+    readonly id: string;
+    readonly name: string;
+    readonly gameId: string;
+    readonly forumId: string;
+    readonly userId: string;
+    readonly replies: number;
+    readonly created: number;
+    readonly lastCommentId: string;
+    readonly lastCommentUserId: string;
+    readonly lastCommentDate: number;
+    readonly sticky: boolean;
+    readonly locked: boolean;
 }
 export interface ForumReadStatus {
-    forumId: string;
-    date: number;
+    readonly forumId: string;
+    readonly date: number;
 }
 export interface Datatype {
-    threadId: string;
-    date: number;
+    readonly threadId: string;
+    readonly date: number;
 }
 export interface Leaderboard {
-    category: Category;
-    game: Game;
-    pagination: Pagination;
-    platforms: Platform[];
+    readonly category: Category;
+    readonly game: Game;
+    readonly pagination: Pagination;
+    readonly platforms: Platform[];
     /**
      * Every Player with a run in a game.
      */
-    players: Player[];
-    regions: Region[];
-    runs: GameRun[];
-    values: VariableValue[];
-    variables: Variable[];
+    readonly players: Player[];
+    readonly regions: Region[];
+    readonly runs: GameRun[];
+    readonly values: VariableValue[];
+    readonly variables: Variable[];
 }
 /**
  * Paramaters for filtering a leaderboard.
@@ -376,159 +505,159 @@ export interface LeaderboardParams {
     video?: Enums.VideoFilter;
 }
 export interface RunCount {
-    gameId: string;
-    categoryId: string;
-    levelId?: string;
-    variableId?: string;
-    valueId?: string;
-    count: number;
+    readonly gameId: string;
+    readonly categoryId: string;
+    readonly levelId?: string;
+    readonly variableId?: string;
+    readonly valueId?: string;
+    readonly count: number;
 }
 export interface Platform {
-    id: string;
-    name: string;
-    url: string;
-    year: number;
+    readonly id: string;
+    readonly name: string;
+    readonly url: string;
+    readonly year: number;
 }
 export interface Article {
-    id: string;
-    slug: string;
-    title: string;
-    summary: string;
-    body: string;
-    createDate: number;
-    updateDate: number;
-    publishDate?: number;
-    rejectDate?: number;
-    publishTarget: string;
-    publishTags: string[];
-    coverImagePath?: string;
-    commentsCount: number;
-    community?: boolean;
-    gameId?: string;
-    userId?: string;
-    editorId?: string;
+    readonly id: string;
+    readonly slug: string;
+    readonly title: string;
+    readonly summary: string;
+    readonly body: string;
+    readonly createDate: number;
+    readonly updateDate: number;
+    readonly publishDate?: number;
+    readonly rejectDate?: number;
+    readonly publishTarget: string;
+    readonly publishTags: string[];
+    readonly coverImagePath?: string;
+    readonly commentsCount: number;
+    readonly community?: boolean;
+    readonly gameId?: string;
+    readonly userId?: string;
+    readonly editorId?: string;
     /**day it was pinned */
-    stickyDate?: number;
+    readonly stickyDate?: number;
 }
 export interface Region {
-    id: string;
-    name: string;
-    url: string;
-    flag: string;
+    readonly id: string;
+    readonly name: string;
+    readonly url: string;
+    readonly flag: string;
 }
 export interface Pagination {
-    count: number;
-    page: number;
-    pages: number;
-    per: number;
+    readonly count: number;
+    readonly page: number;
+    readonly pages: number;
+    readonly per: number;
 }
 export interface Guide {
-    id: string;
-    name: string;
-    text: string;
-    date: number;
-    userId: string;
-    gameId: string;
+    readonly id: string;
+    readonly name: string;
+    readonly text: string;
+    readonly date: number;
+    readonly userId: string;
+    readonly gameId: string;
 }
 export interface Resource {
-    id: string;
-    type: Enums.ResourceType;
-    name: string;
-    description: string;
-    date: number;
-    userId: string;
-    gameId: string;
-    path?: string;
-    link?: string;
-    fileName?: string;
-    authorNames: string;
+    readonly id: string;
+    readonly type: Enums.ResourceType;
+    readonly name: string;
+    readonly description: string;
+    readonly date: number;
+    readonly userId: string;
+    readonly gameId: string;
+    readonly path?: string;
+    readonly link?: string;
+    readonly fileName?: string;
+    readonly authorNames: string;
 }
 export interface Stream {
-    id: string;
-    gameId?: string;
-    userId?: string;
-    areaId?: string;
-    url: string;
-    title: string;
-    previewUrl: string;
-    channelName: string;
-    viewers: number;
+    readonly id: string;
+    readonly gameId?: string;
+    readonly userId?: string;
+    readonly areaId?: string;
+    readonly url: string;
+    readonly title: string;
+    readonly previewUrl: string;
+    readonly channelName: string;
+    readonly viewers: number;
     /**If the stream has a PB on SRC (and has their account linked)  TODO: check*/
-    hasPb: boolean;
+    readonly hasPb: boolean;
 }
 export interface AuditLogEntry {
-    id: string;
-    date: number;
-    eventType: Enums.EventType;
-    actorId: string;
-    gameId: string;
+    readonly id: string;
+    readonly date: number;
+    readonly eventType: Enums.EventType;
+    readonly actorId: string;
+    readonly gameId: string;
     /**A json dict of extra context based on eventType.*/
-    context: string;
-    userId?: string;
+    readonly context: string;
+    readonly userId?: string;
 }
 export interface Session {
-    signedIn: boolean;
-    showAds: boolean;
-    user?: User;
-    theme?: Theme;
-    powerLevel: Enums.SitePowerLevel;
-    dateFormat: Enums.DateFormat;
-    timeFormat: Enums.TimeFormat;
-    timeReference: Enums.TimeReference;
-    timeUnits: Enums.TimeDisplayUnits;
-    homepageStream: Enums.HomepageStreamType;
-    disableThemes: boolean;
-    csrfToken: string;
-    networkToken?: string;
-    gameList: Game[];
-    gameFollowerList: GameFollower[];
-    gameModeratorList: GameModerator[];
-    gameRunnerList: GameRunner[];
-    seriesList: Series[];
-    seriesModeratorList: SeriesModerator[];
-    boostAvailableTokens?: number;
-    boostNextTokenDate: number;
-    boostNextTokenAmount: number;
-    userFollowerList: UserFollower[];
-    enabledExperimentIds: string[];
-    challengeModeratorList: ChallengeModerator[];
+    readonly signedIn: boolean;
+    readonly showAds: boolean;
+    readonly user?: User;
+    readonly theme?: Theme;
+    readonly powerLevel: Enums.SitePowerLevel;
+    readonly dateFormat: Enums.DateFormat;
+    readonly timeFormat: Enums.TimeFormat;
+    readonly timeReference: Enums.TimeReference;
+    readonly timeUnits: Enums.TimeDisplayUnits;
+    readonly homepageStream: Enums.HomepageStreamType;
+    readonly disableThemes: boolean;
+    readonly csrfToken: string;
+    readonly networkToken?: string;
+    readonly gameList: Game[];
+    readonly gameFollowerList: GameFollower[];
+    readonly gameModeratorList: GameModerator[];
+    readonly gameRunnerList: GameRunner[];
+    readonly seriesList: Series[];
+    readonly seriesModeratorList: SeriesModerator[];
+    readonly boostAvailableTokens?: number;
+    readonly boostNextTokenDate: number;
+    readonly boostNextTokenAmount: number;
+    readonly userFollowerList: UserFollower[];
+    readonly enabledExperimentIds: string[];
+    readonly challengeModeratorList: ChallengeModerator[];
 }
 export interface Conversation {
-    id: string;
-    participantUserIds: string[];
-    lastMessageId: string;
-    lastMessageUser: string;
-    lastMessageText: string;
-    lastMessageDate: number;
-    readDate: number;
+    readonly id: string;
+    readonly participantUserIds: string[];
+    readonly lastMessageId: string;
+    readonly lastMessageUser: string;
+    readonly lastMessageText: string;
+    readonly lastMessageDate: number;
+    readonly readDate: number;
 }
 export interface ConversationLightweight {
-    id: string;
+    readonly id: string;
     /**TODO check if empty */
-    participantUserIds: string[];
-    lastMessageId: string;
-    lastMessageDate: number;
+    readonly participantUserIds: string[];
+    readonly lastMessageId: string;
+    readonly lastMessageDate: number;
 }
 export interface ConversationParticipant {
-    conversationId: string;
-    userId: string;
-    joinedDate: number;
+    readonly conversationId: string;
+    readonly userId: string;
+    readonly joinedDate: number;
     /**TODO check if optional*/
-    leftDate: number;
+    readonly leftDate: number;
 }
 export interface ConversationMessage {
-    id: string;
-    conversationId: string;
-    userId: string;
-    text: string;
-    date: number;
+    readonly id: string;
+    readonly conversationId: string;
+    readonly userId: string;
+    readonly text: string;
+    readonly date: number;
 }
 export interface SystemMessage {
-    id: string;
-    userId: string;
-    text: string;
-    date: number;
-    read: boolean;
+    readonly id: string;
+    readonly userId: string;
+    readonly text: string;
+    readonly date: number;
+    readonly read: boolean;
 }
 /**
  * The basic data of a game.
@@ -537,106 +666,106 @@ export interface Game {
     /**
      * ID of the game.
      */
-    id: string;
+    readonly id: string;
     /**
      * Name of the game.
      */
-    name: string;
+    readonly name: string;
     /**
      * Page URL of the game.
      */
-    url: string;
+    readonly url: string;
     /**
      * Unused enum that is always `1`. todo check if gameType is this
      */
-    type: 1;
+    readonly type: 1;
     /**
      * Whether or not a game has Load Removed Time (LRT) as a timing method.
      */
-    loadtimes: boolean;
+    readonly loadtimes: boolean;
     /**
      * Whether or not the game supports entering milliseconds when entering a time into a run.
      */
-    milliseconds: boolean;
+    readonly milliseconds: boolean;
     /**
      * Whether or not a game has In Game Time (IGT) as a timing method.
      */
-    igt: boolean;
+    readonly igt: boolean;
     /**
      * Whether or not runs require moderators to verify them.
      */
-    verification: boolean;
+    readonly verification: boolean;
     /**
      * Whether or not the default option for 'Automatically Verify Run' is true.
      */
-    autoVerify?: boolean;
+    readonly autoVerify?: boolean;
     /**
      * Whether or not videos are required for submission.
      */
-    requireVideo: boolean;
+    readonly requireVideo: boolean;
     /**
      * Emulator allowability in a game.
      */
-    emulator: Enums.EmulatorType;
+    readonly emulator: Enums.EmulatorType;
     /**
      * Default timing method of the game.
      */
-    defaultTimer: Enums.TimingMethod;
-    validTimers: Enums.TimingMethod[];
-    releaseDate?: number;
-    addedDate: number;
-    touchDate: number;
-    baseGameId?: string;
-    coverPath: string;
-    trophy1stPath?: string;
-    trophy2ndPath?: string;
-    trophy3rdPath?: string;
-    trophy4thPath?: string;
-    runCommentsMode: Enums.ItemPermissionType;
-    runCount: number;
-    activePlayerCount: number;
-    totalPlayerCount: number;
-    boostReceivedCount: number;
-    boostDistinctDonorsCount: number;
-    rules?: string;
-    viewPowerLevel: Enums.SitePowerLevel;
-    platformIds: string[];
-    regionIds: string[];
-    gameTypeIds: Enums.GameType[];
-    websiteUrl?: string;
-    discordUrl?: string;
-    defaultView: Enums.DefaultViewType;
-    guidePermissionType: Enums.ItemPermissionType;
-    resourcePermissionType: Enums.ItemPermissionType;
-    staticAssets: StaticAsset[];
-    embargoDate?: number;
-    embargoText?: string;
+    readonly defaultTimer: Enums.TimingMethod;
+    readonly validTimers: Enums.TimingMethod[];
+    readonly releaseDate?: number;
+    readonly addedDate: number;
+    readonly touchDate: number;
+    readonly baseGameId?: string;
+    readonly coverPath: string;
+    readonly trophy1stPath?: string;
+    readonly trophy2ndPath?: string;
+    readonly trophy3rdPath?: string;
+    readonly trophy4thPath?: string;
+    readonly runCommentsMode: Enums.ItemPermissionType;
+    readonly runCount: number;
+    readonly activePlayerCount: number;
+    readonly totalPlayerCount: number;
+    readonly boostReceivedCount: number;
+    readonly boostDistinctDonorsCount: number;
+    readonly rules?: string;
+    readonly viewPowerLevel: Enums.SitePowerLevel;
+    readonly platformIds: string[];
+    readonly regionIds: string[];
+    readonly gameTypeIds: Enums.GameType[];
+    readonly websiteUrl?: string;
+    readonly discordUrl?: string;
+    readonly defaultView: Enums.DefaultViewType;
+    readonly guidePermissionType: Enums.ItemPermissionType;
+    readonly resourcePermissionType: Enums.ItemPermissionType;
+    readonly staticAssets: StaticAsset[];
+    readonly embargoDate?: number;
+    readonly embargoText?: string;
 }
 export interface GameStats {
-    gameId: string;
-    totalRuns: number;
-    totalRunsFG: number;
-    totalRunsIL: number;
-    totalRunTime: number;
-    recentRuns: number;
-    recentRunsFG: number;
-    recentRunsIL: number;
-    totalPlayers: number;
-    activePlayers: number;
-    followers: number;
-    guides: number;
-    resources: number;
+    readonly gameId: string;
+    readonly totalRuns: number;
+    readonly totalRunsFG: number;
+    readonly totalRunsIL: number;
+    readonly totalRunTime: number;
+    readonly recentRuns: number;
+    readonly recentRunsFG: number;
+    readonly recentRunsIL: number;
+    readonly totalPlayers: number;
+    readonly activePlayers: number;
+    readonly followers: number;
+    readonly guides: number;
+    readonly resources: number;
 }
 export interface GameNews {
-    id: string;
-    gameId: string;
-    userId: string;
-    title: string;
+    readonly id: string;
+    readonly gameId: string;
+    readonly userId: string;
+    readonly title: string;
     /**
      * Omitted for all but the first item in `GetGameSummary.newsList[]`.
      */
-    body?: string;
-    dateSubmitted: number;
+    readonly body?: string;
+    readonly dateSubmitted: number;
 }
 export interface GameModerator {
     gameId: string;
@@ -644,24 +773,24 @@ export interface GameModerator {
     level: Enums.GamePowerLevel;
 }
 export interface GameBoost {
-    id: string;
-    createdAt: number;
-    updatedAt: number;
-    gameId: string;
-    donorUserId: string;
-    anonymous: boolean;
-    recipientUserIds: [];
+    readonly id: string;
+    readonly createdAt: number;
+    readonly updatedAt: number;
+    readonly gameId: string;
+    readonly donorUserId: string;
+    readonly anonymous: boolean;
+    readonly recipientUserIds: [];
 }
 export interface GameTypeDetails {
-    id: Enums.GameType;
-    name: string;
-    url: string;
-    description: string;
-    allowBaseGame: boolean;
+    readonly id: Enums.GameType;
+    readonly name: string;
+    readonly url: string;
+    readonly description: string;
+    readonly allowBaseGame: boolean;
 }
 /**TODO: Check for optional properties*/
 export interface GameSettings {
-    id: string;
+    readonly id: string;
     name: string;
     url: string;
     twitchName: string;
@@ -698,56 +827,58 @@ export interface GameSettings {
     staticAssetUpdates: StaticAssetUpdate[];
 }
 export interface GameModerationStats {
-    gameId: string;
+    readonly gameId: string;
     /**enum? appears to always be 0*/
-    state: number;
-    count: number;
-    minDate?: number;
-    maxDate?: number;
+    readonly state: number;
+    readonly count: number;
+    readonly minDate?: number;
+    readonly maxDate?: number;
 }
 export interface GameFollower {
-    gameId: string;
-    followerId: string;
-    pos?: number;
-    accessCount: number;
-    lastAccessDate: number;
+    readonly gameId: string;
+    readonly followerId: string;
+    readonly pos?: number;
+    readonly accessCount: number;
+    readonly lastAccessDate: number;
 }
 export interface GameRunner {
-    gameId: string;
-    userId: string;
-    runCount: number;
+    readonly gameId: string;
+    readonly userId: string;
+    readonly runCount: number;
 }
-export interface Level {
-    id: string;
-    gameId: string;
+export interface NewLevel {
+    readonly gameId: string;
     name: string;
-    url: string;
-    pos: number;
     rules?: string;
     archived: boolean;
 }
+export interface Level extends NewLevel {
+    readonly id: string;
+    readonly url: string;
+    readonly pos: number;
+}
 export interface Notification {
-    id: string;
-    date: number;
-    title: string;
-    path: string;
-    read: boolean;
+    readonly id: string;
+    readonly date: number;
+    readonly title: string;
+    readonly path: string;
+    readonly read: boolean;
 }
 export interface NotificationSetting {
-    type: number;
-    gameId?: string;
-    site: boolean;
-    email: boolean;
+    readonly type: number;
+    readonly gameId?: string;
+    readonly site: boolean;
+    readonly email: boolean;
 }
 /**A different type of notification are returned by `GetStaticData` than in other areas.*/
 export interface NotificationSettingStaticData {
-    id: number;
-    group: string;
-    title: string;
-    pos: number;
-    gameSpecific: boolean;
-    siteDefault: number;
-    emailDefault: boolean;
+    readonly id: number;
+    readonly group: string;
+    readonly title: string;
+    readonly pos: number;
+    readonly gameSpecific: boolean;
+    readonly siteDefault: number;
+    readonly emailDefault: boolean;
 }
 export interface GameOrderGroup {
     id: string;
@@ -758,100 +889,100 @@ export interface GameOrderGroup {
     editing?: boolean;
 }
 export interface GameOrdering {
-    defaultGroups: GameOrderGroup[];
-    supporterGroups: GameOrderGroup[];
+    readonly defaultGroups: GameOrderGroup[];
+    readonly supporterGroups: GameOrderGroup[];
 }
 interface Run_Base {
     /**
      * Unique identification characters of a run.
      */
-    id: string;
+    readonly id: string;
     /**
      * Unique identification characters of the run's game.
      */
-    gameId: string;
+    readonly gameId: string;
     /**
      * Timing of the run, in seconds. If the run has an *LRT* (Load Removed Time) **and** an *RTA* (Real Time Attack) time, this property will be the LRT. If there is an RTA and not an LRT, this will be the RTA.
      */
-    time?: number;
+    readonly time?: number;
     /**
  * Timing of the run, in seconds. If the run has an *LRT* (Load Removed Time) **and** an *RTA* (Real Time Attack) time, this property will be the RTA. If there is an LRT and not an RTA, this will be the LRT.
  */
-    timeWithLoads?: number;
+    readonly timeWithLoads?: number;
     /**
      * In Game Time* of the run, in seconds.
      */
-    igt?: number;
+    readonly igt?: number;
     /**
      * Unique identification characters of a platform. Platforms can be accessed with `GetPlatformList`.
      */
-    platformId?: string;
+    readonly platformId?: string;
     /**
      * Whether or not an emulator was used in the run.
      */
-    emulator: boolean;
+    readonly emulator: boolean;
     /**
      * Unique identification characters of a region. Found in older games that vary based on regions.
      */
-    regionId?: string;
+    readonly regionId?: string;
     /**
      * Everything in the 'Video URL' box.
      */
-    video?: string;
+    readonly video?: string;
     /**
      * Description of a run.
      */
-    comment?: string;
+    readonly comment?: string;
     /**
      * Unique user identification of the run submitter. Absent if the submitter is deleted.
      */
-    submittedById?: string;
+    readonly submittedById?: string;
     /**
      * A run's verification status.
      */
-    verified: Enums.RunStatus;
+    readonly verified: Enums.RunStatus;
     /**
      * Unique user identification characters of the run resolver.
      *
      * Absent if the resolver is deleted.
      */
-    verifiedById?: string;
+    readonly verifiedById?: string;
     /**
      * Run rejection reason if it was rejected.
      */
-    reason?: string;
+    readonly reason?: string;
     /**
      * UNIX timestamp of a run's (changeable) date.
      */
-    date: number;
+    readonly date: number;
     /**
      * UNIX timestamp of when the run was submitted.
      */
-    dateSubmitted?: number;
+    readonly dateSubmitted?: number;
     /**
      * UNIX timestamp of when the run was resolved.
      */
-    dateVerified?: number;
+    readonly dateVerified?: number;
     /**
      * Whether the run is obsolete or not - absent when false.
      */
-    obsolete?: boolean;
+    readonly obsolete?: boolean;
     /**
      * Leaderboard rank of the run. Absent when obsolete.
      */
-    place?: number;
+    readonly place?: number;
     /**
      * Unique identification characters of players in the run.
      */
-    playerIds: string[];
+    readonly playerIds: string[];
     /**
      * Unused property that used to store reports of bad data for a run.
      */
-    issues: null;
+    readonly issues: null;
     /**
      * Availibility and 'status' of the video of a run.
      */
-    VideoState: Enums.VideoState;
+    readonly VideoState: Enums.VideoState;
 }
 /**
  * A game speedrun's public data.
@@ -860,30 +991,30 @@ export interface GameRun extends Run_Base {
     /**
      * Unique identification characters of the run's category.
      */
-    categoryId: string;
+    readonly categoryId: string;
     /**
      * Unique identification characters of the run's level, if the run is on an individual level (IL).
      */
-    levelId?: string;
+    readonly levelId?: string;
     /**
      * Whether the run has *splits.io* splits. Splits.io has been shut down; this is `false` on all new runs.
      */
-    hasSplits: boolean;
+    readonly hasSplits: boolean;
     /**
      * Unique identification characters of values (subcategories and annotations) in the run.
      */
-    valueIds: string[];
+    readonly valueIds: string[];
     /**
      * Whether or not the run's category or subcategories were archived - absent when false.
      */
-    orphaned?: boolean;
+    readonly orphaned?: boolean;
 }
 export interface ChallengeRun extends Run_Base {
-    challengeId: string;
-    screened: boolean;
-    screenedById?: string;
-    dateScreened?: number;
-    commentsCount: number;
+    readonly challengeId: string;
+    readonly screened: boolean;
+    readonly screenedById?: string;
+    readonly dateScreened?: number;
+    readonly commentsCount: number;
 }
 export interface ModerationRun extends GameRun {
     /**
@@ -891,7 +1022,7 @@ export interface ModerationRun extends GameRun {
      *
      * Missing when false.
      */
-    estimated?: true;
+    readonly estimated?: true;
 }
 export interface RunTime {
     hour: number;
@@ -903,7 +1034,7 @@ export interface RunSettings {
     /**
      * Omitted when submitting a new run.
      */
-    runId?: string;
+    readonly runId?: string;
     gameId: string;
     categoryId: string;
     playerNames: string[];
@@ -921,18 +1052,18 @@ export interface RunSettings {
     values: VariableValue[];
 }
 export interface Series {
-    id: string;
-    name: string;
-    url: string;
-    addedDate: number;
-    touchDate: number;
-    websiteUrl?: string;
-    discordUrl?: string;
-    runCount: number;
-    activePlayerCount: number;
-    totalPlayerCount: number;
-    officialGameCount: number;
-    staticAssets: StaticAsset[];
+    readonly id: string;
+    readonly name: string;
+    readonly url: string;
+    readonly addedDate: number;
+    readonly touchDate: number;
+    readonly websiteUrl?: string;
+    readonly discordUrl?: string;
+    readonly runCount: number;
+    readonly activePlayerCount: number;
+    readonly totalPlayerCount: number;
+    readonly officialGameCount: number;
+    readonly staticAssets: StaticAsset[];
 }
 export interface SeriesModerator {
     seriesId: string;
@@ -959,43 +1090,43 @@ export interface StaticAssetUpdate {
     deleteContent?: boolean;
 }
 export interface SupporterCredit {
-    id: string;
-    userId: string;
-    providerId: number;
-    createdAt: number;
-    updatedAt: number;
-    creditType: number;
-    amount: number;
-    currency: string;
-    receivedAt: number;
-    subscriptionId: string;
-    periodStartsAt: number;
-    periodEndsAt: number;
-    providerItemId: string;
+    readonly id: string;
+    readonly userId: string;
+    readonly providerId: number;
+    readonly createdAt: number;
+    readonly updatedAt: number;
+    readonly creditType: number;
+    readonly amount: number;
+    readonly currency: string;
+    readonly receivedAt: number;
+    readonly subscriptionId: string;
+    readonly periodStartsAt: number;
+    readonly periodEndsAt: number;
+    readonly providerItemId: string;
 }
 export interface SupporterCode {
-    id: string;
-    code: string;
-    description: string;
-    duration: number;
-    userId: string;
-    createdAt: number;
-    updatedAt: number;
+    readonly id: string;
+    readonly code: string;
+    readonly description: string;
+    readonly duration: number;
+    readonly userId: string;
+    readonly createdAt: number;
+    readonly updatedAt: number;
 }
 export interface SupporterSubscription {
-    id: string;
-    userId: string;
-    providerId: number;
-    createdAt: number;
-    updatedAt: number;
-    expiresAt: number;
-    planId: number;
-    nextPeriodPlanId: number;
-    status: number;
+    readonly id: string;
+    readonly userId: string;
+    readonly providerId: number;
+    readonly createdAt: number;
+    readonly updatedAt: number;
+    readonly expiresAt: number;
+    readonly planId: number;
+    readonly nextPeriodPlanId: number;
+    readonly status: number;
     /**Default 0, undocumented but assume timestamp otherwise TODO*/
-    trialEndsAt: number;
-    cancelAtPeriodEnd: boolean;
-    canceledAt: number;
+    readonly trialEndsAt: number;
+    readonly cancelAtPeriodEnd: boolean;
+    readonly canceledAt: number;
 }
 export interface Theme {
     id: string;
@@ -1235,10 +1366,7 @@ export interface VariableValues {
     valueIds: string[];
 }
 export interface Variable {
-    id: string;
     name: string;
-    url: string;
-    pos: number;
     gameId: string;
     description?: string;
     categoryScope: Enums.VarCategoryScope;
@@ -1253,6 +1381,11 @@ export interface Variable {
     archived: boolean;
     displayMode?: Enums.VarDisplayMode;
 }
+export interface Variable {
+    id: string;
+    url: string;
+    pos: number;
+}
 /**Value of a variable. `VariableValue` is a selector on this type (and the underlying variable)*/
 export interface Value {
     id: string;