speedruncom.js 1.3.0 → 2.0.0

package/src/endpoints/endpoints.post.ts

@@ -1,1277 +1,1268 @@
 //Endpoints that would give the "Method Not Allowed" error when called with GET.
 
-import * as Enums from '../enums.js';
-import * as Interfaces from '../interfaces.js';
-import { AtLeastOne } from '../types.js';
-/**
- * Logs in by giving a `set-cookie` header in a response with a `PHPSESSID` cookie.
- * 
- * The first (or only) call only must have only the `name` and `password` params.
- * 
- * If the account has 2 factor authentication (indicated by `loggedIn = false` and `tokenChallengeSent = true`), a 5-digit code will be sent to the account's email. Then a second call with `name`, `password`, and `token` (the token provided in the email) will authenticate.
- */
-export interface PutAuthLogin {
+import * as Enums from '../enums';
+import * as Interfaces from '../interfaces';
+import { AtLeastOne } from '../types';
 
-    /**
-     * The username of the account.
-     */
-    name: string;
-
-    /**
-     * The password of the account.
-     */
-    password: string;
+export default interface POSTEndpoints {
 
     /**
-     * Five-digit token sent to the account's email after a call to an account that has 2 factor authentication.
+     * Logs in by giving a `set-cookie` header in a response with a `PHPSESSID` cookie.
+     * 
+     * The first (or only) call only must have only the `name` and `password` params.
+     * 
+     * If the account has 2 factor authentication (indicated by `loggedIn = false` and `tokenChallengeSent = true`), a 5-digit code will be sent to the account's email. Then a second call with `name`, `password`, and `token` (the token provided in the email) will authenticate.
      */
-    token?: string;
-}
+    PutAuthLogin: {
 
-// TODO PutAuthSignup
+        /**
+         * The username of the account.
+         */
+        name: string;
 
-/**
- * Gets information about the current user's session.
- * Most notably `csrfToken`, required for `PutRunSettings`, `PutConversation`, `PutConversationMessage`, `PutConversationLeave` and `PutConversationReport.
- */
-export interface GetSession {}
+        /**
+         * The password of the account.
+         */
+        password: string;
 
-/**
- * todo test which credentials this is for
- */
-export interface PutSessionPing {}
+        /**
+         * Five-digit token sent to the account's email after a call to an account that has 2 factor authentication.
+         */
+        token?: string;
+    };
 
-/**
- * Gets a game, series, or your account's audit log.
- * 
- * If getting a game or series audit log, you must be a Super Moderator for it.
- * 
- * If getting your account's audit log, your account must not be banned.
- * 
- * If multiple item ID parameters are called, it will fetch events concurrent to the items (ex. getting added as a moderator to the game).
- */
-interface GetAuditLogList_Base {
+    // TODO PutAuthSignup
 
     /**
-     * An `EventType` of an event.
+     * Gets information about the current user's session.
+     * Most notably `csrfToken`, required for `PutRunSettings`, `PutConversation`, `PutConversationMessage`, `PutConversationLeave` and `PutConversationReport.
      */
-    eventType?: Enums.EventType;
+    GetSession: {};
 
     /**
-     * ID of a game.
+     * todo test which credentials this is for
      */
-    gameId?: string;
+    PutSessionPing: {};
 
     /**
-     * ID of a series.
+     * Gets a game's settings.
+     * 
+     * You must be a verifier, moderator, or super moderator in the game.
      */
-    seriesId?: string;
+    GetGameSettings: {
+
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    };
 
     /**
-     * ID of the user.
+     * Set a game's settings.
+     * 
+     * You must be a moderator or super moderator in a game.
      */
-    userId?: string;
+    PutGameSettings: {
+
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+
+        /**
+         * New game settings.
+         */
+        settings: Interfaces.GameSettings;
+    };
 
     /**
-     * The maximum amount of `AuditLogEntry`s to fetch.
+     * Creates a new category.
      */
-    limit?: number;
+    PutCategory: {
+
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+
+        /**
+         * Settings for the new category.
+         */
+        category: Interfaces.Category;
+    };
 
     /**
-     * The audit log page, in relation to `limit`.
+     * Updates an existing category.
      */
-    page?: number;
-}
+    PutCategoryUpdate: {
 
-export type GetAuditLogList = AtLeastOne<GetAuditLogList_Base, 'gameId' | 'seriesId' | 'userId'>;
+        /**
+         * ID of the game the category is on.
+         */
+        gameId: string;
 
-/**
- * Gets a game's settings.
- * 
- * You must be a verifier, moderator, or super moderator in the game.
- */
-export interface GetGameSettings {
+        /**
+         * ID of the category.
+         */
+        categoryId: string;
+
+        /**
+         * New settings for the category.
+         */
+        category: Interfaces.Category;
+    };
 
     /**
-     * ID of the game.
+     * Archives a category.
      */
-    gameId: string;
-}
+    PutCategoryArchive: {
+
+        /**
+         * ID of the game the category is on.
+         */
+        gameId: string;
 
-/**
- * Set a game's settings.
- * 
- * You must be a moderator or super moderator in a game.
- */
-export interface PutGameSettings {
+        /**
+         * ID of the category to archive.
+         */
+        categoryId: string;
+    };
 
     /**
-     * ID of the game.
+     * Restores an archived category.
      */
-    gameId: string;
+    PutCategoryRestore: {
+
+        /**
+         * ID of the game that the category to restore is on.
+         */
+        gameId: string;
+
+        /**
+         * ID of the category to restore.
+         */
+        categoryId: string;
+    };
 
     /**
-     * New game settings.
+     * Re-orders game categories.
+     * 
+     * You must be a moderator or super moderator of the game.
      */
-    settings: Interfaces.GameSettings;
-}
+    PutCategoryOrder: {
+
+        /**
+         * ID of the game to order categories on.
+         */
+        gameId: string;
 
-/**
- * Creates a new category.
- */
-export interface PutCategory {
+        /**
+         * The new order of categories.
+         */
+        categoryIds: string[];
+    };
 
     /**
-     * ID of the game.
+     * Creates a new game Level.
+     * 
+     * You must be a moderator or super moderator of the game.
      */
-    gameId: string;
+    PutLevel: {
+
+        /**
+         * ID of the game to put the level on.
+         */
+        gameId: string;
+
+        /**
+         * Settings for the new level.
+         */
+        level: Interfaces.NewLevel;
+    };
 
     /**
-     * Settings for the new category.
+     * Updates an existing level.
+     * 
+     * You must be a moderator or super moderator of the level's game.
      */
-    category: Interfaces.Category;
-}
+    PutLevelUpdate: {
+
+        /**
+         * ID of the game that the level to update is on.
+         */
+        gameId: string;
 
-/**
- * Updates an existing category.
- */
-export interface PutCategoryUpdate {
+        /**
+         * ID of the level to update.
+         */
+        levelId: string;
+
+        /**
+         * New settings for the level.
+         */
+        level: Interfaces.Level;
+    };
 
     /**
-     * ID of the game the category is on.
+     * Archives a level.
+     * 
+     * You must be a moderator or super moderator of the level's game.
      */
-    gameId: string;
+    PutLevelArchive: {
+
+        /**
+         * ID of the game that the level to archive is on.
+         */
+        gameId: string;
+
+        /**
+         * ID of the level to archive.
+         */
+        levelId: string;
+    };
 
     /**
-     * ID of the category.
+     * Restores an archived level.
      */
-    categoryId: string;
+    PutLevelRestore: {
+
+        /**
+         * ID of the game that the level to restore is on.
+         * 
+         * You must be a moderator or super moderator of the level's game.
+         */
+        gameId: string;
+
+        /**
+         * ID of the level to restore.
+         */
+        levelId: string;
+    };
 
     /**
-     * New settings for the category.
+     * Re-orders levels in a game.
+     * 
+     * You must be a moderator or super moderator of the level's game.
      */
-    category: Interfaces.Category;
-}
+    PutLevelOrder: {
+
+        /**
+         * ID of the game to order levels on.
+         */
+        gameId: string;
 
-/**
- * Archives a category.
- */
-export interface PutCategoryArchive {
+        /**
+         * The new order of levels.
+         */
+        levelIds: string[];
+    };
 
     /**
-     * ID of the game the category is on.
+     * Creates a new variable.
+     * 
+     * You must be a moderator or super moderator of the variables's game.
      */
-    gameId: string;
+    PutVariable: {
+
+        /**
+         * ID of the game that the variable to create is on.
+         */
+        gameId: string;
+
+        /**
+         * Settings for the new variable.
+         */
+        variable: Interfaces.Variable;
+
+        /**
+         * Values for the new variable.
+         */
+        values: Interfaces.Value[];
+    };
 
     /**
-     * ID of the category to archive.
+     * Updates an existing variable.
      */
-    categoryId: string;
-}
+    PutVariableUpdate: {
+        gameId: string;
+        variableId: string;
 
-/**
- * Restores an archived category.
- */
-export interface PutCategoryRestore {
+        /**
+         * The new variable settings for the variable you are updating.
+         */
+        variable: Interfaces.Variable;
+        values: Interfaces.Value[];
+    };
 
     /**
-     * ID of the game that the category to restore is on.
+     * Archives a variable.
      */
-    gameId: string;
+    PutVariableArchive: {
+        gameId: string;
+        variableId: string;
+    };
 
     /**
-     * ID of the category to restore.
+     * Restores an archived variable.
      */
-    categoryId: string;
-}
-
-/**
- * Re-orders game categories.
- * 
- * You must be a moderator or super moderator of the game.
- */
-export interface PutCategoryOrder {
+    PutVariableRestore: {
+        gameId: string;
+        variableId: string;
+    };
 
     /**
-     * ID of the game to order categories on.
+     * Re-orders variables. NOTE: only all subcategories OR all annotations are taken at once.
      */
-    gameId: string;
+    PutVariableOrder: {
+        gameId: string;
+        variableId: string;
+    };
 
     /**
-     * The new order of categories.
+     * Puts a variable's default value on all runs in the variable's scope.
      */
-    categoryIds: string[];
-}
+    PutVariableApplyDefault: {
+        gameId: string;
+        variableId: string;
+    };
 
-/**
- * Creates a new game Level.
- * 
- * You must be a moderator or super moderator of the game.
- */
-export interface PutLevel {
+    /**
+     * Posts a news item to a game.
+     */
+    PutNews: {
+        // TODO: check all
+        gameId: string;
+        userId: string;
+        title: string;
+        body: string;
+        date: number;
+    };
 
     /**
-     * ID of the game to put the level on.
+     * Updates a news item.
      */
-    gameId: string;
+    PutNewsUpdate: {
+        // TODO: check all
+        newsId: string;
+        userId: string;
+        title: string;
+        body: string;
+        date: number;
+    };
 
     /**
-     * Settings for the new level.
+     * Deletes a news item.
      */
-    level: Interfaces.NewLevel;
-}
+    PutNewsDelete: {
+        newsId: string;
+    };
 
-/**
- * Updates an existing level.
- * 
- * You must be a moderator or super moderator of the level's game.
- */
-export interface PutLevelUpdate {
+    /**
+     * Posts a guide item to a game.
+     */
+    PutGuide: {
+        // TODO: check all
+        gameId: string;
+        userId: string;
+        name: string;
+        text: string;
+        date: number;
+    };
 
     /**
-     * ID of the game that the level to update is on.
+     * Updates a guide item.
      */
-    gameId: string;
+    PutGuideUpdate: {
+        // TODO: check all
+        guideId: string;
+        userId: string;
+        name: string;
+        text: string;
+        date: number;
+    };
 
     /**
-     * ID of the level to update.
+     * Deletes a guide item.
      */
-    levelId: string;
+    PutGuideDelete: {
+        guideId: string;
+    };
 
     /**
-     * New settings for the level.
+     * Posts a resource item to a game.
      */
-    level: Interfaces.Level;
-}
+    PutResource: {
+        // todo check all check base64 encoding of content and also test priority and make aliases
+        gameId: string;
+
+        /**
+         * Manager ID
+         */
+        userId: string;
 
-/**
- * Archives a level.
- * 
- * You must be a moderator or super moderator of the level's game.
- */
-export interface PutLevelArchive {
+        /**
+         * Comma-separated list of usernames
+         */
+        authorNames: string;
+        date: number;
+        name: string;
+        description: string;
+        type: Enums.ResourceType;
+        link?: string;
+        uploadFilename?: string;
+
+        /**
+         * Ex. data:application/json;base64examplebase64data
+         */
+        uploadContent?: string;
+    };
 
     /**
-     * ID of the game that the level to archive is on.
+     * Updates a resource item.
      */
-    gameId: string;
+    PutResourceUpdate: {
+        // check all check base64 encoding of content probably a `resourceId`
+
+        /**
+         * ID of the resource to update.
+         */
+        resourceId: string;
+
+        gameId: string;
+
+        /**
+         * Manager ID
+         */
+        userId: string;
+
+        /**
+         * Comma-separated list of usernames
+         */
+        authorNames: string;
+        date: number;
+        name: string;
+        description: string;
+        type: Enums.ResourceType;
+        link?: string;
+        uploadFilename?: string;
+
+        /**
+         * Ex. data:application/json;base64examplebase64data
+         */
+        uploadContent?: string;
+    };
 
     /**
-     * ID of the level to archive.
+     * Deletes a resource item.
      */
-    levelId: string;
-}
+    PutResourceDelete: {
+        resourceId: string;
+    };
 
-/**
- * Restores an archived level.
- */
-export interface PutLevelRestore {
+    /**
+     * Get moderation games and stats for the logged in user.
+     * If the user is not logged in, the response is void.
+     */
+    GetModerationGames: {};
 
     /**
-     * ID of the game that the level to restore is on.
-     * 
-     * You must be a moderator or super moderator of the level's game.
+     * Get data for runs waiting in the moderation queue for a game.
      */
-    gameId: string;
+    GetModerationRuns: {
+        gameId: string;
+        search?: string;
+        verified?: Enums.RunStatus;
+        verifiedById?: string;
+        videoState?: Enums.VideoState;
+        limit: number;
+        page: number;
+    };
 
     /**
-     * ID of the level to restore.
+     * Assigns a verifier to a run.
      */
-    levelId: string;
-}
+    PutRunAssignee: {
+        assigneeId: string;
+        runId: string;
+    };
 
-/**
- * Re-orders levels in a game.
- * 
- * You must be a moderator or super moderator of the level's game.
- */
-export interface PutLevelOrder {
+    PutRunDelete: {
+        gameId: string;
+        runId: string;
+    };
 
     /**
-     * ID of the game to order levels on.
+     * Assigns a verification level `RunStatus` to a run.
      */
-    gameId: string;
+    //TODO
+    PutRunVerification: {
+        runId: string;
+        verified: Enums.RunStatus;
+        reason?: string;
+    };
 
     /**
-     * The new order of levels.
+     * Assigns a video-at-risk state to a run.
      */
-    levelIds: string[];
-}
-
-/**
- * Creates a new variable.
- * 
- * You must be a moderator or super moderator of the variables's game.
- */
-export interface PutVariable {
+    PutRunVideoState: {
+        runId: string;
+        videoState: Enums.VideoState;
+    };
 
     /**
-     * ID of the game that the variable to create is on.
-     */
-    gameId: string;
-
-    /**
-     * Settings for the new variable.
-     */
-    variable: Interfaces.Variable;
-
-    /**
-     * Values for the new variable.
-     */
-    values: Interfaces.Value[];
-}
-
-/**
- * Updates an existing variable.
- */
-export interface PutVariableUpdate {
-    gameId: string;
-    variableId: string;
-
-    /**
-     * The new variable settings for the variable you are updating.
-     */
-    variable: Interfaces.Variable;
-    values: Interfaces.Value[];
-}
-
-/**
- * Archives a variable.
- */
-export interface PutVariableArchive {
-    gameId: string;
-    variableId: string;
-}
-
-/**
- * Restores an archived variable.
- */
-export interface PutVariableRestore {
-    gameId: string;
-    variableId: string;
-}
-
-/**
- * Re-orders variables. NOTE: only all subcategories OR all annotations are taken at once.
- */
-export interface PutVariableOrder {
-    gameId: string;
-    variableId: string;
-}
-
-/**
- * Puts a variable's default value on all runs in the variable's scope.
- */
-export interface PutVariableApplyDefault {
-    gameId: string;
-    variableId: string;
-}
+     * Gets a run's settings.
+     * TODO: check specific details on who can use
+     */
+    GetRunSettings: {
+        runId: string;
+    };
 
-/**
- * Posts a news item to a game.
- */
-export interface PutNews {
-    // TODO: check all
-    gameId: string;
-    userId: string;
-    title: string;
-    body: string;
-    date: number;
-}
+    /**
+     * Sets a run's settings or submit a new run if `settings.runId` is exempted.
+     */
+    PutRunSettings: {
 
-/**
- * Updates a news item.
- */
-export interface PutNewsUpdate {
-    // TODO: check all
-    newsId: string;
-    userId: string;
-    title: string;
-    body: string;
-    date: number;
-}
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
 
-/**
- * Deletes a news item.
- */
-export interface PutNewsDelete {
-    newsId: string;
-}
-
-/**
- * Posts a guide item to a game.
- */
-export interface PutGuide {
-    // TODO: check all
-    gameId: string;
-    userId: string;
-    name: string;
-    text: string;
-    date: number;
-}
-
-/**
- * Updates a guide item.
- */
-export interface PutGuideUpdate {
-    // TODO: check all
-    guideId: string;
-    userId: string;
-    name: string;
-    text: string;
-    date: number;
-}
-
-/**
- * Deletes a guide item.
- */
-export interface PutGuideDelete {
-    guideId: string;
-}
-
-/**
- * Posts a resource item to a game.
- */
-export interface PutResource {
-    // todo check all check base64 encoding of content and also test priority and make aliases
-    gameId: string;
-
-    /**
-     * Manager ID
-     */
-    userId: string;
-
-    /**
-     * Comma-separated list of usernames
-     */
-    authorNames: string;
-    date: number;
-    name: string;
-    description: string;
-    type: Enums.ResourceType;
-    link?: string;
-    uploadFilename?: string;
-
-    /**
-     * Ex. data:application/json;base64examplebase64data
-     */
-    uploadContent?: string;
-}
-
-/**
- * Updates a resource item.
- */
-export interface PutResourceUpdate {
-    // check all check base64 encoding of content probably a `resourceId`
-
-    /**
-     * ID of the resource to update.
-     */
-    resourceId: string;
-
-    gameId: string;
-
-    /**
-     * Manager ID
-     */
-    userId: string;
-
-    /**
-     * Comma-separated list of usernames
-     */
-    authorNames: string;
-    date: number;
-    name: string;
-    description: string;
-    type: Enums.ResourceType;
-    link?: string;
-    uploadFilename?: string;
-
-    /**
-     * Ex. data:application/json;base64examplebase64data
-     */
-    uploadContent?: string;
-}
-
-/**
- * Deletes a resource item.
- */
-export interface PutResourceDelete {
-    resourceId: string;
-}
-
-/**
- * Get moderation games and stats for the logged in user.
- * If the user is not logged in, the response is void.
- */
-export interface GetModerationGames {}
+        /**
+         * Existing run settings if `runId: string; is not None` otherwise new run's settings.
+         */
+        settings: Interfaces.RunSettings;
 
-/**
- * Get data for runs waiting in the moderation queue for a game.
- */
-export interface GetModerationRuns {
-    gameId: string;
-    search?: string;
-    verified?: Enums.RunStatus;
-    verifiedById?: string;
-    videoState?: Enums.VideoState;
-    limit?: number;
-    page?: number;
-}
+        /**
+         * If the run should be automatically verified after editing or not. - only works for game moderators.
+         */
+        autoverify: boolean;
+    };
 
-/**
- * Assigns a verifier to a run.
- */
-export interface PutRunAssignee {
-    assigneeId: string;
-    runId: string;
-}
+    /**
+     * Gets conversations the user is involved in.
+     */
+    GetConversations: {};
 
-export interface PutRunDelete {
-    gameId: string;
-    runId: string;
-}
+    /**
+     * Gets messages from a given conversation.
+     */
+    GetConversationMessages: {
+        conversationId: string;
+    };
 
-/**
- * Assigns a verification level `RunStatus` to a run.
- */
-//TODO
-export interface PutRunVerification {
-    runId: string;
-    verified: Enums.RunStatus;
-    reason?: string;
-}
+    /**
+     * Creates a new conversation. May include several users.
+     * If the conversation already exists the message is sent to the existing conversation.
+     * NOTE: if the conversation exists but the user has left it they will _not_ rejoin the conversation.
+     */
+    PutConversation: {
 
-/**
- * Assigns a video-at-risk state to a run.
- */
-export interface PutRunVideoState {
-    runId: string;
-    videoState: Enums.VideoState;
-}
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
 
-/**
- * Gets a run's settings.
- * TODO: check specific details on who can use
- */
-export interface GetRunSettings {
-    runId: string;
-}
+        /**
+         * A list of other users to add to the conversation.
+         */
+        recipientIds: string[];
 
-/**
- * Sets a run's settings or submit a new run if `settings.runId` is exempted.
- */
-export interface PutRunSettings {
+        /**
+         * Content of the initial message.
+         */
+        text: string;
+    };
 
     /**
-     * May be retrieved by `GetSession`.
+     * Sends a message to a conversation.
      */
-    csrfToken: string;
+    PutConversationMessage: {
+
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
+        text: string;
+    };
 
     /**
-     * Existing run settings if `runId: string; is not None` otherwise new run's settings.
+     * Leaves a conversation.
      */
-    settings: Interfaces.RunSettings;
+    PutConversationLeave: {
+
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
+    };
 
     /**
-     * If the run should be automatically verified after editing or not. - only works for game moderators.
+     * Reports a conversation.
      */
-    autoverify: boolean;
-}
-
-/**
- * Gets conversations the user is involved in.
- */
-export interface GetConversations {}
+    PutConversationReport: {
 
-/**
- * Gets messages from a given conversation.
- */
-export interface GetConversationMessages {
-    conversationId: string;
-}
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
 
-/**
- * Creates a new conversation. May include several users.
- * If the conversation already exists the message is sent to the existing conversation.
- * NOTE: if the conversation exists but the user has left it they will _not_ rejoin the conversation.
- */
-export interface PutConversation {
+        /**
+         * User description of the report
+         */
+        text: string;
+    };
 
     /**
-     * May be retrieved by `GetSession`.
+     * Gets your notifications.
      */
-    csrfToken: string;
+    GetNotifications: {};
+
     /**
-     * A list of other users to add to the conversation.
+     * Marks all notifications as read.
      */
-    recipientIds: string[];
+    PutNotificationsRead: {};
 
     /**
-     * Content of the initial message.
+     * Follow a game.
      */
-    text: string;
-}
+    PutGameFollower: {
+        gameId: string;
 
-/**
- * Sends a message to a conversation.
- */
-export interface PutConversationMessage {
+        /**
+         * Your `userId`.
+         */
+        userId: string;
+    };
 
     /**
-     * May be retrieved by `GetSession`.
+     * Unfollow a game.
      */
-    csrfToken: string;
-    conversationId: string;
-    text: string;
-}
+    PutGameFollowerDelete: {
+        gameId: string;
 
-/**
- * Leaves a conversation.
- */
-export interface PutConversationLeave {
+        /**
+         * Your `userId`.
+         */
+        userId: string;
+    };
 
     /**
-     * May be retrieved by `GetSession`.
+     * Follow a user.
      */
-    csrfToken: string;
-    conversationId: string;
-}
-
-/**
- * Reports a conversation.
- */
-export interface PutConversationReport {
+    PutUserFollower: {
+        userId: string;
+    };
 
     /**
-     * May be retrieved by `GetSession`.
+     * Unfollow a user.
      */
-    csrfToken: string;
-    conversationId: string;
+    PutUserFollowerDelete: {
+        userId: string;
+    };
 
     /**
-     * User description of the report
+     * Gets a user's settings.
      */
-    text: string;
-}
+    GetUserSettings: {
 
-// User notifications & follows
-
-/**
- * Gets your notifications.
- */
-export interface GetNotifications {}
-
-/**
- * Marks all notifications as read.
- */
-export interface PutNotificationsRead {}
-
-/**
- * Follow a game.
- */
-export interface PutGameFollower {
-    gameId: string;
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+    };
 
     /**
-     * Your `userId`.
+     * Sets a user's settings.
      */
-    userId: string;
-}
+    PutUserSettings: {
 
-/**
- * Unfollow a game.
- */
-export interface PutGameFollowerDelete {
-    gameId: string;
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        settings: Interfaces.UserSettings;
+    };
 
     /**
-     * Your `userId`.
+     * Sets the run featured on a user's profile.
      */
-    userId: string;
-}
-
-/**
- * Follow a user.
- */
-export interface PutUserFollower {
-    userId: string;
-}
+    PutUserUpdateFeaturedRun: {
 
-/**
- * Unfollow a user.
- */
-export interface PutUserFollowerDelete {
-    userId: string;
-}
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
 
-// User settings
+        /**
+         * If omitted clears the full game featured run.
+         */
+        fullRunId?: string;
 
-/**
- * Gets a user's settings.
- */
-export interface GetUserSettings {
+        /**
+         * If omitted clears the level featured run.
+         */
+        levelRunId?: string;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Updates the order of games displayed on your profile.
+     * Note that having multiple GameOrderGroups is a Supporter-only feature. The default group has fixed id of `default`.
      */
-    userUrl: string;
-}
+    PutUserUpdateGameOrdering: {
 
-/**
- * Sets a user's settings.
- */
-export interface PutUserSettings {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        groups: Interfaces.GameOrderGroup;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Get a user's API key (the authorization method for API version 1).
      */
-    userUrl: string;
-    settings: Interfaces.UserSettings;
-}
+    GetUserApiKey: {
+        userId: string;
 
-/**
- * Sets the run featured on a user's profile.
- */
-export interface PutUserUpdateFeaturedRun {
+        /**
+         * Returns a new API key if `true`.
+         */
+        regenerate: boolean;
+    };
+
+    GetUserFollowers: {
+        userId: string;
+        limit?: number;
+        page?: number;
+    };
+
+    GetUserFollowingGames: {
+        userId: string;
+        limit?: number;
+        page?: number;
+    };
+
+    GetUserFollowingUsers: {
+        userId: string;
+        limit?: number;
+        page?: number;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Get a list of games that a user has boosted.
      */
-    userUrl: string;
+    GetUserGameBoostData: {
+        userId: string;
+    };
 
     /**
-     * If omitted clears the full game featured run.
+     * Get a user's exported data.
      */
-    fullRunId?: string;
+    GetUserDataExport: {
+        userId: string;
+    };
 
     /**
-     * If omitted clears the level featured run.
+     * Reorder a your account's followed games.
      */
-    levelRunId?: string;
-}
+    PutGameFollowerOrder: {
 
-/**
- * Updates the order of games displayed on your profile.
- * Note that having multiple GameOrderGroups is a Supporter-only feature. The default group has fixed id of `default`.
- */
-export interface PutUserUpdateGameOrdering {
+        /**
+         * List of `gameId`s in the order they should be in
+         */
+        gameId: string[];
+        userId: string;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Submits a site article.
      */
-    userUrl: string;
-    groups: Interfaces.GameOrderGroup;
-}
-
-/**
- * Get a user's API key (the authorization method for API version 1).
- */
-export interface GetUserApiKey {
-    userId: string;
+    PutArticleSubmission: {
+        title: string;
+        summary: string;
+        body: string;
+        game?: string;
+        publishTags?: string[];
+    }; // todo coverImagePath?: string;
 
     /**
-     * Returns a new API key if `true`.
+     * Checks the comment permissions on an item.
      */
-    regenerate: boolean;
-}
+    GetCommentable: {
+        itemId: string;
+        itemType: Enums.ItemType;
+    };
 
-export interface GetUserFollowers {
-    userId: string;
-    limit?: number;
-    page?: number;
-}
-
-export interface GetUserFollowingGames {
-    userId: string;
-    limit?: number;
-    page?: number;
-}
+    /**
+     * Posts a comment on an item.
+     */
+    PutComment: {
+        itemId: string;
+        itemType: Enums.ItemType;
+        text: string;
+    };
 
-export interface GetUserFollowingUsers {
-    userId: string;
-    limit?: number;
-    page?: number;
-}
+    /**
+     * Adds or removes a like to a comment.
+     */
+    PutLike: {
 
-/**
- * Get a list of games that a user has boosted.
- */
-export interface GetUserGameBoostData {
-    userId: string;
-}
+        /**
+         * ID 0f the item you are liking or removing your like from.
+         */
+        itemId: string;
 
-/**
- * Get a user's exported data.
- */
-export interface GetUserDataExport {
-    userId: string;
-}
+        /**
+         * `ItemType` of the item you are liking or removing your like from.
+         */
+        itemType: Enums.ItemType;
 
-/**
- * Reorder a your account's followed games.
- */
-export interface PutGameFollowerOrder {
+        /**
+         * Whether you are liking a comment (`true`) or removing your like from a comment (`false`).
+         * 
+         * `false` when exempted.
+         */
+        like?: boolean;
+    };
 
     /**
-     * List of `gameId`s in the order they should be in
+     * Updates commentable settings on an item.
      */
-    gameId: string[];
-    userId: string;
-}
+    PutCommentableSettings: {
 
-/**
- * Submits a site article.
- */
-export interface PutArticleSubmission {
-    title: string;
-    summary: string;
-    body: string;
-    game?: string;
-    publishTags?: string[];
-} // todo coverImagePath?: string;
+        /**
+         * ID of the item you are modifying the comment settings on.
+         */
+        itemId: string;
 
-/**
- * Checks the comment permissions on an item.
- */
-export interface GetCommentable {
-    itemId: string;
-    itemType: Enums.ItemType;
-}
+        /**
+         * `itemType` of the item you are modifying the comment settings on.
+         */
+        itemType: Enums.ItemType;
+        disabled: boolean;
+        locked: boolean;
+    };
 
-/**
- * Posts a comment on an item.
- */
-export interface PutComment {
-    itemId: string;
-    itemType: Enums.ItemType;
-    text: string;
-}
+    /**
+     * Gets whether a set of threads have been read by the user.
+     */
+    GetThreadReadStatus: {
 
-/**
- * Adds or removes a like to a comment.
- */
-export interface PutLike {
+        /**
+         * List of thread IDs to get read status from.
+         */
+        threadIds: string[];
+    };
 
     /**
-     * ID 0f the item you are liking or removing your like from.
+     * Sets a thread as read by the user.
      */
-    itemId: string;
+    PutThreadRead: {
+        threadId: string;
+    };
 
     /**
-     * `ItemType` of the item you are liking or removing your like from.
-     */
-    itemType: Enums.ItemType;
+     * Gets whether a set of forums have been read by the user.
+     */
+    GetForumReadStatus: {
+
+        /**
+         * List of forum IDs to get read status from.
+         */
+        forumIds: string[];
+    };
 
     /**
-     * Whether you are liking a comment (`true`) or removing your like from a comment (`false`).
-     * 
-     * `false` when exempted.
+     * Gets a user game or series' theme.  # TODO: check noargs & series
      */
-    like?: boolean;
-}
+    GetThemeSettings: {
 
-/**
- * Updates commentable settings on an item.
- */
-export interface PutCommentableSettings {
+        // One of:
+        userId?: string;
+        gameId?: string;
+        seriesId?: string;
+    };
 
     /**
-     * ID of the item you are modifying the comment settings on.
+     * Sets a user, game, or series' theme.
      */
-    itemId: string;
+    PutThemeSettings: {
+        // One of:
+        userId?: string;
+        gameId?: string;
+        seriesId?: string;
+        settings: Interfaces.ThemeSettings;
+    };
 
     /**
-     * `itemType` of the item you are modifying the comment settings on.
+     * Gets supporter data for your account.
      */
-    itemType: Enums.ItemType;
-    disabled: boolean;
-    locked: boolean;
-}
+    GetUserSupporterData: {
 
-/**
- * Gets whether a set of threads have been read by the user.
- */
-export interface GetThreadReadStatus {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+    };
 
     /**
-     * List of thread IDs to get read status from.
+     * Get data used to construct a payment form.
      */
-    threadIds: string[];
-}
+    PutUserSupporterNewSubscription: {
+        planKey?: Enums.SupportPlanPeriod
+        userUrl?: string;
+    };
 
-/**
- * Sets a thread as read by the user.
- */
-export interface PutThreadRead {
-    threadId: string;
-}
-
-// Forum actions
+    /**
+     * Adds a boost to a game.
+     */
+    PutGameBoostGrant: {
+        gameId: string;
+        anonymous: boolean;
+    };
 
-/**
- * Gets whether a set of forums have been read by the user.
- */
-export interface GetForumReadStatus {
+    /**
+     * Sends a request for contact to SRC for collaboration.
+     */
+    PutAdvertiseContact: {
+        name: string;
+        company: string;
+        email: string;
+        message: string;
+    };
 
     /**
-     * List of forum IDs to get read status from.
+     * Gets tickets submitted by you.
      */
-    forumIds: string[];
-}
+    GetTickets: {
 
-/**
- * Gets a user game or series' theme.  # TODO: check noargs & series
- */
-export interface GetThemeSettings {
+        /**
+         * list of ticket IDs to fetch
+         */
+        ticketIds: string[];
 
-    // One of:
-    userId?: string;
-    gameId?: string;
-    seriesId?: string;
-}
+        /**
+         * list of `TicketQueueType` to filter by
+         */
+        queues: Enums.TicketQueueType[];
 
-/**
- * Sets a user, game, or series' theme.
- */
-export interface PutThemeSettings {
-    // One of:
-    userId?: string;
-    gameId?: string;
-    seriesId?: string;
-    settings: Interfaces.ThemeSettings;
-}
+        /**
+         * list of `TicketType`
+         */
+        types: Enums.TicketType[];
 
-// Supporter
+        /**
+         * list of `TicketStatus`
+         */
+        statuses: Enums.TicketStatus[];
 
-/**
- * Gets supporter data for your account.
- */
-export interface GetUserSupporterData {
+        /**
+         * List of `userId`s. Must only have your `userId`.
+         */
+        requestorIds: string[];
+        search: string;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Gets settings of a series.
      */
-    userUrl: string;
-}
-
-/**
- * Get data used to construct a payment form.
- */
-export interface PutUserSupporterNewSubscription {
-    planKey?: Enums.SupportPlanPeriod
-    userUrl?: string;
-}
+    GetSeriesSettings: {
+        seriesId: string;
+    };
 
-/**
- * Adds a boost to a game.
- */
-export interface PutGameBoostGrant {
-    gameId: string;
-    anonymous: boolean;
-}
+    /**
+     * Gets blocks of you blocking a user and users blocking you.
+     */
+    GetUserBlocks: {};
 
-// To Be Sorted
+    /**
+     * Blocks or unblocks a user on your account.
+     */
+    PutUserBlock: {
 
-/**
- * Sends a request for contact to SRC for collaboration.
- */
-export interface PutAdvertiseContact {
-    name: string;
-    company: string;
-    email: string;
-    message: string;
-}
+        /**
+         * Whether or not you are blocking (`true`) or unblocking (`false`) the user.
+         */
+        block: boolean;
 
-/**
- * Gets tickets submitted by you.
- */
-export interface GetTickets {
+        /**
+         * `userId` of you are blocking.
+         */
+        blockeeId: string;
+    };
 
     /**
-     * list of ticket IDs to fetch
+     * Add a new game.
      */
-    ticketIds: string[];
+    PutGame: { // TODO: needs param testing
+        name: string;
+        releaseDate: number;
+
+        /**
+         * list of `GameType`
+         */
+        gameTypeIds: string[];
+
+        /**
+         * If one of the GameTypes supports a baseGame then this can be included with a game id.
+         */
+        baseGame: string;
+        seriesId: string;
+    };
 
     /**
-     * list of `TicketQueueType` to filter by
+     * Add a moderator to a game.
      */
-    queues: Enums.TicketQueueType[];
+    PutGameModerator: Interfaces.GameModerator;
 
     /**
-     * list of `TicketType`
+     * Remove a moderator from a game.
+     * TODO: test `level` necessity & enum type
      */
-    types: Enums.TicketType[];
+    PutGameModeratorDelete: {
+        gameId: string;
+        userId: string;
+    };
 
     /**
-     * list of `TicketStatus`
+     * Add an existing game to a series.
      */
-    statuses: Enums.TicketStatus[];
+    PutSeriesGame: {
+        seriesId: string;
+        gameId: string;
+    };
 
     /**
-     * List of `userId`s. Must only have your `userId`.
+     * Remove a game from a series.
+     * 
+     * Does not delete the game.
      */
-    requestorIds: string[];
-    search: string;
-}
+    PutSeriesGameDelete: {
+        seriesId: string;
+        gameId: string;
+    };
 
-/**
- * Gets settings of a series.
- */
+    PutSeriesModerator: Interfaces.SeriesModerator;
 
-export interface GetSeriesSettings {
-    seriesId: string;
-}
+    PutSeriesModeratorUpdate: Interfaces.SeriesModerator;
 
-/**
- * Gets blocks of you blocking a user and users blocking you.
- */
-export interface GetUserBlocks {}
+    PutSeriesModeratorDelete: Interfaces.SeriesModerator;
 
-/**
- * Blocks or unblocks a user on your account.
- */
-export interface PutUserBlock {
+    PutSeriesSettings: {
+        seriesId: string;
+        settings: Interfaces.SeriesSettings;
+    };
 
     /**
-     * Whether or not you are blocking (`true`) or unblocking (`false`) the user.
+     * Submits support tickets.
      */
-    block: boolean;
+    PutTicket: {
+
+        /**
+         * a JSON string of ticket data
+         */
+        metadata: string;
+
+        /**
+         * TODO: check TicketType vs TicketQueue Type
+         */
+        type: Enums.TicketType;
+    };
+
+    PutTicketNote: {
+        ticketId: string;
+        note: string;
+
+        /**
+         * Whether the note is a message to the user. `false` only permitted for admins.
+         */
+        isMessage: string;
+    };
 
     /**
-     * `userId` of you are blocking.
+     * Modifies a user's social connection.
+     * todo verification?
      */
-    blockeeId: string;
-}
+    PutUserSocialConnection: {
+        userId: string;
+        networkId: Enums.SocialConnection;
+        value: string;
+    };
 
-/**
- * Add a new game.
- */
-export interface PutGame { // TODO: needs param testing
-    name: string;
-    releaseDate: number;
+    /**
+     * Remove a user's social connection.
+     */
+    PutUserSocialConnectionDelete: {
+        userId: string;
+        networkId: Enums.SocialConnection;
+    };
 
+    /**
+     * Undocumented.
+     */
+    PutUserSocialConnectionSsoExchange: {
+        userId: string;
+        provider: string;
+        state: string;
+        code: string;
+    };
 
     /**
-     * list of `GameType`
+     * Update a user's password.
      */
-    gameTypeIds: string[];
+    PutUserUpdatePassword: {
+        userUrl: string;
+        oldPassword: string;
+        newPassword: string;
+    };
 
     /**
-     * If one of the GameTypes supports a baseGame then this can be included with a game id.
+     * Update a user's email.
+     * First you send userUrl email and password. SRC will respond with `tokenChallengeSent: true`
+     * Afterwards you send the above data again but this time with `token` set.
      */
-    baseGame: string;
-    seriesId: string;
-}
+    PutUserUpdateEmail: {
 
-/**
- * Add a moderator to a game.
- */
-export interface PutGameModerator extends Interfaces.GameModerator {}
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
 
-/**
- * Remove a moderator from a game.
- * TODO: test `level` necessity & enum type
- */
-export interface PutGameModeratorDelete {
-    gameId: string;
-    userId: string;
-}
+        /**
+         * The **new** email you want to have for the account.
+         */
+        email: string;
+        token?: string;
+        password: string;
+    };
 
-/**
- * Add an existing game to a series.
- */
-export interface PutSeriesGame {
-    seriesId: string;
-    gameId: string;
-}
+    /**
+     * Updates your name.
+     * You must wait 60 days after changing your name to change it again.
+     */
+    PutUserUpdateName: {
 
-/**
- * Remove a game from a series.
- * 
- * Does not delete the game.
- */
-export interface PutSeriesGameDelete {
-    seriesId: string;
-    gameId: string;
-}
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        newName: string;
 
-export interface PutSeriesModerator extends Interfaces.SeriesModerator {}
+        /**
+         * Whether or not 
+         */
+        acceptTerms: boolean;
+        // TODO: check if these are mandatory
+    };
 
-export interface PutSeriesModeratorUpdate extends Interfaces.SeriesModerator {}
+    PutUserDelete: {
+        userUrl: string;
+        password: string;
+    };
 
-export interface PutSeriesModeratorDelete extends Interfaces.SeriesModerator {}
+    /**
+     * Updates a comment.
+     */
+    PutCommentUpdate: {
 
-export interface PutSeriesSettings {
-    seriesId: string;
-    settings: Interfaces.SeriesSettings;
-}
+        /**
+         * ID of the comment to update.
+         */
+        commentId: string;
 
-/**
- * Submits support tickets.
- */
-export interface PutTicket {
+        /**
+         * New text of the comment.
+         */
+        text: string;
+    };
 
     /**
-     * a JSON string of ticket data
+     * Deletes a comment.
      */
-    metadata: string;
+    PutCommentDelete: {
+        commentId: string;
+    };
 
     /**
-     * TODO: check TicketType vs TicketQueue Type
+     * Restores a deleted comment
      */
-    type: Enums.TicketType;
-}
-
-export interface PutTicketNote {
-    ticketId: string;
-    note: string;
+    PutCommentRestore: {
+        commentId: string;
+    };
 
     /**
-     * Whether the note is a message to the user. `false` only permitted for admins.
+     * Create a new thread on a forum.
      */
-    isMessage: string;
-}
+    PutThread: {
+        forumId: string;
+        name: string;
+        body: string;
+    };
 
-/**
- * Modifies a user's social connection.
- * todo verification?
- */
-export interface PutUserSocialConnection {
-    userId: string;
-    networkId: Enums.SocialConnection;
-    value: string;
-}
-
-/**
- * Remove a user's social connection.
- */
-export interface PutUserSocialConnectionDelete {
-    userId: string;
-    networkId: Enums.SocialConnection;
-}
-
-/**
- * Undocumented.
- */
-export interface PutUserSocialConnectionSsoExchange {
-    userId: string;
-    provider: string;
-    state: string;
-    code: string;
-}
-
-/**
- * Update a user's password.
- */
-export interface PutUserUpdatePassword {
-    userUrl: string;
-    oldPassword: string;
-    newPassword: string;
-}
-
-/**
- * Update a user's email.
- * First you send userUrl email and password. SRC will respond with `tokenChallengeSent: true`
- * Afterwards you send the above data again but this time with `token` set.
- */
-export interface PutUserUpdateEmail {
-
-    /**
-     * Your user page URL for your account.
-     */
-    userUrl: string;
-
-    /**
-     * The **new** email you want to have for the account.
+    /**
+     * Locks or unlocks a thread.
      */
-    email: string;
-    token?: string;
-    password: string;
-}
-
-/**
- * Updates your name.
- * You must wait 60 days after changing your name to change it again.
- */
-export interface PutUserUpdateName {
+    PutThreadLocked: {
+        threadId: string;
+        locked: boolean;
+    };
 
     /**
-     * Your user page URL for your account.
+     * Pins or un-pins a thread.
      */
-    userUrl: string;
-    newName: string;
+    PutThreadSticky: {
+        threadId: string;
+        sticky: boolean;
+    };
 
-    /**
-     * Whether or not 
+    /**
+     * Delete a thread.
      */
-    acceptTerms: boolean;
-    // TODO: check if these are mandatory
-}
-
-export interface PutUserDelete {
-    userUrl: string;
-    password: string;
-}
-
-/**
- * Updates a comment.
- */
-export interface PutCommentUpdate {
-    
-    /**
-     * ID of the comment to update.
-     */
-    commentId: string;
-
-    /**
-     * New text of the comment.
-     */
-    text: string;
-}
-
-/**
- * Deletes a comment.
- */
-export interface PutCommentDelete {
-    commentId: string;
-}
-
-/**
- * Restores a deleted comment
- */
-export interface PutCommentRestore {
-    commentId: string;
-}
-
-/**
- * Create a new thread on a forum.
- */
-export interface PutThread {
-    forumId: string;
-    name: string;
-    body: string;
-}
-
-/**
- * Locks or unlocks a thread.
- */
-export interface PutThreadLocked {
-threadId: string;
-locked: boolean;
-}
+    PutThreadDelete: {
+        threadId: string;
+    };
 
-/**
- * Pins or un-pins a thread.
- */
-export interface PutThreadSticky {
-    threadId: string;
-    sticky: boolean;
-}
-
-/**
- * Delete a thread.
- */
-export interface PutThreadDelete {
-    threadId: string;
+    /**
+     * Gets a game, series, or your account's audit log.
+     * 
+     * If getting a game or series audit log, you must be a Super Moderator for it.
+     * 
+     * If getting your account's audit log, your account must not be banned.
+     * 
+     * If multiple item ID parameters are called, it will fetch events concurrent to the items (ex. getting added as a moderator to the game).
+     */
+    GetAuditLogList: AtLeastOne<{
+
+        /**
+         * An `EventType` of an event.
+         */
+        eventType?: Enums.EventType;
+
+        /**
+         * ID of a game.
+         */
+        gameId?: string;
+
+        /**
+         * ID of a series.
+         */
+        seriesId?: string;
+
+        /**
+         * ID of the user.
+         */
+        userId?: string;
+
+        /**
+         * The maximum amount of `AuditLogEntry`s to fetch.
+         */
+        limit?: number;
+
+        /**
+         * The audit log page, in relation to `limit`.
+         */
+        page?: number;
+    }, 'gameId' | 'seriesId' | 'userId'>;
 }