speedruncom.js 1.3.1 → 2.0.0

package/lib/endpoints/endpoints.post.d.ts

@@ -0,0 +1,1055 @@
+import * as Enums from '../enums';
+import * as Interfaces from '../interfaces';
+import { AtLeastOne } from '../types';
+export default interface POSTEndpoints {
+    /**
+     * 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.
+     */
+    PutAuthLogin: {
+        /**
+         * The username of the account.
+         */
+        name: string;
+        /**
+         * The password of the account.
+         */
+        password: string;
+        /**
+         * Five-digit token sent to the account's email after a call to an account that has 2 factor authentication.
+         */
+        token?: string;
+    };
+    /**
+     * Gets information about the current user's session.
+     * Most notably `csrfToken`, required for `PutRunSettings`, `PutConversation`, `PutConversationMessage`, `PutConversationLeave` and `PutConversationReport.
+     */
+    GetSession: {};
+    /**
+     * todo test which credentials this is for
+     */
+    PutSessionPing: {};
+    /**
+     * Gets a game's settings.
+     *
+     * You must be a verifier, moderator, or super moderator in the game.
+     */
+    GetGameSettings: {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+    };
+    /**
+     * Set a game's settings.
+     *
+     * You must be a moderator or super moderator in a game.
+     */
+    PutGameSettings: {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+        /**
+         * New game settings.
+         */
+        settings: Interfaces.GameSettings;
+    };
+    /**
+     * Creates a new category.
+     */
+    PutCategory: {
+        /**
+         * ID of the game.
+         */
+        gameId: string;
+        /**
+         * Settings for the new category.
+         */
+        category: Interfaces.Category;
+    };
+    /**
+     * Updates an existing category.
+     */
+    PutCategoryUpdate: {
+        /**
+         * ID of the game the category is on.
+         */
+        gameId: string;
+        /**
+         * ID of the category.
+         */
+        categoryId: string;
+        /**
+         * New settings for the category.
+         */
+        category: Interfaces.Category;
+    };
+    /**
+     * Archives a category.
+     */
+    PutCategoryArchive: {
+        /**
+         * ID of the game the category is on.
+         */
+        gameId: string;
+        /**
+         * ID of the category to archive.
+         */
+        categoryId: string;
+    };
+    /**
+     * Restores an archived category.
+     */
+    PutCategoryRestore: {
+        /**
+         * ID of the game that the category to restore is on.
+         */
+        gameId: string;
+        /**
+         * ID of the category to restore.
+         */
+        categoryId: string;
+    };
+    /**
+     * Re-orders game categories.
+     *
+     * You must be a moderator or super moderator of the game.
+     */
+    PutCategoryOrder: {
+        /**
+         * ID of the game to order categories on.
+         */
+        gameId: string;
+        /**
+         * The new order of categories.
+         */
+        categoryIds: string[];
+    };
+    /**
+     * Creates a new game Level.
+     *
+     * You must be a moderator or super moderator of the game.
+     */
+    PutLevel: {
+        /**
+         * ID of the game to put the level on.
+         */
+        gameId: string;
+        /**
+         * Settings for the new level.
+         */
+        level: Interfaces.NewLevel;
+    };
+    /**
+     * Updates an existing level.
+     *
+     * You must be a moderator or super moderator of the level's game.
+     */
+    PutLevelUpdate: {
+        /**
+         * ID of the game that the level to update is on.
+         */
+        gameId: string;
+        /**
+         * ID of the level to update.
+         */
+        levelId: string;
+        /**
+         * New settings for the level.
+         */
+        level: Interfaces.Level;
+    };
+    /**
+     * Archives a level.
+     *
+     * You must be a moderator or super moderator of the level's game.
+     */
+    PutLevelArchive: {
+        /**
+         * ID of the game that the level to archive is on.
+         */
+        gameId: string;
+        /**
+         * ID of the level to archive.
+         */
+        levelId: string;
+    };
+    /**
+     * Restores an archived level.
+     */
+    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;
+    };
+    /**
+     * Re-orders levels in a game.
+     *
+     * You must be a moderator or super moderator of the level's game.
+     */
+    PutLevelOrder: {
+        /**
+         * ID of the game to order levels on.
+         */
+        gameId: string;
+        /**
+         * The new order of levels.
+         */
+        levelIds: string[];
+    };
+    /**
+     * Creates a new variable.
+     *
+     * You must be a moderator or super moderator of the variables's game.
+     */
+    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[];
+    };
+    /**
+     * Updates an existing variable.
+     */
+    PutVariableUpdate: {
+        gameId: string;
+        variableId: string;
+        /**
+         * The new variable settings for the variable you are updating.
+         */
+        variable: Interfaces.Variable;
+        values: Interfaces.Value[];
+    };
+    /**
+     * Archives a variable.
+     */
+    PutVariableArchive: {
+        gameId: string;
+        variableId: string;
+    };
+    /**
+     * Restores an archived variable.
+     */
+    PutVariableRestore: {
+        gameId: string;
+        variableId: string;
+    };
+    /**
+     * Re-orders variables. NOTE: only all subcategories OR all annotations are taken at once.
+     */
+    PutVariableOrder: {
+        gameId: string;
+        variableId: string;
+    };
+    /**
+     * Puts a variable's default value on all runs in the variable's scope.
+     */
+    PutVariableApplyDefault: {
+        gameId: string;
+        variableId: string;
+    };
+    /**
+     * Posts a news item to a game.
+     */
+    PutNews: {
+        gameId: string;
+        userId: string;
+        title: string;
+        body: string;
+        date: number;
+    };
+    /**
+     * Updates a news item.
+     */
+    PutNewsUpdate: {
+        newsId: string;
+        userId: string;
+        title: string;
+        body: string;
+        date: number;
+    };
+    /**
+     * Deletes a news item.
+     */
+    PutNewsDelete: {
+        newsId: string;
+    };
+    /**
+     * Posts a guide item to a game.
+     */
+    PutGuide: {
+        gameId: string;
+        userId: string;
+        name: string;
+        text: string;
+        date: number;
+    };
+    /**
+     * Updates a guide item.
+     */
+    PutGuideUpdate: {
+        guideId: string;
+        userId: string;
+        name: string;
+        text: string;
+        date: number;
+    };
+    /**
+     * Deletes a guide item.
+     */
+    PutGuideDelete: {
+        guideId: string;
+    };
+    /**
+     * Posts a resource item to a game.
+     */
+    PutResource: {
+        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.
+     */
+    PutResourceUpdate: {
+        /**
+         * 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.
+     */
+    PutResourceDelete: {
+        resourceId: string;
+    };
+    /**
+     * Get moderation games and stats for the logged in user.
+     * If the user is not logged in, the response is void.
+     */
+    GetModerationGames: {};
+    /**
+     * Get data for runs waiting in the moderation queue for a game.
+     */
+    GetModerationRuns: {
+        gameId: string;
+        search?: string;
+        verified?: Enums.RunStatus;
+        verifiedById?: string;
+        videoState?: Enums.VideoState;
+        limit: number;
+        page: number;
+    };
+    /**
+     * Assigns a verifier to a run.
+     */
+    PutRunAssignee: {
+        assigneeId: string;
+        runId: string;
+    };
+    PutRunDelete: {
+        gameId: string;
+        runId: string;
+    };
+    /**
+     * Assigns a verification level `RunStatus` to a run.
+     */
+    PutRunVerification: {
+        runId: string;
+        verified: Enums.RunStatus;
+        reason?: string;
+    };
+    /**
+     * Assigns a video-at-risk state to a run.
+     */
+    PutRunVideoState: {
+        runId: string;
+        videoState: Enums.VideoState;
+    };
+    /**
+     * Gets a run's settings.
+     * TODO: check specific details on who can use
+     */
+    GetRunSettings: {
+        runId: string;
+    };
+    /**
+     * Sets a run's settings or submit a new run if `settings.runId` is exempted.
+     */
+    PutRunSettings: {
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        /**
+         * Existing run settings if `runId: string; is not None` otherwise new run's settings.
+         */
+        settings: Interfaces.RunSettings;
+        /**
+         * If the run should be automatically verified after editing or not. - only works for game moderators.
+         */
+        autoverify: boolean;
+    };
+    /**
+     * Gets conversations the user is involved in.
+     */
+    GetConversations: {};
+    /**
+     * Gets messages from a given conversation.
+     */
+    GetConversationMessages: {
+        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.
+     */
+    PutConversation: {
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        /**
+         * A list of other users to add to the conversation.
+         */
+        recipientIds: string[];
+        /**
+         * Content of the initial message.
+         */
+        text: string;
+    };
+    /**
+     * Sends a message to a conversation.
+     */
+    PutConversationMessage: {
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
+        text: string;
+    };
+    /**
+     * Leaves a conversation.
+     */
+    PutConversationLeave: {
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
+    };
+    /**
+     * Reports a conversation.
+     */
+    PutConversationReport: {
+        /**
+         * May be retrieved by `GetSession`.
+         */
+        csrfToken: string;
+        conversationId: string;
+        /**
+         * User description of the report
+         */
+        text: string;
+    };
+    /**
+     * Gets your notifications.
+     */
+    GetNotifications: {};
+    /**
+     * Marks all notifications as read.
+     */
+    PutNotificationsRead: {};
+    /**
+     * Follow a game.
+     */
+    PutGameFollower: {
+        gameId: string;
+        /**
+         * Your `userId`.
+         */
+        userId: string;
+    };
+    /**
+     * Unfollow a game.
+     */
+    PutGameFollowerDelete: {
+        gameId: string;
+        /**
+         * Your `userId`.
+         */
+        userId: string;
+    };
+    /**
+     * Follow a user.
+     */
+    PutUserFollower: {
+        userId: string;
+    };
+    /**
+     * Unfollow a user.
+     */
+    PutUserFollowerDelete: {
+        userId: string;
+    };
+    /**
+     * Gets a user's settings.
+     */
+    GetUserSettings: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+    };
+    /**
+     * Sets a user's settings.
+     */
+    PutUserSettings: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        settings: Interfaces.UserSettings;
+    };
+    /**
+     * Sets the run featured on a user's profile.
+     */
+    PutUserUpdateFeaturedRun: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        /**
+         * If omitted clears the full game featured run.
+         */
+        fullRunId?: string;
+        /**
+         * If omitted clears the level featured run.
+         */
+        levelRunId?: string;
+    };
+    /**
+     * 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`.
+     */
+    PutUserUpdateGameOrdering: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        groups: Interfaces.GameOrderGroup;
+    };
+    /**
+     * Get a user's API key (the authorization method for API version 1).
+     */
+    GetUserApiKey: {
+        userId: string;
+        /**
+         * 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;
+    };
+    /**
+     * Get a list of games that a user has boosted.
+     */
+    GetUserGameBoostData: {
+        userId: string;
+    };
+    /**
+     * Get a user's exported data.
+     */
+    GetUserDataExport: {
+        userId: string;
+    };
+    /**
+     * Reorder a your account's followed games.
+     */
+    PutGameFollowerOrder: {
+        /**
+         * List of `gameId`s in the order they should be in
+         */
+        gameId: string[];
+        userId: string;
+    };
+    /**
+     * Submits a site article.
+     */
+    PutArticleSubmission: {
+        title: string;
+        summary: string;
+        body: string;
+        game?: string;
+        publishTags?: string[];
+    };
+    /**
+     * Checks the comment permissions on an item.
+     */
+    GetCommentable: {
+        itemId: string;
+        itemType: Enums.ItemType;
+    };
+    /**
+     * Posts a comment on an item.
+     */
+    PutComment: {
+        itemId: string;
+        itemType: Enums.ItemType;
+        text: string;
+    };
+    /**
+     * Adds or removes a like to a comment.
+     */
+    PutLike: {
+        /**
+         * ID 0f the item you are liking or removing your like from.
+         */
+        itemId: string;
+        /**
+         * `ItemType` of the item you are liking or removing your like from.
+         */
+        itemType: Enums.ItemType;
+        /**
+         * Whether you are liking a comment (`true`) or removing your like from a comment (`false`).
+         *
+         * `false` when exempted.
+         */
+        like?: boolean;
+    };
+    /**
+     * Updates commentable settings on an item.
+     */
+    PutCommentableSettings: {
+        /**
+         * ID of the item you are modifying the comment settings on.
+         */
+        itemId: string;
+        /**
+         * `itemType` of the item you are modifying the comment settings on.
+         */
+        itemType: Enums.ItemType;
+        disabled: boolean;
+        locked: boolean;
+    };
+    /**
+     * Gets whether a set of threads have been read by the user.
+     */
+    GetThreadReadStatus: {
+        /**
+         * List of thread IDs to get read status from.
+         */
+        threadIds: string[];
+    };
+    /**
+     * Sets a thread as read by the user.
+     */
+    PutThreadRead: {
+        threadId: string;
+    };
+    /**
+     * Gets whether a set of forums have been read by the user.
+     */
+    GetForumReadStatus: {
+        /**
+         * List of forum IDs to get read status from.
+         */
+        forumIds: string[];
+    };
+    /**
+     * Gets a user game or series' theme.  # TODO: check noargs & series
+     */
+    GetThemeSettings: {
+        userId?: string;
+        gameId?: string;
+        seriesId?: string;
+    };
+    /**
+     * Sets a user, game, or series' theme.
+     */
+    PutThemeSettings: {
+        userId?: string;
+        gameId?: string;
+        seriesId?: string;
+        settings: Interfaces.ThemeSettings;
+    };
+    /**
+     * Gets supporter data for your account.
+     */
+    GetUserSupporterData: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+    };
+    /**
+     * Get data used to construct a payment form.
+     */
+    PutUserSupporterNewSubscription: {
+        planKey?: Enums.SupportPlanPeriod;
+        userUrl?: string;
+    };
+    /**
+     * Adds a boost to a game.
+     */
+    PutGameBoostGrant: {
+        gameId: string;
+        anonymous: boolean;
+    };
+    /**
+     * Sends a request for contact to SRC for collaboration.
+     */
+    PutAdvertiseContact: {
+        name: string;
+        company: string;
+        email: string;
+        message: string;
+    };
+    /**
+     * Gets tickets submitted by you.
+     */
+    GetTickets: {
+        /**
+         * list of ticket IDs to fetch
+         */
+        ticketIds: string[];
+        /**
+         * list of `TicketQueueType` to filter by
+         */
+        queues: Enums.TicketQueueType[];
+        /**
+         * list of `TicketType`
+         */
+        types: Enums.TicketType[];
+        /**
+         * list of `TicketStatus`
+         */
+        statuses: Enums.TicketStatus[];
+        /**
+         * List of `userId`s. Must only have your `userId`.
+         */
+        requestorIds: string[];
+        search: string;
+    };
+    /**
+     * Gets settings of a series.
+     */
+    GetSeriesSettings: {
+        seriesId: string;
+    };
+    /**
+     * Gets blocks of you blocking a user and users blocking you.
+     */
+    GetUserBlocks: {};
+    /**
+     * Blocks or unblocks a user on your account.
+     */
+    PutUserBlock: {
+        /**
+         * Whether or not you are blocking (`true`) or unblocking (`false`) the user.
+         */
+        block: boolean;
+        /**
+         * `userId` of you are blocking.
+         */
+        blockeeId: string;
+    };
+    /**
+     * Add a new game.
+     */
+    PutGame: {
+        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;
+    };
+    /**
+     * Add a moderator to a game.
+     */
+    PutGameModerator: Interfaces.GameModerator;
+    /**
+     * Remove a moderator from a game.
+     * TODO: test `level` necessity & enum type
+     */
+    PutGameModeratorDelete: {
+        gameId: string;
+        userId: string;
+    };
+    /**
+     * Add an existing game to a series.
+     */
+    PutSeriesGame: {
+        seriesId: string;
+        gameId: string;
+    };
+    /**
+     * Remove a game from a series.
+     *
+     * Does not delete the game.
+     */
+    PutSeriesGameDelete: {
+        seriesId: string;
+        gameId: string;
+    };
+    PutSeriesModerator: Interfaces.SeriesModerator;
+    PutSeriesModeratorUpdate: Interfaces.SeriesModerator;
+    PutSeriesModeratorDelete: Interfaces.SeriesModerator;
+    PutSeriesSettings: {
+        seriesId: string;
+        settings: Interfaces.SeriesSettings;
+    };
+    /**
+     * Submits support tickets.
+     */
+    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;
+    };
+    /**
+     * Modifies a user's social connection.
+     * todo verification?
+     */
+    PutUserSocialConnection: {
+        userId: string;
+        networkId: Enums.SocialConnection;
+        value: string;
+    };
+    /**
+     * Remove a user's social connection.
+     */
+    PutUserSocialConnectionDelete: {
+        userId: string;
+        networkId: Enums.SocialConnection;
+    };
+    /**
+     * Undocumented.
+     */
+    PutUserSocialConnectionSsoExchange: {
+        userId: string;
+        provider: string;
+        state: string;
+        code: string;
+    };
+    /**
+     * Update a user's password.
+     */
+    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.
+     */
+    PutUserUpdateEmail: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        /**
+         * The **new** email you want to have for the account.
+         */
+        email: string;
+        token?: string;
+        password: string;
+    };
+    /**
+     * Updates your name.
+     * You must wait 60 days after changing your name to change it again.
+     */
+    PutUserUpdateName: {
+        /**
+         * Your user page URL for your account.
+         */
+        userUrl: string;
+        newName: string;
+        /**
+         * Whether or not
+         */
+        acceptTerms: boolean;
+    };
+    PutUserDelete: {
+        userUrl: string;
+        password: string;
+    };
+    /**
+     * Updates a comment.
+     */
+    PutCommentUpdate: {
+        /**
+         * ID of the comment to update.
+         */
+        commentId: string;
+        /**
+         * New text of the comment.
+         */
+        text: string;
+    };
+    /**
+     * Deletes a comment.
+     */
+    PutCommentDelete: {
+        commentId: string;
+    };
+    /**
+     * Restores a deleted comment
+     */
+    PutCommentRestore: {
+        commentId: string;
+    };
+    /**
+     * Create a new thread on a forum.
+     */
+    PutThread: {
+        forumId: string;
+        name: string;
+        body: string;
+    };
+    /**
+     * Locks or unlocks a thread.
+     */
+    PutThreadLocked: {
+        threadId: string;
+        locked: boolean;
+    };
+    /**
+     * Pins or un-pins a thread.
+     */
+    PutThreadSticky: {
+        threadId: string;
+        sticky: boolean;
+    };
+    /**
+     * Delete a thread.
+     */
+    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'>;
+}